dellemc.openmanage.dellemc_configure_idrac_services 模块 – 配置 iDRAC 服务相关属性

注意

此模块是 dellemc.openmanage 集合 (版本 9.9.0) 的一部分。

如果您正在使用 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install dellemc.openmanage。您需要其他要求才能使用此模块，有关详细信息，请参阅要求。

要在剧本中使用它，请指定：dellemc.openmanage.dellemc_configure_idrac_services。

dellemc.openmanage 1.0.0 中的新增功能

已弃用 

移除于：: 2024-12-31 后的主要版本
原因：: 已替换为 dellemc.openmanage.idrac_attributes。
替代方案：: 请改用 dellemc.openmanage.idrac_attributes。

摘要 

此模块允许配置 iDRAC 服务相关的属性。

要求 

执行此模块的主机需要以下要求。

omsdk >= 1.2.488
python >= 3.9.6

参数 

参数	注释
alert_port 整数	必须用于 SNMP 陷阱的 iDRAC 端口号。默认值为 162，可接受的范围是 1 到 65535 之间。默认值： `162`
ca_path 路径 dellemc.openmanage 5.0.0 中新增	包含用于验证的 CA 证书的隐私增强邮件 (PEM) 文件。
community_name 字符串	iDRAC 的 SNMP 社区名称。iDRAC 使用它来验证从请求 SNMP 数据访问的远程系统接收到的 SNMP 查询。
discovery_port 整数	iDRAC 上的 SNMP 代理端口。默认值为 161，可接受的范围是 1 到 65535 之间。默认值： `161`
enable_web_server 字符串	是否启用或禁用 iDRAC 的 Web 服务器配置。选项 `"已启用"` `"已禁用"`
http_port 整数	HTTP 访问端口。
https_port 整数	HTTPS 访问端口。
idrac_ip 字符串 / 必填	iDRAC IP 地址。
idrac_password 别名：idrac_pwd 字符串 / 必填	iDRAC 用户密码。
idrac_port 整数	iDRAC 端口。默认值： `443`
idrac_user 字符串 / 必填	iDRAC 用户名。
ipmi_lan 字典	在 iDRAC 上设置的用于 SNMP 设置的社区名称。
community_name 字符串	iDRAC 发送 SNMP 和 IPMI 陷阱时使用此选项。远程系统会检查社区名称，该名称是陷阱发送到的目标。
share_mnt 字符串	(已弃用)具有 Ansible 用户读写权限的网络共享的本地挂载路径。此选项对于网络共享是必需的。此选项已弃用，将在更高版本中删除。
share_name 字符串	(已弃用)网络共享或本地路径。此选项已弃用，将在更高版本中删除。
share_password 别名：share_pwd 字符串	(已弃用)网络共享用户密码。此选项对于 CIFS 网络共享是必需的。此选项已弃用，将在更高版本中删除。
share_user 字符串	(已弃用)网络共享用户，格式为 ‘user@domain’ 或 ‘domain\user’（如果用户属于域），否则为 ‘user’。此选项对于 CIFS 网络共享是必需的。此选项已弃用，将在更高版本中删除。
snmp_enable 字符串	是否为 iDRAC 启用或禁用 SNMP 协议。选项 `"已启用"` `"已禁用"`
snmp_protocol 字符串	SNMP 协议的类型。选项 `"全部"` `"SNMPv3"`
ssl_encryption 字符串	Web 服务器的安全套接字层加密。选项 `"自动协商"` `"128 位或更高"` `"168 位或更高"` `"256 位或更高"`
timeout 字符串	超时值。
tls_protocol 字符串	Web 服务器的传输层安全性。选项 `"TLS 1.0 及更高版本"` `"TLS 1.1 及更高版本"` `"仅 TLS 1.2"`
trap_format 字符串	iDRAC 的 SNMP 陷阱格式。选项 `"SNMPv1"` `"SNMPv2"` `"SNMPv3"`
validate_certs 布尔值 dellemc.openmanage 5.0.0 中新增	如果为`false`，则不会验证SSL证书。仅在使用自签名证书的个人控制站点上配置`false`。在收集版本`5.0.0`之前，validate_certs默认为`false`。选项 `false` `true` ← (默认)

备注 

注意

此模块需要idrac_user具有“管理员”权限。
从可以直接访问Dell iDRAC的系统运行此模块。
此模块支持idrac_ip的IPv4和IPv6地址。
此模块支持check_mode。

示例 

---
- name: Configure the iDRAC services attributes
  dellemc.openmanage.dellemc_configure_idrac_services:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    enable_web_server: "Enabled"
    http_port: 80
    https_port: 443
    ssl_encryption: "Auto_Negotiate"
    tls_protocol: "TLS_1_2_Only"
    timeout: "1800"
    snmp_enable: "Enabled"
    snmp_protocol: "SNMPv3"
    community_name: "public"
    alert_port: 162
    discovery_port: 161
    trap_format: "SNMPv3"
    ipmi_lan:
      community_name: "public"

返回值 

常见的返回值已在此处记录，以下是此模块特有的字段

键	描述
error_info 字典	HTTP错误的详细信息。返回：HTTP错误时示例：`{"error": {"@Message.ExtendedInfo": [{"Message": "由于发生错误，无法处理请求。", "MessageArgs": [], "MessageId": "GEN1234", "RelatedProperties": [], "Resolution": "重试操作。如果问题仍然存在，请联系您的系统管理员。", "Severity": "Critical"}], "code": "Base.1.0.GeneralError", "message": "发生一般错误。请查看ExtendedInfo以获取更多信息。"}`
msg 字符串	iDRAC服务属性配置的总体状态。返回：始终示例：`"已成功配置iDRAC服务设置。"`
service_status 字典	iDRAC服务属性配置的详细信息。返回：成功示例：`{"CompletionTime": "2020-04-02T02:43:28", "Description": "作业实例", "EndTime": null, "Id": "JID_12345123456", "JobState": "已完成", "JobType": "ImportConfiguration", "Message": "已成功导入并应用服务器配置配置文件。", "MessageArgs": [], "MessageId": "SYS053", "Name": "导入配置", "PercentComplete": 100, "StartTime": "TIME_NOW", "Status": "Success", "TargetSettingsURI": null, "retval": true}`

dellemc.openmanage.dellemc_configure_idrac_services 模块 – 配置 iDRAC 服务相关属性

作者

集合链接