dellemc.openmanage.dellemc_system_lockdown_mode – Configures system lockdown mode for iDRAC
dellemc.openmanage.dellemc_system_lockdown_mode – Configures system lockdown mode for iDRAC
Note
This plugin is part of the dellemc.openmanage collection (version 3.0.0).
To install it use: ansible-galaxy collection install dellemc.openmanage
.
To use it in a playbook, specify: dellemc.openmanage.dellemc_system_lockdown_mode
.
New in version 1.0.0: of dellemc.openmanage
Synopsis
- This module is allows to Enable or Disable System lockdown Mode.
Requirements
The below requirements are needed on the host that executes this module.
- omsdk
- python >= 2.7.5
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
idrac_ip string / required |
iDRAC IP Address. | |
idrac_password string / required |
iDRAC user password.
| |
idrac_port integer |
Default: 443 |
iDRAC port. |
idrac_user string / required |
iDRAC username. | |
lockdown_mode string / required |
|
Whether to Enable or Disable system lockdown mode. |
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.
| |
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
- Run this module from a system that has direct access to DellEMC iDRAC.
- This module does not support
check_mode
.
Examples
---
- name: Check System Lockdown Mode
dellemc.openmanage.dellemc_system_lockdown_mode:
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"
lockdown_mode: "Disabled"
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.'}} |
msg string |
always |
Lockdown mode of the system is configured.
Sample: Successfully completed the lockdown mode operations. |
system_lockdown_status dictionary |
success |
Storage configuration job and progress details from the iDRAC.
Sample: {'Data': {'StatusCode': 200, 'body': {'@Message.ExtendedInfo': [{'Message': 'Successfully Completed Request', 'MessageArgs': [], '[email protected]': 0, 'MessageId': 'Base.1.0.Success', 'RelatedProperties': [], '[email protected]': 0, 'Resolution': 'None', 'Severity': 'OK'}]}}, 'Message': 'none', 'Status': 'Success', 'StatusCode': 200, 'retval': True} |
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/2.11/collections/dellemc/openmanage/dellemc_system_lockdown_mode_module.html