Users Guide
Table Of Contents
- Dell EMC OpenManage Ansible Modules Version 4.0.0 User’s Guide
- Contents
- Overview
- Getting Started
- Modules for iDRAC
- How OpenManage Ansible Modules work with iDRAC
- Running your first iDRAC Playbook
- Updating Firmware
- Configuring PowerEdge Servers
- Deploying operating system
- Server Inventory
- Server administration tasks
- Storage controller
- Modules for OpenManage Enterprise (OME)
- How OpenManage Ansible Modules work with OME
- Running your first OME Playbook
- Manage Devices
- Manage device configuration templates
- Template Service
- Manage the device firmware
- Manage jobs
- Manage users
- Manage identity pool
- Manage application settings
- Manage network configuration
- Manage fabrics
- Manage Profiles
- Device discovery
- Manage Chassis
- Manage Active Directory service and user groups
- Diagnostics
- Modules for Redfish APIs
- Deprecated modules
Table 5. idrac_user (continued)
Parameter/aliases Required Default Choices Comments
protocol_enable False NA
● Enabled
● Disabled
Select enabled to enable Simple Network
Management Protocol version 3 (SNMP
V3) support.
authentication_protocol No NA
● T_None
● SHA
● MD5
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 C(none) is selected.
privacy_protocol No NA
● T_None
● DES
● AES
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
C(none) is selected.
Return Values
msg:
description: Status of the iDRAC user configuration.
returned: always
type: str
sample: "Successfully created user account details."
status:
description: Configures the iDRAC users attributes.
returned: success
type: dict
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"}
]}
error_info:
description: Details of the HTTP Error.
returned: on HTTP error
type: dict
sample: {
"error": {
"code": "Base.1.0.GeneralError",
"message": "A general error has occurred. See ExtendedInfo for more information.",
"@Message.ExtendedInfo": [
{
"MessageId": "GEN1234",
"RelatedProperties": [],
"Message": "Unable to process the request because an error occurred.",
"MessageArgs": [],
Modules for iDRAC
21