dellemc.openmanage.idrac_user – Configure settings for user accounts
Note
This plugin is part of the dellemc.openmanage collection (version 3.6.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.
New in version 2.1.0: of dellemc.openmanage
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 >= 2.7.5
Parameters
| Parameter | Choices/Defaults | 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.
An authentication protocol is not configured if None is selected.
|
| enable
boolean
|
|
Provide the option to enable or disable a user from logging in to iDRAC.
|
| idrac_ip
string / required
|
iDRAC IP Address.
|
|
| idrac_password
string / required
|
iDRAC user password.
aliases: idrac_pwd |
|
| idrac_port
integer
|
Default:
443
|
iDRAC port.
|
| idrac_user
string / required
|
iDRAC username.
|
|
| ipmi_lan_privilege
string
|
|
The Intelligent Platform Management Interface LAN privilege level assigned to the user.
|
| 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.
|
| new_user_name
string
|
Provide the user_name for the account to be modified.
|
|
| 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.
A privacy protocol is not configured if None is selected.
|
| 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.
|
| protocol_enable
boolean
|
|
Enables protocol for the iDRAC user.
|
| sol_enable
boolean
|
|
Enables Serial Over Lan (SOL) for an iDRAC user.
|
| state
string
|
|
Select
present to create or modify a user account.
Select
absent to remove a user account.
Ensure Lifecycle Controller is available because the user operation uses the capabilities of Lifecycle Controller.
|
| user_name
string / required
|
Provide the user_name of the account to be created, deleted or modified.
|
|
| user_password
string
|
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.
|
Notes
Note
- Run this module from a system that has direct access to DellEMC 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
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
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
state: absent
user_name: user_name
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| error_info
dictionary
|
on HTTP error |
Details of the 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
|
always |
Status of the iDRAC user configuration.
Sample:
Successfully created user account details.
|
| status
dictionary
|
success |
Configures the iDRAC users attributes.
Sample:
{'@Message.ExtendedInfo': [{'Message': 'Successfully Completed Request', 'MessageArgs': [], 'MessageArgs@odata.count': 0, 'MessageId': 'Base.1.5.Success', 'RelatedProperties': [], 'RelatedProperties@odata.count': 0, 'Resolution': 'None', 'Severity': 'OK'}, {'Message': 'The operation successfully completed.', 'MessageArgs': [], 'MessageArgs@odata.count': 0, 'MessageId': 'IDRAC.2.1.SYS413', 'RelatedProperties': [], 'RelatedProperties@odata.count': 0, 'Resolution': 'No response action is required.', 'Severity': 'Informational'}]}
|
Authors
- Felix Stephen (@felixs88)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/dellemc/openmanage/idrac_user_module.html