Back up and restore Citrix ADC instances

You can back up the current state of a Citrix Application Delivery Controller (Citrix ADC) instance and later use the backed-up files to restore the Citrix ADC instance to the same state. You must always back up an instance before you upgrade it or for just 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, CLI, or you can use Citrix Application Delivery Management (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 backs up and restores the following types of Citrix ADC instances:

  • Citrix ADC SDX

  • Citrix ADC VPX

  • Citrix ADC MPX

For a Citrix ADC VPX instance, Citrix ADM backs up the files depending on the type of data to be backed up. You can create either a basic backup or a full backup.  

Note

  • You cannot perform the backup and restore operation on a Citrix ADC cluster.

  • There is no option to select the level of back up required from the ADM. Configure the level of back up required in the ADC instance. For more information, see Backup and restore an ADC instance.

  • Basic backup: In this type, only configuration files are backed up as these are the files that change regularly. The following table lists the files that are backed up in the respective folders. Note that if a folder name is followed by a “*,” all files in that folder are backed up.

  • Full backup: In this type, in addition to the files that are backed up by a basic backup, some less frequently updated files are also backed up. The following table lists the files that are backed up when using the full backup option:

The backed up files are stored as a compressed TAR file in the /var/ns_sys_backup/ directory. To avoid issues due to non-availability of disk space, you can save a maximum of 50 backup files in this directory. You can use the “rm system backup” command to delete existing backup files so that you can create more backups.

Note

  • You cannot use the backup file taken from one instance to restore a different instance.
  • You can back up and restore instances in an HA setup. But ensure to restore the same instance from which the backup file was created. For example, if the backup was taken from the primary instance of the HA pair when restoring ensure you are restoring the same instance, even if it is no longer the primary instance.

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 required you can also restore the Citrix ADC instances by using these backed up files.

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, VPX) to display on the screen.

  2. Select the instance that you want to back up, and then click View Backup.

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

  4. 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.

Transfer a backup file to an external system

You can transfer a copy of your backup file to another system as a precautionary measure. When you want to restore the configuration, you have to first upload the backup file to the Citrix ADM server and then perform the restore operation.

To transfer a Citrix ADM backup file:

  1. Navigate to Networks > Instances > Citrix ADC and then select the instance type. For example, VPX.

  2. Select the instance and from the Select Action list, select Backup/Restore.

  3. Select the backup file and then click Transfer.

    localized file

    The Transfer Backup File page is displayed. Specify the following parameters:

    1. Server - IP address of the system where you want to transfer the back-up file.

    2. User name and password – User credentials of the new system, where the backed-up files are being copied.

    3. Port – Port number of the system the files are being transferred to.

    4. Transfer protocol – Protocol being used to make the backup file transfer. You can select SCP, SFTP, or FTP protocols to transfer the back-up file.

    5. Directory path – The location where the backed-up file is being transferred to on the new system.

    6. Click OK.

      localized image

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.

Important

  1. For a Citrix ADC SDX appliance, Citrix ADM backs up only 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
    • SDX Single Bundle Image (SVM+XS)
    • Third Party instance images (if provisioned)
  2. 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.

  3. 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.

  4.  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.

To export the report of this dashboard:

To export the report of this page, click the Export icon on the top right side of this page. On the Export page, you can do one of the following:

  1. Select Export Now tab. To view and save the report in PDF, JPEG, PNG, or CSV format.

  2. Select Schedule Export tab. To schedule the report daily, weekly, or monthly and send the report over email or slack message.

Note

  • If you select Weekly recurrence, ensure that you select the weekdays on which you want the report to be scheduled.
  • If you select Monthly recurrence, ensure that you enter all the days that you want the report to be scheduled separated by commas.