Download full document:

perf_lb_vserver_report

Configuration for LBVServer resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
pktssentrate<Double>Read-writepktssentrate Value.
curclntconnections<Double>Read-writecurclntconnections Value.
vsvrName<String>Read-writevsvrName Value.
timestamp<Double>Read-writetimestamp in milliseconds.
totalresponsebytes<Double>Read-writeTotal Response Bytes Value.
id<String>Read-writeId is system generated key for all the entries in this perf table configuration.
Maximum length = 256
pktsrecvdrate<Double>Read-writepktsrecvdrate Value.
surgecount<Double>Read-writesurgecount Value.
requestbytesrate<Double>Read-writerequestbytesrate Value.
responsebytesrate<Double>Read-writeresponsebytesrate Value.
cursrvrconnections<Double>Read-writecursrvrconnections Value.
svcsurgecount<Double>Read-writesvcsurgecount Value.
device_ip_address<String>Read-writeDevice IP Address.
Minimum length = 1
Maximum length = 64
vsvrsurgecount<Double>Read-writevsvrsurgecount Value.
totalrequestbytes<Double>Read-writeTotal Request Bytes Value.
hitsrate<Double>Read-writeHits Rate Value.
throughput_avg<Double>Read-writeAverage of throughput across all apps which have same IP address and Vserver name.
report_start_time<Double>Read-writereport_start_time in seconds.
report_end_time<Double>Read-writereport_end_time in seconds.
apps_count<Integer>Read-writeNo 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>.

get

URL: https://<MGMT-IP>/nitro/v1/config/perf_lb_vserver_report

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "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>,
"surgecount":<Double_value>,
"requestbytesrate":<Double_value>,
"responsebytesrate":<Double_value>,
"cursrvrconnections":<Double_value>,
"svcsurgecount":<Double_value>,
"device_ip_address":<String_value>,
"vsvrsurgecount":<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>}]}