Skip to content

rnatsession

Configuration for RNAT session resource.

Properties

(click to see Operations)

NameData TypePermissionsDescription
network<String>Read-writeIPv4 network address on whose traffic you want the Citrix ADC to do RNAT processing.
Minimum length = 1
netmask<String>Read-writeSubnet mask associated with the network address.
Minimum length = 1
natip<String>Read-writeThe NAT IP address defined for the RNAT entry.
Minimum length = 1
aclname<String>Read-writeName of any configured extended ACL whose action is ALLOW.
Minimum length = 1

Operations

(click to see Properties)

FLUSH

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 Citrix ADC appliance, the URL is as follows:

    http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC 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>.

flush

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/rnatsession?action=flush

HTTP Method:POST

Request Headers:

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

Request Payload:

{"rnatsession":{
"network":<String_value>,
"netmask":<String_value>,
"natip":<String_value>,
"aclname":<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 Citrix ADC specific errors). The response payload provides details of the error