dellemc.openmanage.idrac_network module – Configures the iDRAC network 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.idrac_network
.
New in dellemc.openmanage 2.1.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 iDRAC network settings.
Requirements
The below requirements are needed on the host that executes this module.
omsdk >= 1.2.488
python >= 3.9.6
Parameters
Parameter |
Comments |
---|---|
Allows to enable or disable auto-provisioning to automatically acquire domain name from DHCP. Choices:
|
|
Allows to auto detect the available NIC types used by iDRAC. Choices:
|
|
Allows iDRAC to automatically set the duplex mode and network speed. Choices:
|
|
The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation. |
|
Allows to enable DHCP to obtain DNS server address. Choices:
|
|
Name of the DNS to register iDRAC. |
|
Select the type of data transmission for the NIC. Choices:
|
|
Allows to enable or disable Dynamic Host Configuration Protocol (DHCP) in iDRAC. Choices:
|
|
Allows to enable or disable IPv4 configuration. Choices:
|
|
Allows to enable or disable the Network Interface Controller (NIC) used by iDRAC. Choices:
|
|
Select one of the remaining LOMs. If a network fails, the traffic is routed through the failover network. Choices:
|
|
iDRAC IP Address. |
|
iDRAC user password. |
|
iDRAC port. Default: |
|
iDRAC username. |
|
Enter a valid iDRAC static IPv4 address. |
|
Select the network speed for the selected NIC. Choices:
|
|
Maximum Transmission Unit of the NIC. |
|
Select one of the available NICs. Choices:
|
|
Registers iDRAC on a Domain Name System (DNS). Choices:
|
|
Allows to configure VLAN on iDRAC. Choices:
|
|
(deprecated)Local mount path of the network share with read-write permission for ansible user. This option is mandatory for network shares. 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 share. This option is deprecated and will be removed in the later version. |
|
(deprecated)Network share user name. Use the format ‘user@domain’ or ‘domain\user’ if user is part of a domain. This option is mandatory for CIFS share. This option is deprecated and will be removed in the later version. |
|
Enter the static DNS domain name. |
|
Enter the preferred static DNS server IPv4 address. |
|
Enter the preferred static DNS server IPv4 address. |
|
Enter the static IPv4 gateway address to iDRAC. |
|
Enter the static IP subnet mask to iDRAC. |
|
The socket level timeout in seconds. Default: |
|
If Configure Prior to collection version Choices:
|
|
Enter the VLAN ID. The VLAN ID must be a number from 1 through 4094. |
|
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 iDRAC.
This module supports both IPv4 and IPv6 address for idrac_ip.
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"
ca_path: "/path/to/ca_cert.pem"
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 |
Description |
---|---|
Details of the HTTP Error. Returned: on HTTP error Sample: |
|
Successfully configured the idrac network settings. Returned: always Sample: |
|
Status of the Network settings operation job. Returned: success Sample: |
Status
This module will be removed in a major release after 2024-07-31. [deprecated]
For more information see DEPRECATED.