lbvserver
Configuration for Load Balancing Virtual Server resource.
Properties
(click to see Operations )
Name | Data Type | Permissions | Description |
---|---|---|---|
name |
|
Read-write | Name for the virtual server. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at sign (@), equal sign (=), and hyphen (-) characters. Can be changed after the virtual server is created.
CLI Users: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, “my vserver” or ‘my vserver’). . Minimum length = 1 |
servicetype |
|
Read-write | Protocol used by the service (also called the service type).
Possible values = HTTP, FTP, TCP, UDP, SSL, SSL_BRIDGE, SSL_TCP, DTLS, NNTP, DNS, DHCPRA, ANY, SIP_UDP, SIP_TCP, SIP_SSL, DNS_TCP, RTSP, PUSH, SSL_PUSH, RADIUS, RDP, MYSQL, MSSQL, DIAMETER, SSL_DIAMETER, TFTP, ORACLE, SMPP, SYSLOGTCP, SYSLOGUDP, FIX, SSL_FIX, PROXY, USER_TCP, USER_SSL_TCP, QUIC, IPFIX, LOGSTREAM, MONGO, MONGO_TLS, MQTT, MQTT_TLS, QUIC_BRIDGE, HTTP_QUIC |
ipv46 |
|
Read-write | IPv4 or IPv6 address to assign to the virtual server. |
ippattern |
|
Read-write | IP address pattern, in dotted decimal notation, for identifying packets to be accepted by the virtual server. The IP Mask parameter specifies which part of the destination IP address is matched against the pattern. Mutually exclusive with the IP Address parameter.
For example, if the IP pattern assigned to the virtual server is 198.51.100.0 and the IP mask is 255.255.240.0 (a forward mask), the first 20 bits in the destination IP addresses are matched with the first 20 bits in the pattern. The virtual server accepts requests with IP addresses that range from 198.51.96.1 to 198.51.111.254. You can also use a pattern such as 0.0.2.2 and a mask such as 0.0.255.255 (a reverse mask). If a destination IP address matches more than one IP pattern, the pattern with the longest match is selected, and the associated virtual server processes the request. For example, if virtual servers vs1 and vs2 have the same IP pattern, 0.0.100.128, but different IP masks of 0.0.255.255 and 0.0.224.255, a destination IP address of 198.51.100.128 has the longest match with the IP pattern of vs1. If a destination IP address matches two or more virtual servers to the same extent, the request is processed by the virtual server whose port number matches the port number in the request. |
ipmask |
|
Read-write | IP mask, in dotted decimal notation, for the IP Pattern parameter. Can have leading or trailing non-zero octets (for example, 255.255.240.0 or 0.0.255.255). Accordingly, the mask specifies whether the first n bits or the last n bits of the destination IP address in a client request are to be matched with the corresponding bits in the IP pattern. The former is called a forward mask. The latter is called a reverse mask. |
port |
|
Read-write | Port number for the virtual server.
Range 1 - 65535 * in CLI is represented as 65535 in NITRO API |
ipset |
|
Read-write | The list of IPv4/IPv6 addresses bound to ipset would form a part of listening service on the current lb vserver.
Minimum length = 1 |
range |
|
Read-write | 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
|
persistencetype |
|
Read-write | Type of persistence for the virtual server. Available settings function as follows
|
timeout |
|
Read-write | Time period for which a persistence session is in effect.
Default value: 2 Minimum value = 0 Maximum value = 1440 |
persistencebackup |
|
Read-write | Backup persistence type for the virtual server. Becomes operational if the primary persistence mechanism fails.
Possible values = SOURCEIP, NONE |
backuppersistencetimeout |
|
Read-write | Time period for which backup persistence is in effect.
Default value: 2 Minimum value = 2 Maximum value = 1440 |
lbmethod |
|
Read-write | Load balancing method. The available settings function as follows
|
hashlength |
|
Read-write | Number of bytes to consider for the hash value used in the URLHASH and DOMAINHASH load balancing methods.
Default value: 80 Minimum value = 1 Maximum value = 4096 |
netmask |
|
Read-write | IPv4 subnet mask to apply to the destination IP address or source IP address when the load balancing method is DESTINATIONIPHASH or SOURCEIPHASH.
Minimum length = 1 |
v6netmasklen |
|
Read-write | 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.
Default value: 128 Minimum value = 1 Maximum value = 128 |
backuplbmethod |
|
Read-write | Backup load balancing method. Becomes operational if the primary load balancing me
thod fails or cannot be used. Valid only if the primary method is based on static proximity. Default value: ROUNDROBIN Possible values = ROUNDROBIN, LEASTCONNECTION, LEASTRESPONSETIME, SOURCEIPHASH, LEASTBANDWIDTH, LEASTPACKETS, CUSTOMLOAD |
cookiename |
|
Read-write | 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. |
rule |
|
Read-write | Expression, or name of a named expression, against which traffic is evaluated.
The following requirements apply only to the Citrix ADC CLI
|
listenpolicy |
|
Read-write | Expression identifying traffic accepted by the virtual server. Can be either an expression (for example, CLIENT.IP.DST.IN_SUBNET(192.0.2.0/24) or the name of a named expression. In the above example, the virtual server accepts all requests whose destination IP address is in the 192.0.2.0/24 subnet.
Default value: “NONE” |
listenpriority |
|
Read-write | Integer specifying the priority of the listen policy. A higher number specifies a lower priority. If a request matches the listen policies of more than one virtual server the virtual server whose listen policy has the highest priority (the lowest priority number) accepts the request.
Default value: 101 Minimum value = 0 Maximum value = 101 |
resrule |
|
Read-write | 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. Example HTTP.RES.HEADER(“setcookie”).VALUE(0).TYPECAST_NVLIST_T(‘=’,’;’).VALUE(“server1”). Default value: “none” |
persistmask |
|
Read-write | Persistence mask for IP based persistence types, for IPv4 virtual servers.
Minimum length = 1 |
v6persistmasklen |
|
Read-write | Persistence mask for IP based persistence types, for IPv6 virtual servers.
Default value: 128 Minimum value = 1 Maximum value = 128 |
rtspnat |
|
Read-write | Use network address translation (NAT) for RTSP data connections.
Default value: OFF Possible values = ON, OFF |
m |
|
Read-write | Redirection mode for load balancing. Available settings function as follows
|
tosid |
|
Read-write | TOS ID of the virtual server. Applicable only when the load balancing redirection mode is set to TOS.
Minimum value = 1 Maximum value = 63 |
datalength |
|
Read-write | 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.
Minimum value = 1 Maximum value = 100 |
dataoffset |
|
Read-write | 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.
Minimum value = 0 Maximum value = 25400 |
sessionless |
|
Read-write | Perform load balancing on a per-packet basis, without establishing sessions. Recommended for load balancing of intrusion detection system (IDS) servers and scenarios involving direct server return (DSR), where session information is unnecessary.
Default value: DISABLED Possible values = ENABLED, DISABLED |
trofspersistence |
|
Read-write | When value is ENABLED, Trofs persistence is honored. When value is DISABLED, Trofs persistence is not honored.
Default value: ENABLED Possible values = ENABLED, DISABLED |
state |
|
Read-write | State of the load balancing virtual server.
Default value: ENABLED Possible values = ENABLED, DISABLED |
connfailover |
|
Read-write | Mode in which the connection failover feature must operate for the virtual server. After a failover, established TCP connections and UDP packet flows are kept active and resumed on the secondary appliance. Clients remain connected to the same servers. Available settings function as follows
|
redirurl |
|
Read-write | URL to which to redirect traffic if the virtual server becomes unavailable.
WARNING! Make sure that the domain in the URL does not match the domain specified for a content switching policy. If it does, requests are continuously redirected to the unavailable virtual server. Minimum length = 1 |
cacheable |
|
Read-write | Route cacheable requests to a cache redirection virtual server. The load balancing virtual server can forward requests only to a transparent cache redirection virtual server that has an IP address and port combination of *:80, so such a cache redirection virtual server must be configured on the appliance.
Default value: NO Possible values = YES, NO |
clttimeout |
|
Read-write | Idle time, in seconds, after which a client connection is terminated.
Minimum value = 0 Maximum value = 31536000 |
somethod |
|
Read-write | Type of threshold that, when exceeded, triggers spillover. Available settings function as follows
|
sopersistence |
|
Read-write | If spillover occurs, maintain source IP address based persistence for both primary and backup virtual servers.
Default value: DISABLED Possible values = ENABLED, DISABLED |
sopersistencetimeout |
|
Read-write | Timeout for spillover persistence, in minutes.
Default value: 2 Minimum value = 2 Maximum value = 1440 |
healththreshold |
|
Read-write | Threshold in percent of active services below which vserver state is made down. If this threshold is 0, vserver state will be up even if one bound service is up.
Default value: 0 Minimum value = 0 Maximum value = 100 |
sothreshold |
|
Read-write | 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).
Minimum value = 1 Maximum value = 4294967287 |
sobackupaction |
|
Read-write | Action to be performed if spillover is to take effect, but no backup chain to spillover is usable or exists.
Possible values = DROP, ACCEPT, REDIRECT |
redirectportrewrite |
|
Read-write | Rewrite the port and change the protocol to ensure successful HTTP redirects from services.
Default value: DISABLED Possible values = ENABLED, DISABLED |
downstateflush |
|
Read-write | 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.
Default value: ENABLED Possible values = ENABLED, DISABLED |
backupvserver |
|
Read-write | Name of the backup virtual server to which to forward requests if the primary virtual server goes DOWN or reaches its spillover threshold.
Minimum length = 1 |
disableprimaryondown |
|
Read-write | If the primary virtual server goes down, do not allow it to return to primary status until manually enabled.
Default value: DISABLED Possible values = ENABLED, DISABLED |
insertvserveripport |
|
Read-write | Insert an HTTP header, whose value is the IP address and port number of the virtual server, before forwarding a request to the server. The format of the header is |
vipheader |
|
Read-write | Name for the inserted header. The default name is vip-header.
Minimum length = 1 |
authenticationhost |
|
Read-write | 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.
Minimum length = 3 Maximum length = 252 |
authentication |
|
Read-write | Enable or disable user authentication.
Default value: OFF Possible values = ON, OFF |
authn401 |
|
Read-write | Enable or disable user authentication with HTTP 401 responses.
Default value: OFF Possible values = ON, OFF |
authnvsname |
|
Read-write | Name of an authentication virtual server with which to authenticate users.
Minimum length = 1 Maximum length = 252 |
push |
|
Read-write | Process traffic with the push virtual server that is bound to this load balancing virtual server.
Default value: DISABLED Possible values = ENABLED, DISABLED |
pushvserver |
|
Read-write | 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.
Minimum length = 1 |
pushlabel |
|
Read-write | Expression for extracting a label from the server’s response. Can be either an expression or the name of a named expression.
Default value: “none” |
pushmulticlients |
|
Read-write | Allow multiple Web 2.0 connections from the same client to connect to the virtual server and expect updates.
Default value: NO Possible values = YES, NO |
tcpprofilename |
|
Read-write | Name of the TCP profile whose settings are to be applied to the virtual server.
Minimum length = 1 Maximum length = 127 |
httpprofilename |
|
Read-write | Name of the HTTP profile whose settings are to be applied to the virtual server.
Minimum length = 1 Maximum length = 127 |
dbprofilename |
|
Read-write | Name of the DB profile whose settings are to be applied to the virtual server.
Minimum length = 1 Maximum length = 127 |
comment |
|
Read-write | Any comments that you might want to associate with the virtual server. |
l2conn |
|
Read-write | Use Layer 2 parameters (channel number, MAC address, and VLAN ID) in addition to the 4-tuple ( |
oracleserverversion |
|
Read-write | Oracle server version.
Default value: 10G Possible values = 10G, 11G |
mssqlserverversion |
|
Read-write | 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.
Default value: 2008R2 Possible values = 70, 2000, 2000SP1, 2005, 2008, 2008R2, 2012, 2014 |
mysqlprotocolversion |
|
Read-write | MySQL protocol version that the virtual server advertises to clients. |
mysqlserverversion |
|
Read-write | MySQL server version string that the virtual server advertises to clients.
Minimum length = 1 Maximum length = 31 |
mysqlcharacterset |
|
Read-write | Character set that the virtual server advertises to clients. |
mysqlservercapabilities |
|
Read-write | Server capabilities that the virtual server advertises to clients. |
appflowlog |
|
Read-write | Apply AppFlow logging to the virtual server.
Default value: ENABLED Possible values = ENABLED, DISABLED |
netprofile |
|
Read-write | 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.
Minimum length = 1 Maximum length = 127 |
icmpvsrresponse |
|
Read-write | 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
|
rhistate |
|
Read-write | 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
|
newservicerequest |
|
Read-write | 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.
Default value: 0 |
newservicerequestunit |
|
Read-write | Units in which to increment load at each interval in slow-start mode.
Default value: PER_SECOND Possible values = PER_SECOND, PERCENT |
newservicerequestincrementinterval |
|
Read-write | 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.
Default value: 0 Minimum value = 0 Maximum value = 3600 |
minautoscalemembers |
|
Read-write | Minimum number of members expected to be present when vserver is used in Autoscale.
Default value: 0 Minimum value = 0 Maximum value = 5000 |
maxautoscalemembers |
|
Read-write | Maximum number of members expected to be present when vserver is used in Autoscale.
Default value: 0 Minimum value = 0 Maximum value = 5000 |
persistavpno | <Double[]> | Read-write | 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. Minimum value = 1 |
skippersistency |
|
Read-write | This argument decides the behavior incase the service which is selected from an existing persistence session has reached threshold.
Default value: None Possible values = Bypass, ReLb, None |
td |
|
Read-write | 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.
Minimum value = 0 Maximum value = 4094 |
authnprofile |
|
Read-write | Name of the authentication profile to be used when authentication is turned on. |
macmoderetainvlan |
|
Read-write | This option is used to retain vlan information of incoming packet when macmode is enabled.
Default value: DISABLED Possible values = ENABLED, DISABLED |
dbslb |
|
Read-write | Enable database specific load balancing for MySQL and MSSQL service types.
Default value: DISABLED Possible values = ENABLED, DISABLED |
dns64 |
|
Read-write | This argument is for enabling/disabling the dns64 on lbvserver.
Possible values = ENABLED, DISABLED |
bypassaaaa |
|
Read-write | If this option is enabled while resolving DNS64 query AAAA queries are not sent to back end dns server.
Default value: NO Possible values = YES, NO |
recursionavailable |
|
Read-write | 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.
Default value: NO Possible values = YES, NO |
processlocal |
|
Read-write | 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.
Default value: DISABLED Possible values = ENABLED, DISABLED |
dnsprofilename |
|
Read-write | 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.
Minimum length = 1 Maximum length = 127 |
lbprofilename |
|
Read-write | Name of the LB profile which is associated to the vserver. |
redirectfromport |
|
Read-write | Port number for the virtual server, from which we absorb the traffic for http redirect.
Minimum value = 1 Range 1 - 65535 * in CLI is represented as 65535 in NITRO API |
httpsredirecturl |
|
Read-write | URL to which all HTTP traffic received on the port specified in the -redirectFromPort parameter is redirected. |
retainconnectionsoncluster |
|
Read-write | 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.
Default value: NO Possible values = YES, NO |
adfsproxyprofile |
|
Read-write | Name of the adfsProxy profile to be used to support ADFSPIP protocol for ADFS servers. |
tcpprobeport |
|
Read-write | 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.
Minimum value = 1 Range 1 - 65535 * in CLI is represented as 65535 in NITRO API |
quicprofilename |
|
Read-write | Name of QUIC profile which will be attached to the VServer.
Minimum length = 1 Maximum length = 255 |
quicbridgeprofilename |
|
Read-write | Name of the QUIC Bridge profile whose settings are to be applied to the virtual server.
Minimum length = 1 Maximum length = 127 |
probeprotocol |
|
Read-write | Citrix ADC provides support for external health check of the vserver status. Select HTTP or TCP probes for healthcheck.
Possible values = TCP, HTTP |
probesuccessresponsecode |
|
Read-write | HTTP code to return in SUCCESS case.
Default value: “200 OK” Minimum length = 1 Maximum length = 64 |
probeport |
|
Read-write | Citrix ADC provides support for external health check of the vserver status. Select port for HTTP/TCP monitring.
Default value: 0 Range 1 - 65535 * in CLI is represented as 65535 in NITRO API |
toggleorder |
|
Read-write | Configure this option to toggle order preference.
Default value: ASCENDING Possible values = ASCENDING, DESCENDING |
orderthreshold |
|
Read-write | 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.
Default value: 0 Minimum value = 0 Maximum value = 100 |
servicename |
|
Read-write | Service to bind to the virtual server.
Minimum length = 1 |
weight |
|
Read-write | Weight to assign to the specified service.
Minimum value = 1 Maximum value = 100 |
order |
|
Read-write | Order number to be assigned to the service when it is bound to the lb vserver.
Minimum value = 1 Maximum value = 8192 |
redirurlflags |
|
Read-write | The redirect URL to be unset. |
newname |
|
Read-write | New name for the virtual server.
Minimum length = 1 |
value |
|
Read-only | SSL status.
Possible values = Certkey/Certkeybundle not bound, SSL feature disabled |
ipmapping |
|
Read-only | The permanent mapping for the V6 Address. |
ngname |
|
Read-only | Nodegroup name to which this lbvsever belongs to. |
type |
|
Read-only | Type of LB vserver.
Possible values = CONTENT, ADDRESS |
curstate |
|
Read-only | Current LB vserver state.
Possible values = UP, DOWN, UNKNOWN, BUSY, OUT OF SERVICE, GOING OUT OF SERVICE, DOWN WHEN GOING OUT OF SERVICE, NS_EMPTY_STR, Unknown, DISABLED |
effectivestate |
|
Read-only | Effective state of the LB vserver , based on the state of backup vservers.
Possible values = UP, DOWN, UNKNOWN, BUSY, OUT OF SERVICE, GOING OUT OF SERVICE, DOWN WHEN GOING OUT OF SERVICE, NS_EMPTY_STR, Unknown, DISABLED |
status |
|
Read-only | 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. |
lbrrreason |
|
Read-only | 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 . |
redirect |
|
Read-only | Cache redirect type.
Possible values = CACHE, POLICY, ORIGIN |
precedence |
|
Read-only | Precedence.
Possible values = RULE, URL |
homepage |
|
Read-only | Home page. |
dnsvservername |
|
Read-only | DNS vserver name. |
domain |
|
Read-only | Domain. |
cachevserver |
|
Read-only | Cache virtual server. |
health |
|
Read-only | Health of vserver based on percentage of weights of active svcs/all svcs. This does not consider administratively disabled svcs. |
ruletype |
|
Read-only | Rule type. |
groupname |
|
Read-only | LB group to which the lb vserver is to be bound. |
cookiedomain |
|
Read-only | Domain name to be used in the set cookie header in case of cookie persistence. |
map |
|
Read-only | Map.
Possible values = ON, OFF |
gt2gb |
|
Read-only | Allow for greater than 2 GB transactions on this vserver.
Default value: DISABLED Possible values = ENABLED, DISABLED |
consolidatedlconn |
|
Read-only | Use consolidated stats for LeastConnection.
Default value: GLOBAL Possible values = GLOBAL, NO, YES |
consolidatedlconngbl |
|
Read-only | Fetches Global setting.
Possible values = YES, NO |
thresholdvalue |
|
Read-only | Tells whether threshold exceeded for this service participating in CUSTOMLB. |
bindpoint |
|
Read-only | The bindpoint to which the policy is bound.
Possible values = REQUEST, RESPONSE, MQTT_JUMBO_REQ |
version |
|
Read-only | Cookie version. |
totalservices |
|
Read-only | Total number of services bound to the vserver. |
activeservices |
|
Read-only | Total number of active services bound to the vserver. |
statechangetimesec |
|
Read-only | Time when last state change happened. Seconds part. |
statechangetimeseconds |
|
Read-only | Time when last state change happened. Seconds part. |
statechangetimemsec |
|
Read-only | Time at which last state change happened. Milliseconds part. |
tickssincelaststatechange |
|
Read-only | Time in 10 millisecond ticks since the last state change. |
isgslb |
|
Read-only | This field is set to true if it is a GSLBVserver. |
vsvrdynconnsothreshold |
|
Read-only | Spillover threshold for dynamic connection. |
backupvserverstatus |
|
Read-only | Staus of BackUp Vserver . |
nodefaultbindings |
|
Read-only | to determine if the configuration will have default ssl CIPHER and ECC curve bindings.
Default value: NO Possible values = YES, NO |
currentactiveorder |
|
Read-only | current order that takes the traffic in case service or servicegroup is bound with order. |
__count |
|
Read-only | count parameter |
Operations
(click to see Properties )
- ADD
- DELETE
- UPDATE
- UNSET
- ENABLE
- DISABLE
- GET (ALL)
- GET
- COUNT
- RENAME
Some options that you can use for each operations:
-
Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the 'warning' query parameter as 'yes'. For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:
http:// <netscaler-ip-address> /nitro/v1/config/login?warning=yes
If any, the warnings are displayed in the response payload with the HTTP code '209 X-NITRO-WARNING'.
-
Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,
To do this, you must specify the username and password in the request header of the NITRO request as follows:
X-NITRO-USER: <username>
X-NITRO-PASS: <password>
Note: In such cases, make sure that the request header DOES not include the following:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
*Note:
*
Mandatory parameters are marked in
red
and placeholder content is marked in
green
add
URL: http:// <netscaler-ip-address> /nitro/v1/config/lbvserver HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"lbvserver":{
<b>"name":<String_value>,
</b><b>"servicetype":<String_value>,
</b>"ipv46":<String_value>,
"ippattern":<String_value>,
"ipmask":<String_value>,
"port":<Integer_value>,
"ipset":<String_value>,
"range":<Double_value>,
"persistencetype":<String_value>,
"timeout":<Double_value>,
"persistencebackup":<String_value>,
"backuppersistencetimeout":<Double_value>,
"lbmethod":<String_value>,
"hashlength":<Double_value>,
"netmask":<String_value>,
"v6netmasklen":<Double_value>,
"backuplbmethod":<String_value>,
"cookiename":<String_value>,
"rule":<String_value>,
"listenpolicy":<String_value>,
"listenpriority":<Double_value>,
"resrule":<String_value>,
"persistmask":<String_value>,
"v6persistmasklen":<Double_value>,
"rtspnat":<String_value>,
"m":<String_value>,
"tosid":<Double_value>,
"datalength":<Double_value>,
"dataoffset":<Double_value>,
"sessionless":<String_value>,
"trofspersistence":<String_value>,
"state":<String_value>,
"connfailover":<String_value>,
"redirurl":<String_value>,
"cacheable":<String_value>,
"clttimeout":<Double_value>,
"somethod":<String_value>,
"sopersistence":<String_value>,
"sopersistencetimeout":<Double_value>,
"healththreshold":<Double_value>,
"sothreshold":<Double_value>,
"sobackupaction":<String_value>,
"redirectportrewrite":<String_value>,
"downstateflush":<String_value>,
"backupvserver":<String_value>,
"disableprimaryondown":<String_value>,
"insertvserveripport":<String_value>,
"vipheader":<String_value>,
"authenticationhost":<String_value>,
"authentication":<String_value>,
"authn401":<String_value>,
"authnvsname":<String_value>,
"push":<String_value>,
"pushvserver":<String_value>,
"pushlabel":<String_value>,
"pushmulticlients":<String_value>,
"tcpprofilename":<String_value>,
"httpprofilename":<String_value>,
"dbprofilename":<String_value>,
"comment":<String_value>,
"l2conn":<String_value>,
"oracleserverversion":<String_value>,
"mssqlserverversion":<String_value>,
"mysqlprotocolversion":<Double_value>,
"mysqlserverversion":<String_value>,
"mysqlcharacterset":<Double_value>,
"mysqlservercapabilities":<Double_value>,
"appflowlog":<String_value>,
"netprofile":<String_value>,
"icmpvsrresponse":<String_value>,
"rhistate":<String_value>,
"newservicerequest":<Double_value>,
"newservicerequestunit":<String_value>,
"newservicerequestincrementinterval":<Double_value>,
"minautoscalemembers":<Double_value>,
"maxautoscalemembers":<Double_value>,
"persistavpno":<Double[]_value>,
"skippersistency":<String_value>,
"td":<Double_value>,
"authnprofile":<String_value>,
"macmoderetainvlan":<String_value>,
"dbslb":<String_value>,
"dns64":<String_value>,
"bypassaaaa":<String_value>,
"recursionavailable":<String_value>,
"processlocal":<String_value>,
"dnsprofilename":<String_value>,
"lbprofilename":<String_value>,
"redirectfromport":<Integer_value>,
"httpsredirecturl":<String_value>,
"retainconnectionsoncluster":<String_value>,
"adfsproxyprofile":<String_value>,
"tcpprobeport":<Integer_value>,
"quicprofilename":<String_value>,
"quicbridgeprofilename":<String_value>,
"probeprotocol":<String_value>,
"probesuccessresponsecode":<String_value>,
"probeport":<Integer_value>,
"toggleorder":<String_value>,
"orderthreshold":<Double_value>
}}
Response: HTTP Status Code on Success: 201 Created
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error
delete
URL: http:// <netscaler-ip-address> /nitro/v1/config/lbvserver/ name_value<String> HTTP Method: DELETE
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Response: HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error
update
URL: http:// <netscaler-ip-address> /nitro/v1/config/lbvserver HTTP Method: PUT
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"lbvserver":{
<b>"name":<String_value>,
</b>"ipv46":<String_value>,
"ipset":<String_value>,
"ippattern":<String_value>,
"ipmask":<String_value>,
"servicename":<String_value>,
"weight":<Double_value>,
"order":<Double_value>,
"persistencetype":<String_value>,
"timeout":<Double_value>,
"persistencebackup":<String_value>,
"backuppersistencetimeout":<Double_value>,
"lbmethod":<String_value>,
"hashlength":<Double_value>,
"netmask":<String_value>,
"v6netmasklen":<Double_value>,
"backuplbmethod":<String_value>,
"rule":<String_value>,
"cookiename":<String_value>,
"resrule":<String_value>,
"persistmask":<String_value>,
"v6persistmasklen":<Double_value>,
"rtspnat":<String_value>,
"m":<String_value>,
"tosid":<Double_value>,
"datalength":<Double_value>,
"dataoffset":<Double_value>,
"sessionless":<String_value>,
"trofspersistence":<String_value>,
"connfailover":<String_value>,
"backupvserver":<String_value>,
"redirurl":<String_value>,
"cacheable":<String_value>,
"clttimeout":<Double_value>,
"somethod":<String_value>,
"sothreshold":<Double_value>,
"sopersistence":<String_value>,
"sopersistencetimeout":<Double_value>,
"healththreshold":<Double_value>,
"sobackupaction":<String_value>,
"redirectportrewrite":<String_value>,
"downstateflush":<String_value>,
"insertvserveripport":<String_value>,
"vipheader":<String_value>,
"disableprimaryondown":<String_value>,
"authenticationhost":<String_value>,
"authentication":<String_value>,
"authn401":<String_value>,
"authnvsname":<String_value>,
"push":<String_value>,
"pushvserver":<String_value>,
"pushlabel":<String_value>,
"pushmulticlients":<String_value>,
"listenpolicy":<String_value>,
"listenpriority":<Double_value>,
"tcpprofilename":<String_value>,
"httpprofilename":<String_value>,
"dbprofilename":<String_value>,
"comment":<String_value>,
"l2conn":<String_value>,
"oracleserverversion":<String_value>,
"mssqlserverversion":<String_value>,
"mysqlprotocolversion":<Double_value>,
"mysqlserverversion":<String_value>,
"mysqlcharacterset":<Double_value>,
"mysqlservercapabilities":<Double_value>,
"appflowlog":<String_value>,
"netprofile":<String_value>,
"icmpvsrresponse":<String_value>,
"rhistate":<String_value>,
"newservicerequest":<Double_value>,
"newservicerequestunit":<String_value>,
"newservicerequestincrementinterval":<Double_value>,
"minautoscalemembers":<Double_value>,
"maxautoscalemembers":<Double_value>,
"persistavpno":<Double[]_value>,
"skippersistency":<String_value>,
"authnprofile":<String_value>,
"macmoderetainvlan":<String_value>,
"dbslb":<String_value>,
"dns64":<String_value>,
"bypassaaaa":<String_value>,
"recursionavailable":<String_value>,
"processlocal":<String_value>,
"dnsprofilename":<String_value>,
"lbprofilename":<String_value>,
"redirectfromport":<Integer_value>,
"httpsredirecturl":<String_value>,
"retainconnectionsoncluster":<String_value>,
"adfsproxyprofile":<String_value>,
"tcpprobeport":<Integer_value>,
"quicprofilename":<String_value>,
"quicbridgeprofilename":<String_value>,
"probeport":<Integer_value>,
"probeprotocol":<String_value>,
"probesuccessresponsecode":<String_value>,
"toggleorder":<String_value>,
"orderthreshold":<Double_value>
}}
Response: HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error
unset
URL: http:// <netscaler-ip-address> /nitro/v1/config/lbvserver? action=unset HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"lbvserver":{
<b>"name":<String_value>,
</b>"backupvserver":true,
"clttimeout":true,
"redirurl":true,
"redirurlflags":true,
"authn401":true,
"authentication":true,
"authenticationhost":true,
"authnvsname":true,
"pushvserver":true,
"pushlabel":true,
"tcpprofilename":true,
"httpprofilename":true,
"dbprofilename":true,
"rule":true,
"sothreshold":true,
"l2conn":true,
"mysqlprotocolversion":true,
"mysqlserverversion":true,
"mysqlcharacterset":true,
"mysqlservercapabilities":true,
"appflowlog":true,
"netprofile":true,
"icmpvsrresponse":true,
"skippersistency":true,
"minautoscalemembers":true,
"maxautoscalemembers":true,
"authnprofile":true,
"macmoderetainvlan":true,
"dbslb":true,
"dnsprofilename":true,
"lbprofilename":true,
"redirectfromport":true,
"httpsredirecturl":true,
"adfsproxyprofile":true,
"tcpprobeport":true,
"quicprofilename":true,
"quicbridgeprofilename":true,
"probeprotocol":true,
"servicename":true,
"order":true,
"ipset":true,
"persistencetype":true,
"timeout":true,
"persistencebackup":true,
"backuppersistencetimeout":true,
"lbmethod":true,
"hashlength":true,
"netmask":true,
"v6netmasklen":true,
"backuplbmethod":true,
"cookiename":true,
"resrule":true,
"persistmask":true,
"v6persistmasklen":true,
"rtspnat":true,
"m":true,
"tosid":true,
"datalength":true,
"dataoffset":true,
"sessionless":true,
"trofspersistence":true,
"connfailover":true,
"cacheable":true,
"somethod":true,
"sopersistence":true,
"sopersistencetimeout":true,
"healththreshold":true,
"sobackupaction":true,
"redirectportrewrite":true,
"downstateflush":true,
"insertvserveripport":true,
"vipheader":true,
"disableprimaryondown":true,
"push":true,
"pushmulticlients":true,
"listenpolicy":true,
"listenpriority":true,
"comment":true,
"oracleserverversion":true,
"mssqlserverversion":true,
"rhistate":true,
"newservicerequest":true,
"newservicerequestunit":true,
"newservicerequestincrementinterval":true,
"persistavpno":true,
"recursionavailable":true,
"retainconnectionsoncluster":true,
"probesuccessresponsecode":true,
"toggleorder":true,
"orderthreshold":true
}}
Response: HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error
enable
URL: http:// <netscaler-ip-address> /nitro/v1/config/lbvserver? action=enable HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"lbvserver":{
<b>"name":<String_value>
</b>}}
Response: HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error
disable
URL: http:// <netscaler-ip-address> /nitro/v1/config/lbvserver? action=disable HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"lbvserver":{
<b>"name":<String_value>
</b>}}
Response: HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error
rename
URL: http:// <netscaler-ip-address> /nitro/v1/config/lbvserver? action=rename HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"lbvserver":{
<b>"name":<String_value>,
</b><b>"newname":<String_value>
</b>}}
Response: HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error
get (all)
URL: http:// <netscaler-ip-address> /nitro/v1/config/lbvserver Query-parameters: attrs http:// <netscaler-ip-address> /nitro/v1/config/lbvserver? attrs=property-name1,property-name2
Use this query parameter to specify the resource details that you want to retrieve.
filter http:// <netscaler-ip-address> /nitro/v1/config/lbvserver? filter=property-name1:property-val1,property-name2:property-val2
Use this query-parameter to get the filtered set of lbvserver resources configured on NetScaler.Filtering can be done on any of the properties of the resource.
view http:// <netscaler-ip-address> /nitro/v1/config/lbvserver? view=summary
Use this query-parameter to get the summary output of lbvserver resources configured on NetScaler.
Note: By default, the retrieved results are displayed in detail view (?view=detail).
pagination http:// <netscaler-ip-address> /nitro/v1/config/lbvserver? pagesize=#no;pageno=#no
Use this query-parameter to get the lbvserver resources in chunks.
HTTP Method: GET
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Accept:application/json
Response: HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error
Response Header:
Content-Type:application/json
Response Payload:
{ "lbvserver": [ {
"name":<String_value>,
"insertvserveripport":<String_value>,
"vipheader":<String_value>,
"value":<String_value>,
"ip":<String_value>,
"ipv46":<String_value>,
"ippattern":<String_value>,
"ipmask":<String_value>,
"listenpolicy":<String_value>,
"listenpriority":<Double_value>,
"ipmapping":<String_value>,
"port":<Integer_value>,
"ipset":<String_value>,
"range":<Double_value>,
"servicetype":<String_value>,
"ngname":<String_value>,
"type":<String_value>,
"curstate":<String_value>,
"effectivestate":<String_value>,
"status":<Integer_value>,
"lbrrreason":<Integer_value>,
"redirect":<String_value>,
"precedence":<String_value>,
"redirurl":<String_value>,
"authentication":<String_value>,
"authn401":<String_value>,
"authnvsname":<String_value>,
"homepage":<String_value>,
"dnsvservername":<String_value>,
"domain":<String_value>,
"servicename":<String_value>,
"weight":<Double_value>,
"cachevserver":<String_value>,
"backupvserver":<String_value>,
"clttimeout":<Double_value>,
"somethod":<String_value>,
"sopersistence":<String_value>,
"sopersistencetimeout":<Double_value>,
"healththreshold":<Double_value>,
"sothreshold":<Double_value>,
"sobackupaction":<String_value>,
"lbmethod":<String_value>,
"backuplbmethod":<String_value>,
"hashlength":<Double_value>,
"dataoffset":<Double_value>,
"health":<Double_value>,
"datalength":<Double_value>,
"netmask":<String_value>,
"v6netmasklen":<Double_value>,
"rule":<String_value>,
"resrule":<String_value>,
"ruletype":<Double_value>,
"groupname":<String_value>,
"m":<String_value>,
"tosid":<Double_value>,
"persistencetype":<String_value>,
"timeout":<Double_value>,
"cookiedomain":<String_value>,
"persistmask":<String_value>,
"v6persistmasklen":<Double_value>,
"persistencebackup":<String_value>,
"backuppersistencetimeout":<Double_value>,
"cacheable":<String_value>,
"rtspnat":<String_value>,
"sessionless":<String_value>,
"trofspersistence":<String_value>,
"map":<String_value>,
"connfailover":<String_value>,
"redirectportrewrite":<String_value>,
"downstateflush":<String_value>,
"disableprimaryondown":<String_value>,
"gt2gb":<String_value>,
"consolidatedlconn":<String_value>,
"consolidatedlconngbl":<String_value>,
"thresholdvalue":<Integer_value>,
"bindpoint":<String_value>,
"cookiename":<String_value>,
"version":<Integer_value>,
"totalservices":<Double_value>,
"activeservices":<Double_value>,
"statechangetimesec":<String_value>,
"statechangetimeseconds":<Double_value>,
"statechangetimemsec":<Double_value>,
"tickssincelaststatechange":<Double_value>,
"authenticationhost":<String_value>,
"push":<String_value>,
"pushvserver":<String_value>,
"pushlabel":<String_value>,
"pushmulticlients":<String_value>,
"tcpprofilename":<String_value>,
"httpprofilename":<String_value>,
"dbprofilename":<String_value>,
"comment":<String_value>,
"l2conn":<String_value>,
"oracleserverversion":<String_value>,
"mssqlserverversion":<String_value>,
"mysqlprotocolversion":<Double_value>,
"mysqlserverversion":<String_value>,
"mysqlcharacterset":<Double_value>,
"mysqlservercapabilities":<Double_value>,
"appflowlog":<String_value>,
"netprofile":<String_value>,
"isgslb":<Boolean_value>,
"icmpvsrresponse":<String_value>,
"rhistate":<String_value>,
"newservicerequest":<Double_value>,
"newservicerequestunit":<String_value>,
"newservicerequestincrementinterval":<Double_value>,
"persistavpno":<Double[]_value>,
"skippersistency":<String_value>,
"td":<Double_value>,
"minautoscalemembers":<Double_value>,
"maxautoscalemembers":<Double_value>,
"authnprofile":<String_value>,
"macmoderetainvlan":<String_value>,
"dbslb":<String_value>,
"dns64":<String_value>,
"bypassaaaa":<String_value>,
"recursionavailable":<String_value>,
"processlocal":<String_value>,
"vsvrdynconnsothreshold":<Double_value>,
"backupvserverstatus":<String_value>,
"dnsprofilename":<String_value>,
"lbprofilename":<String_value>,
"redirectfromport":<Integer_value>,
"httpsredirecturl":<String_value>,
"retainconnectionsoncluster":<String_value>,
"nodefaultbindings":<String_value>,
"adfsproxyprofile":<String_value>,
"tcpprobeport":<Integer_value>,
"quicbridgeprofilename":<String_value>,
"probeprotocol":<String_value>,
"probeport":<Integer_value>,
"probesuccessresponsecode":<String_value>,
"quicprofilename":<String_value>,
"order":<Double_value>,
"toggleorder":<String_value>,
"orderthreshold":<Double_value>,
"currentactiveorder":<String_value>
}]}
get
URL: http:// <netscaler-ip-address> /nitro/v1/config/lbvserver/ name_value<String> Query-parameters: attrs http:// <netscaler-ip-address> /nitro/v1/config/lbvserver/ name_value<String> ? attrs=property-name1,property-name2
Use this query parameter to specify the resource details that you want to retrieve.
view http:// <netscaler-ip-address> /nitro/v1/config/lbvserver/ name_value<String> ? view=summary
Use this query-parameter to get the summary output of lbvserver resources configured on NetScaler.
Note: By default, the retrieved results are displayed in detail view (?view=detail).
HTTP Method: GET
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Accept:application/json
Response: HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error
Response Header:
Content-Type:application/json
Response Payload:
{ "lbvserver": [ {
"name":<String_value>,
"insertvserveripport":<String_value>,
"vipheader":<String_value>,
"value":<String_value>,
"ip":<String_value>,
"ipv46":<String_value>,
"ippattern":<String_value>,
"ipmask":<String_value>,
"listenpolicy":<String_value>,
"listenpriority":<Double_value>,
"ipmapping":<String_value>,
"port":<Integer_value>,
"ipset":<String_value>,
"range":<Double_value>,
"servicetype":<String_value>,
"ngname":<String_value>,
"type":<String_value>,
"curstate":<String_value>,
"effectivestate":<String_value>,
"status":<Integer_value>,
"lbrrreason":<Integer_value>,
"redirect":<String_value>,
"precedence":<String_value>,
"redirurl":<String_value>,
"authentication":<String_value>,
"authn401":<String_value>,
"authnvsname":<String_value>,
"homepage":<String_value>,
"dnsvservername":<String_value>,
"domain":<String_value>,
"servicename":<String_value>,
"weight":<Double_value>,
"cachevserver":<String_value>,
"backupvserver":<String_value>,
"clttimeout":<Double_value>,
"somethod":<String_value>,
"sopersistence":<String_value>,
"sopersistencetimeout":<Double_value>,
"healththreshold":<Double_value>,
"sothreshold":<Double_value>,
"sobackupaction":<String_value>,
"lbmethod":<String_value>,
"backuplbmethod":<String_value>,
"hashlength":<Double_value>,
"dataoffset":<Double_value>,
"health":<Double_value>,
"datalength":<Double_value>,
"netmask":<String_value>,
"v6netmasklen":<Double_value>,
"rule":<String_value>,
"resrule":<String_value>,
"ruletype":<Double_value>,
"groupname":<String_value>,
"m":<String_value>,
"tosid":<Double_value>,
"persistencetype":<String_value>,
"timeout":<Double_value>,
"cookiedomain":<String_value>,
"persistmask":<String_value>,
"v6persistmasklen":<Double_value>,
"persistencebackup":<String_value>,
"backuppersistencetimeout":<Double_value>,
"cacheable":<String_value>,
"rtspnat":<String_value>,
"sessionless":<String_value>,
"trofspersistence":<String_value>,
"map":<String_value>,
"connfailover":<String_value>,
"redirectportrewrite":<String_value>,
"downstateflush":<String_value>,
"disableprimaryondown":<String_value>,
"gt2gb":<String_value>,
"consolidatedlconn":<String_value>,
"consolidatedlconngbl":<String_value>,
"thresholdvalue":<Integer_value>,
"bindpoint":<String_value>,
"cookiename":<String_value>,
"version":<Integer_value>,
"totalservices":<Double_value>,
"activeservices":<Double_value>,
"statechangetimesec":<String_value>,
"statechangetimeseconds":<Double_value>,
"statechangetimemsec":<Double_value>,
"tickssincelaststatechange":<Double_value>,
"authenticationhost":<String_value>,
"push":<String_value>,
"pushvserver":<String_value>,
"pushlabel":<String_value>,
"pushmulticlients":<String_value>,
"tcpprofilename":<String_value>,
"httpprofilename":<String_value>,
"dbprofilename":<String_value>,
"comment":<String_value>,
"l2conn":<String_value>,
"oracleserverversion":<String_value>,
"mssqlserverversion":<String_value>,
"mysqlprotocolversion":<Double_value>,
"mysqlserverversion":<String_value>,
"mysqlcharacterset":<Double_value>,
"mysqlservercapabilities":<Double_value>,
"appflowlog":<String_value>,
"netprofile":<String_value>,
"isgslb":<Boolean_value>,
"icmpvsrresponse":<String_value>,
"rhistate":<String_value>,
"newservicerequest":<Double_value>,
"newservicerequestunit":<String_value>,
"newservicerequestincrementinterval":<Double_value>,
"persistavpno":<Double[]_value>,
"skippersistency":<String_value>,
"td":<Double_value>,
"minautoscalemembers":<Double_value>,
"maxautoscalemembers":<Double_value>,
"authnprofile":<String_value>,
"macmoderetainvlan":<String_value>,
"dbslb":<String_value>,
"dns64":<String_value>,
"bypassaaaa":<String_value>,
"recursionavailable":<String_value>,
"processlocal":<String_value>,
"vsvrdynconnsothreshold":<Double_value>,
"backupvserverstatus":<String_value>,
"dnsprofilename":<String_value>,
"lbprofilename":<String_value>,
"redirectfromport":<Integer_value>,
"httpsredirecturl":<String_value>,
"retainconnectionsoncluster":<String_value>,
"nodefaultbindings":<String_value>,
"adfsproxyprofile":<String_value>,
"tcpprobeport":<Integer_value>,
"quicbridgeprofilename":<String_value>,
"probeprotocol":<String_value>,
"probeport":<Integer_value>,
"probesuccessresponsecode":<String_value>,
"quicprofilename":<String_value>,
"order":<Double_value>,
"toggleorder":<String_value>,
"orderthreshold":<Double_value>,
"currentactiveorder":<String_value>
}]}
count
URL: http:// <netscaler-ip-address> /nitro/v1/config/lbvserver? count=yes HTTP Method: GET
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Accept:application/json
Response: HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error
Response Header:
Content-Type:application/json
Response Payload:
{ "lbvserver": [ { "__count": "#no"} ] }