Application Delivery Management

NSX Manager: manual provisioning of NetScaler instances

NetScaler Console 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 Console.


Ensure 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 Console on any of the supported hypervisors.

    For tasks to install NetScaler Console build 13.1, on any of the supported hypervisors, see Deploying NetScaler Console.

VMware ESXi Hardware Requirements

The following table lists the virtual computing resources that you require on your VMware ESXi server to install a NetScaler Console virtual appliance.

Component Requirement
Virtual CPU 8
Storage space 500 GB
Virtual Network Interfaces 1
Throughput 1 Gbps


The memory and hard disk requirements specified above are for deploying NetScaler Console 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.

Configuring VMware NSX

  • Create a pool of NetScaler VPX instances of different capacities, which are added to the different service packages.

For example:

  • 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.

  1. 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).

    Configure port group in vSphere client

  2. Create a new interface for each NetScaler VPX instance, and attach it to the VLAN range trunk port group that was created above.

    NSVPX-ESX settings

  3. 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.

    Create a VLAN port group in vSphere client

Adding NetScaler VPX Instance in NetScaler Console

Add NetScaler VPX instances in NetScaler Console and specify the VLAN range of the trunked group for each device.

  1. In NetScaler Console, navigate to Infrastructure > Instances > NetScaler VPX, and click Add.

  2. 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.

  3. Click OK.

  4. 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.

    Configure Interfaces for Orchestration

  5. On the Interfaces page, select the management interface, and click Disable to disable VLAN from binding to the management interface.

    Disable VLANs for interfaces

  6. On the Interfaces page, select the required interface, and click Configure VLAN Range.

  7. Enter the VLAN range configured in NSX Manager, click OK, and then click Close.

    Configure VLAN Range

Registering VMware NSX Manager with NetScaler Console

Register VMware NSX manager with NetScaler Console to create a communication channel between them.

  1. In NetScaler Console, navigate to OrchestrationSDN  Orchestration > VMware NSX Manager from the drop-down list, and click Configure NSX Manager Settings.

  2. On Configure NSX Manager Settings page, set the following parameters:

    1. NSX Manager IP Address - IP address of NSX Manager.

    2. NSX Manager user name - Administrative user name of NSX Manager.

    3. Password - Password of the administrative user of NSX Manager.

  3. In NetScaler Console account used by NSX Manager section, set the NetScaler Driver user name and Password for the NSX Manager. NetScaler Console authenticates load balancer configuration requests from the NSX Manager by using these logon credentials.

  4. Click OK.

  5. Navigate to Orchestration > System > Deployment Settings. Provide the VLAN range which was configured in trunked port group.

    Deployment settings for VLAN network

  6. Log on to the NSX Manager on vSphere Web Client, and navigate to Service Definitions > Service Managers.

    You can view Citrix NetScaler Console 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 Console.

    View deployed VLAN settings

Creating a Service Package in NetScaler Console

  1. In NetScaler Console, navigate to  OrchestrationSDN  Orchestration > VMware NSX Manager > Service Packages, and click Add to add a new service package.

  2. On Service Package page, in Basic Settings section, set the following parameters:

    1. Name – type the name of a service package

    2. Isolation Policy – by default, the isolation policy is set to Dedicated

    3. Device Type – by default, the device type is set to NetScaler VPX


      These values are set by default in this version, and you cannot modify them.

    4. Click Continue.

      Service Package

  3. In Assign Devices section, select the pre-provisioned VPX for this package, and click Continue.

  4. In Publish Service Package section, click Continue to publish the service package to VMware NSX, and then click Done.

    Service Package

    Publish Service Package

    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 Console.

  5. Log on to the NSX Manager on vSphere Web Client, and navigate to Service Definitions > Services.

    You can see that the NetScaler Console service package is registered.

    View the NetScaler Console service Package

Performing Load Balancer Service Insertion for Edge

Perform load balancer service insertion on the previously created NSX Edge gateway (offload the load balancing function from NSX LB to NetScaler).

  1. In NSX Manager, navigate to Home > NSX Edges, and select the edge gateway that you have configured.

    NSX Edges

  2. Click Manage, and on the Load Balancer tab, select Global Configuration, and click Edit.

    Global configuration

  3. Select Enable Load Balancer, Logging, Enable Service Insertion to enable them.

    1. In Service Definition, select the service package that was created in NetScaler Console and published to NSX Manager.

      Service Definition

  4. Select the existing runtime NICs and click the Edit icon to edit runtime NICs that have to be connected when NetScaler VPX is allocated.

    Runtime NICs

  5. Edit the name of the NIC, specify Connectivity Type as Data, and click Change.

    Edit the NIC name

  6. Select the appropriate web logical switch.

    Select the logical switch

  7. In Primary IP Allocation Mode, select IP Pool from the drop-down list, and click the down-arrow button on IP Pool field.

    Primary IP Allocation Mode

  8. In the Select IP Pool window, select the appropriate IP pool, and click OK.

    Select IP Pool

    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.


    All data interfaces are connected as run-time NICs, and they are part of interfaces for DLR.

  9. Refresh the view to see the creation of the run time.

    Refresh to view the NIC creation

    Refresh to view the NIC creation

  10. After the VM has started, the value of Status changes to In Service and that of Install State changes to Enabled.

    In Service


    In NetScaler Console, navigate to Orchestration > Requests to see progress details of completion of LB service insertion.

Viewing L2 Gateway on NSX Manager

  1. Log on to the NSX Manager on vSphere Web Client, navigate to NSX Edges, and select the DLR created.

    View L2 Gateway on NSX Manager

  2. In the DLR page, navigate to Manage > Bridging. You can see the L2 gateway displayed in the list.



    An L2 gateway gets created for each data interface.

Viewing Allotted NetScaler

  1. Log on to the NetScaler VPX instance using the IP address displayed in NetScaler Console.  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.

    Configure IP address

    The subnet IP address is same as the IP address of the web interface added in the NSX.

    Configure the Subnet IP address

  2. Navigate to Configuration > System > Licenses to view the licenses that are applied to this instance.

Configuring NetScaler VPX Instance Using StyleBook

  1. In NetScaler Console, navigate to OrchestrationSDN 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.

  2. 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.

  3. Specify values for all the required parameters.

    Specify the Load Balancer parameters

  4. Specify the NetScaler VPX instance on which you want to run these configuration settings.

    Specify the target instance

  5. Select the IP instance noted earlier, and click Select.

    Specify the IP instance

  6. Click Create to apply the configuration on the selected device.

    Create a config pack

Viewing Load Balancer Configuration

  1. Log on to the NetScaler VPX instance, navigate to Configuration > Traffic Management > Load Balancing to view the load balancing virtual server that is created.

    View the load balancer configuration

    You can also view the service groups that are created.

    View Service Groups

  2. Select the service group, and click Manage Members. The Configure Service Group Member page displays the members associated with the service group.

    Configure Service Group Member

Deleting Load Balancer Service

  1. In NetScaler Console, navigate to Applications > Configuration, and click X icon to delete the application configuration.

  2. Log on to the NSX Manager on vSphere Web Client and navigate to the edge gateway to which the NetScaler VPX instance is connected.

  3. Navigate to the Manage > Load Balancer > Global Configuration, right-click on the runtime entry, and click Unprovision.


    Edge Gateways in NetScaler Console corresponds to runtime entries in NSX manager.


    The NetScaler VPX instance is rendered out of service.

  4. In NetScaler Console, navigate to OrchestrationSDN Orchestration > Configure NSX Manager > Edge Gateways. Verify that the respective mapping of Edge Gateway to the deleted instance is not present.