ADC NITRO APIs

rnat

August 17, 2023

Contributed by:

Configuration for RNAT configured route resource.

Properties

(click to see Operations )

Name	Permissions	Description
network	Read-write	The network address defined for the RNAT entry. Minimum length = 1
netmask	Read-write	The subnet mask for the network address. Minimum length = 1
aclname	Read-write	An extended ACL defined for the RNAT entry. Minimum length = 1
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
ownergroup	Read-write	The owner node group in a Cluster for this rnat rule. Default value: DEFAULT_NG Minimum length = 1
name	Read-write	Name for the RNAT4 rule. Must begin with a letter, number, or the underscore character (_), and can consist of letters, numbers, and the hyphen (-), period (.) pound (#), space ( ), at sign (@), equals (=), colon (:), and underscore characters. Cannot be changed after the rule is created. Choose a name that helps identify the RNAT4 rule. Minimum length = 1
redirectport	Read-write	Port number to which the IPv4 packets are redirected. Applicable to TCP and UDP protocols. Minimum value = 1 Maximum value = 65535
natip	Read-write	Any NetScaler-owned IPv4 address except the NSIP address. The NetScaler appliance replaces the source IP addresses of server-generated packets with the IP address specified. The IP address must be a public NetScaler-owned IP address. If you specify multiple addresses for this field, NATIP selection uses the round robin algorithm for each session. By specifying a range of IP addresses, you can specify all NetScaler-owned IP addresses, except the NSIP, that fall within the specified range. Minimum length = 1
srcippersistency	Read-write	Enables the Citrix ADC to use the same NAT IP address for all RNAT sessions initiated from a particular server. Default value: DISABLED Possible values = ENABLED, DISABLED
useproxyport	Read-write	Enable source port proxying, which enables the Citrix ADC to use the RNAT ips using proxied source port. Default value: ENABLED Possible values = ENABLED, DISABLED
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 RNAT session. In order for this to work, tcpproxy should be DISABLED. To disable tcpproxy use “set rnatparam tcpproxy DISABLED”. Default value: DISABLED Possible values = ENABLED, DISABLED
newname	Read-write	New name for the RNAT4 rule. Must begin with an ASCII alphabetic or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Minimum length = 1
__count	Read-only	count parameter

Operations

(click to see Properties )

CLEAR
UPDATE
UNSET
ADD
RENAME
DELETE
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

clear

URL: http:// <netscaler-ip-address> /nitro/v1/config/rnat? action=clear

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"rnat":{
      "network":<String_value>,
      "netmask":<String_value>,
      "aclname":<String_value>,
      "td":<Double_value>,
      "ownergroup":<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

update

URL: http:// <netscaler-ip-address> /nitro/v1/config/rnat

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"rnat":{
      "name":<String_value>,
      "network":<String_value>,
      "netmask":<String_value>,
      "aclname":<String_value>,
      "redirectport":<Integer_value>,
      "td":<Double_value>,
      "natip":<String_value>,
      "srcippersistency":<String_value>,
      "useproxyport":<String_value>,
      "ownergroup":<String_value>,
      "connfailover":<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/rnat? action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"rnat":{
      "name":<String_value>,
      "network":true,
      "netmask":true,
      "aclname":true,
      "td":true,
      "redirectport":true,
      "natip":true,
      "srcippersistency":true,
      "ownergroup":true,
      "useproxyport":true,
      "connfailover":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

add

URL: http:// <netscaler-ip-address> /nitro/v1/config/rnat

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"rnat":{
<b>      "name":<String_value>,
</b>      "network":<String_value>,
      "netmask":<String_value>,
      "aclname":<String_value>,
      "redirectport":<Integer_value>,
      "td":<Double_value>,
      "srcippersistency":<String_value>,
      "useproxyport":<String_value>,
      "connfailover":<String_value>,
      "ownergroup":<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

rename

URL: http:// <netscaler-ip-address> /nitro/v1/config/rnat? action=rename

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"rnat":{
<b>      "name":<String_value>,
</b><b>      "newname":<String_value>
</b>}}

<!--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

delete

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

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/rnat

Query-parameters:

attrs

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

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

view

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

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

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

{ "rnat": [ {
      "name":<String_value>,
      "network":<String_value>,
      "netmask":<String_value>,
      "td":<Double_value>,
      "natip":<String_value>,
      "aclname":<String_value>,
      "redirectport":<Integer_value>,
      "srcippersistency":<String_value>,
      "useproxyport":<String_value>,
      "ownergroup":<String_value>,
      "connfailover":<String_value>
}]}

<!--NeedCopy-->

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/rnat/ name_value<String>

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/rnat/ 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/rnat/ name_value<String> ? view=summary

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

{  "rnat": [ {
      "name":<String_value>,
      "network":<String_value>,
      "netmask":<String_value>,
      "td":<Double_value>,
      "natip":<String_value>,
      "aclname":<String_value>,
      "redirectport":<Integer_value>,
      "srcippersistency":<String_value>,
      "useproxyport":<String_value>,
      "ownergroup":<String_value>,
      "connfailover":<String_value>
}]}

<!--NeedCopy-->

count

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

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

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

rnat

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

rnat

Properties

Operations

clear

update

unset

add

rename

delete

get (all)

get

count

In this article