ADC NITRO APIs
Interface
Statistics for interface resource.
Properties
(click to see Operations )
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| id | <String> | Read-write | Interface number, in C/U format, where C can take one of the following values:
* 0 - Indicates a management interface. * 1 - Indicates a 1 Gbps port. * 10 - Indicates a 10 Gbps port. * LA - Indicates a link aggregation port. * LO - Indicates a loop back port. U is a unique integer for representing an interface in a particular port group. |
| clearstats | <String> | Read-write | Clear the statsistics / counters.
Possible values = basic, full |
| curintfstate | <String> | Read-only | Current state of the specified interface. The interface state set to UP only if the link state is UP and administrative state is ENABLED . |
| curlinkuptime | <String> | Read-only | Duration for which the link is UP. This statistic is reset when the state changes to DOWN. |
| curlinkdowntime | <String> | Read-only | Duration for which the link is DOWN. This statistic is reset when the state changes to UP. |
| totrxbytes | <Double> | Read-only | Number of bytes received by an interface since the Citrix ADC was started or the interface statistics were cleared. |
| rxbytesrate | <Double> | Read-only | Rate (/s) counter for totrxbytes |
| tottxbytes | <Double> | Read-only | Number of bytes transmitted by an interface since the Citrix ADC was started or the interface statistics were cleared. |
| txbytesrate | <Double> | Read-only | Rate (/s) counter for tottxbytes |
| totrxpkts | <Double> | Read-only | Number of packets received by an interface since the Citrix ADC was started or the interface statistics were cleared. |
| rxpktsrate | <Double> | Read-only | Rate (/s) counter for totrxpkts |
| tottxpkts | <Double> | Read-only | Number of packets transmitted by an interface since the Citrix ADC was started or the interface statistics were cleared. |
| txpktsrate | <Double> | Read-only | Rate (/s) counter for tottxpkts |
| jumbopktsreceived | <Double> | Read-only | Number of Jumbo Packets received on this interface. |
| jumbopktsreceivedrate | <Double> | Read-only | Rate (/s) counter for jumbopktsreceived |
| jumbopktstransmitted | <Double> | Read-only | Number of Jumbo packets transmitted on this interface by upper layer, with TSO enabled actual trasmission size could be non Jumbo. |
| jumbopktstransmittedrate | <Double> | Read-only | Rate (/s) counter for jumbopktstransmitted |
| trunkpktsreceived | <Double> | Read-only | Number of Tagged Packets received on this Trunk interface through Allowed VLan List. |
| trunkpktsreceivedrate | <Double> | Read-only | Rate (/s) counter for trunkpktsreceived |
| trunkpktstransmitted | <Double> | Read-only | Number of Tagged Packets transmitted on this Trunk interface through Allowed VLan List. |
| trunkpktstransmittedrate | <Double> | Read-only | Rate (/s) counter for trunkpktstransmitted |
| nictotmulticastpkts | <Double> | Read-only | Number of multicast packets received by the specified interface since the Citrix ADC was started or the interface statistics were cleared. |
| nicmulticastpktsrate | <Double> | Read-only | Rate (/s) counter for nictotmulticastpkts |
| totnetscalerpkts | <Double> | Read-only | Number of packets, destined to the Citrix ADC, received by an interface since the Citrix ADC was started or the interface statistics were cleared. The packets destined to Citrix ADC are those that have the same MAC address as that of an interface or a VMAC address owned by the Citrix ADC. |
| netscalerpktsrate | <Double> | Read-only | Rate (/s) counter for totnetscalerpkts |
| rxlacpdu | <Double> | Read-only | Number of Link Aggregation Control Protocol Data Units(LACPDUs) received by the specified interface since the Citrix ADC was started or the interface statistics were cleared. |
| rxlacpdurate | <Double> | Read-only | Rate (/s) counter for rxlacpdu |
| txlacpdu | <Double> | Read-only | Number of Link Aggregation Control Protocol Data Units(LACPDUs) transmitted by the specified interface since the Citrix ADC was started or the interface statistics were cleared. |
| txlacpdurate | <Double> | Read-only | Rate (/s) counter for txlacpdu |
| errpktrx | <Double> | Read-only | Number of inbound packets dropped by the hardware on a specified interface once the Citrix ADC starts or the interface statistics are cleared. This happens due to following reasons: 1) The hardware receives packets at a rate higher rate than that at which the software is processing packets. In this case, the hardware FIFO overruns and starts dropping the packets . 2) The specified interface fails to receive inbound packets from the appliance because of insufficient memory. 3) The specified interface receives packets with CRC errors (Alignment or Frame Check Sequence). 4) The specified interface receives overly long packets. 5) The specified interface receives packets with alignment errors. 6) The software does less buffering because it is running out of available memory. When hardware detects that there is no space into which to push newly arrived packets, it starts dropping them. 7) The specified interface receives packets with Frame Check Sequence (FCS) errors. 8) The specified interface receives packets smaller than 64 bytes. 9) The specified interface discards error-free inbound packets because of insufficient resources. For example: NIC buffers. 10) Packets are missed because of collision detection, link lost, physical decoding error, or MAC abort. |
| errpktrxrate | <Double> | Read-only | Rate (/s) counter for errpktrx |
| errpkttx | <Double> | Read-only | Number of outbound packets dropped by the hardware on a specified interface since the Citrix ADC was started or the interface statistics were cleared. This could happen due to length (undersize or oversize) errors and lack of resources. This statistic is available only for: (1) Loop back interface (LO) of all platforms. (2) All data ports on the Citrix ADC 12000 platform. (3) Management ports on the MPX 15000 and 17000 platforms. |
| errpkttxrate | <Double> | Read-only | Rate (/s) counter for errpkttx |
| errifindiscards | <Double> | Read-only | Number of error-free inbound packets discarded by the specified interface due to a lack of resources, for example, insufficient receive buffers. |
| errifindiscardsrate | <Double> | Read-only | Rate (/s) counter for errifindiscards |
| nicerrifoutdiscards | <Double> | Read-only | Number of error-free outbound packets discarded by the specified interface due to a lack of resources. This statistic is not available on: (1) 10G ports of Citrix ADC MPX 12500/12500/15500-10G platforms. (2) 10G data ports on Citrix ADC MPX 17500/19500/21500 platforms. |
| nicerrifoutdiscardsrate | <Double> | Read-only | Rate (/s) counter for nicerrifoutdiscards |
| errdroppedrxpkts | <Double> | Read-only | Number of inbound packets dropped by the specified interface. Commonly dropped packets are multicast frames, spanning tree BPDUs, packets destined to a MAC not owned by the Citrix ADC when L2 mode is disabled, or packets tagged for a VLAN that is not bound to the interface. This statistic will increment in most healthy networks at a steady rate regardless of traffic load. If a sharp spike in dropped packets occurs, it generally indicates an issue with connected L2 switches, such as a forwarding database overflow resulting in packets being broadcast on all ports. |
| errdroppedrxpktsrate | <Double> | Read-only | Rate (/s) counter for errdroppedrxpkts |
| errdroppedtxpkts | <Double> | Read-only | Number of packets dropped in transmission by the specified interface due to one of the following reasons. (1) VLAN mismatch. (2) Oversized packets. (3) Interface congestion. (4) Loopback packets sent on non loop back interface. |
| errdroppedtxpktsrate | <Double> | Read-only | Rate (/s) counter for errdroppedtxpkts |
| errlinkhangs | <Double> | Read-only | Number of times the specified interface detected hangs in the transmit and receive paths since the Citrix ADC was started or the interface statistics were cleared. |
| nicstsstalls | <Double> | Read-only | Number of times the status updates for a specified interface were stalled since the Citrix ADC was started or the interface statistics were cleared. A status stall is detected when the status of the interface is not updated by the NIC hardware within 0.8 seconds of the last update. |
| nictxstalls | <Double> | Read-only | Number of times the interface stalled, when transmitting packets, since the Citrix ADC was started or the interface statistics were cleared. Transmit (Tx) stalls are detected when a packet posted for transmission is not transmitted in 4 seconds. |
| nicrxstalls | <Double> | Read-only | Number of times the interface stalled, when receiving packets, since the Citrix ADC was started or the interface statistics were cleared. Receive (Rx) stalls are detected when the following conditions are met: (1)The link is up for more than 10 minutes. (2)Packets are transmitted, but no packets is received for 16 seconds. |
| nicerrdisables | <Double> | Read-only | Number of times the specified interface is disabled by the Citrix ADC, due to continuous Receive (Rx) or Transmit (Tx) stalls, since the Citrix ADC was started or the interface statistics were cleared. The Citrix ADC disables an interface when one of the following conditions is met: (1) Three consecutive transmit stalls occurs with at most gap of 10 seconds between any two stalls. (2) Three consecutive receive stalls occurs with at most gap of 120 seconds between any two stalls. |
| linkreinits | <Double> | Read-only | Number of times the link has been re-initialized. A re-initialization occurs due to link state change, configuration parameter change, or administrative reset operation. |
| totmacmoved | <Double> | Read-only | Number of MAC moves between ports. If a high rate of MAC moves is observed, it is likely that there is a bridge loop between two interfaces. |
| macmovedrate | <Double> | Read-only | Rate (/s) counter for totmacmoved |
| errnicmuted | <Double> | Read-only | Number of times the specified interface stopped transmitting and receiving packets due to MAC moves between ports. |
| rxcrcerrors | <Double> | Read-only | Number of packets received with the wrong checksum by the specified interface since the Citrix ADC was started or the interface statistics were cleared. This indicates the number of Jabber frames received instead of CRC errors on the 10G data ports of Citrix ADC 12000-10G platform and the data ports of Citrix ADC MPX 15000 and 17000 platforms. |
| rxcrcerrorsrate | <Double> | Read-only | Rate (/s) counter for rxcrcerrors |
| interfacealias | <String> | Read-only | Alias Name for the Interface |
| curlinkstate | <String> | Read-only | The current state of the link associated with the interface. For logical interfaces (LA), the state of the link is dependent on the state of the slave interfaces. For the link to be UP at least one of the slave interfaces needs to be UP. |
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/Interface
Query-parameters:
args
http:// <netscaler-ip-address> /nitro/v1/stat/Interface? args=id: <String_value> ,detail: <Boolean_value> ,fullvalues: <Boolean_value> ,ntimes: <Double_value> ,logfile: <String_value> ,clearstats: <String_value>
Use this query-parameter to get Interface 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:
{ "Interface": [ {
"id":<String_value>,
"netscalerpktsrate":<Double_value>,
"tottxpkts":<Double_value>,
"macmovedrate":<Double_value>,
"errpktrx":<Double_value>,
"curlinkdowntime":<String_value>,
"rxcrcerrorsrate":<Double_value>,
"nicmulticastpktsrate":<Double_value>,
"curlinkuptime":<String_value>,
"errdroppedtxpktsrate":<Double_value>,
"errpkttxrate":<Double_value>,
"rxlacpdurate":<Double_value>,
"linkreinits":<Double_value>,
"nicerrdisables":<Double_value>,
"txpktsrate":<Double_value>,
"txlacpdu":<Double_value>,
"errnicmuted":<Double_value>,
"trunkpktsreceivedrate":<Double_value>,
"curlinkstate":<String_value>,
"rxcrcerrors":<Double_value>,
"errifindiscards":<Double_value>,
"rxpktsrate":<Double_value>,
"jumbopktstransmittedrate":<Double_value>,
"errpktrxrate":<Double_value>,
"errlinkhangs":<Double_value>,
"nicstsstalls":<Double_value>,
"trunkpktsreceived":<Double_value>,
"errpkttx":<Double_value>,
"nicrxstalls":<Double_value>,
"nictotmulticastpkts":<Double_value>,
"jumbopktstransmitted":<Double_value>,
"txbytesrate":<Double_value>,
"rxlacpdu":<Double_value>,
"curintfstate":<String_value>,
"rxbytesrate":<Double_value>,
"tottxbytes":<Double_value>,
"nictxstalls":<Double_value>,
"totnetscalerpkts":<Double_value>,
"trunkpktstransmittedrate":<Double_value>,
"jumbopktsreceivedrate":<Double_value>,
"totrxbytes":<Double_value>,
"trunkpktstransmitted":<Double_value>,
"jumbopktsreceived":<Double_value>,
"errdroppedrxpktsrate":<Double_value>,
"errdroppedtxpkts":<Double_value>,
"nicerrifoutdiscardsrate":<Double_value>,
"errifindiscardsrate":<Double_value>,
"nicerrifoutdiscards":<Double_value>,
"interfacealias":<String_value>,
"totrxpkts":<Double_value>,
"totmacmoved":<Double_value>,
"errdroppedrxpkts":<Double_value>,
"txlacpdurate":<Double_value>
}]}
<!--NeedCopy-->
get
URL: http:// <netscaler-ip-address> /nitro/v1/stat/Interface/ id_value><String>
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:
{ "Interface": [ {
"id":<String_value>,
"netscalerpktsrate":<Double_value>,
"tottxpkts":<Double_value>,
"macmovedrate":<Double_value>,
"errpktrx":<Double_value>,
"curlinkdowntime":<String_value>,
"rxcrcerrorsrate":<Double_value>,
"nicmulticastpktsrate":<Double_value>,
"curlinkuptime":<String_value>,
"errdroppedtxpktsrate":<Double_value>,
"errpkttxrate":<Double_value>,
"rxlacpdurate":<Double_value>,
"linkreinits":<Double_value>,
"nicerrdisables":<Double_value>,
"txpktsrate":<Double_value>,
"txlacpdu":<Double_value>,
"errnicmuted":<Double_value>,
"trunkpktsreceivedrate":<Double_value>,
"curlinkstate":<String_value>,
"rxcrcerrors":<Double_value>,
"errifindiscards":<Double_value>,
"rxpktsrate":<Double_value>,
"jumbopktstransmittedrate":<Double_value>,
"errpktrxrate":<Double_value>,
"errlinkhangs":<Double_value>,
"nicstsstalls":<Double_value>,
"trunkpktsreceived":<Double_value>,
"errpkttx":<Double_value>,
"nicrxstalls":<Double_value>,
"nictotmulticastpkts":<Double_value>,
"jumbopktstransmitted":<Double_value>,
"txbytesrate":<Double_value>,
"rxlacpdu":<Double_value>,
"curintfstate":<String_value>,
"rxbytesrate":<Double_value>,
"tottxbytes":<Double_value>,
"nictxstalls":<Double_value>,
"totnetscalerpkts":<Double_value>,
"trunkpktstransmittedrate":<Double_value>,
"jumbopktsreceivedrate":<Double_value>,
"totrxbytes":<Double_value>,
"trunkpktstransmitted":<Double_value>,
"jumbopktsreceived":<Double_value>,
"errdroppedrxpktsrate":<Double_value>,
"errdroppedtxpkts":<Double_value>,
"nicerrifoutdiscardsrate":<Double_value>,
"errifindiscardsrate":<Double_value>,
"nicerrifoutdiscards":<Double_value>,
"interfacealias":<String_value>,
"totrxpkts":<Double_value>,
"totmacmoved":<Double_value>,
"errdroppedrxpkts":<Double_value>,
"txlacpdurate":<Double_value>
}]}
<!--NeedCopy-->
Interface
In this article
Copied!
Failed!