Before continuing make sure you have a working Salt installation by following the installation and the configuration instructions.
salt '<target>' <function> [arguments]
The target component allows you to filter which minions should run the following function. The default filter is a glob on the minion id. For example:
salt '*' test.ping salt '*.example.org' test.ping
Targets can be based on minion system information using the Grains system:
salt -G 'os:Ubuntu' test.ping
Targets can be filtered by regular expression:
salt -E 'virtmach[0-9]' test.ping
Targets can be explicitly specified in a list:
salt -L 'foo,bar,baz,quo' test.ping
Or Multiple target types can be combined in one command:
salt -C 'G@os:Ubuntu and webser* or E@database.*' test.ping
A function is some functionality provided by a module. Salt ships with a large collection of available functions. List all available functions on your minions:
salt '*' sys.doc
Here are some examples:
Show all currently available minions:
salt '*' test.ping
Run an arbitrary shell command:
salt '*' cmd.run 'uname -a'
Space-delimited arguments to the function:
salt '*' cmd.exec_code python 'import sys; print sys.version'
Optional, keyword arguments are also supported:
salt '*' pip.install salt timeout=5 upgrade=True
They are always in the form of kwarg=argument.
These docs are for Salt's development version: 7dfce99.
Docs for previous releases are available on salt.rtfd.org.
Latest Salt release: 2014.1.0
Enter search terms or a module, class or function name.