ADC NITRO APIs

inat

Configuration for inbound nat resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
name Read-write Name for the Inbound NAT (INAT) entry. Leading character must be a number or letter. Other characters allowed, after the first character, are @ _ - . (period) : (colon) # and space ( ).

Minimum length = 1
publicip Read-write Public IP address of packets received on the Citrix ADC. Can be aNetScaler-owned VIP or VIP6 address.

Minimum length = 1
privateip Read-write IP address of the server to which the packet is sent by the Citrix ADC. Can be an IPv4 or IPv6 address.

Minimum length = 1
mode Read-write Stateless translation.

Possible values = STATELESS
tcpproxy Read-write Enable TCP proxy, which enables the Citrix ADC to optimize the RNAT TCP traffic by using Layer 4 features.

Default value: DISABLED

Possible values = ENABLED, DISABLED
ftp Read-write Enable the FTP protocol on the server for transferring files between the client and the server.

Default value: DISABLED

Possible values = ENABLED, DISABLED
tftp Read-write To enable/disable TFTP (Default DISABLED).

Default value: DISABLED

Possible values = ENABLED, DISABLED
usip Read-write Enable the Citrix ADC to retain the source IP address of packets before sending the packets to the server.

Possible values = ON, OFF
usnip Read-write Enable the Citrix ADC to use a SNIP address as the source IP address of packets before sending the packets to the server.

Possible values = ON, OFF
proxyip Read-write Unique IP address used as the source IP address in packets sent to the server. Must be a MIP or SNIP address.
useproxyport Read-write Enable the Citrix ADC to proxy the source port of packets before sending the packets to the server.

Default value: ENABLED

Possible values = ENABLED, DISABLED
td 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.

Minimum value = 0

Maximum value = 4094
connfailover Read-write Synchronize connection information with the secondary appliance in a high availability (HA) pair. That is, synchronize all connection-related information for the INAT session.

Default value: DISABLED

Possible values = ENABLED, DISABLED
flags Read-only Flags for different modes.
__count Read-only count parameter

Operations

(click to see Properties )

  • ADD
  • DELETE
  • 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

add

URL: http:// <netscaler-ip-address> /nitro/v1/config/inat HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"inat":{
<b>"name":<String_value>,
</b><b>"publicip":<String_value>,
</b><b>"privateip":<String_value>,
</b>"mode":<String_value>,
"tcpproxy":<String_value>,
"ftp":<String_value>,
"tftp":<String_value>,
"usip":<String_value>,
"usnip":<String_value>,
"proxyip":<String_value>,
"useproxyport":<String_value>,
"td":<Double_value>,
"connfailover":<String_value>
}}

<!--NeedCopy-->

Response: HTTP Status Code on Success: 201 Created

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

delete

URL: http:// <netscaler-ip-address> /nitro/v1/config/inat/ name_value<String> HTTP Method: DELETE

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

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

update

URL: http:// <netscaler-ip-address> /nitro/v1/config/inat HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"inat":{
<b>"name":<String_value>,
</b>"privateip":<String_value>,
"tcpproxy":<String_value>,
"ftp":<String_value>,
"tftp":<String_value>,
"usip":<String_value>,
"usnip":<String_value>,
"proxyip":<String_value>,
"useproxyport":<String_value>,
"connfailover":<String_value>,
"mode":<String_value>
}}

<!--NeedCopy-->

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/inat? action=unset HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"inat":{
<b>"name":<String_value>,
</b>"tcpproxy":true,
"ftp":true,
"tftp":true,
"usip":true,
"usnip":true,
"proxyip":true,
"useproxyport":true,
"connfailover":true,
"mode":true
}}

<!--NeedCopy-->

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/inat Query-parameters: attrs http:// <netscaler-ip-address> /nitro/v1/config/inat? 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/inat? filter=property-name1:property-val1,property-name2:property-val2

Use this query-parameter to get the filtered set of inat resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

view http:// <netscaler-ip-address> /nitro/v1/config/inat? view=summary

Use this query-parameter to get the summary output of inat 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/inat? pagesize=#no;pageno=#no

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

{ "inat": [ {
"name":<String_value>,
"publicip":<String_value>,
"privateip":<String_value>,
"proxyip":<String_value>,
"tcpproxy":<String_value>,
"ftp":<String_value>,
"tftp":<String_value>,
"usip":<String_value>,
"usnip":<String_value>,
"useproxyport":<String_value>,
"flags":<Double_value>,
"mode":<String_value>,
"connfailover":<String_value>,
"td":<Double_value>
}]}

<!--NeedCopy-->

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/inat/ name_value<String> Query-parameters: attrs http:// <netscaler-ip-address> /nitro/v1/config/inat/ name_value<String> ? 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/inat/ name_value<String> ? view=summary

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

{  "inat": [ {
"name":<String_value>,
"publicip":<String_value>,
"privateip":<String_value>,
"proxyip":<String_value>,
"tcpproxy":<String_value>,
"ftp":<String_value>,
"tftp":<String_value>,
"usip":<String_value>,
"usnip":<String_value>,
"useproxyport":<String_value>,
"flags":<Double_value>,
"mode":<String_value>,
"connfailover":<String_value>,
"td":<Double_value>
}]}

<!--NeedCopy-->

count

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

{ "inat": [ { "__count": "#no"} ] }

<!--NeedCopy-->
inat