dellemc.openmanage.ome_alert_policies_category_info module – Retrieves information of all OME alert policy categories.

Note

This module is part of the dellemc.openmanage collection (version 9.8.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install dellemc.openmanage. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: dellemc.openmanage.ome_alert_policies_category_info.

New in dellemc.openmanage 8.2.0

Synopsis

  • This module allows to retrieve all the alert policy categories for OpenManage Enterprise and OpenManage Enterprise Modular.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 3.9.6

Parameters

Parameter

Comments

ca_path

path

added in dellemc.openmanage 5.0.0

The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation.

hostname

string / required

OpenManage Enterprise or OpenManage Enterprise Modular IP address or hostname.

password

string

OpenManage Enterprise or OpenManage Enterprise Modular password.

If the password is not provided, then the environment variable OME_PASSWORD is used.

Example: export OME_PASSWORD=password

port

integer

OpenManage Enterprise or OpenManage Enterprise Modular HTTPS port.

Default: 443

timeout

integer

added in dellemc.openmanage 5.0.0

The socket level timeout in seconds.

Default: 30

username

string

OpenManage Enterprise or OpenManage Enterprise Modular username.

If the username is not provided, then the environment variable OME_USERNAME is used.

Example: export OME_USERNAME=username

validate_certs

boolean

added in dellemc.openmanage 5.0.0

If false, the SSL certificates will not be validated.

Configure false only on personally controlled sites where self-signed certificates are used.

Prior to collection version 5.0.0, the validate_certs is false by default.

Choices:

  • false

  • true ← (default)

x_auth_token

string

added in dellemc.openmanage 9.3.0

Authentication token.

If the x_auth_token is not provided, then the environment variable OME_X_AUTH_TOKEN is used.

Example: export OME_X_AUTH_TOKEN=x_auth_token

Notes

Note

  • Run this module from a system that has direct access to Dell OpenManage Enterprise or OpenManage Enterprise Modular.

  • This module supports IPv4 and IPv6 addresses.

  • This module supports check_mode.

Examples

---
- 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"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

categories

list / elements=string

Information about the alert categories.

Returned: always

Sample: [{"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

dictionary

Details of the HTTP Error.

Returned: on HTTP error

Sample: {"error": {"@Message.ExtendedInfo": [{"Message": "Unable to complete the request because the resource URI does not exist or is not implemented.", "MessageArgs": [], "MessageId": "CGEN1234", "RelatedProperties": [], "Resolution": "Check the request resource URI. Refer to the OpenManage Enterprise-Modular User's Guide for more information about resource URI and its properties.", "Severity": "Critical"}], "code": "Base.1.0.GeneralError", "message": "A general error has occurred. See ExtendedInfo for more information."}}

msg

string

Status of the alert policies category fetch operation.

Returned: always

Sample: "Successfully retrieved alert policies category information."

Authors

  • Jagadeesh N V(@jagadeeshnv)