Perform an appliance reset
The NetScaler SDX appliance allows you to:
- Reset the configuration of the appliance.
Note:
When you reset the configuration, you must log on using the appliance serial number as the password.
- Reset the appliance to factory version.
- Reset the appliance to a particular Single Bundle Image version.
Before performing an appliance reset, back up all the data stored on the appliance, including the settings of all the NetScaler instances provisioned on the appliance.
Citrix recommends that you store the files outside the appliance. Performing an appliance reset terminates all current client sessions with the Management Service. Log back on to the Management Service for any additional configuration tasks. When you are ready to restore the data, import the backup files by using the Management Service.
The Management Service provides the following options to reset the Appliance:
- Config Reset
- Factory Reset
- Clean Install
Reset the configuration of the appliance
The Management Service provides the Config Reset option to reset the configuration of the Appliance. The Config Reset option performs the following:
- Deletes VPX instances.
- Deletes SSL certificate and key files.
- Deletes license and technical archive files.
- Deletes the NTP configuration on the appliance.
- Restores the time zone to UTC.
- Restores prune and backup policies to their default settings.
- Deletes the Management Service image.
- Deletes the NetScaler SDX image.
- Deletes all XVA images except the last image file that was accessed on the appliance.
- Restores default interface settings.
- Restores the default configuration of the appliance, including default profiles, users, and system settings.
- Restores default passwords for Citrix Hypervisor and the Management Service.
- Restarts the Management Service.
Reset the configuration of the appliance
- Navigate to Configuration > System > System Administration group.
- Click Appliance Reset.
- In the Appliance Reset dialog box, select Config Reset in the Reset Type list.
- Click OK.
Reset the appliance to factory version
The Management Service provides the Factory Reset option to reset the appliance to the factory version. The Factory Reset option resets the current IP addresses of the Management Service and Citrix Hypervisor to the default IP addresses of the Management Service and Citrix Hypervisor.
Ensure that you back up all the data stored on the appliance, including the settings of all the NetScaler instances provisioned on the appliance. Citrix recommends that you store the files outside the appliance. Performing a factory reset terminates all current client sessions with the Management Service. Log back on to the Management Service for any additional configuration tasks. When you are ready to restore the data, import the backup files by using the Management Service.
Important
Make sure you connect a serial console cable to the appliance before performing a factory reset.
Reset the appliance to the factory version
- Navigate to Configuration > System > System Administration.
- Click Appliance Reset.
- In the Appliance Reset dialog box, select Factory Reset in the Reset Type list.
- Click OK.
Reset the appliance to a single bundle image version
The Management Service provides the Clean Install option that allows you to install an arbitrary version of a single bundle image on the appliance. It enables you to perform a fresh install of the single bundle image as the new default boot image. Clean installation removes the existing configuration, except network settings, in the SDX appliance.
Note:
If your SDX appliance was shipped with software version 11.0 or earlier, clean install to version 13.1 or later fails.
The clean-install option is supported on the following:
| Single Bundle Image Version | SDX Platforms |
|---|---|
| 11.0.xx | SDX 14xxx, SDX 25xxx. Note: The clean-install option is supported on other SDX platforms if they have a 10G factory partition. |
| 11.1.xx | SDX 14xxx, SDX 25xxx. Note: The clean-install option is supported on other SDX platforms if they have 10G factory partition |
| 11.1.51.x | All the SDX platforms. |
| 12.1.xx | All the SDX platforms. |
| 13.0.xx | All the SDX platforms. |
| 13.1.xx | All the SDX platforms. |
Prerequisites
Make sure that:
- You fail over all the primary high availability nodes to a different SDX appliance. If you do not have high availability capabilities, make sure that you plan for the downtime accordingly.
- Download the single bundle image to your local machine.
Important:
Make sure that you do not restart or power cycle the appliance while using the Clean Install option. The appliance is restarted multiple times.
Reset the appliance to a single bundle image version
- Navigate to Configuration > System > System Administration group.
- Click Appliance Reset.
- In the Appliance Reset dialog box, select Clean Install in the Reset Type list.
- Click OK.