community.general.syslogger module – Log messages in the syslog
Note
This module is part of the community.general collection (version 9.5.1).
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 community.general
.
To use it in a playbook, specify: community.general.syslogger
.
Synopsis
Uses syslog to add log entries to the host.
Parameters
Parameter |
Comments |
---|---|
Set the log facility. Choices:
|
|
Specify the name of application name which is sending the log to syslog. Default: |
|
Log the PID in brackets. Choices:
|
|
This is the message to place in syslog. |
|
Set the log priority. Choices:
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: none |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
Examples
- name: Simple Usage
community.general.syslogger:
msg: "I will end up as daemon.info"
- name: Send a log message with err priority and user facility with log_pid
community.general.syslogger:
msg: "Hello from Ansible"
priority: "err"
facility: "user"
log_pid: true
- name: Specify the name of application which is sending log message
community.general.syslogger:
ident: "MyApp"
msg: "I want to believe"
priority: "alert"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Syslog facility Returned: always Sample: |
|
Name of application sending the message to log Returned: always Sample: |
|
Log PID status Returned: always Sample: |
|
Message sent to syslog Returned: always Sample: |
|
Priority level Returned: always Sample: |