Citrix ADC 12.1 NITRO API Reference

nat64

Statistics for nat64 config resource.

Properties

(click to see Operations)

Name Data Type Permissions Description
clearstats Read-write Clear the statsistics / counters.
Possible values = basic, full
nat64tottcpsessions Read-only Total number of TCP sessions created by NAT64.
nat64tcpsessionsrate Read-only Rate (/s) counter for nat64tottcpsessions
nat64totudpsessions Read-only Total number of UDP sessions created by NAT64.
nat64udpsessionsrate Read-only Rate (/s) counter for nat64totudpsessions
nat64toticmpsessions Read-only Total number of ICMP sessions created by NAT64.
nat64icmpsessionsrate Read-only Rate (/s) counter for nat64toticmpsessions
nat64totsessions Read-only Total number of sessions created by NAT64.
nat64sessionsrate Read-only Rate (/s) counter for nat64totsessions

Operations

(click to see Properties)

GET (ALL)

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 Citrix ADC appliance, the URL is as follows:

    http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC 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://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/stat/nat64

Query-parameters:

args

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/stat/nat64?args=detail:<Boolean_value>,fullvalues:<Boolean_value>,ntimes:<Double_value>,logfile:<String_value>,clearstats:<String_value>

Use this query-parameter to get nat64 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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:


{ "nat64": [ {
"nat64icmpsessionsrate":<Double_value>,
"nat64toticmpsessions":<Double_value>,
"nat64sessionsrate":<Double_value>,
"nat64totudpsessions":<Double_value>,
"nat64udpsessionsrate":<Double_value>,
"nat64tottcpsessions":<Double_value>,
"nat64totsessions":<Double_value>,
"nat64tcpsessionsrate":<Double_value>
}]}

<!--NeedCopy-->
nat64