Configuration Backup and Restore

Crosswork Network Controller's device configuration backup and restore features help prevent data loss and preserve the configuration templates on your onboarded devices.

This chapter contains the following topics:

Schedule a configuration backup

This section explains how to schedule a configuration backup.

Procedure


Step 1

From the main menu, choose Device Management > Configuration Backup and Restore.

The Configuration Backup & Restore page is displayed.

Step 2

Click Schedule backup. The Schedule Configuration Backup page is displayed with the first step, Select devices, highlighted.

Step 3

Choose either Device groups or Devices. Based on your selection, device group(s) or individual devices are displayed in the selection pane at the bottom. Select the required devices, and click Next.

Step 4

The Schedule Configuration Backup page is refreshed with the next step, Configure & schedule, highlighted.

  1. Provide a Backup name.

  2. Select the backup Type.

    If you selected the Type as Recurring, provide relevant values for these fields:

    • Frequency: Select the frequency of the backup. The values are Daily, Hourly, Weekly, and Monthy.

    • Repeat every: Select the duration for repeating the backup based on the frequency you have chosen. You can specify the duration as a number of days, a number of hours, specific days of the week, or a specific day of the month. For example, if you select a monthly frequency, choose a specific day of the month.

    • Starting date and time: Enter the starting date and time for the backup.

    If you selected the Type as One time, provide relevant values for these fields:

    • Schedule: Choose Now or Later.

    • Starting date and time: This field is applicable only if you have chosen to schedule the backup for a later time. Enter the starting date and time for the backup.

Click Next to proceed.

Step 5

The Schedule Configuration Backup page is refreshed with the final step, Summary, highlighted. Review your selections, and click Schedule backup to proceed.

A backup job is created and added to the job list.

Step 6

To view the progress of a job, navigate to the Jobs tab on the Configuration Backup & Restore page. Enter job details, such as the job name or status, in the search fields within the table. Then, click on the job name to view detailed information about the job.

On the Job details page, you can edit, pause, or delete the backup job by selecting the corresponding options in the UI.


Restore a configuration backup

This section explains how to restore a configuration backup on a device.

Procedure


Step 1

From the main menu, choose Device Management > Configuration Backup and Restore.

The Configuration Backup & Restore page is displayed.

Step 2

Click on the device to which you want to restore the backup. The Device Configuration Details page is displayed.

Step 3

Click Restore. The Restore Configuration page is displayed with the first step, Select backup file, highlighted.

  • Select Backup files to select from the list of configuration backups.
  • Select Upload to upload the configuration file from you local machine.

Click Next to continue.

Step 4

The Restore Configuration page is refreshed with the next step, Configure & schedule, highlighted.

  1. Under Configurations to restore, choose the relevant configuration you need. Based on the device type and version, the available configurations may include Admin, Running, and/or Startup configurations.

  2. Select the relevant configuration checkboxes.

    • Reboot

      Note

       

      The Reboot checkbox is enabled only when Startup configuration is being restored.

    • Save to startup

      Note

       

      The Save to startup checkbox is enabled only when Running configuration is being restored on IOS, IOS XE, or NX-OS devices.

    • Archive before restore

    • Continue restore on archive failure

    • VRF name

  3. Under Schedule, choose Now or Later.

    • Starting date and time: This field is applicable only if you have chosen to schedule the restore operation for a later time.

Click Next to continue.

Step 5

The Restore Configuration page is refreshed with the final step, Summary, highlighted. Review your selections, and click Restore to proceed.

A restore job is created and added to the job list.

Step 6

To view the progress of a job, navigate to the Jobs tab on the Configuration Backup & Restore page. Enter job details, such as the job name or status, in the search fields within the table. Then, click on the job name to view detailed information about the job.

On the Job details page, you can edit, pause, or delete the restore job by selecting the corresponding options in the UI.


View a device configuration

This section outlines the steps to view a device backup configuration.

Procedure


Step 1

From the main menu, choose Device Management > Configuration Backup and Restore.

The Configuration Backup & Restore page is displayed.

Step 2

To view the latest backup configuration, click View under the Last backup configuration column to view the latest configuration backup of the selected device.

Step 3

To view an older backup configuration, click on the device. The Device Configuration Details page is displayed with the list of backup configurations performed on the device.

Note

 

When new non-empty backups are created for a device, old non-pinned backups, including empty backups, are purged based on the configured preferences (maximum backup versions or maximum retention days). Old backups are removed only after successfully creating a new backup for the same device.

Step 4

Click on the required backup configuration file, and the configuration details are displayed in a drawer panel window.


Pin a device configuration

This section outlines the steps to pin a device configuration.

Procedure


Step 1

From the main menu, choose Device Management > Configuration Backup and Restore.

The Configuration Backup & Restore page is displayed.

Step 2

Click on the required device. The Device Configuration Details page is displayed.

Step 3

Under the Actions column, click More icon and select Pin to pin a configuration file.

Note

 

A pinned configuration cannot be deleted.

Step 4

(Optional) To unpin a pinned configuration, click More icon and select Unpin.


Compare device configurations

This section outlines the steps to compare your device backup configurations.

Procedure


Step 1

From the main menu, choose Device Management > Configuration Backup and Restore.

The Configuration Backup & Restore page is displayed.

Step 2

Click on the device you want to view. The Device Configuration Details page is displayed with the list of backup configurations performed on the device.

Step 3

Click Compare and the latest backup configuration version is displayed.

Step 4

Click the Configuration versions dropdown lists to select the configuration versions to compare.


Export device configuration

This section outlines the steps for exporting your device configuration.

Procedure


Step 1

From the main menu, choose Device Management > Configuration Backup and Restore.

The Configuration Backup & Restore page is displayed.

Step 2

Click on the device you want to view. The Device Configuration Details page is displayed with the list of backup configurations performed on the device.

Step 3

Under the Actions column, click More icon and select Export.

The Export drawer panel window is displayed.

Step 4

Choose the Type.

  • Select Sanitized if you want to mask device passwords (credentials) in the downloaded file.

  • Select Unsanitized if you want to keep device passwords (credentials) visible in the downloaded file.

Step 5

Click Export, and the device configuration is exported as a ZIP archive file.

Note

 
  • Exporting sanitized or unsanitized configurations is done at the device and configuration level. Multi-selection is not allowed.

  • Only one configuration can be exported at a time.

Step 6

(Optional) You can also export configuration backup activity history for one or more devices.

  • Export for multiple devices: On the Configuration Backup & Restore page, select the devices and click Export icon. In the popup window, provide a file name and click Export to export the configuration activity history as a CSV file.
  • Export for all devices: On the Configuration Backup & Restore page, click Export icon. In the popup window, provide a file name and click Export to export the configuration activity history as a CSV file.

Delete a device configuration

This section outlines the steps to delete a device configuration.

Procedure


Step 1

From the main menu, choose Device Management > Configuration Backup and Restore.

The Configuration Backup & Restore page is displayed.

Step 2

Click on the required device. The Device Configuration Details page is displayed.

Step 3

Under the Actions column, click More icon and select Delete to delete a configuration file.