dellemc.openmanage.ome_alert_policies_actions_info 模块 – 获取告警策略操作信息。

注意

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

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

要安装它，请使用： ansible-galaxy collection install dellemc.openmanage。您需要其他要求才能使用此模块，请参阅 要求 以了解详情。

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

dellemc.openmanage 8.2.0 中的新增功能

摘要

  • 此模块检索 OpenManage Enterprise 和 OpenManage Enterprise Modular 告警策略操作信息。

要求

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

  • python >= 3.9.6

参数

参数

注释

ca_path

路径

在 dellemc.openmanage 5.0.0 中添加

包含用于验证的 CA 证书的隐私增强邮件 (PEM) 文件。

hostname

字符串 / 必需

OpenManage Enterprise 或 OpenManage Enterprise Modular 的 IP 地址或主机名。

password

字符串

OpenManage Enterprise 或 OpenManage Enterprise Modular 密码。

如果未提供密码，则使用环境变量 OME_PASSWORD。

示例：export OME_PASSWORD=password

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: Get action details of all alert policies.
  dellemc.openmanage.ome_alert_policies_actions_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"

返回值

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

键

描述

actions

列表 / 元素=字符串

返回从设备收集的告警策略操作信息。

返回：成功

示例： [{"Description": "电子邮件", "Disabled": false, "Name": "电子邮件", "ParameterDetails": [{"Id": 1, "Name": "主题", "TemplateParameterTypeDetails": [{"Name": "maxLength", "Value": "255"}], "Type": "string", "Value": "设备名称：$name，设备IP地址：$ip，严重程度：$severity"}, {"Id": 2, "Name": "收件人", "TemplateParameterTypeDetails": [{"Name": "maxLength", "Value": "255"}], "Type": "string", "Value": ""}, {"Id": 3, "Name": "发件人", "TemplateParameterTypeDetails": [{"Name": "maxLength", "Value": "255"}], "Type": "string", "Value": "admin1@dell.com"}, {"Id": 4, "Name": "消息", "TemplateParameterTypeDetails": [{"Name": "maxLength", "Value": "255"}], "Type": "string", "Value": "设备名称：$name，设备IP地址：$ip，服务标签：$identifier，UTC时间：$time，严重程度：$severity，消息ID：$messageId，$message"}, {"Description": "陷阱", "Disabled": false, "Id": 60, "Name": "陷阱", "ParameterDetails": [{"Id": 1, "Name": "localhost:162", "TemplateParameterTypeDetails": [], "Type": "boolean", "Value": "true"}]}, {"Description": "Syslog", "Disabled": false, "Id": 90, "Name": "Syslog", "ParameterDetails": [{"Id": 1, "Name": "localhost.scomdev.com:555", "TemplateParameterTypeDetails": [], "Type": "boolean", "Value": "true"}, {"Id": 2, "Name": "localhost.scomdev.com:555", "TemplateParameterTypeDetails": [], "Type": "boolean", "Value": "true"}]}, {"Description": "忽略", "Disabled": false, "Id": 100, "Name": "忽略", "ParameterDetails": []}, {"Description": "短信", "Disabled": false, "Id": 70, "Name": "短信", "ParameterDetails": [{"Id": 1, "Name": "收件人", "TemplateParameterTypeDetails": [{"Name": "maxLength", "Value": "255"}], "Type": "string", "Value": ""}]}, {"Description": "电源控制操作模板", "Disabled": false, "Id": 110, "Name": "电源控制", "ParameterDetails": [{"Id": 1, "Name": "powercontrolaction", "TemplateParameterTypeDetails": [{"Name": "option", "Value": "powercycle"}, {"Name": "option", "Value": "poweroff"}, {"Name": "option", "Value": "poweron"}, {"Name": "option", "Value": "gracefulshutdown"}], "Type": "singleSelect", "Value": "poweroff"}]}, {"Description": "远程命令", "Disabled": true, "Id": 111, "Name": "远程命令", "ParameterDetails": [{"Id": 1, "Name": "remotecommandaction", "TemplateParameterTypeDetails": [], "Type": "singleSelect", "Value": null}]}, {"Description": "移动", "Disabled": false, "Id": 112, "Name": "移动", "ParameterDetails": []}]}]

错误信息

字典

HTTP错误详情。

返回值： HTTP错误时

示例： {"error": {"@Message.ExtendedInfo": [{"Message": "由于发生错误，无法处理请求。", "MessageArgs": [], "MessageId": "GEN1234", "RelatedProperties": [], "Resolution": "重试操作。如果问题仍然存在，请联系您的系统管理员。", "Severity": "严重"}], "code": "Base.1.0.GeneralError", "message": "发生一般错误。请参阅ExtendedInfo了解更多信息。"} }

消息

字符串

警报策略操作获取操作的状态。

返回值： 始终

示例： "已成功检索警报策略信息。"

作者

  • Kritika Bhateja (@Kritika-Bhateja-03)