Download full document:

rnatip

Statistics for RNAT ipaddress resource.

Properties

(click to see Operations)

NameData TypePermissionsDescription
Rnatip<String>Read-writeSpecifies the NAT IP address of the configured RNAT entry for which you want to see the statistics. If you do not specify an IP address, this displays the statistics for all the configured RNAT entries.
Minimum length = 1
clearstats<String>Read-writeClear the statsistics / counters.
Possible values = basic, full
iptd<Double>Read-onlyTraffic domain for ipaddr.
iprnattotrxbytes<Double>Read-onlyBytes received on this IP address during RNAT sessions.
iprnatrxbytesrate<Double>Read-onlyRate (/s) counter for iprnattotrxbytes
iprnattottxbytes<Double>Read-onlyBytes sent from this IP address during RNAT sessions.
iprnattxbytesrate<Double>Read-onlyRate (/s) counter for iprnattottxbytes
iprnattotrxpkts<Double>Read-onlyPackets received on this IP address during RNAT sessions.
iprnatrxpktsrate<Double>Read-onlyRate (/s) counter for iprnattotrxpkts
iprnattottxpkts<Double>Read-onlyPackets sent from this IP address during RNAT sessions.
iprnattxpktsrate<Double>Read-onlyRate (/s) counter for iprnattottxpkts
iprnattottxsyn<Double>Read-onlyRequests for connections sent from this IP address during RNAT sessions.
iprnattxsynrate<Double>Read-onlyRate (/s) counter for iprnattottxsyn
iprnatcursessions<Double>Read-onlyCurrently active RNAT sessions started from this IP address.

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 redand placeholder content is marked in <green>.

get (all)

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

Query-parameters:

args

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

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

{ "rnatip": [ {
"Rnatip":<String_value>,
"iprnatrxpktsrate":<Double_value>,
"iprnattxpktsrate":<Double_value>,
"iprnattottxpkts":<Double_value>,
"iptd":<Double_value>,
"iprnattottxbytes":<Double_value>,
"iprnatcursessions":<Double_value>,
"iprnatrxbytesrate":<Double_value>,
"iprnattotrxbytes":<Double_value>,
"iprnattxsynrate":<Double_value>,
"iprnattxbytesrate":<Double_value>,
"iprnattotrxpkts":<Double_value>,
"iprnattottxsyn":<Double_value>
}]}

get

URL:http://<netscaler-ip-address>/nitro/v1/stat/rnatip/Rnatip_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 errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "rnatip": [ {
"Rnatip":<String_value>,
"iprnatrxpktsrate":<Double_value>,
"iprnattxpktsrate":<Double_value>,
"iprnattottxpkts":<Double_value>,
"iptd":<Double_value>,
"iprnattottxbytes":<Double_value>,
"iprnatcursessions":<Double_value>,
"iprnatrxbytesrate":<Double_value>,
"iprnattotrxbytes":<Double_value>,
"iprnattxsynrate":<Double_value>,
"iprnattxbytesrate":<Double_value>,
"iprnattotrxpkts":<Double_value>,
"iprnattottxsyn":<Double_value>
}]}