protocolip
Statistics for protocolip resource.
Properties
(click to see Operations )
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| clearstats |
|
Read-write | Clear the statsistics / counters.
Possible values = basic, full |
| iptotrxpkts |
|
Read-only | IP packets received. |
| iprxpktsrate |
|
Read-only | Rate (/s) counter for iptotrxpkts |
| iptotrxbytes |
|
Read-only | Bytes of IP data received. |
| iprxbytesrate |
|
Read-only | Rate (/s) counter for iptotrxbytes |
| iptottxpkts |
|
Read-only | IP packets transmitted. |
| iptxpktsrate |
|
Read-only | Rate (/s) counter for iptottxpkts |
| iptottxbytes |
|
Read-only | Bytes of IP data transmitted. |
| iptxbytesrate |
|
Read-only | Rate (/s) counter for iptottxbytes |
| iptotrxmbits |
|
Read-only | Megabits of IP data received. |
| iprxmbitsrate |
|
Read-only | Rate (/s) counter for iptotrxmbits |
| iptottxmbits |
|
Read-only | Megabits of IP data transmitted. |
| iptxmbitsrate |
|
Read-only | Rate (/s) counter for iptottxmbits |
| iptotroutedpkts |
|
Read-only | Total routed packets. |
| iproutedpktsrate |
|
Read-only | Rate (/s) counter for iptotroutedpkts |
| iptotroutedmbits |
|
Read-only | Total routed Mbits |
| iproutedmbitsrate |
|
Read-only | Rate (/s) counter for iptotroutedmbits |
| iptotfragments |
|
Read-only | IP fragments received. |
| iptotsuccreassembly |
|
Read-only | Fragmented IP packets successfully reassembled on the Citrix ADC. |
| iptotreassemblyattempt |
|
Read-only | IP packets that the Citrix ADC attempts to reassemble. If one of the fragments is missing, the whole packet is dropped. |
| iptotaddrlookup |
|
Read-only | IP address lookups performed by the Citrix ADC. When a packet is received on a non-established session, the Citrix ADC checks if the destination IP address is one of the Citrix ADC owned IP addresses. |
| iptotaddrlookupfail |
|
Read-only | IP address lookups performed by the Citrix ADC that have failed because the destination IP address of the packet does not match any of the Citrix ADC owned IP addresses. |
| iptotudpfragmentsfwd |
|
Read-only | UDP fragments forwarded to the client or the server. |
| iptottcpfragmentsfwd |
|
Read-only | TCP fragments forwarded to the client or the server. |
| iptotfragpktsgen |
|
Read-only | Fragmented packets created by the Citrix ADC. |
| iptotbadchecksums |
|
Read-only | Packets received with an IP checksum error. |
| iptotunsuccreassembly |
|
Read-only | Packets received that could not be reassembled. This can occur when there is a checksum failure, an identification field mismatch, or when one of the fragments is missing. |
| iptottoobig |
|
Read-only | Packets received for which the reassembled data exceeds the Ethernet packet data length of 1500 bytes. |
| iptotzerofragmentlen |
|
Read-only | Packets received with a fragment length of 0 bytes. |
| iptotdupfragments |
|
Read-only | Duplicate IP fragments received. This can occur when the acknowledgement was not received within the expected time. |
| iptotoutoforderfrag |
|
Read-only | Fragments received that are out of order. |
| iptotunknowndstrcvd |
|
Read-only | Packets received in which the destination IP address was not reachable or not owned by the Citrix ADC. |
| iptotbadtransport |
|
Read-only | Packets received in which the protocol specified in the IP header is unknown to the Citrix ADC. |
| iptotvipdown |
|
Read-only | Packets received for which the VIP is down. This can occur when all the services bound to the VIP are down or the VIP is manually disabled. |
| iptotfixheaderfail |
|
Read-only | Packets received that contain an error in one or more components of the IP header. |
| iptotttlexpired |
|
Read-only | Packets for which the time-to-live (TTL) expired during transit. These packets are dropped. |
| iptotmaxclients |
|
Read-only | Attempts to open a new connection to a service for which the maximum limit has been exceeded. Default value, 0, applies no limit. |
| iptotunknownsvcs |
|
Read-only | Packets received on a port or service that is not configured. |
| iptotlandattacks |
|
Read-only | Land-attack packets received. The source and destination addresses are the same. |
| iptotinvalidheadersz |
|
Read-only | Packets received in which an invalid data length is specified, or the value in the length field and the actual data length do not match. The range for the Ethernet packet data length is 0-1500 bytes. |
| iptotinvalidpacketsize |
|
Read-only | Total number of packets received by Citrix ADC with invalid IP packet size. |
| iptottruncatedpackets |
|
Read-only | Truncated IP packets received. An overflow in the routers along the path can truncate IP packets. |
| noniptottruncatedpackets |
|
Read-only | Truncated non-IP packets received. |
| iptotzeronexthop |
|
Read-only | Packets received that contain a 0 value in the next hop field. These packets are dropped. |
| iptotbadlens |
|
Read-only | Packets received with a length greater than the normal maximum transmission unit of 1514 bytes. |
| iptotbadmacaddrs |
|
Read-only | IP packets transmitted with a bad MAC address. |
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
red
and placeholder content is marked in
green
get (all)
URL: http:// <netscaler-ip-address> /nitro/v1/stat/protocolip Query-parameters: args http:// <netscaler-ip-address> /nitro/v1/stat/protocolip? args=detail: <Boolean_value> ,fullvalues: <Boolean_value> ,ntimes: <Double_value> ,logfile: <String_value> ,clearstats: <String_value>
Use this query-parameter to get protocolip resources based on additional properties.
attrs http:// <netscaler-ip-address> /nitro/v1/stat/protocolip? attrs=property-name1,property-name2
Use this query parameter to specify the resource details that you want to retrieve.
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:
{ "protocolip": [ {
"iproutedpktsrate":<Double_value>,
"iptotoutoforderfrag":<Double_value>,
"noniptottruncatedpackets":<Double_value>,
"iptotmaxclients":<Double_value>,
"iptotzerofragmentlen":<Double_value>,
"iptxbytesrate":<Double_value>,
"iptotvipdown":<Double_value>,
"iptotroutedpkts":<Double_value>,
"iprxmbitsrate":<Double_value>,
"iprxpktsrate":<Double_value>,
"iptxmbitsrate":<Double_value>,
"iptotroutedmbits":<Double_value>,
"iptotinvalidheadersz":<Double_value>,
"iptotaddrlookupfail":<Double_value>,
"iptotbadtransport":<Double_value>,
"iptotfragpktsgen":<Double_value>,
"iptotsuccreassembly":<Double_value>,
"iptotrxmbits":<Double_value>,
"iptottxbytes":<Double_value>,
"iptotbadmacaddrs":<Double_value>,
"iptottcpfragmentsfwd":<Double_value>,
"iptotrxpkts":<Double_value>,
"iptotrxbytes":<Double_value>,
"iptotlandattacks":<Double_value>,
"iptotunknowndstrcvd":<Double_value>,
"iptottruncatedpackets":<Double_value>,
"iptotttlexpired":<Double_value>,
"iprxbytesrate":<Double_value>,
"iptottxmbits":<Double_value>,
"iptotbadlens":<Double_value>,
"iptotunknownsvcs":<Double_value>,
"iptotdupfragments":<Double_value>,
"iptottoobig":<Double_value>,
"iptotzeronexthop":<Double_value>,
"iptotaddrlookup":<Double_value>,
"iptotfragments":<Double_value>,
"iptotinvalidpacketsize":<Double_value>,
"iptotunsuccreassembly":<Double_value>,
"iptotreassemblyattempt":<Double_value>,
"iptottxpkts":<Double_value>,
"iptxpktsrate":<Double_value>,
"iptotbadchecksums":<Double_value>,
"iptotfixheaderfail":<Double_value>,
"iproutedmbitsrate":<Double_value>,
"iptotudpfragmentsfwd":<Double_value>
}]}
<!--NeedCopy-->