ansible.netcommon.cli_backup module – Back up device configuration from network devices over network_cli
This module is part of the ansible.netcommon collection (version 5.3.0).
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 ansible.netcommon 4.2.0
This module provides platform agnostic way of backing up text based configuration from network devices over network_cli connection plugin.
This module has a corresponding action plugin.
The defaults argument will influence how the running-config is collected from the device. When the value is set to true, the command used to collect the running-config is append with the all keyword. When the value is set to false, the command is issued without the all keyword.
This option provides the path ending with directory name in which the backup configuration file will be stored. If the directory does not exist it will be first created and the filename is either the value of
The filename to be used to store the backup configuration. If the filename is not given it will be generated based on the hostname, current time and date in format defined by <hostname>_config.<current-date>@<current-time>
This module is supported on
ansible_network_osnetwork platforms. See the :ref:`Network Platform Options <platform_options>` for details.
- name: configurable backup path
Common return values are documented here, the following are the fields unique to this module:
The full path to the backup file