- 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
You can optimize resource usage by monitoring your network reporting on NetScaler MAS. You may have a distributed deployment with many applications deployed at multiple locations. To ensure optimal performance of your applications, you have also deployed multiple NetScaler instances to load balance, content switch, or compress the traffic. Network performance can impact the application performance. To continue to maintain performance of your applications, you must regularly monitor your network performance and make sure all resources are used optimally.
NetScaler MAS now allows you to generate reports not only for instances at a global level but also for entities such as the virtual servers and network interfaces. The instance family comprises both NetScaler and SD-WAN instances. The virtual servers for which you can generate reports are as follows:
Load balancing servers
Content switching servers
Global service load balancing (GSLB)
The network reporting dashboard in NetScaler MAS is a highly customizable. You can now create multiple dashboards for various instances, virtual servers, and other entities.
The following image calls out the various features in the dashboard:
The left side panel lists all the custom dashboards that are created in NetScaler MAS. You can click on one of them to view the various reports that the dashboard is composed of. For example, a TCP and SSL dashboard contains various reports related to TCP and SSL protocols.
You can customize each dashboard with multiple widgets to display a variety of reports. A widget represents a report on the dashboard, that is a collection of more related reports. For example, a compression TCP Bytes Usage report contains reports for compressed TCP bytes transferred and received per second.
You can display reports for one hour, one day, one week, or for one month. In addition, you can now use the timeline slider option to customize the duration of reports being generated on the NetScaler MAS.
You can remove a report by clicking “X”. You can also export the report as a .pdf, .jpeg, .png, or .csv format to your system. You can also schedule a time and recurrence of when the report should be generated. You can also configure a email distribution list to which the reports should be sent.
The Instances section at the top of the dashboard lists the IP addresses of all the instances for which the report is generated.
You can either remove instances by clicking “X” or add more instances to the reports. But, currently NetScaler MAS allows you to view reports for ten instances.
You can also export the entire dashboard as a .pdf, .jpeg, .png, or .csv format to your system. Any changes made to the dashboard must be saved. Click Save to save the changes.
The following section explains in detail the tasks to create a dashboard, generate reports, and to export reports.
To view or to create a dashboard
In NetScaler MAS, navigate to Networks > Network Reporting.
In the Select Reports tab, select the reports required. In this example, you can select transactions, connections, and throughput. Click Next.
To view the existing dashboards, click View Dashboard. The Network Reporting Dashboard page opens where you can view all your dashboards and report widgets.
To create a dashboard, click Create Dashboard.
The Create Dashboard page opens.
In the Basic Settings tab, enter the following details:
Name. Type the name of the dashboard.
Instance Family. Select the type of instance - NetScaler or NetScaler SD-WAN
Type. Select the entity type for which you want to generate reports. In this example, select load balancing virtual servers.
Description. Type a meaningful description for the dashboard.
In the Select Entities tab, click Add.
In the Choose LB Virtual Servers window that slides in, select any number of virtual servers that you want to monitor.
Depending on the entity type that you have selected in Basic Settings tab, the Entities tab is populated with corresponding entities. For example, if you select global, you can add instances.
The Skype for Business dashboard is created and displays all the reports that you have selected.
Exporting network reports
While you can export widget reports in .pdf, .png, .jpeg, or .csv formats, you can export the entire dashboards in only .pdf, .jpeg, or .png formats.
You cannot export reports in NetScaler MAS if you have read-only permissions. You need an edit permission to be able to create a file in NetScaler MAS and to be able to export the file.
To export dashboard reports:
Navigate to Networks > Network Reporting
Click View Dashboards to view all the dashboards that you have created.
In the left pane, click a dashboard. In this example, click Dashboard 1.
Click the export button at the top right corner of the page.
Under the Export Now tab, select the required format, and then click Export.**
To export widget reports:
Navigate to Networks > Network Reporting.
Click View Dashboards to view all the dashboards that you have created.
In the left pane, click a dashboard. In this example also click Skype for Business.
Select a widget. For example, select Load Balancing Virtual Server Transactions.
Click the export button at the top right corner of the page
Under the Export Now tab, select the required format, and then click Export.
To monitor the state of a NetScaler instance, you can set thresholds on counters and receive notifications when a threshold is exceeded. On NetScaler MAS, you can configure thresholds and view, edit, and delete them.
For example, you can receive an email notification when the Connections counter for a content switching virtual server reaches a specified value. You can define a threshold for a specific instance type. You can also choose the reports you want to generate for specific counter metrics from your chosen instance.
When the value of a counter exceeds or falls below (as specified by the rule) the threshold value, an event of the specified severity is generated to signify a performance related issue. When the counter value returns to a value that you consider normal, the event is cleared. These events can be viewed by navigating to Networks > Events > Reports. On the Reports page, you can click the Events by Severity donut to view events by their severity.
You can also associate an action with a threshold such as sending an email or SMS message when the threshold is breached.
To create a threshold
1. In NetScaler MAS, navigate to Networks > Network Reporting > Thresholds. Under Thresholds, click Add.
On the Create Threshold page, specify the following details:
Threshold Name. Name of the threshold.
Instance Type. Choose NetScaler or NetScaler SD-WAN WO.
Report Name. Name of the performance report that provides information about this threshold.
You can also set rules to specify when an event is to be generated or cleared. You can specify the following details under the Configure Rule section:
Metric. Select the metric for which you want to set a threshold.
Comparator. Select a comparator to check whether the monitored value is greater than or equal to or less than or equal to the threshold value.
Threshold Value. Type the value for which the event severity is calculated. For example, you might want to generate an event with critical event severity if the monitored value for Current Client Connections reaches 80 percent. In this case, type 80 as the threshold value. You can view “critical severity” events by navigating to Networks > Events > Reports. On the Reports page, you can click the Events by Severity donut to view events by their severity.
Clear Value. Type the value that indicates when to clear the value. For example, you might want to clear the Current Client Connections threshold when the monitored value reaches 50 percent. In this case, type 50 as the clear value.
Event Severity. Select the security level that you want to set for the threshold value.
Choose the IP address of the instance or instances for which you want set the threshold.
You can additionally add an Event Message. Type a message that you want to appear when the threshold is reached. NetScaler MAS appends the monitored value and the threshold value to this message.
Select Enable to enable the threshold to generate alarms.
Optionally, you can configure Actions such as email and/or SMS notifications.
By default, every 5 minutes, NITRO calls collect performance data for network reporting. This retrieves instance statistics such as counter information and aggregates them on the basis of per minute, per hour, per day, or per week. You can view this aggregated data in predefined reports.
To set the performance polling interval, navigate to Networks > Network Reporting and click Configure Polling Interval. Your polling interval cannot be less than 5 minutes or more than 60 minutes.
You can configure the purge interval of network reporting data in NetScaler MAS. This limits the amount of network reporting data being stored in the NetScaler MAS server’s database. By default, pruning happens every 24 hours (at 01.00 hours) for the network reporting historical data.
Note: The value you can specify cannot exceed 90 days or be less than 1 days.
To configure network reporting prune settings:
Navigate to System > System Administration. Under Prune Settings, click Network Reporting Prune Settings.
In the Configure Network Reporting Prune Settings page, specify the number of days for which to retain data, and click OK.
All the network reporting performance data are persisted in the NetScaler MAS database for the number of days selected.