dellemc.openmanage.dellemc_configure_idrac_services module – Configures the iDRAC services 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_services
.
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 services related attributes.
Requirements
The below requirements are needed on the host that executes this module.
omsdk >= 1.2.488
python >= 3.9.6
Parameters
Parameter |
Comments |
---|---|
The iDRAC port number that must be used for SNMP traps. The default value is 162, and the acceptable range is between 1 to 65535. Default: |
|
The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation. |
|
SNMP community name for iDRAC. It is used by iDRAC to validate SNMP queries received from remote systems requesting SNMP data access. |
|
The SNMP agent port on the iDRAC. The default value is 161, and the acceptable range is between 1 to 65535. Default: |
|
Whether to Enable or Disable webserver configuration for iDRAC. Choices:
|
|
HTTP access port. |
|
HTTPS access port. |
|
iDRAC IP Address. |
|
iDRAC user password. |
|
iDRAC port. Default: |
|
iDRAC username. |
|
Community name set on iDRAC for SNMP settings. |
|
This option is used by iDRAC when it sends out SNMP and IPMI traps. The community name is checked by the remote system to which the traps are sent. |
|
(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. |
|
Whether to Enable or Disable SNMP protocol for iDRAC. Choices:
|
|
Type of the SNMP protocol. Choices:
|
|
Secure Socket Layer encryption for webserver. Choices:
|
|
Timeout value. |
|
Transport Layer Security for webserver. Choices:
|
|
SNMP trap format for iDRAC. Choices:
|
|
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 services attributes
dellemc.openmanage.dellemc_configure_idrac_services:
idrac_ip: "192.168.0.1"
idrac_user: "user_name"
idrac_password: "user_password"
ca_path: "/path/to/ca_cert.pem"
enable_web_server: "Enabled"
http_port: 80
https_port: 443
ssl_encryption: "Auto_Negotiate"
tls_protocol: "TLS_1_2_Only"
timeout: "1800"
snmp_enable: "Enabled"
snmp_protocol: "SNMPv3"
community_name: "public"
alert_port: 162
discovery_port: 161
trap_format: "SNMPv3"
ipmi_lan:
community_name: "public"
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: |
|
Overall status of iDRAC service attributes configuration. Returned: always Sample: |
|
Details of iDRAC services attributes configuration. Returned: success 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)