dellemc.openmanage.ome_alert_policies_message_id_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 message ID information 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 message ID details of all alert policies
  dellemc.openmanage.ome_alert_policies_message_id_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

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
message_ids:
  description: Details of the message ids.
  returned: success
  sample:
  - Category: System Health
    DetailedDescription: The current sensor identified in the message has failed.
      This condition can cause system performance issues and degradation in the monitoring
      capability of the system.
    Message: The ${0} sensor has failed, and the last recorded value by the sensor
      was ${1} A.
    MessageId: AMP400
    Prefix: AMP
    RecommendedAction: Check the Embedded System Management (ESM) Log for any sensor
      related faults. If there is a failed sensor, replace the system board. For more
      information, contact your service provider.
    SequenceNo: 400
    Severity: Critical
    SubCategory: Amperage
  - Category: System Health
    DetailedDescription: The current sensor identified in the message has failed.
      This condition can cause system performance issues and degradation in the monitoring
      capability of the system.
    Message: Unable to read the ${0} sensor value.
    MessageId: AMP401
    Prefix: AMP
    RecommendedAction: Check the Embedded System Management (ESM) Log for any sensor
      related faults. If there is a failed sensor, replace the system board. For more
      information, contact your service provider.
    SequenceNo: 401
    Severity: Warning
    SubCategory: Amperage
  type: dict
msg:
  description: Status of the alert policies message ids fetch operation.
  returned: always
  sample: Successfully retrieved alert policies message ids information.
  type: str