dellemc.openmanage.idrac_user_info module – Retrieve details of all users or a specific user on iDRAC.
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_info
.
New in dellemc.openmanage 7.0.0
Synopsis
This module retrieves the list and basic details of all users or details of a specific user on iDRAC
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.8.6
Parameters
Parameter |
Comments |
---|---|
The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation. |
|
iDRAC IP Address. |
|
iDRAC user password. |
|
iDRAC port. Default: |
|
iDRAC username. |
|
The socket level timeout in seconds. Default: |
|
Sequential user id numbers that supports from 1 to 16. user_id is mutually exclusive with username |
|
Username of the account that is created in iDRAC local users. username is mutually exclusive with user_id |
|
If Configure Prior to collection version Choices:
|
Notes
Note
Run this module on a system that has direct access to Dell iDRAC.
This module supports
check_mode
.
Examples
---
- name: Retrieve basic details of all user accounts.
dellemc.openmanage.idrac_user_info:
idrac_ip: 198.162.0.1
idrac_user: idrac_user
idrac_password: idrac_password
ca_path: "/path/to/ca_cert.pem"
- name: Retrieve user details using user_id
dellemc.openmanage.idrac_user_info:
idrac_ip: 198.162.0.1
idrac_user: idrac_user
idrac_password: idrac_password
ca_path: "/path/to/ca_cert.pem"
user_id: 1
- name: Retrieve user details using username
dellemc.openmanage.idrac_user_info:
idrac_ip: 198.162.0.1
idrac_user: idrac_user
idrac_password: idrac_password
ca_path: "/path/to/ca_cert.pem"
username: 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 user information retrieval. Returned: always Sample: |
|
Information about the user. Returned: success Sample: |