File: //opt/saltstack/salt/lib/python3.10/site-packages/salt/modules/__pycache__/scp_mod.cpython-310.pyc
o
�N�g� � @ s� d Z ddlZz ddlZddlZdZW n ey dZY nw dgZdZe�e �Z
dd� Z d d
� Z d d � Z
ddd�Z ddd�ZdS )zr
SCP Module
==========
.. versionadded:: 2019.2.0
Module to copy files via `SCP <https://man.openbsd.org/scp>`_
� NTF�*�scpc C s t sdS tS )N)Fz4Please install SCP for this modules: pip install scp)�HAS_SCP�__virtualname__� r r �H/opt/saltstack/salt/lib/python3.10/site-packages/salt/modules/scp_mod.py� __virtual__ s r c K s� i }i }t d tjj�d }|�d� t d tjj�d }|�d� | � � D ] \}}||v r6|d ur6|||< ||v rB|d urB|||< q&||fS )Nzargs.get_function_argspecr �auto_add_policy)
Z __utils__�paramiko� SSHClient�connect�appendr � SCPClient�__init__�pop�items)�kwargs�paramiko_kwargs�
scp_kwargsZ
paramiko_argsZscp_args�key�valr r r �_select_kwargs" s �
�r c K s^ t di | ��\}}t�� }|�dd�r|�t�� � |jdi |�� tj|� � fi |��}|S )zG
Prepare the underlying SSH connection with the remote target.
r FNr )
r r
r r Zset_missing_host_key_policyZ
AutoAddPolicyr r r Z
get_transport)r r r Zssh�
scp_clientr r r �_prepare_connection3 s r � c K s6 t di |��}||d�}|r||d< |j| fi |��S )a�
Transfer files and directories from remote host to the localhost of the
Minion.
remote_path
Path to retrieve from remote host. Since this is evaluated by scp on the
remote host, shell wildcards and environment variables may be used.
recursive: ``False``
Transfer files and directories recursively.
preserve_times: ``False``
Preserve ``mtime`` and ``atime`` of transferred files and directories.
hostname
The hostname of the remote device.
port: ``22``
The port of the remote device.
username
The username required for SSH authentication on the device.
password
Used for password authentication. It is also used for private key
decryption if ``passphrase`` is not given.
passphrase
Used for decrypting private keys.
pkey
An optional private key to use for authentication.
key_filename
The filename, or list of filenames, of optional private key(s) and/or
certificates to try for authentication.
timeout
An optional timeout (in seconds) for the TCP connect.
socket_timeout: ``10``
The channel socket timeout in seconds.
buff_size: ``16384``
The size of the SCP send buffer.
allow_agent: ``True``
Set to ``False`` to disable connecting to the SSH agent.
look_for_keys: ``True``
Set to ``False`` to disable searching for discoverable private key
files in ``~/.ssh/``
banner_timeout
An optional timeout (in seconds) to wait for the SSH banner to be
presented.
auth_timeout
An optional timeout (in seconds) to wait for an authentication
response.
auto_add_policy: ``False``
Automatically add the host to the ``known_hosts``.
CLI Example:
.. code-block:: bash
salt '*' scp.get /var/tmp/file /tmp/file hostname=10.10.10.1 auto_add_policy=True
�� recursive�preserve_times�
local_pathNr )r �get)� remote_pathr r r r r Z
get_kwargsr r r r @ s
G
r �basec K sr t di |��}||d�}|r||d< g }t| ttf�s | g} | D ]} td | |d�}
|�|
� q |j|fi |��S )ab
Transfer files and directories to remote host.
files
A single path or a list of paths to be transferred.
remote_path
The path on the remote device where to store the files.
recursive: ``True``
Transfer files and directories recursively.
preserve_times: ``False``
Preserve ``mtime`` and ``atime`` of transferred files and directories.
hostname
The hostname of the remote device.
port: ``22``
The port of the remote device.
username
The username required for SSH authentication on the device.
password
Used for password authentication. It is also used for private key
decryption if ``passphrase`` is not given.
passphrase
Used for decrypting private keys.
pkey
An optional private key to use for authentication.
key_filename
The filename, or list of filenames, of optional private key(s) and/or
certificates to try for authentication.
timeout
An optional timeout (in seconds) for the TCP connect.
socket_timeout: ``10``
The channel socket timeout in seconds.
buff_size: ``16384``
The size of the SCP send buffer.
allow_agent: ``True``
Set to ``False`` to disable connecting to the SSH agent.
look_for_keys: ``True``
Set to ``False`` to disable searching for discoverable private key
files in ``~/.ssh/``
banner_timeout
An optional timeout (in seconds) to wait for the SSH banner to be
presented.
auth_timeout
An optional timeout (in seconds) to wait for an authentication
response.
auto_add_policy: ``False``
Automatically add the host to the ``known_hosts``.
CLI Example:
.. code-block:: bash
salt '*' scp.put /path/to/file /var/tmp/file hostname=server1 auto_add_policy=True
r r z
cp.cache_file)�saltenvNr )r �
isinstance�list�tupleZ__salt__r
�put) �filesr r r r" r r Z
put_kwargsZ cached_filesZfile_Z cached_filer r r r& � s O
r& )r FF)NFFr! )�__doc__�loggingr
r r � ImportErrorZ__proxyenabled__r � getLogger�__name__�logr r r r r& r r r r �<module> s* �
P�