dellemc.openmanage.dellemc_system_lockdown_mode module – Configures system lockdown mode for iDRAC
Note
This module is part of the dellemc.openmanage collection (version 5.4.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_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 >= 1.2.488
python >= 3.8.6
Parameters
Parameter |
Comments |
---|---|
The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation. |
|
iDRAC IP Address. |
|
iDRAC user password. |
|
iDRAC port. Default: 443 |
|
iDRAC username. |
|
Whether to Enable or Disable system lockdown mode. Choices:
|
|
Local mount path of the network share with read-write permission for ansible user. This option is mandatory for Network Share. |
|
Network share or a local path. |
|
Network share user password. This option is mandatory for CIFS Network Share. |
|
Network share user in the format ‘user@domain’ or ‘domainuser’ if user is part of a domain else ‘user’. This option is mandatory for CIFS Network Share. |
|
The socket level timeout in seconds. Default: 30 |
|
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 EMC 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"
ca_path: "/path/to/ca_cert.pem"
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 |
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.”}} |
|
Lockdown mode of the system is configured. Returned: always Sample: “Successfully completed the lockdown mode operations.” |
|
Storage configuration job and progress details from the iDRAC. Returned: success Sample: {“Data”: {“StatusCode”: 200, “body”: {“@Message.ExtendedInfo”: [{“Message”: “Successfully Completed Request”, “MessageArgs”: [], “MessageArgs@odata.count”: 0, “MessageId”: “Base.1.0.Success”, “RelatedProperties”: [], “RelatedProperties@odata.count”: 0, “Resolution”: “None”, “Severity”: “OK”}]}}, “Message”: “none”, “Status”: “Success”, “StatusCode”: 200, “retval”: true} |