ansible.netcommon.net_get – Copy a file from a network device to Ansible Controller

Note

This plugin is part of the ansible.netcommon collection (version 1.5.0).

To install it use: ansible-galaxy collection install ansible.netcommon.

To use it in a playbook, specify: ansible.netcommon.net_get.

New in version 1.0.0: of ansible.netcommon

Synopsis

  • This module provides functionality to copy file from network device to ansible controller.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

  • scp

Parameters

Parameter Choices/Defaults Comments
dest
string
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."]
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
string
    Choices:
  • scp ←
  • sftp
Protocol used to transfer file.
src
string / required
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.

Notes

Note

  • Some devices need specific configurations to be enabled before scp can work These configuration should be pre-configured before using this module e.g ios - ip scp server enable.
  • User privilege to do scp on network device should be pre-configured e.g. ios - need user privilege 15 by default for allowing scp.
  • Default destination of source file.
  • This module is supported on ansible_network_os network platforms. See the Network Platform Options for details.

Examples

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

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

Authors

  • Deepak Agrawal (@dagrawal)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ansible/netcommon/net_get_module.html