dellemc.openmanage.ome_alert_policies_info 模块 – 检索一个或多个 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_info。

dellemc.openmanage 8.2.0 中的新功能

概要 

此模块检索 OpenManage Enterprise 和 OpenManage Enterprise Modular 的告警策略信息。
使用策略名称获取有关特定 OME 告警策略的信息列表。
当未提供策略名称时，获取包含其信息的所有 OME 告警策略的列表。

要求 

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

python >= 3.9.6

参数 

参数	注释
ca_path 路径在 dellemc.openmanage 5.0.0 中添加	包含用于验证的 CA 证书的 Privacy Enhanced Mail (PEM) 文件。
hostname 字符串 / 必需	OpenManage Enterprise 或 OpenManage Enterprise Modular IP 地址或主机名。
password 字符串	OpenManage Enterprise 或 OpenManage Enterprise Modular 密码。如果未提供密码，则使用环境变量 `OME_PASSWORD`。示例：export OME_PASSWORD=password
policy_name 字符串	策略的名称。
port 整数	OpenManage Enterprise 或 OpenManage Enterprise Modular HTTPS 端口。默认值： `443`
timeout 整数在 dellemc.openmanage 5.0.0 中添加	套接字级别超时（以秒为单位）。默认值： `30`
username 字符串	OpenManage Enterprise 或 OpenManage Enterprise Modular 用户名。如果未提供用户名，则使用环境变量 `OME_USERNAME`。示例：export OME_USERNAME=username
validate_certs 布尔值在 dellemc.openmanage 5.0.0 中添加	如果为 `false`，则不会验证 SSL 证书。仅在个人控制的站点（使用自签名证书）上配置 `false`。在集合版本 `5.0.0` 之前，validate_certs 默认为 `false`。选项 `false` `true` ←（默认）
x_auth_token 字符串在 dellemc.openmanage 9.3.0 中添加	身份验证令牌。如果未提供 x_auth_token，则使用环境变量 `OME_X_AUTH_TOKEN`。示例：export OME_X_AUTH_TOKEN=x_auth_token

备注 

注意

从可以直接访问 Dell OpenManage Enterprise 或 OpenManage Enterprise Modular 的系统运行此模块。
此模块支持 IPv4 和 IPv6 地址。
此模块支持 check_mode。

示例 

---
- name: Retrieve information about all OME alert policies.
  dellemc.openmanage.ome_alert_policies_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"

- name: Retrieve information about a specific OME alert policy using the policy name.
  dellemc.openmanage.ome_alert_policies_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    policy_name: "Mobile Push Notification - Critical Alerts"

返回值 

通用返回值记录在这里，以下是此模块独有的字段

键	描述
error_info 字典	HTTP 错误的详细信息。返回：发生 HTTP 错误时示例： `{"error": {"@Message.ExtendedInfo": [{"Message": "由于发生错误，无法处理请求。", "MessageArgs": [], "MessageId": "GEN1234", "RelatedProperties": [], "Resolution": "重试该操作。如果问题仍然存在，请联系您的系统管理员。", "Severity": "Critical"}], "code": "Base.1.0.GeneralError", "message": "发生一般错误。有关详细信息，请参阅 ExtendedInfo。"}}`
msg 字符串	告警策略信息获取操作的状态。返回：始终示例： `"已成功检索所有 OME 告警策略信息。"`
policies 列表 / 元素=字符串	检索有关所有 OME 告警策略的信息。返回: 成功示例: [{"DefaultPolicy": true, "Description": "此策略适用于关键警报。当收到关键警报时，将采取关联的操作。", "Enabled": true, "Id": 10006, "Name": "移动推送通知 - 关键警报", "Owner": null, "PolicyData": {"Actions": [{"Id": 5, "Name": "移动", "ParameterDetails": [], "TemplateId": 112}], "AllTargets": false, "Catalogs": [], "DeviceTypes": [], "Devices": [], "Groups": [], "MessageIds": [], "Schedule": {"CronString": null, "EndTime": null, "Interval": false, "StartTime": null}, "Severities": [16], "UndiscoveredTargets": []}, "State": true, "Visible": true}]

作者

Abhishek Sinha(@ABHISHEK-SINHA10)