ansible.netcommon.net_get module – Copy a file from a network device to Ansible Controller
This module is part of the ansible.netcommon collection (version 2.6.1).
You might already have this collection installed if you are using the
It is not included in
To check whether it is installed, run
ansible-galaxy collection list.
To install it, use:
ansible-galaxy collection install ansible.netcommon.
To use it in a playbook, specify:
New in version 1.0.0: of ansible.netcommon
This module provides functionality to copy file from network device to ansible controller.
This module has a corresponding action plugin.
The below requirements are needed on the host that executes this module.
scp if using protocol=scp with paramiko
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.
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.”]
Protocol used to transfer file.
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.
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_osnetwork platforms. See the Network Platform Options for details.