Note
This plugin is part of the junipernetworks.junos collection (version 2.6.0).
You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install junipernetworks.junos.
To use it in a playbook, specify: junipernetworks.junos.junos_scp.
New in version 1.0.0: of junipernetworks.junos
Note
This module has a corresponding action plugin.
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| dest path | Default: "." | The dest argument specifies the path in which to receive the files. | |
| provider dictionary | Deprecated Starting with Ansible 2.5 we recommend using connection: network_cli or connection: netconf.For more information please see the Junos OS Platform Options guide. A dict object containing connection details. | ||
| host string | Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. | ||
| password string | Specifies the password to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead. | ||
| port integer | Specifies the port to use when building the connection to the remote device. The port value will default to the well known SSH port of 22 (for transport=cli) or port 830 (for transport=netconf) device. | ||
| ssh_keyfile path | Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead. | ||
| timeout integer | Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. | ||
| transport string |
| Configures the transport connection to use when connecting to the remote device. | |
| username string | Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead. | ||
| recursive boolean |
| The recursive argument enables recursive transfer of files and directories. | |
| remote_src boolean |
| The remote_src argument enables the download of files (scp get) from the remote device. The default behavior is to upload files (scp put) to the remote device. | |
| src list / elements=path / required | The src argument takes a single path, or a list of paths to be transferred. The argument recursive must be true to transfer directories. | ||
| ssh_config path | The ssh_config argument is path to the SSH configuration file. This can be used to load SSH information from a configuration file. If this option is not given by default ~/.ssh/config is queried. | ||
| ssh_private_key_file path | The ssh_private_key_file argument is path to the SSH private key file. This can be used if you need to provide a private key rather than loading the key into the ssh-key-ring/environment | ||
Note
local connections only.ssh_config unlike other junos modules that uses netconf connection type.# the required set of connection arguments have been purposely left off
# the examples for brevity
- name: upload local file to home directory on remote device
junipernetworks.junos.junos_scp:
src: test.tgz
- name: upload local file to tmp directory on remote device
junipernetworks.junos.junos_scp:
src: test.tgz
dest: /tmp/
- name: download file from remote device
junipernetworks.junos.junos_scp:
src: test.tgz
remote_src: true
- name: ssh config file path for jumphost config
junipernetworks.junos.junos_scp:
src: test.tgz
remote_src: true
ssh_config: /home/user/customsshconfig
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| changed boolean | always | always true |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/junipernetworks/junos/junos_scp_module.html