- 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
Integrating NetScaler MAS with NSX Manager by Manual Provisioning
NetScaler Management and Analytics System (MAS) integrates with VMware network virtualization platform to automate the deployment, configuration, and management of NetScaler services. This integration abstracts away the traditional complexities associated with physical network topology, enabling vSphere/vCenter admins to programmatically deploy NetScaler services faster.
This article provides you with a list of tasks that you have to perform on both VMware NSX Manager and on NetScaler MAS.
Note: Make sure that VMware NSX for vSphere 6.2 and above is installed and configured, and the edge gateways, DLR, and virtual machines that have to be load balanced are already created.
Install VMware ESXi version 4.1 or later with hardware that meets the minimum requirements.
Install VMware Client on a management workstation that meets the minimum system requirements.
Install VMware OVF Tool (required for VMware ESXi version 4.1) on a management workstation that meets the minimum system requirements.
Install NetScaler Management and Analytics System on any of the supported hypervisors.
For tasks to install NetScaler MAS build 12.0, on any of the supported hypervisors, see Deploying NetScaler MAS.
The following table lists the virtual computing resources that you require on your VMware ESXi server to install a NetScaler MAS virtual appliance.
|Storage space||500 GB|
|Virtual Network Interfaces||1|
Note: The memory and hard disk requirements specified above are for deploying NetScaler MAS on VMware ESXi server, considering that there are no other virtual machines running on the host. The hardware requirements for VMware ESXi server depends on the number of virtual machines running on it.
Create a pool of NetScaler VPX instances of different capacities, which are added to the different service packages.
Create five NetScaler VPX instances of VPX1000 (1 Gbps). These instances are added to the Gold service package.
Create five NetScaler VPX instances of VPX10 (10 Mbps). These instances are added to the Bronze service package.
In vSphere client, navigate to Networking, and create a port group of type VLAN trunking with range, for example, 101-105 (you can even provide the full range, but create port group of type VLAN for only the required VLANs).
Create a new interface for each NetScaler VPX instance, and attach it to the VLAN range trunk port group that was created above.
In vSphere client, navigate to Networking, and create a port group of type VLAN.
For example, If the initial trunked port group was created with range 101-105, create five VLAN port groups one per VLAN, that is a port group with VLAN 101, another with VLAN102, and so on, until VLAN 105.
Add NetScaler VPX instances in NetScaler MAS and specify the VLAN range of the trunked group for each device.
In NetScaler MAS, navigate to Infrastructure > Instances > NetScaler VPX, and click Add.
On the Add NetScaler VPX page, specify either the host names of the instances, the IP address of each instance, or a range of IP addresses, and then select an instance profile from the Profile Name list. You can also create a new instance profile by clicking the + icon.
Select the newly added NetScaler VPX instance from the list on the NetScaler VPX page, and click the down arrow button in Action field. Select Configure Interfaces for Orchestration.
On the Interfaces page, select the management interface, and click Disable to disable VLAN from binding to the management interface.
On the Interfaces page, select the required interface, and click Configure VLAN Range.
Enter the VLAN range configured in NSX Manager, click OK, and then click Close.
Register VMware NSX manager with NetScaler MAS to create a communication channel between them.
In NetScaler MAS, navigate to Orchestration > SDN Orchestration > VMware NSX Manager from the drop-down list, and click Configure NSX Manager Settings.
On Configure NSX Manager Settings page, set the following parameters:
NSX Manager IP Address - IP address of NSX Manager.
NSX Manager Username - Administrative user name of NSX Manager.
Password - Password of the administrative user of NSX Manager.
In NetScaler MAS account used by NSX Manager section, set the NetScaler Driver Username and Password for the NSX Manager. NetScaler MAS authenticates load balancer configuration requests from the NSX Manager by using these logon credentials.
Navigate to Orchestration > System > Deployment Settings. Provide the VLAN range which was configured in trunked port group.
Log on to the NSX Manager on vSphere Web Client, and navigate to Service Definitions > Service Managers.
You can view Citrix NetScaler MAS as one of the service managers. This indicates that the registration is successful and a communication channel is established between the NSX manager and NetScaler MAS.
In NetScaler MAS, navigate to Orchestration > SDN Orchestration > VMware NSX Manager > Service Packages, and click Add to add a new service package.
On Service Package page, in Basic Settings section, set the following parameters:
Name – type the name of a service package
Isolation Policy – by default, the isolation policy is set to Dedicated
Device Type – by default, the device type is set to NetScaler VPX
Note: These values are set by default in this version, and you cannot modify them.
In Assign Devices section, select the pre-provisioned VPX for this package, and click Continue.
In Publish Service Package section, click Continue to publish the service package to VMware NSX, and then click Done.
This procedure configures a service package in the NSX Manager. A service can have multiple devices added to it and multiple edges can use the same service package to offload the NetScaler VPX instance to NetScaler MAS.
Log on to the NSX Manager on vSphere Web Client, and navigate to Service Definitions > Services.
You can see that the NetScaler MAS service package is registered.
Perform load balancer service insertion on the previously created NSX Edge gateway (offload the load balancing function from NSX LB to NetScaler).
In NSX Manager, navigate to Home > NSX Edges, and select the edge gateway that you have configured.
Click Manage, and on the Load Balancer tab, select Global Configuration, and click Edit.
Select Enable Load Balancer, Logging, Enable Service Insertion to enable them.
In Service Definition, select the service package that was created in NetScaler MAS and published to NSX Manager.
Select the existing runtime NICs and click the Edit icon to edit runtime NICs that have to be connected when NetScaler VPX is allocated.
Edit the name of the NIC, specify Connectivity Type as Data, and click Change.
Select the appropriate web logical switch.
In Primary IP Allocation Mode, select IP Pool from the drop-down list, and click the down-arrow button on IP Pool field.
In the Select IP Pool window, select the appropriate IP pool, and click OK.
The IP address is acquired and is set as the source net IP address in the NetScaler VPX appliance. A L2 gateway is created in the NSX Manager to map the VXLAN to VLAN.
Note: All data interfaces are connected as run-time NICs, and they should be part of interfaces for DLR.
Refresh the view to see the creation of the run time.
After the VM has started, the value of Status changes to In Service and that of Install State changes to Enabled.
Note: In NetScaler MAS, navigate to Orchestration > Requests to see progress details of completion of LB service insertion.
Log on to the NSX Manager on vSphere Web Client, navigate to NSX Edges, and select the DLR created.
In the DLR page, navigate to Manage > Bridging. You can see the L2 gateway displayed in the list.
Note: An L2 gateway gets created for each data interface.
Log on to the NetScaler VPX instance using the IP address displayed in NetScaler MAS. Then, navigate to Configuration > System > Networking. In the right pane, you can see that the two IP address are added. Click the IP address hyperlink to see the details.
The subnet IP address is same as the IP address of the web interface added in the NSX.
Navigate to Configuration > System > Licenses to view the licenses that are applied to this instance.
In NetScaler MAS, navigate to Orchestration > SDN Orchestration > Configure NSX Manager > Edge Gateways.
Make a note of the NetScaler instance IP that is allotted to the respective Edge Gateway on which Load Balancing configuration through Stylebooks has to be applied.
Create a new Stylebook. Navigate to Applications > Configuration, import the stylebook, and select the stylebook from the list.
To create a new stylebook, see Create Your Own Stylebook.
Specify values for all the required parameters.
Specify the NetScaler VPX instance on which you want to run these configuration settings.
Select the IP instance noted earlier, and click Select.
Click Create to apply the configuration on the selected device.
Log on to the NetScaler VPX instance, navigate to Configuration > Traffic Management > Load Balancing to view the load balancing virtual server that is created.
You can also view the service groups that are created.
Select the service group, and click Manage Members. The Configure Service Group Member page displays the members associated with the service group.
In NetScaler MAS, navigate to Applications > Configuration, and click X icon to delete the application configuration.
Log on to the NSX Manager on vSphere Web Client and navigate to the edge gateway to which the NetScaler VPX instance is connected.
Navigate to the Manage > Load Balancer > Global Configuration, right-click on the runtime entry, and click Unprovision.
Note: Edge Gateways in NetScler MAS corresponds to runtime entries in NSX manager.
The NetScaler VPX instance is rendered out of service.
In NetScaler MAS, navigate to Orchestration > SDN Orchestration > Configure NSX Manager > Edge Gateways. Verify that the respective mapping of Edge Gateway to the deleted instance is not present.
Integrating NetScaler MAS with NSX Manager by Manual Provisioning
In this article
- VMware ESXi Hardware Requirements
- Configuring VMware NSX
- Adding NetScaler VPX Instance in NetScaler MAS
- Registering VMware NSX Manager with NetScaler MAS
- Creating a Service Package in NetScaler MAS
- Performing Load Balancer Service Insertion for Edge
- Viewing L2 Gateway on NSX Manager
- Viewing Allotted NetScaler
- Configuring NetScaler VPX Instance Using Stylebook
- Viewing Load Balancer Configuration
- Deleting Load Balancer Service