New in version 2019.2.0.
Module to copy files via SCP
Transfer files and directories from remote host to the localhost of the Minion.
Path to retrieve from remote host. Since this is evaluated by scp on the remote host, shell wildcards and environment variables may be used.
FalseTransfer files and directories recursively.
FalsePreserve mtime and atime of transferred files and directories.
The hostname of the remote device.
22The port of the remote device.
The username required for SSH authentication on the device.
Used for password authentication. It is also used for private key
decryption if passphrase is not given.
Used for decrypting private keys.
An optional private key to use for authentication.
The filename, or list of filenames, of optional private key(s) and/or certificates to try for authentication.
An optional timeout (in seconds) for the TCP connect.
10The channel socket timeout in seconds.
16384The size of the SCP send buffer.
TrueSet to False to disable connecting to the SSH agent.
TrueSet to False to disable searching for discoverable private key
files in ~/.ssh/
An optional timeout (in seconds) to wait for the SSH banner to be presented.
An optional timeout (in seconds) to wait for an authentication response.
FalseAutomatically add the host to the known_hosts.
CLI Example:
salt '*' scp.get /var/tmp/file /tmp/file hostname=10.10.10.1 auto_add_policy=True
Transfer files and directories to remote host.
A single path or a list of paths to be transferred.
The path on the remote device where to store the files.
TrueTransfer files and directories recursively.
FalsePreserve mtime and atime of transferred files and directories.
The hostname of the remote device.
22The port of the remote device.
The username required for SSH authentication on the device.
Used for password authentication. It is also used for private key
decryption if passphrase is not given.
Used for decrypting private keys.
An optional private key to use for authentication.
The filename, or list of filenames, of optional private key(s) and/or certificates to try for authentication.
An optional timeout (in seconds) for the TCP connect.
10The channel socket timeout in seconds.
16384The size of the SCP send buffer.
TrueSet to False to disable connecting to the SSH agent.
TrueSet to False to disable searching for discoverable private key
files in ~/.ssh/
An optional timeout (in seconds) to wait for the SSH banner to be presented.
An optional timeout (in seconds) to wait for an authentication response.
FalseAutomatically add the host to the known_hosts.
CLI Example:
salt '*' scp.put /path/to/file /var/tmp/file hostname=server1 auto_add_policy=True