dellemc.openmanage.idrac_user (2.1.5) — module

Install collection

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

Add to requirements.yml

  collections:
    - name: dellemc.openmanage
      version: 2.1.5

Description

This module allows to perform the following,

Add a new user account.

Edit a user account.

Enable or Disable a user account.

Requirements

• python >= 2.7.5

Usage examples

Scanned by Steampunk Spotter

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

---
- name: Configure a new iDRAC user.
  dellemc.openmanage.idrac_user:
    idrac_ip: 198.162.0.1
    idrac_user: idrac_user
    idrac_password: idrac_password
    state: present
    user_name: user_name
    user_password: user_password
    privilege: Administrator
    ipmi_lan_privilege: Administrator
    ipmi_serial_privilege: Administrator
    enable: true
    sol_enable: true
    protocol_enable: true
    authentication_protocol: SHA
    privacy_protocol: AES

Scanned by Steampunk Spotter

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

- name: Modify existing iDRAC user username and password.
  dellemc.openmanage.idrac_user:
    idrac_ip: 198.162.0.1
    idrac_user: idrac_user
    idrac_password: idrac_password
    state: present
    user_name: user_name
    new_user_name: new_user_name
    user_password: user_password

Scanned by Steampunk Spotter

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

- name: Delete existing iDRAC user account.
  dellemc.openmanage.idrac_user:
    idrac_ip: 198.162.0.1
    idrac_user: idrac_user
    idrac_password: idrac_password
    state: absent
    user_name: user_name

Inputs

    
state:
    choices:
    - present
    - absent
    default: present
    description:
    - Select C(present) to create or modify a user account.
    - Select C(absent) to remove a user account.
    - "Ensure Lifecycle Controller is available\_because the user operation uses the capabilities\
      \ of Lifecycle Controller."
    required: false
    type: str

enable:
    description: Provide the option to enable or disable a user from logging in to iDRAC.
    required: false
    type: bool

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

privilege:
    choices:
    - Administrator
    - ReadOnly
    - Operator
    - None
    description:
    - Following are the role-based privileges,
    - A user with C(Administrator) privilege can log in to iDRAC, and then configure iDRAC,
      configure users, clear logs, control and configure system, access virtual console,
      access virtual media, test alerts, and execute debug commands.
    - A user with C(Operator) privilege can log in to iDRAC, and then configure iDRAC,
      control and configure system, access virtual console, access virtual media, and
      execute debug commands.
    - A user with C(ReadOnly) privilege can only log in to iDRAC.
    - A user with C(None), no privileges assigned.
    required: false
    type: str

user_name:
    description: Provide the I(user_name) of the account to be created, deleted or modified.
    required: true
    type: str

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

idrac_user:
    description: iDRAC username.
    required: true
    type: str

sol_enable:
    description: Enables Serial Over Lan (SOL) for an iDRAC user.
    required: false
    type: bool

new_user_name:
    description: Provide the I(user_name) for the account to be modified.
    required: false
    type: str

user_password:
    description:
    - Provide the password for the user account. The password can be changed when the
      user account is modified.
    - To ensure security, the I(user_password) must be at least eight characters long
      and must contain lowercase and upper-case characters, numbers, and special characters.
    required: false
    type: str

idrac_password:
    aliases:
    - idrac_pwd
    description: iDRAC user password.
    required: true
    type: str

protocol_enable:
    description: Enables protocol for the iDRAC user.
    required: false
    type: bool

privacy_protocol:
    choices:
    - None
    - DES
    - AES
    description:
    - This option allows to configure one of the following privacy encryption protocols
      for the iDRAC user.
    - Data Encryption Standard C(DES).
    - Advanced Encryption Standard C(AES).
    - A privacy protocol is not configured if C(None) is selected.
    required: false
    type: str

ipmi_lan_privilege:
    choices:
    - Administrator
    - Operator
    - User
    - No Access
    description: The Intelligent Platform Management Interface LAN privilege level assigned
      to the user.
    required: false
    type: str

ipmi_serial_privilege:
    choices:
    - Administrator
    - Operator
    - User
    - No Access
    description:
    - The Intelligent Platform Management Interface Serial Port privilege level assigned
      to the user.
    - This option is only applicable for rack and tower servers.
    required: false
    type: str

authentication_protocol:
    choices:
    - None
    - SHA
    - MD5
    description:
    - This option allows to configure one of the following authentication protocol types
      to authenticate the iDRAC user.
    - Secure Hash Algorithm C(SHA)
    - Message Digest 5 C(MD5)
    - An authentication protocol is not configured if C(None) is selected.
    required: false
    type: str