NetScaler Console service

Install a NetScaler agent on Microsoft Azure cloud

The agent works as an intermediary between the NetScaler Console and the managed instances in the enterprise data center, or on the cloud.

To install the NetScaler agent on the Microsoft Azure cloud, you have to create an instance of the agent in the virtual network. Obtain the NetScaler agent image from the Azure Marketplace, and then use the Azure Resource Manager portal to create the agent.

Before you begin creating the NetScaler agent instance, make sure that you have created a virtual network with the required subnets where the instance resides. You can create virtual networks during VM provisioning, but without the flexibility to create different subnets. For information about creating virtual networks, see

Configure DNS server and VPN connectivity that allows a virtual machine to access Internet resources.


Make sure that you have the following:

  • A Microsoft Azure user account
  • Access to Microsoft Azure Resource Manager


  • We recommend that you create resource group, network security group, virtual network, and other entities before you provision the NetScaler agent virtual machine, so that the network information is available during provisioning.
  • For the NetScaler agent to communicate with NetScaler Console and the NetScaler instances, ensure that the recommended ports are open. For complete details about the port requirements for the NetScaler agent, see Ports.

To install the NetScaler agent on Microsoft Azure Cloud:

  1. Log on to the Azure portal ( by using your Microsoft Azure credentials.

  2. Click +Create a resource.

  3. Type NetScaler agent in the search bar and select NetScaler agent.

    Azure networking pane

  4. Click Create.

    Create Resource Manager

  5. In the Create virtual machine pane, specify the required values in each section to create a virtual machine.


    In this tab, specify Project details, Instance details, and Administrator account.

    Create virtual machine

    • Resource group – Select the resource group that you have created from the drop-down list.


      You can create a resource group at this point, but we recommend that you create a resource group from Resource groups in the Azure Resource Manager and then select the group from the drop-down list.

    • Virtual machine name – Specify a name for the NetScaler agent instance.

    • Region - Select the region where you want to deploy an agent.

    • Availability options – Select the availability set from the list.

    • Image - This field displays the already selected agent image. If you want to change to a different agent image, select the required image from the list.

    • Size - Specify the type and size of the virtual disk for deploying your NetScaler agent.

      Select the Supported virtual disk type (HDD or SSD) from the list.

      For more information about supported virtual disk sizes, see Agent installation requirements and Lightweight agent for pooled licensing.

    • Authentication Type – Select Password.

    • User name and Password – Specify a user name and password to access the resources in the resource group that you have created.


      We recommend you specify your own user name and password for your agent. Do not use nsrecover or nsroot as the user name because they are reserved for agent users.


    In this tab, specify Disk options and Data disks.

    Specify disks information

    • OS disk type - Select the virtual disk type (HDD or SSD).


    Specify the required networking details:

    Specify Networking

    • Virtual network – Select the virtual network.
    • Subnet – Set the subnet address.
    • Public IP address - Optional, select the IP address.
    • Network security group – Optional, select the security group that you have created.
    • Select inbound ports - If you allow public inbound ports, ensure the inbound and outbound rules are configured in the security group. Then, select the inbound ports from the list. For more details, see Prerequisites.


    Ensure that agent has Internet access.


    Specify Azure Security Center, Monitoring, and Identity.

    Specify Management


    Optional, specify Extensions, Custom Data, and Proximity placement group.

    Specify Advanced


    In Custom Data, specify the Service-URL and Activation code that you copied from the Set Up Agents page in NetScaler Console as instructed in Getting Started. Enter the details in the following format:

    registeragent -serviceurl <apigatewayurl> -activationcode <activationcodevalue>

    Agent uses this information to auto-register with the NetScaler Console during boot-up.

    If you specify this auto-registration script, skip step 7 and 8.


    Type the key-value pair for the NetScaler agent tags. A tag consists of a case-sensitive key-value pair. These tags enable you to organize and identify the agent easily. The tags are applied to both Azure and NetScaler Console.

    Specify Tags

    The configuration settings are validated and the Review and create tab displays the result of the validation.

    • If the validation fails, this tab displays the reason for the failure. Go back to the particular section and make changes as required.
    • If the validation passes, click Create. The agent deployment process begins.

      VM summary

      The deployment process might take approximately 10–15 minutes. Once the deployment is successfully completed, you can view your NetScaler agent virtual machine in your Microsoft Azure account.

    Deploy VM

  6. Once the agent is up and running, use an SSH client to log on to your NetScaler agent. Use the user name and password that was specified during the virtual machine creation.

  7. Run the deployment script by typing the command at the shell prompt:

  8. Enter the Service-URL and the Activation code that you copied and saved from the Set Up Agents page in NetScaler Console as instructed in Getting Started. The agent uses the service URL to locate the service and the activation code to register with the service.

    Register agent

After agent registration is successful, the agent restarts to complete the installation process.

After the agent has restarted, access NetScaler Console and on the Set Up Agent page, under Discovered Agents, verify the status of the agent.

Install a NetScaler agent on Microsoft Azure cloud