dellemc.openmanage.idrac_syslog module – Enable or disable the syslog on iDRAC

Note

This module is part of the dellemc.openmanage collection (version 8.5.0).

To install it, use: ansible-galaxy collection install dellemc.openmanage. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: dellemc.openmanage.idrac_syslog.

New in dellemc.openmanage 2.1.0

Synopsis

  • This module allows to enable or disable the iDRAC syslog.

Requirements

The below requirements are needed on the host that executes this module.

  • omsdk >= 1.2.488

  • python >= 3.9.6

Parameters

Parameter

Comments

ca_path

path

added in dellemc.openmanage 5.0.0

The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation.

idrac_ip

string / required

iDRAC IP Address.

idrac_password

aliases: idrac_pwd

string / required

iDRAC user password.

idrac_port

integer

iDRAC port.

Default: 443

idrac_user

string / required

iDRAC username.

share_mnt

string

Local mount path of the network share with read-write permission for ansible user. This option is mandatory for network shares.

share_name

string / required

Network share or a local path.

share_password

aliases: share_pwd

string

Network share user password. This option is mandatory for CIFS share.

share_user

string

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.

syslog

string

Enables or disables an iDRAC syslog.

Choices:

  • "Enabled" ← (default)

  • "Disabled"

timeout

integer

added in dellemc.openmanage 5.0.0

The socket level timeout in seconds.

Default: 30

validate_certs

boolean

added in dellemc.openmanage 5.0.0

If false, the SSL certificates will not be validated.

Configure false only on personally controlled sites where self-signed certificates are used.

Prior to collection version 5.0.0, the validate_certs is false by default.

Choices:

  • false

  • true ← (default)

Notes

Note

  • This module requires ‘Administrator’ privilege for idrac_user.

  • Run this module from a system that has direct access to Dell iDRAC.

  • This module supports both IPv4 and IPv6 address for idrac_ip.

  • 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"
       ca_path: "/path/to/ca_cert.pem"
       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"
       ca_path: "/path/to/ca_cert.pem"
       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

error_info

dictionary

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."}}

msg

string

Overall status of the syslog export operation.

Returned: always

Sample: "Successfully fetch the syslogs."

syslog_status

dictionary

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)