lowell80.splunk.splunk_cli (0.12.3) — module

Install collection

Install with ansible-galaxy collection install lowell80.splunk:==0.12.3

Add to requirements.yml

  collections:
    - name: lowell80.splunk
      version: 0.12.3

Description

This is a lightweight wrapper around the Splunk CLI that handles auth parameter hiding and some other niceties.

If the Splunk command requires authentication, provide the I(username) and I(password) options.

Inputs

    
cmd:
    default: null
    description:
    - Command line arguments to the Splunk CLI
    required: true

password:
    default: null
    description:
    - The password for username/password authentication.
    - Must be provided if I(username) is provided.
    required: false

username:
    default: null
    description:
    - Splunk username for username/password authentication.
    - When provided, I(password) must also be specified.
    required: false

splunk_home:
    default: /opt/splunk
    description:
    - The Splunk installation home.  $SPLUNK_HOME
    required: true

splunkd_uri:
    aliases:
    - uri
    default: https://localhost:8089
    description:
    - The Splunkd endpoint of the Splunk server to configure.
    - Defaults to the local server and default splunkd port.
    required: false