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 |
---|---|
The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation. |
|
iDRAC IP Address. |
|
iDRAC user password. |
|
iDRAC port. Default: |
|
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:
|
|
The socket level timeout in seconds. Default: |
|
If Configure Prior to collection version Choices:
|
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 |
---|---|
Details of the HTTP Error. Returned: on HTTP error Sample: |
|
Overall status of the syslog export operation. Returned: always Sample: |
|
Job details of the syslog operation. Returned: success Sample: |