Users Guide
Table Of Contents
- Dell EMC OpenManage Ansible Modules Version 4.0.0 User’s Guide
- Contents
- Overview
- Getting Started
- Modules for iDRAC
- How OpenManage Ansible Modules work with iDRAC
- Running your first iDRAC Playbook
- Updating Firmware
- Configuring PowerEdge Servers
- Deploying operating system
- Server Inventory
- Server administration tasks
- Storage controller
- Modules for OpenManage Enterprise (OME)
- How OpenManage Ansible Modules work with OME
- Running your first OME Playbook
- Manage Devices
- Manage device configuration templates
- Template Service
- Manage the device firmware
- Manage jobs
- Manage users
- Manage identity pool
- Manage application settings
- Manage network configuration
- Manage fabrics
- Manage Profiles
- Device discovery
- Manage Chassis
- Manage Active Directory service and user groups
- Diagnostics
- Modules for Redfish APIs
- Deprecated modules
Table 23. dellemc_system_lockdown_mode (continued)
Parameter/aliases Required Default Choices Comments
share_name Yes NA NA CIFS or NFS network share or a local path
share_user No NA NA
Network share user in the format
'user@domain' or user\domain if user is part
of a domain else 'user'. This field is mandatory
for CIFS Network Share.
share_password/
share_pwd
No NA NA
Network share user password. This field is
mandatory for CIFS Network Share.
share_mnt No NA NA
Local mount path of the network share with
read-write permission for Ansible user. This
option is mandatory for CIFS or NFS Network
share.
lockdown_mode Yes NA
● Enabled
● Disabled
Whether to Enable or Disable system lockdown
mode
Return Values
msg:
description: "Lockdown mode of the system is configured."
returned: always
type: str
sample: "Successfully completed the lockdown mode operations."
system_lockdown_status:
type: dict
description: 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
}
error_info:
description: Details of the HTTP Error.
returned: on HTTP error
type: dict
sample: {
"error": {
"code": "Base.1.0.GeneralError",
"message": "A general error has occurred. See ExtendedInfo for more information.",
"@Message.ExtendedInfo": [
{
"MessageId": "GEN1234",
"RelatedProperties": [],
"Message": "Unable to process the request because an error occurred.",
"MessageArgs": [],
"Severity": "Critical",
Modules for iDRAC
51