How to Backup & Restore a NetScaler
We all know that backups are important, but exactly how did it work again for the Netscaler? Let me help you with the following guide!
I this article I will cover creating and restoring backups via both the GUI and the CLI. You can skip to the chapter that is right for you.
Backup Levels
There are two backup levels, consider which one you require beforehand.
Basic:
A basic backup contains the data that relatively gets changed the most.
For example, but not limited to:
- /var/
- /netscaler/
- /nsconfig/
- /ns.conf
Full:
A full backup contains:
- The above
- Certificates
- Licenses
- and more
Backup (GUI)
Before doing a backup, you need to make sure your running configuration is saved. If you do not save your running config, it will not be included in the backup.
In the below slider you can see the difference between non-saved running configuration and synced config.
Navigate towards the backup menu option via:
Configuration > System > Backup and Restore > Backup/Import
To create the backup press the Backup button.
You can see that there are two different versions of backup 'level' as described earlier.
After choosing a backup level, simply press "Backup".
You can save your NetScaler backup to a local folder (offloaded from the NetScaler). This is a best practice, as it might not be freely available on the NetScaler in time of need.
Your GUI backup is now created and stored offline.
Restore Backup (GUI)
Navigate to System / Backup and Restore click the checkbox on the appropriate backup and select the restore action.
The screen that follows allows you the click the 'Skip Backup' button.
This will prevent a new backup from being taken when the restore is executed.
Press restore to restore the selected backup.
A warm reboot needs to take place for the restore to take effect (running vs saved config).
Navigate to
System > Reboot
Check: "Warm Reboot"
When ready, press "OK" and the system will reboot with the restored configuration
Create Backup (CLI)
Connect to your NetScaler appliance over SSH with any tool you prefer. I use Putty.
Log in with your credentials. If you are an unexperienced user, please note that your password will not be visible while typing.
Use the following syntax for a full level backup:
create system backup BackupHere -level Full -Comment OptionalComment
- Replace "BackupName" with your backup name
- Replace "Full" with either Basic or leave it Full
- You can remove the optional -Comment switch if you dont want to add a comment. It's good practice to atleast add a date and firmware version.
If you want to see your current backups you can do so with the following command, mind you the 's' in backupS is optional ;).
show system backups
Restore Backup with CLI
Restoring with the CLI is very straightforward.
Use the following command:
restore system backup BackupName.tgz
now to actually restore the backup you need to do a warm reboot.reboot -warm
The backup will now be restored after the reboot.