Distributed Deployment Manual

 


Supported CLI commands

NOTE - Splunk version 4.x reached its End of Life on October 1, 2013. Please see the migration information.

This documentation does not apply to the most recent version of Splunk. Click here for the latest version.

Supported CLI commands

The universal forwarder supports a subset of objects for use in CLI commands. Certain objects valid in full Splunk, like index (as in add index), make no sense in the context of the universal forwarder.

Commands act upon objects. If you type an invalid command/object combination, the universal forwarder will return an error message.

Valid CLI objects

The universal forwarder supports all CLI commands for these objects:

    ad
    app
    config
    datastore-dir
    default-hostname
    deploy-client
    deploy-poll
    eventlog
    exec
    forward-server
    monitor
    oneshot
    perfmon
    registry
    servername
    splunkd-port
    tcp
    udp
    user
    wmi

Note: A few commands, such as start and stop can be run without an object. A command with no object is also valid for the universal forwarder.

A brief introduction to CLI syntax

The general syntax for a CLI command is:

./splunk <command> [<object>] [[-<parameter>] <value>]...

As described above, it's the object that determines whether a command is valid in the universal forwarder. For example, the above list includes the monitor object. Therefore, the add monitor and edit monitor command/object combinations are both valid. For more information on the monitor object, see "Use the CLI to monitor files and directories" in the Getting Data In manual.

For more details on using the CLI in general, see the "Use Splunk's command line interface" chapter in the Admin manual. In particular, the topic "CLI admin commands" provides details on CLI syntax, including a list of all commands supported by full Splunk and the objects they can act upon.

This documentation applies to the following versions of Splunk: 4.2 , 4.2.1 , 4.2.2 , 4.2.3 , 4.2.4 , 4.2.5 , 4.3 , 4.3.1 , 4.3.2 , 4.3.3 , 4.3.4 , 4.3.5 , 4.3.6 , 4.3.7 , 5.0 , 5.0.1 , 5.0.2 , 5.0.3 , 5.0.4 , 5.0.5 , 5.0.6 , 5.0.7 , 5.0.8 , 5.0.9 , 5.0.10 , 5.0.11 View the Article History for its revisions.


Comments

Csowers - "config" is an object, not a command. Commands act on objects. The list specifies which objects are valid for universal forwarders. I've updated the topic to provide a clearer explanation of CLI syntax, as well as pointers to where you can go to get more information on the commands that act upon the listed objects.

Sgoodman, Splunker
June 27, 2012

Are you sure this documentation is up-to-date? These commands don't seem to work:

C:\Program Files\SplunkUniversalForwarder\bin>splunk config
Command error: 'config' is not a valid command. Please run 'splunk help' to see
the valid commands.

Csowers
June 26, 2012

You must be logged into splunk.com in order to post comments. Log in now.

Was this documentation topic helpful?

If you'd like to hear back from us, please provide your email address:

We'd love to hear what you think about this topic or the documentation as a whole. Feedback you enter here will be delivered to the documentation team.

Feedback submitted, thanks!