Product Documentation

protocolip

Sep 08, 2016

Statistics for protocolip resource.

Properties (click to see Operations)

Name Data Type Permissions Description
clearstats
<String>
Read-write
Clear the statsistics / counters.
Possible values = basic, full
iptotrxpkts
<Double>
Read-only
IP packets received.
iprxpktsrate
<Double>
Read-only
Rate (/s) counter for iptotrxpkts
iptotrxbytes
<Double>
Read-only
Bytes of IP data received.
iprxbytesrate
<Double>
Read-only
Rate (/s) counter for iptotrxbytes
iptottxpkts
<Double>
Read-only
IP packets transmitted.
iptxpktsrate
<Double>
Read-only
Rate (/s) counter for iptottxpkts
iptottxbytes
<Double>
Read-only
Bytes of IP data transmitted.
iptxbytesrate
<Double>
Read-only
Rate (/s) counter for iptottxbytes
iptotrxmbits
<Double>
Read-only
Megabits of IP data received.
iprxmbitsrate
<Double>
Read-only
Rate (/s) counter for iptotrxmbits
iptottxmbits
<Double>
Read-only
Megabits of IP data transmitted.
iptxmbitsrate
<Double>
Read-only
Rate (/s) counter for iptottxmbits
iptotroutedpkts
<Double>
Read-only
Total routed packets.
iproutedpktsrate
<Double>
Read-only
Rate (/s) counter for iptotroutedpkts
iptotroutedmbits
<Double>
Read-only
Total routed Mbits
iproutedmbitsrate
<Double>
Read-only
Rate (/s) counter for iptotroutedmbits
iptotfragments
<Double>
Read-only
IP fragments received.
iptotsuccreassembly
<Double>
Read-only
Fragmented IP packets successfully reassembled on the NetScaler.
iptotreassemblyattempt
<Double>
Read-only
IP packets that the NetScaler attempts to reassemble. If one of the fragments is missing, the whole packet is dropped.
iptotaddrlookup
<Double>
Read-only
IP address lookups performed by the NetScaler. When a packet is received on a non-established session, the NetScaler checks if the destination IP address is one of the NetScaler owned IP addresses.
iptotaddrlookupfail
<Double>
Read-only
IP address lookups performed by the NetScaler that have failed because the destination IP address of the packet does not match any of the NetScaler owned IP addresses.
iptotudpfragmentsfwd
<Double>
Read-only
UDP fragments forwarded to the client or the server.
iptottcpfragmentsfwd
<Double>
Read-only
TCP fragments forwarded to the client or the server.
iptotfragpktsgen
<Double>
Read-only
Fragmented packets created by the NetScaler.
iptotbadchecksums
<Double>
Read-only
Packets received with an IP checksum error.
iptotunsuccreassembly
<Double>
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
<Double>
Read-only
Packets received for which the reassembled data exceeds the Ethernet packet data length of 1500 bytes.
iptotzerofragmentlen
<Double>
Read-only
Packets received with a fragment length of 0 bytes.
iptotdupfragments
<Double>
Read-only
Duplicate IP fragments received. This can occur when the acknowledgement was not received within the expected time.
iptotoutoforderfrag
<Double>
Read-only
Fragments received that are out of order.
iptotunknowndstrcvd
<Double>
Read-only
Packets received in which the destination IP address was not reachable or not owned by the NetScaler.
iptotbadtransport
<Double>
Read-only
Packets received in which the protocol specified in the IP header is unknown to the NetScaler.
iptotvipdown
<Double>
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
<Double>
Read-only
Packets received that contain an error in one or more components of the IP header.
iptotttlexpired
<Double>
Read-only
Packets for which the time-to-live (TTL) expired during transit. These packets are dropped.
iptotmaxclients
<Double>
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
<Double>
Read-only
Packets received on a port or service that is not configured.
iptotlandattacks
<Double>
Read-only
Land-attack packets received. The source and destination addresses are the same.
iptotinvalidheadersz
<Double>
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
<Double>
Read-only
Total number of packets received by NetScaler with invalid IP packet size.
iptottruncatedpackets
<Double>
Read-only
Truncated IP packets received. An overflow in the routers along the path can truncate IP packets.
noniptottruncatedpackets
<Double>
Read-only
Truncated non-IP packets received.
iptotzeronexthop
<Double>
Read-only
Packets received that contain a 0 value in the next hop field. These packets are dropped.
iptotbadlens
<Double>
Read-only
Packets received with a length greater than the normal maximum transmission unit of 1514 bytes.
iptotbadmacaddrs
<Double>
Read-only
IP packets transmitted with a bad MAC address.

Operations (click to see Properties)

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>

메모

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.

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 Headers:

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>
}]}