- 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
Pre-configuration Tasks in NetScaler MAS and OpenStack
Perform the following tasks before you configure NetScaler MAS and OpenStack:
Install NetScaler MAS on a supported hypervisor. For more information on how to download and install NetScaler MAS, see Deploying NetScaler MAS.
Download the NetScaler bundle for OpenStack from the NetScaler MAS Downloads page.
To install NetScaler driver on OpenStack platform using NetScaler MAS GUI:
In NetScaler MAS, click Downloads. The Downloads page in NetScaler MAS provides you links to download NetScaler bundle for OpenStack software required for Newton, Ocata, and Pike OpenStack versions.
Download the latest NetScaler bundle tar file to a temporary directory (for example, /tmp) in OpenStack Controller. This bundle includes the LBaaS V2 driver and Heat plug-in for all OpenStack releases.
Run the following command to extract the files from the NetScaler driver tar file:
tar -xvzf \<name\_of\_tar\_file\>
If you have an OpenStack <Release Name> setup, at the prompt, type the following command:
cd \<Release Name\>
Run the following command to install the driver and specify the NetScaler MAS IP address, the NetScaler driver password that you configured when you registered OpenStack with NetScaler MAS, and the protocol:
./install.sh --ip=\<NetScaler\_MAS\_IP\> --password=\<password\> --protocol=\<protocol\> --neutron-lbaas-path \<neutron-lbaas-directory-path\>
Example for single node OpenStack setup:
./install.sh --ip=10.102.29.90 --password=xxxx --protocol=HTTP --neutron-lbaas-path=/opt/stack/neutron-lbaas
Example for multinode OpenStack setup:
./install.sh --ip=10.102.29.90 --password=xxxx --protocol=HTTP --neutron-lbaas-path=/usr/lib/python2.7/site-packages
Providing the path of the neutron-lbaas directory of the system is optional. Providing the path might assist the script to find the drivers.
After NetScaler MAS is registered successfully on OpenStack, you can log on to NetScaler MAS using your OpenStack user credentials also.
After NetScaler MAS is registered successfully on OpenStack, restart the OpenStack Neutron services.
To register OpenStack with NetScaler MAS using NetScaler MAS GUI:
In NetScaler MAS, navigate to Orchestration > Cloud Orchestration > OpenStack.
Click Configure OpenStack Settings.
In Configure OpenStack Settings page, you can set the parameters to configure OpenStack in NetScaler MAS. You have two options here - Default and Customized.
For Newton and Ocata releases of OpenStack, you can use either default or customized deployment type. But for Pike release, you must use customized deployment type to register OpenStack with NetScaler MAS.
Default Deployment Type
Select Default, if the OpenStack services are running on default ports. For example, the default portal for Neutron services is 9696, the default portal for Keystone services is 5000.
OpenStack Controller IP Address - IP address of the OpenStack controller (both the KeyStone service and the Neutron service should be reachable on this IP address). For example, enter the IP address 10.102.205.23.
OpenStack Admin Username - administrative username of the OpenStack controller. For example, enter admin1.
Password - password of the administrative user of the OpenStack controller.
OpenStack Admin Tenant - the name of the administrative tenant on OpenStack. For example, enter admin.
Customized Deployment Type
Select deployment type as Customized if the OpenStack services are running on ports different from the default ports. If these services are running on different ports, specify them here. Registering OpenStack Newton and Ocata releases with NetScaler MAS is different from registering OpenStack Pike release.
Newton and Ocata Release of OpenStack:
Specify the port numbers for the various OpenStack services if you are registering Newton release of OpenStack.
Specify the OpenStack Admin username, password, and OpenStack Admin Tenant username as you had specified earlier in the Default settings.
Pike Release of OpenStack:
If you are registering the Pike release of OpenStack enter the details of the OpenStack services as shown in the following image. You must also specify the OpenStack Admin username, password, and OpenStack Admin Tenant username as in Default settings.
In OpenStack Neutron LBaaS - Credentials Used by NetScaler Driver section, set the NetScaler Driver Password for the OpenStack NetScaler driver user account. NetScaler MAS authenticates the calls from the OpenStack NetScaler driver by using these credentials. You must specify the same password when you execute the NetScaler driver installation script in the OpenStack controller.
Create a project or a tenant on OpenStack, add users to the project or tenant, and assign roles to all of the users. KeyStone, the Identity service in OpenStack provides authentication services for each OpenStack service. The authentication service uses a combination of domains, projects (tenants), users, and roles.
For more information on how to create a project, and to perform other tasks in OpenStack, see the OpenStack documentation at http://docs.openstack.org/.
In NetScaler MAS, navigate to Orchestration > Cloud Orchestration > OpenStack > OpenStack Tenants, and then click Add.
In Add OpenStack Tenants page, click +Add, and then select the OpenStack tenant.
Based on whether you are using pre-provisioned instance or auto-provisioning the instance when you are integrating the OpenStack, follow one of these two tasks:
Pre-provisioning NetScaler Devices
Install the NetScaler device on any of the hypervisor platforms like XenServer, KVM, or ESX, and add the instance to NetScaler MAS. NetScaler MAS then manages this device that load balances the traffic in the servers.
To add an existing NetScaler VPX instance in NetScaler MAS:
In NetScaler MAS, navigate to Infrastructure > Instances > NetScaler VPX, and then click Add.
On the Add NetScaler VPX page, specify the IP address of the NetScaler VPX instance and select an instance profile from the Profile Name list. The instance profile contains the credentials used to logon to the NetScaler VPX. You can also create a new instance profile by clicking the + icon. Click OK.
For more information, see Getting Started with Citrix NetScaler.
Autoprovisioning NetScaler Devices
Download the required NetScaler instance image from the Citrix download page, and upload it on Glance, the OpenStack Imaging service. Having an image available on Glance allows you to configure a NetScaler instance on-demand when assigning the instance to the tenant.
To auto-provision the NetScaler VPX devices on OpenStack:
In NetScaler MAS, navigate to Orchestration > Cloud Orchestration > OpenStack.
Click Deployment Settings.
Set the following parameters:
Management Network - select the management network on OpenStack, to which the auto-provisioned NetScaler VPX is connected.
Profile Name - select the profile from the drop-down list. The NetScaler MAS uses the password contained in this profile to configure new auto-provisioned NetScaler VPX instances.
Licenses - provide the NetScaler MAS license activation codes (LAC) used to license new auto-provisioned NetScaler instances. NetScaler MAS provisions NetScaler instances on OpenStack compute in management network, then triggers license installation on them using the specified license code. The NetScaler instance then downloads the license files from Citrix website using the LAC specified here.
NetScaler VPX Image in Glance - select the NetScaler VPX image available in the OpenStack Glance that is used to create a NetScaler VPX instance.
Proxy Settings - provide details of NetScaler proxy server for installing licenses. This may be required when NetScaler does not have direct access to the Internet through the management network.
Creating a Service Package in NetScaler MAS
To create service packages for a tenant in NetScaler MAS:
In NetScaler MAS, navigate to Orchestration > Cloud Orchestration > OpenStack > Service Packages, and then click Add.
On the Service Package page specify the following parameters:
Name - name for the service package. For example, enter SVC-PKG-GOLD.
NetScaler Instance Allocation - the type of instance allocation defined in the service package based which NetScaler instance resources are allocated to a tenant. Select Dedicated. For more information on policies, see Service Package Isolation Policies.
NetScaler Instance Provisioning - select Existing Instance to allocate an existing NetScaler instance to a tenant. If you want to create NetScaler instances during the configuration itself, select Create Instance OnDemand.
NetScaler Instance Type - select NetScaler VPX.
Note: Select NetScaler VPX to allocate pre-provisioned NetScaler instances hosted on SDX platform.
Click Continue to associate a tenant with a service package.
Note: Enable Provision pair of NetScaler instances for high availability, if you are deploying the NetScaler instances in high availability mode.
In Assign Instances section, click Add, and then select the NetScaler instance that you want to assign to the tenant, and click Continue.
In Assign OpenStack Tenants/Placement Policies section, under OpenStack Tenants, click Add, and select the tenant.
Click Continue, and then click Done.
Note: If the policy is not found, the fallback mechanism is revived, and the NetScaler MAS assigns NetScaler instances based on tenants. If the tenant is not part of any service package, the NetScaler MAS displays an error message that says: “Tenant <admin> is not part of any Service Package and there is no default Service Package.”
Creating Placement Policies (Optional)
Isolation Policies are not tenant-based only. You can create flexible placement policies, where the policies are not only based on tenant name or id, but on other custom attributes also.
To create placement policies for a tenant in NetScaler MAS:
In NetScaler MAS, navigate to Orchestration > Cloud Orchestration > OpenStack > Placement Policy, and then click Add.
On the Add Placement Policy page, set the following parameters:
Name - type a name for the placement policy.
Sample Expressions - select a sample expression from the list. These examples are helpful to construct the placement policy.
Expression - a Boolean expression is populated in this field based on the sample expression that you have selected in the earlier field. Edit the field names as required.
Auto-Provisioning NetScaler VPX Devices Deployed on NetScaler SDX Platform
Add the NetScaler SDX platform in NetScaler MAS, so that NetScaler MAS provisions the instances on this platform on-demand.
To Auto-provison NetScaler Instances Deployed on NetScaler SDX Platform:
In NetScaler MAS GUI, navigate to Networks > Instances > NetScaler SDX, and click Add to add a NetScaler SDX platform.
Navigate to Orchestration > Cloud Orchestration > OpenStack > Deployment Settings.
In Management Network section, select the management network on OpenStack to which the auto-provisioned NetScaler SDX is connected.
In Profile Name, select the profile from the drop-down list. The NetScaler MAS uses the password contained in this profile to configure new auto-provisioned NetScaler VPX instances.
To provision the NetScaler SDX platform in OpenStack, navigate to Orchestration > Cloud Orchestration > OpenStack > Service Package.
Click Add to create a new service package.
Enter the name of the service package.
In NetScaler Instance Allocation field, select Dedicated.
In NetScaler Instance Provisioning field, select Create Instance OnDemand, and in Auto Provision Platform field, select NetScaler SDX.
By default, only NetScaler VPX instances are provisioned on NetScaler SDX platform.
In Auto Provision Settings section, set the Resources properties.
Throughput field. Enter 1000 Mbps.
NetScaler Version field. From the drop-down field, select the right version of the NetScaler VPX image present on the NetScaler SDX platform.
In NetScaler SDX Platforms section, click Add to add the SDX platform to the service package.
In Configure OpenStack Tenants section, click Add to add the tenants. You can also add new tenants by clicking New.
LBaaS V2 API implementations are performed through Neutron LBaaS commands. Connect to any Neutron client and execute the configuration tasks. For more information on how to execute configuration commands, see Configuring LBaaS V2 using Command Line.