inatparam

Last published : Oct 30, 2026
Configuration for INAT parameter resource.
Related information
Configuration

Properties

(click to see Operations )
Name Data Type Permissions Description
nat46v6prefix <String> Read-write The prefix used for translating packets received from private IPv6 servers into IPv4 packets. This prefix has a length of 96 bits (128-32 = 96). The IPv6 servers embed the destination IP address of the IPv4 servers or hosts in the last 32 bits of the destination IP address field of the IPv6 packets. The first 96 bits of the destination IP address field are set as the IPv6 NAT prefix. IPv6 packets addressed to this prefix have to be routed to the Citrix ADC to ensure that the IPv6-IPv4 translation is done by the appliance.
td <Integer> Read-write Integer value that uniquely identifies the traffic domain in which you want to configure the entity. If you do not specify an ID, the entity becomes part of the default traffic domain, which has an ID of 0.
Default value: 0
Minimum value = 0
Maximum value = 4094
nat46ignoretos <String> Read-write Ignore TOS.
Default value: NO
Possible values = YES, NO
nat46zerochecksum <String> Read-write Calculate checksum for UDP packets with zero checksum.
Default value: ENABLED
Possible values = ENABLED, DISABLED
nat46v6mtu <Integer> Read-write MTU setting for the IPv6 side. If the incoming IPv4 packet greater than this, either fragment or send icmp need fragmentation error.
Default value: 1280
Minimum value = 1280
Maximum value = 9216
nat46fragheader <String> Read-write When disabled, translator will not insert IPv6 fragmentation header for non fragmented IPv4 packets.
Default value: ENABLED
Possible values = ENABLED, DISABLED
_nextgenapiresource <String> Read-only .
__count <Double> Read-only count parameter

Operations

(click to see Properties )
  • UPDATE
  • UNSET
  • GET (ALL)
  • GET
  • COUNT
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

update

URL: http:// <netscaler-ip-address> /nitro/v1/config/inatparam HTTP Method: PUT
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"inatparam":{
"nat46v6prefix":<String_value>,
"td":<Integer_value>,
"nat46ignoretos":<String_value>,
"nat46zerochecksum":<String_value>,
"nat46v6mtu":<Integer_value>,
"nat46fragheader":<String_value>
}}
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

unset

URL: http:// <netscaler-ip-address> /nitro/v1/config/inatparam? action=unset HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"inatparam":{
"nat46v6prefix":true,
"td":<Integer_value>
}}
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

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/inatparam Query-parameters: attrs http:// <netscaler-ip-address> /nitro/v1/config/inatparam? attrs=property-name1,property-name2
Use this query parameter to specify the resource details that you want to retrieve.
filter http:// <netscaler-ip-address> /nitro/v1/config/inatparam? filter=property-name1:property-val1,property-name2:property-val2
Use this query-parameter to get the filtered set of inatparam resources configured on NetScaler.Filtering can be done on any of the properties of the resource.
view http:// <netscaler-ip-address> /nitro/v1/config/inatparam? view=summary
Use this query-parameter to get the summary output of inatparam resources configured on NetScaler.
Note: By default, the retrieved results are displayed in detail view (?view=detail).
pagination http:// <netscaler-ip-address> /nitro/v1/config/inatparam? pagesize=#no;pageno=#no
Use this query-parameter to get the inatparam resources in chunks.
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:
{ "inatparam": [ {
"td":<Integer_value>,
"nat46v6prefix":<String_value>,
"nat46ignoretos":<String_value>,
"nat46zerochecksum":<String_value>,
"nat46v6mtu":<Integer_value>,
"nat46fragheader":<String_value>,
"_nextgenapiresource":<String_value>
}]}

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/inatparam/ td_value<Integer> Query-parameters: attrs http:// <netscaler-ip-address> /nitro/v1/config/inatparam/ td_value<Integer> ? attrs=property-name1,property-name2
Use this query parameter to specify the resource details that you want to retrieve.
view http:// <netscaler-ip-address> /nitro/v1/config/inatparam/ td_value<Integer> ? view=summary
Use this query-parameter to get the summary output of inatparam resources configured on NetScaler.
Note: By default, the retrieved results are displayed in detail view (?view=detail).
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:
{  "inatparam": [ {
"td":<Integer_value>,
"nat46v6prefix":<String_value>,
"nat46ignoretos":<String_value>,
"nat46zerochecksum":<String_value>,
"nat46v6mtu":<Integer_value>,
"nat46fragheader":<String_value>,
"_nextgenapiresource":<String_value>
}]}

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/inatparam? count=yes 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:
{ "inatparam": [ { "__count": "#no"} ] }