dellemc.openmanage.dellemc_system_lockdown_mode module – Configures system lockdown mode for iDRAC

Note

This module is part of the dellemc.openmanage collection (version 9.8.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_system_lockdown_mode.

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 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.9.6

Parameters

Parameter

Comments

ca_path

path

added in dellemc.openmanage 5.0.0

The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation.

idrac_ip

string / required

iDRAC IP Address.

idrac_password

aliases: idrac_pwd

string / required

iDRAC user password.

If the password is not provided, then the environment variable IDRAC_PASSWORD is used.

Example: export IDRAC_PASSWORD=password

idrac_port

integer

iDRAC port.

Default: 443

idrac_user

string / required

iDRAC username.

If the username is not provided, then the environment variable IDRAC_USERNAME is used.

Example: export IDRAC_USERNAME=username

lockdown_mode

string / required

Whether to Enable or Disable system lockdown mode.

Choices:

  • "Enabled"

  • "Disabled"

share_mnt

string

(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.

share_name

string

(deprecated)Network share or a local path.

This option is deprecated and will be removed in the later version.

share_password

aliases: share_pwd

string

(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.

share_user

string

(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.

timeout

integer

added in dellemc.openmanage 5.0.0

The socket level timeout in seconds.

Default: 30

validate_certs

boolean

added in dellemc.openmanage 5.0.0

If false, the SSL certificates will not be validated.

Configure false only on personally controlled sites where self-signed certificates are used.

Prior to collection version 5.0.0, the validate_certs is false by default.

Choices:

  • false

  • true ← (default)

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 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"
    lockdown_mode: "Disabled"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

error_info

dictionary

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."}}

msg

string

Lockdown mode of the system is configured.

Returned: always

Sample: "Successfully completed the lockdown mode operations."

system_lockdown_status

dictionary

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}

Status

  • This module will be removed in a major release after 2024-12-31. [deprecated]

  • For more information see DEPRECATED.

Authors

  • Felix Stephen (@felixs88)