dellemc.openmanage.idrac_syslog – Enable or disable the syslog on iDRAC
Note
This plugin is part of the dellemc.openmanage collection (version 3.6.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
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
Parameter |
Comments |
---|---|
iDRAC IP Address. |
|
iDRAC user password. |
|
iDRAC port. Default: 443 |
|
iDRAC username. |
|
Local mount path of the network share with read-write permission for ansible user. This option is mandatory for network shares. |
|
Network share or a local path. |
|
Network share user password. This option is mandatory for CIFS share. |
|
Network share user name. Use the format ‘user@domain’ or ‘domain\user’ if user is part of a domain. This option is mandatory for CIFS share. |
|
Enables or disables an iDRAC syslog. Choices:
|
Notes
Note
This module requires ‘Administrator’ privilege for idrac_user.
Run this module from a system that has direct access to Dell EMC 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 |
Description |
---|---|
Details of the HTTP Error. Returned: on 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.”}} |
|
Overall status of the syslog export operation. Returned: always Sample: “Successfully fetch the syslogs.” |
|
Job details of the syslog operation. Returned: success 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”: null, “Id”: “JID_852940632485”, “JobState”: “Completed”, “JobType”: “ImportConfiguration”, “Message”: “Successfully imported and applied Server Configuration Profile.”, “MessageArgs”: [], “MessageArgs@odata.count”: 0, “MessageId”: “SYS053”, “Name”: “Import Configuration”, “PercentComplete”: 100, “StartTime”: “TIME_NOW”, “Status”: “Success”, “TargetSettingsURI”: null, “retval”: true} |
Authors
Felix Stephen (@felixs88)
Anooja Vardhineni (@anooja-vardhineni)