2013-01-16 03:49:54 +00:00
|
|
|
.TH "SALT-CALL" "1" "January 15, 2013" "0.12.0" "Salt"
|
2011-08-27 17:38:12 +00:00
|
|
|
.SH NAME
|
|
|
|
salt-call \- salt-call 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
|
|
|
|
..
|
2013-01-16 03:49:54 +00:00
|
|
|
.\" Man page generated from reStructeredText.
|
2011-08-27 17:38:12 +00:00
|
|
|
.
|
|
|
|
.SH SYNOPSIS
|
|
|
|
.sp
|
|
|
|
.nf
|
|
|
|
.ft C
|
|
|
|
salt\-call [options]
|
|
|
|
.ft P
|
|
|
|
.fi
|
2012-09-30 21:58:27 +00:00
|
|
|
.SH DESCRIPTION
|
|
|
|
.sp
|
|
|
|
The salt\-call command is used to run module functions locally on a minion
|
|
|
|
instead of executing them from the master.
|
2011-08-27 17:38:12 +00:00
|
|
|
.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 \-g, \-\-grains
|
2012-06-16 22:25:22 +00:00
|
|
|
Return the information generated by the Salt grains
|
2011-08-27 17:38:12 +00:00
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
|
|
|
.TP
|
|
|
|
.B \-m MODULE_DIRS, \-\-module\-dirs=MODULE_DIRS
|
|
|
|
Specify an additional directories to pull modules from, multiple
|
|
|
|
directories can be delimited by commas
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
|
|
|
.TP
|
2012-12-14 13:50:47 +00:00
|
|
|
.B \-\-return RETURNER
|
|
|
|
Set salt\-call to pass the return data to one or many returner interfaces.
|
|
|
|
To use many returner interfaces specify a comma delimited list of
|
|
|
|
returners.
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
|
|
|
.TP
|
|
|
|
.B \-\-local
|
|
|
|
Run salt\-call locally, as if there was no master running.
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
|
|
|
.TP
|
2011-08-27 17:38:12 +00:00
|
|
|
.B \-d, \-\-doc
|
2012-06-16 22:25:22 +00:00
|
|
|
Return the documentation for the specified module or for all modules if
|
2011-08-27 17:38:12 +00:00
|
|
|
none are specified
|
|
|
|
.UNINDENT
|
2012-03-19 19:02:36 +00:00
|
|
|
.INDENT 0.0
|
|
|
|
.TP
|
|
|
|
.B \-l LOG_LEVEL, \-\-log\-level=LOG_LEVEL
|
|
|
|
Console log level. One of \fBinfo\fP, \fBnone\fP, \fBgarbage\fP,
|
|
|
|
\fBtrace\fP, \fBwarning\fP, \fBerror\fP, \fBdebug\fP. For the logfile
|
|
|
|
settings see the config file. Default: \fBinfo\fP.
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
|
|
|
.TP
|
2012-12-14 13:50:47 +00:00
|
|
|
.B \-c CONFIG_DIR, \-\-config\-dir=CONFIG_dir
|
|
|
|
The location of the Salt configuration directory, this directory contains
|
|
|
|
the configuration files for Salt master and minions. The default location
|
|
|
|
on most systems is /etc/salt.
|
2012-03-19 19:02:36 +00:00
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
|
|
|
.TP
|
2012-12-14 13:50:47 +00:00
|
|
|
.B \-\-out
|
|
|
|
Pass in an alternative outputter to display the return of data. This
|
|
|
|
outputter can be any of the available outputters:
|
|
|
|
grains, highstate, json, key, overstatestage, pprint, raw, txt, yaml
|
|
|
|
Some outputters are formatted only for data returned from specific
|
|
|
|
functions, for instance the grains outputter will not work for non grains
|
|
|
|
data.
|
|
|
|
If an outputter is used that does not support the data passed into it, then
|
|
|
|
Salt will fall back on the pprint outputter and display the return data
|
|
|
|
using the python pprint library.
|
2012-03-19 19:02:36 +00:00
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
|
|
|
.TP
|
2012-12-14 13:50:47 +00:00
|
|
|
.B \-\-out\-indent OUTPUT_INDENT, \-\-output\-indent OUTPUT_INDENT
|
|
|
|
Print the output indented by the provided value in spaces. Negative values
|
|
|
|
disables indentation. Only applicable in outputters that support indentation.
|
2012-03-19 19:02:36 +00:00
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
|
|
|
.TP
|
2012-12-14 13:50:47 +00:00
|
|
|
.B \-\-no\-color
|
|
|
|
Disable all colored output
|
2012-03-19 19:02:36 +00:00
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
|
|
|
.TP
|
2012-12-14 13:50:47 +00:00
|
|
|
.B \-\-version
|
|
|
|
Show program\(aqs version number and exit
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
|
|
|
.TP
|
|
|
|
.B \-\-versions\-report
|
|
|
|
Show program\(aqs dependencies version number and exit
|
2012-03-19 19:02:36 +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-08-27 17:38:12 +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-08-27 17:38:12 +00:00
|
|
|
.SH COPYRIGHT
|
2013-01-16 03:49:54 +00:00
|
|
|
2013, Thomas S. Hatch
|
2011-08-27 17:38:12 +00:00
|
|
|
.\" Generated by docutils manpage writer.
|
2013-01-16 03:49:54 +00:00
|
|
|
.\"
|
2011-08-27 17:38:12 +00:00
|
|
|
.
|