dellemc.openmanage.dellemc_configure_idrac_eventing module – Configures the iDRAC eventing related attributes
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.dellemc_configure_idrac_eventing
.
New in dellemc.openmanage 1.0.0
DEPRECATED
- Removed in:
major release after 2024-07-31
- Why:
Replaced with dellemc.openmanage.idrac_attributes.
- Alternative:
Use dellemc.openmanage.idrac_attributes instead.
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 >= 1.2.503
python >= 3.9.6
Parameters
Parameter |
Comments |
---|---|
Email address for SNMP Trap. |
|
Alert number for Email configuration. |
|
Simple Mail Transfer Protocol Authentication. Choices:
|
|
The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation. |
|
Custom message for SNMP Trap reference. |
|
Destination for SNMP Trap. |
|
Destination number for SNMP Trap. |
|
Whether to Enable or Disable Email alert. Choices:
|
|
Whether to Enable or Disable iDRAC alerts. Choices:
|
|
iDRAC IP Address. |
|
iDRAC user password. |
|
iDRAC port. Default: |
|
iDRAC username. |
|
Password for SMTP authentication. |
|
(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. |
|
(deprecated)Network share or a local path. This option is deprecated and will be removed in the later version. |
|
(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. |
|
(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. |
|
Enter the IPv4 or IPv6 address of the SMTP server or the FQDN or DNS name. |
|
SMTP Port number for access. |
|
Whether to Enable or Disable SNMP alert. Choices:
|
|
SNMP v3 username for SNMP Trap. |
|
The socket level timeout in seconds. Default: |
|
Username for SMTP authentication. |
|
If Configure Prior to collection version Choices:
|
Notes
Note
This module requires ‘Administrator’ privilege for idrac_user.
Run this module from a system that has direct access to Dell iDRAC.
This module supports both IPv4 and IPv6 address for idrac_ip.
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"
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"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Details of the HTTP Error. Returned: on HTTP error Sample: |
|
Configures the iDRAC eventing attributes. Returned: success Sample: |
|
Successfully configured the iDRAC eventing settings. Returned: always Sample: |
Status
This module will be removed in a major release after 2024-07-31. [deprecated]
For more information see DEPRECATED.
Authors
Felix Stephen (@felixs88)