Skip to content

vlan

Statistics for "VLAN" resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
id <Double> Read-write An integer specifying the VLAN identification number (VID). Possible values: 1 through 4094.

Minimum value = 1

Maximum value = 4094
clearstats <String> Read-write Clear the statsistics / counters.

Possible values = basic, full
vlantotrxpkts <Double> Read-only Packets received on the VLAN.
vlanrxpktsrate <Double> Read-only Rate (/s) counter for vlantotrxpkts
vlantotrxbytes <Double> Read-only Bytes of data received on the VLAN.
vlanrxbytesrate <Double> Read-only Rate (/s) counter for vlantotrxbytes
vlantottxpkts <Double> Read-only Packets transmitted on the VLAN.
vlantxpktsrate <Double> Read-only Rate (/s) counter for vlantottxpkts
vlantottxbytes <Double> Read-only Bytes of data transmitted on the VLAN.
vlantxbytesrate <Double> Read-only Rate (/s) counter for vlantottxbytes
vlantotdroppedpkts <Double> Read-only Inbound packets dropped by the VLAN upon reception.
vlantotbroadcastpkts <Double> Read-only Broadcast packets sent and received on the VLAN.

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

Query-parameters:

args

http:// <netscaler-ip-address> /nitro/v1/stat/vlan? 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 vlan 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:

{  "vlan": [ {
      "id":<Double_value>,
      "vlanrxbytesrate":<Double_value>,
      "vlantottxpkts":<Double_value>,
      "vlantotdroppedpkts":<Double_value>,
      "vlanrxpktsrate":<Double_value>,
      "vlantotrxpkts":<Double_value>,
      "vlantotbroadcastpkts":<Double_value>,
      "vlantxbytesrate":<Double_value>,
      "vlantotrxbytes":<Double_value>,
      "vlantxpktsrate":<Double_value>,
      "vlantottxbytes":<Double_value>
}]}

get

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

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:

{  "vlan": [ {
      "id":<Double_value>,
      "vlanrxbytesrate":<Double_value>,
      "vlantottxpkts":<Double_value>,
      "vlantotdroppedpkts":<Double_value>,
      "vlanrxpktsrate":<Double_value>,
      "vlantotrxpkts":<Double_value>,
      "vlantotbroadcastpkts":<Double_value>,
      "vlantxbytesrate":<Double_value>,
      "vlantotrxbytes":<Double_value>,
      "vlantxpktsrate":<Double_value>,
      "vlantottxbytes":<Double_value>
}]}