Citrix ADC 12.1 NITRO API Reference

lsnsession

Configuration for lsn session resource.

Properties

(click to see Operations)

Name Data Type Permissions Description
nattype Read-write Type of sessions to be displayed.
Default value: NAT44
Possible values = NAT44, DS-Lite, NAT64
clientname Read-write Name of the LSN Client entity.
network Read-write IP address or network address of subscriber(s).
netmask Read-write Subnet mask for the IP address specified by the network parameter.
network6 Read-write IPv6 address of the LSN subscriber or B4 device.
td Read-write Traffic domain ID of the LSN client entity.
Default value: 0
Minimum value = 0
Maximum value = 4094
natip Read-write Mapped NAT IP address used in LSN sessions.
nodeid Read-write Unique number that identifies the cluster node.
Minimum value = 0
Maximum value = 31
natport2 Read-write Mapped NAT port used in the LSN sessions.
natprefix Read-only IPv6 address of the LSN subscriber(s) or subscriber network(B4-Device) on whose traffic the Citrix ADC perform Large Scale NAT.
subscrip Read-only The Source IP address.
subscrport Read-only The Source Port.
destip Read-only The Destination IP address.
destport Read-only The Destination Port.
natport Read-only The NAT Port.
transportprotocol Read-only The Transport Protocol for the session.
Possible values = TCP, UDP, ICMP
sessionestdir Read-only The Session establishment direction, session was established for outbound or inbound packet.
Possible values = OUT, IN
dsttd Read-only .
srctd Read-only .
ipv6address Read-only IPv6 address of v6 vserver.
__count Read-only count parameter

Operations

(click to see Properties)

FLUSH 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 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/lsnsession?action=flush

HTTP Method:POST

Request Headers:

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

Request Payload:


{"lsnsession":{
"nattype":<String_value>,
"clientname":<String_value>,
"network":<String_value>,
"netmask":<String_value>,
"network6":<String_value>,
"td":<Double_value>,
"natip":<String_value>,
"natport2":<Integer_value>,
"nodeid":<Double_value>
}}

<!--NeedCopy-->

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

get (all)

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/lsnsession

Query-parameters:

args

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/lsnsession?args=nattype:<String_value>,clientname:<String_value>,network:<String_value>,netmask:<String_value>,network6:<String_value>,td:<Double_value>,natip:<String_value>,nodeid:<Double_value>

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

attrs

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/lsnsession?attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/lsnsession?filter=property-name1:property-val1,property-name2:property-val2

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

view

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/lsnsession?view=summary

Note:By default, the retrieved results are displayed in detail view (?view=detail).

pagination

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/lsnsession?pagesize=#no;pageno=#no

Use this query-parameter to get the lsnsession 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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:


{ "lsnsession": [ {
nattype:<String_value>,clientname:<String_value>,network:<String_value>,netmask:<String_value>,network6:<String_value>,td:<Double_value>,natip:<String_value>,nodeid:<Double_value>"natprefix":<String_value>,
"subscrip":<String_value>,
"subscrport":<Integer_value>,
"destip":<String_value>,
"destport":<Integer_value>,
"natport":<Integer_value>,
"transportprotocol":<String_value>,
"sessionestdir":<String_value>,
"dsttd":<Double_value>,
"srctd":<Double_value>,
"ipv6address":<String_value>
}]}

<!--NeedCopy-->

count

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/lsnsession?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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:


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

<!--NeedCopy-->
lsnsession