dellemc.openmanage.dellemc_configure_idrac_eventing 模块 – 配置 iDRAC 事件相关属性

注意

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

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

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

要在 playbook 中使用它，请指定：dellemc.openmanage.dellemc_configure_idrac_eventing。

dellemc.openmanage 1.0.0 中的新增功能

已弃用 

在以下版本中移除：: 2024-12-31 之后的主要版本
原因：: 已替换为 dellemc.openmanage.idrac_attributes。
替代方案：: 使用 dellemc.openmanage.idrac_attributes 代替。

概要 

此模块允许配置 iDRAC 事件相关属性。

需求 

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

omsdk >= 1.2.503
python >= 3.9.6

参数 

参数	注释
address 字符串	SNMP 陷阱的电子邮件地址。
alert_number 整数	电子邮件配置的警报编号。
authentication 字符串	简单邮件传输协议 (SMTP) 身份验证。选项 `"已启用"` `"已禁用"`
ca_path 路径在 dellemc.openmanage 5.0.0 中添加	包含用于验证的 CA 证书的隐私增强邮件 (PEM) 文件。
custom_message 字符串	SNMP 陷阱引用的自定义消息。
destination 字符串	SNMP 陷阱的目标。
destination_number 整数	SNMP 陷阱的目标编号。
email_alert_state 字符串	是否启用或禁用电子邮件警报。选项 `"已启用"` `"已禁用"`
enable_alerts 字符串	是否启用或禁用 iDRAC 警报。选项 `"已启用"` `"已禁用"`
idrac_ip 字符串 / 必需	iDRAC IP 地址。
idrac_password 别名：idrac_pwd 字符串 / 必需	iDRAC 用户密码。如果未提供密码，则使用环境变量 `IDRAC_PASSWORD`。示例：export IDRAC_PASSWORD=password
idrac_port 整数	iDRAC 端口。默认值： `443`
idrac_user 字符串 / 必需	iDRAC 用户名。如果未提供用户名，则使用环境变量 `IDRAC_USERNAME`。示例：export IDRAC_USERNAME=username
password 字符串	SMTP 身份验证的密码。
share_mnt 字符串	(已弃用) 具有 Ansible 用户读写权限的网络共享的本地挂载路径。此选项对于网络共享是必需的。此选项已弃用，将在以后的版本中删除。
share_name 字符串	(已弃用)网络共享或本地路径。此选项已弃用，将在以后的版本中删除。
share_password 别名：share_pwd 字符串	(已弃用)网络共享用户密码。此选项对于 CIFS 网络共享是必需的。此选项已弃用，将在以后的版本中删除。
share_user 字符串	(已弃用)网络共享用户，格式为 ‘user@domain’ 或 ‘domain\user’（如果用户是域的一部分），否则为 ‘user’。此选项对于 CIFS 网络共享是必需的。此选项已弃用，将在以后的版本中删除。
smtp_ip_address 字符串	输入 SMTP 服务器的 IPv4 或 IPv6 地址，或 FQDN 或 DNS 名称。
smtp_port 字符串	访问的 SMTP 端口号。
snmp_trap_state 字符串	是否启用或禁用 SNMP 警报。选项 `"已启用"` `"已禁用"`
snmp_v3_username 字符串	SNMP 陷阱的 SNMP v3 用户名。
timeout 整数在 dellemc.openmanage 5.0.0 中添加	以秒为单位的套接字级别超时。默认值： `30`
username 字符串	SMTP 身份验证的用户名。
validate_certs 布尔值在 dellemc.openmanage 5.0.0 中添加	如果为 `false`，则不会验证 SSL 证书。仅在使用自签名证书的个人控制站点上配置 `false`。在集合版本 `5.0.0` 之前，validate_certs 默认值为 `false`。选项 `false` `true` ← (默认)

备注 

注意

此模块需要对 idrac_user 具有“管理员”权限。
请在能够直接访问 Dell iDRAC 的系统上运行此模块。
此模块支持 IPv4 和 IPv6 地址作为 idrac_ip。
此模块支持 check_mode。

示例 

---
- name: Configure the iDRAC eventing attributes
  dellemc.openmanage.dellemc_configure_idrac_eventing:
       idrac_ip: "192.168.0.1"
       idrac_user: "user_name"
       idrac_password: "user_password"
       ca_path: "/path/to/ca_cert.pem"
       destination_number: "2"
       destination: "1.1.1.1"
       snmp_v3_username: "None"
       snmp_trap_state: "Enabled"
       email_alert_state: "Disabled"
       alert_number: "1"
       address: "alert_email@company.com"
       custom_message: "Custom Message"
       enable_alerts: "Disabled"
       authentication: "Enabled"
       smtp_ip_address: "192.168.0.1"
       smtp_port: "25"
       username: "username"
       password: "password"

返回值 

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

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

状态 

此模块将在 2024 年 12 月 31 日后的主要版本中删除。[已弃用]
更多信息请参见已弃用。

作者

Felix Stephen (@felixs88)

dellemc.openmanage.dellemc_configure_idrac_eventing 模块 – 配置 iDRAC 事件相关属性

作者

集合链接