- 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
Each NetScaler MAS release offers new and updated features with increased functionality. Citrix recommends you upgrade NetScaler MAS to the latest release to avail of the new features and bug fixes. A comprehensive list of enhancements, known issues, and bug fixes is included in the release notes accompanying every release announcement. It is also important to understand the licensing framework and types of licenses that can be used before you start to upgrade. For NetScaler MAS licensing information, see Licensing.
Download the upgrade package from the NetScaler MAS Downloads page and follow the instructions in this article to upgrade your system to the latest 12.1 build. After the upgrade operation is started, NetScaler MAS restarts and the existing connections are terminated and reconnected when the upgrade is completed successfully. The existing configuration is preserved, but NetScaler MAS does not process any data until the upgrade is successfully completed.
Points to note before upgrading to 12.1:
If you are upgrading to NetScaler MAS 12.1 build 48.18 version from either version 11.1 or from version 12.0 build earlier than 56.x, perform the following steps.
Upgrade from existing version to 12.0 build 57.24.
Then, upgrade to version 12.1 build 48.18.
You must follow this two-step process because there are certain clean-up procedures required to upgrade successfully to 12.1 release. These procedures are available only from 12.0 build 56.x onwards.
With 12.1, the high availability deployment has the ability to configure a floating IP address on the primary node and eliminate the need for a separate NetScaler load balancer. Because of this improvement, the high availability deployment must be on the same subnet. If your current deployment is on different subnets, you must review this article to learn about the upgrade process.
With 12.1, the advanced backup support has been removed. The advanced backup feature is no longer available after you upgrade to NetScaler MAS 12.1. Review this article for more details.
You cannot downgrade NetScaler MAS from a 12.1 build to any build of an earlier release.
Back up the NetScaler MAS server before you upgrade.
After the upgrade, you might have to reestablish connections between the NetScaler MAS server and the managed instances. A confirmation prompt warns you that connections can fail if you proceed.
For NetScaler MAS servers in high availability setup, when upgrading, do not make any configuration changes on either of the nodes.
- Do not refresh the browser until the upgrade process is successfully completed. It might take a few minutes for the upgrade process to finish.
- After upgrade, the active node can change in a high availability pair.
Upgrading single NetScaler MAS server
To upgrade single NetScaler MAS Server:
- In a web browser, type the IP address of the NetScaler MAS server.
Note: For NetScaler MAS servers in a high availability mode, type the IP address of either of the NetScaler MAS servers in the HA pair, or the load balancing virtual server.
In the User Name and Password fields, enter the administrator credentials.
Navigate to System > System Administrations. Under the System Administration sub-heading, click Upgrade NetScaler MAS.
On the Upgrade NetScaler MAS page, select the Clean software image on successful upgrade check box to delete image files after upgrade. Selecting this option removes the NetScaler MAS image files automatically upon upgrade.
This option is selected by default. If you do not select this check box before starting the upgrade process, you must manually delete the images.
You can then upload a new image file by selecting either Local (your local machine) or Appliance. The build file must be present on the NetScaler MAS virtual appliance.
Click OK. Upgrade process starts along with the following message.
Upgrading NetScaler MAS in high availability mode
For NetScaler MAS servers in a high availability mode, you can upgrade by either accessing the active node or the load balancing virtual server IP address. Both the NetScaler MAS servers are automatically upgraded to the latest build once you initiate the upgrade process in either of the servers.
Points to note while upgrading NetScaler MAS in a high availability mode
While upgrading NetScaler MAS in high availability mode to 12.1 from an earlier release, the high availability connection is established internally by the “join HA” script that runs on the secondary node. The time taken for the upgrade process is dependent on the network infrastructure, the data present in the database, and the speed of the link. It might take a few hours to reestablish the connection between the two nodes. During this period, the primary node does not receive any heartbeat from the secondary node. You see a notification for missing heartbeat on the primary UI until the upgrade process gets completed. After the upgrade process is over, the secondary node restarts and the high availability deployment is complete.
Note: To know the status of upgrade, log on to each node using SSH, run the following commands and check the output:
pgrep -lf installmas
pgrep -lf maintenance
pgrep -lf join_streaming_replication
pgrep -lf pg_basebackup
If any of these commands shows a running process on any of the nodes, then the upgrade is in progress and should not be interrupted. Do not restart NetScaler MAS during this time or do not try force failover on the secondary node.
After the upgrade process is complete, sometimes you might not be able to log on with the nsroot/nsroot or your user credentials. This is because the NetScaler MAS subsystem has not completely restarted or migration might still be in progress. Do not restart NetScaler MAS or do not attempt password recovery. This might have an undesired effect and the system might behave inconsistently. If required, you can try to log on using the nsrecover/<your_password_for_the_nsroot_user> credentials.
After the upgrade and before starting the operations, ensure that both the primary and the secondary nodes are upgraded and the reboot is complete.
Note: You cannot upgrade NetScaler MAS in high availability mode using the CLI.
Pooled licensing in NetScaler MAS servers in a high availability:
When NetScaler MAS servers are deployed in a high availability mode, the license file is attached to the primary node and configured (node-locked) with the hostID or the MAC address of the primary server. Pooled licenses feature is now supported by NetScaler MAS in high availability from 12.1 build onwards. To configure pooled licensing feature on both nodes, you must have identical license files on both nodes. To install an identical license on the secondary node, you must rehost the license to the hostID (MAC address) of the secondary node.
Consider a scenario where the NetScaler MAS has two server nodes S1 and S2 in high availability mode. The original license file, L1 is installed on server S1. The rehosted license file L2 should now be assigned to S2.
Follow the steps to upgrade NetScaler MAS in high availability mode from 12.0 to 12.1 and configure pooled license feature:
Log on to the primary node of the NetScaler MAS servers in high availability mode and perform the upgrade process.
Install the rehosted license file L2 on the secondary server node S2.
At this time:
- If S2 is the primary node, you can install the L2 license by accessing the GUI of that instance. - If S2 is the secondary node, you must manually perform a failover so that S2 now becomes the primary node. Install the license L2 on the new primary node by using the GUI. This is because you can access only the primary server in high availability through the GUI.
Configure the floating IP address on the new primary node.
Delete the license server IP addresses on the NetScaler instances and reconfigure them to use the floating IP address. Perform this on all NetScaler instances.
Citrix recommends that you perform NetScaler MAS high availability pooled licensing upgrade by creating a maintenance window on the NetScaler instances. This is because removing the license server and adding floating IP address causes the NetScaler instances to move back temporarily to the minimum bandwidth support.
High availability upgrade scenarios
There might be two scenarios in which the NetScaler MAS servers are deployed in high availability mode.
- The primary and secondary servers are deployed on the same subnet.
- The primary and the secondary servers are deployed in different subnets.
This upgrade document assists you in upgrading the NetScaler MAS in both these scenarios.
- Upgrading a high availability setup on the same subnet
- Upgrading a high availability setup in different subnets
Upgrading a high availability setup on the same subnet
Upgrading of NetScaler MAS servers deployed in high availability mode on the same subnet is handled automatically by NetScaler MAS 12.1.
To upgrade NetScaler MAS deployed in high availability mode on the same subnet:
Log on to the primary node and navigate to System > System Administrations.
Under System Administration, click Upgrade NetScaler MAS.
If there is an error during upgrade, the following error message is displayed. Follow the instructions as mentioned in the message on the primary server.
As part of the upgrade process, you must perform clean-up procedure through the CLI. During the clean-up process, the secondary node becomes the primary node. The old primary node cannot be accessed through its GUI. Do not restart the old primary node as well as the new primary node while the clean-up process is in progress. After the clean-up process is complete, continue the upgrade procedure through the new primary node.
After the upgrade process is complete, the two nodes must synchronize their databases. The time taken for complete synchronization and the new secondary node to come up depends on the data present in the databases.
After the upgrade is successful, you must configure the floating IP address using the NetScaler MAS user interface.
To configure floating IP address, navigate to System > Deployment > Configure Floating IP Address for High Availability Mode.
Specify the floating IP address as shown in the following image and click OK.
Upgrading a high availability setup in different subnets
Upgrading of NetScaler MAS servers deployed in high availability mode on different subnets must be handled by an administrator.
In this scenario, NetScaler MAS HA node 1 (primary) is in subnet 1, and NetScaler MAS HA node 2 (secondary) is in subnet 2.
To upgrade NetScaler MAS deployed in high availability mode on different subnets:
Manually break the high availability setup. For more information, see Disabling high availability.
Upgrade the NetScaler MAS standalone node 1. For more information on how to upgrade NetScaler MAS, see Upgrading NetScaler MAS.
Setup and register a new NetScaler MAS standalone node 3 in subnet 1.
After registering node 1 and node 3, deploy both these nodes in high availability mode. For details see, Deploying the primary and secondary node as a high availability pair.
Note: Configuring the floating IP address is mandatory.
Delete the NetScaler MAS node 2.
Removing support for the Advanced Backup and Restore feature of NetScaler MAS
Instead of using the advanced backup capability to take a complete backup of your NetScaler MAS server, you can now use the new Disaster Recovery feature made available in NetScaler MAS version 12.1 to take a complete backup of your NetScaler MAS high availability setup and help with business continuity use cases.
- The advanced backup feature is no longer available after you upgrade to NetScaler MAS 12.1. To remove the advanced backup feature, and to continue backing up using the Disaster Recovery feature, see Back up your NetScaler MAS after upgrading to NetScaler MAS 12.1. Disaster Recovery is supported only with NetScaler MAS HA.
- To continue to take a partial backup of the NetScaler MAS server that includes the configuration files, instance details, system data, and so on and then, to restore your NetScaler MAS server in a standalone deployment (partial backup), see How to back up and restore your NetScaler MAS server in a single-server deployment.
In case of a disaster on the primary server, use the Disaster Recovery feature to start and configure NetScaler MAS on the same primary server without losing data. The feature is only available on NetScaler MAS servers deployed in a high availability setup from NetScaler MAS version 12.1.
Back up your NetScaler MAS server after upgrading to NetScaler MAS 12.1
To continue to back up your NetScaler MAS server Citrix recommends the following:
Delete your remote backup settings on NetScaler MAS by doing the following:
Navigate to System > System Administration > Advanced System Backup Settings.
In the Configure Advanced Backup Settings page, select No to disable remote backups.
Click Apply Settings. Please wait for your NetScaler MAS server to reboot and apply the changed settings.
Delete your remote backup node.
Deploy and configure a new NetScaler MAS server, create a high availability setup with the existing NetScaler MAS server that was rebooted in the step above.
Configure Disaster Recovery to continue to backup and restore data. For more information about Disaster Recovery, see Configure disaster recovery for high availability.
To add an additional disk to the NetScaler MAS server
If your NetScaler MAS storage requirement exceeds the default disk space (120 gigabytes), you can attach an additional disk. You can attach additional disk in both single-server and high availability deployments.
When you upgrade NetScaler MAS from release version 12.0 to 12.1, the partitions that you had created on the additional disk in the earlier version remain the same. The partitions are not removed nor are they resized.
The procedure to attach additional disk remains the same in the upgraded build. You can now use the new NetScaler disk partitioning tool to create partitions in the newly added disk. You can also use tool to resize the partitions in the existing additional disk. For more information on how to attach additional disks and to use the new disk partitioning tool, see How to attach an additional disk to NetScaler MAS.