Package Documentation

Storm Package: synapse-splunk

The following Commands are available from this package. This documentation is generated for version 0.3.1 of the package.

Storm Commands

This package implements the following Storm Commands.

splunk.setup.apikey

Manage the Splunk API key.

Examples

    // Set a global Splunk API key
    splunk.setup.apikey abcd1234

    // Set a Splunk API key for the current user
    splunk.setup.apikey --self abcd1234

    // Display the API key scope of the current key
    splunk.setup.apikey --show-scope

    // Display the current API key.
    splunk.setup.apikey --show-apikey

    // Remove the current global API key.
    splunk.setup.apikey --remove

    // Remove the per-user API key for the current user.
    splunk.setup.apikey --self --remove


Usage: splunk.setup.apikey [options] <apikey>

Options:

  --help                      : Display the command usage.
  --self                      : Set or remove the key as a user variable. If not used, the key is set globally.
  --show-scope                : Display the API key scope in use (global vs self).
  --show-apikey               : Display the API key value (requires admin perms or a "self" scope key).
  --remove                    : Remove the configured API key. May be used with --self.

Arguments:

  [apikey]                    : The API key string.

splunk.setup.domain

Set the domain name to use when making Splunk HTTP API requests.


Usage: splunk.setup.domain [options] <domain>

Options:

  --help                      : Display the command usage.
  --port <port>               : The port to use with the Splunk domain. (default: 8089)
  --insecure                  : Do not perform SSL/TLS verification.
  --noproxy                   : Disable proxy use.
  --self                      : Set the domain as a user variable. If not used, the domain is set globally.

Arguments:

  <domain>                    : The Splunk domain such as "mydeployment.splunkcloud.com".

Storm Modules

This package does not export any Storm APIs.