W3cubDocs

/Ansible

community.general.syslog_json – sends JSON events to syslog

Note

This plugin is part of the community.general collection (version 3.8.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.syslog_json.

Synopsis

  • This plugin logs ansible-playbook and ansible runs to a syslog server in JSON format
  • Before 2.9 only environment variables were available for configuration

Requirements

The below requirements are needed on the local controller node that executes this callback.

  • whitelist in configuration

Parameters

Parameter Choices/Defaults Configuration Comments
facility
string
Default:
"user"
ini entries:

[callback_syslog_json]
syslog_facility = user

env:SYSLOG_FACILITY
syslog facility to log as
port
string
Default:
514
ini entries:

[callback_syslog_json]
syslog_port = 514

env:SYSLOG_PORT
port on which the syslog server is listening
server
string
Default:
"localhost"
ini entries:

[callback_syslog_json]
syslog_server = localhost

env:SYSLOG_SERVER
syslog server that will receive the event

Authors

  • Unknown (!UNKNOWN)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/syslog_json_callback.html