dellemc.openmanage.ome_alert_policies_actions_info (9.1.0) — module

Install collection

Install with ansible-galaxy collection install dellemc.openmanage:==9.1.0

Add to requirements.yml

  collections:
    - name: dellemc.openmanage
      version: 9.1.0

Description

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

Requirements

• python >= 3.9.6

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Inputs

    
port:
    default: 443
    description: OpenManage Enterprise or OpenManage Enterprise Modular HTTPS port.
    type: int

ca_path:
    description:
    - The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for
      the validation.
    type: path
    version_added: 5.0.0
    version_added_collection: dellemc.openmanage

timeout:
    default: 30
    description: The socket level timeout in seconds.
    type: int
    version_added: 5.0.0
    version_added_collection: dellemc.openmanage

hostname:
    description: OpenManage Enterprise or OpenManage Enterprise Modular IP address or
      hostname.
    required: true
    type: str

password:
    description:
    - OpenManage Enterprise or OpenManage Enterprise Modular password.
    - If the password is not provided, then the environment variable C(OME_PASSWORD) is
      used.
    - 'Example: export OME_PASSWORD=password'
    required: true
    type: str

username:
    description:
    - OpenManage Enterprise or OpenManage Enterprise Modular username.
    - If the username is not provided, then the environment variable C(OME_USERNAME) is
      used.
    - 'Example: export OME_USERNAME=username'
    required: true
    type: str

validate_certs:
    default: true
    description:
    - If C(false), the SSL certificates will not be validated.
    - Configure C(false) only on personally controlled sites where self-signed certificates
      are used.
    - Prior to collection version C(5.0.0), the I(validate_certs) is C(false) by default.
    type: bool
    version_added: 5.0.0
    version_added_collection: dellemc.openmanage

Outputs

actions:
  description: 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: []
  type: list
error_info:
  description: 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.
  type: dict
msg:
  description: Status of the alert policies actions fetch operation.
  returned: always
  sample: Successfully retrieved alert policies actions information.
  type: str