ansible.builtin.nxos_file_copy (v2.8.11) — module

Install Ansible via pip

Install with pip install ansible==2.8.11

Description

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).

Requirements

• paramiko (required when file_pull is False)
• SCPClient (required when file_pull is False)
• pexpect (required when file_pull is True)

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# 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"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# 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_filr_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"

Inputs

    
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 file name used on the NXOS device.
    type: path

file_system:
    default: 'bootflash:'
    description:
    - The remote file system of the 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.
    type: path

connect_ssh_port:
    default: 22
    description:
    - SSH port to connect to server during transfer of file
    version_added: '2.5'
    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.
    version_added: '2.7'
    version_added_collection: ansible.builtin

remote_scp_server:
    description:
    - The remote scp server address which is used to pull the file. This is required if
      file_pull is True.
    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 not used.
    type: path
    version_added: '2.7'
    version_added_collection: ansible.builtin

remote_scp_server_user:
    description:
    - The remote scp server username which is used to pull the file. This is required
      if file_pull is True.
    version_added: '2.7'
    version_added_collection: ansible.builtin

remote_scp_server_password:
    description:
    - The remote scp server password which is used to pull the file. This is required
      if file_pull is True.
    version_added: '2.7'
    version_added_collection: ansible.builtin

Outputs

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
transfer_status:
  description: Whether a file was transferred. "No Transfer" or "Sent". If file_pull
    is successful, it is set to "Received".
  returned: success
  sample: Sent
  type: str