dellemc.openmanage.idrac_network – Configures the iDRAC network attributes

Note

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

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

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

New in version 2.1.0: of dellemc.openmanage

Synopsis

  • This module allows to configure iDRAC network settings.

Requirements

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

  • omsdk

  • python >= 2.7.5

Parameters

Parameter Choices/Defaults Comments
auto_config
string
    Choices:
  • Enabled
  • Disabled
Allows to enable or disable auto-provisioning to automatically acquire domain name from DHCP.
auto_detect
string
    Choices:
  • Enabled
  • Disabled
Allows to auto detect the available NIC types used by iDRAC.
auto_negotiation
string
    Choices:
  • Enabled
  • Disabled
Allows iDRAC to automatically set the duplex mode and network speed.
dns_from_dhcp
string
    Choices:
  • Enabled
  • Disabled
Allows to enable DHCP to obtain DNS server address.
dns_idrac_name
string
Name of the DNS to register iDRAC.
duplex_mode
string
    Choices:
  • Full
  • Half
Select the type of data transmission for the NIC.
enable_dhcp
string
    Choices:
  • Enabled
  • Disabled
Allows to enable or disable Dynamic Host Configuration Protocol (DHCP) in iDRAC.
enable_ipv4
string
    Choices:
  • Enabled
  • Disabled
Allows to enable or disable IPv4 configuration.
enable_nic
string
    Choices:
  • Enabled
  • Disabled
Allows to enable or disable the Network Interface Controller (NIC) used by iDRAC.
failover_network
string
    Choices:
  • ALL
  • LOM1
  • LOM2
  • LOM3
  • LOM4
  • T_None
Select one of the remaining LOMs. If a network fails, the traffic is routed through the failover network.
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.
ip_address
string
Enter a valid iDRAC static IPv4 address.
network_speed
string
    Choices:
  • T_10
  • T_100
  • T_1000
Select the network speed for the selected NIC.
nic_mtu
integer
Maximum Transmission Unit of the NIC.
nic_selection
string
    Choices:
  • Dedicated
  • LOM1
  • LOM2
  • LOM3
  • LOM4
Select one of the available NICs.
register_idrac_on_dns
string
    Choices:
  • Enabled
  • Disabled
Registers iDRAC on a Domain Name System (DNS).
setup_idrac_nic_vlan
string
    Choices:
  • Enabled
  • Disabled
Allows to configure VLAN on iDRAC.
share_mnt
string
Local mount path of the network share with read-write permission for ansible user. This option is mandatory for network shares.
share_name
string / required
Network share or a local path.
share_password
string
Network share user password. This option is mandatory for CIFS share.

aliases: share_pwd
share_user
string
Network share user name. Use the format '[email protected]' or 'domain\\user' if user is part of a domain. This option is mandatory for CIFS share.
static_dns
string
Enter the static DNS domain name.
static_dns_1
string
Enter the preferred static DNS server IPv4 address.
static_dns_2
string
Enter the preferred static DNS server IPv4 address.
static_gateway
string
Enter the static IPv4 gateway address to iDRAC.
static_net_mask
string
Enter the static IP subnet mask to iDRAC.
vlan_id
integer
Enter the VLAN ID. The VLAN ID must be a number from 1 through 4094.
vlan_priority
integer
Enter the priority for the VLAN ID. The priority value must be a number from 0 through 7.

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 iDRAC network settings
  dellemc.openmanage.idrac_network:
       idrac_ip:   "192.168.0.1"
       idrac_user: "user_name"
       idrac_password:  "user_password"
       share_name: "192.168.0.1:/share"
       share_password:  "share_pwd"
       share_user: "share_user"
       share_mnt: "/mnt/share"
       register_idrac_on_dns: Enabled
       dns_idrac_name: None
       auto_config: None
       static_dns: None
       setup_idrac_nic_vlan: Enabled
       vlan_id: 0
       vlan_priority: 1
       enable_nic: Enabled
       nic_selection: Dedicated
       failover_network: T_None
       auto_detect: Disabled
       auto_negotiation: Enabled
       network_speed: T_1000
       duplex_mode: Full
       nic_mtu: 1500
       ip_address: "192.168.0.1"
       enable_dhcp: Enabled
       enable_ipv4: Enabled
       static_dns_1: "192.168.0.1"
       static_dns_2: "192.168.0.1"
       dns_from_dhcp: Enabled
       static_gateway: None
       static_net_mask: None

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
Successfully configured the idrac network settings.

Sample:
Successfully configured the idrac network settings.
network_status
dictionary
success
Status of the Network settings operation job.

Sample:
{'@odata.context': '/redfish/v1/$metadata#DellJob.DellJob', '@odata.id': '/redfish/v1/Managers/iDRAC.Embedded.1/Jobs/JID_856418531008', '@odata.type': '#DellJob.v1_0_2.DellJob', 'CompletionTime': '2020-03-31T03:04:15', 'Description': 'Job Instance', 'EndTime': None, 'Id': 'JID_856418531008', 'JobState': 'Completed', 'JobType': 'ImportConfiguration', 'Message': 'Successfully imported and applied Server Configuration Profile.', 'MessageArgs': [], '[email protected]': 0, 'MessageId': 'SYS053', 'Name': 'Import Configuration', 'PercentComplete': 100, 'StartTime': 'TIME_NOW', 'Status': 'Success', 'TargetSettingsURI': None, 'retval': True}


Authors

  • Felix Stephen (@felixs88)

  • Anooja Vardhineni (@anooja-vardhineni)