- Release Notes
- How-to Articles
- About NetScaler MAS
- 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
Microsoft SharePoint StyleBook
Feb 26, 2018
Microsoft SharePoint 2016 is a key enterprise application that primarily provides a document management and storage system, which is highly configurable and supported by all major browsers.
You can use the Microsoft SharePoint 2016 StyleBook to deploy a NetScaler configuration that optimizes and secures the Microsoft SharePoint 2016 enterprise application in your network.
- Microsoft SharePoint 2016
- NetScaler MAS, version 12.0 and later
- NetScaler, version 10.5 and later
NetScaler features configured by the Microsoft SharePoint 2016 StyleBook
You can use the Microsoft SharePoint 2016 StyleBook to enable and configure the following NetScaler features for Microsoft SharePoint 2016:
- Load balancing
- Content Switching
- Integrated Caching
NetScaler load balancing evenly distributes requests to backend SharePoint servers. Intelligent monitoring of backend servers prevents requests from being sent to malfunctioning servers.
The SharePoint StyleBook configures 12 load balancing virtual servers, each dedicated to load balancing requests for a certain type of content, such as documents, images, audio, video, and other file types.
NetScaler MAS now supports SSL Mode of SharePoint application by configuring SSL based LB virtual servers. Make sure you select SSL as the front-end protocol. Note that the virtual port is set to 443 by default.
The content switching feature is used to distribute client requests across multiple load balancing virtual servers on the basis of specific types of requested SharePoint content (for example, documents, images, and audio or video files). The content switching module directs incoming traffic to an optimal matching load balancing virtual server that can process that type of content. You can therefore apply different optimization policies to different types of traffic. For example, you might want to use different compression or caching policies for video than for text documents.
The responder functionality of a NetScaler instance can be used to seamlessly redirect users from HTTP to HTTPS. Responder can also be configured to provide customized error pages. The Responder policy determines the requests (traffic) on which an action has to be taken, and binds each policy to a load balancing virtual server. The SharePoint StyleBook includes a configuration that redirects users from HTTP to HTTPS URLs.
The rewrite module is used to modify request/response headers, URLs, or content on the fly. This module works in-line with traffic processing and can therefore change the traffic flow as appropriate for particular use cases. For example, rewriting can provide access to the requested content without exposing unnecessary details about the website’s server.
In the SharePoint StyleBook, the rewrite feature is used to removed unnecessary headers from user requests.
The NetScaler compression engine identifies and compresses content that is compressible. This process improves data transmission time and reduces network bandwidth requirements for the clients, while saving CPU cycles on SharePoint content servers. A NetScaler instance can compress both static and dynamically generated data. It applies the GZIP or the DEFLATE compression algorithm to remove extraneous and repetitive information from the server responses and represent the original information in a more compact and efficient format. The client browser’s ability to decompress the data depends on which algorithm or algorithms it supports: GZIP, DEFLATE, or both of these.
A NetScaler instance is configured to compress the text in HTML, XML, plain text, Cascading Style Sheet (CSS), and Microsoft Office documents, but does not compress images in GIF or JPG format. The major benefits of compressed traffic include reduced bandwidth costs, WAN latency reduction, and better server performance.
The NetScaler in-memory cache can store SharePoint objects in order to quickly deliver frequently requested content to users. Cached content includes downloaded documents and audio, video, and image files.
The following figure diagrammatically represents the deployment of SharePoint servers in a network front-ended by a NetScaler instance on which NetScaler MAS is used to deploy a SharePoint StyleBook configuration.
Deploying SharePoint StyleBook configurations
The following task will assist you in deploying the Microsoft SharePoint 2016 StyleBook in your business network.
To deploy Microsoft SharePoint 2016 StyleBook
1. In NetScaler MAS, navigate to Applications > Administration > Configuration, and click Create New. The Choose StyleBook page displays all the StyleBooks available for your use in NetScaler MAS.
2. Scroll down and select Microsoft SharePoint 2016 StyleBook.
Note: In NetScaler MA Service, navigate to Applications > Configurations > StyleBooks. Scroll down to find the Microsoft SharePoint 2016 StyleBook. In the Microsoft SharePoint 2016 StyleBook panel, click Create Configuration.
The StyleBook opens as a user interface form on which you can enter the values for all the parameters defined in this StyleBook.
Enter values for the following parameters:
1. SharePoint Application Name. Name of the SharePoint configuration to deploy in your network.
2. SharePoint Virtual IP. Virtual IP address at which the NetScaler instance receives client requests for the Microsoft SharePoint application.
3. SharePoint Virtual Port. The TCP Port to be used by the Users in accessing the SharePoint application
4. SharePoint frontend Protocol. Select the SharePoint frontend protocol from the drop-down list. The options available are HTTP or SSL.
Note: If you select SSL, make sure that the Rewrite Configuration parameter is enabled in the SharePoint Advanced Settings section in this StyleBook.
5. SharePoint Server IPs. IP addresses of all the SharePoint servers in the network.
6. SharePoint Servers Port. TCP port number used by the SharePoint servers. By default, this is 80. You can edit this value if required, but make sure that this port is accessible on Microsoft SharePoint 2016 servers.
3. In the SSL Certificates settings section, click + to enter the name of the SSL certificate, the certificate key, and select the respective files from your local storage folder.
4. Optionally click Advanced Certificate Settings to enable or disable SSL certificate expiry monitoring. If you enable the certificate expiry monitoring, set the number of days so that NetScaler MAS issues an alarm after these many days when the certificate is about to expire. You also have an option to make the OCSP checking as an optional feature or a mandatory feature.
5. The SharePoint Advanced Settings section allows you to enable the NetScaler features that will be configured on the NetScaler instances. While the load balancing and content switching features are configured on the instances by default, you can choose the other features, that is, responder configuration, rewrite configuration, compression configuration, and integrated caching configuration, that you want to be configured on the instance.
6. Click Target Instances and select the NetScaler instance on which to deploy this SharePoint configuration. Click Create to create the configuration and deploy the configuration on the selected NetScaler instance.
You can also click the refresh icon to add recently discovered NetScaler instances in NetScaler MAS to the available list of instances in this window.
Note: Citrix recommends that before executing the actual configuration, you select Dry Run to check the configuration objects that will be created on the target instance.
When the configuration is created and successfully deployed, the SharePoint StyleBook creates one content switching virtual server and 12 load balancing virtual servers. It also creates policies and service groups and binds them to the load balancing virtual servers. Which policies are created depends on the features selected in the StyleBook during creation of the configuration pack.
Viewing the objects defined on the NetScaler instance
After the configuration pack is created on NetScaler MAS, you can view all the objects created on the NetScaler instance for the SharePoint StyleBook. Navigate to Applications > Administration > Configuration, and click View Objects Created. The following figure shows some of the created objects, with the IP addresses specified in the example shown in “Deploying SharePoint StyleBook Configurations from NetScaler MAS.”