ansible.netcommon.net_put (6.1.0) — module

Install collection

Install with ansible-galaxy collection install ansible.netcommon:==6.1.0

Add to requirements.yml

  collections:
    - name: ansible.netcommon
      version: 6.1.0

Description

This module provides functionality to copy file from Ansible controller to network devices.

Requirements

• scp if using protocol=scp with paramiko

Usage examples

Scanned by Steampunk Spotter

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

- name: copy file from ansible controller to a network device
  ansible.netcommon.net_put:
    src: running_cfg_ios1.txt

Scanned by Steampunk Spotter

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

- name: copy file at root dir of flash in slot 3 of sw1(ios)
  ansible.netcommon.net_put:
    src: running_cfg_sw1.txt
    protocol: sftp
    dest: flash3:/running_cfg_sw1.txt

Inputs

    
src:
    description:
    - Specifies the source file. The path to the source file can either be the full path
      on the Ansible control host or a relative path from the playbook or role root directory.
    required: true

dest:
    default:
    - Filename from src and at default directory of user shell on network_os.
    description:
    - Specifies the destination file. The path to destination file can either be the full
      path or relative path as supported by network_os.
    required: false

mode:
    choices:
    - binary
    - text
    default: binary
    description:
    - Set the file transfer mode. If mode is set to I(text) then I(src) file will go through
      Jinja2 template engine to replace any vars if present in the src file. If mode is
      set to I(binary) then file will be copied as it is to destination device.

protocol:
    choices:
    - scp
    - sftp
    default: scp
    description:
    - Protocol used to transfer file.