- 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
This document walks you through how to get started with deploying and setting up NetScaler MAS for the first time. This document is intended for network and application administrators who manages Citrix network devices (NetScaler, SD-WAN WO, NetScaler Gateway, and so on) and also third-party devices such as HAProxy. You must follow the steps in this document irrespective of the type of device you plan to manage using NetScaler MAS.
If you are an existing user of NetScaler MAS, you are recommended to review the release notes, system requirements, and licensing details before upgrading your server to the latest release of NetScaler MAS.
Before you begin deploying NetScaler MAS in your data center, review the software requirements, browser requirements, port information, license information, and limitations.
License information. You can manage and monitor any number of instances and entities without a license. However, you can only manage 30 discovered apps and view analytics information for only 30 virtual servers without applying a license. To manage more than 30 apps or to view analytics for more than 30 virtual servers, you must purchase appropriate licenses. Learn More.
Operating system and Receiver requirements. Review this information to make sure you have the correct receiver version for the supported operating systems. Learn More.
Broswer requirements. To access NetScaler MAS GUI, you must make sure you have the required browser and the correct version. Learn More.
Ports. Make sure the required ports are open for NetScaler MAS to communicate with NetScaler and/or SD-WAN instances. Learn More.
NetScaler instance requirements. Different NetScaler MAS features are supported on different NetScaler software versions. Review this information to make sure you have upgraded your NetScaler instances to the correct version. Learn More.
NetScaler SD-WAN instance requirements. Review this information to make sure you have upgraded your NetScaler SD-WAN instances to the correct version and you have the correct platform editions. Learn More.
To manage and monitor applications and the network infrastructure, you must first install NetScaler MAS on one of the hypervisors. You can deploy NetScaler MAS either as a single server or in a high availability mode. If you are using NetScaler Insight Center, you can migrate to NetScaler MAS and avail of the management, monitoring, orchestration, and application management features in addition to the analytics features.
Single-Server Deployment. In a NetScaler MAS single server deployment, the database is integrated with the server and a single server processes all the traffic. You can deploy NetScaler MAS with Citrix XenServer, VMWare ESXi, Microsoft Hyper-V, and Linux KVM. See:
High Availability (HA) Deployment. An HA deployment of two Citrix NetScaler MAS servers provides uninterrupted operations. In a high availability setup, both the NetScaler MAS nodes must be deployed in active-passive mode, on the same subnet using the same software version and build, and must have same configurations. With HA deployment the ability to configure the floating IP address on the NetScaler MAS primary node eliminates the need of separate NetScaler load balancer. To learn more, see Configure in high availability deployment.
Instances are Citrix appliances or virtual appliances or third-party devices 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 instances to NetScaler MAS:
When you add an instance to the NetScaler MAS server, the server implicitly communicates with the instances and collects inventory of these instances.
To view analytics data for your application traffic flow, you must enable the Analytics feature on the virtual servers that receive traffic for the specific applications.
You have to configure a Network Time Protocol (NTP) server in NetScaler MAS to synchronize its clock with the NTP server. Configuring an NTP server ensures that the NetScaler MAS clock has the same date and time settings as the other servers on the network.
Before you start using NetScaler MAS to manage and monitor your instances and applications, it is recommended that you configure a few system settings that will ensure optimal performance of your NetScaler MAS server.
Configure System Alarms. You should configure system alarms to make sure you are aware of any critical or major system issues. For example, you might want to be notified if the CPU usage is high or if there are multiple login failures to the server.
Configure System Notifications. You can send notifications to select groups of users for a number of system-related functions. You can set up a notification server in NetScaler MAS, and you can configure email and Short Message Service (SMS) gateway servers to send email and text notifications to users. This ensures that you are notified of any system-level activities such as user login or system restart.
Configure System Prune Settings. To limit the amount of reporting data being stored in your NetScaler MAS server’s database, you can specify the interval for which you want NetScaler MAS to retain network reporting data, events, audit logs, and task logs. By default, this data is pruned every 24 hours (at 00.00 hours).
Configure System Backup Settings. NetScaler MAS automatically backs up the system everyday at 00:30 hours. By default, it saves three backup files. You might want to retain more number of backups of the system.
Configure Instance Backup Settings. If you back up the current state of a NetScaler instance, you can use the backup files to restore stability in the event that the instance becomes unstable. Doing so is especially important before performing an upgrade. By default, a backup is taken every 12 hours and three backup files are retained in the system.
Configure Instance Event Prune Settings. To limit the amount of event messages data being stored in your NetScaler MAS server’s database, you can specify the interval for which you want NetScaler MAS to retain network reporting data, events, audit logs, and task logs. By default, this data is pruned every 24 hours (at 00:00 hours).
Configure Instance Syslog Purge Settings. To limit the amount of syslog data stored in the database, you can specify the interval at which you want to purge syslog data. You can specify the number of days after which the following syslog data will be deleted from NetScaler MAS: Generic Syslog Data, AppFirewall Data, and NetScaler Gateway Data.
After you have deployed and set up NetScaler MAS, you can start managing and monitoring your instances and applications.
Managing NetScaler instances and applications. All NetScaler MAS features are supported on NetScaler instances. You can start using any of the features.
Managing NetScaler SD-WAN instances. Not all NetScaler MAS features are supported on SD-WAN WO instances, for example, certificate management or configuration audit are not supported. To learn about what features are supported and how to use them, see Managing NetScaler SD-WAN WO Using NetScaler MAS.
Managing HAProxy instances and applications. You can monitor the frontends, backends, and servers configured in an HAProxy dpeloyment. You can also use the Application Management feature to monitor real-time statistics of the frontends monitored by NetScaler MAS. To learn about what features are supported for HAProxy and how to use them, see Managing and Monitoring HAProxy Instances Using NetScaler MAS.