Download full document:

ns

Statistics for ns.

Properties

(click to see Operations)

NameData TypePermissionsDescription
clearstats<String>Read-writeClear the statsistics / counters.
Possible values = basic, full
rescpuusagepcnt<Double>Read-onlyAverage CPU utilization percentage. Not applicable for a single-CPU system.
cpuusagepcnt<Double>Read-onlyCPU utilization percentage.
cachemaxmemorykb<Double>Read-onlyLargest amount of memory the NetScaler can dedicate to caching, up to 50% of available memory. A 0 value disables caching, but the caching module continues to run.
delcmpratio<Double>Read-onlyRatio of compressible data received to compressed data transmitted.If this ratio is one (uncmp:1.0) that means compression is disabled or we are not able to compress even a single compressible packet.
rescpuusage<Double>Read-onlyShows average CPU utilization percentage if more than 1 CPU is present.
cpuusage<Double>Read-onlyCPU utilization percentage.
resmemusage<Double>Read-onlyPercentage of memory utilization on NetScaler.
comptotaldatacompressionratio<Double>Read-onlyRatio of total HTTP data received to total HTTP data transmitted.
compratio<Double>Read-onlyRatio of the compressible data received from the server to the compressed data sent to the client.
cacheutilizedmemorykb<Double>Read-onlyAmount of memory the integrated cache is currently using.
cachemaxmemoryactivekb<Double>Read-onlyCurrently active value of maximum memory
cache64maxmemorykb<Double>Read-onlyLargest amount of memory the NetScaler can dedicate to caching, up to 50% of available memory. A 0 value disables caching, but the caching module continues to run.
cachepercentoriginbandwidthsaved<Double>Read-onlyPercentage of origin bandwidth saved, expressed as number of bytes served from the integrated cache divided by all bytes served. The assumption is that all compression is done in the NetScaler.
cachetotmisses<Double>Read-onlyIntercepted HTTP requests requiring fetches from origin server.
cachemissesrate<Double>Read-onlyRate (/s) counter for cachetotmisses
cachetothits<Double>Read-onlyResponses served from the integrated cache. These responses match a policy with a CACHE action.
cachehitsrate<Double>Read-onlyRate (/s) counter for cachetothits
sslnumcardsup<Double>Read-onlyNumber of SSL cards that are UP. If the number of cards UP is lower than a threshold, a failover is initiated.
memusagepcnt<Double>Read-onlyPercentage of memory utilization on NetScaler.
memuseinmb<Double>Read-onlyMain memory currently in use, in megabytes.
mgmtcpuusagepcnt<Double>Read-onlyAverage Management CPU utilization percentage.
pktcpuusagepcnt<Double>Read-onlyAverage CPU utilization percentage for all packet engines excluding management PE.
starttime<String>Read-onlyTime when the NetScaler appliance was last started.
transtime<String>Read-onlyTime when the last master state transition occurred. You can use this statistic for debugging.
hacurstate<String>Read-onlyState of the HA node, based on its health, in a high availability setup. Possible values are: UP - Indicates that the node is accessible and can function as either a primary or secondary node. DISABLED - Indicates that the high availability status of the node has been manually disabled. Synchronization and propagation cannot take place between the peer nodes. INIT - Indicates that the node is in the process of becoming part of the high availability configuration. PARTIALFAIL - Indicates that one of the high availability monitored interfaces has failed because of a card or link failure. This state triggers a failover. COMPLETEFAIL - Indicates that all the interfaces of the node are unusable, because the interfaces on which high availability monitoring is enabled are not connected or are manually disabled. This state triggers a failover. DUMB - Indicates that the node is in listening mode. It does not participate in high availability transitions or transfer configuration from the peer node. This is a configured value, not a statistic. PARTIALFAILSSL - Indicates that the SSL card has failed. This state triggers a failover. ROUTEMONITORFAIL - Indicates that the route monitor has failed. This state triggers a failover.
hacurmasterstate<String>Read-onlyIndicates the high availability state of the node. Possible values are: STAYSECONDARY - Indicates that the selected node remains the secondary node in a high availability setup. In this case a forced failover does not change the state but, instead, returns an appropriate error message. This is a configured value and not a statistic. PRIMARY - Indicates that the selected node is the primary node in a high availability setup. SECONDARY - Indicates that the selected node is the secondary node in a high availability setup. CLAIMING - Indicates that the secondary node is in the process of taking over as the primary node. This is the intermediate state in the transition of the secondary node to primary status. FORCE CHANGE - Indicates that the secondary node is forcibly changing its status to primary due to a forced failover issued on the secondary node.
sslcards<Double>Read-onlyNumber of SSL crypto cards present on the NetScaler appliance.
disk0perusage<Double>Read-onlyUsed space in /flash partition of the disk, as a percentage. This is a critical counter. You can configure /flash Used (%) by using the Set snmp alarm DISK-USAGE-HIGH command.
disk1perusage<Double>Read-onlyUsed space in /var partition of the disk, as a percentage. This is a critical counter. You can configure /var Used (%) by using the Set snmp alarm DISK-USAGE-HIGH command.
disk0avail<Double>Read-onlyAvailable space in /flash partition of the hard disk.
disk1avail<Double>Read-onlyAvailable space in /var partition of the hard disk.
totrxmbits<Double>Read-onlyNumber of megabytes received by the NetScaler appliance.
rxmbitsrate<Double>Read-onlyRate (/s) counter for totrxmbits
tottxmbits<Double>Read-onlyNumber of megabytes transmitted by the NetScaler appliance.
txmbitsrate<Double>Read-onlyRate (/s) counter for tottxmbits
tcpcurclientconn<Double>Read-onlyClient connections, including connections in the Opening, Established, and Closing state.
tcpcurclientconnestablished<Double>Read-onlyCurrent client connections in the Established state, which indicates that data transfer can occur between the NetScaler and the client.
tcpcurserverconn<Double>Read-onlyServer connections, including connections in the Opening, Established, and Closing state.
tcpcurserverconnestablished<Double>Read-onlyCurrent server connections in the Established state, which indicates that data transfer can occur between the NetScaler and the server.
httptotrequests<Double>Read-onlyTotal number of HTTP requests received.
httprequestsrate<Double>Read-onlyRate (/s) counter for httptotrequests
httptotresponses<Double>Read-onlyTotal number of HTTP responses sent.
httpresponsesrate<Double>Read-onlyRate (/s) counter for httptotresponses
httptotrxrequestbytes<Double>Read-onlyTotal number of bytes of HTTP request data received.
httprxrequestbytesrate<Double>Read-onlyRate (/s) counter for httptotrxrequestbytes
httptotrxresponsebytes<Double>Read-onlyTotal number of bytes of HTTP response data received.
httprxresponsebytesrate<Double>Read-onlyRate (/s) counter for httptotrxresponsebytes
ssltottransactions<Double>Read-onlyNumber of SSL transactions on the NetScaler appliance.
ssltransactionsrate<Double>Read-onlyRate (/s) counter for ssltottransactions
ssltotsessionhits<Double>Read-onlyNumber of SSL session reuse hits on the NetScaler appliance.
sslsessionhitsrate<Double>Read-onlyRate (/s) counter for ssltotsessionhits
appfirewallrequests<Double>Read-onlyHTTP/HTTPS requests sent to your protected web servers via the Application Firewall.
appfirewallrequestsrate<Double>Read-onlyRate (/s) counter for appfirewallrequests
appfirewallresponses<Double>Read-onlyHTTP/HTTPS responses sent by your protected web servers via the Application Firewall.
appfirewallresponsesrate<Double>Read-onlyRate (/s) counter for appfirewallresponses
appfirewallaborts<Double>Read-onlyIncomplete HTTP/HTTPS requests aborted by the client before the Application Firewall could finish processing them.
appfirewallabortsrate<Double>Read-onlyRate (/s) counter for appfirewallaborts
appfirewallredirects<Double>Read-onlyHTTP/HTTPS requests redirected by the Application Firewall to a different Web page or web server. (HTTP 302)
appfirewallredirectsrate<Double>Read-onlyRate (/s) counter for appfirewallredirects
misccounter0<Double>Read-onlyMiscellaneous Counter 0.
misccounter1<Double>Read-onlyMiscellaneous Counter 1.
numcpus<Double>Read-onlyThe number of CPUs on the NetScaler appliance.

Operations

(click to see Properties)

GET (ALL)

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 redand placeholder content is marked in <green>.

get (all)

URL:http://<netscaler-ip-address>/nitro/v1/stat/ns

Query-parameters:

args

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

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

Content-Type:application/json

Response Payload:

{ "ns": [ {
"appfirewallredirectsrate":<Double_value>,
"ssltottransactions":<Double_value>,
"sslnumcardsup":<Double_value>,
"hacurmasterstate":<String_value>,
"httprxrequestbytesrate":<Double_value>,
"httptotrxresponsebytes":<Double_value>,
"disk1perusage":<Double_value>,
"rescpuusagepcnt":<Double_value>,
"appfirewallresponsesrate":<Double_value>,
"delcmpratio":<Double_value>,
"appfirewallresponses":<Double_value>,
"comptotaldatacompressionratio":<Double_value>,
"httprxresponsebytesrate":<Double_value>,
"disk0perusage":<Double_value>,
"appfirewallabortsrate":<Double_value>,
"appfirewallrequestsrate":<Double_value>,
"ssltotsessionhits":<Double_value>,
"appfirewallredirects":<Double_value>,
"mgmtcpuusagepcnt":<Double_value>,
"cpuusage":<Double_value>,
"httptotresponses":<Double_value>,
"compratio":<Double_value>,
"memuseinmb":<Double_value>,
"sslsessionhitsrate":<Double_value>,
"resmemusage":<Double_value>,
"cache64maxmemorykb":<Double_value>,
"starttime":<String_value>,
"cachepercentoriginbandwidthsaved":<Double_value>,
"misccounter0":<Double_value>,
"memusagepcnt":<Double_value>,
"cachehitsrate":<Double_value>,
"transtime":<String_value>,
"cacheutilizedmemorykb":<Double_value>,
"appfirewallaborts":<Double_value>,
"disk1avail":<Double_value>,
"tcpcurserverconnestablished":<Double_value>,
"tcpcurclientconn":<Double_value>,
"tcpcurserverconn":<Double_value>,
"rescpuusage":<Double_value>,
"appfirewallrequests":<Double_value>,
"totrxmbits":<Double_value>,
"tottxmbits":<Double_value>,
"cachemissesrate":<Double_value>,
"cachemaxmemorykb":<Double_value>,
"httptotrequests":<Double_value>,
"cachetothits":<Double_value>,
"misccounter1":<Double_value>,
"numcpus":<Double_value>,
"pktcpuusagepcnt":<Double_value>,
"ssltransactionsrate":<Double_value>,
"httprequestsrate":<Double_value>,
"cachemaxmemoryactivekb":<Double_value>,
"httpresponsesrate":<Double_value>,
"disk0avail":<Double_value>,
"txmbitsrate":<Double_value>,
"sslcards":<Double_value>,
"hacurstate":<String_value>,
"rxmbitsrate":<Double_value>,
"tcpcurclientconnestablished":<Double_value>,
"cpuusagepcnt":<Double_value>,
"cachetotmisses":<Double_value>,
"httptotrxrequestbytes":<Double_value>
}]}