Backup and restore

April 9, 2019

Contributed by: C

You can back up the current state of a NetScaler appliance, and later use the backed up files to restore the appliance to the same state. You must use this feature before performing an upgrade or for precautionary reasons. A backup of a stable system enables you to restore the system to a stable point in the event that it becomes unstable.

Points to remember:

Sysid and Interfaces should be same.
Network configuration should be supported on New Platform.
New Platform build should is either same of backup file or higher version than it.

Back up a NetScaler appliance

Depending on the type of data to be backed up and the frequency at which you will create a backup, you can take a basic backup or a full backup.

Basic backup. Backs up only configuration files. You might want to perform this type of backup frequently, because the files it backs up change constantly. The files that are backed up are:

For more information about the basic backup details, see the Table topic.

Full backup. In addition to the files that are backed up by a basic backup, a full backup backs up some less frequently updated files. The files that are backed up when using the full backup option are:

Directory	Sub-Directory or Files
nsconfig	ssl, license, fips*
/var/	netscaler/ssl/, wi/java_home/jre/lib/security/cacerts/, wi/java_home/lib/security/cacerts/*

The backup is 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 store 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

While the backup operation is in progress, do not execute commands that affect the configuration.

If a file that is required to be backed up is not available, the operation skips that file.

To backup a NetScaler appliance

To backup the NetScaler by using the NetScaler command line interface

At the command prompt, do the following:

Save the NetScaler configurations.

save ns config

Create the backup file.

create system backup [<fileName>] -level <basic ¦ full> -comment <string>

Note:

If the file name is not specified, the appliance creates a TAR file with the following naming convention:backup_<level>_<nsip_address>_<date-timestamp>.tgz.

Example: To backup the full appliance using the default naming convention for the backup file.

> create system backup -level full

Verify that the backup file was created.

show system backup

You can view properties of a specific backup file by using the fileName parameter.

To backup the NetScaler by using the GUI

Navigate to System > Backup and Restore, click Backup and then specify the details of the backup.

Restore a NetScaler appliance

Important

The restore operation does not succeed if the backup file is renamed or if the contents of the file are modified.

When you restore the appliance from a backup file, the restore operation untars the backup file into the /var/ns_sys_backup/ directory. Once the untar operation is complete, the files are copied to their respective directories.

To restore the NetScaler from a local backup file by using the command line interface

Note: Citrix recommends backing up the current configuration before restoring a previous configuration. However, if you do not want the restore command to automatically create a backup of the current configuration, use the –skipBackup parameter.

At the command prompt, do the following:

Obtain a list of the backup files available on the appliance.

show system backup
Restore the appliance by specifying one of the backup files.

restore system backup <filename> [-skipBackup]

Example: To restore by using a full backup of an appliance

> restore system backup backup_full_<nsip_address>_<date-timestamp>.tgz
Reboot the appliance.

reboot

To backup and restore a Citrix ADC appliance by using the GUI

Navigate to System > Backup and Restore.
Click Backup/Import to start the process.
In the Backup/Import page, select Create and set the following parameters.
1. File Name. Name of the appliance backup file.
2. Level. Select a backup level as basic or full.
3. Comment. Provide a brief description for the backup.
Click Backup.
If you want to import a backup, you must select Import.
Once backup is complete, you can select the file and click Download.
To restore, select the backup file and click Restore.
In the Restore page, verify backup file details and click Restore.

The official version of this content is in English. Some of the Citrix documentation content is machine translated for your convenience only. Citrix has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Citrix product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Citrix, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Citrix will not be held responsible for any damage or issues that may arise from using machine-translated content.

Edit this article

Backup and restore

April 9, 2019

Contributed by: C

Backup and restore

Back up a NetScaler appliance

To backup a NetScaler appliance

Restore a NetScaler appliance

To restore the NetScaler from a local backup file by using the command line interface

To backup and restore a Citrix ADC appliance by using the GUI

Backup and restore

In this article