dellemc.openmanage.dellemc_system_lockdown_mode (9.1.0) — module

Install collection

Install with ansible-galaxy collection install dellemc.openmanage:==9.1.0

Add to requirements.yml

  collections:
    - name: dellemc.openmanage
      version: 9.1.0

Description

This module is allows to Enable or Disable System lockdown Mode.

Requirements

• omsdk >= 1.2.488
• python >= 3.9.6

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Inputs

    
ca_path:
    description:
    - The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for
      the validation.
    type: path
    version_added: 5.0.0
    version_added_collection: dellemc.openmanage

timeout:
    default: 30
    description: The socket level timeout in seconds.
    type: int
    version_added: 5.0.0
    version_added_collection: dellemc.openmanage

idrac_ip:
    description: iDRAC IP Address.
    required: true
    type: str

share_mnt:
    description:
    - (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.
    type: str

idrac_port:
    default: 443
    description: iDRAC port.
    type: int

idrac_user:
    description:
    - iDRAC username.
    - If the username is not provided, then the environment variable C(IDRAC_USERNAME)
      is used.
    - 'Example: export IDRAC_USERNAME=username'
    required: true
    type: str

share_name:
    description:
    - (deprecated)Network share or a local path.
    - This option is deprecated and will be removed in the later version.
    type: str

share_user:
    description:
    - (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.
    type: str

lockdown_mode:
    choices:
    - Enabled
    - Disabled
    description: Whether to Enable or Disable system lockdown mode.
    required: true
    type: str

idrac_password:
    aliases:
    - idrac_pwd
    description:
    - iDRAC user password.
    - If the password is not provided, then the environment variable C(IDRAC_PASSWORD)
      is used.
    - 'Example: export IDRAC_PASSWORD=password'
    required: true
    type: str

share_password:
    aliases:
    - share_pwd
    description:
    - (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.
    type: str

validate_certs:
    default: true
    description:
    - If C(false), the SSL certificates will not be validated.
    - Configure C(false) only on personally controlled sites where self-signed certificates
      are used.
    - Prior to collection version C(5.0.0), the I(validate_certs) is C(false) by default.
    type: bool
    version_added: 5.0.0
    version_added_collection: dellemc.openmanage

Outputs

error_info:
  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.
  type: dict
msg:
  description: Lockdown mode of the system is configured.
  returned: always
  sample: Successfully completed the lockdown mode operations.
  type: str
system_lockdown_status:
  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
  type: dict