Product Documentation

nsconnectiontable

Sep 07, 2016

Configuration for TCP/IP connection table resource.

Properties (click to see Operations)

Name Data Type Permissions Description
filterexpression
<String>
Read-write
The maximum length of filter expression is 255 and it can be of following format:
<expression> [<relop> <expression>]

<relop> = ( && | || )

<expression> =:
CONNECTION.<qualifier>.<qualifier-method>.(<qualifier-value>)

<qualifier> = SRCIP
<qualifier-method> = [ EQ | NE ]
<qualifier-value> = A valid IPv4 address
example = CONNECTION.SRCIP.EQ(127.0.0.1)

<qualifier> = DSTIP
<qualifier-method> = [ EQ | NE ]
<qualifier-value> = A valid IPv4 address.
example = CONNECTION.DSTIP.EQ(127.0.0.1)

<qualifier> = IP
<qualifier-method> = [ EQ | NE ]
<qualifier-value> = A valid IPv4 address.
example = CONNECTION.IP.EQ(127.0.0.1)

<qualifier> = SRCIPv6
<qualifier-method> = [ EQ | NE ]
<qualifier-value> = A valid IPv6 address.
example = CONNECTION.SRCIPv6.EQ(2001:db8:0:0:1::1)

<qualifier> = DSTIPv6
<qualifier-method> = [ EQ | NE ]
<qualifier-value> = A valid IPv6 address.
example = CONNECTION.DSTIPv6.EQ(2001:db8:0:0:1::1)

<qualifier> = IPv6
<qualifier-method> = [ EQ | NE ]
<qualifier-value> = A valid IPv6 address.
example = CONNECTION.IPv6.EQ(2001:db8:0:0:1::1)

<qualifier> = SRCPORT
<qualifier-method> = [ EQ | NE | GT | GE | LT | LE
| BETWEEN ]
<qualifier-value> = A valid port number.
example = CONNECTION.SRCPORT.EQ(80)

<qualifier> = DSTPORT
<qualifier-method> = [ EQ | NE | GT | GE | LT | LE
| BETWEEN ]
<qualifier-value> = A valid port number.
example = CONNECTION.DSTPORT.EQ(80)

<qualifier> = PORT
<qualifier-method> = [ EQ | NE | GT | GE | LT | LE
| BETWEEN ]
<qualifier-value> = A valid port number.
example = CONNECTION.PORT.EQ(80)

<qualifier> = SVCNAME
<qualifier-method> = [ EQ | NE | CONTAINS | STARTSWITH
| ENDSWITH ]
<qualifier-value> = service name.
example = CONNECTION.SVCNAME.EQ("name")

<qualifier> = LB_VSERVER.NAME
<qualifier-method> = [ EQ | NE | CONTAINS | STARTSWITH
| ENDSWITH ]
<qualifier-value> = LB vserver name.
example = CONNECTION.LB_VSERVER.NAME.EQ("name")

<qualifier> = CS_VSERVER.NAME
<qualifier-method> = [ EQ | NE | CONTAINS | STARTSWITH
| ENDSWITH ]
<qualifier-value> = CS vserver name.
example = CONNECTION.CS_VSERVER.NAME.EQ("name")

<qualifier> = INTF
<qualifier-method> = [ EQ | NE ]
<qualifier-value> = A valid interface id in the form of
x/y (n/x/y in case of cluster interface).
examle = CONNECTION.INTF.EQ("0/1/1")

<qualifier> = VLANID
<qualifier-method> = [ EQ | NE | GT | GE | LT | LE
| BETWEEN ]
<qualifier-value> = A valid VLAN ID.
example = CONNECTION.VLANID.EQ(0)

<qualifier> = CONNID
<qualifier-method> = [ EQ | NE | GT | GE | LT | LE
| BETWEEN ]
<qualifier-value> = A valid PCB dev number.
example = CONNECTION.CONNID.EQ(0)

<qualifier> = PPEID
<qualifier-method> = [ EQ | NE | GT | GE | LT | LE
| BETWEEN ]
<qualifier-value> = A valid core ID.
example = CONNECTION.PPEID.EQ(0)

<qualifier> = IDLETIME
<qualifier-method> = [ EQ | NE | GT | GE | LT | LE
| BETWEEN ]
<qualifier-value> = A positive integer indicating the
idletime.
example = CONNECTION.IDLETIME.LT(100)

<qualifier> = TCPSTATE
<qualifier-method> = [ EQ | NE ]
<qualifier-value> = ( CLOSE_WAIT | CLOSED | CLOSING |
ESTABLISHED | FIN_WAIT_1 | FIN_WAIT_2 | LAST_ACK |
LISTEN | SYN_RECEIVED | SYN_SENT | TIME_WAIT |
NOT_APPLICABLE)
example = CONNECTION.TCPSTATE.EQ(LISTEN)

<qualifier> = SERVICE_TYPE
<qualifier-method> = [ EQ | NE ]
<qualifier-value> = ( SVC_HTTP | FTP | TCP | UDP | SSL |
SSL_BRIDGE | SSL_TCP | NNTP | RPCSVR | RPCSVRS |
RPCCLNT | SVC_DNS | ADNS | SNMP | RTSP | DHCPRA | ANY|
MONITOR | MONITOR_UDP | MONITOR_PING | SIP_UDP |
SVC_MYSQL | SVC_MSSQL | SERVICE_UNKNOWN )
example = CONNECTION.SERVICE_TYPE.EQ(ANY)

<qualifier> = TRAFFIC_DOMAIN_ID
<qualifier-method> = [ EQ | NE | GT | GE | LT | LE
| BETWEEN ]
<qualifier-value> = A valid traffic domain ID.
example = CONNECTION.TRAFFIC_DOMAIN_ID.EQ(0)

common usecases:
Filtering out loopback connections and view present
connections through netsclaer
show connectiontable "CONNECTION.IP.NEQ(127.0.0.1) &&
CONNECTION.TCPSTATE.EQ(ESTABLISHED)" -detail full

show connections from a particular sourceip and targeted
to port 80
show connectiontable "CONNECTION.SRCIP.EQ(10.102.1.91) &&
CONNECTION.DSTPORT.EQ(80)"

show connection particular to a service and its linked
client connections
show connectiontable "CONNECTION.SVCNAME.EQ("S1")"
-detail link

show connections for a particular servicetype(e.g.http)
show connectiontable "CONNECTION.SERVICE_TYPE.EQ(TCP)"

viewing connections that have been idle for a long time
show connectiontable "CONNECTION.IDLETIME.GT(100)"

show connections for a particular interface and vlan
show connectiontable "CONNECTION.INTF.EQ("1/1") &&
CONNECTION.VLANID.EQ(1)"
.
link
<Boolean>
Read-write
Display link information if available.
filtername
<Boolean>
Read-write
Display name instead of IP for local entities.
detail
<String[]>
Read-write
Specify display options for the connection table.
* LINK - Displays the linked PCB (Protocol Control Block).
* NAME - Displays along with the service name.
* CONNFAILOVER - Displays PCB with connection failover.
* FULL - Displays all available details.
Possible values = LINK, NAME, CONNFAILOVER, FULL, NNM
listen
<Boolean>
Read-write
Display listening services only.
sourceip
<String>
Read-only
Source IP of the connection.
sourceport
<Integer>
Read-only
Source port of the connection.
Range 1 - 65535
* in CLI is represented as 65535 in NITRO API
destip
<String>
Read-only
Destination IP of the connection.
destport
<Integer>
Read-only
Destination port of the connection.
Range 1 - 65535
* in CLI is represented as 65535 in NITRO API
svctype
<String>
Read-only
Protocol supported by the connection.
Possible values = HTTP, FTP, TCP, UDP, SSL, SSL_BRIDGE, SSL_TCP, NNTP, RPCSVR, DNS, ADNS, SNMP, RTSP, DHCPRA, ANY, SIP_UDP, SIP_TCP, SIP_SSL, DNS_TCP, ADNS_TCP, HTTPSVR, HTTPCLIENT, NAT, HA, AAA, SINCTCP, VPN AFTP, MONITORS, SSLVPN UDP, SINCUDP, RIP, UDP CLNT, SASP, RPCCLNTS, ROUTE, AUDIT, STA HTTP, STA SSL, DNS RESOLVE, RDP, MYSQL, MSSQL, DIAMETER, SSL_DIAMETER, TFTP, ORACLE, ICA, RADIUS, RADIUSListener, SMPP, PPTP, GRE, SYSLOGTCP, SYSLOGUDP, FIX, SSL_FIX, TFTP_DATA
idletime
<Integer>
Read-only
Time since last activity was detected on the connection.
state
<String>
Read-only
Current TCP/IP state of the connection.
Possible values = CLOSED, LISTEN, SYN_SENT, SYN_RECEIVED, ESTABLISHED, CLOSE_WAIT, FIN_WAIT_1, CLOSING, LAST_ACK, FIN_WAIT_2, TIME_WAIT, NA
linksourceip
<String>
Read-only
Source IP of the link connection.
linksourceport
<Integer>
Read-only
Source port of the link connection.
Range 1 - 65535
* in CLI is represented as 65535 in NITRO API
linkdestip
<String>
Read-only
Destination IP of the link connection.
linkdestport
<Integer>
Read-only
Destination port of the link connection.
Range 1 - 65535
* in CLI is represented as 65535 in NITRO API
linkservicetype
<String>
Read-only
Protocol supported by the link connection.
Possible values = HTTP, FTP, TCP, UDP, SSL, SSL_BRIDGE, SSL_TCP, NNTP, RPCSVR, DNS, ADNS, SNMP, RTSP, DHCPRA, ANY, SIP_UDP, SIP_TCP, SIP_SSL, DNS_TCP, ADNS_TCP, HTTPSVR, HTTPCLIENT, NAT, HA, AAA, SINCTCP, VPN AFTP, MONITORS, SSLVPN UDP, SINCUDP, RIP, UDP CLNT, SASP, RPCCLNTS, ROUTE, AUDIT, STA HTTP, STA SSL, DNS RESOLVE, RDP, MYSQL, MSSQL, DIAMETER, SSL_DIAMETER, TFTP, ORACLE, ICA, RADIUS, RADIUSListener, SMPP, PPTP, GRE, SYSLOGTCP, SYSLOGUDP, FIX, SSL_FIX, TFTP_DATA
linkidletime
<Integer>
Read-only
Time since last activity was detected on link connection.
linkstate
<String>
Read-only
TCP/IP current state of link connection.
Possible values = CLOSED, LISTEN, SYN_SENT, SYN_RECEIVED, ESTABLISHED, CLOSE_WAIT, FIN_WAIT_1, CLOSING, LAST_ACK, FIN_WAIT_2, TIME_WAIT, NA
entityname
<String>
Read-only
NetScaler entity name for the connection.
linkentityname
<String>
Read-only
NetScaler entity name for link connection.
connid
<Double>
Read-only
Unique transaction number for the connection.
linkconnid
<Double>
Read-only
Unique transaction number for the peer connection.
connproperties
<String[]>
Read-only
flags used to store connection properties like client, server etc.
Possible values = LINK, HASLINK, CLIENT, SERVER, NNM, MPTCP, SUBFLOW
optionflags
<String[]>
Read-only
flags used to store TCP options like Sack, WS.
Possible values = sack, timstmp, ws
nswsvalue
<Double>
Read-only
netscaler window scaling value.
peerwsvalue
<Double>
Read-only
peer window scaling value.
mss
<Integer>
Read-only
Client side MSS for the connection - used in server SYN.
retxretrycnt
<Integer>
Read-only
Retransmission retry count for the connection.
rcvwnd
<Integer>
Read-only
Received Advertised Window for the connection.
advwnd
<Integer>
Read-only
Sent advertised window for the connection.
sndcwnd
<Integer>
Read-only
sent congestion window for the connection.
iss
<Integer>
Read-only
Initial send sequence number for the connection.
irs
<Integer>
Read-only
Initial receive sequence number for the connection.
rcvnxt
<Integer>
Read-only
next expecting seq number for the connection.
maxack
<Integer>
Read-only
current running max ack sent for the connection.
sndnxt
<Integer>
Read-only
next bytes seq number for the connection.
sndunack
<Integer>
Read-only
Most recently received ACK for the connection.
httpendseq
<Integer>
Read-only
HTTP parsing tracking seq number for the connection.
httpstate
<String>
Read-only
HTTP Protocol state for the connection.
Possible values = INITIALIZED, CONTENT_LENGTH, CHUNKED, WAIT_FINAL_ACK, UNKNOWN, DONE, WAIT_FIN
trcount
<Integer>
Read-only
Max reuests allowed per connection.
priority
<String>
Read-only
priority of the connection.
Possible values = SC Priority, Priority queue1, priority queue2, priority queue3, DoS Priority, Surge Priority
httpreqver
<String>
Read-only
current HTTP request version on the connection.
Possible values = HTTP_1_0, HTTP_1_1, HTTP_0_9, RTSP_1_0, SIP_2_0, VPN_ICA_SOCKS, VPN_ICA_CGP, HTTP_2_0
httprequest
<String>
Read-only
current HTTP request type on the connection.
Possible values = OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, CONNECT, RPCCONNECT
httprspcode
<Integer>
Read-only
current response type on the connection.
rttsmoothed
<Integer>
Read-only
smoothed RTT value of the connection.
rttvariance
<Integer>
Read-only
RTT variance for the connection.
outoforderpkts
<Integer>
Read-only
held packets on the connection.
linkoptionflag
<String[]>
Read-only
Link connection's TCP option flag for Sack and WS.
Possible values = sack, timstmp, ws
linknswsvalue
<Double>
Read-only
Link connection-s netscaler window scaling value.
linkpeerwsvalue
<Double>
Read-only
Link connection-s peer netscaler window scaling value.
targetnodeidnnm
<Integer>
Read-only
NNM connection target node ID.
sourcenodeidnnm
<Integer>
Read-only
NNM connection source node ID.
channelidnnm
<Double>
Read-only
NNM connection channel ID.
msgversionnnm
<Double>
Read-only
nnm message version.
td
<Double>
Read-only
Traffic Domain Id.
maxrcvbuf
<Integer>
Read-only
Maximum receive window that application advertizes to peer.
linkmaxrcvbuf
<Integer>
Read-only
Maximum receive window that application advertizes to peer in linked connection.
rxqsize
<Integer>
Read-only
Total number of bytes in Netscaler receive buffer. This includes bytes being processed / policy related data / stored in application buffer.
linkrxqsize
<Integer>
Read-only
Total number of bytes in Netscaler receive buffer for linked connection. This includes bytes being processed / policy related data / stored in application buffer.
maxsndbuf
<Integer>
Read-only
Maximum send window that application can process and send.
linkmaxsndbuf
<Integer>
Read-only
Maximum send window that application can process and send in linked connection.
txqsize
<Integer>
Read-only
Total number of bytes in Netscaler send buffer. This includes both inflight and queued bytes in netscaler.
linktxqsize
<Integer>
Read-only
Total number of bytes in Netscaler send buffer for linked connection. This includes both inflight and queued bytes in netscaler.
flavor
<String>
Read-only
TCP congestion control algorithm.
Possible values = Default, Westwood, BIC, CUBIC, Nile
linkflavor
<String>
Read-only
TCP congestion control algorithm for a linked connection.
Possible values = Default, Westwood, BIC, CUBIC, Nile
bwestimate
<Integer>
Read-only
TCP Bandwidth Estimate.
linkbwestimate
<Integer>
Read-only
TCP Bandwidth Estimate for a linked connection.
rttmin
<Integer>
Read-only
Minimum Round Trip Time for the connection.
linkrttmin
<Integer>
Read-only
Minimum Round Trip Time for linked connection.
name
<String>
Read-only
Name of TCP profile attached to the connection.
Minimum length = 1
Maximum length = 127
linkname
<String>
Read-only
Name of TCP profile attached to the connection.
Minimum length = 1
Maximum length = 127
tcpmode
<String>
Read-only
TCP Optimization modes TRANSPARENT / ENDPOINT.
Possible values = TRANSPARENT, ENDPOINT
linktcpmode
<String>
Read-only
TCP Optimization modes TRANSPARENT / ENDPOINT for linked connection.
Possible values = TRANSPARENT, ENDPOINT
realtimertt
<Integer>
Read-only
Real Time / Instantaneous round trip time.
linkrealtimertt
<Integer>
Read-only
Real Time / Instantaneous round trip time for linked connection.
sndbuf
<Integer>
Read-only
send buffer size.
linksndbuf
<Integer>
Read-only
Send buffer size for linked connection.
nsbtcpwaitq
<Integer>
Read-only
Number of packets in TCP wait queue.
linknsbtcpwaitq
<Integer>
Read-only
Number of packets in wait queue for linked connection.
nsbretxq
<Integer>
Read-only
Number of packets in retransmission queue.
linknsbretxq
<Integer>
Read-only
Number of packets in retransmission queue for linked connection.
sackblocks
<Integer>
Read-only
Number of sack blocks attached to the connection.
linksackblocks
<Integer>
Read-only
Number of sack blocks attached in linked connection.
congstate
<String>
Read-only
TCP congestion state.
Possible values = open, recovery, loss, reneg, partial_ACK, retx_lost
linkcongstate
<String>
Read-only
TCP congestion state for a linked connection.
Possible values = open, recovery, loss, reneg, partial_ACK, retx_lost
sndrecoverle
<Double>
Read-only
Sequence Number denoting end of fast recovery.
linksndrecoverle
<Double>
Read-only
Sequence Number denoting end of fast recovery for linked connection.
__count
<Double>
Read-only
count parameter

Operations (click to see Properties)

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>

메모

Mandatory parameters are marked in red and placeholder content is marked in <green>.

get (all)

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

Query-parameters:

args

http://<netscaler-ip-address>/nitro/v1/config/nsconnectiontable?args=filterexpression:<String_value>,link:<Boolean_value>,filtername:<Boolean_value>,detail:<String[]_value>,listen:<Boolean_value>

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

attrs

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

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

view

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

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

pagination

http://<netscaler-ip-address>/nitro/v1/config/nsconnectiontable?pagesize=#no&pageno=#no

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

Content-Type:application/json

Response Payload:

{ "nsconnectiontable": [ {
filterexpression:<String_value>,link:<Boolean_value>,filtername:<Boolean_value>,detail:<String[]_value>,listen:<Boolean_value>      "sourceip":<String_value>,
      "sourceport":<Integer_value>,
      "destip":<String_value>,
      "destport":<Integer_value>,
      "svctype":<String_value>,
      "idletime":<Integer_value>,
      "state":<String_value>,
      "linksourceip":<String_value>,
      "linksourceport":<Integer_value>,
      "linkdestip":<String_value>,
      "linkdestport":<Integer_value>,
      "linkservicetype":<String_value>,
      "linkidletime":<Integer_value>,
      "linkstate":<String_value>,
      "entityname":<String_value>,
      "linkentityname":<String_value>,
      "connectionnumber":<Integer_value>,
      "linkconnectionnumber":<Integer_value>,
      "connid":<Double_value>,
      "linkconnid":<Double_value>,
      "connproperties":<String[]_value>,
      "optionflags":<String[]_value>,
      "nswsvalue":<Double_value>,
      "peerwsvalue":<Double_value>,
      "mss":<Integer_value>,
      "retxretrycnt":<Integer_value>,
      "rcvwnd":<Integer_value>,
      "advwnd":<Integer_value>,
      "sndcwnd":<Integer_value>,
      "iss":<Integer_value>,
      "irs":<Integer_value>,
      "rcvnxt":<Integer_value>,
      "maxack":<Integer_value>,
      "sndnxt":<Integer_value>,
      "sndunack":<Integer_value>,
      "httpendseq":<Integer_value>,
      "httpstate":<String_value>,
      "trcount":<Integer_value>,
      "priority":<String_value>,
      "httpreqver":<String_value>,
      "httprequest":<String_value>,
      "httprspcode":<Integer_value>,
      "rttsmoothed":<Integer_value>,
      "rttvariance":<Integer_value>,
      "outoforderpkts":<Integer_value>,
      "linkoptionflag":<String[]_value>,
      "linknswsvalue":<Double_value>,
      "linkpeerwsvalue":<Double_value>,
      "targetnodeidnnm":<Integer_value>,
      "sourcenodeidnnm":<Integer_value>,
      "channelidnnm":<Double_value>,
      "msgversionnnm":<Double_value>,
      "td":<Double_value>,
      "maxrcvbuf":<Integer_value>,
      "linkmaxrcvbuf":<Integer_value>,
      "rxqsize":<Integer_value>,
      "linkrxqsize":<Integer_value>,
      "maxsndbuf":<Integer_value>,
      "linkmaxsndbuf":<Integer_value>,
      "txqsize":<Integer_value>,
      "linktxqsize":<Integer_value>,
      "flavor":<String_value>,
      "linkflavor":<String_value>,
      "bwestimate":<Integer_value>,
      "linkbwestimate":<Integer_value>,
      "rttmin":<Integer_value>,
      "linkrttmin":<Integer_value>,
      "name":<String_value>,
      "linkname":<String_value>,
      "tcpmode":<String_value>,
      "linktcpmode":<String_value>,
      "realtimertt":<Integer_value>,
      "linkrealtimertt":<Integer_value>,
      "sndbuf":<Integer_value>,
      "linksndbuf":<Integer_value>,
      "nsbtcpwaitq":<Integer_value>,
      "linknsbtcpwaitq":<Integer_value>,
      "nsbretxq":<Integer_value>,
      "linknsbretxq":<Integer_value>,
      "sackblocks":<Integer_value>,
      "linksackblocks":<Integer_value>,
      "congstate":<String_value>,
      "linkcongstate":<String_value>,
      "sndrecoverle":<Double_value>,
      "linksndrecoverle":<Double_value>
}]}

count

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

Content-Type:application/json

Response Payload:

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