Docs4dev
Docs
ansible / latest / collections / dellemc / openmanage / dellemc_configure_idrac_services_module.html

dellemc.openmanage.dellemc_configure_idrac_services – Configures the iDRAC services 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_services.

New in version 1.0.0: of dellemc.openmanage

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
  • python >= 2.7.5

Parameters

Parameter Choices/Defaults Comments
alert_port
integer
Default:
162
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.
community_name
string
SNMP community name for iDRAC. It is used by iDRAC to validate SNMP queries received from remote systems requesting SNMP data access.
discovery_port
integer
Default:
161
The SNMP agent port on the iDRAC. The default value is 161, and the acceptable range is between 1 to 65535.
enable_web_server
string
    Choices:
  • Enabled
  • Disabled
Whether to Enable or Disable webserver configuration for iDRAC.
http_port
integer
HTTP access port.
https_port
integer
HTTPS access port.
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.
ipmi_lan
dictionary
Community name set on iDRAC for SNMP settings.
community_name
string
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.
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.
snmp_enable
string
    Choices:
  • Enabled
  • Disabled
Whether to Enable or Disable SNMP protocol for iDRAC.
snmp_protocol
string
    Choices:
  • All
  • SNMPv3
Type of the SNMP protocol.
ssl_encryption
string
    Choices:
  • Auto_Negotiate
  • T_128_Bit_or_higher
  • T_168_Bit_or_higher
  • T_256_Bit_or_higher
Secure Socket Layer encryption for webserver.
timeout
string
Timeout value.
tls_protocol
string
    Choices:
  • TLS_1_0_and_Higher
  • TLS_1_1_and_Higher
  • TLS_1_2_Only
Transport Layer Security for webserver.
trap_format
string
    Choices:
  • SNMPv1
  • SNMPv2
  • SNMPv3
SNMP trap format for iDRAC.

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 services attributes
  dellemc.openmanage.dellemc_configure_idrac_services:
       idrac_ip:   "192.168.0.1"
       idrac_user: "user_name"
       idrac_password:  "user_password"
       share_name: "192.168.0.1:/share"
       share_mnt: "/mnt/share"
       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 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.'}}
msg
string
always
Overall status of iDRAC service attributes configuration.

Sample:
Successfully configured the iDRAC services settings.
service_status
dictionary
success
Details of iDRAC services attributes configuration.

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}


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_services_module.html