Download full document:

rnat

Configuration for RNAT configured route resource.

Properties

(click to see Operations)

NameData TypePermissionsDescription
network<String>Read-writeThe network address defined for the RNAT entry.
Minimum length = 1
netmask<String>Read-writeThe subnet mask for the network address.
Minimum length = 1
aclname<String>Read-writeAn extended ACL defined for the RNAT entry.
Minimum length = 1
redirectport<Boolean>Read-writeThe port number to which the packets are redirected.
natip<String>Read-writeThe NAT IP address defined for the RNAT entry. .
Minimum length = 1
td<Double>Read-writeInteger 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<String>Read-writeThe owner node group in a Cluster for this rnat rule.
Default value: DEFAULT_NG
Minimum length = 1
natip2<String>Read-writeThe NAT IP(s) assigned to the RNAT.
Minimum length = 1
srcippersistency<String>Read-writeEnables 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<String>Read-writeEnable 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<String>Read-writeSynchronize 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
__count<Double>Read-onlycount parameter

Operations

(click to see Properties)

CLEAR| UPDATE| UNSET| GET (ALL)| 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 redand 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>,
"redirectport":<Boolean_value>,
"natip":<String_value>,
"td":<Double_value>,
"ownergroup":<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

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

HTTP Method:POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload:

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

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 errorResponse Headers:

Content-Type:application/json

Response Payload:

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

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 errorResponse Headers:

Content-Type:application/json

Response Payload:

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