.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.6.
.TH SALT-PEPPER "1" "March 2018" "salt-pepper 0.5.5-1" "User Commands"
.SH NAME
salt-pepper \- Tool to access a salt-api instance
.SH SYNOPSIS
.B salt-pepper
[\fI\,opts\/\fR]
.SH DESCRIPTION
.IP
A CLI interface to a remote salt\-api instance
.SH OPTIONS
.TP
\fB\-\-version\fR
show program's version number and exit
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-c\fR CONFIG
Configuration file location. Default is a file path in
the "PEPPERRC" environment variable or ~/.pepperrc.
.TP
\fB\-v\fR
Increment output verbosity; may be specified multiple
times
.TP
\fB\-H\fR, \fB\-\-debug\-http\fR
Output the HTTP request/response headers on stderr
.TP
\fB\-\-ignore\-ssl\-errors\fR
Ignore any SSL certificate that may be encountered.
Note that it is recommended to resolve certificate
errors for production.
.IP
Pepper ``salt`` Options:
.IP
Mimic the ``salt`` CLI
.TP
\fB\-t\fR TIMEOUT, \fB\-\-timeout\fR=\fI\,TIMEOUT\/\fR
Specify wait time (in seconds) before returning
control to the shell
.TP
\fB\-\-client\fR=\fI\,CLIENT\/\fR
specify the salt\-api client to use (local,
local_async, runner, etc)
.TP
\fB\-\-json\fR=\fI\,JSON_INPUT\/\fR
Enter JSON at the CLI instead of positional (text)
arguments. This is useful for arguments that need
complex data structures. Specifying this argument will
cause positional arguments to be ignored.
.TP
\fB\-\-json\-file\fR=\fI\,JSON_FILE\/\fR
Specify file containing the JSON to be used by salt-pepper
.TP
\fB\-\-fail\-if\-incomplete\fR
Return a failure exit code if not all minions respond.
This option requires the authenticated user have
access to run the `jobs.list_jobs` runner function.
.IP
Targeting Options:
.IP
Target which minions to run commands on
.TP
\fB\-E\fR, \fB\-\-pcre\fR
Target hostnames using PCRE regular expressions
.TP
\fB\-L\fR, \fB\-\-list\fR
Specify a comma delimited list of hostnames
.TP
\fB\-G\fR, \fB\-\-grain\fR
Target based on system properties
.TP
\fB\-\-grain\-pcre\fR
Target based on PCRE matches on system properties
.TP
\fB\-I\fR, \fB\-\-pillar\fR
Target based on pillar values
.TP
\fB\-\-pillar\-pcre\fR
Target based on PCRE matches on pillar values
.TP
\fB\-R\fR, \fB\-\-range\fR
Target based on range expression
.TP
\fB\-C\fR, \fB\-\-compound\fR
Target based on compound expression
.TP
\fB\-N\fR, \fB\-\-nodegroup\fR
Target based on a named nodegroup
.HP
\fB\-\-batch\fR=\fI\,BATCH\/\fR
.IP
Authentication Options:
.IP
Authentication credentials can optionally be supplied via the
environment variables: SALTAPI_URL, SALTAPI_USER, SALTAPI_PASS,
SALTAPI_EAUTH.
.TP
\fB\-u\fR SALTAPIURL, \fB\-\-saltapi\-url\fR=\fI\,SALTAPIURL\/\fR
Specify the host url.  Defaults to
https://localhost:8080
.TP
\fB\-a\fR EAUTH, \fB\-\-auth\fR=\fI\,EAUTH\/\fR, \fB\-\-eauth\fR=\fI\,EAUTH\/\fR, \fB\-\-extended\-auth\fR=\fI\,EAUTH\/\fR
Specify the external_auth backend to authenticate
against and interactively prompt for credentials
.TP
\fB\-\-username\fR=\fI\,USERNAME\/\fR
Optional, defaults to user name. will be prompt if
empty unless \fB\-\-non\-interactive\fR
.TP
\fB\-\-password\fR=\fI\,PASSWORD\/\fR
Optional, but will be prompted unless \fB\-\-noninteractive\fR
.TP
\fB\-\-token\-expire\fR=\fI\,TOKEN_EXPIRE\/\fR
Set eauth token expiry in seconds. Must be allowed per
user. See the `token_expire_user_override` Master
setting for more info.
.TP
\fB\-\-non\-interactive\fR
Optional, fail rather than waiting for input
.TP
\fB\-T\fR, \fB\-\-make\-token\fR
Generate and save an authentication token for re\-use.
The token is generated and made available for the
period defined in the Salt Master.
.TP
\fB\-r\fR, \fB\-\-run\-uri\fR
Use an eauth token from \fI\,/token\/\fP and send commands
through the \fI\,/run\/\fP URL instead of the traditional
session token approach.
.TP
\fB\-x\fR CACHE
Cache file location. Default is a file path in the
"PEPPERCACHE" environment variable or ~/.peppercache.
.SH "SEE ALSO"
The full documentation for
.B salt-pepper
is maintained as a Texinfo manual.  If the
.B info
and
.B salt-pepper
programs are properly installed at your site, the command
.IP
.B info salt-pepper
.PP
should give you access to the complete manual.