community.general.splunk – Sends task result events to Splunk HTTP Event Collector

Note

This plugin is part of the community.general collection (version 1.3.2).

To install it use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.splunk.

Synopsis
Requirements
Parameters
Examples

Synopsis

This callback plugin will send task results as JSON formatted events to a Splunk HTTP collector.
The companion Splunk Monitoring & Diagnostics App is available here “https://splunkbase.splunk.com/app/4023/”
Credit to “Ryan Currah (@ryancurrah)” for original source upon which this is based.

Requirements

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

Whitelisting this callback plugin
Create a HTTP Event Collector in Splunk
Define the url and token in ansible.cfg

Parameters

Parameter	Choices/Defaults	Configuration	Comments
authtoken string		ini entries: [callback_splunk]authtoken = None env:SPLUNK_AUTHTOKEN	Token to authenticate the connection to the Splunk HTTP collector
url string		ini entries: [callback_splunk]url = None env:SPLUNK_URL	URL to the Splunk HTTP collector source
validate_certs boolean added in 1.0.0 of community.general	no yes ←	ini entries: [callback_splunk]validate_certs = yes env:SPLUNK_VALIDATE_CERTS	Whether to validate certificates for connections to HEC. It is not recommended to set to `false` except when you are sure that nobody can intercept the connection between this plugin and HEC, as setting it to `false` allows man-in-the-middle attacks!

Examples

examples: >
  To enable, add this to your ansible.cfg file in the defaults block
    [defaults]
    callback_whitelist = community.general.splunk
  Set the environment variable
    export SPLUNK_URL=http://mysplunkinstance.datapaas.io:8088/services/collector/event
    export SPLUNK_AUTHTOKEN=f23blad6-5965-4537-bf69-5b5a545blabla88
  Set the ansible.cfg variable in the callback_splunk block
    [callback_splunk]
    url = http://mysplunkinstance.datapaas.io:8088/services/collector/event
    authtoken = f23blad6-5965-4537-bf69-5b5a545blabla88

Authors

Stuart Hirst (!UNKNOWN) <[email protected]>

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