Try SpotterConfigures the iDRAC network attributes
| "added in version" 8.4.0 of dellemc.openmanage"
Authors: Abhishek Sinha(@ABHISHEK-SINHA10)
Install with ansible-galaxy collection install dellemc.openmanage:==9.1.0
collections:
- name: dellemc.openmanage
version: 9.1.0This module allows you to configure the port and partition network attributes on the network interface cards.
---
- 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_id: "NIC.Integrated.1"
network_port_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_id: NIC.Integrated.1
network_port_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_id: NIC.Integrated.1
network_port_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_id: NIC.Integrated.1
network_port_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_id: NIC.Integrated.1
network_port_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_id: NIC.Integrated.1
network_port_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_id: NIC.Integrated.1
network_port_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_id: NIC.Integrated.1
network_port_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_id: NIC.Integrated.1
network_port_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_id: NIC.Integrated.1
network_port_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
ca_path:
description:
- The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for
the validation.
type: path
version_added: 5.0.0
version_added_collection: dellemc.openmanage
timeout:
default: 30
description: The socket level timeout in seconds.
type: int
version_added: 5.0.0
version_added_collection: dellemc.openmanage
idrac_ip:
description: iDRAC IP Address.
required: true
type: str
job_wait:
default: true
description:
- Provides the option to wait for job completion.
- This is applicable when I(apply_time) is C(Immediate) for I(oem_network_attributes).
type: bool
apply_time:
choices:
- Immediate
- OnReset
- AtMaintenanceWindowStart
- InMaintenanceWindowOnReset
description:
- Apply time of the I(network_attributes) and I(oem_network_attributes).
- This is applicable only to I(network_attributes) and I(oem_network_attributes).
- C(Immediate) allows the user to immediately reboot the host and apply the changes.
I(job_wait) is applicable. This is applicable for I(oem_network_attributes) and
I(job_wait).
- C(OnReset) allows the user to apply the changes on the next reboot of the host server.
- C(AtMaintenanceWindowStart) allows the user to apply at the start of a maintenance
window as specified in I(maintenance_window). A reboot job is scheduled.
- C(InMaintenanceWindowOnReset) allows to apply after a manual reset but within the
maintenance window as specified in I(maintenance_window).
- This is not applicable for iDRAC8 and value will be ignored and will not have any
impact for configuring I(oem_network_attributes).
required: true
type: str
idrac_port:
default: 443
description: iDRAC port.
type: int
idrac_user:
description:
- iDRAC username.
- If the username is not provided, then the environment variable C(IDRAC_USERNAME)
is used.
- 'Example: export IDRAC_USERNAME=username'
required: true
type: str
resource_id:
description:
- 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.
type: str
clear_pending:
default: false
description:
- This parameter allows you to clear all the pending OEM network attributes changes.
- C(false) does not perform any operation.
- C(true) discards any pending changes to network attributes, or if a job is in scheduled
state, removes the job.
- I(apply_time) value will be ignored and will not have any impact for I(clear_pending)
operation.
- This operation is not supported for iDRAC8.
type: bool
idrac_password:
aliases:
- idrac_pwd
description:
- iDRAC user password.
- If the password is not provided, then the environment variable C(IDRAC_PASSWORD)
is used.
- 'Example: export IDRAC_PASSWORD=password'
required: true
type: str
validate_certs:
default: true
description:
- If C(false), the SSL certificates will not be validated.
- Configure C(false) only on personally controlled sites where self-signed certificates
are used.
- Prior to collection version C(5.0.0), the I(validate_certs) is C(false) by default.
type: bool
version_added: 5.0.0
version_added_collection: dellemc.openmanage
job_wait_timeout:
default: 1200
description:
- The maximum wait time of I(job_wait) in seconds. The job is tracked only for this
duration.
- This option is applicable when I(job_wait) is C(true).
type: int
maintenance_window:
description:
- This option allows you to schedule the maintenance window.
- This is required when I(apply_time) is C(AtMaintenanceWindowStart) or C(InMaintenanceWindowOnReset).
suboptions:
duration:
description:
- The duration in seconds for the maintenance window.
required: true
type: int
start_time:
description:
- 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.'
required: true
type: str
type: dict
network_adapter_id:
description:
- 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'
required: true
type: str
network_attributes:
description:
- Dictionary of network attributes and value. To view the list of attributes and its
structure, see the below API U(https://I(idrac_ip)/redfish/v1/Systems/System.Embedded.1/NetworkAdapters/<network_id>/NetworkDeviceFunctions/
<network_port_id>/Settings) and U(https://<idrac_ip>/redfish/v1/Schemas/NetworkDeviceFunction.v1_8_0.json).
- I(network_attributes) is mutually exclusive with I(oem_network_attributes).
type: dict
oem_network_attributes:
description:
- 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, U(https://I(idrac_ip)/redfish/v1/Chassis/System.Embedded.1/NetworkAdapters/<network_id>/NetworkDeviceFunctions/
<network_port_id>/Oem/Dell/DellNetworkAttributes/<network_port_id>) and U(https://I(idrac_ip)/redfish/v1/Registries/NetworkAttributesRegistry_<network_port_id>/
NetworkAttributesRegistry_network_port_id.json).
- For iDRAC8 based servers, derive the network attribute name from Server Configuration
Profile.
- I(oem_network_attributes) is mutually exclusive with I(network_attributes).
type: dict
network_device_function_id:
description:
- 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'
required: true
type: str
error_info:
description: Details of the HTTP Error.
returned: on 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.
type: dict
invalid_attributes:
description: Dictionary of invalid attributes provided that cannot be applied.
returned: On invalid attributes or values
sample:
IscsiInitiatorIpAddr: Attribute is not valid.
IscsiInitiatorSubnet: Attribute is not valid.
type: dict
job_status:
description: Returns the output for status of the job.
returned: always
sample:
ActualRunningStartTime: null
ActualRunningStopTime: null
CompletionTime: null
Description: Job Instance
EndTime: TIME_NA
Id: JID_XXXXXXXXX
JobState: Scheduled
JobType: NICConfiguration
Message: Task successfully scheduled.
MessageArgs: []
MessageId: JCP001
Name: 'Configure: NIC.Integrated.1-1-1'
PercentComplete: 0
StartTime: '2023-08-07T06:21:24'
TargetSettingsURI: null
type: dict
msg:
description: Status of the attribute update operation.
returned: when network attributes is applied
sample: Successfully updated the network attributes.
type: str