dellemc.openmanage.ome_alert_policies_info module – Retrieves information of one or more OME alert policies.

Note

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

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_info.

New in dellemc.openmanage 8.2.0

Synopsis

  • This module retrieves the information of alert policies for OpenManage Enterprise and OpenManage Enterprise Modular.

  • A list of information about a specific OME alert policy using the policy name.

  • A list of all the OME alert policies with their information when the policy name is not provided.

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 / required

OpenManage Enterprise or OpenManage Enterprise Modular password.

policy_name

string

Name of the policy.

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 / required

OpenManage Enterprise or OpenManage Enterprise Modular 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)

Notes

Note

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

  • This module supports both IPv4 and IPv6 addresses.

  • This module supports check_mode.

Examples

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

Return Values

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

Key

Description

error_info

dictionary

Details of the HTTP Error.

Returned: on HTTP error

Sample: {"error": {"@Message.ExtendedInfo": [{"Message": "Unable to process the request because an error occurred.", "MessageArgs": [], "MessageId": "GEN1234", "RelatedProperties": [], "Resolution": "Retry the operation. If the issue persists, contact your system administrator.", "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 info fetch operation.

Returned: always

Sample: "Successfully retrieved all the OME alert policies information."

policies

list / elements=string

Retrieve information about all the OME alert policies.

Returned: success

Sample: [{"DefaultPolicy": true, "Description": "This policy is applicable to critical alerts. Associated actions will be taken when a critical alert is received.", "Enabled": true, "Id": 10006, "Name": "Mobile Push Notification - Critical Alerts", "Owner": null, "PolicyData": {"Actions": [{"Id": 5, "Name": "Mobile", "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}]

Authors

  • Abhishek Sinha(@ABHISHEK-SINHA10)