- 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
Configure disaster recovery for high availability
Disaster is a sudden disruption of business functions caused by natural calamities or human caused events. Disasters affect data center operations, after which resources and the data lost at the disaster site must be fully rebuilt and restored. The loss of data or downtime in the data center is critical and collapses the business continuity.
The NetScaler MAS 12.1 disaster recovery (DR) feature provides full system backup and recovery capabilities for NetScaler MAS deployed in high availability mode. At the time of recovery, certificates, configuration files, and a complete backup of the database is available in the recovery site.
The following table describes the terms used while configuring disaster recovery in NetScaler MAS.
|Primary site (Data center A)||The primary site has NetScaler MAS nodes deployed in high availability mode.|
|Recovery site (Data center B)||The recovery site has a disaster recovery node deployed in standalone mode. This node is in read-only mode and is not operational until the primary site is down.|
|Disaster recovery node||The recovery node is a standalone node deployed in the recovery site. This node is made operational (to the new primary) in case a disaster hits the primary site and it is non-functional.|
The following image shows the disaster recovery workflow, the initial setup before disaster, and the workflow after the disaster.
Initial setup before disaster
The image above shows the disaster recovery setup before disaster.
The primary site has NetScaler MAS nodes deployed in the high availability mode. To learn more, see High availability deployment
The recovery site has a standalone NetScaler MAS disaster recovery node deployed remotely. The disaster recovery node is in read-only mode and receives data from the primary node to create data backup. NetScaler instances in the recovery site are also discovered but, they do not have any traffic flowing through them. During the backup process, all data, files, and configurations are replicated on the disaster recovery node from the primary node.
Before you set up the disaster recovery node, note the following the prerequisites:
- To enable disaster recovery settings, the primary site must have NetScaler MAS nodes configured in high availability mode.
- The standalone deployment of NetScaler MAS in the primary site does not support the disaster recovery feature.
Citrix recommends that you set CPU priority (in virtual machine properties) at the highest level to improve scheduling behaviour and network latency.
The following table lists the minimum requirements for the virtual computing resources:
|Note: The default value is 8 GB. Citrix recommends that you increase the default value to 32 GB for better performance.|
|Virtual CPU||8 CPUs|
|Note: The default is 2 CPUs. Citrix recommends that you increase the default value to 8 CPUs for better performance.|
|Storage Space||Citrix recommends using solid-state drive (SSD) technology for NetScaler MAS deployments.The default value is 120 GB. Actual storage requirement depends on NetScaler MAS sizing estimation.If your NetScaler MAS storage requirement exceeds 120 GB, you have to attach an additional disk. Note: You can add only one additional disk.Citrix recommends you to estimate storage and attach additional disk at the time of initial deployment.For more information, see How to Attach an Additional Disk to NetScaler MAS.|
|Virtual network interfaces||1|
|Throughput||1 Gbps or 100 Mbps|
|Citrix XenServer||6.2 and 6.5|
|VMware ESXi||5.5 and 6.0|
|Microsoft Hyper-V||2012 R2|
|Linux KVM||Ubuntu and Fedora|
Deploying NetScaler MAS in high availability mode
- Registering and deploying the NetScaler MAS disaster recovery node
- Enabling and disabling disaster recovery settings from the user interface
Deploying NetScaler MAS in high availability mode
To set up disaster recovery settings, ensure that NetScaler MAS is deployed in high availability mode. For information on deploying the NetScaler MAS in high availability, see High availability deployment
- NetScaler MAS deployed in high availability mode must be upgraded to NetScaler MAS release version 12.1.
- Floating IP address is mandatory to register disaster recovery node with the primary node.
Registering and deploying the NetScaler MAS disaster recovery node
To register the NetScaler MAS disaster recovery node:
Download the .xva image file from the Citrix download site and import it into your hypervisor.
From the Console tab, configure NetScaler MAS with the initial network configurations as shown in the following image.
The disaster recovery node can be on a different subnet.
After the initial network configuration is completed, the system prompts for login. Log on using the following credentials – nsrecover/nsroot.
To deploy the disaster recovery node, type /mps/deployment_type.py and press enter. The NetScaler MAS deployment configuration menu is displayed as shown in the following image.
Select 2 to register disaster recovery node.
The console prompts for floating IP address of the high availability node and password. Enter the floating IP address and password.
Enter the floating IP address and password to register the disaster recovery node to the primary node.
The disaster recovery node is now registered successfully.
Enabling disaster recovery settings from the NetScaler MAS GUI
After the disaster recovery node is registered successfully, you can enable the disaster recovery settings from the NetScaler MAS primary site user interface.
Navigate to System > System Administration > Disaster Recovery Settings.
On the Configure Disaster Recovery Settings page, select Enable Disaster Recovery check box, and click Apply Settings.
A confirmation dialogue box is displayed. Click Yes to continue.
The time taken for system backup depends on the data size and the WAN (Wide Area Network) link speed.
To disable the disaster recovery settings, clear the Enable Disaster Recoverycheck box and click Apply Settings.
A confirmation dialogue box is displayed. Click Yesto continue.
- It is the responsibility of the administrator to detect that a disaster has occurred on the primary site.
- The disaster recovery workflow is not automated and is manually initiated by the administrator after the primary site goes down.
- An administrator must manually initiate the process by executing a recovery script on the disaster recovery node at the recovery site.
When the primary site goes down after a disaster, the disaster recovery workflow must be initiated as follows:
The administrator identifies that a disaster has struck the primary site and it is not operational.
It is the responsibility of the administrator to detect that a disaster has occurred on the primary site.
The recovery process is initiated by the administrator.
The administrator must manually execute the following recovery script on the disaster recovery node (at the recovery site): /mps/scripts/pgsql/pgsql_restore_remote_backup.sh
Internally, NetScaler instances are automatically reconfigured to send the data to the disaster recovery node that has now become the new primary site.
The following image shows that the disaster recovery workflow after the primary site is struck with a disaster.
After the disaster has occurred and the recovery process is complete, you will be given time of 30 days to get your original licenses from Citrix.
Ensure that you contact Citrix to update your instances to their original licenses. If you fail to contact Citrix within 30 days, your original licenses expire and a new license will be required.