dellemc.openmanage.dellemc_idrac_lc_attributes – Enable or disable Collect System Inventory on Restart (CSIOR) property for all iDRAC/LC jobs
Note
This plugin is part of the dellemc.openmanage collection (version 3.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.
To use it in a playbook, specify: dellemc.openmanage.dellemc_idrac_lc_attributes.
New in version 1.0.0: of dellemc.openmanage
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
- python >= 2.7.5
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| csior
string
|
|
Whether to Enable or Disable Collect System Inventory on Restart (CSIOR) property for all iDRAC/LC jobs.
|
| 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.
|
|
| share_mnt
string
|
Local mount path of the network share with read-write permission for ansible user. This option is mandatory for Network Share.
|
|
| share_name
string / required
|
Network share or a local path.
|
|
| share_password
string
|
Network share user password. This option is mandatory for CIFS Network Share.
aliases: share_pwd |
|
| share_user
string
|
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.
|
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: 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"
share_name: "192.168.0.1:/share"
share_mnt: "/mnt/share"
csior: "Enabled"
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.'}}
|
| lc_attribute_status
dictionary
|
success |
Collect System Inventory on Restart (CSIOR) property for all iDRAC/LC jobs is configured.
Sample:
{'CompletionTime': '2020-03-30T00:06:53', 'Description': 'Job Instance', 'EndTime': None, 'Id': 'JID_1234512345', 'JobState': 'Completed', 'JobType': 'ImportConfiguration', 'Message': 'Successfully imported and applied Server Configuration Profile.', 'MessageArgs': [], 'MessageArgs@odata.count': 0, 'MessageId': 'SYS053', 'Name': 'Import Configuration', 'PercentComplete': 100, 'StartTime': 'TIME_NOW', 'Status': 'Success', 'TargetSettingsURI': None, 'retval': True}
|
| msg
string
|
always |
Overall status of iDRAC LC attributes configuration.
Sample:
Successfully configured the iDRAC LC attributes.
|
Authors
- Felix Stephen (@felixs88)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/dellemc/openmanage/dellemc_idrac_lc_attributes_module.html