Download full document:

rnat

Configuration for RNAT configured route resource.

Properties

(click to see Operations)

Name	Data Type	Permissions	Description
network	<String>	Read-write	The network address defined for the RNAT entry.<br>Minimum length = 1
netmask	<String>	Read-write	The subnet mask for the network address.<br>Minimum length = 1
aclname	<String>	Read-write	An extended ACL defined for the RNAT entry.<br>Minimum length = 1
redirectport	<Boolean>	Read-write	The port number to which the packets are redirected.
natip	<String>	Read-write	The NAT IP address defined for the RNAT entry. .<br>Minimum length = 1
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.<br>Minimum value = 0<br>Maximum value = 4094
natip2	<String>	Read-write	The NAT IP(s) assigned to the RNAT.<br>Minimum length = 1
srcippersistency	<String>	Read-write	Enables the NetScaler appliance to use the same NAT IP address for all RNAT sessions initiated from a particular server.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED
__count	<Double>	Read-only	count 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 red and placeholder content is marked in <green>.

clear

URL: http://<NSIP>/nitro/v1/config/

HTTP Method: POST

Request Payload:

object={
"params":{
      "warning":<String_value>,
      "onerror":<String_value>,
      "action":"clear"
},
"sessionid":"##sessionid",
"rnat":{
      "network":<String_value>,
      "netmask":<String_value>,
      "aclname":<String_value>,
      "redirectport":<Boolean_value>,
      "natip":<String_value>,
      "td":<Double_value>,
}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

update

URL: http://<NSIP>/nitro/v1/config/

HTTP Method: PUT

Request Payload:

{
"params": {
      "warning":<String_value>,
      "onerror":<String_value>"
},
sessionid":"##sessionid",
"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>,
}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

unset

URL: http://<NSIP>/nitro/v1/config/

HTTP Method: POST

Request Payload:

object={
"params":{
      "warning":<String_value>,
      "onerror":<String_value>,
      "action":"unset"
},
"sessionid":"##sessionid",
"rnat":{
      "network":true,
      "netmask":true,
      "td":true,
      "aclname":true,
      "redirectport":true,
      "natip":true,
      "srcippersistency":true,
}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

get (all)

URL: http://<NSIP>/nitro/v1/config/rnat

Query-parameters:

filter

http://<NSIP>/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://<NS_IP>/nitro/v1/config/rnat?view=summary

Use this query-parameter to get the summary output of rnat resources configured on NetScaler.

pagesize=#no;pageno=#no

http://<NS_IP>/nitro/v1/config/rnat?pagesize=#no;pageno=#no

Use this query-parameter to get the rnat resources in chunks.

warning

http://<NS_IP>/nitro/v1/config/rnat?warning=yes

Use this query parameter to get warnings in nitro response. If this field is set to YES, warning message will be sent in 'message' field and 'WARNING' value is set in severity field of the response in case there is a

HTTP Method: GET

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "rnat": [ {
      "network":<String_value>,
      "netmask":<String_value>,
      "td":<Double_value>,
      "natip":<String_value>,
      "aclname":<String_value>,
      "redirectport":<Boolean_value>,
      "srcippersistency":<String_value>

}]}

count

URL: http://<NS_IP>/nitro/v1/config/rnat?count=yes

HTTP Method: GET

Response Payload:

{ "errorcode": 0, "message": "Done",rnat: [ { "__count": "#no"} ] }