2014-06-30 21:04:53 +00:00
|
|
|
.\" Man page generated from reStructuredText.
|
|
|
|
|
.
|
2015-09-30 18:58:34 +00:00
|
|
|
.TH "SALT-RUN" "1" "September 30, 2015" "2015.8.1" "Salt"
|
2011-07-09 23:13:08 +00:00
|
|
|
.SH NAME
|
|
|
|
|
salt-run \- salt-run Documentation
|
|
|
|
|
.
|
|
|
|
|
.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
|
|
|
|
|
..
|
|
|
|
|
.sp
|
|
|
|
|
Execute a Salt runner
|
|
|
|
|
.SH SYNOPSIS
|
2014-06-30 21:04:53 +00:00
|
|
|
.INDENT 0.0
|
|
|
|
|
.INDENT 3.5
|
2011-07-09 23:13:08 +00:00
|
|
|
.sp
|
|
|
|
|
.nf
|
|
|
|
|
.ft C
|
|
|
|
|
salt\-run RUNNER
|
|
|
|
|
.ft P
|
|
|
|
|
.fi
|
2014-06-30 21:04:53 +00:00
|
|
|
.UNINDENT
|
|
|
|
|
.UNINDENT
|
2011-07-09 23:13:08 +00:00
|
|
|
.SH DESCRIPTION
|
|
|
|
|
.sp
|
2014-06-30 21:04:53 +00:00
|
|
|
salt\-run is the frontend command for executing \fBSalt Runners\fP\&.
|
2011-07-09 23:13:08 +00:00
|
|
|
Salt runners are simple modules used to execute convenience functions on the
|
|
|
|
|
master
|
|
|
|
|
.SH OPTIONS
|
|
|
|
|
.INDENT 0.0
|
|
|
|
|
.TP
|
2013-09-17 23:58:01 +00:00
|
|
|
.B \-\-version
|
|
|
|
|
Print the version of Salt that is running.
|
2011-07-09 23:13:08 +00:00
|
|
|
.UNINDENT
|
|
|
|
|
.INDENT 0.0
|
|
|
|
|
.TP
|
2013-09-17 23:58:01 +00:00
|
|
|
.B \-\-versions\-report
|
|
|
|
|
Show program\(aqs dependencies and version number, and then exit
|
2012-12-14 13:50:47 +00:00
|
|
|
.UNINDENT
|
|
|
|
|
.INDENT 0.0
|
|
|
|
|
.TP
|
2013-09-17 23:58:01 +00:00
|
|
|
.B \-h, \-\-help
|
|
|
|
|
Show the help message and exit
|
2012-12-14 13:50:47 +00:00
|
|
|
.UNINDENT
|
|
|
|
|
.INDENT 0.0
|
|
|
|
|
.TP
|
|
|
|
|
.B \-c CONFIG_DIR, \-\-config\-dir=CONFIG_dir
|
2013-09-17 23:58:01 +00:00
|
|
|
The location of the Salt configuration directory. This directory contains
|
2012-12-14 13:50:47 +00:00
|
|
|
the configuration files for Salt master and minions. The default location
|
2014-06-30 21:04:53 +00:00
|
|
|
on most systems is \fB/etc/salt\fP\&.
|
2013-09-17 23:58:01 +00:00
|
|
|
.UNINDENT
|
|
|
|
|
.INDENT 0.0
|
|
|
|
|
.TP
|
|
|
|
|
.B \-t TIMEOUT, \-\-timeout=TIMEOUT
|
|
|
|
|
The timeout in seconds to wait for replies from the Salt minions. The
|
|
|
|
|
timeout number specifies how long the command line client will wait to
|
|
|
|
|
query the minions and check on running jobs. Default: 1
|
|
|
|
|
.UNINDENT
|
|
|
|
|
.INDENT 0.0
|
|
|
|
|
.TP
|
2015-05-06 17:08:46 +00:00
|
|
|
.B \-\-hard\-crash
|
|
|
|
|
Raise any original exception rather than exiting gracefully. Default is
|
|
|
|
|
False.
|
|
|
|
|
.UNINDENT
|
|
|
|
|
.INDENT 0.0
|
|
|
|
|
.TP
|
2013-09-17 23:58:01 +00:00
|
|
|
.B \-d, \-\-doc, \-\-documentation
|
|
|
|
|
Display documentation for runners, pass a module or a runner to see
|
|
|
|
|
documentation on only that module/runner.
|
|
|
|
|
.UNINDENT
|
|
|
|
|
.SS Logging Options
|
|
|
|
|
.sp
|
|
|
|
|
Logging options which override any settings defined on the configuration files.
|
|
|
|
|
.INDENT 0.0
|
|
|
|
|
.TP
|
|
|
|
|
.B \-l LOG_LEVEL, \-\-log\-level=LOG_LEVEL
|
|
|
|
|
Console logging log level. One of \fBall\fP, \fBgarbage\fP, \fBtrace\fP,
|
2014-06-30 21:04:53 +00:00
|
|
|
\fBdebug\fP, \fBinfo\fP, \fBwarning\fP, \fBerror\fP, \fBquiet\fP\&. Default:
|
|
|
|
|
\fBwarning\fP\&.
|
2013-09-17 23:58:01 +00:00
|
|
|
.UNINDENT
|
|
|
|
|
.INDENT 0.0
|
|
|
|
|
.TP
|
|
|
|
|
.B \-\-log\-file=LOG_FILE
|
2014-06-30 21:04:53 +00:00
|
|
|
Log file path. Default: /var/log/salt/master\&.
|
2013-09-17 23:58:01 +00:00
|
|
|
.UNINDENT
|
|
|
|
|
.INDENT 0.0
|
|
|
|
|
.TP
|
|
|
|
|
.B \-\-log\-file\-level=LOG_LEVEL_LOGFILE
|
|
|
|
|
Logfile logging log level. One of \fBall\fP, \fBgarbage\fP, \fBtrace\fP,
|
2014-06-30 21:04:53 +00:00
|
|
|
\fBdebug\fP, \fBinfo\fP, \fBwarning\fP, \fBerror\fP, \fBquiet\fP\&. Default:
|
|
|
|
|
\fBwarning\fP\&.
|
2011-07-09 23:13:08 +00:00
|
|
|
.UNINDENT
|
2012-05-10 22:10:39 +00:00
|
|
|
.SH SEE ALSO
|
|
|
|
|
.sp
|
|
|
|
|
\fIsalt(1)\fP
|
|
|
|
|
\fIsalt\-master(1)\fP
|
|
|
|
|
\fIsalt\-minion(1)\fP
|
2011-07-09 23:13:08 +00:00
|
|
|
.SH AUTHOR
|
2012-07-28 00:04:56 +00:00
|
|
|
Thomas S. Hatch <thatch45@gmail.com> and many others, please see the Authors file
|
2011-07-09 23:13:08 +00:00
|
|
|
.SH COPYRIGHT
|
2015-03-10 00:36:38 +00:00
|
|
|
2015 SaltStack, Inc.
|
2011-07-09 23:13:08 +00:00
|
|
|
.\" Generated by docutils manpage writer.
|
|
|
|
|
.
|
