Product Documentation

vpath

Sep 08, 2016

Statistics for Vpath resource.

Properties (click to see Operations)

Name Data Type Permissions Description
clearstats
<String>
Read-write
Clear the statsistics / counters.
Possible values = basic, full
vpathtotl2datarx
<Double>
Read-only
Total number of non-fragmented vPath data packets decapsulated in L2 adjacency
vpathl2datarxrate
<Double>
Read-only
Rate (/s) counter for vpathtotl2datarx
vpathtotl3datarx
<Double>
Read-only
Total number of non-fragmented vPath data packets decapsulated in L3 adjacency
vpathl3datarxrate
<Double>
Read-only
Rate (/s) counter for vpathtotl3datarx
vpathtotl2cntrlpkts
<Double>
Read-only
Total number of vPath control packets received in L2 adjacency
vpathl2cntrlpktsrate
<Double>
Read-only
Rate (/s) counter for vpathtotl2cntrlpkts
vpathtotl3cntrlpkts
<Double>
Read-only
Total number of vPath control packets received in L3 adjacency
vpathl3cntrlpktsrate
<Double>
Read-only
Rate (/s) counter for vpathtotl3cntrlpkts
vpathtotfragpkts
<Double>
Read-only
Total number of vPath fragments received
vpathfragpktsrate
<Double>
Read-only
Rate (/s) counter for vpathtotfragpkts
vpathtotl2encappkts
<Double>
Read-only
Total number of L2 vPath encapsulated packets injected to VEM
vpathl2encappktsrate
<Double>
Read-only
Rate (/s) counter for vpathtotl2encappkts
vpathtotl3encappkts
<Double>
Read-only
Total number of L3 vPath encapsulated packets injected to VEM
vpathl3encappktsrate
<Double>
Read-only
Rate (/s) counter for vpathtotl3encappkts
vpathtotfragencappkts
<Double>
Read-only
Number of fragmented vPath packets transmitted
vpathfragencappktsrate
<Double>
Read-only
Rate (/s) counter for vpathtotfragencappkts
vpathtotoffload
<Double>
Read-only
Number of offloaded vPath packets transmitted
vpathoffloadrate
<Double>
Read-only
Rate (/s) counter for vpathtotoffload

Operations (click to see Properties)

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>

메모

Mandatory parameters are marked in red and placeholder content is marked in <green>.

get (all)

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

Query-parameters:

args

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

Use this query-parameter to get vpath 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 Headers:

Content-Type:application/json

Response Payload:

{ "vpath": [ {
      "vpathfragencappktsrate":<Double_value>,
      "vpathtotl2cntrlpkts":<Double_value>,
      "vpathtotoffload":<Double_value>,
      "vpathtotl3encappkts":<Double_value>,
      "vpathtotl2datarx":<Double_value>,
      "vpathtotl2encappkts":<Double_value>,
      "vpathoffloadrate":<Double_value>,
      "vpathl3cntrlpktsrate":<Double_value>,
      "vpathfragpktsrate":<Double_value>,
      "vpathtotl3datarx":<Double_value>,
      "vpathtotl3cntrlpkts":<Double_value>,
      "vpathtotfragencappkts":<Double_value>,
      "vpathl3encappktsrate":<Double_value>,
      "vpathl2encappktsrate":<Double_value>,
      "vpathl2cntrlpktsrate":<Double_value>,
      "vpathl3datarxrate":<Double_value>,
      "vpathl2datarxrate":<Double_value>,
      "vpathtotfragpkts":<Double_value>
}]}