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
-
create a splunk user by name/email
CLI Example:
salt myminion splunk.create_user [email protected] roles=['user'] realname="Test User" name=testuser
salt.modules.splunk.create_user(email, profile='splunk', **kwargs)
-
Delete a splunk user by email
CLI Example:
salt myminion splunk_user.delete '[email protected]'
salt.modules.splunk.delete_user(email, profile='splunk')
-
Get a splunk user by name/email
CLI Example:
salt myminion splunk.get_user '[email protected]' user_details=false salt myminion splunk.get_user '[email protected]' user_details=true
salt.modules.splunk.get_user(email, profile='splunk', **kwargs)
-
List all users in the splunk DB
CLI Example:
salt myminion splunk.list_users
salt.modules.splunk.list_users(profile='splunk')
-
Create a splunk user by email
CLI Example:
salt myminion splunk.update_user [email protected] roles=['user'] realname="Test User"
salt.modules.splunk.update_user(email, profile='splunk', **kwargs)
© 2021 SaltStack.
Licensed under the Apache License, Version 2.0.
https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.splunk.html