{"revision":"c10276e953456835cdbb1f3a60d58ae1980be353","document":{"id":31054,"path":"it-operations-management/itom-visibility/c_LoadBalancerCitrixNetscaler.md","title":"Citrix NetScaler load balancer discovery","bundle":null,"doc_type":null,"release":"australia","body":"\n# Citrix NetScaler load balancer discovery\n\nDiscovery and Service Mapping find Citrix NetScaler load balancers including Server Load Balancing \\(GSLB\\).\n\n**Note:** For information on Probe to Pattern migration see the knowledge article [KB0694477](https://support.servicenow.com/kb_view.do?sysparm_article=KB0694477).\n\n## Requirements and support\n\n**Important:** Discovery treats load balancers as licensable entities and attempts to discover them primarily using SNMP. If a load balancer in your system, running on a Linux host, has SNMP and SSH ports open, Discovery might classify it based on the SSH port. This classification has priority over SNMP. To ensure that Discovery properly classifies your hardware load balancers, create a Discovery behavior for load balancers that includes SNMP but not SSH. Software load balancers are treated as applications.\n\nVirtual NetScaler load balancers are not fully supported. Discovery supports local server load balancers and GSLB.\n\n## Credentials\n\n-   Configure [SNMP credentials](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-security/c_SNMPCredentials.md). The SNMP community string requires read-only access to the Citrix NetScaler MIB \\(`1.3.6.1.4.1.5951`\\).\n\n    **Note:** You also have the option of using [SSH credentials](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-security/r_SSHCredentialsForm.md). The SSH user requires permission to run NetScaler `show` commands only. However, if the payload size of the data that's returned to the instance is large, the discovery process can fail. In this case, use SNMP credentials instead.\n\n-   \\(Optional\\) When using the NS.CONF pattern, provide a user with read-only access to the **NS.conf** configuration file if you don't want to provide SNMP or SSH credentials.\n-   Use [basic authentication](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-security/r_BasicAuthCredentialsForm.md) credentials for discovery via REST. Configure the credential as a [credential alias](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-security/discovery-credential-alias.md). The NITRO API user requires read-only access to the following resources:\n    -   `lbvserver`\n    -   `csvserver`\n    -   `service`\n    -   `servicegroup`\n    -   `interface`\n    -   `lbvserver_binding`\n    -   `csvserver_binding`\n    -   `nspartition`\n    -   `nshardware`\n    -   `nshostname`\n    -   `nsconfig`\n    -   `hanode`\n\nFor a list of privileged commands that you need for Discovery and Service Mapping, see [Service Mapping commands requiring a privileged user](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/it-operations-management/service-mapping/r_CommandsnCredentials.md). This list includes commands that require elevated rights to discover and map Unix-based hosts in your organization.\n\n## Classifier, pattern, and probes\n\n<table id=\"table_bfh_4ks_rz\"><thead><tr><th>\n\nClassifier\n\n</th><th>\n\nTrigger probes\n\n</th><th>\n\nPatterns\n\n</th></tr></thead><tbody><tr><td>\n\nNetScaler Load Balancer\n\n</td><td>\n\n-   Horizontal discovery probe: launches patterns \\(see the Patterns column\\)\n-   NetScaler - Network Path Information \\(multiprobe\\)\n    -   NetScaler - ARP Information\n    -   NetScaler - Route Information\n-   SNMP - NetScaler - Identity\n-   SNMP - NetScaler - Identity - Serial\n-   SNMP - NetScaler - Identity Info\n-   SNMP - NetScaler - System\n\n</td><td>\n\n-   NetScaler Load Balancer\n-   NetScaler Load Balancer NS.CONF\n-   NetScaler Load Balancer SSH\n-   Netscaler Loadbalancer NITRO\n\n</td></tr></tbody>\n</table>To use probes for the horizontal discovery, make sure that the **NetScaler - Network Path Information** multiprobe is active on the **Trigger probes** related list for the **NetScaler Load Balancer** classifier. Then deactivate or remove the **Horizontal discovery** probe from the **Trigger probes** related list.\n\nTo use patterns, verify that the correct pattern is specified in the horizontal pattern probe on the classifier. See [Add the Horizontal Pattern probe to a classifier](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/it-operations-management/discovery/c-UsingPatternsForHorizontalDiscovery.md) for instructions.\n\n**Note:** When using probes and sensors and the system properties**glide.discovery.hostname.snmp\\_trusted** and/or **glide.discovery.hostname.dns\\_nbt\\_trusted** are set to false, the system uses **dns\\_name** as the load balancer name. When using the Netscaler Load Balancer pattern, the system currently doesn’t recognize these system properties when they are set to false.\n\n## Connections discovered by Service Mapping during the top-down discovery\n\nService Mapping performs the top-down discovery of the NetScaler Global Server Load Balancer in the context of application services. It discovers configured URLs of the NetScaler Global Server Load Balancer.\n\n## Data collected by Discovery during horizontal discovery\n\n|Table and field|Description|\n|---------------|-----------|\n|DNS name \\[cmdb\\_ci\\_dns\\_name\\]|\n|Name \\[name\\]|The name or the DNS name alias of the NetScaler Global Server Load Balancing \\(GSLB\\).|\n|IP address \\[ip\\_addresses\\]|Management IP address of the NetScaler Global Server Load Balancing \\(GSLB\\).|\n|Port \\[port\\]|The DNS port that Global Server Load Balancer listens to.|\n|Citrix NetScaler `[cmdb_ci_lb_netscaler]`|\n|Serial Number \\[serial\\_number\\]|The serial number of the NetScaler device and its current operational status.|\n|Operational Status \\[operational\\_status\\]|\n|Load Balancer Pool `[cmdb_ci_lb_pool]`|\n|Name \\[name\\]|The name of the pool and the method of load balancing it enables.|\n|Load Balancing Method \\[load\\_balancing\\_method\\]|\n|Load Balancer Pool Member `[cmdb_ci_lb_pool_member]`|\n|Name \\[name\\]|The name, IP address and service port that each pool member uses.|\n|IP Address \\[ip\\_address\\]|\n|Service Port \\[service\\_port\\]|\n|Load Balancer VLAN `[cmdb_ci_lb_vlan]`|\n|Name \\[name\\]|The name of the VLAN and the tag that is associated with this VLAN to identify it.|\n|Tag \\[tag\\]|\n|Load Balancer Services `[cmdb_ci_lb_service]`|\n|Name \\[name\\]|Details about the service running on the load balancer, including|\n|IP Address \\[ip\\_address\\]|\n|Port \\[port\\]|\n|Operational Status \\[operational\\_status\\]|\n|Install Status \\[install\\_status\\]|\n|Hit count \\[hit\\_count\\]|\n|Exit Interface Routing Rules `[dscy_route_interface]`|\n|Router Interface \\[router\\_interface\\]|Details about the routing rules for the exit interface, including the interface on the router that ...|\n|Configuration item \\[cmdb\\_ci\\]|\n|Destination IP network \\[dest\\_ip\\_network\\]|\n|Next Hop Routing Rules `[dscy_route_next_hop]`|\n|Next hop IP address \\[router\\_interface\\]|Details about the routing rules on the load balancer, including the IP addresses of the next hop router on the network. The Configuration item field is the router which is the next hop device.|\n|Router Interface \\[router\\_interface\\]|\n|Configuration item \\[cmdb\\_ci\\]|\n|Destination IP network \\[dest\\_ip\\_network\\]|\n\n<table id=\"table_dcm_kc3_zyb\"><tbody><tr><td>\n\nColumn name\n\n</td><td>\n\nType\n\n</td><td>\n\nReference\n\n</td></tr><tr><td>\n\nip\\_address\n\n</td><td>\n\nIP Address \\(Validated IPV4, IPV6\\)\n\n</td><td>\n\n \n\n</td></tr><tr><td>\n\nname\n\n</td><td>\n\nString\n\n</td><td>\n\n \n\n</td></tr><tr><td>\n\noperational\\_status\n\n</td><td>\n\nInteger\n\n</td><td>\n\n \n\n</td></tr><tr><td>\n\nserial\\_number\n\n</td><td>\n\nString\n\n</td><td>\n\n \n\n</td></tr></tbody>\n</table>Data collected during Netscaler Loadbalancer NITRO.\n\n<table id=\"table_ecm_kc3_zyb\"><tbody><tr><td>\n\nColumn label\n\n</td><td>\n\nColumn name\n\n</td><td>\n\nType\n\n</td><td>\n\nReference\n\n</td></tr><tr><td>\n\nConfiguration Item\n\n</td><td>\n\ncmdb\\_ci\n\n</td><td>\n\nReference\n\n</td><td>\n\nConfiguration Item \\(Load Balancer\\)\n\n</td></tr><tr><td>\n\nSerial Number\n\n</td><td>\n\nserial\\_number\n\n</td><td>\n\nString\n\n</td><td>\n\n \n\n</td></tr><tr><td>\n\nSerial Number Type\n\n</td><td>\n\nserial\\_number\\_type\n\n</td><td>\n\nString\n\n</td><td>\n\n \n\n</td></tr><tr><td>\n\nValid\n\n</td><td>\n\nvalid\n\n</td><td>\n\nTrue/False\n\n</td><td>\n\n \n\n</td></tr></tbody>\n</table><table id=\"table_fcm_kc3_zyb\"><tbody><tr><td>\n\nColumn label\n\n</td><td>\n\nColumn name\n\n</td><td>\n\nType\n\n</td><td>\n\nReference\n\n</td></tr><tr><td>\n\nLoad balancer\n\n</td><td>\n\nload\\_balancer\n\n</td><td>\n\nReference\n\n</td><td>\n\nConfiguration Item \\(Load Balancer\\)\n\n</td></tr><tr><td>\n\nName\n\n</td><td>\n\nname\n\n</td><td>\n\nString\n\n</td><td>\n\n \n\n</td></tr><tr><td>\n\nTag\n\n</td><td>\n\ntag\n\n</td><td>\n\nInteger\n\n</td><td>\n\n \n\n</td></tr></tbody>\n</table><table id=\"table_gcm_kc3_zyb\"><tbody><tr><td>\n\nColumn label\n\n</td><td>\n\nColumn name\n\n</td><td>\n\nType\n\n</td><td>\n\nReference\n\n</td></tr><tr><td>\n\nLoad balancer\n\n</td><td>\n\nload\\_balancer\n\n</td><td>\n\nReference\n\n</td><td>\n\nConfiguration Item \\(Load Balancer\\)\n\n</td></tr><tr><td>\n\nName\n\n</td><td>\n\nname\n\n</td><td>\n\nString\n\n</td><td>\n\n \n\n</td></tr><tr><td>\n\nOperational status\n\n</td><td>\n\noperational\\_status\n\n</td><td>\n\nInteger\n\n</td><td>\n\n \n\n</td></tr><tr><td>\n\nMAC Address\n\n</td><td>\n\nmac\\_address\n\n</td><td>\n\nString\n\n</td><td>\n\n \n\n</td></tr></tbody>\n</table><table id=\"table_hcm_kc3_zyb\"><tbody><tr><td>\n\nColumn label\n\n</td><td>\n\nColumn name\n\n</td><td>\n\nType\n\n</td><td>\n\nReference\n\n</td></tr><tr><td>\n\nIP Address\n\n</td><td>\n\nip\\_address\n\n</td><td>\n\nIP Address \\(Validated IPV4, IPV6\\)\n\n</td><td>\n\n \n\n</td></tr><tr><td>\n\nLoad balancer\n\n</td><td>\n\nload\\_balancer\n\n</td><td>\n\nReference\n\n</td><td>\n\nConfiguration Item \\(Load Balancer\\)\n\n</td></tr><tr><td>\n\nName\n\n</td><td>\n\nname\n\n</td><td>\n\nString\n\n</td><td>\n\n \n\n</td></tr><tr><td>\n\nPort\n\n</td><td>\n\nport\n\n</td><td>\n\nInteger\n\n</td><td>\n\n \n\n</td></tr></tbody>\n</table><table id=\"table_icm_kc3_zyb\"><tbody><tr><td>\n\nColumn label\n\n</td><td>\n\nColumn name\n\n</td><td>\n\nType\n\n</td><td>\n\nReference\n\n</td></tr><tr><td>\n\nLoad balancer\n\n</td><td>\n\nload\\_balancer\n\n</td><td>\n\nReference\n\n</td><td>\n\nConfiguration Item \\(Load Balancer\\)\n\n</td></tr><tr><td>\n\nName\n\n</td><td>\n\nname\n\n</td><td>\n\nString\n\n</td><td>\n\n \n\n</td></tr></tbody>\n</table><table id=\"table_jcm_kc3_zyb\"><tbody><tr><td>\n\nColumn label\n\n</td><td>\n\nColumn name\n\n</td><td>\n\nType\n\n</td><td>\n\nReference\n\n</td></tr><tr><td>\n\nIP Address\n\n</td><td>\n\nip\\_address\n\n</td><td>\n\nIP Address \\(Validated IPV4, IPV6\\)\n\n</td><td>\n\n \n\n</td></tr><tr><td>\n\nLoad balancer\n\n</td><td>\n\nload\\_balancer\n\n</td><td>\n\nReference\n\n</td><td>\n\nConfiguration Item \\(Load Balancer\\)\n\n</td></tr><tr><td>\n\nName\n\n</td><td>\n\nname\n\n</td><td>\n\nString\n\n</td><td>\n\n \n\n</td></tr><tr><td>\n\nPool\n\n</td><td>\n\npool\n\n</td><td>\n\nReference\n\n</td><td>\n\nLoad Balancer Pool\n\n</td></tr><tr><td>\n\nService port\n\n</td><td>\n\nservice\\_port\n\n</td><td>\n\nInteger\n\n</td><td>\n\n \n\n</td></tr></tbody>\n</table>To see the DNS names and alases for a NetScaler load balancer, you must configure the form and add the **DNS Names for CIs** related list. DNS names also include aliases.\n\n**Note:** Discovery populates load balancer interface information that is necessary to map the [network path](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/it-operations-management/service-mapping/t_CheckNtwrkStrgPath.md) in Service Mapping.\n\n## Configuration item \\(CI\\) Relationships\n\nThese relationships are created to support NetScaler Global Server Load Balancer discovery:\n\n<table id=\"table_bhf_jis2_ycb\"><thead><tr><th>\n\nCI\n\n</th><th>\n\nRelationship\n\n</th><th>\n\nCI\n\n</th></tr></thead><tbody><tr><td>\n\nDNS name \\[cmdb\\_ci\\_dns\\_name\\]\n\n</td><td>\n\nUses:Used by\n\n</td><td>\n\nIP address\\[cmdb\\_ci\\_ip\\_addresses\\]\n\n</td></tr></tbody>\n</table>These relationships are created to support NetScaler Loadbalancer NITRO:\n\n<table id=\"table_syt_bc3_zyb\"><thead><tr><th>\n\nCI\n\n</th><th>\n\nRelationship\n\n</th><th>\n\nCI\n\n</th></tr></thead><tbody><tr><td>\n\nNetscaler \\[cmdb\\_ci\\_lb\\_netscaler\\]\n\n</td><td>\n\nOwns::Owned by\n\n</td><td>\n\ninterfaces\\[cmdb\\_ci\\_lb\\_interface\\]\n\n</td></tr><tr><td>\n\nNetscaler \\[cmdb\\_ci\\_lb\\_netscaler\\]\n\n</td><td>\n\nOwns::Owned by\n\n</td><td>\n\nvlan\\[cmdb\\_ci\\_lb\\_vlan\\]\n\n</td></tr><tr><td>\n\nNetscaler \\[cmdb\\_ci\\_lb\\_netscaler\\]\n\n</td><td>\n\nOwns::Owned by\n\n</td><td>\n\nservice groups\\[cmdb\\_ci\\_lb\\_pool\\]\n\n</td></tr><tr><td>\n\nservice groups\\[cmdb\\_ci\\_lb\\_pool\\]\n\n</td><td>\n\nOwns::Owned by\n\n</td><td>\n\nlbvservers\\[cmdb\\_ci\\_lb\\_pool\\_member\\]\n\n</td></tr><tr><td>\n\nservices \\[cmdb\\_ci\\_lb\\_service\\]\n\n</td><td>\n\nRuns on::Runs\n\n</td><td>\n\nNetscaler \\[cmdb\\_ci\\_lb\\_netscaler\\]\n\n</td></tr></tbody>\n</table>## NetScaler device sysName\n\nTo verify the NetScaler device sysName, check the snmp mib and verify the sysName value by running the command: `show snmp mib`.\n\nTo change the value of the sysName, run the command: `set mib -name <DNS_NAME or NAME_OF_THE_NETSCALER_LB>` to set the name of the SNMP MIB.\n\n**Parent Topic:**[Load balancer discovery](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/it-operations-management/itom-visibility/c_LoadBalancers.md)\n\n"}}