2011-08-27 17:38:12 +00:00
|
|
|
.TH "SALT" "1" "August 27, 2011" "0.9.0" "Salt"
|
2011-04-02 03:47:31 +00:00
|
|
|
.SH NAME
|
2011-05-30 22:24:23 +00:00
|
|
|
salt \- salt
|
|
|
|
|
.
|
|
|
|
|
.nr rst2man-indent-level 0
|
|
|
|
|
.
|
|
|
|
|
.de1 rstReportMargin
|
|
|
|
|
\\$1 \\n[an-margin]
|
|
|
|
|
level \\n[rst2man-indent-level]
|
|
|
|
|
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
|
|
|
-
|
|
|
|
|
\\n[rst2man-indent0]
|
|
|
|
|
\\n[rst2man-indent1]
|
|
|
|
|
\\n[rst2man-indent2]
|
|
|
|
|
..
|
|
|
|
|
.de1 INDENT
|
|
|
|
|
.\" .rstReportMargin pre:
|
|
|
|
|
. RS \\$1
|
|
|
|
|
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
|
|
|
|
|
. nr rst2man-indent-level +1
|
|
|
|
|
.\" .rstReportMargin post:
|
|
|
|
|
..
|
|
|
|
|
.de UNINDENT
|
|
|
|
|
. RE
|
|
|
|
|
.\" indent \\n[an-margin]
|
|
|
|
|
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
|
|
|
.nr rst2man-indent-level -1
|
|
|
|
|
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
|
|
|
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
|
|
|
|
..
|
|
|
|
|
.\" Man page generated from reStructeredText.
|
|
|
|
|
.
|
2011-04-02 03:47:31 +00:00
|
|
|
.SH SYNOPSIS
|
2011-05-30 22:24:23 +00:00
|
|
|
.INDENT 0.0
|
|
|
|
|
.INDENT 3.5
|
|
|
|
|
salt \(aq*\(aq [ options ] sys.doc
|
|
|
|
|
.sp
|
|
|
|
|
salt \-E \(aq.*\(aq [ options ] sys.doc cmd
|
|
|
|
|
.sp
|
|
|
|
|
salt \-F \(aqoperatingsystem:Arch.*\(aq [ options ] test.ping
|
|
|
|
|
.sp
|
|
|
|
|
salt \-Q test.ping
|
|
|
|
|
.UNINDENT
|
|
|
|
|
.UNINDENT
|
2011-04-02 03:47:31 +00:00
|
|
|
.SH DESCRIPTION
|
2011-05-30 22:24:23 +00:00
|
|
|
.sp
|
|
|
|
|
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-02 03:47:31 +00:00
|
|
|
.SH OPTIONS
|
2011-05-30 22:24:23 +00:00
|
|
|
.INDENT 0.0
|
2011-04-02 03:47:31 +00:00
|
|
|
.TP
|
2011-05-30 22:24:23 +00:00
|
|
|
.B \-h, \-\-help
|
|
|
|
|
Print a usage message briefly summarizing these command\-line options
|
|
|
|
|
.UNINDENT
|
|
|
|
|
.INDENT 0.0
|
2011-04-02 03:47:31 +00:00
|
|
|
.TP
|
2011-05-30 22:24:23 +00:00
|
|
|
.B \-t TIMEOUT, \-\-timeout=TIMEOUT
|
2011-04-02 03:47:31 +00:00
|
|
|
The timeout in seconds to wait for replies from the salt minions.
|
2011-05-30 22:24:23 +00:00
|
|
|
.UNINDENT
|
|
|
|
|
.INDENT 0.0
|
2011-04-02 03:47:31 +00:00
|
|
|
.TP
|
2011-05-30 22:24:23 +00:00
|
|
|
.B \-E, \-\-pcre
|
|
|
|
|
The target expression will be interpreted as a pcre regular expression
|
|
|
|
|
rather than a shell glob.
|
|
|
|
|
.UNINDENT
|
|
|
|
|
.INDENT 0.0
|
2011-04-02 03:47:31 +00:00
|
|
|
.TP
|
2011-05-30 22:24:23 +00:00
|
|
|
.B \-L, \-\-list
|
2011-05-26 11:17:02 +00:00
|
|
|
The target expression will be interpreted as a comma delimited list,
|
|
|
|
|
example: server1.foo.bar,server2.foo.bar,example7.quo.qux
|
2011-05-30 22:24:23 +00:00
|
|
|
.UNINDENT
|
|
|
|
|
.INDENT 0.0
|
2011-04-02 03:47:31 +00:00
|
|
|
.TP
|
2011-05-30 22:24:23 +00:00
|
|
|
.B \-G, \-\-grain
|
|
|
|
|
The target expression matches values returned by the salt grains system on
|
|
|
|
|
the minions. The target expression is in the format of \(aq<grain value>:<pcre
|
|
|
|
|
regular expression>\(aq; example: \(aqos:Arch.*\(aq
|
|
|
|
|
.UNINDENT
|
|
|
|
|
.INDENT 0.0
|
2011-04-02 03:47:31 +00:00
|
|
|
.TP
|
2011-05-30 22:24:23 +00:00
|
|
|
.B \-Q, \-\-query
|
|
|
|
|
Execute a salt command query, this can be used to find the results os a
|
|
|
|
|
previous function call: \-Q test.echo\(aq)
|
|
|
|
|
.UNINDENT
|
|
|
|
|
.INDENT 0.0
|
2011-04-02 03:47:31 +00:00
|
|
|
.TP
|
2011-05-30 22:24:23 +00:00
|
|
|
.B \-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
|
|
|
|
|
.UNINDENT
|
|
|
|
|
.SH SEE ALSO
|
|
|
|
|
.sp
|
|
|
|
|
\fIsalt(7)\fP
|
|
|
|
|
\fIsalt\-master(1)\fP
|
|
|
|
|
\fIsalt\-minion(1)\fP
|
|
|
|
|
.SH AUTHOR
|
|
|
|
|
Thomas S. Hatch <thatch@gmail.com> and many others, please see the Authors file
|
|
|
|
|
.SH COPYRIGHT
|
2011-07-09 23:13:08 +00:00
|
|
|
2011, Thomas S. Hatch
|
2011-05-30 22:24:23 +00:00
|
|
|
.\" Generated by docutils manpage writer.
|
|
|
|
|
.\"
|
|
|
|
|
.
|
