W3cubDocs

/Ansible

nxos_file_copy - Copy a file to a remote NXOS device over SCP.

New in version 2.2.

Synopsis

Copy a file to the flash (or bootflash) remote network device on NXOS devices.

Options

parameter required default choices comments
file_system
 no
The remote file system of the device. If omitted, devices that support a file_system parameter will use their default values.
host
 yes
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.
local_file
 yes
Path to local file. Local directory must exist.
password
 no
Specifies the password to use to authenticate the connection to the remote device. This is a common argument used for either cli or nxapi transports. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
port
 no 0 (use common port)
Specifies the port to use when building the connection to the remote device. This value applies to either cli or nxapi. The port value will default to the appropriate transport common port if none is provided in the task. (cli=22, http=80, https=443).
provider
 no
Convenience method that allows all nxos arguments to be passed as a dict object. All constraints (required, choices, etc) must be met either by individual arguments or values in this dict.
remote_file
 no
Remote file path of the copy. Remote directories must exist. If omitted, the name of the local file will be used.
ssh_keyfile
 no
Specifies the SSH key to use to authenticate the connection to the remote device. This argument is only used for the cli transport. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.
transport
 yes cli
Configures the transport connection to use when connecting to the remote device. The transport argument supports connectivity to the device over cli (ssh) or nxapi.
use_ssl
 no
  • yes
  • no
Configures the transport to use SSL if set to true only when the transport=nxapi, otherwise this value is ignored.
username
 no
Configures the username to use to authenticate the connection to the remote device. The value of username is used to authenticate either the CLI login or the nxapi authentication depending on which transport is used. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.

Examples

- nxos_file_copy:
    local_file: "./test_file.txt"
    username: "{{ un }}"
    password: "{{ pwd }}"
    host: "{{ inventory_hostname }}"

Return Values

Common return values are documented here Common Return Values, the following are the fields unique to this module:

name description returned type sample
local_file The path of the local file. success string /path/to/local/file
remote_file The path of the remote file. success string /path/to/remote/file
transfer_status Whether a file was transferred. "No Transfer" or "Sent". success string Sent

Notes

Note

The feature must be enabled with feature scp-server.

Note

If the file is already present (md5 sums match), no transfer will take place.

Note

Check mode will tell you if the file would be copied.

This is a Core Module

For more information on what this means please read Core Modules

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, developing_test_pr and Developing Modules.

© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/nxos_file_copy_module.html