In Citrix Application Delivery Management 12.1
In Citrix Application Delivery Management Software
In All products
Product Documentation
In Citrix Application Delivery Management 12.1
In Citrix Application Delivery Management Software
In All products
Citrix Application Delivery Management 13.0 Citrix Application Delivery Management 12.1
View PDF

Back up Citrix SD-WAN WANOP instances

August 1, 2019
Contributed by:  C

You can back up the current state of an instance and later use the backed-up files to restore the instance to the same state. It is a good practice to back up an instance before you upgrade the instance or for precautionary reasons. A backup of a stable system enables you to restore the system to a stable point in case it becomes unstable. There are multiple ways to perform backups and restores on a Citrix SD-WAN WANOP instance. You can maually backup and restore instances using the GUI, CLI, or use Citrix ADM to perform backups. Citrix ADM backs up the current state of your managed Citrix SD-WAN WANOP instances using NITRO calls, Secure Shell (SSH) protocol, and Secure Copy (SCP) protocol.

Configuring Instance Backup Settings

Before you take a backup of the Citrix SD-WAN WANOP instance in Citrix ADM, you have to configure the instance backup settings on Citrix ADM.

To configure instance backup settings:

  1. In Citrix ADM, navigate to System > System Administration. In the right-hand pane, under Backup Settings, select Instance Backup Settings.

  2. Select Enable Instance Backups. This option is enabled by default.

  3. Select Password Protect File to encrypt the backup file. Encrypting the backup file ensures that the sensitive information in the backup file is secure.

  4. In the Number of Backup Files to retain field, specify the number of backup files to retain in Citrix ADM. You can retain up to 50 backup files.

    Note

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

    localized image

  5. Set the Backup Scheduling settings. Choose one of the following options:

    • Interval Based - A backup file is created in Citrix ADM after the specified interval elapses. The default backup interval is 12 hours.
    • Time Based - You can specify the time in “hours:minutes” format at which the backup should happen. Citrix ADM allows up to four daily backups to happen on the instances.

    localized image

    Note

    Ignore the Citrix ADC Settings section; these settings are not applicable for Citrix SD-WAN WANOP instances.

  6. Select Enable External Transfer to transfer the instance backup files to an external location. Enter the values for the following fields:

    • Server: IP address of the external server.
    • User Name: User name of the external server
    • Password: Password of the external server.
    • Port: Port number used to communicate with the external server.
    • Transfer Protocol: Protocol to be used for transferring the backup files from Citrix ADM to the external server.

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

    localized image

  7. Click OK.

    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 SD-WAN WANOP instances.

Creating a Backup of Citrix SD-WAN WANOP Instance

The procedure to create a backup for Citrix SD-WAN WANOP instance is applicable for an admin user, using the default nsroot profile.

For information on, how a custom user can take back up of a Citrix SD-WAN WANOP instance see, Creating a Backup of Citrix SD-WAN WANOP Instance for Custom Users section in this topic.           .

Ensure that a Citrix SD-WAN WANOP instance is added to Citrix ADM for more information see, Adding Instance to Citrix ADM.

To create a backup for Citrix SD-WAN WANOP Instance:

  1. In Citrix ADM, navigate to Networks > Instances > Citrix SD-WAN.

  2. In SD-WAN WO, select the Citrix SD-WAN WANOP instance that you want to back up, and then click Backup/Restore.

    localized image

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

  4. Encrypt your backup file by using any one of the following options:

    • Select Password Protected file, and enter a password to encrypt the backup files.
    • Select Use Global Password to use the global password that you specified on the instance backup settings page.

  5. Click Create Backup

Creating a Backup of Citrix SD-WAN WANOP Instance for Custom Users

If you have created a custom user with admin privileges in Citrix SD-WAN WANOP instance, use the following procedure to add an instance and take back up of that instance using Citrix ADM.

Backup operation by custom users is not supported on 400/800/1000WS/2000/2000WS/3000/4000/5000/4100/5100 SD-WAN WANOP platforms.

Note

Citrix recommends you to use the default nsroot profile, while creating backup of Citrix SD-WAN advanced platforms in Citrix ADM.

To add a Citrix SD-WAN WANOP Instance and take a backup for a custom user:

  1. In Citrix ADM, navigate to Networks > Instances > Citrix SD-WAN and select SD WAN WO.

  2. Click Add.

  3. In the IP Address field, enter the IP address of the Citrix SD-WAN WANOP instance.

  4. Click Add next to Profile Name field to create a new profile. The Create Citrix SD-WAN WO Profile window appears.

    localized image

  5. In the Profile Name field, enter a name for the profile.

  6. In the User Name field, enter the username of the custom user that you create on the SD-WAN WANOP instance.

  7. In the Password field, enter the password that you set for the custom user in the SD-WAN WANOP instance.

  8. In the Community field, enter the SNMP communication string configured on the SD-WAN WANOP appliance. ( for example: public)

  9. Click Create.

  10. In the Profile Name field, select the newly created profile and click OK.

    localized image

  11. Navigate to Networks > Instances > Citrix SD-WAN.

  12. In SD-WAN WO, select the Citrix SD-WAN WANOP instance that you just added, and then click Backup/Restore.

    localized image

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

  14. Encrypt your backup file by using any one of the following options:

    • Select Password Protected file, and enter a password to encrypt the backup files.
    • Select Use Global Password to use the global password that you specified on the instance backup settings page.

    Note

    You can download the encrypted backup file to your local machine, but you cannot view its contents. Only Citrix ADM can use these backup file for restore purpose. Restoring encrypted backup will prompt for password.

  15. Click Create Backup.

    Important

    1. For a Citrix SD-WAN WANOP VPX appliance, Citrix ADM backs up only the CB broker configuration file.
    2. For an advanced Citrix SD-WAN WANOP platform, Citrix ADM backs up the following:·
    • CB broker configuration file
    • NTP configuration file
    • DNS
    • SNMPD configuration file
    • Syslog configuration file
    • SSL certificate, keys and policies
    • SVM Database file
    • Components (in XML format)
    • Resources (in XML format)

    The files that are backed up in the respective folders are listed in the following table. Note that if a folder name is followed by a “*”, all files in that folder are backed up.

    Directory Sub-Directory or Files
    /br_broker/ CB-6bbb660a/ ws.conf
    /etc/ resolv.conf
    /mps/ mps_devices.xml
    /mpsconfig/ ssl/*, ntp.conf, snmpd.conf, syslog.conf
    /mpsdb/ mpsdb_dump.sql
    /ns/ NS-6cbb660a/*
    /var/ mps/policy/*, mps/ssl_certs/ sdx_default_ssl_cert, mps/ssl_keys/ sdx_default_ssl_key, mps/tenants/*

Back up Citrix SD-WAN WANOP instances

August 1, 2019
Contributed by:  C

In this article

Edit this article