junipernetworks.junos.junos_scp – Transfer files from or to remote devices running Junos
junipernetworks.junos.junos_scp – Transfer files from or to remote devices running Junos
Note
This plugin is part of the junipernetworks.junos collection (version 1.2.1).
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
Synopsis
- This module transfers files via SCP from or to remote devices running Junos.
Requirements
The below requirements are needed on the host that executes this module.
- junos-eznc
- ncclient (>=v0.5.2)
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
dest path |
Default: "." |
The | |
provider dictionary |
Deprecated Starting with Ansible 2.5 we recommend using 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 | ||
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 | ||
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 | ||
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 | ||
recursive boolean |
|
The | |
remote_src boolean |
|
The | |
src list / elements=string / required |
The | ||
ssh_config path |
The | ||
ssh_private_key_file path |
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 Junos OS Platform Options guide
- For more information on using Ansible to manage network devices see the Ansible 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 | Returned | Description |
---|---|---|
changed boolean |
always |
always true
|
Authors
- Christian Giese (@GIC-de)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/junipernetworks/junos/junos_scp_module.html