dellemc.openmanage.redfish_event_subscription 模块 – 管理 Redfish 订阅
注意
此模块是 dellemc.openmanage 集合（版本 9.9.0）的一部分。
如果您使用的是 ansible 包，您可能已经安装了此集合。 它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install dellemc.openmanage。您需要其他要求才能使用此模块，请参阅 要求 了解详细信息。
要在 playbook 中使用它，请指定：dellemc.openmanage.redfish_event_subscription。
dellemc.openmanage 4.1.0 中的新增功能
概要
此模块允许添加或删除 Redfish 事件订阅。
要求
执行此模块的主机需要满足以下要求。
python >= 3.9.6
参数
参数 |
注释 |
|---|---|
目标带外控制器的 IP 地址。例如：<ipaddress>:<port>。 |
|
包含用于验证的 CA 证书的隐私增强邮件 (PEM) 文件。 |
|
用于发送事件的目标的 HTTPS URI。 必须使用 HTTPS。 |
|
指定要订阅的事件的格式类型。
选项
|
|
指定要订阅的事件类型。
选项
|
|
目标带外控制器的密码。 如果未提供密码，则使用环境变量 示例：export IDRAC_PASSWORD=password |
|
选项
|
|
套接字级别的超时时间（以秒为单位）。 默认： |
|
目标带外控制器的用户名。 如果未提供用户名，则使用环境变量 示例：export IDRAC_USERNAME=username |
|
如果为 仅在个人控制的使用自签名证书的站点上配置 在集合版本 选项
|
|
身份验证令牌。 如果未提供 x_auth_token，则使用环境变量 示例：export IDRAC_X_AUTH_TOKEN=x_auth_token |
备注
注意
对于指标订阅，*event_type* 需要为
MetricReport，*event_format_type* 需要为MetricReport。对于事件订阅，*event_type* 需要为
Alert，*event_format_type* 需要为Event。不支持修改订阅。
上下文始终设置为 RedfishEvent。
此模块支持
check_mode。
示例
---
- name: Add Redfish metric subscription
redfish_event_subscription:
baseuri: "192.168.0.1"
username: "user_name"
password: "user_password"
ca_path: "/path/to/ca_cert.pem"
destination: "https://192.168.1.100:8188"
event_type: MetricReport
event_format_type: MetricReport
state: present
- name: Add Redfish alert subscription
redfish_event_subscription:
baseuri: "192.168.0.1"
username: "user_name"
password: "user_password"
ca_path: "/path/to/ca_cert.pem"
destination: "https://server01.example.com:8188"
event_type: Alert
event_format_type: Event
state: present
- name: Delete Redfish subscription with a specified destination
redfish_event_subscription:
baseuri: "192.168.0.1"
username: "user_name"
password: "user_password"
ca_path: "/path/to/ca_cert.pem"
destination: "https://server01.example.com:8188"
state: absent
返回值
通用返回值记录在 此处，以下是此模块独有的字段
键 |
描述 |
|---|---|
http 错误的详细信息。 返回：出现 http 错误时 示例： |
|
任务的总体状态。 返回： 始终 示例： |
|
返回创建的订阅对象 返回： 成功添加订阅时 示例： |