salt/doc/man/salt-cp.1

172 lines
4.7 KiB
Groff
Raw Normal View History

2014-06-30 21:04:53 +00:00
.\" Man page generated from reStructuredText.
.
.TH "SALT-CP" "1" "October 26, 2016" "2016.3.4" "Salt"
2011-05-14 04:43:58 +00:00
.SH NAME
salt-cp \- salt-cp 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
Copy a file to a set of systems
2011-05-14 04:43:58 +00:00
.SH SYNOPSIS
2014-06-30 21:04:53 +00:00
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-cp \(aq*\(aq [ options ] SOURCE DEST
2011-05-14 04:43:58 +00:00
salt\-cp \-E \(aq.*\(aq [ options ] SOURCE DEST
2011-05-14 04:43:58 +00:00
salt\-cp \-G \(aqos:Arch.*\(aq [ options ] SOURCE DEST
.ft P
.fi
2014-06-30 21:04:53 +00:00
.UNINDENT
.UNINDENT
2011-05-14 04:43:58 +00:00
.SH DESCRIPTION
.sp
2012-06-16 22:25:22 +00:00
Salt copy copies a local file out to all of the Salt minions matched by the
given target.
.sp
Note: salt\-cp uses salt\(aqs publishing mechanism. This means the privacy of the
contents of the file on the wire is completely dependent upon the transport
in use. In addition, if the salt\-master is running with debug logging it is
possible that the contents of the file will be logged to disk.
2011-05-14 04:43:58 +00:00
.SH OPTIONS
.INDENT 0.0
2011-05-14 04:43:58 +00:00
.TP
2013-09-17 23:58:01 +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
.B \-h, \-\-help
2013-09-17 23:58:01 +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
2014-06-30 21:04:53 +00:00
on most systems is \fB/etc/salt\fP\&.
.UNINDENT
.INDENT 0.0
2011-05-14 04:43:58 +00:00
.TP
.B \-t TIMEOUT, \-\-timeout=TIMEOUT
2013-09-17 23:58:01 +00:00
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: 5
.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\&.
.UNINDENT
.INDENT 0.0
2011-05-14 04:43:58 +00:00
.TP
2013-09-17 23:58:01 +00:00
.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\&.
2013-09-17 23:58:01 +00:00
.UNINDENT
.SS Target Selection
.sp
The default matching that Salt utilizes is shell\-style globbing around the
minion id. See \fI\%https://docs.python.org/2/library/fnmatch.html#module\-fnmatch\fP\&.
2013-09-17 23:58:01 +00:00
.INDENT 0.0
.TP
.B \-E, \-\-pcre
2012-06-16 22:25:22 +00:00
The target expression will be interpreted as a PCRE regular expression
rather than a shell glob.
.UNINDENT
.INDENT 0.0
2011-05-14 04:43:58 +00:00
.TP
.B \-L, \-\-list
2013-09-17 23:58:01 +00:00
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
2011-05-14 04:43:58 +00:00
.TP
.B \-G, \-\-grain
2012-06-16 22:25:22 +00:00
The target expression matches values returned by the Salt grains system on
2012-03-19 19:02:36 +00:00
the minions. The target expression is in the format of \(aq<grain value>:<glob
expression>\(aq; example: \(aqos:Arch*\(aq
2013-09-17 23:58:01 +00:00
.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.
2012-03-19 19:02:36 +00:00
.UNINDENT
.INDENT 0.0
.TP
.B \-\-grain\-pcre
2012-06-16 22:25:22 +00:00
The target expression matches values returned by the Salt grains system on
2013-09-17 23:58:01 +00:00
the minions. The target expression is in the format of \(aq<grain value>:<
regular expression>\(aq; example: \(aqos:Arch.*\(aq
.UNINDENT
.INDENT 0.0
2011-05-14 04:43:58 +00:00
.TP
2013-09-17 23:58:01 +00:00
.B \-N, \-\-nodegroup
Use a predefined compound target defined in the Salt master configuration
file.
.UNINDENT
.INDENT 0.0
.TP
2012-03-19 19:02:36 +00:00
.B \-R, \-\-range
2013-09-17 23:58:01 +00:00
Instead of using shell globs to evaluate the target, use a range expression
2012-03-19 19:02:36 +00:00
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
2012-05-10 22:10:39 +00:00
.SH SEE ALSO
.sp
\fIsalt(1)\fP
\fIsalt\-master(1)\fP
\fIsalt\-minion(1)\fP
.SH AUTHOR
2012-07-28 00:04:56 +00:00
Thomas S. Hatch <thatch45@gmail.com> and many others, please see the Authors file
.SH COPYRIGHT
2016 SaltStack, Inc.
.\" Generated by docutils manpage writer.
.