mirror of
https://github.com/valitydev/salt.git
synced 2024-11-08 01:18:58 +00:00
121 lines
3.2 KiB
ReStructuredText
121 lines
3.2 KiB
ReStructuredText
========
|
|
``salt``
|
|
========
|
|
|
|
Synopsis
|
|
========
|
|
|
|
salt '*' [ options ] sys.doc
|
|
|
|
salt -E '.*' [ options ] sys.doc cmd
|
|
|
|
salt -G 'os:Arch.*' [ options ] test.ping
|
|
|
|
salt -C 'G@os:Arch.* and webserv* or G@kernel:FreeBSD' [ options ] test.ping
|
|
|
|
salt -Q test.ping
|
|
|
|
Description
|
|
===========
|
|
|
|
Salt allows for commands to be executed across a swath of remote systems in
|
|
parallel. This means that remote systems can be both controlled and queried
|
|
with ease.
|
|
|
|
Options
|
|
=======
|
|
|
|
.. program:: salt
|
|
|
|
.. option:: -h, --help
|
|
|
|
Print a usage message briefly summarizing these command-line options
|
|
|
|
.. option:: -t TIMEOUT, --timeout=TIMEOUT
|
|
|
|
The timeout in seconds to wait for replies from the salt minions.
|
|
|
|
.. option:: --version
|
|
|
|
Print the version of salt that is running.
|
|
|
|
.. option:: -E, --pcre
|
|
|
|
The target expression will be interpreted as a pcre regular expression
|
|
rather than a shell glob.
|
|
|
|
.. option:: -L, --list
|
|
|
|
The target expression will be interpreted as a comma delimited list,
|
|
example: server1.foo.bar,server2.foo.bar,example7.quo.qux
|
|
|
|
.. option:: -G, --grain
|
|
|
|
The target expression matches values returned by the salt grains system on
|
|
the minions. The target expression is in the format of '<grain value>:<pcre
|
|
regular expression>'; example: 'os:Arch.*'
|
|
|
|
.. option:: -C, --compound
|
|
|
|
Utilize many target definitions to make the call very granular. This option
|
|
takes a group of targets separated by and or or. The default matcher is a
|
|
glob as usual, if something other than a glob is used preface it with the
|
|
letter denoting the type, example: 'webserv* and G@os:Debian or E@db.*'
|
|
make sure that the compound target is encapsulated in quotes.
|
|
|
|
.. option:: -X, --exsel
|
|
|
|
Instead of using shell globs use the return code of a function.
|
|
|
|
.. option:: -N, --nodegroup
|
|
|
|
Use a predefined compound target defined in the salt master configuration
|
|
file
|
|
|
|
.. option:: --return
|
|
|
|
Chose an alternative returner to call on the minion, if an alternative
|
|
returner is used then the return will not come back tot he command line
|
|
but will be sent to the specified return system.
|
|
|
|
.. option:: -Q, --query
|
|
|
|
The -Q option is being deprecated and will be removed in a future release,
|
|
Use the salt jobs interface instead, for documentation on the salt jobs
|
|
interface execute the command "salt-run -d jobs"
|
|
|
|
Execute a salt command query, this can be used to find the results of a
|
|
previous function call: -Q test.echo')
|
|
|
|
.. option:: -c CONFIG, --config=CONFIG
|
|
|
|
The location of the salt master configuration file, the salt master
|
|
settings are required to know where the connections are;
|
|
default=/etc/salt/master
|
|
|
|
.. option:: --raw-out
|
|
|
|
Print the output from the salt command in raw python
|
|
form, this is suitable for re-reading the output into
|
|
an executing python script with eval.
|
|
|
|
.. option:: --text-out
|
|
|
|
Print the output from the salt command in the same
|
|
form the shell would.
|
|
|
|
.. option:: --yaml-out
|
|
|
|
Print the output from the salt command in yaml.
|
|
|
|
.. option:: --json-out
|
|
|
|
Print the output from the salt command in json.
|
|
|
|
See also
|
|
========
|
|
|
|
:manpage:`salt(7)`
|
|
:manpage:`salt-master(1)`
|
|
:manpage:`salt-minion(1)`
|