Product Documentation

Back up NetScaler SD-WAN WO instances

May 24, 2018

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 NetScaler SD-WAN WO instance. You can maually backup and restore instances using the GUI, CLI, or use NetScaler MAS to perform backups. NetScaler MAS backs up the current state of your managed NetScaler SD-WAN WO instances using NITRO calls, Secure Shell (SSH) protocol, and Secure Copy (SCP) protocol.

Configuring Instance Backup Settings

Before you take a backup of the NetScaler SD-WAN WO instance in NetScaler MAS, you have to configure the instance backup settings on NetScaler MAS. 

To configure instance backup settings: 

In NetScaler MAS, navigate to System > System Administration. In the right-hand pane, under Backup Settings, select Instance Backup Settings.

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

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

In the Number of Backup Files to retain field, specify the number of backup files to retain in NetScaler MAS. 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 NetScaler MAS as per your requirement.

localized image

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

  • Interval Based - A backup file is created in NetScaler MAS 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. NetScaler MAS allows up to four daily backups to happen on the instances.
localized image

Note

Ignore the NetScaler Settings section; these settings are not applicable for NetScaler SD-WAN WO instances.

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 NetScaler MAS to the external server.

You can also delete the backup file from NetScaler MAS after transferring it to the external server.

localized image

Click OK

Note

NetScaler MAS sends an SNMP trap or a Syslog notification to itself when there is a backup failure for any of the selected NetScaler SD-WAN WO instances. 

Creating a Backup of NetScaler SD-WAN WO Instance

The procedure to create a backup for NetScaler SD-WAN WO 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 NetScaler SD-WAN WO instance see, Creating a Backup of NetScaler SD-WAN WO Instance for Custom Users section in this topic.           .

Ensure that a NetScaler SD-WAN WO instance is added to NetScaler MAS for more information see, Adding Instance to NetScaler MAS.

To create a backup for NetScaler SD-WAN WO Instance: 

In NetScaler MAS, navigate to Networks > Instances > NetScaler SD-WAN WO.

Select the NetScaler SD-WAN WO instance that you want to back up, and then click Backup/Restore.

localized image

On the Backup Files page, click Back Up.

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.

Click Create Backup

Creating a Backup of NetScaler SD-WAN WO Instance for Custom Users

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

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

Note

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

To add a NetScaler SD-WAN WO Instance and take a backup for a custom user:

In NetScaler MAS, navigate to Networks > Instances > NetScaler SD-WAN WO and click Add

In the IP Address field, enter the IP address of the NetScaler SD-WAN WO instance. 

Click + next to Profile Name field to create a new profile. The Create NetScaler SD-WAN WO Profile window appears. 

localized image

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

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

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

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

Click Create

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

localized image

 Navigate to Networks > Instances > NetScaler SD-WAN WO.

Select the NetScaler SD-WAN WO instance that you just added, and then click Backup/Restore.

localized image

On the Backup Files page, click Back Up.

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 NetScaler MAS can use these backup file for restore purpose. Restoring encrypted backup will prompt for password.

Click Create Backup

Important

  1. For a NetScaler SD-WAN WO VPX appliance, NetScaler MAS backs up only the CB broker configuration file. 
  2. For an advanced NetScaler SD-WAN WO platform, NetScaler MAS 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/*