ADC NITRO APIs

lsndeterministicnat

Configuration for deterministic NAT resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
clientname <String> Read-write The name of the LSN Client.
network6 <String> Read-write IPv6 address of the LSN subscriber or B4 device.
subscrip <String> Read-write The Client IP address.
td <Double> Read-write The LSN client TD.

Default value: 0

Minimum value = 0

Maximum value = 4094
natip <String> Read-write The NAT IP address.

Minimum length = 1
natprefix <String> Read-only IPv6 address of the LSN subscriber network(B4-Device) on whose traffic the Citrix ADC perform Large Scale NAT.
subscrip2 <String> Read-only The Subscriber IP address.
natip2 <String> Read-only The NAT IP address.
firstport <Integer> Read-only The Application Protocol Port of the Profile.

Minimum value = 1

Maximum value = 65535
lastport <Integer> Read-only The Application Protocol Ending Port of the Profile.

Minimum value = 1

Maximum value = 65535
srctd <Double> Read-only The LSN client TD.

Minimum value = 0

Maximum value = 4094
nattype <String> Read-only Type of subscriber info(ex: nat44 or ds-lite).

Default value: NAT44

Possible values = NAT44, DS-Lite, NAT64
__count <Double> Read-only count parameter

Operations

(click to see Properties )

  • 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

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/lsndeterministicnat Query-parameters: args http:// <netscaler-ip-address> /nitro/v1/config/lsndeterministicnat? args=clientname: <String_value> ,network6: <String_value> ,subscrip: <String_value> ,td: <Double_value> ,natip: <String_value>

Use this query-parameter to get lsndeterministicnat resources based on additional properties.

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

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

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

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

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

{ "lsndeterministicnat": [ {
clientname:<String_value>,network6:<String_value>,subscrip:<String_value>,td:<Double_value>,natip:<String_value>"natprefix":<String_value>,
"subscrip2":<String_value>,
"natip2":<String_value>,
"firstport":<Integer_value>,
"lastport":<Integer_value>,
"srctd":<Double_value>,
"nattype":<String_value>
}]}

<!--NeedCopy-->

count

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

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

<!--NeedCopy-->
lsndeterministicnat