junipernetworks.junos.junos_scp module – Transfer files from or to remote devices running Junos
Note
This module is part of the junipernetworks.junos collection (version 5.3.1).
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
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: junipernetworks.junos.junos_scp
.
New in junipernetworks.junos 1.0.0
DEPRECATED
- Removed in:
major release after 2025-01-01
- Why:
Updated modules released with more functionality
- Alternative:
Use ansible.netcommon.net_get, ansible.netcommon.net_put instead.
Synopsis
This module transfers files via SCP from or to remote devices running Junos.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
junos-eznc
ncclient (>=v0.5.2)
Parameters
Parameter |
Comments |
---|---|
The Default: |
|
Deprecated Starting with Ansible 2.5 we recommend using For more information please see the Junos OS Platform Options guide. <hr> A dict object containing connection details. |
|
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. |
|
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 |
|
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 |
|
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 |
|
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. |
|
Configures the transport connection to use when connecting to the remote device. Choices:
|
|
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 |
|
The Choices:
|
|
The Choices:
|
|
The |
|
The |
|
The |
Notes
Note
This module requires the netconf system service be enabled on the remote device being managed.
Tested against vMX JUNOS version 17.3R1.10.
Works with
local
connections only.Since this module uses junos-eznc to establish connection with junos device the netconf configuration parameters needs to be passed using module options for example
ssh_config
unlike other junos modules that usesnetconf
connection type.For information on using CLI and netconf see the :ref:`Junos OS Platform Options guide <junos_platform_options>`
For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>`
For more information on using Ansible to manage Juniper network devices see https://www.ansible.com/ansible-juniper.
Examples
# 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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
always true Returned: always |
Status
This module will be removed in a major release after 2025-01-01. [deprecated]
For more information see DEPRECATED.