dellemc.openmanage.ome_alert_policies_actions_info module – Get information on actions of 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_actions_info.

New in dellemc.openmanage 8.2.0

Synopsis

  • This module retrieves the information on actions of alert policies 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 / required

OpenManage Enterprise or OpenManage Enterprise Modular 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 / 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: 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"

Return Values

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

Key

Description

actions

list / elements=string

Returns the alert policies action information collected from the Device.

Returned: success

Sample: [{"Description": "Email", "Disabled": false, "Name": "Email", "ParameterDetails": [{"Id": 1, "Name": "subject", "TemplateParameterTypeDetails": [{"Name": "maxLength", "Value": "255"}], "Type": "string", "Value": "Device Name: $name,  Device IP Address: $ip,  Severity: $severity"}, {"Id": 2, "Name": "to", "TemplateParameterTypeDetails": [{"Name": "maxLength", "Value": "255"}], "Type": "string", "Value": ""}, {"Id": 3, "Name": "from", "TemplateParameterTypeDetails": [{"Name": "maxLength", "Value": "255"}], "Type": "string", "Value": "admin1@dell.com"}, {"Id": 4, "Name": "message", "TemplateParameterTypeDetails": [{"Name": "maxLength", "Value": "255"}], "Type": "string", "Value": "Event occurred for Device Name: $name, Device IP Address: $ip, Service Tag: $identifier, UTC Time: $time, Severity: $severity, Message ID: $messageId, $message"}, {"Description": "Trap", "Disabled": false, "Id": 60, "Name": "Trap", "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": "Ignore", "Disabled": false, "Id": 100, "Name": "Ignore", "ParameterDetails": []}, {"Description": "SMS", "Disabled": false, "Id": 70, "Name": "SMS", "ParameterDetails": [{"Id": 1, "Name": "to", "TemplateParameterTypeDetails": [{"Name": "maxLength", "Value": "255"}], "Type": "string", "Value": ""}]}, {"Description": "Power Control Action Template", "Disabled": false, "Id": 110, "Name": "PowerControl", "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": "RemoteCommand", "Disabled": true, "Id": 111, "Name": "RemoteCommand", "ParameterDetails": [{"Id": 1, "Name": "remotecommandaction", "TemplateParameterTypeDetails": [], "Type": "singleSelect", "Value": null}]}, {"Description": "Mobile", "Disabled": false, "Id": 112, "Name": "Mobile", "ParameterDetails": []}]}]

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 actions fetch operation.

Returned: always

Sample: "Successfully retrieved alert policies actions information."

Authors

  • Kritika Bhateja (@Kritika-Bhateja-03)