Skip to content

lbvserver

Statistics for Load Balancing Virtual Server resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
name <String> Read-write Name of the virtual server. If no name is provided, statistical data of all configured virtual servers is displayed.

Minimum length = 1
clearstats <String> Read-write Clear the statsistics / counters.

Possible values = basic, full
sortby <String> Read-write use this argument to sort by specific key.

Possible values =
sortorder <String> Read-write use this argument to specify sort order.

Default value: SORT_DESCENDING

Possible values = ascending, descending
avgcltttlb <Double> Read-only Average TTLB between the client and the server. TTLB is the time interval between sending the request packet to a service and receiving the ACK for response from client.
cltresponsetimeapdex <Double> Read-only Vserver APDEX index based on client response times.
vsvrsurgecount <Double> Read-only Number of requests waiting on this vserver.
establishedconn <Double> Read-only Number of client connections in ESTABLISHED state.
inactsvcs <Double> Read-only number of INACTIVE services bound to a vserver
vslbhealth <Double> Read-only Health of the vserver. This gives percentage of UP services bound to this vserver.
primaryipaddress <String> Read-only IP address of the vserver
primaryport <Integer> Read-only The port on which the service is running.
type <String> Read-only Protocol associated with the vserver
state <String> Read-only Current state of the server. There are seven possible values: UP(7), DOWN(1), UNKNOWN(2), BUSY(3), OFS(Out of Service)(4), TROFS(Transition Out of Service)(5), TROFS_DOWN(Down When going Out of Service)(8)
actsvcs <Double> Read-only number of ACTIVE services bound to a vserver
tothits <Double> Read-only Total vserver hits
hitsrate <Double> Read-only Rate (/s) counter for tothits
totalrequests <Double> Read-only Total number of requests received on this service or virtual server. (This applies to HTTP/SSL services and servers.)
requestsrate <Double> Read-only Rate (/s) counter for totalrequests
totalresponses <Double> Read-only Number of responses received on this service or virtual server. (This applies to HTTP/SSL services and servers.)
responsesrate <Double> Read-only Rate (/s) counter for totalresponses
totalrequestbytes <Double> Read-only Total number of request bytes received on this service or virtual server.
requestbytesrate <Double> Read-only Rate (/s) counter for totalrequestbytes
totalresponsebytes <Double> Read-only Number of response bytes received by this service or virtual server.
responsebytesrate <Double> Read-only Rate (/s) counter for totalresponsebytes
totalpktsrecvd <Double> Read-only Total number of packets received by this service or virtual server.
pktsrecvdrate <Double> Read-only Rate (/s) counter for totalpktsrecvd
totalpktssent <Double> Read-only Total number of packets sent.
pktssentrate <Double> Read-only Rate (/s) counter for totalpktssent
curclntconnections <Double> Read-only Number of current client connections.
cursrvrconnections <Double> Read-only Number of current connections to the actual servers behind the virtual server.
curpersistencesessions <Double> Read-only current vserver owned persistence sessions
curbackuppersistencesessions <Double> Read-only current vserver owned backup persistence sessions
surgecount <Double> Read-only Number of requests in the surge queue.
svcsurgecount <Double> Read-only Total number of requests in the surge queues of all the services bound to this LB-vserver.
sothreshold <Double> Read-only Spill Over Threshold set on the VServer.
totspillovers <Double> Read-only Number of times vserver experienced spill over.
labelledconn <Double> Read-only Number of Labeled connection on this vserver
pushlabel <Double> Read-only Number of labels for this push vserver.
deferredreq <Double> Read-only Number of deferred request on this vserver
deferredreqrate <Double> Read-only Rate (/s) counter for deferredreq
invalidrequestresponse <Double> Read-only Number invalid requests/responses on this vserver
invalidrequestresponsedropped <Double> Read-only Number invalid requests/responses dropped on this vserver
totvserverdownbackuphits <Double> Read-only Number of times traffic was diverted to backup vserver since primary vserver was DOWN.
curmptcpsessions <Double> Read-only Current Multipath TCP sessions
cursubflowconn <Double> Read-only Current Multipath TCP subflows
totalconnreassemblyqueue75 <Double> Read-only Total no of connections with 75% TCP reassembly queue
totalconnreassemblyqueueflush <Double> Read-only Total no of connections incurred TCP reassembly queue flush
totalsvrbusyerr <Double> Read-only Total no of server busy error
svrbusyerrrate <Double> Read-only Rate (/s) counter for totalsvrbusyerr
httpmaxhdrszpkts <Double> Read-only Number of http max header size packet parsing failures
tcpmaxooopkts <Double> Read-only No of times max out of order packets reached
totcltttlbtransactions <Double> Read-only Total transactions where client TTLB is calculated.
toleratingttlbtransactions <Double> Read-only Tolerable transactions based on APDEX threshold (>T ;; <4T).
frustratingttlbtransactions <Double> Read-only Frustrating transactions based on APDEX threshold (>4T).

Operations

(click to see Properties )

  • GET (ALL)
  • GET

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

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/stat/lbvserver

Query-parameters:

args

http:// <netscaler-ip-address> /nitro/v1/stat/lbvserver? args=name: <String_value> ,detail: <Boolean_value> ,fullvalues: <Boolean_value> ,ntimes: <Double_value> ,logfile: <String_value> ,clearstats: <String_value> ,sortby: <String_value> ,sortorder: <String_value> ,sortorder: <String_value>

Use this query-parameter to get lbvserver resources based on additional properties.

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>,
      "curclntconnections":<Double_value>,
      "establishedconn":<Double_value>,
      "totalpktssent":<Double_value>,
      "labelledconn":<Double_value>,
      "tothits":<Double_value>,
      "totalrequests":<Double_value>,
      "sothreshold":<Double_value>,
      "cursubflowconn":<Double_value>,
      "svrbusyerrrate":<Double_value>,
      "surgecount":<Double_value>,
      "responsebytesrate":<Double_value>,
      "invalidrequestresponsedropped":<Double_value>,
      "totalresponses":<Double_value>,
      "curpersistencesessions":<Double_value>,
      "requestbytesrate":<Double_value>,
      "totalsvrbusyerr":<Double_value>,
      "avgcltttlb":<Double_value>,
      "type":<String_value>,
      "hitsrate":<Double_value>,
      "totalconnreassemblyqueue75":<Double_value>,
      "cursrvrconnections":<Double_value>,
      "totalconnreassemblyqueueflush":<Double_value>,
      "cltresponsetimeapdex":<Double_value>,
      "totcltttlbtransactions":<Double_value>,
      "pktsrecvdrate":<Double_value>,
      "primaryipaddress":<String_value>,
      "vsvrsurgecount":<Double_value>,
      "pushlabel":<Double_value>,
      "toleratingttlbtransactions":<Double_value>,
      "responsesrate":<Double_value>,
      "deferredreq":<Double_value>,
      "curmptcpsessions":<Double_value>,
      "tcpmaxooopkts":<Double_value>,
      "totspillovers":<Double_value>,
      "svcsurgecount":<Double_value>,
      "totalrequestbytes":<Double_value>,
      "invalidrequestresponse":<Double_value>,
      "state":<String_value>,
      "httpmaxhdrszpkts":<Double_value>,
      "vslbhealth":<Double_value>,
      "deferredreqrate":<Double_value>,
      "actsvcs":<Double_value>,
      "totalpktsrecvd":<Double_value>,
      "curbackuppersistencesessions":<Double_value>,
      "pktssentrate":<Double_value>,
      "frustratingttlbtransactions":<Double_value>,
      "totalresponsebytes":<Double_value>,
      "primaryport":<Integer_value>,
      "requestsrate":<Double_value>,
      "totvserverdownbackuphits":<Double_value>,
      "inactsvcs":<Double_value>
}]}

get

URL: http:// <netscaler-ip-address> /nitro/v1/stat/lbvserver/ name_value><String>

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>,
      "curclntconnections":<Double_value>,
      "establishedconn":<Double_value>,
      "totalpktssent":<Double_value>,
      "labelledconn":<Double_value>,
      "tothits":<Double_value>,
      "totalrequests":<Double_value>,
      "sothreshold":<Double_value>,
      "cursubflowconn":<Double_value>,
      "svrbusyerrrate":<Double_value>,
      "surgecount":<Double_value>,
      "responsebytesrate":<Double_value>,
      "invalidrequestresponsedropped":<Double_value>,
      "totalresponses":<Double_value>,
      "curpersistencesessions":<Double_value>,
      "requestbytesrate":<Double_value>,
      "totalsvrbusyerr":<Double_value>,
      "avgcltttlb":<Double_value>,
      "type":<String_value>,
      "hitsrate":<Double_value>,
      "totalconnreassemblyqueue75":<Double_value>,
      "cursrvrconnections":<Double_value>,
      "totalconnreassemblyqueueflush":<Double_value>,
      "cltresponsetimeapdex":<Double_value>,
      "totcltttlbtransactions":<Double_value>,
      "pktsrecvdrate":<Double_value>,
      "primaryipaddress":<String_value>,
      "vsvrsurgecount":<Double_value>,
      "pushlabel":<Double_value>,
      "toleratingttlbtransactions":<Double_value>,
      "responsesrate":<Double_value>,
      "deferredreq":<Double_value>,
      "curmptcpsessions":<Double_value>,
      "tcpmaxooopkts":<Double_value>,
      "totspillovers":<Double_value>,
      "svcsurgecount":<Double_value>,
      "totalrequestbytes":<Double_value>,
      "invalidrequestresponse":<Double_value>,
      "state":<String_value>,
      "httpmaxhdrszpkts":<Double_value>,
      "vslbhealth":<Double_value>,
      "deferredreqrate":<Double_value>,
      "actsvcs":<Double_value>,
      "totalpktsrecvd":<Double_value>,
      "curbackuppersistencesessions":<Double_value>,
      "pktssentrate":<Double_value>,
      "frustratingttlbtransactions":<Double_value>,
      "totalresponsebytes":<Double_value>,
      "primaryport":<Integer_value>,
      "requestsrate":<Double_value>,
      "totvserverdownbackuphits":<Double_value>,
      "inactsvcs":<Double_value>
}]}