perf_lb_vserver_report

Last published : Aug 10, 2026
Configuration for LBVServer resource.
Related information

Properties

(click to see Operations )
Name Data Type Permissions Description
pktssentrate <Double> Read-write pktssentrate Value.
curclntconnections <Double> Read-write curclntconnections Value.
vsvrName <String> Read-write vsvrName Value.
timestamp <Double> Read-write timestamp in milliseconds.
totalresponsebytes <Double> Read-write Total Response Bytes Value.
id <String> Read-write Id is system generated key for all the entries in this perf table configuration. Maximum length = 256
pktsrecvdrate <Double> Read-write pktsrecvdrate Value.
agg_level <Integer> Read-write whether the row is Aggregated for Avg, Min, Max etc.
surgecount <Double> Read-write surgecount Value.
requestbytesrate <Double> Read-write requestbytesrate Value.
responsebytesrate <Double> Read-write responsebytesrate Value.
cursrvrconnections <Double> Read-write cursrvrconnections Value.
svcsurgecount <Double> Read-write svcsurgecount Value.
totalpktssent <Double> Read-write totalpktssent Value .
report_level <Integer> Read-write whether the row is for minutely, hourly etc.
device_ip_address <String> Read-write Device IP Address. Minimum length = 1 Maximum length = 64
vsvrsurgecount <Double> Read-write vsvrsurgecount Value.
totalpktsrecvd <Double> Read-write totalpktsrecvd Value.
totalrequestbytes <Double> Read-write Total Request Bytes Value.
hitsrate <Double> Read-write Hits Rate Value.
throughput_avg <Double> Read-write Average of throughput across all apps which have same IP address and Vserver name.
report_start_time <Double> Read-write report_start_time in seconds.
report_end_time <Double> Read-write report_end_time in seconds.
apps_count <Integer> Read-write No of apps associated with a LB Vserver.

Operations

(click to see Properties )
  • 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
The following parameters can be used in the nitro request : onerror <String_value>
Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.
Default value: EXIT
Possible values = EXIT, CONTINUE

get

URL: https://<MGMT-IP>/nitro/v2/config/perf_lb_vserver_report HTTPS Method: GET
Request Headers: Accept: application/json
X-NITRO-USER:username_value<String>
X-NITRO-PASS:password_value<String>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error
Response Headers:
Content-Type:application/json
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "perf_lb_vserver_report":[{
"pktssentrate":<Double_value>,
"curclntconnections":<Double_value>,
"vsvrName":<String_value>,
"timestamp":<Double_value>,
"totalresponsebytes":<Double_value>,
"id":<String_value>,
"pktsrecvdrate":<Double_value>,
"agg_level":<Integer_value>,
"surgecount":<Double_value>,
"requestbytesrate":<Double_value>,
"responsebytesrate":<Double_value>,
"cursrvrconnections":<Double_value>,
"svcsurgecount":<Double_value>,
"totalpktssent":<Double_value>,
"report_level":<Integer_value>,
"device_ip_address":<String_value>,
"vsvrsurgecount":<Double_value>,
"totalpktsrecvd":<Double_value>,
"totalrequestbytes":<Double_value>,
"hitsrate":<Double_value>,
"throughput_avg":<Double_value>,
"report_start_time":<Double_value>,
"report_end_time":<Double_value>,
"apps_count":<Integer_value>}]}