Product Documentation

tunnelip

Sep 08, 2016

Statistics for TUNNEL Remote ipaddress resource.

Properties (click to see Operations)

Name Data Type Permissions Description
tunnelip
<String>
Read-write
remote IP address of the configured tunnel.
Minimum length = 1
clearstats
<String>
Read-write
Clear the statsistics / counters.
Possible values = basic, full
tnltotrxpkts
<Double>
Read-only
Total number of packets received on the tunnel.
tnlrxpktsrate
<Double>
Read-only
Rate (/s) counter for tnltotrxpkts
tnltottxpkts
<Double>
Read-only
Total number of packets transmitted on the tunnel.
tnltxpktsrate
<Double>
Read-only
Rate (/s) counter for tnltottxpkts
tnltotrxbytes
<Double>
Read-only
Total number of bytes received on the tunnel.
tnlrxbytesrate
<Double>
Read-only
Rate (/s) counter for tnltotrxbytes
tnltottxbytes
<Double>
Read-only
Total number of bytes transmitted on the tunnel.
tnltxbytesrate
<Double>
Read-only
Rate (/s) counter for tnltottxbytes

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

Query-parameters:

args

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

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

{ "tunnelip": [ {
      "tunnelip":<String_value>,
      "tnltxpktsrate":<Double_value>,
      "tnltxbytesrate":<Double_value>,
      "tnlrxpktsrate":<Double_value>,
      "tnltotrxpkts":<Double_value>,
      "tnltottxbytes":<Double_value>,
      "tnltottxpkts":<Double_value>,
      "tnlrxbytesrate":<Double_value>,
      "tnltotrxbytes":<Double_value>
}]}

get

URL: http://<netscaler-ip-address>/nitro/v1/stat/tunnelip/tunnelip_value><String>

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:

{ "tunnelip": [ {
      "tunnelip":<String_value>,
      "tnltxpktsrate":<Double_value>,
      "tnltxbytesrate":<Double_value>,
      "tnlrxpktsrate":<Double_value>,
      "tnltotrxpkts":<Double_value>,
      "tnltottxbytes":<Double_value>,
      "tnltottxpkts":<Double_value>,
      "tnlrxbytesrate":<Double_value>,
      "tnltotrxbytes":<Double_value>
}]}