nat64param¶
Configuration for NAT64 parameter resource.
Properties¶
(click to see Operations )
Name | Data Type | Permissions | Description |
---|---|---|---|
td | <Double> | 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 |
nat64ignoretos | <String> | Read-write | Ignore TOS.
Default value: NO Possible values = YES, NO |
nat64zerochecksum | <String> | Read-write | Calculate checksum for UDP packets with zero checksum.
Default value: ENABLED Possible values = ENABLED, DISABLED |
nat64v6mtu | <Double> | 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 |
nat64fragheader | <String> | Read-write | When disabled, translator will not insert IPv6 fragmentation header for non fragmented IPv4 packets.
Default value: ENABLED Possible values = ENABLED, DISABLED |
__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/nat64param
HTTP Method: PUT
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"nat64param":{
"td":<Double_value>,
"nat64ignoretos":<String_value>,
"nat64zerochecksum":<String_value>,
"nat64v6mtu":<Double_value>,
"nat64fragheader":<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/nat64param? action=unset
HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"nat64param":{
"td":<Double_value>,
"nat64ignoretos":true,
"nat64zerochecksum":true,
"nat64v6mtu":true,
"nat64fragheader":true
}}
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/nat64param
Query-parameters:
attrs
http:// <netscaler-ip-address> /nitro/v1/config/nat64param? 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/nat64param? filter=property-name1:property-val1,property-name2:property-val2
Use this query-parameter to get the filtered set of nat64param resources configured on NetScaler.Filtering can be done on any of the properties of the resource.
view
http:// <netscaler-ip-address> /nitro/v1/config/nat64param? view=summary
Use this query-parameter to get the summary output of nat64param 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/nat64param? pagesize=#no;pageno=#no
Use this query-parameter to get the nat64param 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:
{ "nat64param": [ {
"td":<Double_value>,
"nat64ignoretos":<String_value>,
"nat64zerochecksum":<String_value>,
"nat64v6mtu":<Double_value>,
"nat64fragheader":<String_value>
}]}
get¶
URL: http:// <netscaler-ip-address> /nitro/v1/config/nat64param/ td_value<Double>
Query-parameters:
attrs
http:// <netscaler-ip-address> /nitro/v1/config/nat64param/ td_value<Double> ? 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/nat64param/ td_value<Double> ? view=summary
Use this query-parameter to get the summary output of nat64param 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:
{ "nat64param": [ {
"td":<Double_value>,
"nat64ignoretos":<String_value>,
"nat64zerochecksum":<String_value>,
"nat64v6mtu":<Double_value>,
"nat64fragheader":<String_value>
}]}
count¶
URL: http:// <netscaler-ip-address> /nitro/v1/config/nat64param? 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:
{ "nat64param": [ { "__count": "#no"} ] }