Download full document:

vxlan

Statistics for "VXLAN" resource.

Properties

(click to see Operations)

Name	Data Type	Permissions	Description
id	<Double>	Read-write	An integer specifying the VXLAN identification number (VNID).<br>Minimum value = 1<br>Maximum value = 16777215
clearstats	<String>	Read-write	Clear the statsistics / counters.<br>Possible values = basic, full
vxlantotrxpkts	<Double>	Read-only	Packets received on the VXLAN.
vxlanrxpktsrate	<Double>	Read-only	Rate (/s) counter for vxlantotrxpkts
vxlantotrxbytes	<Double>	Read-only	Bytes of data received on the VXLAN.
vxlanrxbytesrate	<Double>	Read-only	Rate (/s) counter for vxlantotrxbytes
vxlantottxpkts	<Double>	Read-only	Packets transmitted on the VXLAN.
vxlantxpktsrate	<Double>	Read-only	Rate (/s) counter for vxlantottxpkts
vxlantottxbytes	<Double>	Read-only	Bytes of data transmitted on the VXLAN.
vxlantxbytesrate	<Double>	Read-only	Rate (/s) counter for vxlantottxbytes

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/vxlan

Query-parameters:

args

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

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

Content-Type:application/json

Response Payload:

{ "vxlan": [ {
      "id":<Double_value>,
      "vxlanrxbytesrate":<Double_value>,
      "vxlantottxpkts":<Double_value>,
      "vxlanrxpktsrate":<Double_value>,
      "vxlantotrxbytes":<Double_value>,
      "vxlantxbytesrate":<Double_value>,
      "vxlantxpktsrate":<Double_value>,
      "vxlantottxbytes":<Double_value>,
      "vxlantotrxpkts":<Double_value>
}]}

get

URL: http://<netscaler-ip-address>/nitro/v1/stat/vxlan/id_value><Double>