- Release Notes
- How-to Articles
About NetScaler MAS
- Features and solutions
- How NetScaler MAS discovers instances
- How NetScaler MAS communicates with managed instances
- NetScaler MAS Licensing
- Getting Started with NetScaler MAS
- System Requirements
Deploying NetScaler MAS
- NetScaler MAS with Citrix XenServer
- NetScaler MAS with Microsoft Hyper-V
- NetScaler MAS with VMware ESXi
- NetScaler MAS with Linux KVM server
- Deploy NetScaler MAS in high availability mode
- Migrate a single-server deployment to a high availability 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
- Setting up NetScaler MAS
- Upgrading NetScaler MAS
- Managing NetScaler SD-WAN instances
Managing and Monitoring HAProxy instances
- Adding HAProxy instances to NetScaler MAS
- HAProxy Applications in Application Dashboard
- Third-party licensing
- Role Based Access Control in NetScaler MAS for HAProxy Instances
- How to Use the NetScaler MAS Dashboard to Monitor an HAProxy Instance
- How to Display the Details of the Frontends Configured on HAProxy Instances
- How to Display the Details of the Backends Configured on HAProxy Instances
- How to Display the Details of the Servers Configured on HAProxy Instances
- How to Use the Application Dashboard to View the HAProxy Instances That Have the Highest Number of Frontends or Servers
- How to Restart an HAProxy Instance From NetScaler MAS
- How to Back Up and Restore an HAProxy Instance by Using NetScaler MAS
- How to Edit the HAProxy Configuration File by Using NetScaler MAS
Application Analytics and Management
- Application Performance Analytics
- Application Security Analytics
- How to create an application definition in NetScaler MAS
- How to Enable or Disable Entities in NetScaler MAS
- How to Disable Entities in NetScaler MAS
- How to View the Effective State of a Virtual Server on NetScaler MAS
- How to Search for Entities in NetScaler MAS
- StyleBook groups
- Use default StyleBooks
- How to Create Your Own StyleBooks
- How to Use User-Defined StyleBooks in NetScaler MAS
- Use API to create configurations from StyleBooks
- Retrieve private StyleBooks
- Enable analytics and configure alarms on a virtual server defined in a StyleBook
- Create a StyleBook to upload files
- Create a StyleBook to upload SSL certificate and certificate key files
- SSO Google Apps StyleBook
- Microsoft Skype for Business StyleBook
- Microsoft Exchange StyleBook
- Microsoft SharePoint StyleBook
- How to use the SSO Office 365 StyleBook
- 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
- How to Monitor Globally Distributed Sites
- How to Manage Admin Partitions of NetScaler Instances
- How to Add Instances to NetScaler MAS
- How to Back Up and Restore NetScaler Instances Using NetScaler MAS
- How to Configure Sites for Geomaps in NetScaler MAS
- How to Force a Failover to the Secondary NetScaler Instance by Using NetScaler MAS
- How to Force a Secondary NetScaler Instance to Stay Secondary by Using NetScaler MAS
- How to Create Instance Groups on NetScaler MAS
- How to Rediscover Multiple NetScaler VPX Instances
- How to Poll NetScaler Instances and Entities in NetScaler MAS
- How to Unmanage an Instance on NetScaler MAS
- How to Trace the Route to an Instance from NetScaler MAS
- How to Set Event Age for Events on NetScaler MAS
- How to Schedule an Event Filter by Using NetScaler MAS
- How to Set Repeated Email Notifications for Events from NetScaler MAS
- How to Suppress Events by Using NetScaler MAS
- How to Use the Events Dashboard to Monitor Events
- Creating Event Rules
- How to Modify the Reported Severity of Events that Occur on NetScaler Instances
- How to View Events Summary in NetScaler MAS
- How to Display Event Severities and SNMP Traps Details on NetScaler MAS
- Using NetScaler MAS to Export Syslog Messages
- How to Suppress Syslog Messages in NetScaler MAS
- How to Configure Prune Settings for Instance Events
NetScaler Certificate Management
- How to Set Up Notifications for SSL Certificate Expiry from NetScaler MAS
- How to Install SSL Certificates on a NetScaler Instance
- How to Update an Installed Certificate from NetScaler MAS
- How to Link and Unlink SSL Certificates by Using NetScaler MAS
- How to Create a Certificate Signing Request (CSR) using NetScaler MAS
- How to Configure an Enterprise Policy on NetScaler MAS
- How to Use the SSL Dashboard on NetScaler MAS
- How to Poll SSL Certificates from NetScaler Instances
- How to Create a Configuration Job on NetScaler MAS
- How to Use Record-and-Play to Create Configuration Jobs
- How to Use Configuration Jobs to Replicate Configuration from One Instance to Multiple Instances
- How to Use Variables in Configuration Jobs on NetScaler MAS
- How to Create Configuration Jobs from Corrective Commands on NetScaler MAS
- How to Use Configuration Templates to Create Audit Templates on NetScaler MAS
- How to Create Configuration Jobs for SD-WAN WO Instances in NetScaler MAS
- How to Use the Master Configuration Template on NetScaler MAS
- How to Replicate Running and Saved Configuration Commands from One NetScaler Instance to Another on NetScaler MAS
- How to Upgrade NetScaler SDX Instances by Using NetScaler MAS
- How to Schedule Jobs Created by Using Built-in Templates in NetScaler MAS
- How to Reschedule Jobs That Were Configured by Using Built-in Templates in NetScaler MAS
- How to Reuse Executed Configuration Jobs
- How to Upgrade NetScaler Instances
- How to Use SCP (put) Command in Configuration Jobs
- How to Reuse Configuration Audit Templates in Configuration Jobs
- Creating Maintenance Tasks
- How to Import and Export Configuration Templates
- Configuration Audit
- Network Functions
- Network Reporting
- License requirements
- Understanding Logstream
- Web Insight
- HDX Insight
- Gateway Insight
- Security Insight
- SSL Insight
- TCP Insight
- WAN Insight
- Viewing the Type of Videos Streamed and the Data Volume Consumed from your Network
- Viewing the Peak Data Rate for a Particular Time Frame
- Comparing the Optimized and Un-Optimized Number of Plays of ABR Videos
- Compare the Optimized and Unoptimized Play Time of ABR Videos
- Comparing Bandwidth Consumption of Optimized and Un-Optimized ABR Videos
- Comparing the Data Volume Used by Optimized and Unoptimized ABR Videos
- Viewing the Network Efficiency
- Secure Web Gateway Analytics
Integrating NetScaler MAS with OpenStack Platform
- Pre-configuration tasks in NetScaler MAS and OpenStack
- Configure LBaaS V1 using Horizon
- Configure LBaaS V2 using command line
- Configure layer 7 content switching
- Manual provisioning of NetScaler VPX instance on OpenStack
- Shared VLAN support for admin partitions
- Trial licensing workflow
- Integrate with OpenStack Heat services
- Service package isolation policies
- Flexible policy-based device allotment
- Integrating NetScaler MAS with NSX Manager by Manual Provisioning
- Integrating NetScaler MAS with NSX Manager by Auto-provisioning
- NetScaler automation using NetScaler MAS in Cisco ACI hybrid mode
- NetScaler device package in Cisco ACI's cloud orchestrator mode
- Use NetScaler MAS as an Ingress Controller for the Kubernetes Environment
Authentication and Access Control
- Role-based Access Control in NetScaler MAS
- Configuring Authentication in NetScaler MAS
- Multi-Tenancy - Provide Exclusive Management Environment to Your Tenants
Managing NetScaler MAS 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
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
How NetScaler MAS Discovers Instances
Instances are Citrix appliances or virtual appliances that you want to discover, manage, and monitor from NetScaler MAS. You must add instances to the NetScaler MAS server if you want to manage and monitor these instances. You can add the following Citrix appliances and virtual appliances to NetScaler MAS:
NetScaler SD-WAN WO
NetScaler SD-WAN SE/EE
You can add instances either while setting up the NetScaler MAS server for the first time or at a later time.
NetScaler MAS uses the NetScaler IP (NSIP) address of the NetScaler instances for communication. NetScaler MAS can also discover NetScaler instances with subnet IP (SNIP) address that has management access enabled on it. For information about the ports that must be open between the NetScaler instances and NetScaler MAS, see Ports.
For NetScaler SD-WAN WO, NetScaler MAS uses the mangament IP address of the instances for communication.
You cannot add NetScaler SD-WAN SE / EE instances in NetScaler MAS. You can configure NetScaler MAS as an AppFlow collector on the NetScaler SD-WAN SE/EE appliances,
When you add an instance to the NetScaler MAS server, the server implicitly adds itself as a trap destination for the instance and collects inventory of the instance.
The following diagram describes how NetScaler MAS implicitly discovers and adds instances.
As shown in the diagram, the following steps are performed implicitly by NetScaler MAS.
The NetScaler MAS server uses the instance profile details to log on to the instance. Using a NetScaler NITRO call, NetScaler MAS retrieves the license information of the instance. On the basis of the licensing information, it determines whether the instance is a NetScaler instance and the type of NetScaler platform (for example, NetScaler MPX, NetScaler VPX, NetScaler SDX, or NetScaler Gateway). On succesful detection of the NetScaler instance, it is added to the NetScaler MAS server’s database.
For NetScaler SD-WAN WO instances, NetScaler MAS does not detect the instance by using licensing information. It sends a NITRO request to the instance to check for the instance type and version.
This step might fail if the instance profile does not include the correct credentials. For NetScaler MPX, NetScaler VPX, NetScaler SDX, and NetScaler Gateway instances, this step might also fail if the licenses are not applied to the instance.
In HTTP, you can add NetScaler instances to the NetScaler MAS even if licenses are not configured on the instances.
NetScaler MAS adds its IP address to the list of trap destinations on the instance.This allows the NetScaler MAS server to receive traps generated on the NetScaler instance.
This step might fail if the number of trap destinations on the NetScaler instance exceeds the maximum limit of trap destinations. The maximum limit on NetScaler instances is 20.
For NetScaler SD-WAN WO instances, NetScaler MAS adds its IP address as the SNMP manager on the instance.
NetScaler MAS collects inventory from the instance by sending a NITRO request. It collects instance details such as host name, software version, running and saved configuration, certificate details, entities configured on the instance, and so on.
This step might fail because of network or firewall issues.
You can add instances either while setting up the NetScaler MAS server for the first time or at a later time.
To add instances, you must specify either the host name or IP address of each NetScaler instance, or a range of IP addresses.
For SD-WAN WO instances, specify the IP address of each instance, or a range of IP addresses.
You must then specify an instance profile that NetScaler MAS can use to access the instance.
This instance profile contains the user name and password of the instance(s) that you want to add to NetScaler MAS. For each instance type, a default profile is available. For example, the ns-root-profile is the default profile for NetScaler instances. This profile is defined by the default NetScaler administrator credentials. If you have changed the default admin credentials of your instances, you can define custom instance profiles for those instances. If you change the credentials of an instance after the instance is discovered, you must edit the instance profile or create a new profile, and then rediscover the instance.
- To add NetScaler instances configured in a cluster, you must specify either the cluster IP address or any one of the individual nodes in the cluster setup. However, on NetScaler MAS, the cluster is represented by the cluster IP address only.
- For NetScaler instances set up as an HA pair, when you add one instance, the other instance in the pair is automatically added.
If two NetScaler MAS servers are set up in high availability mode, when an instance is added, load balancing comes into effect and the instances are distributed across the two NetScaler MAS server nodes by using the round-robin method.
To add an instance to NetScaler MAS:
In a web browser, type the IP address of the NetScaler Management and Analytics System (for example,
In the User Name and Password fields, enter the administrator credentials. The default administrator credentials are nsroot/nsroot.
Navigate to Networks > Dashboard and click All Instances. On the Instances page, click New at the top right corner of the page. On the Add Instance page, from Instance Type, select the type of instance you want to add, and then follow the instructions in step 4.
Alternatively, navigate to Networks > Instances. Under Instances, select the type of instance you want to add (for example, NetScaler VPX) and click Add.
Select one of the following options:
Enter Device IP address - For NetScaler instances, specify either the host name or IP address of each instance, or a range of IP addresses. For SD-WAN WO instances, specify the IP address of each instance, or a range of IP addresses.
Import from file - From your local system, upload a text file that contains the IP addresses of all the instances you want to add.
From Profile Name, select the appropriate instance profile, or create a new profile by clicking the + icon.
For NetScaler CPX instances, you must specify the HTTP, HTTPS, SSH, and SNMP port details of the host. You can also specify the range of ports that were published by the host in the Start Port and Number of ports field. Also, if your NetScaler CPX IP address is reachable from the NetScaler MAS server, select the Routable checkbox. If your NetScaler CPX IP address is reachable through the host, uncheck the Routable checkbox and specify the host’s IP address.
Click OK to initiate the process of adding instances to NetScaler MAS.
If you want to rediscover an instance, navigate to Networks > Instances > NetScaler <Instance Type>, select the instance you want to rediscover, and then from the Action drop-down list, click Rediscover.