dellemc.openmanage.dellemc_idrac_lc_attributes module – Enable or disable Collect System Inventory on Restart (CSIOR) property for all iDRAC/LC jobs
Note
This module is part of the dellemc.openmanage collection (version 9.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
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: dellemc.openmanage.dellemc_idrac_lc_attributes
.
New in dellemc.openmanage 1.0.0
DEPRECATED
- Removed in:
major release after 2024-12-31
- Why:
Replaced with dellemc.openmanage.idrac_attributes.
- Alternative:
Use dellemc.openmanage.idrac_attributes instead.
Synopsis
This module is responsible for enabling or disabling of Collect System Inventory on Restart (CSIOR) property for all iDRAC/LC jobs.
Requirements
The below requirements are needed on the host that executes this module.
omsdk >= 1.2.488
python >= 3.9.6
Parameters
Parameter |
Comments |
---|---|
The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation. |
|
Whether to Enable or Disable Collect System Inventory on Restart (CSIOR) property for all iDRAC/LC jobs. 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 |
|
(deprecated)Local mount path of the network share with read-write permission for ansible user. This option is mandatory for Network Share. 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 Network Share. This option is deprecated and will be removed in the later version. |
|
(deprecated)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. This option is deprecated and will be removed in the later version. |
|
The socket level timeout in seconds. Default: |
|
If Configure Prior to collection version Choices:
|
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: Set up iDRAC LC Attributes
dellemc.openmanage.dellemc_idrac_lc_attributes:
idrac_ip: "192.168.0.1"
idrac_user: "user_name"
idrac_password: "user_password"
ca_path: "/path/to/ca_cert.pem"
csior: "Enabled"
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: |
|
Collect System Inventory on Restart (CSIOR) property for all iDRAC/LC jobs is configured. Returned: success Sample: |
|
Overall status of iDRAC LC attributes configuration. Returned: always Sample: |
Status
This module will be removed in a major release after 2024-12-31. [deprecated]
For more information see DEPRECATED.