.TH "SALT" "1" "July 27, 2012" "0.10.2" "Salt" .SH NAME 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 reStructuredText. . .SH SYNOPSIS .INDENT 0.0 .INDENT 3.5 salt \(aq*\(aq [ options ] sys.doc .sp salt \-E \(aq.*\(aq [ options ] sys.doc cmd .sp salt \-G \(aqos:Arch.*\(aq [ options ] test.ping .sp salt \-C \fI\%'G@os\fP:Arch.* and webserv* or \fI\%G@kernel\fP:FreeBSD\(aq [ options ] test.ping .sp salt \-Q test.ping .UNINDENT .UNINDENT .SH DESCRIPTION .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. .SH OPTIONS .INDENT 0.0 .TP .B \-h, \-\-help Print a usage message briefly summarizing these command\-line options .UNINDENT .INDENT 0.0 .TP .B \-t TIMEOUT, \-\-timeout=TIMEOUT The timeout in seconds to wait for replies from the Salt minions. .UNINDENT .INDENT 0.0 .TP .B \-s STATIC, \-\-static=STATIC By default as of version 0.9.8 the salt command returns data to the console as it is received from minions, but previous releases would return data only after all data was received. To only return the data with a hard timeout and after all minions have returned then use the static option. .UNINDENT .INDENT 0.0 .TP .B \-b BATCH, \-\-batch\-size=BATCH Instead of executing on all targeted minions at once, execute on a progressive set of minions. This option takes an argument in the form of an explicit number of minions to execute at once, or a percentage of minions to execute on. .UNINDENT .INDENT 0.0 .TP .B \-\-version Print the version of Salt that is running. .UNINDENT .INDENT 0.0 .TP .B \-E, \-\-pcre The target expression will be interpreted as a pcre regular expression rather than a shell glob. .UNINDENT .INDENT 0.0 .TP .B \-L, \-\-list The target expression will be interpreted as a comma delimited list, example: server1.foo.bar,server2.foo.bar,example7.quo.qux .UNINDENT .INDENT 0.0 .TP .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:\(aq; example: \(aqos:Arch*\(aq .sp This was changed in version 0.9.8 to accept glob expressions instead of regular expression. To use regular expression matching with grains use the \-\-grain\-pcre option. .UNINDENT .INDENT 0.0 .TP .B \-\-grain\-pcre The target expression matches values returned by the Salt grains system on the minions. The target expression is in the format of \(aq:< regular expression>\(aq; example: \(aqos:Arch.*\(aq .UNINDENT .INDENT 0.0 .TP .B \-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: \(aqwebserv* and \fI\%G@os\fP:Debian or \fI\%E@db*\fP\(aq make sure that the compound target is encapsulated in quotes. .UNINDENT .INDENT 0.0 .TP .B \-X, \-\-exsel Instead of using shell globs use the return code of a function. .UNINDENT .INDENT 0.0 .TP .B \-N, \-\-nodegroup Use a predefined compound target defined in the Salt master configuration file .UNINDENT .INDENT 0.0 .TP .B \-R, \-\-range Instead of using shell globs to evaluate the target use a range expression to identify targets. Range expressions look like %cluster. .sp Using the Range option requires that a range server is set up and the location of the range server is referenced in the master configuration file. .UNINDENT .INDENT 0.0 .TP .B \-\-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. .UNINDENT .INDENT 0.0 .TP .B \-Q, \-\-query The \-Q option is being deprecated and will be removed in version 0.9.9, Use the Salt jobs interface instead, for documentation on the Salt jobs interface execute the command "salt\-run \-d jobs" .sp Execute a salt command query, this can be used to find the results of a previous function call: \-Q test.echo\(aq) .UNINDENT .INDENT 0.0 .TP .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 .INDENT 0.0 .TP .B \-v VERBOSE, \-\-verbose Turn on verbosity for the salt call, this will cause the salt command to print out extra data like the job id. .UNINDENT .INDENT 0.0 .TP .B \-\-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. .UNINDENT .INDENT 0.0 .TP .B \-\-text\-out Print the output from the salt command in the same form the shell would. .UNINDENT .INDENT 0.0 .TP .B \-\-yaml\-out Print the output from the salt command in YAML. .UNINDENT .INDENT 0.0 .TP .B \-\-json\-out Print the output from the salt command in JSON. .UNINDENT .INDENT 0.0 .TP .B \-\-no\-color Disable all colored output .UNINDENT .SH SEE ALSO .sp \fIsalt(7)\fP \fIsalt\-master(1)\fP \fIsalt\-minion(1)\fP .SH AUTHOR Thomas S. Hatch and many others, please see the Authors file .SH COPYRIGHT 2012, Thomas S. Hatch .\" Generated by docutils manpage writer. .