2011-05-13 22:45:53 -06:00
|
|
|
.TH salt 1 "May 2011" "salt 0.8.7" "salt Manual"
|
2011-04-01 21:47:31 -06:00
|
|
|
|
|
|
|
.SH NAME
|
|
|
|
salt \- Parallel remote execution system
|
|
|
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
.B salt '*' [ options ] sys.doc
|
|
|
|
|
|
|
|
.B salt -E '.*' [ options ] sys.doc cmd
|
|
|
|
|
|
|
|
.B salt -F 'operatingsystem:Arch.*' [ options ] test.ping
|
|
|
|
|
|
|
|
.B salt -Q test.ping
|
|
|
|
|
|
|
|
.SH DESCRIPTION
|
2011-05-26 12:17:02 +01:00
|
|
|
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.
|
2011-04-01 21:47:31 -06:00
|
|
|
|
|
|
|
.SH OPTIONS
|
|
|
|
.TP
|
|
|
|
-h, --help
|
|
|
|
Print a usage message briefly summarizing these command-line options
|
|
|
|
|
|
|
|
.TP
|
|
|
|
-t TIMEOUT, --timeout=TIMEOUT
|
|
|
|
The timeout in seconds to wait for replies from the salt minions.
|
|
|
|
|
|
|
|
.TP
|
|
|
|
-E, --pcre
|
2011-05-26 12:17:02 +01:00
|
|
|
The target expression will be interpreted as a pcre regular expression rather than
|
|
|
|
a shell glob.
|
2011-04-01 21:47:31 -06:00
|
|
|
|
|
|
|
.TP
|
|
|
|
-L, --list
|
2011-05-26 12:17:02 +01:00
|
|
|
The target expression will be interpreted as a comma delimited list,
|
|
|
|
example: server1.foo.bar,server2.foo.bar,example7.quo.qux
|
2011-04-01 21:47:31 -06:00
|
|
|
|
|
|
|
.TP
|
2011-05-13 22:54:36 -06:00
|
|
|
-G, --grain
|
2011-05-26 12:17:02 +01:00
|
|
|
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.*'
|
2011-04-01 21:47:31 -06:00
|
|
|
|
|
|
|
.TP
|
|
|
|
-Q, --query
|
2011-05-26 12:17:02 +01:00
|
|
|
Execute a salt command query, this can be used to find the results os a previous
|
|
|
|
function call: -Q test.echo')
|
2011-04-01 21:47:31 -06:00
|
|
|
|
|
|
|
.TP
|
|
|
|
-c CONFIG, --config=CONFIG
|
2011-05-26 12:17:02 +01:00
|
|
|
The location of the salt master configuration file, the salt master settings are
|
|
|
|
required to know where the connections are; default=/etc/salt/master
|
2011-04-01 21:47:31 -06:00
|
|
|
|
|
|
|
.SH AUTHORS
|
|
|
|
Thomas S. Hatch <thatch@gmail.com>
|