dellemc.openmanage.idrac_network_attributes module – Configures the iDRAC network attributes
Note
This module is part of the dellemc.openmanage collection (version 9.9.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.
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_attributes.
New in dellemc.openmanage 8.4.0
Synopsis
This module allows you to configure the port and partition network attributes on the network interface cards.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.9.6
Parameters
Parameter |
Comments |
|---|---|
Apply time of the network_attributes and oem_network_attributes. This is applicable only to network_attributes and oem_network_attributes.
This is not applicable for iDRAC8 and value will be ignored and will not have any impact for configuring oem_network_attributes. Choices:
|
|
The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation. |
|
This parameter allows you to clear all the pending OEM network attributes changes.
apply_time value will be ignored and will not have any impact for clear_pending operation. This operation is not supported for iDRAC8. Choices:
|
|
iDRAC IP Address. |
|
iDRAC user password. If the password is not provided, then the environment variable Example: export IDRAC_PASSWORD=password |
|
iDRAC port. Default: |
|
iDRAC username. If the username is not provided, then the environment variable Example: export IDRAC_USERNAME=username |
|
Provides the option to wait for job completion. This is applicable when apply_time is Choices:
|
|
The maximum wait time of job_wait in seconds. The job is tracked only for this duration. This option is applicable when job_wait is Default: |
|
This option allows you to schedule the maintenance window. This is required when apply_time is |
|
The duration in seconds for the maintenance window. |
|
The start time for the maintenance window to be scheduled. The format is YYYY-MM-DDThh:mm:ss<offset> <offset> is the time offset from UTC that the current timezone set in iDRAC in the format: +05:30 for IST. |
|
FQDD of the network adapter device that represents the physical network adapter capable of connecting to a computer network. An example of FQDD of the network adapter is ‘NIC.Mezzanine.1A’ |
|
Dictionary of network attributes and value. To view the list of attributes and its structure, see the below API https://I(idrac_ip/redfish/v1/Systems/System.Embedded.1/NetworkAdapters/<network_adapter_id>/NetworkDeviceFunctions/ <network_device_function_id>/Settings) and https://<idrac_ip>/redfish/v1/Schemas/NetworkDeviceFunction.v1_8_0.json. network_attributes is mutually exclusive with oem_network_attributes. |
|
FQDD of the network adapter device function that represents a logical interface exposed by the network adapter. An example of FQDD of the network adapter device function is ‘NIC.Mezzanine.1A-1-1’ |
|
The attributes must be part of the Integrated Dell Remote Access Controller Attribute Registry. To view the list of attributes in Attribute Registry for iDRAC9 and newer versions. For more information, see, https://I(idrac_ip/redfish/v1/Chassis/System.Embedded.1/NetworkAdapters/<network_adapter_id>/NetworkDeviceFunctions/ <network_device_function_id>/Oem/Dell/DellNetworkAttributes/<network_device_function_id>) and https://I(idrac_ip/redfish/v1/Registries/NetworkAttributesRegistry_<network_device_function_id>/ NetworkAttributesRegistry_network_port_id.json). For iDRAC8 based servers, derive the network attribute name from Server Configuration Profile. oem_network_attributes is mutually exclusive with network_attributes. |
|
Id of the resource. If the value for resource ID is not provided, the module picks the first resource ID available from the list of system resources returned by the iDRAC. |
|
The socket level timeout in seconds. Default: |
|
If Configure Prior to collection version Choices:
|
|
Authentication token. If the x_auth_token is not provided, then the environment variable Example: export IDRAC_X_AUTH_TOKEN=x_auth_token |
Notes
Note
Run this module from a system that has direct access to Dell iDRAC.
This module supports both IPv4 and IPv6 address.
This module supports
check_mode.
Examples
---
- name: Configure OEM network attributes
dellemc.openmanage.idrac_network_attributes:
idrac_ip: "192.168.0.1"
idrac_user: "user_name"
idrac_password: "user_password"
network_adapter_id: "NIC.Integrated.1"
network_device_function_id: "NIC.Integrated.1-1-1"
apply_time: "Immediate"
oem_network_attributes:
BannerMessageTimeout: "4"
- name: Configure OEM network attributes to apply on reset
dellemc.openmanage.idrac_network_attributes:
idrac_ip: "192.168.0.1"
idrac_user: "user_name"
idrac_password: "user_password"
network_adapter_id: NIC.Integrated.1
network_device_function_id: "NIC.Integrated.1-1-1"
oem_network_attributes:
BannerMessageTimeout: "4"
apply_time: OnReset
- name: Configure OEM network attributes to apply at maintainance window
dellemc.openmanage.idrac_network_attributes:
idrac_ip: "192.168.0.1"
idrac_user: "user_name"
idrac_password: "user_password"
network_adapter_id: NIC.Integrated.1
network_device_function_id: "NIC.Integrated.1-1-1"
oem_network_attributes:
BannerMessageTimeout: "4"
apply_time: AtMaintenanceWindowStart
maintenance_window:
start_time: "2022-09-30T05:15:40-05:00"
duration: 600
- name: Clearing the pending attributes
dellemc.openmanage.idrac_network_attributes:
idrac_ip: "192.168.0.1"
idrac_user: "user_name"
idrac_password: "user_password"
network_adapter_id: NIC.Integrated.1
network_device_function_id: "NIC.Integrated.1-1-1"
apply_time: "Immediate"
clear_pending: true
- name: Clearing the OEM pending attributes and apply the OEM network attributes
dellemc.openmanage.idrac_network_attributes:
idrac_ip: "192.168.0.1"
idrac_user: "user_name"
idrac_password: "user_password"
network_adapter_id: NIC.Integrated.1
network_device_function_id: "NIC.Integrated.1-1-1"
apply_time: "Immediate"
clear_pending: true
oem_network_attributes:
BannerMessageTimeout: "4"
- name: Configure OEM network attributes and wait for the job
dellemc.openmanage.idrac_network_attributes:
idrac_ip: "192.168.0.1"
idrac_user: "user_name"
idrac_password: "user_password"
network_adapter_id: NIC.Integrated.1
network_device_function_id: "NIC.Integrated.1-1-1"
apply_time: "Immediate"
oem_network_attributes:
LnkSpeed: "10MbpsHalf"
WakeOnLan: "Enabled"
VLanMode: "Enabled"
job_wait: true
job_wait_timeout: 2000
- name: Configure redfish network attributes to update fiber channel on reset
dellemc.openmanage.idrac_network_attributes:
idrac_ip: "192.168.0.1"
idrac_user: "user_name"
idrac_password: "user_password"
network_adapter_id: NIC.Integrated.1
network_device_function_id: "NIC.Integrated.1-1-1"
apply_time: OnReset
network_attributes:
Ethernet:
VLAN:
VLANEnable: true
- name: Configure redfish network attributes to apply on reset
dellemc.openmanage.idrac_network_attributes:
idrac_ip: "192.168.0.1"
idrac_user: "user_name"
idrac_password: "user_password"
network_adapter_id: NIC.Integrated.1
network_device_function_id: "NIC.Integrated.1-1-1"
network_attributes:
Ethernet:
VLAN:
VLANEnable: true
apply_time: OnReset
- name: Configure redfish network attributes of iscsi to apply at maintainance window start
dellemc.openmanage.idrac_network_attributes:
idrac_ip: "192.168.0.1"
idrac_user: "user_name"
idrac_password: "user_password"
network_adapter_id: NIC.Integrated.1
network_device_function_id: "NIC.Integrated.1-1-1"
network_attributes:
iSCSIBoot:
InitiatorIPAddress: 1.0.0.1
apply_time: AtMaintenanceWindowStart
maintenance_window:
start_time: "2022-09-30T05:15:40-05:00"
duration: 600
- name: Configure redfish network attributes to apply at maintainance window on reset
dellemc.openmanage.idrac_network_attributes:
idrac_ip: "192.168.0.1"
idrac_user: "user_name"
idrac_password: "user_password"
network_adapter_id: NIC.Integrated.1
network_device_function_id: "NIC.Integrated.1-1-1"
network_attributes:
Ethernet:
VLAN:
VLANEnable: false
VLANId: 1
apply_time: AtMaintenanceWindowStart
maintenance_window:
start_time: "2022-09-30T05:15:40-05:00"
duration: 600
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: |
|
Dictionary of invalid attributes provided that cannot be applied. Returned: On invalid attributes or values Sample: |
|
Returns the output for status of the job. Returned: always Sample: |
|
Status of the attribute update operation. Returned: when network attributes is applied Sample: |