dellemc.openmanage.dellemc_configure_idrac_eventing (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 allows to configure the iDRAC eventing related attributes.

Requirements

• omsdk >= 1.2.503
• python >= 3.9.6

Usage examples

Scanned by Steampunk Spotter

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

---
- name: Configure the iDRAC eventing attributes
  dellemc.openmanage.dellemc_configure_idrac_eventing:
       idrac_ip: "192.168.0.1"
       idrac_user: "user_name"
       idrac_password: "user_password"
       ca_path: "/path/to/ca_cert.pem"
       destination_number: "2"
       destination: "1.1.1.1"
       snmp_v3_username: "None"
       snmp_trap_state: "Enabled"
       email_alert_state: "Disabled"
       alert_number: "1"
       address: "alert_email@company.com"
       custom_message: "Custom Message"
       enable_alerts: "Disabled"
       authentication: "Enabled"
       smtp_ip_address: "192.168.0.1"
       smtp_port: "25"
       username: "username"
       password: "password"

Inputs

    
address:
    description: Email address for SNMP Trap.
    type: str

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

idrac_ip:
    description: iDRAC IP Address.
    required: true
    type: str

password:
    description: Password for SMTP authentication.
    type: str

username:
    description: Username for SMTP authentication.
    type: str

share_mnt:
    description:
    - (deprecated)Local mount path of the network share with read-write permission for
      ansible user. This option is mandatory for Network Share.
    - This option is deprecated and will be removed in the later version.
    type: str

smtp_port:
    description: SMTP Port number for access.
    type: str

idrac_port:
    default: 443
    description: iDRAC port.
    type: int

idrac_user:
    description:
    - iDRAC username.
    - If the username is not provided, then the environment variable C(IDRAC_USERNAME)
      is used.
    - 'Example: export IDRAC_USERNAME=username'
    required: true
    type: str

share_name:
    description:
    - (deprecated)Network share or a local path.
    - This option is deprecated and will be removed in the later version.
    type: str

share_user:
    description:
    - (deprecated)Network share user in the format 'user@domain' or 'domain\user' if user
      is part of a domain else 'user'. This option is mandatory for CIFS Network Share.
    - This option is deprecated and will be removed in the later version.
    type: str

destination:
    description: Destination for SNMP Trap.
    type: str

alert_number:
    description: Alert number for Email configuration.
    type: int

enable_alerts:
    choices:
    - Enabled
    - Disabled
    description: Whether to Enable or Disable iDRAC alerts.
    type: str

authentication:
    choices:
    - Enabled
    - Disabled
    description: Simple Mail Transfer Protocol Authentication.
    type: str

custom_message:
    description: Custom message for SNMP Trap reference.
    type: str

idrac_password:
    aliases:
    - idrac_pwd
    description:
    - iDRAC user password.
    - If the password is not provided, then the environment variable C(IDRAC_PASSWORD)
      is used.
    - 'Example: export IDRAC_PASSWORD=password'
    required: true
    type: str

share_password:
    aliases:
    - share_pwd
    description:
    - (deprecated)Network share user password. This option is mandatory for CIFS Network
      Share.
    - This option is deprecated and will be removed in the later version.
    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

smtp_ip_address:
    description: Enter the IPv4 or IPv6 address of the SMTP server or the FQDN or DNS
      name.
    type: str

snmp_trap_state:
    choices:
    - Enabled
    - Disabled
    description: Whether to Enable or Disable SNMP alert.
    type: str

snmp_v3_username:
    description: SNMP v3 username for SNMP Trap.
    type: str

email_alert_state:
    choices:
    - Enabled
    - Disabled
    description: Whether to Enable or Disable Email alert.
    type: str

destination_number:
    description: Destination number for SNMP Trap.
    type: int

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
eventing_status:
  description: Configures the iDRAC eventing attributes.
  returned: success
  sample:
    CompletionTime: '2020-04-02T02:43:28'
    Description: Job Instance
    EndTime: null
    Id: JID_12345123456
    JobState: Completed
    JobType: ImportConfiguration
    Message: Successfully imported and applied Server Configuration Profile.
    MessageArgs: []
    MessageId: SYS053
    Name: Import Configuration
    PercentComplete: 100
    StartTime: TIME_NOW
    Status: Success
    TargetSettingsURI: null
    retval: true
  type: dict
msg:
  description: Successfully configured the iDRAC eventing settings.
  returned: always
  sample: Successfully configured the iDRAC eventing settings.
  type: str