Back up and restore Citrix ADC instances

You can back up the current state of a Citrix ADC instance and later use the backed-up files to restore it to the same state. Always back up an instance before you upgrade it or for precautionary reasons. A backup of a stable system enables you to restore it back to a stable point if it becomes unstable.

There are multiple ways to perform backups and restores on a Citrix ADC instance. You can manually backup and restore Citrix ADC configurations using the GUI and CLI. You can also use Citrix ADM to perform automatic backups and manual restores.

Citrix ADM backs up the current state of your managed Citrix ADC instances by using NITRO calls and the Secure Shell (SSH) and Secure Copy (SCP) protocols.

Citrix ADM creates a complete backup and restores the following Citrix ADC instance types:

  • Citrix SDX

  • Citrix VPX

  • Citrix MPX

  • Citrix BLX

For more information, see Backup and restore an ADC instance.

Note

  • From Citrix ADM, you cannot perform the backup and restore operation on a Citrix ADC cluster.

  • You cannot use the backup file taken from one instance to restore a different instance.

The backed-up files are stored as a compressed TAR file in the following directory:

/var/mps/tenants/root/device_backup/

To avoid issues due to non-availability of disk space, you can save a maximum of 50 backup files in this directory.

To back up and restore Citrix ADC instances, you must first configure the backup settings on Citrix ADM. After configuring the settings, you can select a single Citrix ADC instance or multiple instances and create back up of the configuration files in these instances. If necessary, you can also restore the Citrix ADC instances by using these backed-up files.

Configure instance backup settings

The Instance Backup Settings page allows you to configure settings on Citrix ADM to back up a selected Citrix ADC instance or multiple instances:

  1. In Citrix ADM, navigate to System > Administration.

  2. In Backup, select Configure System and Instance backup.

  3. Select Instance and specify the following:

    • Enable Instance Backups: By default, Citrix ADM is enabled for taking backups of Citrix ADC instances. Clear this option if you do not want to create backup files for the instances.

    • Password Protect File: (optional) Select password protect option to encrypt the backup file. Encrypting the backup file ensures that all the sensitive information inside the backup file is secure.

      Note

      You can download the encrypted backup file to your local machine, but you cannot open the file either with Citrix ADM GUI or with any text editor. The file can be retrieved and used by Citrix ADM alone. You are prompted to provide the password when restoring the encrypted backup file. You can, however, open an unencrypted backup file on your system.

    • Number of Backup Files to retain: Specify the number of backup files to retain in Citrix ADM. You can retain up to 50 backup files of the current state of a Citrix ADC instance. The default is three backup files.

      Note

      Each backup file accounts for some storage requirement. Citrix recommends that you store an optimal number of Citrix ADC backup files on Citrix ADM as per your requirement.

      localized image

    • Backup scheduling settings: (optional) There are two options available for creating backup files, though you can use only one option at a time:

      1. The default backup scheduling option is “interval-based.” A backup file is created in Citrix ADM after the specified interval elapses. The default backup interval is 12 hours.

      2. You can also change the type of scheduled backups to “time-based.” In this option you specify the time in “hours:minutes” format at which the backup should happen. Citrix ADM allows a maximum of four daily backups to happen on the instances.

      localized image

    • Citrix ADC settings: (optional) By default, Citrix ADM does not create a backup file when it receives the “NetScalerConfigSave” trap. But, you can enable the option to create a backup file whenever a Citrix ADC instance sends a “NetScalerConfigSave” trap to Citrix ADM. A Citrix ADC instance sends “NetScalerConfigSave” every time the configuration on the instance is saved.

    • Geodatabase files: (optional) By default, Citrix ADM does not back up the GeoDatabase files. You can enable the option to create a backup of these files also.

      localized image

    • External Transfer:(optional) Citrix ADM allows you to transfer the Citrix ADC instance backup files to an external location:

      1. Specify the IP address of the location.

      2. Specify the user name and the password of the external server to which you want to transfer the backup files.

      3. Specify the transfer protocol and the port number.

      4. You can specify the directory path where the file must be stored.

      5. You also have the option to delete the backup file from Citrix ADM after transferring it to the external server.

      localized image

      Note

      Citrix ADM sends an SNMP trap or a Syslog notification to itself when there is a backup failure for any of the selected Citrix ADC instances.

Create a backup for a selected Citrix ADC instance by using Citrix ADM

Perform this task if you want to back up a selected Citrix ADC instance or multiple instances:

  1. In Citrix ADM, navigate to NetworksInstances. Under Instances, select the type of instances (for example, Citrix VPX) to display on the screen.

  2. Select the instance that you want to back up.

    • For MPX, VPX, and BLX instance, select Backup/Restore from the Select Action list.

    • For an SDX instance, click Backup/Restore.

  3. On the Backup Files page, click Back Up.

  4. You can specify whether to encrypt your backup file for additional security. You can either enter your password or use the global password that you previously specified on the Instance Backup Settings page.

  5. Click Continue.

Restore a Citrix ADC instance by using Citrix ADM

Note:

If you have Citrix ADC instances in a HA pair, you need to note the following:

  • Restore the same instance from which the backup file was created. For example, let us consider a scenario that a backup was taken from the primary instance of the HA pair. During the restore process, ensure that you are restoring the same instance, even if it is no longer the primary instance.

  • When you initiate the restore process on the primary ADC instance, you cannot access the primary instance and the secondary instance gets changed to STAYSECONDARY. Once the restore process is completed on the primary instance, the secondary ADC instance changes from STAYSECONDARY to ENABLED mode and becomes part of the HA pair again. You can expect a possible downtime on the primary instance until the restore process gets completed.

Perform this task to restore a Citrix ADC instance by using the backup file that you had created earlier:

  1. Navigate to NetworksInstances, select the instance that you want to restore, and then click View Backup.

  2. On the Backup Files page, select the backup file containing the settings that you want to restore, and then click Restore.

    localized image

Restore a Citrix ADC SDX appliance using Citrix ADM

In Citrix ADM, the backup of Citrix ADC SDX appliance includes the following:

  • Citrix ADC instances hosted on the appliance
  • SVM SSL certificates and keys
  • Instance prune settings (in XML format)
  • Instance backup settings (in XML format)
  • SSL certificate poll settings (in XML format)
  • SVM db file
  • Citrix ADC config files of devices present on SDX
  • Citrix ADC build images
  • Citrix ADC XVA images, these images are stored in the following location: /var/mps/sdx_images/
  • SDX Single Bundle Image (SVM+XS)
  • Third Party instance images (if provisioned)

You must restore your Citrix ADC SDX appliance to the configuration available in the backup file. During appliance restore, the entire current configuration is deleted.

If you are restoring the Citrix ADC SDX appliance by using a backup of a different Citrix ADC SDX appliance, make sure that you add the licenses and configure the appliance’s Management Service network settings to match those in the backup file before you start the restore process.

Ensure that the Citrix ADC SDX platform variant that was backed up was taken is same as the one on which you are trying to restore. You cannot restore from a different platform variant.

Note

Before you restore an SDX RMA appliance, ensure the backed-up version is either same or higher than the RMA version.

To restore the SDX appliance from the backed-up file:

  1. In the Citrix ADM GUI, navigate to Networks > Instances > Citrix ADC.

  2. Click Backup/Restore.

  3. Select the backup file of the same instance that you want to restore.

  4. Click Repackage Backup.

    Repackage the backed-up file to restore an SDX appliance

    When the SDX appliance is backed up the XVA files and images are stored separately to save the network bandwidth and the disk space. Therefore, you must repackage the backed-up file before you restore the SDX appliance.

    When you repackage the backup file, it includes all the backed-up files together to restore the SDX appliance. The repackaged backup file ensures the successful restoration of the SDX appliance.

  5. Select the backup file that is repackaged and click Restore.