If the method succeeds, rc is 0 else rc > 0. Values above 0x8000 indicate Warnings.

If the method succeeds, message is NULL else message contains Error/Warning message.

List of lbvservers

Name of the virtual server.

The virtual IP and port header insertion option for the vserver.

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

SSL status.

The IP address of the virtual server.
NOTE: This attribute is deprecated.
This is no more in use.

IPv4 or IPv6 address to assign to the virtual server.

The string is listenpolicy configured for lb vserver

This parameter is the priority for listen policy of LB Vserver.

The permanent mapping for the V6 Address

Port number for the virtual server.

The list of IPv4/IPv6 addresses bound to ipset would form a part of listening service on the current lb vserver

Number of IP addresses that the appliance must generate and assign to the virtual server. The virtual server then functions as a network virtual server, accepting traffic on any of the generated IP addresses. The IP addresses are generated automatically, as follows: * For a range of n, the last octet of the address specified by the IP Address parameter increments n-1 times. * If the last octet exceeds 255, it rolls over to 0 and the third octet increments by 1. Note: The Range parameter assigns multiple IP addresses to one virtual server. To generate an array of virtual servers, each of which owns only one IP address, use brackets in the IP Address and Name parameters to specify the range. For example: add lb vserver my_vserver[1-3] HTTP 192.0.2.[1-3] 80

Protocol used by the service (also called the service type).

Nodegroup name to which this lbvsever belongs to

Type of LB vserver.

Current LB vserver state.

Effective state of the LB vserver , based on the state of backup vservers.

Current status of the lb vserver. During the initial phase if the configured lb method is not round robin , the vserver will adopt round robin to distribute traffic for a predefined number of requests.

Reason why a vserver 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

Cache type CS/CR

Cache redirect type.

Precedence.

The redirect URL.

Authentication.

HTTP 401 response based authentication.

Name of an authentication virtual server with which to authenticate users.

Home page.

DNS vserver name.

Domain.

The bound bot policy names.

Service to bind to the virtual server.

The service group names.

Weight to assign to the specified service.

Dynamic weight

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

The priorities of bound bot policies.

The client timeout in seconds.

The spillover method to be in effect.

State of spillover persistence.

The maximum time persistence is in effect for a specific client on a spillover vserver.

Threshold in percent of active services below which vserver state is made down.

Threshold at which spillover occurs. Specify an integer for the CONNECTION spillover method, a bandwidth value in kilobits per second for the BANDWIDTH method (do not enter the units), or a percentage for the HEALTH method (do not enter the percentage symbol).

Action to be performed if spillover is to take effect, but no backup chain to spillover is usable or exists

The load balancing method to be in effect

Indicates the backup method in case the primary fails

The hash length.

The data offset length for TOKEN load balancing method.

Health of vserver based on percentage of weights of active svcs/all svcs. This does not consider administratively disabled svcs

The data length for TOKEN load balancing method.

The netmask of the destination network.

The netmask of the destination network.

Rule type.

Use this parameter to specify the expression to be used in response for RULE persistence type. The string is an in-line expression with a maximum of 1499 characters.

The next_expr-s of bound bot policies.

Rule type.

LB group to which the lb vserver is to be bound.

The LB mode.

TOS ID

The persistence type for the specified virtual server

The maximum time persistence is in effect for a specific client.

Domain name to be used in the set cookie header in case of cookie persistence.

The persistence mask for v4 traffic

The persistence mask for v6 traffic.

The maximum time backup persistence is in effect for a specific client.

Time period for which backup persistence is in effect.

The state of caching.

Use network address translation (NAT) for RTSP data connections.

To enable sessionless load balancing, enable this option

When value is ENABLED, Trofs persistence is honored. When value is DISABLED, Trofs persistence is not honored.

Map.

The connection failover mode of the virtual server

Rewrite the port and change the protocol to ensure successful HTTP redirects from services.

Flush all active transactions associated with a virtual server whose state transitions from UP to DOWN. Do not enable this option for applications that must complete their transactions.

Tells whether traffic will continue reaching backup vservers even after primary comes UP from DOWN state.

Allow for greater than 2 GB transactions on this vserver.

Use consolidated stats for LeastConnection.

Fetches Global setting.

Tells whether threshold exceeded for this service participating in CUSTOMLB

The bindpoint to which the policy is bound

The invoke flag of bound bot policies.

The invoke-label-types of bound bot policies.

The invoke-labels of bound bot policies.

Encryped Ip address and port of the service that is inserted into the set-cookie http header

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.

Vserver Id

Cookie version

Total number of services bound to the vserver.

Total number of active services bound to the vserver.

Time when last state change happened. Seconds part.

Time when last state change happened. Seconds part.

Time at which last state change happened. Milliseconds part.

Time in 10 millisecond ticks since the last state change.

Hits of bound cs policy

The hits of bound CSW PI policies.

Fully qualified domain name (FQDN) of the authentication virtual server to which the user must be redirected for authentication. Make sure that the Authentication parameter is set to ENABLED.

Process traffic with the push virtual server that is bound to this load balancing 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.

Expression for extracting a label from the server's response. Can be either an expression or the name of a named expression.

Allow multiple Web 2.0 connections from the same client to connect to the virtual server and expect updates.

Name of the TCP profile whose settings are to be applied to the virtual server.

Name of the HTTP profile whose settings are to be applied to the virtual server.

Name of the DB profile whose settings are to be applied to the virtual server.

Any comments that you might want to associate with the virtual server.

Flag to indicate bind entity is CS Vserver/CS Policylabel. For CS Vserver it is 1, for CS policylabel it is 2

Use Layer 2 parameters (channel number, MAC address, and VLAN ID) in addition to the 4-tuple (::::) that is used to identify a connection. Allows multiple TCP and non-TCP connections with the same 4-tuple to co-exist on the Citrix ADC.

Oracle server version

For a load balancing virtual server of type MSSQL, the Microsoft SQL Server version. Set this parameter if you expect some clients to run a version different from the version of the database. This setting provides compatibility between the client-side and server-side connections by ensuring that all communication conforms to the server's version.

MySQL protocol version that the virtual server advertises to clients.

MySQL server version string that the virtual server advertises to clients.

Character set that the virtual server advertises to clients.

Server capabilities that the virtual server advertises to clients.

Apply AppFlow logging to the virtual server.

Name of the network profile to associate with the virtual server. If you set this parameter, the virtual server uses only the IP addresses in the network profile as source IP addresses when initiating connections with servers.

How the Citrix ADC 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. Note: This parameter is available at the virtual server level. A similar parameter, ICMP Response, is available at the IP address level, for IPv4 addresses of type VIP. To set that parameter, use the add ip method in the CLI or the Create IP dialog box in the GUI.

Route Health Injection (RHI) functionality of the NetSaler appliance for advertising the route of the VIP address associated with the virtual server. When Vserver RHI Level (RHI) parameter is set to VSVR_CNTRLD, the following are different RHI behaviors for the VIP address on the basis of RHIstate (RHI STATE) settings on the virtual servers associated with the VIP address: * If you set RHI STATE to PASSIVE on all virtual servers, the Citrix ADC always advertises the route for the VIP address. * If you set RHI STATE to ACTIVE on all virtual servers, the Citrix ADC advertises the route for the VIP address if at least one of the associated virtual servers is in UP state. * If you set RHI STATE to ACTIVE on some and PASSIVE on others, the Citrix ADC advertises the route for the VIP address if at least one of the associated virtual servers, whose RHI STATE set to ACTIVE, is in UP state.

Number of requests, or percentage of the load on existing services, by which to increase the load on a new service at each interval in slow-start mode. A non-zero value indicates that slow-start is applicable. A zero value indicates that the global RR startup parameter is applied. Changing the value to zero will cause services currently in slow start to take the full traffic as determined by the LB method. Subsequently, any new services added will use the global RR factor.

Units in which to increment load at each interval in slow-start mode.

Interval, in seconds, between successive increments in the load on a new service or a service whose state has just changed from DOWN to UP. A value of 0 (zero) specifies manual slow start.

used for showing the ip of bound entities

used for showing ports of bound entities

Used for displaying the location of bound services.

Persist AVP number for Diameter Persistency. In case this AVP is not defined in Base RFC 3588 and it is nested inside a Grouped AVP, define a sequence of AVP numbers (max 3) in order of parent to child. So say persist AVP number X is nested inside AVP Y which is nested in Z, then define the list as Z Y X

This argument decides the behavior incase the service which is selected from an existing persistence session has reached threshold.

Minimum number of members expected to be present when vserver is used in Autoscale.

Maximum number of members expected to be present when vserver is used in Autoscale.

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

This option is used to retain vlan information of incoming packet when macmode is enabled

Enable database specific load balancing for MySQL and MSSQL service types.

This argument is for enabling/disabling the dns64 on lbvserver

If this option is enabled while resolving DNS64 query AAAA queries are not sent to back end dns server

When set to YES, this option causes the DNS replies from this vserver to have the RA bit turned on. Typically one would set this option to YES, when the vserver is load balancing a set of DNS servers thatsupport recursive queries.

By turning on this option packets destined to a vserver in a cluster will not under go any steering. Turn this option for single packet request response mode or when the upstream device is performing a proper RSS for connection based distribution.

Spillover threshold for dynamic connection

Staus of BackUp Vserver .

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

Name of the LB profile which is associated to the vserver

Port number for the virtual server, from which we absorb the traffic for http redirect

URL to which all HTTP traffic received on the port specified in the -redirectFromPort parameter is redirected.

This option enables you to retain existing connections on a node joining a Cluster system or when a node is being configured for passive timeout. By default, this option is disabled.

Name of the analytics profile bound to the LB vserver.

to determine if the configuration will have default ssl CIPHER and ECC curve bindings

Name of the adfsProxy profile to be used to support ADFSPIP protocol for ADFS servers.

Port number for external TCP probe. NetScaler provides support for external TCP health check of the vserver status over the selected port. This option is only supported for vservers assigned with an IPAddress or ipset.
NOTE: This attribute is deprecated.
The functionality is intact, but we advise to use -probePort and -probeProtocol options

Name of the QUIC Bridge profile whose settings are to be applied to the virtual server.

Citrix ADC provides support for external health check of the vserver status. Select HTTP or TCP probes for healthcheck

Citrix ADC provides support for external health check of the vserver status. Select port for HTTP/TCP monitring

HTTP code to return in SUCCESS case.

Name of QUIC profile which will be attached to the VServer.

Order number to be assigned to the service when it is bound to the lb vserver.

Order in string form assigned to the service when it is bound to the lb vserver.

Configure this option to toggle order preference

This option is used to to specify the threshold of minimum number of services to be UP in an order, for it to be considered in Lb decision.

current order that takes the traffic in case service or servicegroup is bound with order

The API profile where one or more API specs are bounded to.

This option is used to enable/disable DNS over HTTPS (DoH) processing.

The bound AS policy names.

The priorities of bound application firewall policies.

The next_expr-s of bound Application firewall policies.

The bindpoints of bound application firewall policies.

The invoke flag of bound application firewall policies.

The invoke-label-types of bound application firewall policies.

The invoke-labels of bound application firewall policies.

The bound AppQoS policy names.

The bound transform policy names.

The priorities of bound transform policies.

The next_expr-s of bound transform policies.

The bindpoints of bound transform policies.

The invoke flag of bound application policies.

The invoke-label-types of bound transform policies.

The invoke-labels of bound transform policies.

The bound RW policy names.

The priorities of bound RW policies.

The next_expr-s of bound RW policies.

The bindpoints of bound RW policies.

The invoke flag of bound RW policies.

The invoke-label-types of bound RW policies.

The invoke-labels of bound RW policies.

The bound Compression policy names.

The priorities of bound Compression policies.

The next_expr-s of bound CMP policies.

The bindpoints of bound CMP policies.

The invoke flag of bound CMP policies.

The invoke-label-types of bound CMP policies.

The invoke-labels of bound CMP policies.

The bound Content optimizatoin policy names.

The priorities of bound CO policies.

The next_expr-s of bound CO policies.

The bindpoints of bound CO policies.

The bound Authorization policy names.

The priorities of bound Authorization policies.

The next_expr-s of bound AUTHOR policies.

The bindpoints of bound AUTHOR policies.

The invoke flag of bound AUTHOR policies.

The invoke-label-types of bound AUTHOR policies.

The invoke-labels of bound AUTHOR policies.

The bound Cache policy names.

The priorities of bound Cache policies.

The next_expr-s of bound CACHE policies.

The bindpoints of bound CACHE policies.

The invoke flag of bound CACHE policies.

The invoke-label-types of bound CACHE policies.

The invoke-labels of bound CACHE policies.

The bound videooptimization detectionpolicy names.

The priorities of bound videooptimization detectionpolicies.

The next_expr-s of bound videooptimization detectionpolicies.

The bindpoints of bound videooptimization detectionpolicies.

The invoke flag of bound videooptimization detectionpolicies.

The invoke-label-types of bound video optimization policies.

The invoke-labels of bound videooptimization detectionpolicies.

The bound videooptimization pacingpolicy names.

The priorities of bound videooptimization pacingpolicies.

The next_expr-s of bound videooptimization pacingpolicies.

The bindpoints of bound videooptimization pacingpolicies.

The invoke flag of bound videooptimization pacingpolicies.

The invoke-label-types of bound videooptimization pacingpolicies.

The invoke-labels of bound videooptimization pacingpolicies.

The bound Responder policy names.

The priorities of bound Responder policies.

The next_expr-s of bound Responder policies.

The invoke flag of bound Responder policies.

The invoke-label-types of bound Responder policies.

The invoke-labels of bound Responder policies.

The bindpoint of bound resonder policies.

The bound LB policy names.

The priorities of bound LB policies.

The next_expr-s of bound LB policies.

The invoke flag of bound LB policies.

The invoke-label-types of bound LB policies.

The invoke-labels of bound LB policies.

The bindpoint of bound LB policies.

The bound AppFlow policy names.

The priorities of bound AppFlow policies.

The next_expr-s of bound AppFlow policies.

The bindpoints of bound CMP policies.

The invoke flag of bound AppFlow policies.

The invoke-label-types of bound AppFlow policies.

The invoke-labels of bound AppFlow policies.

The bound CI policy names.

The priorities of bound CI policies.

The next_expr-s of bound CI policies.

The bindpoints of bound CI policies.

The invoke flag of bound CI policies.

The invoke-label-types of bound CI policies.

The invoke-labels of bound CI policies.

The bindpoints of bound bot policies.

csvserver for which lbvserver is target

Bound cs policies

Priority of bound cs policy

The bound tm traffic policy names.

The priorities of bound tm traffic policies.

The bound spillover policy names.

The priorities of bound spillover policies.

The bound DNS64 policy names.

The priorities of bound DNS64 POLICIES.

The priority of the next dns64 policy to evaluate.