Try SpotterConfigure settings for user accounts
| "added in version" 2.1.0 of dellemc.openmanage"
Authors: Felix Stephen (@felixs88)
Install with ansible-galaxy collection install dellemc.openmanage:==9.1.0
collections:
- name: dellemc.openmanage
version: 9.1.0This module allows to perform the following,
Add a new user account.
Edit a user account.
Enable or Disable a user account.
---
- 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
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.
type: str
enable:
description: Provide the option to enable or disable a user from logging in to iDRAC.
type: bool
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
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.
- Will be ignored, if custom_privilege parameter is provided.
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.
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
sol_enable:
description: Enables Serial Over Lan (SOL) for an iDRAC user.
type: bool
new_user_name:
description: Provide the I(user_name) for the account to be modified.
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.
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
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
protocol_enable:
description: Enables protocol for the iDRAC user.
type: bool
custom_privilege:
description:
- The privilege level assigned to the user.
type: int
version_added: 8.1.0
version_added_collection: dellemc.openmanage
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.
type: str
ipmi_lan_privilege:
choices:
- Administrator
- Operator
- User
- No Access
description: The Intelligent Platform Management Interface LAN privilege level assigned
to the user.
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.
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.
type: str
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: Status of the iDRAC user configuration.
returned: always
sample: Successfully created user account details.
type: str
status:
description: Configures the iDRAC users attributes.
returned: success
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
type: dict