Skip to content

net_get

Collection Note

This module is part of the ansible.netcommon collection. To install the collection, use:

ansible-galaxy collection install ansible.netcommon
Added in version 1.0.0.

You need further requirements to be able to use this module, see the Requirements section for details.

Synopsis

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

Requirements

The following Python packages are needed on the host that executes this module:

Parameters

Parameter Defaults / Choices Comments
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.']
 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 Default: scp
Choices: scp, sftp		 Protocol used to transfer file.
src
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 - C(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 C(ansible_network_os) network platforms. See the :ref:Network Platform Options <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)