Download full document:

lsnstatic

Configuration for static mapping resource.

Properties

(click to see Operations)

Name	Data Type	Permissions	Description
name	<String>	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 NetScaler 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).<br>Minimum length = 1<br>Maximum length = 127
transportprotocol	<String>	Read-write	Protocol for the LSN mapping entry.<br>Possible values = TCP, UDP, ICMP
subscrip	<String>	Read-write	IPv4 address of an LSN subscriber for the LSN mapping entry.
subscrport	<Integer>	Read-write	Port of the LSN subscriber for the LSN mapping entry.<br>Minimum value = 0<br>Maximum value = 65535
td	<Double>	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.<br>Default value: 0<br>Minimum value = 0<br>Maximum value = 4094
natip	<String>	Read-write	IPv4 address, already existing on the NetScaler ADC as type LSN, to be used as NAT IP address for this mapping entry.
natport	<Integer>	Read-write	NAT port for this LSN mapping entry.
destip	<String>	Read-write	Destination IP address for the LSN mapping entry.
dsttd	<Double>	Read-write	ID of the traffic domain through which the destination IP address for this LSN mapping entry is reachable from the NetScaler 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.<br>Default value: 0<br>Minimum value = 0<br>Maximum value = 4094
status	<String>	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.<br>Possible values = ACTIVE, INACTIVE
__count	<Double>	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://<NSIP>/nitro/v1/config/

HTTP Method: POST

Request Payload:

object={
"params":{
      "warning":<String_value>,
      "onerror":<String_value>
},
"sessionid":"##sessionid",
"lsnstatic":{
      "name":<String_value>,
      "transportprotocol":<String_value>,
      "subscrip":<String_value>,
      "subscrport":<Integer_value>,
      "td":<Double_value>,
      "natip":<String_value>,
      "natport":<Integer_value>,
      "destip":<String_value>,
      "dsttd":<Double_value>,
}}

Response Payload:

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

delete

URL: http://<NSIP>/nitro/v1/config/lsnstatic/name_value<String>

Query-parameters:

warning

http://<NS_IP>/nitro/v1/config/lsnstatic/name_value<String>?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: DELETE

Response Payload:

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

get (all)

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

Query-parameters:

filter

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

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

pagesize=#no;pageno=#no

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

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

warning

http://<NS_IP>/nitro/v1/config/lsnstatic?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>, "lsnstatic": [ {
      "name":<String_value>,
      "transportprotocol":<String_value>,
      "subscrip":<String_value>,
      "subscrport":<Integer_value>,
      "natip":<String_value>,
      "natport":<Integer_value>,
      "td":<Double_value>,
      "destip":<String_value>,
      "dsttd":<Double_value>,
      "status":<String_value>

}]}

get

URL: http://<NS_IP>/nitro/v1/config/lsnstatic/name_value<String>

HTTP Method: GET

Response Payload:

{ "errorcode": 0, "message": "Done", "lsnstatic": [ {
      "name":<String_value>,
      "transportprotocol":<String_value>,
      "subscrip":<String_value>,
      "subscrport":<Integer_value>,
      "natip":<String_value>,
      "natport":<Integer_value>,
      "td":<Double_value>,
      "destip":<String_value>,
      "dsttd":<Double_value>,
      "status":<String_value>

}]}

count

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

HTTP Method: GET

Response Payload:

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