dellemc.openmanage.idrac_user module – Configure settings for user accounts
Note
This module is part of the dellemc.openmanage collection (version 8.5.0).
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.idrac_user
.
New in dellemc.openmanage 2.1.0
Synopsis
This module allows to perform the following,
Add a new user account.
Edit a user account.
Enable or Disable a user account.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.8.6
Parameters
Parameter |
Comments |
---|---|
This option allows to configure one of the following authentication protocol types to authenticate the iDRAC user. Secure Hash Algorithm Message Digest 5 An authentication protocol is not configured if Choices:
|
|
The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation. |
|
The privilege level assigned to the user. |
|
Provide the option to enable or disable a user from logging in to iDRAC. Choices:
|
|
iDRAC IP Address. |
|
iDRAC user password. |
|
iDRAC port. Default: |
|
iDRAC username. |
|
The Intelligent Platform Management Interface LAN privilege level assigned to the user. Choices:
|
|
The Intelligent Platform Management Interface Serial Port privilege level assigned to the user. This option is only applicable for rack and tower servers. Choices:
|
|
Provide the user_name for the account to be modified. |
|
This option allows to configure one of the following privacy encryption protocols for the iDRAC user. Data Encryption Standard Advanced Encryption Standard A privacy protocol is not configured if Choices:
|
|
Following are the role-based privileges. A user with A user with A user with A user with Will be ignored, if custom_privilege parameter is provided. Choices:
|
|
Enables protocol for the iDRAC user. Choices:
|
|
Enables Serial Over Lan (SOL) for an iDRAC user. Choices:
|
|
Select Select Choices:
|
|
The socket level timeout in seconds. Default: |
|
Provide the user_name of the account to be created, deleted or modified. |
|
Provide the password for the user account. 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. |
|
If Configure Prior to collection version Choices:
|
Notes
Note
Run this module from a system that has direct access to Dell iDRAC.
This module supports
check_mode
.
Examples
---
- name: Configure a new iDRAC user
dellemc.openmanage.idrac_user:
idrac_ip: 198.162.0.1
idrac_user: idrac_user
idrac_password: idrac_password
ca_path: "/path/to/ca_cert.pem"
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
- 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
ca_path: "/path/to/ca_cert.pem"
state: present
user_name: user_name
new_user_name: new_user_name
user_password: user_password
- name: Delete existing iDRAC user account
dellemc.openmanage.idrac_user:
idrac_ip: 198.162.0.1
idrac_user: idrac_user
idrac_password: idrac_password
ca_path: "/path/to/ca_cert.pem"
state: absent
user_name: user_name
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Details of the HTTP Error. Returned: on HTTP error Sample: |
|
Status of the iDRAC user configuration. Returned: always Sample: |
|
Configures the iDRAC users attributes. Returned: success Sample: |