Product Documentation

inat

Sep 08, 2016

Statistics for inbound nat resource.

Properties (click to see Operations)

Name Data Type Permissions Description
name
<String>
Read-write
The INAT.
Minimum length = 1
clearstats
<String>
Read-write
Clear the statsistics / counters.
Possible values = basic, full
nat46tottcp46
<Double>
Read-only
Total TCP packets translated (V4->v6).
nat46tcp46rate
<Double>
Read-only
Rate (/s) counter for nat46tottcp46
nat46totudp46
<Double>
Read-only
Total UDP packets translated (V4->v6).
nat46udp46rate
<Double>
Read-only
Rate (/s) counter for nat46totudp46
nat46toticmp46
<Double>
Read-only
Total ICMP packets translated (V4->v6).
nat46icmp46rate
<Double>
Read-only
Rate (/s) counter for nat46toticmp46
nat46totdrop46
<Double>
Read-only
Total IPV4 packets dropped.
nat46drop46rate
<Double>
Read-only
Rate (/s) counter for nat46totdrop46
nat46tottcp64
<Double>
Read-only
Total TCP packets translated (V6->v4).
nat46tcp64rate
<Double>
Read-only
Rate (/s) counter for nat46tottcp64
nat46totudp64
<Double>
Read-only
Total UDP packets translated (V6->v4).
nat46udp64rate
<Double>
Read-only
Rate (/s) counter for nat46totudp64
nat46toticmp64
<Double>
Read-only
Total ICMP packets translated (V6->v4).
nat46icmp64rate
<Double>
Read-only
Rate (/s) counter for nat46toticmp64
nat46totdrop64
<Double>
Read-only
Total IPV6 packets dropped.
nat46drop64rate
<Double>
Read-only
Rate (/s) counter for nat46totdrop64
inatnat46tcp46
<Double>
Read-only
TCP packets translated (V4->v6).
inatnat46tcp46rate
<Double>
Read-only
Rate (/s) counter for inatnat46tcp46
inatnat46udp46
<Double>
Read-only
UDP packets translated (V4->v6).
inatnat46udp46rate
<Double>
Read-only
Rate (/s) counter for inatnat46udp46
inatnat46icmp46
<Double>
Read-only
ICMP packets translated (V4->v6).
inatnat46icmp46rate
<Double>
Read-only
Rate (/s) counter for inatnat46icmp46
inatnat46drop46
<Double>
Read-only
IPV4 packets dropped.
inatnat46drop46rate
<Double>
Read-only
Rate (/s) counter for inatnat46drop46
inatnat46tcp64
<Double>
Read-only
TCP packets translated (V6->v4).
inatnat46tcp64rate
<Double>
Read-only
Rate (/s) counter for inatnat46tcp64
inatnat46udp64
<Double>
Read-only
UDP packets translated (V6->v4).
inatnat46udp64rate
<Double>
Read-only
Rate (/s) counter for inatnat46udp64
inatnat46icmp64
<Double>
Read-only
ICMP packets translated (V6->v4).
inatnat46icmp64rate
<Double>
Read-only
Rate (/s) counter for inatnat46icmp64
inatnat46drop64
<Double>
Read-only
IPV6 packets dropped.
inatnat46drop64rate
<Double>
Read-only
Rate (/s) counter for inatnat46drop64

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

Query-parameters:

args

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

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

{ "inat": [ {
      "name":<String_value>,
      "nat46udp64rate":<Double_value>,
      "nat46totdrop64":<Double_value>,
      "nat46totudp46":<Double_value>,
      "nat46icmp64rate":<Double_value>,
      "inatnat46tcp46":<Double_value>,
      "nat46totdrop46":<Double_value>,
      "inatnat46tcp64":<Double_value>,
      "inatnat46drop46":<Double_value>,
      "inatnat46drop64":<Double_value>,
      "inatnat46udp46":<Double_value>,
      "nat46tottcp64":<Double_value>,
      "nat46drop46rate":<Double_value>,
      "inatnat46drop46rate":<Double_value>,
      "inatnat46tcp64rate":<Double_value>,
      "inatnat46icmp64":<Double_value>,
      "nat46drop64rate":<Double_value>,
      "inatnat46tcp46rate":<Double_value>,
      "nat46tottcp46":<Double_value>,
      "nat46toticmp46":<Double_value>,
      "inatnat46icmp46rate":<Double_value>,
      "inatnat46udp64":<Double_value>,
      "nat46tcp46rate":<Double_value>,
      "inatnat46drop64rate":<Double_value>,
      "inatnat46udp64rate":<Double_value>,
      "nat46icmp46rate":<Double_value>,
      "inatnat46icmp46":<Double_value>,
      "inatnat46icmp64rate":<Double_value>,
      "nat46tcp64rate":<Double_value>,
      "nat46totudp64":<Double_value>,
      "nat46udp46rate":<Double_value>,
      "nat46toticmp64":<Double_value>,
      "inatnat46udp46rate":<Double_value>
}]}

get

URL: http://<netscaler-ip-address>/nitro/v1/stat/inat/name_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:

{ "inat": [ {
      "name":<String_value>,
      "nat46udp64rate":<Double_value>,
      "nat46totdrop64":<Double_value>,
      "nat46totudp46":<Double_value>,
      "nat46icmp64rate":<Double_value>,
      "inatnat46tcp46":<Double_value>,
      "nat46totdrop46":<Double_value>,
      "inatnat46tcp64":<Double_value>,
      "inatnat46drop46":<Double_value>,
      "inatnat46drop64":<Double_value>,
      "inatnat46udp46":<Double_value>,
      "nat46tottcp64":<Double_value>,
      "nat46drop46rate":<Double_value>,
      "inatnat46drop46rate":<Double_value>,
      "inatnat46tcp64rate":<Double_value>,
      "inatnat46icmp64":<Double_value>,
      "nat46drop64rate":<Double_value>,
      "inatnat46tcp46rate":<Double_value>,
      "nat46tottcp46":<Double_value>,
      "nat46toticmp46":<Double_value>,
      "inatnat46icmp46rate":<Double_value>,
      "inatnat46udp64":<Double_value>,
      "nat46tcp46rate":<Double_value>,
      "inatnat46drop64rate":<Double_value>,
      "inatnat46udp64rate":<Double_value>,
      "nat46icmp46rate":<Double_value>,
      "inatnat46icmp46":<Double_value>,
      "inatnat46icmp64rate":<Double_value>,
      "nat46tcp64rate":<Double_value>,
      "nat46totudp64":<Double_value>,
      "nat46udp46rate":<Double_value>,
      "nat46toticmp64":<Double_value>,
      "inatnat46udp46rate":<Double_value>
}]}