ADC NITRO APIs

lsnstatic

August 17, 2023

Contributed by:

Configuration for static mapping resource.

Properties

(click to see Operations )

Name	Permissions	Description
name	Read-write	Name for the LSN static mapping entry. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Cannot be changed after the LSN group is created. The following requirement applies only to the Citrix ADC CLI: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, “lsn static1” or ‘lsn static1’). Minimum length = 1 Maximum length = 127
transportprotocol	Read-write	Protocol for the LSN mapping entry. Possible values = TCP, UDP, ICMP, ALL
subscrip	Read-write	IPv4(NAT44 ; DS-Lite)/IPv6(NAT64) address of an LSN subscriber for the LSN static mapping entry.
subscrport	Read-write	Port of the LSN subscriber for the LSN mapping entry. * represents all ports being used. Used in case of static wildcard. Minimum value = 0 Maximum value = 65535 Range 1 - 65535 * in CLI is represented as 65535 in NITRO API
network6	Read-write	B4 address in DS-Lite setup. Minimum length = 1
td	Read-write	ID of the traffic domain to which the subscriber belongs. If you do not specify an ID, the subscriber is assumed to be a part of the default traffic domain. Default value: 0 Minimum value = 0 Maximum value = 4094
natip	Read-write	IPv4 address, already existing on the Citrix ADC as type LSN, to be used as NAT IP address for this mapping entry.
natport	Read-write	NAT port for this LSN mapping entry. * represents all ports being used. Used in case of static wildcard. Minimum value = 0 Maximum value = 65535 Range 1 - 65535 * in CLI is represented as 65535 in NITRO API
destip	Read-write	Destination IP address for the LSN mapping entry.
dsttd	Read-write	ID of the traffic domain through which the destination IP address for this LSN mapping entry is reachable from the Citrix ADC. If you do not specify an ID, the destination IP address is assumed to be reachable through the default traffic domain, which has an ID of 0. Default value: 0 Minimum value = 0 Maximum value = 4094
nattype	Read-write	Type of sessions to be displayed. Possible values = NAT44, DS-Lite, NAT64
status	Read-only	The status of the Mapping. Status could be Inactive, if mapping addition failed due to already existing dynamic/static mapping, port allocation failure. Possible values = ACTIVE, INACTIVE
__count	Read-only	count parameter

Operations

(click to see Properties )

ADD
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

add

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

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"lsnstatic":{
<b>      "name":<String_value>,
</b><b>      "transportprotocol":<String_value>,
</b><b>      "subscrip":<String_value>,
</b><b>      "subscrport":<Integer_value>,
</b>      "network6":<String_value>,
      "td":<Double_value>,
      "natip":<String_value>,
      "natport":<Integer_value>,
      "destip":<String_value>,
      "dsttd":<Double_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

delete

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

Query-parameters:

args

http:// <netscaler-ip-address> /nitro/v1/config/lsnstatic? args=name: <String_value> ,nattype: <String_value>

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

attrs

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

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

view

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

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

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

{ "lsnstatic": [ {
name:<String_value>,nattype:<String_value>      "transportprotocol":<String_value>,
      "subscrip":<String_value>,
      "subscrport":<Integer_value>,
      "network6":<String_value>,
      "natip":<String_value>,
      "natport":<Integer_value>,
      "td":<Double_value>,
      "destip":<String_value>,
      "dsttd":<Double_value>,
      "status":<String_value>
}]}

<!--NeedCopy-->

get

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

Query-parameters:

attrs

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

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

{  "lsnstatic": [ {
name:<String_value>,nattype:<String_value>      "transportprotocol":<String_value>,
      "subscrip":<String_value>,
      "subscrport":<Integer_value>,
      "network6":<String_value>,
      "natip":<String_value>,
      "natport":<Integer_value>,
      "td":<Double_value>,
      "destip":<String_value>,
      "dsttd":<Double_value>,
      "status":<String_value>
}]}

<!--NeedCopy-->

count

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

{ "lsnstatic": [ { "__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

lsnstatic

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

lsnstatic

Properties

Operations

add

delete

get (all)

get

count

In this article