dellemc.openmanage.ome_alert_policies_category_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_category_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: Retrieve information about all the OME alert policy categories
  dellemc.openmanage.ome_alert_policies_category_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"

返回值

常见的返回值记录在 此处,以下是此模块特有的字段

描述

categories

列表 / elements=字符串

有关警报类别的信息。

返回: 总是

示例: [{"CategoriesDetails": [{"CatalogName": "Application", "Id": 5, "Name": "Configuration", "SubCategoryDetails": [{"Description": "Application", "Id": 85, "Name": "Application"}, {"Description": "Users", "Id": 35, "Name": "Users"}]}, {"CatalogName": "Application", "Id": 7, "Name": "Miscellaneous", "SubCategoryDetails": [{"Description": "Miscellaneous", "Id": 20, "Name": "Miscellaneous"}]}, {"CatalogName": "Application", "Id": 2, "Name": "Storage", "SubCategoryDetails": [{"Description": "Devices", "Id": 90, "Name": "Devices"}]}, {"CatalogName": "Application", "Id": 3, "Name": "Updates", "SubCategoryDetails": [{"Description": "Application", "Id": 85, "Name": "Application"}, {"Description": "Firmware", "Id": 112, "Name": "Firmware"}]}], "IsBuiltIn": true, "Name": "Application"}, {"CategoriesDetails": [{"CatalogName": "Dell Storage", "Id": 2, "Name": "Storage", "SubCategoryDetails": [{"Description": "Other", "Id": 7700, "Name": "Other"}]}, {"CatalogName": "Dell Storage", "Id": 1, "Name": "System Health", "SubCategoryDetails": [{"Description": "Other", "Id": 7700, "Name": "Other"}, {"Description": "Storage", "Id": 18, "Name": "Storage"}]}], "IsBuiltIn": true, "Name": "Dell Storage"}, {"CategoriesDetails": [{"CatalogName": "iDRAC", "Id": 4, "Name": "Audit", "SubCategoryDetails": [{"Description": "Auto System Reset", "Id": 41, "Name": "Auto System Reset"}, {"Description": "UEFI Event", "Id": 55, "Name": "UEFI Event"}, {"Description": "User Tracking", "Id": 56, "Name": "User Tracking"}]}, {"CatalogName": "iDRAC", "Id": 5, "Name": "Configuration", "SubCategoryDetails": [{"Description": "Auto-Discovery", "Id": 49, "Name": "Auto-Discovery"}, {"Description": "vFlash Event", "Id": 66, "Name": "vFlash Event"}, {"Description": "Virtual Console", "Id": 7, "Name": "Virtual Console"}]}, {"CatalogName": "iDRAC", "Id": 2, "Name": "Storage", "SubCategoryDetails": [{"Description": "Battery Event", "Id": 108, "Name": "Battery Event"}, {"Description": "Virtual Disk", "Id": 46, "Name": "Virtual Disk"}]}, {"CatalogName": "iDRAC", "Id": 1, "Name": "System Health", "SubCategoryDetails": [{"Description": "Amperage", "Id": 67, "Name": "Amperage"}, {"Description": "Auto System Reset", "Id": 41, "Name": "Auto System Reset"}, {"Description": "Voltage", "Id": 40, "Name": "Voltage"}]}, {"CatalogName": "iDRAC", "Id": 6, "Name": "Work Notes", "SubCategoryDetails": [{"Description": "BIOS Management", "Id": 54, "Name": "BIOS Management"}]}], "IsBuiltIn": true, "Name": "iDRAC"}]

error_info

字典

HTTP 错误的详细信息。

返回: 在 HTTP 错误时

示例: {"error": {"@Message.ExtendedInfo": [{"Message": "无法完成请求,因为资源 URI 不存在或未实现。", "MessageArgs": [], "MessageId": "CGEN1234", "RelatedProperties": [], "Resolution": "检查请求资源 URI。有关资源 URI 及其属性的详细信息,请参阅 OpenManage Enterprise-Modular 用户指南。", "Severity": "Critical"}], "code": "Base.1.0.GeneralError", "message": "发生了一般错误。有关详细信息,请参阅 ExtendedInfo。"}}

msg

字符串

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

返回: 总是

示例: "成功检索到警报策略类别信息。"

作者

  • Jagadeesh N V(@jagadeeshnv)