/ home / ansible / ansible.netcommon / 6.1.0 / module / cli_restore

ansible.netcommon.cli_restore (6.1.0) — module

Restore device configuration to network devices over network_cli

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

Authors: Sagar Paul (@KB-perByte)

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 platform agnostic way of restore text based configuration to network devices over network_cli connection plugin.

The module uses the platforms `config replace` commands to restore backup configuration that is already copied over to the appliance.

Usage examples

Scanned by Steampunk Spotter

- name: Restore IOS-XE configuration
  ansible.netcommon.cli_restore:
    filename: backupDday.cfg
    path: flash://

Inputs

    
path:
    description:
    - The location in the target appliance where the file containing the backup exists.
      The path and the filename together create the input to the config replace command,
    - For an IOSXE appliance the path pattern is flash://<filename>
    type: str

filename:
    description:
    - Filename of the backup file, present in the appliance where the restore operation
      is to be performed. Check appliance for the configuration backup file name.
    type: str