- Release notes
- All how to articles
- System requirements
- Get started
- NetScaler MAS with Citrix XenServer
- NetScaler MAS with Microsoft Hyper-V
- NetScaler MAS with VMware ESXi
- NetScaler MAS with Linux KVM server
- Configure high availability deployment
- Configure disaster recovery for high availability
- Configure on-prem agents for multisite deployment
- Migrate from NetScaler Insight Center to NetScaler MAS
- Migrate Command Center configurations to NetScaler MAS
- Integrate NetScaler MAS with Citrix XenDesktop Director
- Attach an additional disk to NetScaler MAS
- Access control
- StyleBook groups
- Use default StyleBooks
- Business application StyleBooks
Create and use custom StyleBooks
- StyleBook to create a load balancing virtual server
- StyleBook to create a basic load balancing configuration
- Create a composite StyleBook
- Use GUI attributes in a custom StyleBook
- Use custom StyleBooks
- Create a StyleBook to upload files to NetScaler MAS
- Create a StyleBook to upload SSL certificate and certificate key files to NetScaler MAS
- Enable analytics and configure alarms on a virtual server defined in a StyleBook
- Create a Stylebook to perform non-CRUD operations
- Use API to create configurations from StyleBooks
- Import StyleBooks
- Parameters-default-sources construct
- Helper components
- Optional properties
- Properties-default-sources construct
- Nested components
- Condition construct
- Repeat construct
- Repeat-condition construct
- Nested repeats
- Parameter reference
- Parent reference
- Components reference
- Substitutions reference
- Variable reference
- In-place interpolations
- Built-in functions
- Dependency detection
- Monitor globally distributed sites
- Manage admin partitions of NetScaler instances
- Back up and restore NetScaler instances
- Force a failover to the secondary NetScaler instance
- Force a secondary NetScaler instance to stay secondary
- Create instance groups
- Rediscover multiple NetScaler VPX instances
- Poll NetScaler instances and entities
- Unmanage an instance
- Trace the route to an instance
- Use events dashboard
- Set event age for events
- Schedule an event filter
- Set repeated email notifications for events
- Suppress events
- Create event rules
- Modify the reported severity of events that occur on NetScaler instances
- View events summary
- Display event severities and SNMP trap details
- Export syslog messages
- Suppress syslog messages
- Configure prune settings for instance events
- Use the SSL dashboard
- Set up notifications for SSL certificate expiry
- Update an installed certificate
- Install SSL certificates on a NetScaler instance
- Create a Certificate Signing Request (CSR)
- Link and unlink SSL certificates
- Configure an enterprise policy
- Poll SSL certificates from NetScaler instances
- Create a configuration job
- Use record-and-play to create configuration jobs
- Use configuration jobs to replicate configuration from one instance to multiple instances
- Use variables in configuration jobs
- Create configuration jobs from corrective commands
- Replicate running and saved configuration from one NetScaler instance to another
- Reuse executed configuration jobs
- Schedule jobs created by using built in templates
- Use maintenance jobs to upgrade NetScaler SDX instances
- Create configuration jobs for NetScaler SD-WAN WO instances
- Use the master configuration template
- Use jobs to upgrade NetScaler instances
- Use configuration templates to create audit templates
- Use SCP (put) command in configuration jobs
- Reschedule jobs configured by using built in templates
- Reuse configuration audit templates in configuration jobs
- Import and export configuration templates
- Maintenance jobs
- Configuration audit
- Network functions
- Network reporting
- Instance management
- License requirements
- Logstream overview
- Web Insight
- HDX Insight
- Gateway Insight
- Security Insight
- SSL Insight
- TCP Insight
- WAN Insight
- View network efficiency
- Compare the data volume used by optimized and unoptimized ABR videos
- View the type of videos streamed and data volume consumed from your network
- Compare optimized and unoptimized play time of ABR videos
- Compare bandwidth consumption of optimized and unoptimized ABR videos
- Compare optimized and unoptimized number of plays of ABR videos
- View peak data rate for a specific time frame
- Secure Web Gateway Analytics
OpenStack - integrating NetScaler instances
- Service package isolation policies
- Manual provisioning of NetScaler VPX instance on OpenStack
- Configure layer 7 content switching
- Configure LBaaS V1 using Horizon
- Configure LBaaS V2 using command line
- Shared VLAN support for admin partitions
- Pre-configuration tasks in NetScaler MAS and OpenStack
- Trial licensing workflow
- Integrate with OpenStack Heat services
- Flexible policy-based device allotment
- NSX Manager - manual provisioning of NetScaler instances
- NSX Manager - auto provisioning of NetScaler instances
- NetScaler automation using NetScaler MAS in Cisco ACI hybrid mode
- NetScaler device package in Cisco ACI's cloud orchestrator mode
- OpenStack - integrating NetScaler instances
NetScaler pooled capacity
- Configure NetScaler pooled capacity
- Upgrade a perpetual license in NetScaler VPX to NetScaler pooled capacity
- Upgrading a Perpetual License in NetScaler MPX to NetScaler Pooled Capacity
- Upgrade a perpetual license in NetScaler SDX to NetScaler pooled capacity
- NetScaler pooled capacity on NetScaler instances in cluster mode
- Health monitoring
- Expected behaviors when issues arise
- Configure expiry checks for pooled capacity licenses
- NetScaler VPX check-in and check-out licensing
- NetScaler virtual CPU licensing
- NetScaler pooled capacity
- Manage NetScaler SD-WAN instances
Manage HAProxy instances
- Add HAProxy instances to NetScaler MAS
- HAProxy app dashboard
- Third-party licensing
- Role-based access control for HAProxy instances
- Monitor HAProxy instances
- View the details of frontends configured on HAProxy instances
- View the details of backends configured on HAProxy instances
- View the details of servers configured on HAProxy instances
- View the HAProxy Instances with the highest number of frontends or servers
- Restart an HAProxy instance
- Back up and restore an HAProxy instance
- Edit the HAProxy configuration file
Manage system settings
- Configure system backup settings
- Configure a NTP Server
- Upgrade NetScaler MAS
- Configure syslog purging interval
- Configure system prune settings
- Enable shell access for non-default users
- Recover inaccessible NetScaler MAS servers
- Assign a host name to a NetScaler MAS server
- Back up and restore your NetScaler MAS server in a single-server deployment
- View auditing information
- Configure SSL settings
- Monitor CPU, memory, and disk usage
- Configure system notification settings
- Generate a tech support file
- Diagnose and troubleshoot NetScaler instances
- Back Up and restore a NetScaler MAS configuration in an HA pair
- Configure a cipher group
- Create SNMP traps, managers, and users
- Configure and view system alarms
- NetScaler MAS as an API proxy server
Back up and restore NetScaler instances
You can back up the current state of a NetScaler instance and later use the backed-up files to restore the NetScaler instance to the same state. You must always back up an instance before you upgrade it or for just precautionary reasons. A backup of a stable system enables you to restore it back to a stable point if it becomes unstable. There are multiple ways to perform backups and restores on a NetScaler instance. You can manually backup and restore NetScaler configurations using the GUI, CLI, or you can use NetScaler MAS to perform automatic backups and manual restores. NetScaler MAS backs up the current state of your managed NetScaler instances by using NITRO calls and the Secure Shell (SSH) and Secure Copy (SCP) protocols.
NetScaler MAS backs up and restores the following types of NetScaler instances:
For a NetScaler VPX instance, NetScaler MAS backs up the files depending on the type of data to be backed up. You can create either a basic backup or a full backup.
You cannot perform the backup and restore operation on a NetScaler cluster.
Basic backup: In this type, only configuration files are backed up as these are the files that change regularly. The following table lists the files that are backed up in the respective folders. Note that if a folder name is followed by a “*,” all files in that folder are backed up.
Full backup: In this type, in addition to the files that are backed up by a basic backup, some less frequently updated files are also backed up. The following table lists the files that are backed up when using the full backup option:
The backed up files are 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 save 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.
- You cannot use the backup file taken from one instance to restore a different instance.
- You can back up and restore instances in an HA setup. But ensure to restore the same instance from which the backup file was created. For example, if the backup was taken from the primary instance of the HA pair when restoring ensure you are restoring the same instance, even if it is no longer the primary instance.
To back up and restore NetScaler instances, you must first configure the backup settings on NetScaler MAS. After configuring the settings, you can select a single NetScaler instance or multiple instances and create back up of the configuration files in these instances. If required you can also restore the NetScaler instances by using these backed up files.
- Configuring Instance Backup Settings
- Creating a Back Up for a Selected NetScaler Instance
- Restoring a NetScaler Instance
The Instance Backup Settings page allows you to configure settings on NetScaler MAS to back up a selected NetScaler instance or multiple instances:
In NetScaler MAS, navigate to System > System Administration. In the right-hand pane, under Instance Settings, select Instance Backup Settings, and specify the following:
Enable Instance Backups: By default, NetScaler MAS is enabled for taking backups of NetScaler instances. Clear this option if you do not want to create backup files for the instances.
Password Protect File: (optional) Select password protect option to encrypt the backup file. Encrypting the backup file ensures that all the sensitive information inside the backup file is secure.
Note: You can download the encrypted backup file to your local machine, but you cannot open the file either with NetScaler MAS GUI or with any text editor. The file can be retrieved and used by NetScaler MAS alone. You are prompted to provide the password when restoring the encrypted backup file. You can, however, open an unencrypted backup file on your system.
Number of Backup Files to retain: Specify the number of backup files to retain in NetScaler MAS. You can retain up to 50 backup files of the current state of a NetScaler instance. The default is three backup files.
Each backup file accounts for some storage requirement. Citrix recommends that you store an optimal number of NetScaler backup files on NetScaler MAS as per your requirement.
Backup Scheduling Settings: (optional) There are two options available for creating backup files, though you can use only one option at a time:
The default backup scheduling option is “interval-based.” A backup file is created in NetScaler MAS after the specified interval elapses. The default backup interval is 12 hours.
You can also change the type of scheduled backups to “time-based.” In this option you specify the time in “hours:minutes” format at which the backup should happen. NetScaler MAS allows a maximum of four daily backups to happen on the instances.
NetScaler Settings: (optional) By default, NetScaler MAS does not create a backup file when it receives the “NetScalerConfigSave” trap. But, you can enable the option to create a new backup file whenever a NetScaler instance sends a “NetScalerConfigSave” trap to NetScaler MAS. A NetScaler instance sends “NetScalerConfigSave” every time the configuration on the instance is saved.
Geodatabase files: (optional) By default, NetScaler MAS does not back up the GeoDatabase files. You can enable the option to create a backup of these files also.
External Transfer:(optional) NetScaler MAS allows you to transfer the NetScaler instance backup files to an external location:
Specify the IP address of the location.
Specify the username and the password of the external server to which you want to transfer the backup files.
Specify the transfer protocol and the port number.
You can specify the directory path where the file will be stored.
You also have the option to delete the backup file from NetScaler MAS after transferring it to the external server.
NetScaler MAS sends an SNMP trap or a Syslog notification to itself when there is a backup failure for any of the selected NetScaler instances.
Creating a Back Up for a Selected NetScaler Instance by Using NetScaler MAS
Perform this task if you want to back up a selected NetScaler instance or multiple instances:
In NetScaler MAS, navigate to Networks > Instances. Under Instances, select the type of instances (for example, NetScaler VPX) to display on the screen.
Select the instance that you want to back up, and then click Backup/Restore.
On the Backup Files page, click Back Up.
You can specify whether to encrypt your backup file for additional security. You can either enter your password or use the global password that you previously specified on the Instance Backup Settings page.
Restoring a NetScaler Instance by Using NetScaler MAS
Perform this task to restore a NetScaler instance by using the backup file that you had created earlier:
Navigate to Networks > Instances, select the instance that you want to restore, and then click View Backup.
On the Backup Files page, select the backup file containing the settings that you want to restore, and then click Restore.
- For a NetScaler SDX appliance, NetScaler MAS backs up only the following:
- NetScaler instances hosted on the appliance
- SVM SSL certificates and keys
- Instance prune settings (in XML format)
- Instance backup settings (in XML format)
- SSL certificate poll settings (in XML format)
- SVM db file
- NetScaler config files of devices present on SDX
- NetScaler build images
- NetScaler XVA images
- SDX Single Bundle Image (SVM+XS)
- Third Party instance images (if provisioned)
You must restore your NetScaler SDX appliance to the configuration available in the backup file. During appliance restore, the entire current configuration is deleted.
If you are restoring the NetScaler SDX appliance by using a backup of a different NetScaler SDX appliance, make sure that you add the licenses and configure the appliance’s Management Service network settings to match those in the backup file before you start the restore process.
Make sure that the NetScaler SDX platform variant that was backed up was taken is same as the one on which you are trying to restore. You cannot restore from a different platform variant.