salt.modules.splunk

Module for interop with the Splunk API

New in version 2016.3.0..

depends:
  • splunk-sdk python module
configuration:

Configure this module by specifying the name of a configuration profile in the minion config, minion pillar, or master config. The module will use the 'splunk' key by default, if defined.

For example:

splunk:
    username: alice
    password: abc123
    host: example.splunkcloud.com
    port: 8080
salt.modules.splunk.create_user(email, profile=u'splunk', **kwargs)

create a splunk user by name/email

CLI Example:

salt myminion splunk.create_user user@example.com roles=['user'] realname="Test User" name=testuser
salt.modules.splunk.delete_user(email, profile=u'splunk')

Delete a splunk user by email

CLI Example:

salt myminion splunk_user.delete 'user@example.com'
salt.modules.splunk.get_user(email, profile=u'splunk', **kwargs)

Get a splunk user by name/email

CLI Example:

salt myminion splunk.get_user 'user@example.com' user_details=false salt myminion splunk.get_user 'user@example.com' user_details=true
salt.modules.splunk.list_users(profile=u'splunk')

List all users in the splunk DB

CLI Example:

salt myminion splunk.list_users
salt.modules.splunk.update_user(email, profile=u'splunk', **kwargs)

Create a splunk user by email

CLI Example:

salt myminion splunk.update_user example@domain.com roles=['user'] realname="Test User"