New in version 2.2.
Parameter |
Choices/Defaults |
Comments |
|---|---|---|
|
connect_ssh_port
(added in 2.5) |
Default:
22
|
SSH port to connect to server during transfer of file
|
|
file_system
|
|
The remote file system of the device. If omitted, devices that support a file_system parameter will use their default values.
|
|
local_file
required |
|
Path to local file. Local directory must exist.
|
|
provider
|
|
Deprecated
Starting with Ansible 2.5 we recommend using
connection: network_cli.This option is only required if you are using NX-API.
For more information please see the NXOS Platform Options guide.
A dict object containing connection details.
|
|
username
|
|
Configures the username to use to authenticate the connection to the remote device. This value 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. |
|
ssh_keyfile
|
|
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. |
|
use_proxy
(added in 2.5) |
|
If
no, the environment variables http_proxy and https_proxy will be ignored. |
|
host
required |
|
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.
|
|
timeout
(added in 2.3) |
Default:
10
|
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. NX-API can be slow to return on long-running commands (sh mac, sh bgp, etc).
|
|
use_ssl
|
|
Configures the transport to use SSL if set to true only when the
transport=nxapi, otherwise this value is ignored. |
|
password
|
|
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. |
|
validate_certs
|
|
If
no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. If the transport argument is not nxapi, this value is ignored. |
|
port
|
Default:
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).
|
|
transport
required |
Default:
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.
|
|
remote_file
|
|
Remote file path of the copy. Remote directories must exist. If omitted, the name of the local file will be used.
|
Note
- nxos_file_copy:
local_file: "./test_file.txt"
remote_file: "test_file.txt"
provider: "{{ cli }}"
connect_ssh_port: "{{ ansible_ssh_port }}"
Common return values are documented here, the following are the fields unique to this module:
Key |
Returned |
Description |
|---|---|---|
|
local_file
string
|
success |
The path of the local file.
Sample:
/path/to/local/file
|
|
remote_file
string
|
success |
The path of the remote file.
Sample:
/path/to/remote/file
|
|
transfer_status
string
|
success |
Whether a file was transferred. "No Transfer" or "Sent".
Sample:
Sent
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
For more information about Red Hat’s support of this module, please refer to this Knowledge Base article
Hint
If you notice any issues in this documentation you can edit this document to improve it.