Skip to main content
Cisco SD-WAN
Product Documentation
Viptela Documentation


Use the Archive template for vBond controllers, vManage NMSs, vSmart controllers, and vEdge routers.

You can configure a Viptela device to periodically archive a copy of the full running configuration to an archival file. The running configuration that is archived is viewable by the user "admin".

Navigate to the Template Screen and Name the Template

  1. In vManage NMS, select the Configuration ► Templates screen.
  2. In the Device tab, click Create Template.
  3. From the Create Template drop-down, select From Feature Template.
  4. From the Device Model drop-down, select the type of device for which you are creating the template.
  5. Under Additional System Templates, located to the right of the screen, click Archive.
  6. From the Archive drop-down, click Create Template. The Archive template form is displayed. The top of the form contains fields for naming the template, and the bottom contains fields for defining Archive parameters.

  7. In the Template Name field, enter a name for the template. The name can be up to 128 characters and can contain only alphanumeric characters.
  8. In the Template Description field, enter a description of the template. The description can be up to 2048 characters and can contain only alphanumeric characters.

When you first open a feature template, for each parameter that has a default value, the scope is set to Default (indicated by a check mark), and the default setting or value is shown. To change the default or to enter a value, click the scope drop-down to the left of the parameter field and select one of the following:

Parameter Scope

Scope Description

Device Specific (indicated by a host icon)

Use a device-specific value for the parameter. For device-specific parameters, you cannot enter a value in the feature template. You enter the value when you attach a Viptela device to a device template.

When you click Device Specific, the Enter Key box opens. This box displays a key, which is a unique string that identifies the parameter in a CSV file that you create. This file is an Excel spreadsheet that contains one column for each key. The header row contains the key names (one key per column), and each row after that corresponds to a device and defines the values of the keys for that device. You upload the CSV file when you attach a Viptela device to a device template. For more information, see Create a Template Variables Spreadsheet.

To change the default key, type a new string and move the cursor out of the Enter Key box.

Examples of device-specific parameters are system IP address, hostname, GPS location, and site ID.

Global (indicated by a globe icon)

Enter a value for the parameter, and apply that value to all devices.

Examples of parameters that you might apply globally to a group of devices are DNS server, syslog server, and interface MTUs.

Configure Configuration Archive Configuration

To configure archiving of running configurations, configure the following parameters:

Parameter Name Description
Archival Interval Specify how often to archive the full running configuration. In addition, the running configuration is archived each time you issue the commit command on the device.
Range: 5 minutes through 525600 minutes (about one year)
Default: 10080 minutes (7 days)
Path to Archive File Directory Specify the path to the directory in which to store the archival file and the base name of the file. The path can be one of the following:
ftp:file-path—Path to a file on an FTP server.
path file-path/filename /file-path/filename—Path to a file on the local Viptela device.
A separate file is created for each archiving operation. To distinguish the files, a timestamp is appended to the filename. The timestamp has the format yyyy-mm-dd_hh-mm-ss.
SSH Key File Enter the name of the SSH private key file on the local Viptela device. This file is used to SCP into a remote file server. The Viptela software automatically generates a public and a private key and places the public key in the SSH key file, which is located in /home/admin directory on the Viptela device.
If you do not enter the name of an SSH private key file, the software uses the automatically generated private key.
VPN ID Enter the ID for the VPN in which the archival file server is located or through which the server can be reached. On vEdge routers, vpn-id can be a value from 0 through 65530. On vSmart controllers, vpn-id can be either 0 or 512.

To save the feature template, click Save.

CLI equivalent:

    ​interval minutes 
    path file-path 
    ssh-id-file filename 
    vpn vpn-id 

Release Information

Introduced in vManage NMS in Release 15.2.

  • Was this article helpful?