statnsResult Structure Definition

The statnsResult structure defines the return type for statns API.

Syntax



Members

rc

If the method succeeds, rc is 0 else rc > 0. Values above 0x8000 indicate Warnings.

message

If the method succeeds, message is NULL else message contains Error/Warning message.

nsList

Pointer to the ns List.


nsstats Structure Definition

The nsstats structure defines the actual return type values for statns API.

Syntax



Members

clearstats

Clear the statsistics / counters

_nextgenapiresource


rescpuusagepcnt

Average CPU utilization percentage. Not applicable for a single-CPU system.

cpuusagepcnt

CPU utilization percentage.

cachemaxmemorykb

Largest amount of memory the Citrix ADC can dedicate to caching, up to 50% of available memory. A 0 value disables caching, but the caching module continues to run.

delcmpratio

Ratio 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

Shows average CPU utilization percentage if more than 1 CPU is present.

cpuusage

CPU utilization percentage.

resmemusage

Percentage of memory utilization on Citrix ADC.

comptotaldatacompressionratio

Ratio of total HTTP data received to total HTTP data transmitted.

compratio

Ratio of the compressible data received from the server to the compressed data sent to the client.

cacheutilizedmemorykb

Amount of memory the integrated cache is currently using.

cachemaxmemoryactivekb

Currently active value of maximum memory

cache64maxmemorykb

Largest amount of memory the Citrix ADC can dedicate to caching, up to 50% of available memory. A 0 value disables caching, but the caching module continues to run.

cachepercentoriginbandwidthsaved

Percentage 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 Citrix ADC.

cachetotmisses

Intercepted HTTP requests requiring fetches from origin server.

cachemissesrate

Intercepted HTTP requests requiring fetches from origin server.

cachetothits

Responses served from the integrated cache. These responses match a policy with a CACHE action.

cachehitsrate

Responses served from the integrated cache. These responses match a policy with a CACHE action.

memusagepcnt

Percentage of memory utilization on Citrix ADC.

memuseinmb

Main memory currently in use, in megabytes.

mgmtcpuusagepcnt

Average Management CPU utilization percentage.

pktcpuusagepcnt

Average CPU utilization percentage for all packet engines excluding management PE.

starttimelocal

Time (in local timezone format) when the Citrix ADC was last started.

starttime

Time when the Citrix ADC was last started.

transtime

Time when the last master state transition occurred. You can use this statistic for debugging.

hacurstate

State 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.
Possible Values : UNKNOWN, INIT, DOWN, UP, PARTIALFAIL, COMPLETEFAIL, DUMB, DISABLED, PARTIALFAILSSL, ROUTEMONITORFAIL.

hacurmasterstate

Indicates 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.
Possible Values : Secondary, Claiming, Primary, STAYSECONDARY, Force change.

sslnumcardsup

Number of SSL cards that are UP. If the number of cards UP is lower than a threshold, a failover is initiated.

sslcards

Number of SSL crypto cards present on the Citrix ADC.

disk0perusage

Used 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

Used 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

Available space in /flash partition of the hard disk.

disk1avail

Available space in /var partition of the hard disk.

totrxmbits

Number of megabytes received by the Citrix ADC.

rxmbitsrate

Rate of megabytes received by the Citrix ADC.

tottxmbits

Number of megabytes transmitted by the Citrix ADC.

txmbitsrate

Rate of megabytes transmitted by the Citrix ADC.

tcpcurclientconn

Client connections, including connections in the Opening, Established, and Closing state.

tcpcurclientconnestablished

Current client connections in the Established state, which indicates that data transfer can occur between the Citrix ADC and the client.

tcpcurserverconn

Server connections, including connections in the Opening, Established, and Closing state.

tcpcurserverconnestablished

Current server connections in the Established state, which indicates that data transfer can occur between the Citrix ADC and the server.

httptotrequests

Total number of HTTP requests received.

httprequestsrate

Rate of HTTP requests received.

httptotresponses

Total number of HTTP responses sent.

httpresponsesrate

Rate of HTTP responses sent.

httptotrxrequestbytes

Total number of bytes of HTTP request data received.

httprxrequestbytesrate

Rate of bytes of HTTP request data received.

httptotrxresponsebytes

Total number of bytes of HTTP response data received.

httprxresponsebytesrate

Rate of bytes of HTTP response data received.

ssltottransactions

Number of SSL transactions on the Citrix ADC

ssltransactionsrate

Rate of SSL transactions on the Citrix ADC

ssltotsessionhits

Number of SSL session reuse hits on the Citrix ADC.

sslsessionhitsrate

Rate of SSL session reuse hits on the Citrix ADC.

appfirewallrequests

HTTP/HTTPS requests sent to your protected web servers via the Application Firewall.

appfirewallrequestsrate

HTTP/HTTPS requests sent to your protected web servers via the Application Firewall.

appfirewallresponses

HTTP/HTTPS responses sent by your protected web servers via the Application Firewall.

appfirewallresponsesrate

HTTP/HTTPS responses sent by your protected web servers via the Application Firewall.

appfirewallaborts

Incomplete HTTP/HTTPS requests aborted by the client before the Application Firewall could finish processing them.

appfirewallabortsrate

Incomplete HTTP/HTTPS requests aborted by the client before the Application Firewall could finish processing them.

appfirewallredirects

HTTP/HTTPS requests redirected by the Application Firewall to a different Web page or web server. (HTTP 302)

appfirewallredirectsrate

HTTP/HTTPS requests redirected by the Application Firewall to a different Web page or web server. (HTTP 302)

enainbwlimitexceeded

Inbound BW Limits Exceeded

enainbwlimitexceededrate

Inbound BW Limits Exceeded

enaoutbwlimitexceeded

Outbound BW Limits Exceeded

enaoutbwlimitexceededrate

Outbound BW Limits Exceeded

enappslimitexceeded

PPS Limits Exceeded

enappslimitexceededrate

PPS Limits Exceeded

enaconntracklimitexceeded

Conn-Tracking Limits Exceeded

enaconntracklimitexceededrate

Conn-Tracking Limits Exceeded

enalinklocallimitexceeded

Link-Local Limits Exceeded

enalinklocallimitexceededrate

Link-Local Limits Exceeded

misccounter0

Miscellaneous Counter 0.

misccounter1

Miscellaneous Counter 1.

numcpus

The number of CPUs on the Citrix ADC.

cpuuse

CPU utilization: percentage * 10.

mgmtcpuuse

Management CPU utilization: percentage * 10.

cachetot304hits

Object not modified responses served from the cache. (Status code 304 served instead of the full response.)

cache304hitsrate

Object not modified responses served from the cache. (Status code 304 served instead of the full response.)

cachetotnon304hits

Total number of full (non-304) responses served from the cache. A 304 status code indicates that a response has not been modified since the last time it was served

cachenon304hitsrate

Rate of full (non-304) responses served from the cache. A 304 status code indicates that a response has not been modified since the last time it was served

cachetotsqlhits

sql response served from cache

cachesqlhitsrate

sql response served from cache

cachetotrequests

Total cache hits plus total cache misses.

cacherequestsrate

Rate cache hits plus Rate cache misses.

comptotaltxbytes

Number of bytes the Citrix ADC sends to the client after compressing the response from the server.

comptxbytesrate

Rate of bytes the Citrix ADC sends to the client after compressing the response from the server.

comptotalrxbytes

Number of bytes that can be compressed, which the Citrix ADC receives from the server. This gives the content length of the response that the Citrix ADC receives from server.

comprxbytesrate

Rate of bytes that can be compressed, which the Citrix ADC receives from the server. This gives the content length of the response that the Citrix ADC receives from server.

delcomptcprxbytes

Total number of delta-compressible bytes received by Citrix ADC.

delcomptcprxbytesrate

Rate of delta-compressible bytes received by Citrix ADC.

delcomptcptxbytes

Total number of delta-compressed bytes transmitted by Citrix ADC.

delcomptcptxbytesrate

Rate of delta-compressed bytes transmitted by Citrix ADC.

See Also