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 59. ome_diagnostics (continued)
Parameter Required Default Choices Comments
applicable for
I(test_connection).
Return Values
msg:
type: str
description: "Overall status of the export log."
returned: always
sample: "Export log job completed successfully.
"jog_status:
type: dict
description: Details of the export log operation status.
returned: success
sample: {
"Builtin": false,
"CreatedBy": "root",
"Editable": true,
"EndTime": None,
"Id": 12778,
"JobDescription": "Export device log",
"JobName": "Export Log",
"JobStatus": {"Id": 2080, "Name": "New"},
"JobType": {"Id": 18, "Internal": false,
"Name": "DebugLogs_Task"},
"LastRun": "2021-07-06 10:52:50.519",
"LastRunStatus": {"Id": 2060, "Name": "Completed"},
"NextRun": None,
"Schedule": "startnow",
"StartTime": None,
"State": "Enabled",
"UpdatedBy": None,
"UserGenerated": true,
"Visible": true,
"Params": [
{"JobId": 12778, "Key": "maskSensitiveInfo", "Value": "FALSE"},
{"JobId": 12778, "Key": "password", "Value":
"tY86w7q92u0QzvykuF0gQQ"},
{"JobId": 12778, "Key": "userName", "Value": "administrator"},
{"JobId": 12778, "Key": "shareName", "Value": "iso"},
{"JobId": 12778, "Key": "OPERATION_NAME", "Value": "EXTRACT_LOGS"},
{"JobId": 12778, "Key": "shareType", "Value": "CIFS"},
{"JobId": 12778, "Key": "shareAddress", "Value": "100.96.32.142"}
],
"Targets": [{"Data": "", "Id": 10053, "JobId": 12778, "TargetType": {"Id": 1000,
"Name": "DEVICE"}}]
}
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": [],
"Severity": "Critical",
"Resolution": "Retry the operation. If the issue persists, contact your system
administrator."
}
]
}
}
170
Modules for OpenManage Enterprise (OME)