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 9. dellemc_configure_idrac_services (continued)
Parameter Required Default Choices Comments
community_name False test NA
SNMP community name for iDRAC.
It is used by iDRAC to validate
SNMP queries, and gets received
from remote systems requesting
SNMP data access.
alert_port False None NA
The iDRAC port number that must
be used for SNMP traps. The
default value is 162, and the
acceptable range is between 1 to
65535.
discovery_port False 162 NA
The SNMP agent port on the
iDRAC. The default value is 161, and
the acceptable range is between 1
to 65535.
trap_format False None
SNMPv1, SNMPv2 or
SNMPv3
SNMP trap format for iDRAC
ipmi_lan False NA NA
This option used by iDRAC when it
sends out SNMP and IPMI traps.
The community name is checked by
the remote system to which the
traps are sent.
Return Values
msg:
description: Overall status of iDRAC service attributes configuration.
returned: always
type: str
sample: Successfully configured the iDRAC services settings.
service_status:
description: Details of iDRAC services attributes configuration.
returned: success
type: dict
sample: {
"CompletionTime": "2020-04-02T02:43:28",
"Description": "Job Instance",
"EndTime": null,
"Id": "JID_12345123456",
"JobState": "Completed",
"JobType": "ImportConfiguration",
"Message": "Successfully imported and applied Server Configuration Profile.",
"MessageArgs": [],
"MessageId": "SYS053",
"Name": "Import Configuration",
"PercentComplete": 100,
"StartTime": "TIME_NOW",
"Status": "Success",
"TargetSettingsURI": null,
"retval": true
}
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.",
Modules for iDRAC
27