Backup and Restore of Avi Vantage Configuration

Periodic backup of the Avi Vantage configuration database is recommended. This database defines all clouds, all virtual services, all users, and so on. Any user capable of logging into the admin tenant is authorized to perform a backup of the entire configuration, i.e., of all tenants. A restore operation spans all the same entities, but can only be performed by the administrator(s) capable of logging into one of the Controllers using SSH or SCP.

It is a best practice to store backups in a safe, external location, in the unlikely event that a disaster destroys the entire Avi Controller (or cluster), with no possibility of remediation. Based on how often the configuration changes, a recommended backup schedule could be daily or even hourly.

Backing Up the Avi Vantage Configuration

To back up the Avi Vantage configuration, use the UI, CLI commands or API commands shown in this section. Backups can be scheduled or on-demand.

Scheduled Backup via UI

To view or edit the configuration backup scheduler’s current settings, navigate to Administration > System > Configuration Backup as shown below. Note: The scheduled backups get stored in /var/lib/avi/backups/> on all Controllers in the cluster.

Scheduling an Avi Vantage configuration backup

To effect changes, select the edit icon (the pencil icon) available on the right side of the Avi UI. The Backup Scheduler editor appears as shown below:


  • Enable Configuration Backup: Turns scheduled backups on or off.
  • Frequency: A value from 0 to 60 to combine with Frequency Unit to determine how often backups are to be taken. 0 indicates the backup sequence has no end time.
  • Frequency Unit: Backups occur daily by default. Use this field to change the units to minutes, hours, weeks or months.
  • Backup Passphrase: A mandatory phrase that is used to encrypt all sensitive fields contained within the backup. Choose a phrase that is not easy to guess and guard it carefully. Data can’t be restored without it.
  • Local (on Controller): On by default, this switch tells Avi Vantage to preserve the number of indicated backups on the Controller. One can choose the local and remote backup options independently.
  • File Prefix: An optional character string that permits customers to customize the backup archive filename.
  • Number of backups to store: A number ranging from 0 to 20, default is 4. 0 is equivalent to unchecking the Local option. The oldest backup is deleted after the most recent backup successfully completes.
  • Remote Server: This option is off by default. It is recommended that a remote destination be specified in case the Avi Controller cluster fails in a non-recoverable fashion. One can choose the local and remote backup options independently. Turning this option on causes the Controller to log onto the indicated server using SSH user credentials, and then secure copy (scp) the backup data to the indicated directory.
    • Server Address is an FQDN or IP address reachable from the Controller.
    • User Credentials: Use the pulldown menu to select from a previously-defined SSH user or accept the option to create one.
    • Directory: If a target directory other than the SSH user’s home directory is desired, specify an absolute or relative pathname pointing to a directory to which the SSH user has write access.

Scheduled Backup via CLI

[admin:10-10-24-52]: > configure scheduler Default-Scheduler
| Field             | Value                                          |
| uuid              | scheduler-b5f7e673-8818-44d1-8f74-45238cc08235 |
| name              | Default-Scheduler                              |
| enabled           | True                                           |
| run_mode          | RUN_MODE_PERIODIC                              |
| start_date_time   | 2016-10-09T15:35:46.220623                     |
| frequency         | 1                                              |
| frequency_unit    | SCHEDULER_FREQUENCY_UNIT_DAY                   |
| backup_config_ref | Backup-Configuration                           |
| scheduler_action  | SCHEDULER_ACTION_BACKUP                        |
| tenant_ref        | admin                                          |

[admin:10-10-24-52]:  configure backupconfiguration Backup-Configuration
| Field                  | Value                                                    |
| uuid                   | backupconfiguration-5d65f12e-5da1-49e0-b703-ec65ae9a39c6 |
| name                   | Backup-Configuration                                     |
| save_local             | True                                                     |
| maximum_backups_stored | 4                                                        |
| tenant_ref             | admin                                                    |

Scheduled Backup via API

In this example a PUT changes the scheduler frequency to 1 week:

PUT : api/scheduler/
{'_last_modified': u'1476209663670990',
'backup_config_ref': '',
 'enabled': True,
 'frequency': 1,
 'frequency_unit': u'SCHEDULER_FREQUENCY_UNIT_WEEK',
 'name': u'Default-Scheduler',
 'run_mode': u'RUN_MODE_PERIODIC',
 'scheduler_action': u'SCHEDULER_ACTION_BACKUP',
 'start_date_time': u'2016-10-09T15:35:46.220623',
 'tenant_ref': u'',
 'url': '',
 'uuid': u'scheduler-b5f7e673-8818-44d1-8f74-45238cc08235'}

On-demand Backup via CLI

To back up the Avi Vantage configuration on-demand, at any arbitrary time, use the following CLI command:

: > export configuration file /tmp/avi_config.json full_system
Please enter the passphrase to encrypt configuration:
Downloaded the attachment to /tmp/avi_config.json
Completed writing the export configuration to /tmp/avi_config.json

On-demand Backup via API

To back up the Avi Vantage configuration on-demand, at any arbitrary time, use the following API request:

GET https://[CONTROLLER-IP]/api/configuration/export?full_system=true

To also include a passphrase, use one of the following options:

In versions 16.1.3 and above:

GET https://[CONTROLLER-IP]/api/configuration/export?full_system=true&passphrase=[PASSPHRASE]

In versions 16.2 and above, use the following POST method and include passphrase in the JSON data:

POST https://[CONTROLLER-IP]/api/configuration/export?full_system=true
JSON data: {"passphrase":"[PASSPHRASE]"}

Make sure to replace [CONTROLLER-IP] with the IP address of the Avi Controller (if using a single Avi Controller node), or the IP address of the Avi Controller cluster.

On-demand bash Backup Script Utilizing the API

DATE=$(date "+%Y%m%d")
while read -u10 DEVICE
/usr/bin/curl -k -c $COOKIEFILE -X POST -H 'Content-Type: application/json' -d '
' https://$DEVICE/login
/usr/bin/curl -k -b $COOKIEFILE -X GET https://$DEVICE/api/configuration/export?full_system=true > $SCRIPTDIR/$FILENAME
CSRFTOKEN=$(/bin/grep csrftoken $COOKIEFILE | awk '
{ print $7 }
/usr/bin/curl -k -b $COOKIEFILE -X POST -H "X-CSRFToken: $CSRFTOKEN" -H "Referer: https://$DEVICE" https://$DEVICE/logout
/bin/rm -f $SCRIPTDIR/cookiefile
/usr/local/bin/gzip $SCRIPTDIR/$FILENAME
/bin/chown fimtacs:uxusers $SCRIPTDIR/$FILENAME.gz
done 10< "$AVILIST"
    1. Clean up files older than 60 days on the server
       /usr/bin/find $SCRIPTDIR/*json.gz -type f -mtime +60 -exec rm {} \;

On-demand Backup Script Utilizing Python

Refer to

Restoring the Avi Vantage Configuration

If the unlikely should occur and a disaster completely destroys the Avi Controller (or entire cluster), the device/VM hosting the Avi Controller(s) should first be restored to factory default using Failure to do so can prevent the Controller from coming up. To restore the Controller to the factory default, run the script /opt/avi/scripts/ Note: If it exists, the /var/lib/avi/etc/flushdb.done file should be removed before running the script.

Thereafter, the following script can be used to automate the configuration recovery process:


Note: If running an Avi Vantage version earlier than 16.2, please contact Avi Networks support for help restoring the configuration.

This script imports the backup configuration onto the Avi Controller. If restoring an Avi Controller cluster, this script restores the configuration and also re-adds the other two nodes to the cluster.

  1. Create three new Avi Controllers with the same IP address as the original cluster members. (Avi Vantage currently supports only static IP addresses.) At this point, other than having an IP address, each Avi Controller node should be in its factory default state.
  2. Log onto one of the Avi Controller node using SSH or SCP. Use the default administrator credentials.
  3. Run the restore command or script:
    • Copy backup file via SCP:
      scp /var/backup/avi_config.json admin@<controller-ip>://tmp/avi_config.json
  • Run restore command locally via SSH:
    /opt/avi/scripts/ --config /tmp/avi_config.json --passphrase <passphrase> --username <admin> --password <admin password>
  • Optionally, user may choose to delete all configuration before restoring. This can be achieved by passing --flushdb argument to the command.