dellemc.openmanage.idrac_user role – Role to manage local users for iDRAC.

Note

This role is part of the dellemc.openmanage collection (version 9.2.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.idrac_user.

Entry point main – Role to manage local users for iDRAC.

New in dellemc.openmanage 9.0.0

Synopsis

  • Role to manage manage local users for iDRACs (iDRAC8 and iDRAC9 only) for Dell PowerEdge servers.

Parameters

Parameter

Comments

authentication_protocol

string

This option allows to configure one of the following authentication protocol types to authenticate the iDRAC user.

Secure Hash Algorithm SHA.

Message Digest 5 MD5.

If None is selected, then the authentication protocol is not configured.

Choices:

  • "None"

  • "SHA"

  • "MD5"

ca_path

path

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

custom_privilege

integer

Provide the custom role-based authority privileges allowed for the user .

To create a custom privilege, add up the privilege decimal values as defined below. Login - 1 Configure - 2 Configure Users - 4 Logs - 8 System Control - 16 Access Virtual Console - 32 Access Virtual Media - 64 System Operations - 128 Debug - 256 - The value has to be in the range 0-511.

enable

boolean

Provide the option to enable or disable a user from logging in to iDRAC.

Choices:

  • false

  • true

hostname

string / required

IPv4, IPv6 Address or hostname of the iDRAC.

https_port

integer

iDRAC port.

Default: 443

https_timeout

integer

The HTTPS socket level timeout in seconds.

Default: 30

ipmi_lan_privilege

string

The Intelligent Platform Management Interface LAN privilege level assigned to the user.

Choices:

  • "Administrator"

  • "Operator"

  • "User"

  • "No Access"

ipmi_serial_privilege

string

The Intelligent Platform Management Interface Serial Port privilege level assigned to the user.

This option is only applicable for rack and tower servers.

Choices:

  • "Administrator"

  • "Operator"

  • "User"

  • "No Access"

new_user_name

string

Provide the user_name for the iDRAC user account that is modified.

password

string

iDRAC user password.

privacy_protocol

string

This option allows to configure one of the following privacy encryption protocols for the iDRAC user.

Data Encryption Standard DES.

Advanced Encryption Standard AES.

If None is selected, then the privacy protocol = is not configured.

Choices:

  • "None"

  • "DES"

  • "AES"

privilege

string

Following are the role-based privileges.

A user with 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 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 ReadOnly privilege can only log in to iDRAC.

A user with None, no privileges assigned.

Will be ignored, if custom_privilege parameter is provided.

Choices:

  • "Administrator"

  • "ReadOnly"

  • "Operator"

  • "None"

protocol_enable

boolean

Enables SNMPv3 protocol for the iDRAC user.

Choices:

  • false

  • true

sol_enable

boolean

Enables Serial Over Lan (SOL) for an iDRAC user.

Choices:

  • false

  • true

state

string

Select present to create or modify a user account.

Select absent to remove a user account.

Choices:

  • "present" ← (default)

  • "absent"

user_name

string / required

Provide username of the iDRAC user account that is created, deleted, or modified.

user_password

string

Password for the iDRAC user account that is created, or modified. The password can be changed when the user account is modified.

To ensure security, the user_password must be at least eight characters long and must contain lowercase and upper-case characters, numbers, and special characters.

username

string

iDRAC username with ‘Administrator’ privilege.

validate_certs

boolean

If false, the SSL certificates will not be validated.

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

Choices:

  • false

  • true ← (default)