2014-06-30 21:04:53 +00:00
|
|
|
.\" Man page generated from reStructuredText.
|
|
|
|
.
|
2016-10-31 19:09:01 +00:00
|
|
|
.TH "SALT-API" "1" "October 31, 2016" "2016.11.0" "Salt"
|
2012-11-17 16:37:18 +00:00
|
|
|
.SH NAME
|
2015-03-10 00:36:38 +00:00
|
|
|
salt-api \- salt-api Command
|
2012-11-17 16:37:18 +00:00
|
|
|
.
|
|
|
|
.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
|
|
|
|
Start interfaces used to remotely connect to the salt master
|
|
|
|
.SH SYNOPSIS
|
2014-06-30 21:04:53 +00:00
|
|
|
.INDENT 0.0
|
|
|
|
.INDENT 3.5
|
2012-11-17 16:37:18 +00:00
|
|
|
.sp
|
|
|
|
.nf
|
|
|
|
.ft C
|
|
|
|
salt\-api
|
|
|
|
.ft P
|
|
|
|
.fi
|
2014-06-30 21:04:53 +00:00
|
|
|
.UNINDENT
|
|
|
|
.UNINDENT
|
2012-11-17 16:37:18 +00:00
|
|
|
.SH DESCRIPTION
|
|
|
|
.sp
|
2013-10-25 08:26:57 +00:00
|
|
|
The Salt API system manages network api connectors for the Salt Master
|
2012-11-17 16:37:18 +00:00
|
|
|
.SH OPTIONS
|
|
|
|
.INDENT 0.0
|
|
|
|
.TP
|
2015-04-21 17:33:30 +00:00
|
|
|
.B \-\-version
|
|
|
|
Print the version of Salt that is running.
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
|
|
|
.TP
|
|
|
|
.B \-\-versions\-report
|
|
|
|
Show program\(aqs dependencies and version number, and then exit
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
|
|
|
.TP
|
2012-11-17 16:37:18 +00:00
|
|
|
.B \-h, \-\-help
|
2015-04-21 17:33:30 +00:00
|
|
|
Show the help message and exit
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
|
|
|
.TP
|
|
|
|
.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 \fB/etc/salt\fP\&.
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
|
|
|
.TP
|
|
|
|
.B \-d, \-\-daemon
|
|
|
|
Run the salt\-api as a daemon
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
|
|
|
.TP
|
|
|
|
.B \-\-pid\-file=PIDFILE
|
|
|
|
Specify the location of the pidfile. Default: /var/run/salt\-api.pid
|
|
|
|
.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,
|
|
|
|
\fBdebug\fP, \fBinfo\fP, \fBwarning\fP, \fBerror\fP, \fBquiet\fP\&. Default:
|
|
|
|
\fBwarning\fP\&.
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
|
|
|
.TP
|
|
|
|
.B \-\-log\-file=LOG_FILE
|
|
|
|
Log file path. Default: /var/log/salt/api\&.
|
2012-11-17 16:37:18 +00:00
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
|
|
|
.TP
|
2015-04-21 17:33:30 +00:00
|
|
|
.B \-\-log\-file\-level=LOG_LEVEL_LOGFILE
|
|
|
|
Logfile logging log level. One of \fBall\fP, \fBgarbage\fP, \fBtrace\fP,
|
|
|
|
\fBdebug\fP, \fBinfo\fP, \fBwarning\fP, \fBerror\fP, \fBquiet\fP\&. Default:
|
|
|
|
\fBwarning\fP\&.
|
2012-11-17 16:37:18 +00:00
|
|
|
.UNINDENT
|
|
|
|
.SH SEE ALSO
|
|
|
|
.sp
|
|
|
|
\fIsalt\-api(7)\fP
|
|
|
|
\fIsalt(7)\fP
|
|
|
|
\fIsalt\-master(1)\fP
|
|
|
|
.SH AUTHOR
|
|
|
|
Thomas S. Hatch <thatch45@gmail.com> and many others, please see the Authors file
|
|
|
|
.SH COPYRIGHT
|
2016-02-02 20:04:34 +00:00
|
|
|
2016 SaltStack, Inc.
|
2012-11-17 16:37:18 +00:00
|
|
|
.\" Generated by docutils manpage writer.
|
|
|
|
.
|