dellemc.openmanage.idrac_syslog – Enable or disable the syslog on iDRAC¶
Note
This plugin is part of the dellemc.openmanage collection (version 3.2.0).
To install it use: ansible-galaxy collection install dellemc.openmanage
.
To use it in a playbook, specify: dellemc.openmanage.idrac_syslog
.
New in version 2.1.0: of dellemc.openmanage
Requirements¶
The below requirements are needed on the host that executes this module.
omsdk
python >= 2.7.5
Parameters¶
Notes¶
Note
Run this module from a system that has direct access to DellEMC iDRAC.
This module supports
check_mode
.
Examples¶
---
- name: Enable iDRAC syslog
dellemc.openmanage.idrac_syslog:
idrac_ip: "192.168.0.1"
idrac_user: "user_name"
idrac_password: "user_password"
share_name: "192.168.0.2:/share"
share_password: "share_user_pwd"
share_user: "share_user_name"
share_mnt: "/mnt/share"
syslog: "Enabled"
- name: Disable iDRAC syslog
dellemc.openmanage.idrac_syslog:
idrac_ip: "192.168.0.1"
idrac_user: "user_name"
idrac_password: "user_password"
share_name: "192.168.0.2:/share"
share_password: "share_user_pwd"
share_user: "share_user_name"
share_mnt: "/mnt/share"
syslog: "Disabled"
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
error_info
dictionary
|
on HTTP error |
Details of the 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.'}}
|
msg
string
|
always |
Overall status of the syslog export operation.
Sample:
Successfully fetch the syslogs.
|
syslog_status
dictionary
|
success |
Job details of the syslog operation.
Sample:
{'@odata.context': '/redfish/v1/$metadata#DellJob.DellJob', '@odata.id': '/redfish/v1/Managers/iDRAC.Embedded.1/Jobs/JID_852940632485', '@odata.type': '#DellJob.v1_0_2.DellJob', 'CompletionTime': '2020-03-27T02:27:45', 'Description': 'Job Instance', 'EndTime': None, 'Id': 'JID_852940632485', 'JobState': 'Completed', 'JobType': 'ImportConfiguration', 'Message': 'Successfully imported and applied Server Configuration Profile.', 'MessageArgs': [], '[email protected]': 0, 'MessageId': 'SYS053', 'Name': 'Import Configuration', 'PercentComplete': 100, 'StartTime': 'TIME_NOW', 'Status': 'Success', 'TargetSettingsURI': None, 'retval': True}
|
Authors¶
Felix Stephen (@felixs88)
Anooja Vardhineni (@anooja-vardhineni)