dellemc.openmanage.ome_alert_policies 模块 – 管理 OME 警报策略。
注意
此模块是 dellemc.openmanage 集合 (版本 9.9.0) 的一部分。
如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用： ansible-galaxy collection install dellemc.openmanage。您需要其他要求才能使用此模块，请参阅 要求 获取详细信息。
要在 playbook 中使用它，请指定： dellemc.openmanage.ome_alert_policies。
dellemc.openmanage 8.3.0 中的新增功能
概要
此模块允许您在 OpenManage Enterprise 或 OpenManage Enterprise Modular 上创建、修改或删除警报策略。
要求
执行此模块的主机需要以下要求。
python >= 3.9.6
参数
参数 |
注释 |
|---|---|
要为警报策略触发的操作。 此参数区分大小写。 这是创建策略的必填项，更新策略的可选项。 仅当 state 为 |
|
操作的名称。 此项从 dellemc.openmanage.ome_alert_policies_action_info 中获取。 这是创建策略的必填项，更新策略的可选项。 此参数区分大小写。 |
|
为 action_name 设置所需预定义参数。 默认值： |
|
预定义参数的名称。 此项从 dellemc.openmanage.ome_alert_policies_action_info 中获取。 |
|
预定义参数的值。 这些值不会被验证。 |
|
此选项指示警报策略是否适用于所有已发现和未发现的设备。 此选项与 device_service_tag、specific_undiscovered_devices、any_undiscovered_devices 和 device_group 互斥。 仅当 state 为 选项
|
|
此选项指示警报策略是否适用于任何未发现的设备。 此选项与 device_service_tag、specific_undiscovered_devices、device_group 和 all_devices 互斥。 仅当 state 为 选项
|
|
包含用于验证的 CA 证书的隐私增强邮件 (PEM) 文件。 |
|
接收到的警报的类别。 此项与 message_ids、message_file 互斥。 此项从 dellemc.openmanage.ome_alert_policies_category_info 获取。 仅当 state 为 |
|
目录的类别。 |
|
类别的名称。 |
|
子类别的列表。 |
|
目录的名称。 |
|
指定警报策略适用的时间表。 date_and_time 是创建策略的必填项，更新策略的可选项。 仅当 state 为 |
|
开始日期，格式为 YYYY-MM-DD。 此参数需用引号括起来。 |
|
结束日期，格式为 YYYY-MM-DD。 此参数需用引号括起来。 |
|
必须安排警报策略操作的星期几。 选项
|
|
时间间隔开始时间，格式为 HH:MM 此参数需用引号括起来。 当 time_interval 为 |
|
启用必须安排警报策略的时间间隔。 选项
|
|
时间间隔结束时间，格式为 HH:MM 此参数需用引号括起来。 当 time_interval 为 |
|
警报策略的描述。 仅当 state 为 |
|
警报策略适用的设备组名称列表。 此选项与 device_service_tag、specific_undiscovered_devices、any_undiscovered_devices 和 all_devices 互斥。 仅当 state 为 |
|
警报策略适用的设备服务标签列表。 此选项与 device_group、specific_undiscovered_devices、any_undiscovered_devices 和 all_devices 互斥。 仅当 state 为 |
|
仅当 state 为 选项
|
|
OpenManage Enterprise 或 OpenManage Enterprise Modular 的 IP 地址或主机名。 |
|
包含消息 ID 的 CSV 格式文件的本地路径 此项与 category、message_ids 互斥 仅当 state 为 此项从 dellemc.openmanage.ome_alert_policies_message_id_info 获取。 |
|
消息 ID 列表 此项与 category、message_file 互斥 仅当 state 为 此项从 dellemc.openmanage.ome_alert_policies_message_id_info 获取。 |
|
告警策略名称或告警策略列表。 当state 为 |
|
告警策略的新名称。 仅当state 为 |
|
OpenManage Enterprise 或 OpenManage Enterprise Modular 密码。 如果未提供密码，则使用环境变量 示例：export OME_PASSWORD=password |
|
OpenManage Enterprise 或 OpenManage Enterprise Modular HTTPS 端口。 默认： |
|
告警策略的严重性。 这是创建策略的必填项，更新策略的可选项。 仅当 state 为 选项
|
|
适用告警策略的未发现设备的 IP 地址、主机名或 IP 地址范围列表。 此选项与device_service_tag、device_group、any_undiscovered_devices 和 all_devices 互斥。 仅当 state 为 有效的 IP 范围格式示例 10.35.0.0 10.36.0.0-10.36.0.255 10.37.0.0/24 2607:f2b1:f083:135::5500/118 2607:f2b1:f083:135::a500-2607:f2b1:f083:135::a600 hostname.domain.com 无效的 IP 范围格式示例 10.35.0.* 10.36.0.0-255 10.35.0.0/255.255.255.0 这些值不会被验证。 |
|
选项
|
|
套接字级别超时（秒）。 默认： |
|
OpenManage Enterprise 或 OpenManage Enterprise Modular 用户名。 如果未提供用户名，则使用环境变量 示例：export OME_USERNAME=username |
|
如果为 仅在使用自签名证书的个人控制站点上配置 在集合版本 选项
|
|
身份验证令牌。 如果未提供 x_auth_token，则使用环境变量 示例：export OME_X_AUTH_TOKEN=x_auth_token |
备注
注意
从此模块可以直接访问 Dell OpenManage Enterprise 或 OpenManage Enterprise Modular 的系统运行此模块。
此模块支持 IPv4 和 IPv6 地址。
此模块支持
check_mode。
示例
---
- name: "Create an alert policy"
dellemc.openamanage.ome_alert_policies:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
name: "Alert Policy One"
device_service_tag:
- ABCD123
- SVC7845
category:
- catalog_name: Application
catalog_category:
- category_name: Audit
sub_category_names:
- Generic
- Devices
- catalog_name: iDRAC
catalog_category:
- category_name: Audit
sub_category_names:
- BIOS Management
- iDRAC Service Module
date_and_time:
date_from: "2023-10-10"
date_to: "2023-10-11"
time_from: "11:00"
time_to: "12:00"
severity:
- unknown
- critical
actions:
- action_name: Trap
parameters:
- name: "192.1.2.3:162"
value: true
- name: "traphostname.domain.com:162"
value: true
tags: create_alert_policy
- name: "Update an alert Policy"
dellemc.openamanage.ome_alert_policies:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
new_name: "Update Policy Name"
device_group: "Group Name"
message_ids:
- AMP400
- CTL201
- BIOS101
date_and_time:
date_from: "2023-10-10"
date_to: "2023-10-11"
time_from: "11:00"
time_to: "12:00"
time_interval: true
actions:
- action_name: Trap
parameters:
- name: "192.1.2.3:162"
value: true
tags: update_alert_policy
- name: "Enable an alert policy"
dellemc.openamanage.ome_alert_policies:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
name: "Policy Name"
enable: true
tags: enable_alert_policy
- name: "Disable multiple alert policies"
dellemc.openamanage.ome_alert_policies:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
name:
- "Policy Name 1"
- "Policy Name 2"
enable: false
tags: disable_alert_policy
- name: "Delete an alert policy"
dellemc.openamanage.ome_alert_policies:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
name:
- "Policy Name"
state: absent
tags: delete_alert_policy
返回值
常见的返回值已在此处记录，以下是此模块独有的字段
键 |
描述 |
|---|---|
HTTP 错误的详细信息。 返回： HTTP 错误时 示例： |
|
告警策略操作的状态。 返回： 始终 示例： |
|
已创建或修改的策略。 返回： state 为 present 时 示例： |