/ home / ansible / ansible.netcommon / 6.1.0 / module / net_get

ansible.netcommon.net_get (6.1.0) — module

Copy a file from a network device to Ansible Controller

| "added in version" 1.0.0 of ansible.netcommon"

Authors: Deepak Agrawal (@dagrawal)

This plugin has a corresponding action plugin.

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 network device to ansible controller.

Requirements

scp if using protocol=scp with paramiko

Usage examples

Scanned by Steampunk Spotter

- name: copy file from the network device to Ansible controller
  ansible.netcommon.net_get:
    src: running_cfg_ios1.txt

Scanned by Steampunk Spotter

- name: copy file from ios to common location at /tmp
  ansible.netcommon.net_get:
    src: running_cfg_sw1.txt
    dest: /tmp/ios1.txt

Inputs

    
src:
    description:
    - Specifies the source file. The path to the source file can either be the full path
      on the network device or a relative path as per path supported by destination network
      device.
    required: true

dest:
    default:
    - Same filename as specified in I(src). The path will be playbook root or role root
      directory if playbook is part of a role.
    description:
    - Specifies the destination file. The path to the destination file can either be the
      full path on the Ansible control host or a relative path from the playbook or role
      root directory.

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