Bindplane

The Bindplane Developer Hub

Welcome to the Bindplane developer hub. You'll find comprehensive guides and documentation to help you start working with Bindplane as quickly as possible, as well as support if you get stuck. Let's jump right in!

Citrix NetScaler

Connection Parameters

Name
Required?
Description

Host

Required

The Citrix host to connect to.

Username

Required

Password

Required

SSL Configuration

The SSL mode to use when connecting to the target. Can be configured to not use SSL (No SSL), use SSL but do not verify the target's certificate (No Verify), and use SSL and verify the target's certificate (Verify).

Metrics

Appliance

Name
Description

Application Firewall Aborts

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

Application Firewall Aborts Rate (per Second)

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

Application Firewall Redirects

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

Application Firewall Redirects Rate (per Second)

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

Application Firewall Requests

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

Application Firewall Requests Rate (per Second)

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

Application Firewall Responses

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

Application Firewall Responses Rate (per Second)

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

Cache 64 Maximum Memory (Kilobytes)

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

Cache Hits Rate (per Second)

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

Cache Maximum Memory (Kilobytes)

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

Cache Maximum Memory Active (Kilobytes)

Currently active value of maximum memory

Cache Misses Rate (per Second)

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

Cache Origin Bandwidth Saved

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

Cache Redirection Port Range

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

Cache Total Hits

Responses served from the integrated cache.

Cache Total Misses

Intercepted HTTP requests requiring fetches from origin server.

Cache Utilized Memory (Kilobytes)

Amount of memory the integrated cache is currently using.

Client IP Header String

The text used as the client IP header.

Client IP Insertion Enabled

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.

Compression Ratio

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

Configuration Changed True

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

Configuration Difference Output Format

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

Configuration Location 1

Location 1 of the configurations.

Configuration Location 2

Location 2 of the configurations.

Cookie Version

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

CPU Frequency (Megahertz)

The frequency of the CPUs.

CPU Usage

CPU usage.

CPU Utilization (%)

CPU utilization percentage.

Current Flips Count

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

Data Compression Ratio

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.

Dead Interval (Seconds)

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.

Disabled Interfaces

Disabled interfaces.

Disk 0 Space Available

Available space in /flash partition of the hard disk.

Disk 0 Utilization (%)

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

Disk 1 Space Available

Available space in /var partition of the hard disk.

Disk 1 Utilization (%)

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

Enabled Interfaces

Enabled interfaces.

Exclusive Quota Spillover Grant (%)

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

Fail-Safe Mode Enabled

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.

Flags

The flags for this Appliance.

Force Enabled

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

FTP Port Range

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

Hardware Description

Hardware and it's port details.

Hello Interval (Milliseconds)

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 Current Master State

Indicates the high availability state of the node.

High Availability Current State

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

High Availability Master Node IP Address

High Availability Master Node IP address.

High Availability Propagation Enabled

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

Host ID

The ID of the Host.

HTTP Ports

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

HTTP Received Request Rate (Bytes per Second)

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

HTTP Received Response Rate (Bytes per Second)

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

HTTP Requests Rate (per Second)

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

HTTP Responses Rate (per Second)

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

HTTP Total Received Request (Bytes per Second)

Total number of bytes of HTTP request data received.

HTTP Total Received Response (Bytes per Second)

Total number of bytes of HTTP response data received.

HTTP Total Requests

Total number of HTTP requests received.

HTTP Total Responses

Total number of HTTP responses sent.

INC State Enabled

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.

Interfaces Bound to NetScaler VLAN

Comma separated list of interfaces bound to the NetScaler VLAN.

Interfaces without heartbeats

Interfaces on which non-multicast is not seen.

IP Address

The IP address of the system.

Level

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

Management CPU Usage (%)

Management CPU utilization percentage.

Mapped IP Range

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

Master State

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

Maximum Connections

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.

Maximum Exclusive Quota Client Grant (%)

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

Maximum Flips Count

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

Maximum Requests

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.

Maximum Shared Quota Client Grant (%)

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.

Memory Usage (Megabytes)

Main memory currently in use, in megabytes.

Memory Utilization (%)

Percentage of memory utilization on NetScaler.

Minimum Path MTU

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

Miscellaneous Counter 0

Miscellaneous Counter 0.

Miscellaneous Counter 1

Miscellaneous Counter 1.

Monitored High Availability Interfaces

Interfaces with High Availability monitor on.

Name

The name of the NetScaler Appliance.

Netmask

The netmask corresponding to the IP address.

NetScaler VLAN

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

Node State

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

Number of CPUs

The number of CPUs on the NetScaler appliance.

Packet Engines CPU Usage (%)

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

Partial Failure Interfaces

Interfaces causing partial failure.

Received Rate (Megabits per Second)

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

Resident Average CPU Usage (%)

Average CPU utilization percentage.

Resident CPU Usage

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

Resident Memory Usage (%)

Percentage of memory utilization on NetScaler.

Secure Cookie Enabled

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

Serial Number

Serial number of hardware.

Shared Quota Spillover Grant (%)

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

SSL Card Status

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

SSL Cards

Number of SSL crypto cards present on the NetScaler appliance.

SSL Number of Cards Up

Number of SSL cards that are UP.

SSL Session Hits Rate (per Second)

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

SSL Total Session Hits

Number of SSL session reuse hits on the NetScaler appliance.

SSL Total Transactions

Number of SSL transactions on the NetScaler appliance.

SSL Transactions Rate (per Second)

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

Suppress Device Specific Differences Enabled

Whether or not device specific differences are suppressed.

System Mapped IP

Mapped IP address of the system.

System Type

The type of the System.

Tagged Enabled

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

TCP Current Client Connections

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

TCP Current Client Connections established

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

TCP Current Server Connections

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

TCP Current Server Connections established

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

Timezone

The name of the timezone that the system is in.

Total HTTP Compression Ratio

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

Total Received (Megabytes)

Number of megabytes received by the NetScaler appliance.

Total Transmitted (Megabytes)

Number of megabytes transmitted by the NetScaler appliance.

Transmitted Rate (Megabits per Second)

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

Version

The version of the System.

Weak Password Configuration File

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

Global Service Load Balancing Service

Name
Description

Canonical Name

Canonical name of the GSLB Service.

Current Client Connections

Number of current client connections.

Current Load

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

Current Server Connections

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

Effective Global Service Load Balancing State

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.

Established Connections

Number of client connections in ESTABLISHED state.

Global Service Load Balancing Type

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

IP Address

IPv4 or IPv6 address of the GSLB Service.

Maximum_Bandwidth

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.

Maximum Clients

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

Maximum_Users

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

Monitor Threshold

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.

Name

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

Port

Port on which the load balancing entity represented by this GSLB Service listens. Valid values range from 1 to 65535.

Protocol

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.

Public IP

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

Public Port

The public port associated with the GSLB Service's public IP address.

Request Data Rate (Bytes per Second)

Rate (/s) counter for 'Total Request Bytes'.

Requests Rate (per Second)

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

Response Data Rate (Bytes per Second)

Rate (/s) counter for 'Total Response Bytes'.

Responses Rate (per Second)

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

Server Name

The name of the server hosting this GSLB Service.

Service Enabled

Whether or not the service is enabled.

Site Name

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

Site Persistence

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

Total Request Data (Bytes)

Total number of request bytes received on this Service.

Total Requests

Total number of requests received on this Service.

Total Response Data (Bytes)

Number of response bytes received by this Service.

Total Responses

Number of responses received on this Service.

Virtual Server Service Hits

Number of times that the Service has been provided.

Virtual Server Service Hits Rate (per Second)

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

Global Service Load Balancing Site

Name
Description

Current Client Connections

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

Current Server Connections

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

IP Address

IP address for the GSLB Site. The GSLB Site uses this IP address to communicate with other GSLB Sites. For a local site, use any IP address that is owned by the appliance (for example, a SNIP or MIP address, or the IP address of the ADNS service).

Metric Exchange Enabled

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.

Name

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

Network Metric Exchange Enabled

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.

Parent Site

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

Persistence Metric Exchange Protocol Status

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

Public Cluster IP

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.

Public IP

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.

Request Data Rate (Bytes per Second)

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

Requests Rate (per Second)

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

Response Data Rate (Bytes per Second)

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

Responses Rate (per Second)

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

Session Exchange Enabled

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

Site Cluster IP Address

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.

Site Type

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.

Status

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

Total Request Data (Bytes)

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

Total Requests

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

Total Response Data (Bytes)

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

Total Responses

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

Trigger Monitor

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.

Global Service Load Balancing Virtual Server

Name
Description

Active Services

Number of ACTIVE services bound to the GSLB Virtual Server.

App Flow Log Enabled

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

Backup Load Balancing Method

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.

Consider Effective State

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.

Current Client Connections

Number of current client connections.

Current Server Connections

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

Current State

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.

Disable Primary On Down Enabled

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.

Dns Record Type

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

Dynamic Weight Method

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.

Empty DNS Response Enabled

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

Established Connections

Number of client connections in ESTABLISHED state.

Health

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

Hits Rate (per Second)

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

Inactive Services

Number of INACTIVE services bound to the GSLB Virtual Server.

Initial State Enabled

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

Is cname Enabled

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

Load Balancing Method

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.

Load Balancing Round Robin Reason

Reason why a Virtual Server is in Round Robin.

Multiple IP Addresses in DNS Responses Enabled

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

Name

Name of the GSLB Virtual Server. This can be changed after the GSLB Virtual Server is created.

Persistence Type

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.

Request Data Rate (Bytes per Second)

Rate (/s) counter for 'Total Request Bytes'.

Requests Rate (per Second)

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

Response Data Rate (Bytes per Second)

Rate (/s) counter for 'Total Response Bytes'.

Responses Rate

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

Service Type

Protocol used by services bound to the Virtual Server.

Site Persistence

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

Spill Over Method

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

Spill Over Persistence Enabled

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

Spill Over Threshold

Spill over threshold for the GSLB Virtual Server.

Total Hits

Total Virtual Server hits.

Total Request Data (Bytes)

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

Total Requests

Total number of requests received on this GSLB Virtual Server.

Total Response Data (Bytes)

Number of response bytes received by this GSLB Virtual Server.

Total Responses

Number of responses received on this GSLB Virtual Server.

Total Services

Total number of Services bound to the Virtual Server.

Total Spill Overs

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

Total Virtual Server Down Backup Hits

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

High Availability System

Name
Description

IP Address from Connection Info

The IP address in the ConnectionInfo object passed into the entry point of this ExUnoDataProvider.

Load Balancing Service

Name
Description

Access Down On

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

Active Transactions

Number of active transactions handled by this service.

AppFlow Logging Enabled

Whether or not AppFlow logging is enabled.

Average Service Time To First Byte

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

Cache Server Enabled

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

Cache Type

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

Clear Text Port

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.

Client IP Header

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

Client Keep Alive Enabled

Whether or not client keep-alive is enabled.

Comment

Any information about the Service.

Current Client Connections

Number of current client connections.

Current Idle Queue and Reuse Pool Requests

Number of requests in the idle queue/reuse pool.

Current Load

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

Current Server Connections

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

Database Specific Services IP

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

DNS Profile Name

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.

Down State Flush Enabled

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.

Established Server Connections

Number of server connections in ESTABLISHED state.

Global Service Load Balancer Option

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

Graceful Enabled

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

Graceful Shutdown Delay (Seconds)

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

Hash ID

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

Health Monitor On

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

HTTP Compression Enabled

Whether or not HTTP compression is enabled.

HTTP Profile Name

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

Individual Path Monitor Enabled

Whether or not individual path monitoring decisions are enabled.

Initial State Enabled

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

Insert Client IP Address

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.

IP Address

The IP address of the Citrix NetScaler Load Balancing Service.

Last Response

The string form of 'Monitor State Code'.

Maximum Allowed Connections

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

Maximum Bandwidth (Kilobits per Second)

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

Maximum Requests

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.

Monitor Name Bound to Service

Name of the monitor bound to this Service.

Monitor Owner

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

Monitor Owner View ID

Tells the view id of the monitoring owner.

Monitor State

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.

Monitor State Code

The code indicating the monitor response.

Monitor Threshold

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.

Name

The name of the Citrix NetScaler Load Balancing Service.

Network Profile

Network profile to use for the Service.

New Name

New name for the Service.

Number of Connections

The number of client side connections that are still open.

Path Monitor Enabled

Whether or not path monitoring for clustering is enabled.

Policy Name

The name of the policy for which this Service is bound.

Port

The port of the Citrix NetScaler Load Balancing Service.

Process Local Enabled

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

Public IP

The public IP of the Server.

Request Rate (Bytes per Second)

Rate (/s) counter for 'Total Requests Data'

Requests Rate (per Second)

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

Response Rate (Bytes per Second)

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

Responses Rate (per Second)

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

Rise Apbr Status Message Code 1

The code indicating the rise apbr status.

Rise Apbr Status Message Code 2

The code indicating other rise apbr status.

Server ID

The identifier for the service.

Server Name

The name of the server that hosts this Service.

Service Configuration Type 1

The configuration type of the Service.

Service Configuration Type 2

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

Service Hits

Number of times that the service has been provided.

Service Hits Rate (per Second)

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

Service State

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.

Service Type

The service type of the Citrix NetScaler Load Balancing Service.

Session ID Remapping On

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

SSL Status

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

State Update Reason

Checks state update reason on the secondary node.

SureConnect On

Whether or not SureConnect is on.

Surge Protection Enabled

Whether or not surge protection is enabled for the service.

Surge Queue Count

Number of requests in the surge queue.

TCP Buffering On

Whether or not TCP buffering is used.

TCP Profile Name

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

Throughput (Megabits per Second)

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

Ticks Since Last State Change

Time in 10 millisecond ticks since the last state change.

Total Request Data (Bytes)

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

Total Requests

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

Total Response Data (Bytes)

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

Total Responses

Number of responses received on this service or Virtual Server.

Traffic Domain ID

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.

Use Proxy Port

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

Use Source IP Address

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

Weight

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.

Load Balancing Virtual Server

Name
Description

401 Based Authentication

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

Active Services

Number of ACTIVE services bound to a Virtual Server.

AppFlow Logging Enabled

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

Authentication Host

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

Authorization Profile

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

Authorization Virtual Server Name

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

Backup Virtual Server

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

Bypass AAAA Enabled

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

Cacheable

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.

Client Connections

Number of current client connections.

Comment

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

Connection Failover Mode

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

Connections in Established State

Number of client connections in ESTABLISHED state.

Cookie Name

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.

Current State

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.

Data Length (Bytes)

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.

Data Offset

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.

Database Profile Name

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

Database Specific Load Balancer Enabled

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

Deferred Request Rate (per Second)

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

Deferred Requests

Number of deferred request on this Virtual Server.

Disable Primary When Down

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.

DNS 64 Enabled

Whether or not DNS64 is enabled on the Load Balancing Virtual Server.

DNS Profile Name

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

Down State Flush Enabled

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

Effective State

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.

Form Based Authentication

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

Hash Length

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.

Health

Health of the Virtual Server.

Health Threshold

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.

Hits Rate (per Second)

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

HTTP Profile Name

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

ICMP Virtual Server Response

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.

Inactive Services

number of INACTIVE services bound to a Virtual Server.

Inserted Header

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

Invalid Requests or Responses

Number invalid requests/responses on this Virtual Server.

Invalid Requests or Responses Dropped

Number invalid requests/responses dropped on this Virtual Server.

IP Address

The IP address of the Citrix NetScaler Load Balancing Virtual Server.

IP Mask

IP mask, in dotted decimal notation, for 'IP Pattern'.

IP Pattern

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

IPv4 Subnet Mask

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

IPv6 Subnet Mask Length

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.

Labelled Connection

Number of Labeled connection on this Virtual Server.

Layer 2 Parameters

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

Listen Policy Expression

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.

Listen Priority

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.

Load Balancer Reason Code

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.

Load Balancer Redirection Mode

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.

Load Balancing Method

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.

MAC Mode Retain VLAN Enabled

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

Maximum Autoscale Members

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.

Minimum Autoscale Members

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.

Name

The name of the Citrix NetScaler Load Balancing Virtual Server.

Network Profile

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

New Service Request

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.

New Service Request Increment Interval

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.

New Service Request Unit

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

Packets Received Rate (per Second)

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

Packets Sent Rate (per Second)

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

Persist AVP Number

Persist AVP number for Diameter Persistency.

Persistence Backup

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.

Persistence IPv4 Mask

Specifies if the persistency is IP based.

Persistence IPv6 Mask Length

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.

Persistence Type

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

Port

The port of the Citrix NetScaler Load Balancing Virtual Server.

Priority Queueing

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

Process Local Enabled

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

Push Enabled

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.

Push Label Expression

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

Push Labels

Number of labels for this push Virtual Server.

Push Multiple Clients Enabled

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

Push Virtual Server

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.

Range

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.

Real Time Streaming Protocol Natting

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

Recursion Available

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

Redirect Port Rewrite Enabled

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

Redirect URL

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

Request Data Rate (Bytes per Second)

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

Requests Rate (per Second)

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

Requests Waiting

Number of requests waiting on this Virtual Server.

Response Data Rate (Bytes per Second)

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

Response Rule

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

Responses Rate (per Second)

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

Route Health Injection State

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.

Rule

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

Server Connections

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

Service Name

Service bound to this Virtual Server.

Service Type

The service type. Possibilities are: HTTP, FTP, TCP, UDP, 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.

Services Surge Queue Length

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

Sessionless Load Balancing Enabled

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

Skip Persistency

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.

Spillover Backup Action

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.

Spillover Method

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.

Spillover Persistence Enabled

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

Spillover Threshold

Spillover Threshold set on the Virtual Server.

Sure Connect

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

Surge Queue Length

Number of requests in the surge queue.

TCP Profile Name

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

Threshold Value

Tells whether threshold exceeded for this service participating in CUSTOMLB.

TOS ID

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.

Total Backup Diversions

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

Total Hits

Total Virtual Server hits.

Total Packets Received

Total number of packets received by this Virtual Server.

Total Packets Sent

Total number of packets sent.

Total Request Data (Bytes)

Total number of request bytes received on this Virtual Server.

Total Requests

Total number of requests received on this Virtual Server.

Total Response Data (Bytes)

Number of response bytes received by this Virtual Server.

Total Responses

Number of responses received on this Virtual Server.

Total Services

Total number of services bound to the Virtual Server.

Total Spillovers

Number of times Virtual Server experienced spillover.

Traffic Domain

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

Virtual Server IP Port Insertion

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.

Weight

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

Target Server

Name
Description

Appflow Log Enabled

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

Autoscale Mode

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

Cacheable Enabled

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

Client IP Header Insertion Enabled

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.

Client IP Header Name

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.

Client Keep Alive Enabled

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

Comment

Any information about the server.

Compression Enabled

Whether or not compression is enabled on the server.

Custom Server Id

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

Delay (Seconds)

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

Domain

Domain name of the server.

Domain Resolve Now Boolean

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

Domain Resolve Retry (Seconds)

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.

Down State Flush Enabled

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

Graceful Shutdown Enabled

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.

Initial State Enabled

Initial state of the server. The default is TRUE.

IP Address

IPv4 or IPv6 address of the server.

IPv6 Supported

Support IPv6 addressing mode.

Maximum Bandwidth (Kilobits per Second)

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

Maximum Clients

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

Maximum Requests

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.

Monitor Threshold

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.

Name

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

New Name

New name for the server.

SureConnect On

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

Surge Protection On

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

Tcp Buffering Enabled

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

Traffic Domain Unique Identifier

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.

Translation IP

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

Translation Mask

The netmask of the translation IP.

Use Clients IP Enabled

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