dellemc.openmanage.ome_application_alerts_syslog module – Configure syslog forwarding settings on OpenManage Enterprise and OpenManage Enterprise Modular
Note
This module is part of the dellemc.openmanage collection (version 6.3.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
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: dellemc.openmanage.ome_application_alerts_syslog
.
New in dellemc.openmanage 4.3.0
Synopsis
This module allows to configure syslog forwarding settings on OpenManage Enterprise and OpenManage Enterprise Modular.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.8.6
Parameters
Parameter |
Comments |
---|---|
The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation. |
|
OpenManage Enterprise or OpenManage Enterprise Modular IP address or hostname. |
|
OpenManage Enterprise or OpenManage Enterprise Modular password. |
|
OpenManage Enterprise or OpenManage Enterprise Modular HTTPS port. Default: |
|
List of servers to forward syslog. |
|
The IP address, FQDN or hostname of the syslog server. This is required if enabled is |
|
Enable or disable syslog forwarding. Choices:
|
|
The ID of the syslog server. Choices:
|
|
The UDP port number of the syslog server. |
|
The socket level timeout in seconds. Default: |
|
OpenManage Enterprise or OpenManage Enterprise Modular username. |
|
If Configure Prior to collection version Choices:
|
Notes
Note
Run this module from a system that has direct access to Dell EMC OpenManage Enterprise or Dell EMC OpenManage Enterprise Modular.
This module supports
check_mode
.
Examples
---
- name: Configure single server to forward syslog
dellemc.openmanage.ome_application_alerts_syslog:
hostname: 192.168.0.1
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
syslog_servers:
- id: 1
enabled: true
destination_address: 192.168.0.2
port_number: 514
- name: Configure multiple server to forward syslog
dellemc.openmanage.ome_application_alerts_syslog:
hostname: 192.168.0.1
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
syslog_servers:
- id: 1
port_number: 523
- id: 2
enabled: true
destination_address: sysloghost1.lab.com
- id: 3
enabled: false
- id: 4
enabled: true
destination_address: 192.168.0.4
port_number: 514
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 forwarding operation. Returned: always Sample: |
|
Syslog forwarding settings list applied. Returned: on success Sample: |