Adding instances
You can add instances either while setting up the NetScaler ADM for the first time or later.
Instances are NetScaler ADC appliances or virtual appliances that you want to discover, manage, and monitor from NetScaler ADM. You can add the following NetScaler ADC appliances and virtual appliances to NetScaler ADM:
- NetScaler MPX
- NetScaler VPX
- NetScaler SDX
- NetScaler CPX
- NetScaler BLX
- NetScaler Gateway
- Citrix Secure Web Gateway
To add instances, you must specify either the host name or IP address of each NetScaler instance, or a range of IP addresses.
Specify an instance profile that NetScaler ADM can use to access the instance. This instance profile contains the user name and password of the instances that you want to add to the service. For each instance type, a default profile is available. For example, the ns-root-profile is the default profile for NetScaler instances. The default NetScaler administrator credentials define this profile. If you have changed the default admin credentials of your instances, you can define custom instance profiles for those instances. If you change the credentials of an instance after the instance is discovered, you must edit the instance profile or create a profile, and then rediscover the instance.
You can access the GUIs of NetScaler instances from the NetScaler ADM after adding the instances in the NetScaler ADM. To access the NetScaler instances from the NetScaler ADM, you must be connected to the Citrix network.
Note
To add NetScaler instances configured in a cluster, you must specify either the cluster IP address or any one of the individual nodes in the cluster setup. However, on NetScaler ADM, the cluster IP address represents the cluster.
For the NetScaler instances set up as an HA pair, when you add one instance, the other instance in the pair is automatically added.
To make sure that the NetScaler user has all the privileges, assign superuser permissions to the user in NetScaler. For more information, see User, user groups, and command policies
To add a NetScaler instance to NetScaler ADM
Note
Perform this task to add all other ADC instances except the NetScaler CPX instance.
-
Navigate to Infrastructure > Instances > NetScaler. Under Instances, select the type of instance you want to add (for example, NetScaler VPX) and click Add.
-
Select one of the following options:
- Enter Device IP address - For NetScaler instances, specify either the host name or IP address of each instance, or a range of IP addresses.
- Import from file - From your local system, upload a text file that contains the IP addresses of all the instances you want to add.
-
(Optional) Select Enable Device addition on first time login failure. With this option, you can add the instance even without valid credentials.
-
From Profile Name, select the appropriate instance profile, or create a profile by clicking the + icon.
-
From Site, select the site where you want the instance to be added.
-
From Agent, select the agent with which you want to associate the instances, and then click OK.
If there is only one agent configured on your NetScaler ADM, that agent is selected by default.
To add NetScaler CPX instance in NetScaler ADM
-
Navigate to Infrastructure > Instances. Under Instances, select NetScaler and select the CPX tab.
-
Click Add.
-
Select one of the following options:
-
Enter Device IP address. Specify either the host name or IP address of each instance, or a range of IP addresses.
-
Import from file. From your local system, upload a text file that contains the IP addresses of all the instances you want to add.
-
-
(Optional) Select Enable Device addition on first time login failure. With this option, you can add the instance even without valid credentials.
-
In the Routable IP/Docker IP field, enter the IP address. The IP address can be either the NetScaler CPX instance (if it is reachable) or the Docker host.
-
In the Profile Name field, select the appropriate instance profile, or create a profile by clicking the + icon.
Note
When you are creating a profile, ensure to specify the HTTP, HTTPS, SSH, and SNMP port details of the host. You can also specify the range of ports that are published by the host in the Start Port and Number of ports field.
-
As an option, select the site where you want to deploy the CPX instance. You can create a site also by clicking Add.
-
If available, select the NetScaler ADM agent from the list of agents.
-
Click OK to initiate the process of adding instances to NetScaler ADM.
Note
If you want to rediscover an instance, perform the following steps:
- Navigate to Infrastructure > Instances > NetScaler > CPX.
- Select the instance you want to rediscover.
- From the Select Action list, click Rediscover.
To add a standalone NetScaler BLX instance in NetScaler ADM
A standalone NetScaler BLX instance is a single instance that is running on the dedicated host Linux server.
-
Navigate to Infrastructure > Instances > NetScaler.
-
In the BLX tab, click Add.
-
(Optional) Select Enable Device addition on first time login failure. With this option, you can add the instance even without valid credentials.
-
Select the Standalone option from the Instance Type list.
-
In the IP address field, specify the IP address of the BLX instance.
-
In the Host IP address field, specify the IP address of the Linux server where the BLX instance is hosted.
-
In the Profile Name list, select the appropriate profile for a BLX instance, or create a profile.
To create a profile, click Add.
Important
Ensure you have specified the correct host user name and password of the Linux server in the profile.
-
In the Site list, select the site where you want to add an instance.
If you want to add a site, click Add.
-
In the Agent list, select the NetScaler ADM agent to which you want to associate the instance.
If there is only one agent configured on your NetScaler ADM, that agent is selected by default.
-
Click OK.
To add high-availability NetScaler BLX instances in NetScaler ADM
The high-availability NetScaler BLX instances that run on different host Linux servers. A Linux server cannot host more than one BLX instances.
-
In the BLX tab, click Add.
-
(Optional) Select Enable Device addition on first time login failure. With this option, you can add the instance even without valid credentials.
-
Select the High Availability option from the Instance Type list.
-
In the IP address field, specify the IP address of the BLX instance.
-
In the Host IP address field, specify the IP address of the Linux server where the BLX instance is hosted.
-
In the Peer IP address field, specify the IP address of the peer BLX instance.
-
In the Peer Host IP address field, specify the IP address of the Linux server where the peer BLX instance is hosted.
-
In the Profile Name list, select the appropriate profile for a BLX instance, or create a profile.
To create a profile, click Add.
Important
Ensure you have specified the correct host user name and password of the Linux server in the profile.
-
In the Site list, select the site where you want to add an instance.
If you want to add a site, click Add.
-
In the Agent list, select the NetScaler ADM agent to which you want to associate the instance.
If there is only one agent configured on your NetScaler ADM, that agent is selected by default.
-
Click OK.
To access an instance GUI from the NetScaler ADM
-
Navigate to Infrastructure > Instances > NetScaler.
-
Select the type of instance you want to access (for example, VPX, MPX, CPX, SDX, or BLX).
-
Click the required NetScaler IP address or host name.
The instance IP addresses indicate the deployment type with the following notations:
-
In high-availability pair, P – Primary server and S – Secondary server.
-
C-Cluster
-
A-Autoscale Group
If an Instance has no notation, it indicates the standalone deployment.
The GUI of the selected instance appears in a pop-up window.
Resolve instance warnings
A warning sign appears on the instance for the following reasons:
-
Login failed - When you add an instance without valid credentials, it appears in DOWN state, with a Login failed warning. Specify the correct credentials to manage the instance in NetScaler ADM.
If the instance is unlicensed, the License option appears when you select the instance. Click License to apply the license to an instance from the license pool.
-
Unlicensed instance with HTTPS profile - If an unlicensed instance uses only HTTPS connection, apply license to an instance from the ADC GUI.