Try SpotterCopy a file to a remote NXOS device.
| "added in version" 2.2 of ansible.builtin"
Authors: Jason Edelman (@jedelman8), Gabriele Gerbino (@GGabriele), Rewritten as a plugin by (@mikewiebe)
preview | supported by network
pipInstall with pip install ansible==2.9.13
This module supports two different workflows for copying a file to flash (or bootflash) on NXOS devices. Files can either be (1) pushed from the Ansible controller to the device or (2) pulled from a remote SCP file server to the device. File copies are initiated from the NXOS device to the remote SCP server. This module only supports the use of connection C(network_cli) or C(Cli) transport with connection C(local).
# File copy from ansible controller to nxos device
- name: "copy from server to device"
nxos_file_copy:
local_file: "./test_file.txt"
remote_file: "test_file.txt"
# Initiate file copy from the nxos device to transfer file from an SCP server back to the nxos device
- name: "initiate file copy from device"
nxos_file_copy:
file_pull: True
local_file: "xyz"
local_file_directory: "dir1/dir2/dir3"
remote_file: "/mydir/abc"
remote_scp_server: "192.168.0.1"
remote_scp_server_user: "myUser"
remote_scp_server_password: "myPassword"
vrf: "management"
vrf:
default: management
description:
- The VRF used to pull the file. Useful when no vrf management is defined
version_added: '2.9'
version_added_collection: ansible.builtin
provider:
description:
- B(Deprecated)
- 'Starting with Ansible 2.5 we recommend using C(connection: network_cli).'
- 'Starting with Ansible 2.6 we recommend using C(connection: httpapi) for NX-API.'
- This option will be removed in a release after 2022-06-01.
- For more information please see the L(NXOS Platform Options guide, ../network/user_guide/platform_nxos.html).
- HORIZONTALLINE
- A dict object containing connection details.
suboptions:
auth_pass:
description:
- Specifies the password to use if required to enter privileged mode on the remote
device. If I(authorize) is false, then this argument does nothing. If the value
is not specified in the task, the value of environment variable C(ANSIBLE_NET_AUTH_PASS)
will be used instead.
type: str
authorize:
default: false
description:
- Instructs the module to enter privileged mode on the remote device before sending
any commands. If not specified, the device will attempt to execute all commands
in non-privileged mode. If the value is not specified in the task, the value
of environment variable C(ANSIBLE_NET_AUTHORIZE) will be used instead.
type: bool
host:
description:
- 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.
type: str
password:
description:
- Specifies the password to use to authenticate the connection to the remote device. This
is a common argument used for either I(cli) or I(nxapi) transports. If the value
is not specified in the task, the value of environment variable C(ANSIBLE_NET_PASSWORD)
will be used instead.
type: str
port:
description:
- Specifies the port to use when building the connection to the remote device. This
value applies to either I(cli) or I(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).
type: int
ssh_keyfile:
description:
- Specifies the SSH key to use to authenticate the connection to the remote device. This
argument is only used for the I(cli) transport. If the value is not specified
in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE) will
be used instead.
type: str
timeout:
description:
- 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).
type: int
transport:
choices:
- cli
- nxapi
default: cli
description:
- 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.
type: str
use_proxy:
default: true
description:
- If C(no), the environment variables C(http_proxy) and C(https_proxy) will be
ignored.
type: bool
use_ssl:
default: false
description:
- Configures the I(transport) to use SSL if set to C(yes) only when the C(transport=nxapi),
otherwise this value is ignored.
type: bool
username:
description:
- 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 C(ANSIBLE_NET_USERNAME) will
be used instead.
type: str
validate_certs:
default: false
description:
- If C(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.
type: bool
type: dict
file_pull:
default: false
description:
- When (False) file is copied from the Ansible controller to the NXOS device.
- When (True) file is copied from a remote SCP server to the NXOS device. In this
mode, the file copy is initiated from the NXOS device.
- If the file is already present on the device it will be overwritten and therefore
the operation is NOT idempotent.
type: bool
version_added: '2.7'
version_added_collection: ansible.builtin
local_file:
description:
- When (file_pull is False) this is the path to the local file on the Ansible controller.
The local directory must exist.
- When (file_pull is True) this is the target file name on the NXOS device.
file_system:
default: 'bootflash:'
description:
- The remote file system on the nxos device. If omitted, devices that support a I(file_system)
parameter will use their default values.
remote_file:
description:
- When (file_pull is False) this is the remote file path on the NXOS device. If omitted,
the name of the local file will be used. The remote directory must exist.
- When (file_pull is True) this is the full path to the file on the remote SCP server
to be copied to the NXOS device.
connect_ssh_port:
default: 22
description:
- SSH server port used for file transfer.
version_added: '2.5'
version_added_collection: ansible.builtin
file_pull_kstack:
default: false
description:
- When file_pull is True, this can be used to speed up file copies when the nxos running
image supports the use-kstack option.
- When (file_pull is False), this is not used.
type: bool
version_added: '2.9'
version_added_collection: ansible.builtin
file_pull_compact:
default: false
description:
- When file_pull is True, this is used to compact nxos image files. This option can
only be used with nxos image files.
- When (file_pull is False), this is not used.
type: bool
version_added: '2.9'
version_added_collection: ansible.builtin
file_pull_timeout:
default: 300
description:
- Use this parameter to set timeout in seconds, when transferring large files or when
the network is slow.
- When (file_pull is False), this is not used.
version_added: '2.7'
version_added_collection: ansible.builtin
remote_scp_server:
description:
- The remote scp server address when file_pull is True. This is required if file_pull
is True.
- When (file_pull is False), this is not used.
version_added: '2.7'
version_added_collection: ansible.builtin
local_file_directory:
description:
- When (file_pull is True) file is copied from a remote SCP server to the NXOS device,
and written to this directory on the NXOS device. If the directory does not exist,
it will be created under the file_system. This is an optional parameter.
- When (file_pull is False), this is not used.
version_added: '2.7'
version_added_collection: ansible.builtin
remote_scp_server_user:
description:
- The remote scp server username when file_pull is True. This is required if file_pull
is True.
- When (file_pull is False), this is not used.
version_added: '2.7'
version_added_collection: ansible.builtin
remote_scp_server_password:
description:
- The remote scp server password when file_pull is True. This is required if file_pull
is True.
- When (file_pull is False), this is not used.
version_added: '2.7'
version_added_collection: ansible.builtin
changed: description: Indicates whether or not the file was copied. returned: success sample: true type: bool local_file: description: The path of the local file. returned: success sample: /path/to/local/file type: str remote_file: description: The path of the remote file. returned: success sample: /path/to/remote/file type: str remote_scp_server: description: The name of the scp server when file_pull is True. returned: success sample: fileserver.example.com type: str transfer_status: description: Whether a file was transferred to the nxos device. returned: success sample: Sent type: str