Backing Up and Restoring Configuration Templates
Aruba Central allows you to create a backup of configuration templates and variables that you can restore in the event of a failure or loss of data. The feature is available in the page for devices deployed using template-based configuration method.
The feature enables administrators to perform the following functions:
Back up templates and variable files applied to the devices managed using the template-based configuration method.
Restore an earlier known working combination of the configuration template and device variables in the event of a failure.
Important Points to Note
The backup and restoration options are available for devices deployed using the template-based configuration method.
When the backup or restore for a group is in progress, you cannot make configuration changes to that group.
The restore operation restores the variables only for the devices that are currently provisioned or pre-provisioned to the group.
The restore operation is terminated if the major version in the firmware running on any one device in the group does not match the major version in the firmware in the backed up file that is being restored. However, the restore operation completes if the minor version in the firmware running on any device in the group does not match the minor version in the firmware in the backed up file that is being restored. For example, if the configuration file was backed up when a switch was running 16.03.0003 and was later upgraded to 16.04.0003, the restore operation fails for the group. However, if the configuration file was backed up when a switch was running 16.03.0003 and was later upgraded to 16.03.0005, the restore operation completes successfully.
The restore operation deletes any templates applied to the group before the restore. It also deletes and replaces device variables with the backed up version that is being restored.
The details pertaining to the actions carried out during the backup and restore operations are logged in the page.
Creating a Configuration Backup
To back up configuration templates and variables applied to devices:
1. In the app, set the filter to one of the template group under .
2. Navigate to the page.
3. Under , click . The window is displayed.
4. Enter a .
5. Select if you do not want the backed up file to be deleted by a new backup after the threshold of 20 backups is exceeded.
|
|
You can create and maintain up to 20 backed up configuration files. If the number of backup files exceed 20, the old backed up configuration files are overwritten. However, if the backed up files are marked as , Aruba Central does not overwrite the backed up configuration files. |
6. Click . The window is displayed.
7. Read through the information. Select the check box to confirm that configuration changes to the group cannot be done when the backup is in progress.
8. Click . The backup for the group configuration is created.
Viewing Contents of a Backed Up Configuration
To view the contents of a backed up configuration:
1. Click the option.
2. Download the backup and untar the downloaded file. The following example shows the tree structure of a typical backup download.
<backup-name_timestamp>
├── templates
│ ├──<hppctemplate1.tmpl>
│ ├──<iaptemplate1.tmpl>
│ ├──template_meta.json
└── variables
├──HPPC_variables_1.json
├──IAP_variables_1.json
└──devices_meta.json
|
|
The variables are stored according the device type, such as, Instant APs and Aruba Switches. For example, for all Instant APs, the variables are aggregated and stored together. The aggregated file can include variables for up to 80 devices or up to 5 MB of variables data, based on whichever condition is met first. When the number of variables or the data size exceeds this limit, new aggregate files are created and added to the backup until all the variables in the selected group are backed up. The variable data limit applies only to the aggregated files. Aruba Central does not impose any limit on the number of devices or the device variables that can be backed up. |
The following details are available for a backed up configuration snapshot:
—provides details of the number of available and allowed backup and allows you to perform the following actions:
Manage group configuration backups
Create new configuration backups
Modify backup delete protection
—provides details of the status and the timestamp of the last backup.
—provides details of the status and the timestamp of the last restore.
Restoring a Backed Up Configuration
To restore a backed up configuration snapshot:
1. In the app, use the filter to select a group that uses template-based configuration method.
2. Navigate to the page.
3. Under , click . The window is displayed.
4. Select the backup name that you want to restore, from the drop-down list.
5. Select the required device type from the drop-down list.
|
|
Selecting a device type allows you to restore the backed up configuration by the specific device type, for example, Instant APs, Aruba Switch, or Aruba Mobility Controller. By default, is selected. When the device type is set to , configuration restore does not follow any specific order. |
6. Click . The window is displayed.
7. Read the instructions and select the check boxes to confirm your action for configuration restore.
8. Click The selected backup configuration is restored.
|
|
Aruba recommends that the administrators take a backup of the current configuration of the group before the restore operation. |
Managing Backups
To manage the backed up configuration files:
1. In the app, use the filter to select a group that uses template-based configuration method.
2. Navigate to the page.
3. Under , click . The window is displayed.
4. View the backup details such as date and time of backup, backup name, username, and the delete protection status for each configuration backup.
5. Click .
6. Click to view the details of the latest backup. The window displays the following details:
Group name
Backup name
Username that initiated the configuration backup
Details on whether templates and device variables are being saved, and completion of the configuration backup process.
7. To get the status of the last restore, click . To get the error log for a restore error event, click .
Backing Up and Restoring Templates and Variables Using APIs
Aruba Central supports the following NB APIsApplication Programming Interface. Refers to a set of functions, procedures, protocols, and tools that enable users to build application software. for the backup and restore feature:
Create new configuration backup for group
Create backups for multiple groups associated with a customer account
|
|
Aruba Central creates a backup of configuration template and variables only for the groups included in the API request payload. You can use the include or exclude parameters to create backups for specific list of groups. |
The following table describes the API response based on the inputs provided in the parameters:
|
include_groups |
exclude_groups |
API Functionality |
|---|---|---|
|
No groups specified |
No groups specified |
Raises an exception to either include or exclude groups. |
|
group names |
group names |
Raises an exception to include or exclude groups. |
|
[] |
No groups specified |
Raises an exception to provide valid values for the include groups parameter. |
|
group names |
No groups specified |
Includes selected groups for the backup operation. |
|
No groups specified |
ALL_GROUPS |
Creates a backup for all groups. |
|
No groups specified |
group names |
Does not create backup for the excluded groups. |
Restore a backed up version of the configuration template for all devices in a group:
The API restores a specific version of the backup snapshot for the group specified in the API request.
Restore a backed up version of the configuration template by device type:
The API provides you an option to restore the configuration by device type. By selecting a specific device type, you can control the order in which the configuration is restored by device type. This minimizes the impact of the configuration restore activity on the network.
