W3cubDocs

/Ansible

dellemc.openmanage.dellemc_configure_idrac_eventing – Configures the iDRAC eventing related attributes

Note

This plugin is part of the dellemc.openmanage collection (version 3.6.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install dellemc.openmanage.

To use it in a playbook, specify: dellemc.openmanage.dellemc_configure_idrac_eventing.

New in version 1.0.0: of dellemc.openmanage

Synopsis

  • This module allows to configure the iDRAC eventing related attributes.

Requirements

The below requirements are needed on the host that executes this module.

  • omsdk
  • python >= 2.7.5

Parameters

Parameter Choices/Defaults Comments
address
string
Email address for SNMP Trap.
alert_number
integer
Alert number for Email configuration.
authentication
string
    Choices:
  • Enabled
  • Disabled
Simple Mail Transfer Protocol Authentication.
custom_message
string
Custom message for SNMP Trap reference.
destination
string
Destination for SNMP Trap.
destination_number
integer
Destination number for SNMP Trap.
email_alert_state
string
    Choices:
  • Enabled
  • Disabled
Whether to Enable or Disable Email alert.
enable_alerts
string
    Choices:
  • Enabled
  • Disabled
Whether to Enable or Disable iDRAC alerts.
idrac_ip
string / required
iDRAC IP Address.
idrac_password
string / required
iDRAC user password.

aliases: idrac_pwd
idrac_port
integer
Default:
443
iDRAC port.
idrac_user
string / required
iDRAC username.
password
string
Password for SMTP authentication.
share_mnt
string
Local mount path of the network share with read-write permission for ansible user. This option is mandatory for Network Share.
share_name
string / required
Network share or a local path.
share_password
string
Network share user password. This option is mandatory for CIFS Network Share.

aliases: share_pwd
share_user
string
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.
smtp_ip_address
string
SMTP IP address for communication.
smtp_port
string
SMTP Port number for access.
snmp_trap_state
string
    Choices:
  • Enabled
  • Disabled
Whether to Enable or Disable SNMP alert.
snmp_v3_username
string
SNMP v3 username for SNMP Trap.
username
string
Username for SMTP authentication.

Notes

Note

  • This module requires ‘Administrator’ privilege for idrac_user.
  • Run this module from a system that has direct access to Dell EMC iDRAC.
  • This module supports check_mode.

Examples

---
- 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"
       share_name: "192.168.0.1:/share"
       share_password:  "share_user"
       share_user: "share_password"
       share_mnt: "/mnt/share"
       destination_number: "2"
       destination: "1.1.1.1"
       snmp_v3_username: "None"
       snmp_trap_state: "Enabled"
       email_alert_state: "Disabled"
       alert_number: "1"
       address: "[email protected]"
       custom_message: "Custom Message"
       enable_alerts: "Disabled"
       authentication: "Enabled"
       smtp_ip_address: "192.168.0.1"
       smtp_port: "25"
       username: "username"
       password: "password"

Return Values

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

Key Returned Description
error_info
dictionary
on HTTP error
Details of the 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.'}}
eventing_status
dictionary
success
Configures the iDRAC eventing attributes.

Sample:
{'CompletionTime': '2020-04-02T02:43:28', 'Description': 'Job Instance', 'EndTime': None, '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': None, 'retval': True}
msg
string
always
Successfully configured the iDRAC eventing settings.

Sample:
Successfully configured the iDRAC eventing settings.


Authors

  • Felix Stephen (@felixs88)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/dellemc/openmanage/dellemc_configure_idrac_eventing_module.html