vmware vrealize operations management pack for · pdf file3 blue medora vmware vrealize...

VMWARE VREALIZE OPERATIONS MANAGEMENT PACK FOR

Citrix NetScaler

User Guide

2 Blue Medora VMware vRealize Operations Management Pack for Citrix NetScaler User Guide

NOTE: This document supports the version of each product listed, as well as all subsequent versions, until a new edition replaces it.

You can find the most up-to-date technical documentation on the Blue Medora support site at: http://support.bluemedora.com.

The Blue Medora website also provides the latest product updates. If you have comments about this documentation, submit your feedback to: [email protected].

1. Purpose ..................................................................................................................................................................... 32. Introduction to the Management Pack ...................................................................................... 3

2.1 How the Management Pack Collects Data ............................................................ 32.2 Data the Management Pack Collects .......................................................................... 32.3 Inventory Tree (Traversal Spec) .......................................................................................... 3

3. Dashboards ........................................................................................................................................................... 43.1 NetScaler Overview ....................................................................................................................... 43.2 NetScaler Health Investigation ........................................................................................... 53.3 NetScaler on VMware .................................................................................................................. 63.4 NetScaler on OSs ............................................................................................................................ 73.5 NetScaler Appliance Overview ........................................................................................... 83.6 NetScaler Virtual Server Overview .................................................................................. 9

4. Views .........................................................................................................................................................................105. Reports ...................................................................................................................................................................116. Alerts .........................................................................................................................................................................127. Analysis Badges ............................................................................................................................................128. Troubleshooting the Management Pack ...............................................................................13

8.1 Troubleshooting an Adapter Instance ......................................................................138.2 Testing Connection Failures ...............................................................................................138.3 Viewing System Log Files.....................................................................................................13

9. Appendix I: Metrics ....................................................................................................................................1410. Appendix II: Alerts, Symptoms, & Recommendations ........................................4711. Appendix III: Capacity Definitions ..........................................................................................48

TABLE OF CONTENTS


1. PurposeThe Blue Medora VMware vRealize Operations (vROps) Management Pack for Citrix NetScaler User Guide describes the primary features of the Management Pack for Citrix NetScaler, including dashboards, views, reports, metrics, and alerts that allow users to optimize the monitoring of their Citrix NetScaler resources from within vRealize Operations.

2. Introduction to the Management PackThe Management Pack for Citrix NetScaler is an embedded adapter for vRealize Operations (vROps) that monitors Citrix NetScaler remotely. The Management Pack retrieves data regarding Citrix NetScaler resources by connecting to each supported Citrix NetScaler instance.

This section includes the following topics:• How the Management Pack Collects Data• Data the Management Pack Collects

2.1 How the Management Pack Collects DataDuring each data collection cycle, the Management Pack opens a Nitro REST API connection to the configured Citrix NetScaler appliance and queries it to retrieve metrics regarding Citrix NetScaler resources.

The collection interval for the adapter instance resource determines how often the Management Pack collects data. The default collection interval is five minutes.

The Management Pack supports Autodiscovery and manual discovery of resources. When you enable Autodiscovery for an adapter instance, the Management Pack creates resources in vRealize Operations and collects data after the main collection query runs. If a new resource belongs to a resource kind that does not exist in vROps, the Management Pack creates the resource kind.

2.2 Data the Management Pack CollectsThe Management Pack can collect performance data, relationships (associations), and events for the following Citrix NetScaler resources:1. Adapter Instance2. NetScaler Appliance3. High Availability Group4. Load Balancing Virtual Server5. Load Balancing Service6. Target Server7. Global Service Load Balancing (GSLB) Site8. GSLB Virtual Server9. GSLB Service

2.3 Inventory Tree (Traversal Spec)The Inventory Tree (Traversal Spec) feature within vROps allows you to easily navigate your Citrix NetScaler environment. The hierarchical structure implicitly shows relationships among resource kinds and enables quick drill-downs to root-cause issues.

Figure 1: Example Traversal Spec


3. DashboardsDashboards are the primary user interface that allow users to monitor Citrix NetScaler resources from within vRealize Operations.

The following dashboards are available in the Management Pack:

• NetScaler Overview• NetScaler Health Investigation• NetScaler on VMware• NetScaler on OSs• NetScaler Appliance Overview• NetScaler Virtual Server Overview

3.1 NetScaler OverviewThe Overview dashboard provides at-a-glance heatmap views depicting the overall health of your NetScaler resources (Appliances, Virtual Servers, Load Balancing Services, etc.). Figure 2: NetScaler Overview Dashboard


3.2 NetScaler Health InvestigationThe NetScaler Health Investigation dashboard allows you to select a resource from the Environment Overview status view, which populates a list of alerts and KPIs for that resource.

Figure 3: NetScaler Health Investigation Dashboard


3.3 NetScaler on VMwareThe NetScaler on VMware dashboard allows you to select a Virtual Machine and related NetScaler resources to view KPIs for each resource kind.

Figure 4: NetScaler on VMware Dashboard


3.4 NetScaler on OSsThe NetScaler on OSs dashboard allows you to select an Operating System (OS) and related NetScaler resources to view KPIs for each resource kind.

NOTE: This dashboard requires EP Ops installed on the target servers, which is only supported by vROps 6.1+.

Figure 5: NetScaler on OSs


3.5 NetScaler Appliance OverviewThe NetScaler Appliance Overview dashboard allows you to select an Appliance to view its health and status information, a list of alerts, network throughput metrics, HA node status, and more.

Figure 6: NetScaler Appliance Overview Dashboard


3.6 NetScaler Virtual Server OverviewThe NetScaler Virtual Server Overview dashboard allows you to select Virtual Server to view its health and status information, a list of alerts, and network throughput metrics.

Figure 7: NetScaler Virtual Server Overview Dashboard


4. ViewsThe vROps Management Pack for Citrix NetScaler creates views that allow the user to view statistics of metrics for various Citrix NetScaler resources. The views help give a broad picture of the entire system, as opposed to a more in depth view.

The following views are available in the Management Pack:

• Citrix NetScaler Appliance Capacity• Citrix NetScaler Appliance Capacity and Time• Citrix NetScaler Appliance Health• Citrix NetScaler Appliance KPIs• Citrix NetScaler Appliance Throughput• Citrix NetScaler Service Capacity• Citrix NetScaler Service Capacity and Time• Citrix NetScaler Service Health• Citrix NetScaler Service KPIs• Citrix NetScaler Target Server Health• Citrix NetScaler Virtual Server Health• Citrix NetScaler Virtual Server KPIs• Citrix NetScaler Virtual Server Throughput

To access the Management Pack views, go to Environment > All Objects > Citrix NetScaler Adapter and double-click on the desired Object (resource). Select the Details tab, then Views. The available views for that resource are listed and can be selected.

Figure 8: Accessing Management Pack Views


5. ReportsThe vROps Management Pack for Citrix NetScaler contains custom reports, as listed below. Most reports contain one or more of the views listed in section “4. Views” These reports can be exported and easily shared with key stakeholders in either .pdf or .csv formats.

The following reports are available in the Management Pack:

• Citrix NetScaler Health• Citrix NetScaler Capacity• Citrix NetScaler Applications• Citrix NetScaler KPIs• Citrix NetScaler Servers

To access the Management Pack reports, go to Environment > All Objects > Citrix NetScaler Adapter and double-click on the desired Object (resource). Select the Reports tab, then Report Templates.

Figure 9: Accessing Management Pack Reports

To run the selected report, click the Run Template icon ( ), then click Generated Reports, to select the report in your preferred format.


6. AlertsThe Management Pack for Citrix NetScaler pulls health status and events from Citrix NetScaler resources and displays them in vRealize Operations as alerts. Refer to section “10. Appendix II: Alerts, Symptoms, & Recommendations” for the full list of alerts, symptoms, and recommendations.

Figure 10: Alert Example

7. Analysis BadgesUsing the predictive analytics capabilities of the vROps Analysis Badges through capacity definitions, the Management Pack for Citrix NetScaler populates the capacity badge for the Appliance, Service, and GSLB Service resource kinds. For details, refer to section. “11. Appendix III: Capacity Definitions”.

Figure 11: Capacity Badge Example


8. Troubleshooting the Management PackKnown troubleshooting information can help you diagnose and correct common problems with the Management Pack for Citrix NetScaler.

This section includes the following topics:• Troubleshooting an Adapter Instance• Testing Connection Failures• Viewing System Log Files

8.1 Troubleshooting an Adapter InstancePerform these general troubleshooting steps to diagnose and correct problems with an adapter instance:

• Edit the adapter instance and click Test Connection to verify the connection to vROps. Refer to section “8.2 Testing Connection Failures”.• View the collection status and collection state for the adapter instance resource on the Environment Overview page in vROps.• Check the adapter and collector logs for errors. Refer to section “8.3 Viewing System Log Files”.

8.2 Testing Connection FailuresClick Test Connection in the Manage Solution window when adding an adapter instance to ensure data will be retrieved. The following errors are possible when testing the connection:

• “Error connecting to Netscaler.” Proposed action: Ensure the Citrix NetScaler appliance IP address is correct.

• “Error logging in to NetScaler.” Proposed action: Ensure the Citrix NetScaler User Name and Password are correct.

• “Unable to establish a valid connection to the system using SSL. Please confirm that the NetScaler Appliance is using uncompromised cipher suites. For more information see the user guide.”

Proposed action: Make sure the NetScaler server is configured to use uncompromised cipher suites. The RC4 cipher suite is considered compromised by vROps 6.2, and will not support data collection. Earlier versions of vROps may support it, but this is not recommended. Cipher suites can be set on the NetScaler server on the Configuration tab under Traffic Management > SSL > Cipher Groups.

• “Unable to establish a valid connection to the target system using SSL. For more information see the user guide.” Proposed action: Add the NetScaler Appliance server certificate to the Java truststore on the vROps machine, or set ‘Validate Certificate Against Truststore’ to False in the Manage Solution window.

8.3 Viewing System Log FilesYou can view adapter errors in the adapter and collector log files. You can view the adapter and collector log files in the vROps user interface or in an external log viewer.

The adapter log files are in the $ALIVE_BASE/user/log/adapters/CitrixNetScalerAdapter/ folder. The collector log files are in the $ALIVE_BASE/user/log/ folder.The logging level is set to ERROR by default. To troubleshoot issues, set the logging level to INFO. To view detailed messages, including micro steps, queries, and returned results, set the logging level to DEBUG.You can set the base log level for the collector via Administrator > Support > Logs > Select COLLECTOR folder > Select Edit Properties icon > Edit Root logger level.

NOTE: If you set the logging level to DEBUG, log files can become large very quickly. Set the logging level to DEBUG only for short periods of time.

For complete information about viewing log files and modifying log levels, refer to the vROps online help.


9. Appendix I: MetricsThe Management Pack for Citrix NetScaler collects the following metrics by Citrix NetScaler resource kinds.

Table 1: Management Pack Metrics

RESOURCE KIND RESOURCE GROUP

RESOURCE ATTRIBUTE

ATTRIBUTE TYPE

ATTRIBUTE DESCRIPTION

Citrix NetScaler Global Service Load Balancing Service

Configuration Site Per-sistence

string Use cookie-based site persistence. Applicable only to HTTP and SSL GSLB Services. Possibilities are: ConnectionProxy, HTTPRedirect, or NONE.


Configuration Max Band-width

float Integer specifying the maximum bandwidth allowed for the service. A GSLB Service whose bandwidth reaches the maximum is not considered when a GSLB decision is made, until its bandwidth consumption drops below the maximum.


Configuration Public IP string The public IP address that a NAT device translates to the GSLB Service's private IP address.


Configuration Max Clients float The maximum number of open connections that the service can support at any given time. Valid values range from 0 to 4294967294.


Configuration Protocol string The type of service. The default is NSSVC_SERVICE_UNKNOWN. Possibilities are: HTTP, FTP, TCP, UDP, SSL, SSL_BRIDGE, SSL_TCP, NNTP, ANY, SIP_UDP, SIP_TCP, SIP_SSL, RADIUS, RDP, RTSP, MYSQL, MSSQL, or ORACLE.


Configuration Effective State

string Effective state of the GSLB Service. Possibilities are: UP, DOWN, UNKNOWN, BUSY, OUT OF SERVICE, GOING OUT OF SERVICE, DOWN WHEN GOING OUT OF SERVICE, NS_EMPTY_STR, Unknown, or DISABLED.


Configuration Public Port integer The public port associated with the GSLB Service's public IP address.


Configuration Server Name

string The name of the server hosting this GSLB Service.


Configuration Type string GSLB type. The default is GSLB. Possibilities are: REMOTE or LOCAL.


Configuration Name string Name for the Service. Can be changed after the name is created.


Configuration Client Tim-eout

integer Idle time, in seconds, after which a client connection is terminated. Applicable if connection proxy based site persistence is used. Valid values range from 0 to 31536000.



RESOURCE ATTRIBUTE

ATTRIBUTE TYPE



Configuration Monitor Threshold

integer Monitoring threshold value for the GSLB Service. If the sum of the weights of the monitors that are bound to this GSLB Service and are in the UP state is not equal to or greater than this threshold value, the service is marked as DOWN. Valid values range from 0 to 65535.


Configuration Site Name string The name of the GSLB Site to which this GSLB Service belongs.


Configuration Server Tim-eout

float Idle time, in seconds, after which a server connection is terminated. Valid values range from 0 to 31536000.


Configuration Service Enabled

string Whether or not the service is enabled.


Configuration Max Users float Maximum number of SSL VPN users that can be logged on concurrently to the VPN virtual server that is represented by this GSLB Service.


Configuration Canonical Name

string Canonical name of the GSLB Service.


Statistics Virtual Serv-er Service Hits

float Number of times that the Service has been provided.


Statistics Request Data Rate

float Rate (/s) counter for 'Total Request Data'.


Statistics Virtual Serv-er Service Hits Rate

float Rate (/s) counter for 'Virtual Server Service Hits'.


Statistics Total Re-sponse Data

float Number of response bytes received by this Service.


Statistics Established Connections

float Number of client connections in ESTABLISHED state.


Statistics Requests Rate

float Rate (/s) counter for 'Total Requests'.


Statistics Total Re-quests

float Total number of requests received on this Service.


Statistics Total Re-sponses

float Number of responses received on this Service.



RESOURCE ATTRIBUTE

ATTRIBUTE TYPE



Statistics Current Server Con-nections

float Number of current connections to the actual servers behind the Virtual Server.


Statistics Current Load

float Load on the service that is calculated from the bound load based monitor.


Statistics Current Cli-ent Connec-tions

float Number of current client connections.


Statistics Responses Rate

float Rate (/s) counter for 'Total Responses'.


Statistics Total Re-quest Data

float Total number of request bytes received on this Service.


Statistics Response Data Rate

float Rate (/s) counter for 'Total Response Data'.

Citrix NetScaler Target Server

Configuration Translation IP

string IP address used to transform the server's DNS-resolved IP address.


Configuration Max Band-width

float Maximum bandwidth, in Kbps, allocated for all the services in the service group. Valid values range from 0 to 4294967287.


Configuration Max Clients float Maximum number of simultaneous open connections for the service group. Valid values range from 0 to 4294967294.


Configuration Idle Server Timeout

integer Time, in seconds, after which to terminate an idle server connection. Valid values range from 0 to 31536000.


Configuration Tcp Buffer-ing Enabled

string Whether or not TCP buffering is enabled for the service group.


Configuration Appflow Log Enabled

string Whether or not logging of AppFlow information for the specified service group is enabled. The default is TRUE.


Configuration Graceful Shutdown Enabled

string Whether or not the server shuts down gracefully, without accepting any new connections, and disabling each service when all of its connections are closed. The default is FALSE.


Configuration Custom Server Id

integer A positive integer to identify the service. Used when the persistency type is set to Custom Server ID. The default value: is 'None'.


Configuration Name string Name for the server. Can be changed after the name is created.


Configuration Initial State Enabled

string Initial state of the server. The default is TRUE.


Configuration Domain string Domain name of the server.



RESOURCE ATTRIBUTE

ATTRIBUTE TYPE



Configuration Client Connection Timeout

integer Time, in seconds, after which to terminate an idle client connection. Valid values range from 0 to 31536000.


Configuration Last State Change Time

string Time when last state change happened.



integer Minimum sum of weights of the monitors that are bound to this service. Used to determine whether to mark a service as UP or DOWN. Valid values range from 0 to 65535.


Configuration Client Keep Alive En-abled

string Whether or not client keep-alive is enabled for the service group.


Configuration Client IP Header Insertion Enabled

string Whether or not an HTTP header is inserted with the client's IPv4 or IPv6 address as its value before forwarding a request to the service. Used if the server needs the client's IP address for security, accounting, or other purposes, and setting the Use Source IP parameter is not a viable option.


Configuration Use Clients IP Enabled

string Whether or not the the client's IP address will be used as the source IP address when initiating a connection to the server.


Configuration Com-pression Enabled

string Whether or not compression is enabled on the server.


Configuration Domain Re-solve Retry

integer Time, in seconds, for which the NetScaler appliance must wait, after DNS resolution fails, before sending the next DNS query to resolve the domain name. The default is 5 seconds. Valid values range from 5 to 20939.


Configuration Down State Flush En-abled

string Whether or not delayed clean-up of connections to all services in the service group is enabled. The default is TRUE.


Configuration Domain Re-solve Now Boolean

string Immediately send a DNS query to resolve the server's domain name.


Configuration Max Re-quests

integer Maximum number of requests that can be sent on a persistent connection to the service group. It is important to note that any connection requests beyond this value are rejected. Valid values range from 0 to 65535.


Configuration Autoscale Mode

string Autoscale mode for the server. The default value is DISABLED. Possibilities are: DISABLED, DNS, or POLICY.


Configuration Surge Pro-tection On

string Whether or not surge protection is enabled for the service group. The default value is FALSE.


Configuration Sure Con-nect On

string Whether or not the SureConnect feature is enabled for the service group.



RESOURCE ATTRIBUTE

ATTRIBUTE TYPE



Configuration Cacheable Enabled

string Use the transparent cache redirection virtual server to forward the request to the cache server. The default is FALSE.


Configuration Client IP Header Name

string Name of the HTTP header whose value must be set to the IP address of the client. Used with the Client IP parameter. If client IP insertion is enabled, and the client IP header is not specified, the value of Client IP Header parameter or the value set by the set ns config command is used as client's IP header name.


Configuration IPv6 Sup-ported

string Support IPv6 addressing mode.


Configuration Delay float Time, in seconds, after which all the services configured on the server are disabled.


Configuration New Name string New name for the server.


Configuration Comment string Any information about the server.


Configuration Translation Mask

string The netmask of the translation IP.


Configuration Traffic Do-main Unique Identifier

integer Integer value that uniquely identifies the traffic domain in which you want to configure the entity. If you do not specify an ID, the entity becomes part of the default traffic domain, which has an ID of 0. Valid values range from 0 to 4094.

Citrix NetScaler Load Balancing Service

Configuration HTTP Com-pression Enabled

string Whether or not HTTP compression is enabled.


Configuration Maximum Bandwidth

float Maximum bandwidth, in Kbps, allocated to the service. Valid values range from 0 to 4294967287.


Configuration Service Type string The service type of the Citrix NetScaler Load Balancing Service.


Configuration Number of Connections

integer The number of client side connections that are still open.


Configuration Traffic Do-main ID

integer Integer value that uniquely identifies the traffic domain in which you want to configure the entity. If you do not specify an ID, the entity becomes part of the default traffic domain, which has an ID of 0. Valid values range from 0 to 4094.


Configuration AppFlow Logging Enabled

string Whether or not AppFlow logging is enabled.


Configuration Cache Type string Cache type supported by the cache server. Possibilities are: TRANSPARENT, REVERSE, or FORWARD.



RESOURCE ATTRIBUTE

ATTRIBUTE TYPE



Configuration Service Configura-tion Type 1

string The configuration type of the Service.


Configuration HTTP Profile Name

string Name of the HTTP profile that contains HTTP configuration settings for the service.


Configuration SSL Status string SSL status. Possibilities are: 'Certkey not bound' or 'SSL feature disabled'.


Configuration Insert Client IP Address

string Whether or not before forwarding a request to the server, the service inserts an HTTP header with the client's IPv4 or IPv6 address as its value. This is used if the server needs the client's IP address for security, accounting, or other purposes.


Configuration Health Mon-itor On

string Whether or not the NetScaler Appliance sends probes to check the health of a service.


Configuration TCP Profile Name

string Name of the TCP profile that contains TCP configuration settings for the Service.


Configuration Client Keep Alive En-abled

string Whether or not client keep-alive is enabled.


Configuration TCP Buffer-ing On

string Whether or not TCP buffering is used.


Configuration Ticks Since Last State Change

float Time in 10 millisecond ticks since the last state change.


Configuration Client IP Header

string Name for the HTTP header whose value must be set to the IP address of the client.


Configuration Monitor Owner View ID

float Tells the view id of the monitoring owner.


Configuration Down State Flush En-abled

string Whether or not the service will flush all active transactions when the state transitions from UP to DOWN. This should not be enabled for applications that must complete their transactions.


Configuration Database Specific Services IP

string This field has been introduced to show the database specific services IP.


Configuration SureCon-nect On

string Whether or not SureConnect is on.


Configuration Rise Apbr Status Mes-sage Code 1

integer The code indicating the rise apbr status.


Configuration Response Time

float Response time of this monitor.



RESOURCE ATTRIBUTE

ATTRIBUTE TYPE



Configuration Graceful Shutdown Delay

float Time, in seconds, allocated to the NetScaler Appliance for a graceful shutdown of the Service. During this period, new requests are sent to the service only for clients who already have persistent sessions on the appliance. Requests from new clients are load balanced among other available services. After the delay time expires, no requests are sent to the service, and the service is marked as unavailable (OUT OF SERVICE).


Configuration Comment string Any information about the Service.


Configuration Use Source IP Address

string Whether or not the service uses the client's IP address as the source IP address when initiating a connection to the server.


Configuration Rise Apbr Status Mes-sage Code 2

integer The code indicating other rise apbr status.


Configuration Port integer The port of the Citrix NetScaler Load Balancing Service.


Configuration Monitor State

string The running state of the monitor on this service. Possibilities are: UP, DOWN, UNKNOWN, BUSY, OUT OF SERVICE, GOING OUT OF SERVICE, DOWN WHEN GOING OUT OF SERVICE, NS_EMPTY_STR, Unknown, or DISABLED.


Configuration Weight float Weight to assign to the monitor-service binding. When a monitor is UP, the weight assigned to its binding with the service determines how much the monitor contributes toward keeping the health of the service above the value configured for the Monitor Threshold parameter. Valid values range from 1 to 100.


Configuration Public IP string The public IP of the Server.


Configuration Maximum Allowed Connections

float Maximum open connections allowed on this service. Valid values range from 0 to 4294967294.


Configuration Access Down On

string Whether or not Layer 2 mode is used to bridge the packets sent to this Service if 'Service State' is DOWN.


Configuration Hash ID float A numerical identifier that can be used by hash based load balancing methods. Must be unique for each service.


Configuration Monitor Owner

integer Tells the monitor owner of the service. Valid values range from 0 to 32.


Configuration Server Name

string The name of the server that hosts this Service.



RESOURCE ATTRIBUTE

ATTRIBUTE TYPE



Configuration Individual Path Moni-tor Enabled

string Whether or not individual path monitoring decisions are enabled.


Configuration Monitor Bound to Service

string Name of the monitor bound to this Service.


Configuration Path Moni-tor Enabled

string Whether or not path monitoring for clustering is enabled.


Configuration Name string The name of the Citrix NetScaler Load Balancing Service.



string Whether or not the initial state of the Service is enabled. The default is true.


Configuration Server Idle Timeout

integer Time, in seconds, after which to terminate an idle server connection. Valid values range from 0 to 31536000.



string The time when the last state change happened.


Configuration Clear Text Port

integer Port to which clear text data must be sent after the appliance decrypts incoming SSL traffic. Applicable to transparent SSL services. The minimum value is 1.



integer Minimum sum of weights of the monitors that are bound to this service. This is used to determine whether to mark a service as UP or DOWN. Valid values range from 0 to 65535.


Configuration DNS Profile Name

string Name of the DNS profile to be associated with the service. DNS profile properties will applied to the transactions processed by a service. This parameter is valid only for ADNS and ADNS-TCP services.


Configuration Server ID string The identifier for the service.


Configuration Service Configura-tion Type 2

string The configuration type of the service. Possibilities are: Internal, Dynamic, or Configured.


Configuration Last Re-sponse

string The string form of 'Monitor State Code'.


Configuration Graceful Enabled

string Whether or not the Service shuts down gracefully, not accepting any new connections, and disabling itself when all of its connections are closed.


Configuration Use Proxy Port

string Whether or not this service uses the proxy port as the source port when initiating connections with the server.



RESOURCE ATTRIBUTE

ATTRIBUTE TYPE



Configuration Maximum Requests

integer Maximum number of requests that can be sent on a persistent connection to the service. Connection requests beyond this value are rejected. Valid values range from 0 to 65535.


Configuration Global Ser-vice Load Balancer Option

string The GSLB option for the corresponding virtual server. Possibilities are: REMOTE or LOCAL.


Configuration State Up-date Reason

float Checks state update reason on the secondary node.



integer Time, in seconds, after which to terminate an idle client connection. Valid values range from 0 to 31536000.


Configuration Cache Serv-er Enabled

string Use the transparent Cache Redirection Virtual Server to forward requests to the Cache Server.


Configuration Monitor State Code

integer The code indicating the monitor response.


Configuration Network Profile

string Network profile to use for the Service.


Configuration Surge Protection Enabled

string Whether or not surge protection is enabled for the service.


Configuration Policy Name string The name of the policy for which this Service is bound.


Configuration New Name string New name for the Service.


Configuration Process Lo-cal Enabled

string Whether or not packets destined to the service will not undergo any steering. The default is false.


Configuration Session ID Remapping On

string Whether or not RTSP session ID mapping is on. The default is false.


Statistics Surge Queue Count

float Number of requests in the surge queue.





Statistics Current Idle Queue/Reuse Pool Requests

float Number of requests in the idle queue/reuse pool.


Statistics Average Service TTFB

float Average TTFB between the NetScaler appliance and the server. TTFB is the time interval between sending the request packet to a service and receiving the first response from the service



RESOURCE ATTRIBUTE

ATTRIBUTE TYPE




float Total number of requests received on this service or Virtual Server.



float Number of responses received on this service or Virtual Server.


Statistics Current Load

float Load on the service that is calculated from the bound load based monitor.


Statistics Service State

string The state of the Citrix NetScaler Load Balancing Service. Possibilities are: UP, DOWN, UNKNOWN, BUSY, OUT OF SERVICE, GOING OUT OF SERVICE, DOWN WHEN GOING OUT OF SERVICE, NS_EMPTY_STR, Unknown, or DISABLED.


Statistics Throughput float Number of bytes received or sent by this service (Mbps).



float Total number of request bytes received on this service or Virtual Server.


Statistics Response Rate

float Rate (/s) counter for 'Total Responses (data)'.



float Rate (/s) counter for 'Total Requests (data)'


Statistics Service Hits float Number of times that the service has been provided.



float Number of response bytes received by this service or Virtual Server.


Statistics Established Server Connection Count

float Number of server connections in ESTABLISHED state.


Statistics Service Hits Rate

float Rate (/s) counter for 'Service Hits'.








Statistics Active Transactions

float Number of active transactions handled by this service.


Statistics Response Rate


Citrix NetScaler Load Balancing Virtual Server

Configuration Spillover Backup Action

string Action to be performed if spillover is to take effect, but no backup chain to spillover is usable or exists. Possibilities are: DROP, ACCEPT, or REDIRECT.


Configuration IP Pattern string IP address pattern, in dotted decimal notation, for identifying packets to be accepted by the Virtual Server.



RESOURCE ATTRIBUTE

ATTRIBUTE TYPE



Configuration Service Type string The service type. Possibilities are: HTTP, UDP, FTP, TCP, SSL, SSL_BRIDGE, SSL_TCP, NNTP, DNS, DHCPRA, ANY, SIP_UDP, DNS_TCP, RTSP, PUSH, SSL_PUSH, RADIUS, RDP, MYSQL, MSSQL, DIAMETER, or SSL_DIAMETER.


Configuration Virtual Serv-er IP Port Insertion

string The virtual IP and port header insertion option for the Virtual Server. The following are the options: VIPADDR - Header contains the Virtual Server's IP address and port number without any translation, OFF - The virtual IP and port header insertion option is disabled, or V6TOV4MAPPING - Header contains the mapped IPv4 address corresponding to the IPv6 address of the Virtual Server and the port number. An IPv6 address can be mapped to a user-specified IPv4 address using the 'set ns ip6' command. Possibilities are: OFF, VIPADDR, or V6TOV4MAPPING.


Configuration ICMP Virtual Server Re-sponse

string How the NetScaler Appliance responds to ping requests received for an IP address that is common to one or more Virtual Servers. Available settings function as follows: If set to PASSIVE on all the Virtual Servers that share the IP address, the Appliance always responds to the ping requests. If set to ACTIVE on all the Virtual Servers that share the IP address, the Appliance responds to the ping requests if at least one of the Virtual Servers is UP. Otherwise, the Appliance does not respond. If set to ACTIVE on some Virtual Servers and PASSIVE on the others, the Appliance responds if at least one Virtual Server with the ACTIVE setting is UP. Otherwise, the Appliance does not respond. The default value is PASSIVE. Possibilities are: PASSIVE or ACTIVE.


Configuration IP Mask string IP mask, in dotted decimal notation, for 'IP Pattern'.


Configuration Priority Queueing

string Whether or not Priority Queuing is enabled on the Virtual Server. The default value is FALSE.


Configuration Disable Pri-mary When Down

string When this argument is enabled, traffic will continue reaching backup Virtual Servers even after primary comes UP from DOWN state. The default value is FALSE.


Configuration AppFlow Logging Enabled

string Whether or not AppFlow Logging is enabled or not. The default is TRUE.


Configuration Spillover Persistence Timeout

integer Timeout for spillover persistence, in minutes. The default is 2. Valid values range from 2 to 1440.



RESOURCE ATTRIBUTE

ATTRIBUTE TYPE



Configuration DNS 64 string Whether or not DNS64 is enabled on the Load Balancing Virtual Server.


Configuration HTTP Profile Name

string Name of the HTTP profile whose settings are to be applied to the Virtual Server.


Configuration Backup Vir-tual Server

string Name of the backup Virtual Server to which to forward requests if the primary Virtual Server goes DOWN or reaches its spillover threshold.


Configuration Minimum Autoscale Members

string Minimum number of members expected to be present when Virtual Server is used in Autoscale. The default is 0. Valid values range from 0 to 5000.



float The timeout value in seconds for idle client connection. The minimum value is 0 whereas the maximum value is 31536000.


Configuration Redirect Port Rewrite

string The state of port rewrite while performing HTTP redirect. The default value is FALSE.


Configuration Cookie Name

string Use this parameter to specify the cookie name for COOKIE peristence type. It specifies the name of cookie with a maximum of 32 characters. If not specified, cookie name is internally generated.


Configuration Database Specif-ic Load Balancer Enabled

string Whether or not database specific load balancing for MySQL and MSSQL service types is enabled.


Configuration Down State Flush

string Perform delayed clean up of connections on this Virtual Server. The default value is TRUE.


Configuration MAC Mode Retain VLAN

string This option is used to retain VLAN information of incoming packets when MAC Mode is enabled. The default is false.


Configuration Persistence Timeout

integer The time period in minutes for which the persistence is in effect for a specific client. The default value is 2. Valid values range from 0 to 1440.


Configuration Form Based Authentica-tion

string Whether or not user authentication is enabled. The default value is FALSE.


Configuration Spillover Method

string The spillover factor based on which the traffic will be given to the backup Virtual Server once the main Virtual Server reaches the spillover threshold. Possibilities are: CONNECTION, DYNAMICCONNECTION, BANDWIDTH, HEALTH, or NONE.



RESOURCE ATTRIBUTE

ATTRIBUTE TYPE



Configuration Response Rule

string Default syntax expression specifying which part of a server's response to use for creating rule based persistence sessions (persistence type RULE). Can be either an expression or the name of a named expression. The default is 'none'.


Configuration Comment string Any comments that you might want to associate with the Virtual Server.


Configuration Port integer The port of the Citrix NetScaler Load Balancing Virtual Server.


Configuration RTSP Nat-ting

string Whether or not natting is enabled for RTSP data connections. The default value is FALSE.


Configuration Authentica-tion Host

string Fully qualified domain name (FQDN) of the authentication virtual server to which the user must be redirected for authentication.


Configuration Range string Number of IP addresses that the appliance must generate and assign to the virtual server. The default is 1. Valid values range from 1 to 254.


Configuration Connection Failover Mode

string The current mode used in a Connection Failover. The default is DISABLED. Possibilities are: STATEFUL, STATELESS, or DISABLED.


Configuration Redir URL string URL to which to redirect traffic if the virtual server becomes unavailable.


Configuration Bypass AAAA En-abled

string Whether or not AAAA queries are not sent to back end DNS server while resolving DNS64 queries.


Configuration Push Label Expression

string Expression for extracting a label from the server's response. Can be either an expression or the name of a named expression. The default value is 'none'.


Configuration Traffic Do-main

integer Integer value that uniquely identifies the traffic domain configured for the Virtual Server. When an ID is not specified, it is automatically added to the default traffic domain (which has an ID of 0). Valid values range from 0 to 4094


Configuration Listen Pri-ority

string Integer specifying the priority of the listen policy. A higher number specifies a lower priority. The default is 101. Valid values range from 0 to 101.


Configuration Cacheable string Whether or not a Virtual Server, used for Load Balancing or Content Switching, routes requests to the cache redirection Virtual Server before sending it to the configured servers. The default value is FALSE.



RESOURCE ATTRIBUTE

ATTRIBUTE TYPE



Configuration Recursion Available

string Whether or not DNS replies from this Virtual Server have the RA bit turned on.


Configuration Load Balancing Method

string The load balancing method for the Virtual Server. Possibilities are: ROUNDROBIN, LEASTCONNECTION, LEASTRESPONSETIME, URLHASH, DOMAINHASH, DESTINATIONIPHASH, SOURCEIPHASH, SRCIPDESTIPHASH, LEASTBANDWIDTH, LEASTPACKETS, TOKEN, SRCIPDESTIPHASH, CUSTOMLOAD, SRCIPSRCPORTHASH, LRTM, or CALLIDHASSH.


Configuration Push Virtual Server

string Name of the load balancing Virtual Server, of type PUSH or SSL_PUSH, to which the server pushes updates received on the Load Balancing Virtual Server that you are configuring.


Configuration DNS Profile Name

string Name of the DNS profile to be associated with the Virtual Server.





Configuration IPv6 Sub-net Mask Length

string Number of bits to consider in an IPv6 destination or source IP address, for creating the hash that is required by the DESTINATIONIPHASH and SOURCEIPHASH load balancing methods. The default value is 128. Valid values range from 1 to 128.


Configuration Authoriza-tion Profile

string Name of the authentication profile to be used when authentication is turned on.


Configuration Listen Policy Expression

string Default syntax expression identifying traffic accepted by the Virtual Server. Can be either an expression or the name of a named expression. The default value is NONE.


Configuration Route Health Injec-tion State

string Route Health Injection (RHI) functionality of the NetSaler appliance for advertising the route of the VIP address associated with the virtual server. The default value is PASSIVE. Possibilities are: PASSIVE or ACTIVE.


Configuration Health Threshold

string Threshold in percent of active services below which Virtual Server state is made down. If this threshold is 0, Virtual Server state will be up even if one bound service is up. The default value is 0. Valid values range from 0 to 100.


Configuration Network Profile

string Name of the network profile to associate with the Virtual Server.



RESOURCE ATTRIBUTE

ATTRIBUTE TYPE



Configuration 401 Based Authentica-tion

string Whether or not user authentication with HTTP 401 responses is enabled. The default is FALSE.


Configuration Process Lo-cal Enabled

string By turning on this option packets destined to a Virtual Server in a cluster will not under go any steering.


Configuration Effective State

string Effective state of the Load Balancing Virtual Server based on the state of backup Virtual Servers. Possibilities are: UP, DOWN, UNKNOWN, BUSY, OUT OF SERVICE, GOING OUT OF SERVICE, DOWN WHEN GOING OUT OF SERVICE, NS_EMPTY_STR, Unknown, or DISABLED.


Configuration Service Name

string Service bound to this Virtual Server.


Configuration Persistence Backup Timeout

integer The maximum time backup persistence is in effect for a specific client. The default value is 2. Valid values range from 2 to 1440.


Configuration New Service Request

integer The number of requests/sec or percentage of requests/sec a new service should receive compared to the existing services. The maximum possible value for requests/sec is 65536 and percentage of requests is 100.


Configuration Push En-abled

string Whether or not traffic is processed with the push Virtual Server that is bound to this Load Balancing Virtual Server. The default value is FALSE.


Configuration Persistence Backup

string This specifies a backup persistence type for the Virtual Server. The backup persistence option is used when the primary configured persistence mechanism on a Virtual Server fails. Possibilities are: SOURCEIP or NONE.


Configuration Hash Length string Number of bytes to consider for the hash value used in the URLHASH and DOMAINHASH load balancing methods. The default is 80. Valid values range from 1 to 4096.


Configuration New Service Request Increment Interval

integer The interval in seconds after which the new services requests limit should be automatically increased. The minimum value is 0 whereas the maximum value is 3600.


Configuration Maximum Autoscale Members

string Maximum number of members expected to be present when Virtual Server is used in Autoscale. The default is 0. Valid values range from 0 to 5000.


Configuration TCP Profile Name

string Name of the TCP profile whose settings are to be applied to the Virtual Server.



RESOURCE ATTRIBUTE

ATTRIBUTE TYPE



Configuration Session-less Load Balancing Enabled

string Whether or not Sessionless Load Balancing is enabled. The default is disabled.


Configuration Persist AVP Number

string Persist AVP number for Diameter Persistency.


Configuration Persistence Type

string Persistence type for the Virtual Server. Possibilities are: SOURCEIP, COOKIEINSERT, SSLSESSION, RULE, URLPASSIVE, CUSTOMSERVERID, DESTIP, SRCIPDESTIP, CALLID, RTSPSID, DIAMETER, or NONE.


Configuration Persistence IPv4 Mask

string Specifies if the persistency is IP based.


Configuration Sure Con-nect

string Whether or not SureConnect is enabled on the Virtual Server. The default value is FALSE.


Configuration Load Bal-ancer Rea-son Code

integer Reason why a Virtual Server is in RR. The following are the reasons: 1 - MEP is DOWN (GSLB), 2 - LB method has changed, 3 - Bound service's state changed to UP, 4 - A new service is bound, 5 - Startup RR factor has changed, 6 - LB feature is enabled, 7 - Load monitor is not active on a service, 8 - Vserver is Enabled, 9 - SSL feature is Enabled, 10 - All bound services have reached threshold. Using effective state to load balance (GSLB), 11 - Primary state of bound services are not UP. Using effective state to load balance (GSLB), 12 - No LB decision can be made as all bound services have either reached threshold or are not UP (GSLB), 13 - All load monitors are active.


Configuration Layer 2 Pa-rameters

string Whether or not the Virtual Server uses L2 Parameters to identify a connection.


Configuration Weight integer Weight to assign to the specified service. Valid values range from 1 to 100.


Configuration TOS ID integer TOS ID of the virtual server. Applicable only when the load balancing redirection mode is set to TOS. Valid values range from 1 to 63.


Configuration Push Multi-ple Clients

string Whether or not multiple Web 2.0 connections from the same client are enabled.


Configuration Name string The name of the Citrix NetScaler Load Balancing Virtual Server.



RESOURCE ATTRIBUTE

ATTRIBUTE TYPE



Configuration Rule string Expression, or name of a named expression, against which traffic is evaluated. The default is 'none'.


Configuration Authoriza-tion Virtual Server Name

string Name of an authentication Virtual Server with which to authenticate users.


Configuration IPv4 Subnet Mask

string IPv4 subnet mask to apply to the destination IP address or source IP address when the load balancing method is DESTINATIONIPHASH or SOURCEIPHASH.


Configuration Data Offset integer Offset to be considered when extracting a token from the TCP payload. Applicable to virtual servers, of type TCP, using the token method of load balancing. Must be within the first 24 KB of the TCP payload. Valid values from 0 to 25400.


Configuration New Service Request Unit

string The unit for new service request value. The default value is NEWSVC_REQTYPE_REQS_PER_SEC. Possibilities are: PER_SECOND or PERCENT.


Configuration Total Ser-vices

integer Total number of services bound to the Virtual Server.


Configuration Data Length integer Length of the token to be extracted from the data segment of an incoming packet, for use in the token method of load balancing. The length of the token, specified in bytes, must not be greater than 24 KB. Applicable to virtual servers of type TCP. Valid values range from 1 to 100.


Configuration Database Profile Name

string Name of the DB profile whose settings are to be applied to the Virtual Server.


Configuration Inserted Header

string Name for the inserted header. The default name is vip-header.


Configuration Spillover Persistence

string Whether or not spillover persistence is enabled. The default value is FALSE.


Configuration Skip Per-sistency

string The behavior in case the service which is selected from an existing persistence session has reached threshold. The default is None. Possibilities are: Bypass, ReLb, or None.


Configuration Persistence IPv6 Mask Length

integer This value is set when using IP based persistence type on an IPv6 Virtual Server. The default value is 128. Valid values range from 1 to 128.



RESOURCE ATTRIBUTE

ATTRIBUTE TYPE



Configuration Load Balancer Redirection Mode

string The Load Balancer mode. If the value is specified as IP then the traffic is sent to the physical servers by changing the destination IP address to that of the physical server. If the value is MAC then the traffic is sent to the physical servers, by changing the destination MAC address to that of one of the physical servers, the destination IP is not changed. MAC mode is used mostly in Firewall Load Balancing scenario. The default value is NSFWD_IP. Possibilities are: IP, MAC, IPTUNNEL, or TOS.


Configuration Threshold Value

float Tells whether threshold exceeded for this service participating in CUSTOMLB.


Statistics Server Con-nections



Statistics Surge Queue Length

float Number of requests in the surge queue.


Statistics Deferred Request Rate

float Rate (/s) counter for 'Deferred Requests'.



float Total number of requests received on this Virtual Server.


Statistics Hits Rate float Rate (/s) counter for 'Total Hits'.


Statistics Current State

string Current state of the Virtual Server. Possibilities are: UP, DOWN, UNKNOWN, BUSY, OUT OF SERVICE, GOING OUT OF SERVICE, DOWN WHEN GOING OUT OF SERVICE, NS_EMPTY_STR, Unknown, or DISABLED.


Statistics Services Surge Queue Length

float Total number of requests in the surge queues of all the services bound to this Virtual Server.


Statistics Health float Health of the Virtual Server.


Statistics Total Pack-ets Sent

float Total number of packets sent.



float Total number of request bytes received on this Virtual Server.



RESOURCE ATTRIBUTE

ATTRIBUTE TYPE



Statistics Total Hits float Total Virtual Server hits.


Statistics Inactive Services

float number of INACTIVE services bound to a Virtual Server.


Statistics Packets Sent Rate

float Rate (/s) counter for 'Total Packets Sent'.


Statistics Invalid Requests or Responses

float Number invalid requests/responses on this Virtual Server.


Statistics Deferred Requests

float Number of deferred request on this Virtual Server.


Statistics Requests Waiting

float Number of requests waiting on this Virtual Server.


Statistics Invalid Requests or Responses Dropped

float Number invalid requests/responses dropped on this Virtual Server.


Statistics Active Ser-vices

float Number of ACTIVE services bound to a Virtual Server.


Statistics Labelled Connection

float Number of Labeled connection on this Virtual Server.



float Number of responses received on this Virtual Server.


Statistics Packets Received Rate

float Rate (/s) counter for 'Total Packets Received'.


Statistics Push Labels float Number of labels for this push Virtual Server.





Statistics Total Spill-overs

float Number of times Virtual Server experienced spillover.


Statistics Total Packets Received

float Total number of packets received by this Virtual Server.



float Number of response bytes received by this Virtual Server.



RESOURCE ATTRIBUTE

ATTRIBUTE TYPE






Statistics Total Back-up Diver-sions

float Number of times traffic was diverted to backup Virtual Server since primary Virtual Server was DOWN.





Statistics Client Con-nections



Statistics Connections in Estab-lished State



Statistics Spillover Threshold

float Spillover Threshold set on the Virtual Server.




Citrix NetScaler Global Service Load Balancing Virtual Server

Configuration Site Per-sistence

string Type of Site Persistence set. Possibilities are: ConnectionProxy, HTTPRedirect, or NONE.





Configuration Service Type string Protocol used by services bound to the Virtual Server.


Configuration Multiple IP Address-es in DNS Responses Enabled

string Whether or not this GSLB Virtual Server includes multiple IP addresses in the DNS responses sent to clients. The default is false.


Configuration Empty DNS Response Enabled

string Whether or not the GSLB Virtual Server sends clients an empty DNS response when its status is DOWN.


Configuration Load Balancing Round Rob-in Reason

integer Reason why a Virtual Server is in Round Robin.


Configuration App Flow Log Enabled

string Whether or not the logging of Appflow flow information is enabled.



RESOURCE ATTRIBUTE

ATTRIBUTE TYPE




string Whether or not the GSLB Virtual Server is enabled after creation.


Configuration Disable Primary On Down Enabled

string Whether or not to continue to direct traffic to the backup chain even after the primary GSLB Virtual Server returns to the UP state. Used when spillover is configured for the Virtual Server. The default is false.


Configuration Spill Over Persistence Enabled

string Whether or not if spillover occurs, maintain source IP address based persistence for both primary and backup GSLB Virtual Servers.


Configuration Total Ser-vices

float Total number of Services bound to the Virtual Server.


Configuration Persistence Type

string Use source IP address based persistence for the Virtual Server. After the load balancing method selects a service for the first packet, the IP address received in response to the DNS query is used for subsequent requests from the same client. Possilibities are: SOURCEIP or NONE.


Configuration Spill Over Persistence Timeout

integer Timeout for spillover persistence, in minutes. The default value is 2. Valid values range from 2 to 1440.


Configuration Load Balancing Method

string The load balancing method for the GSLB Virtual Server. The default value is LEASTCONNECTION. Possibilities are: ROUNDROBIN, LEASTCONNECTION, LEASTRESPONSETIME, SOURCEIPHASH, LEASTBANDWIDTH, LEASTPACKETS, STATICPROXIMITY, RTT, or CUSTOMLOAD.


Configuration Dynamic Weight Method

string Specifies if the Appliance should consider the service count, service weights, or ignore both when using weight-based load balancing methods. The state of the number of Services bound to the Virtual Server help the Appliance to select the Service. The default value is DISABLED. Possibilities are: SERVICECOUNT, SERVICEWEIGHT, or DISABLED.


Configuration Is cname Enabled

string Whether or not the cname feature is set on the Virtual Server.



RESOURCE ATTRIBUTE

ATTRIBUTE TYPE



Configuration Consider Effective State

string If the primary state of all bound GSLB Services is DOWN, consider the effective states of all the GSLB Services, obtained through the Metrics Exchange Protocol (MEP), when determining the state of the GSLB Virtual Server. To consider the effective state, set the parameter to STATE_ONLY. To disregard the effective state, set the parameter to NONE. The effective state of a GSLB Service is the ability of the corresponding Virtual Server to serve traffic. The effective state of the Load Balancing Virtual Server, which is transferred to the GSLB Service, is UP even if only one Virtual Server in the backup chain of Virtual Servers is in the UP state. The default value is NONE. Possibilities are: NONE or STATE_ONLY.


Configuration Back-up Load Balancing Method

string Backup load balancing method. Becomes operational if the primary load balancing method fails or cannot be used. Valid only if the primary method is based on either round-trip time (RTT) or static proximity. Possibilities are: ROUNDROBIN, LEASTCONNECTION, LEASTRESPONSETIME, SOURCEIPHASH, LEASTBANDWIDTH, LEASTPACKETS, STATICPROXIMITY, RTT, or CUSTOMLOAD.


Configuration Spill Over Method

string Type of threshold that, when exceeded, triggers spillover. Possibilities are CONNECTION, DYNAMICCONNECTION, BANDWIDTH, HEALTH, or NONE.


Configuration Dns Record Type

string DNS record type to associate with the GSLB Virtual Server's domain name. The default value is A. Possibilities are: A, AAAA, or CNAME.





Statistics Total Spill Overs

float Number of times that the GSLB Virtual Server experienced spill over.



float Number of response bytes received by this GSLB Virtual Server.


Statistics Established Connections




RESOURCE ATTRIBUTE

ATTRIBUTE TYPE



Statistics Total Hits float Total Virtual Server hits.






float Total number of requests received on this GSLB Virtual Server.


Statistics Spill Over Threshold

float Spill over threshold for the GSLB Virtual Server.



float Number of responses received on this GSLB Virtual Server.


Statistics Total Vir-tual Server Down Back-up Hits

float Number of times traffic was diverted to backup Virtual Server since primary Virtual Server was DOWN.


Statistics Inactive Services

float Number of INACTIVE services bound to the GSLB Virtual Server.


Statistics Hits Rate float Rate (/s) counter for 'Total Hits'.


Statistics Current State

string State of the GSLB Virtual Server. Possibilities are: UP, DOWN, UNKNOWN, BUSY, OUT OF SERVICE, GOING OUT OF SERVICE, DOWN WHEN GOING OUT OF SERVICE, NS_EMPTY_STR, Unknown, or DISABLED.



float Number of current connections to the Target Servers behind the Virtual Server.


Statistics Health float Health of Virtual Server based on percentage of weights of active Services/all Services.






RESOURCE ATTRIBUTE

ATTRIBUTE TYPE



Statistics Active Ser-vices

float Number of ACTIVE services bound to the GSLB Virtual Server.






float Total number of request bytes received on this GSLB Virtual Server.




Citrix NetScaler Appliance

Statistics Application Firewall Requests

float HTTP/HTTPS requests sent to protected web servers via the Application Firewall.


Statistics Number of CPUs

float The number of CPUs on the NetScaler appliance.


Statistics Compress-ible Data Received to Compressed Data Trans-mitted

float Ratio of compressible data received to compressed data transmitted. If this ratio is one (uncmp:1.0) that means compression is disabled or we are not able to compress even a single compressible packet.


Statistics Application Firewall Redirects Rate

float Rate (/s) counter for 'Application Firewall Redirects'.


Statistics TCP Current Server Connections established

float Current server connections in the Established state, which indicates that data transfer can occur between the NetScaler and the server.


Statistics Memory Usage

float Main memory currently in use, in megabytes.


Statistics Cache Total Misses

float Intercepted HTTP requests requiring fetches from origin server.


Statistics Received Rate

float Rate (/s) counter for 'Total Received'.


Statistics CPU Usage float CPU utilization percentage.


Statistics Resident CPU Usage

float Average CPU utilization percentage.


Statistics TCP Current Client Con-nections

float Client connections, including connections in the Opening, Established, and Closing state.



RESOURCE ATTRIBUTE

ATTRIBUTE TYPE



Statistics Application Firewall Aborts

float Incomplete HTTP/HTTPS requests aborted by the client before the Application Firewall could finish processing them.


Statistics Resident Memory Usage

float Percentage of memory utilization on NetScaler.


Statistics HTTP Responses Rate

float Rate (/s) counter for 'HTTP Total Responses'.


Statistics Memory Usage

float Percentage of memory utilization on NetScaler.


Statistics Application Firewall Aborts Rate

float Rate (/s) counter for 'Application Firewall Aborts'.


Statistics TCP Current Server Con-nections

float Server connections, including connections in the Opening, Established, and Closing state.


Statistics Cache per-cent origin bandwidth saved

float Percentage of origin bandwidth saved, expressed as number of bytes served from the integrated cache divided by all bytes served.


Statistics Manage-ment CPU Usage

float Management CPU utilization percentage.


Statistics SSL Trans-actions Rate

float Rate (/s) counter for 'SSL Total Transactions'.


Statistics Total HTTP Compres-sion Ratio

float Ratio of total HTTP data received to total HTTP data transmitted.


Statistics Application Firewall Redirects

float HTTP/HTTPS requests redirected by the Application Firewall to a different web page or web server.


Statistics HTTP Total Requests

float Total number of HTTP requests received.


Statistics Cache Hits Rate

float Rate (/s) counter for 'Cache Total Hits'.


Statistics HTTP Re-quests Rate

float Rate (/s) counter for 'HTTP Total Requests'.


Statistics Total Re-ceived

float Number of megabytes received by the NetScaler appliance.


Statistics Total Trans-mitted

float Number of megabytes transmitted by the NetScaler appliance.


Statistics HTTP Total Responses

float Total number of HTTP responses sent.


Statistics CPU Usage float CPU utilization percentage.



RESOURCE ATTRIBUTE

ATTRIBUTE TYPE



Statistics SSL Session Hits Rate

float Rate (/s) counter for 'SSL Total Session Hits'.


Statistics SSL Number of Cards Up

float Number of SSL cards that are UP.


Statistics Transition Time

string Time when the last master state transition occurred.


Statistics Disk 0 Us-age

float Used space in /flash partition of the disk, as a percentage.


Statistics High Avail-ability Cur-rent State

string State of the HA node, based on its health, in a high availability setup.


Statistics HTTP Received Request Rate

float Rate (/s) counter for 'HTTP Total Received Request'.


Statistics Cache Miss-es Rate

float Rate (/s) counter for 'Cache Total Misses'.


Statistics Cache Total Hits

float Responses served from the integrated cache.


Statistics Cache Max Memory Active

float Currently active value of maximum memory


Statistics Disk 1 Us-age

float Used space in /var partition of the disk, as a percentage.


Statistics SSL Total Session Hits

float Number of SSL session reuse hits on the NetScaler appliance.


Statistics HTTP Com-pression Ratio

float Ratio of the compressible data received from the server to the compressed data sent to the client.


Statistics Cache Utilized Memory

float Amount of memory the integrated cache is currently using.


Statistics HTTP Total Received Response

float Total number of bytes of HTTP response data received.


Statistics SSL Total Transactions

float Number of SSL transactions on the NetScaler appliance.


Statistics HTTP Total Received Request

float Total number of bytes of HTTP request data received.


Statistics Transmitted Rate

float Rate (/s) counter for 'Total Transmitted'.


Statistics SSL Cards float Number of SSL crypto cards present on the NetScaler appliance.


Statistics Cache Max Memory

float Largest amount of memory the NetScaler can dedicate to caching, up to 50% of available memory.



RESOURCE ATTRIBUTE

ATTRIBUTE TYPE



Statistics Application Firewall Requests Rate

float Rate (/s) counter for 'Application Firewall Requests'.


Statistics Application Firewall Responses

float HTTP/HTTPS responses sent by protected web servers via the Application Firewall.


Statistics Miscel-laneous Counter 1

float Miscellaneous Counter 1.


Statistics Miscel-laneous Counter 0

float Miscellaneous Counter 0.


Statistics Resident CPU Usage

float Shows average CPU utilization percentage if more than 1 CPU is present.


Statistics Cache 64 Max Mem-ory

float Largest amount of memory the NetScaler can dedicate to caching, up to 50% of available memory.


Statistics Packet En-gines CPU Usage

float Average CPU utilization percentage for all packet engines excluding management PE.


Statistics HTTP Received Response Rate

float Rate (/s) counter for 'HTTP Total Received Response'.


Statistics TCP Current Client Connections established

float Current client connections in the Established state, which indicates that data transfer can occur between the NetScaler and the client.


Statistics Disk 0 Space Avail-able

float Available space in /flash partition of the hard disk.


Statistics High Avail-ability Cur-rent Master State

string Indicates the high availability state of the node.


Statistics Start Time string Time when the NetScaler appliance was last started.


Statistics Disk 1 Space Avail-able

float Available space in /var partition of the hard disk.


Statistics Application Firewall Responses Rate

float Rate (/s) counter for 'Application Firewall Responses'.


High Availability

Master State string High Availability Master State. Possibilities are: Primary, Secondary, or UNKNOWN.


High Availability

Max Flips Count

float Max number of flips allowed before becoming sticky primary. The default value is 0.



RESOURCE ATTRIBUTE

ATTRIBUTE TYPE



High Availability

Dead Inter-val

integer Number of seconds after which a peer node is marked DOWN if heartbeat messages are not received from the peer node. The default value is 3. Valid values range from 3 to 60.


High Availability

Interfaces without heartbeats

string Interfaces on which non-multicast is not seen.


High Availability

Enabled Interfaces

string Enabled interfaces.


High Availability

Node State string The High Availability status of the node. Possibilities are: ENABLED, STAYSECONDARY, DISABLED, or STAYPRIMARY.


High Availability

Time in Master State

float Time elapsed in current master state.


High Availability

Hello Inter-val

integer Interval, in milliseconds, between heartbeat messages sent to the peer node. The heartbeat messages are UDP packets sent to port 3003 of the peer node. The default value is 200. Valid values range from 200 to 1000.


High Availability

High Availability Propagation Enabled

string Whether or not to automatically propagate all commands from the primary to the secondary node.


High Availability

Interfaces Monitored for Health Status

string Interfaces with High Availability monitor on.


High Availability

SSL Card Status

string SSL card status. Possibilities are: DOWN, UP, NOT PRESENT, or UNKNOWN.


High Availability

Current Flips Count

float Keeps track of number of flips that have happened until now in current interval.


High Availability

Fail-Safe Mode En-abled

string Keep one node primary if both nodes fail the health check, so that a partially available node can back up data and handle traffic. This mode is set independently on each node.


High Availability

Completed Flip Time

float To inform user whether flip time is elapsed or not.


High Availability

Disabled Interfaces

string Disabled interfaces.


High Availability

Max Flips Time

float Interval after which flipping of node states can again start. The default value is 0.


High Availability

Interfaces Causing Partial Fail-ure

string Interfaces causing partial failure.



RESOURCE ATTRIBUTE

ATTRIBUTE TYPE



High Availability

INC Enabled string Whether or not independent network entities and configurations exist. This option is required if the HA nodes reside on different networks. When this mode is enabled, the following independent network entities and configurations are neither propagated nor synced to the other node: MIPs, SNIPs, VLANs, routes (except LLB routes), route monitors, RNAT rules (except any RNAT rule with a VIP as the NAT IP), and dynamic routing configurations. They are maintained independently on each node.


Configuration Last Config-uration Save Time

string Time when the configuration was last saved through 'savensconfig'.


Configuration Client IP Insertion Enabled

string Whether or not the actual client IP address is inserted into the HTTP header request passed from the client to one, some, or all servers attached to the system.


Configuration Host ID integer The ID of the Host.


Configuration Path MTU Timeout

integer The Path MTU timeout in minutes.


Configuration Shared Quota Spill-over Grant

integer The percentage of shared quota to be granted at a time for spillover. The default is 10. Valid values range from 0 to 100.


Configuration Tagged Enabled

string Whether or not interfaces will be added as 802.1q tagged interfaces.


Configuration Current Sys-tem Time

string Current system time in date format.


Configuration Hardware Description

string Hardware and it's port details.


Configuration Version string The version of the System.


Configuration Config Changed True

string Whether or not the configuration has changed since the last saved configuration.


Configuration Flags float The flags for this Appliance.


Configuration Maximum Exclusive Quota Client Grant

integer The percentage of maxClient to be given to PEs. The default value is 80. Valid values range from 0 to 100.


Configuration HA Master Node IP Address

string High Availability Master Node IP address.


Configuration Exclusive Quota Spill-over Grant

integer The percentage of max limit to be given to PEs. The default value is 80. Valid values range from 0 to 100.



RESOURCE ATTRIBUTE

ATTRIBUTE TYPE



Configuration Configura-tion Loca-tion 1

string Location 1 of the configurations.


Configuration Configura-tion Loca-tion 2

string Location 2 of the configurations.


Configuration Maximum Connections

float The maximum number of connections that will be made from the system to the web server(s) attached to it. The value entered here is applied globally to all attached servers. Valid values range from 0 to 4294967294.


Configuration Mapped IP Range

float The range of mapped IP addresses to be configured. The minimum value is 1.


Configuration Interfaces Bound to NetScaler VLAN

string Comma separated list of interfaces bound to the NetScaler VLAN.


Configuration Netmask string The netmask corresponding to the IP address.


Configuration Maximum Requests

integer The maximum number of requests that the system can pass on a particular connection between the system and a server attached to it. Setting this value to 0 allows an unlimited number of requests to be passed. Valid values range from 0 to 65535.


Configuration Timezone string The name of the timezone that the system is in.


Configuration Level string Types of configuration to be cleared. Possibilities are: BASIC, EXTENDED, or FULL.


Configuration CPU Fre-quency

integer The frequency of the CPUs.


Configuration NetScaler VLAN

string VLAN for the subnet on which the IP address resides. Valid values range from 2 to 4094.


Configuration Last Con-figuration Changed Time

string Time when the configuration was last modified.


Configuration Cookie Version

integer The version of the cookie inserted by the system. Possibilities are: 1 or 2.


Configuration FTP Port Range

integer Port range configured for FTP services. Valid values range from 1024 to 64000.


Configuration System Type string The type of the System.


Configuration IP Address string The IP address of the system.



RESOURCE ATTRIBUTE

ATTRIBUTE TYPE



Configuration Secure Cookie Enabled

string Whether or not the secure flag for persistence cookie is set.


Configuration HTTP Ports string The HTTP ports on the web server. The minimum value is 1.


Configuration Weak Password Configura-tion File

string Configuration file used to find weak passwords. If none is specified, the running configuration is taken as input.


Configuration Cache Redi-rection Port Range

integer Port range configured for Cache Redirection services. Valid values range from 1 to 65535.


Configuration Configu-ration Diff Output Format

string Format that difference in configurations is displayed in. Possibilities are: CLI or XML.


Configuration Maximum Shared Quota Client Grant

integer The percentage of shared quota to be granted at a time for maxClient. The default value is 10. Valid values range from 0 to 100.


Configuration System Mapped IP

float Mapped IP address of the system.


Configuration Force En-abled

string Whether or not configurations will be cleared without prompting for confirmation.


Configuration Serial Num-ber

string Serial number of hardware.


Configuration Minimum Path MTU

integer The minimum Path MTU. The default value is 576. Valid values range from 168 to 1500.


Configuration Client IP Header String

string The text used as the client IP header.


Configuration Suppress Device Specific Differences Enabled

string Whether or not device specific differences are suppressed.


Capacity Value of 100 for Capacity Calculations

integer Metric generated with purpose of Value of 100 for Capacity Calculations.

Citrix NetScaler Global Service Load Balancing Site

Configuration Session Exchange Enabled

string Whether or not the exchange of persistent session entries with other GSLB Sites (every five seconds) is enabled.


Configuration Public Clus-ter IP

string IP address to be used to globally access the remote cluster when it is deployed behind a NAT. It can be same as the normal cluster IP address.



RESOURCE ATTRIBUTE

ATTRIBUTE TYPE



Configuration Public IP string Public IP address for the local Site. Required only if the Appliance is deployed in a private address space and the site has a public IP address hosted on an external firewall or a NAT device.


Configuration Metric Exchange Enabled

string Whether or not this Site exchanges metrics with other Sites. Metrics are exchanged by using Metric Exchange Protocol (MEP). The Appliances in the GSLB setup exchange health information once every second. If you disable metrics exchange, you can use only static load balancing methods (such as round robin, static proximity, or the hash-based methods), and if you disable metrics exchange when a dynamic load balancing method (such as least connection) is in operation, the appliance falls back to round robin. Also, if you disable metrics exchange, you must use a monitor to determine the state of GSLB services. Otherwise, the service is marked as DOWN. The default value is true.


Configuration Network Metric Exchange Enabled

string Whether or not exchange with other GSLB sites for network metrics is enabled. Metrics, such as round-trip time (RTT), are learned from communications with various local DNS (LDNS) servers used by clients. RTT information is used in the dynamic RTT load balancing method, and is exchanged every 5 seconds.


Configuration Trigger Mon-itor

string The conditions under which the GSLB Service must be monitored by a monitor, if one is bound. The default value is ALWAYS. Possibilities are: ALWAYS, MEPDOWN, or MEPDOWN_SVCDOWN.


Configuration Site Cluster IP Address

string Cluster IP address. Specify this parameter to connect to the remote cluster Site for GSLB auto-sync. Note: The cluster IP address is defined when creating the cluster.


Configuration Parent Site string Parent site of the GSLB site, in a parent-child topology.


Configuration Name string Name for the GSLB site. Cannot be changed after the GSLB Virtual Server is created.


Configuration Site Type string Type of GSLB Site. If the type is not specified, the Appliance automatically detects and sets the type on the basis of the IP address being assigned to the Site. If the specified Site IP address is owned by the Appliance (for example, a MIP address or SNIP address), the Site is a local Site. Otherwise, it is a remote site. The default value is NONE. Possibilities are: REMOTE or LOCAL.



RESOURCE ATTRIBUTE

ATTRIBUTE TYPE



Configuration Persistence Metric Exchange Protocol Status

string Network metric and persistence exchange Metric Exchange Protocol connection status. Possibilities are: ACTIVE, INACTIVE, or DOWN.



float Number of current connections to the Target Servers behind the Virtual Servers represented by all GSLB Services associated with this GSLB Site.


Statistics Status string Current metric exchange status. Possibilities are: ACTIVE, INACTIVE, or DOWN.



float Number of response bytes received by the Virtual Servers represented by all GSLB Services associated with this GSLB Site.






float Total number of requests received by the Virtual Servers represented by all GSLB Services associated with this GSLB Site.









float Number of responses received by the Virtual Servers represented by all GSLB Services associated with this GSLB Site.






float Number of current client connections to the Virtual Servers represented by all GSLB Services associated with this GSLB Site.



float Total number of request bytes received by the Virtual Servers represented by all GSLB Services associated with this GSLB Site.


10. Appendix II: Alerts, Symptoms, & RecommendationsThe vROps Management Pack for Citrix NetScaler creates alerts and provides recommended actions based on various symptoms that it detects in the environment. See the table below for details regarding each alert.

Table 2: Alerts, Symptoms, & Recommendations

NAME DESCRIPTION SYMPTOM RECOMMENDATION

Citrix NetScaler Global Service Load Balancing Service Down or Unavailable

This alert indicates that a Critical alert was raised in CitrixNetScaler.

GSLB Service Down or Unavailable

See 'What is Causing the Issue?' below for more information about this alert.

Citrix NetScaler Target Server has High Availability configuration mismatch


High Availability configuration mismatch


Citrix NetScaler Load Balancing Service Down or Unavailable


Service Down or Unavailable


Citrix NetScaler Load Balancing Service has High Availability configuration mismatch




Citrix NetScaler Load Balancing Virtual Server has High Availability configuration mismatch




Citrix NetScaler Global Service Load Balancing Virtual Server Down or Unavailable


GSLB Virtual Server Down or Unavailable


Citrix NetScaler Appliance has HA Node Failure


HA Node Failure See 'What is Causing the Issue?' below for more information about this alert.

Citrix NetScaler Appliance has Exceeded Licensed PPS

This alert indicates that a Warning alert was raised in CitrixNetScaler.

Exceeded Licensed PPS See 'What is Causing the Issue?' below for more information about this alert.

Citrix NetScaler Appliance has Exceeded Licensed Throughput


Exceeded Licensed Throughput


Citrix NetScaler Appliance has HA Node Disabled


HA Node Disabled See 'What is Causing the Issue?' below for more information about this alert.


11. Appendix III: Capacity DefinitionsThe Management Pack uses the following capacity definitions, which help determine the value of Analysis Badges (refer to section “7. Analysis Badges”) within vRealize Operations. For more information on using Analysis Badges, refer to the VMware vRealize Operations online help.

Table 3: Capacity Definitions

CONTAINER USE IN WORKLOAD

Appliance

vRealize Calculated Connections Capacity yes

vRealize Calculated Memory Capacity yes

vRealize Calculated CPU Capacity yes

vRealize Calculated /flash Capacity yes

vRealize Calculated /var Capacity yes

Service

vRealize Calculated Client Capacity yes

GSLB Service

vRealize Calculated Connections Capacity yes

Copyright © 2016 Blue Medora Inc. All rights reserved. U.S. and international copyright and intellectual property laws protect this product. Blue Medora is a registered trademark or trademark of Blue Medora in the United States and/or other jurisdictions.

The Citrix name (including Citrix NetScaler) and logo are trademarks or registered trademarks of Citrix Systems, Inc.in the United States and/or other jurisdictions. All other marks and names mentioned herein may be trademarks of their respective companies.

Blue Medora3225 N Evergreen Dr. NE Suite 103Grand Rapids, MI 49525www.bluemedora.com

You can find the most up-to-date technical documentation on the Blue Medora support site at: http://support.bluemedora.com.

The Blue Medora website also provides the latest product updates. If you have comments about this documentation, submit your feedback to: [email protected].

vmware vrealize operations management pack for · pdf file3 blue medora vmware vrealize...

Documents