inatsession¶

Statistics for stateful INAT resource.

Properties¶

(click to see Operations )

Name	Data Type	Permissions	Description
name	<String>	Read-write	INAT name. Minimum length = 1
clearstats	<String>	Read-write	Clear the statsistics / counters. Possible values = basic, full
globalinathits	<Double>	Read-only	Total INAT Session hits
globalinathitsrate	<Double>	Read-only	Rate (/s) counter for globalinathits
globalinatcursessions	<Double>	Read-only	Total INAT current sessions
globalinatcursessionsrate	<Double>	Read-only	Rate (/s) counter for globalinatcursessions
globalinatreceivebytes	<Double>	Read-only	Total INAT Received Bytes
globalinatreceivebytesrate	<Double>	Read-only	Rate (/s) counter for globalinatreceivebytes
globalinattotsentbytes	<Double>	Read-only	Total INAT Sent Bytes
globalinatsentbytesrate	<Double>	Read-only	Rate (/s) counter for globalinattotsentbytes
globalinatpktreceived	<Double>	Read-only	Total INAT Packets Received
globalinatpktreceivedrate	<Double>	Read-only	Rate (/s) counter for globalinatpktreceived
globalinatpktsent	<Double>	Read-only	Total INAT Packets Sent
globalinatpktsentrate	<Double>	Read-only	Rate (/s) counter for globalinatpktsent
inattothits	<Double>	Read-only	INAT total sessions
inathitsrate	<Double>	Read-only	Rate (/s) counter for inattothits
inatcursessions	<Double>	Read-only	INAT current sessions
inatcursessionsrate	<Double>	Read-only	Rate (/s) counter for inatcursessions
inattotreceivebytes	<Double>	Read-only	INAT total Received Bytes
inatreceivebytesrate	<Double>	Read-only	Rate (/s) counter for inattotreceivebytes
inattotsentbytes	<Double>	Read-only	INAT total Sent Bytes
inatsentbytesrate	<Double>	Read-only	Rate (/s) counter for inattotsentbytes
inattotpktreceived	<Double>	Read-only	INAT total Packets Received
inatpktreceivedrate	<Double>	Read-only	Rate (/s) counter for inattotpktreceived
inattotpktsent	<Double>	Read-only	INAT total Packets Sent
inatpktsentrate	<Double>	Read-only	Rate (/s) counter for inattotpktsent

Operations¶

(click to see Properties )

GET (ALL)
GET

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/stat/inatsession

Query-parameters:

args

http:// <netscaler-ip-address> /nitro/v1/stat/inatsession? args=name: <String_value> ,detail: <Boolean_value> ,fullvalues: <Boolean_value> ,ntimes: <Double_value> ,logfile: <String_value> ,clearstats: <String_value>

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

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:

{  "inatsession": [ {
      "name":<String_value>,
      "inatreceivebytesrate":<Double_value>,
      "globalinatcursessionsrate":<Double_value>,
      "inathitsrate":<Double_value>,
      "globalinatreceivebytesrate":<Double_value>,
      "globalinatpktsentrate":<Double_value>,
      "globalinathits":<Double_value>,
      "globalinathitsrate":<Double_value>,
      "inatpktsentrate":<Double_value>,
      "globalinatpktreceived":<Double_value>,
      "globalinatpktreceivedrate":<Double_value>,
      "inattothits":<Double_value>,
      "inattotpktsent":<Double_value>,
      "globalinatreceivebytes":<Double_value>,
      "globalinatcursessions":<Double_value>,
      "inattotsentbytes":<Double_value>,
      "globalinatpktsent":<Double_value>,
      "globalinatsentbytesrate":<Double_value>,
      "inattotreceivebytes":<Double_value>,
      "inatcursessionsrate":<Double_value>,
      "inatcursessions":<Double_value>,
      "inatsentbytesrate":<Double_value>,
      "globalinattotsentbytes":<Double_value>,
      "inattotpktreceived":<Double_value>,
      "inatpktreceivedrate":<Double_value>
}]}

get¶

URL: http:// <netscaler-ip-address> /nitro/v1/stat/inatsession/ name_value><String>