Descriptions of built-in metrics

Built-In Metrics : Descriptions of built-in metrics

The following tables list the built-in metrics that NetIM can poll, organized by group and metric class. Additional metric classes can be defined by the user. For more information, see Defining a metric class using the User-Defined Metrics wizard. For details about user-defined classes, contact the NetIM administrator.

For each metric, the tables list the following information:

• Metric name

• Description

• Units (if any)

• Alertable (whether the metric can be used to trigger alerts)

See Retention schemes to understand how metrics data are consolidated for each metric class.

CPU utilization

This metric class contains metrics about a device’s CPU.

Device availability

This metric class provides availability for a device. Computed based on Device status metrics.

Metric Name	Description	Alertable
timestamp	Time in milliseconds of metric data retrieval.	No
duration	Time difference in milliseconds between successive metric data retrievals.	No
Device Availability	The percentage of time that a device is up.	Yes

Device fan status

This metric class contains metrics providing fan status information for a device.

Metric Name	Description	Units	Alertable
timestamp	Time of metric data retrieval.	milliseconds	No
duration	Time difference between successive metric data retrievals.	milliseconds	No
Fan Index	Unique index for the fan.	—	No
Fan Description	Description of the fan.	—	No
Fan State	The current state of the fan.	—	Yes

Device power status

This metric class contains metrics providing power supply status information for a device.

Metric Name	Description	Units	Alertable
timestamp	Time of metric data retrieval.	milliseconds	No
duration	Time difference between successive metric data retrievals.	milliseconds	No
Power Index	Unique index for the power supply.	—	No
Power Description	Description of the power supply.	—	No
Power Source	The power supply source.	—	No
Power State	The current state of the power supply.	—	Yes
Power State Detail	Additional details of the power supply state.	—	No

Device statistics

This metric class contains metrics providing system-level information for a device.

Metric Name	Description	Units	Alertable
timestamp	Time of metric data retrieval.	milliseconds	No
System Uptime	Time since the network management portion of the system was last initialized.	centiseconds	Yes
System Reboot Detected	Number of times the system was rebooted.	—	Yes

Device status

This metric class contains metrics providing status information for a device, and is used to compute Device availability.

Metric Name	Description	Units	Alertable
timestamp	Time of metric data retrieval.	milliseconds	No
Device Status	The status of a device—up (1) or down (0).	0 or 1	Yes
Device SNMP Status	The device responds to SNMP—up (1) or down (0).	0 or 1	Yes
Device Ping Status	The device responds to a ping test—up (1) or down (0).	0 or 1	Yes
Ping Round-Trip Time	The average send and response time of one or more pings.	milliseconds	Yes

Device temperature status

This metric class contains metrics providing temperature status information for a device.

Metric Name	Description	Units	Alertable
timestamp	Time of metric data retrieval.	milliseconds	No
Temperature Sensor Index	Unique index for the temperature testpoint.	—	No
Temperature Sensor Description	Description of the testpoint being instrumented.	—	No
Temperature Value	The current measurement of the testpoint being instrumented.	degrees Celsius	Yes
Temperature Threshold	The highest value before an emergency shutdown of the managed device.	degrees Celsius	No
Temperature of Last Shutdown	The temperature value of last emergency shutdown.	degrees Celsius	No
State	The current state of the testpoint being instrumented.	—	Yes

Entity sensor status

This metric class contains metrics providing status information of monitored sensor entities.

Metric Name	Description	Units	Alertable
Sensor Entity Index	The physical entity index for this sensor.	—	No
Sensor Entity Name	The sensor physical entity name.	—	No
Sensor Type	The type of data returned by the sensor.	—	No
Sensor Scale	The exponent to apply to values returned by the associated.	—	No
Sensor Precision	The number of decimal places of precision for sensor values.	—	No
Sensor Value	The most recent sensor measurement.	—	No
Operational Status	The operational status of the sensor.	—	Yes
Units Display	Description of the data units for the sensor value.	—	No
Value Timestamp	The value of UTC Time at the time the status and/or value was obtained.	milliseconds	No
Update Rate	The frequency that the sensor value is updated.	milliseconds	No
Threshold Violation Severity		—	Yes

Host disk usage

This metric class contains metrics for the amount of disk space used on a host.

Metric name	Description	Units	Alertable
timestamp	Time of metric data retrieval.	milliseconds	No
Index	Unique value for each logical storage area contained by the host.	—	No
Disk Type	Type of storage represented by this entry.	—	No
Description	Description of the type and instance of storage described by this entry.	—	No
Allocation Units	Size of the data objects allocated from this pool. For example, if this entry is monitoring sectors, blocks, buffers, or packets, this number will commonly be greater than 1. Otherwise, this number will typically be 1.	bytes	No
Size	Size of the storage represented by this entry.	allocation units	No
Used	The amount of storage units on the device that are currently allocated.	allocation units	Yes
Disk Utilization	Percentage of disk space used. Calculated as (Disk Used / Disk Size) * 100.	%	Yes
Disk Allocation Failures	Number of disk allocation failures on this device.	number	Yes
Disk Read Time (WMI Only)	Percentage of elapsed time that the selected disk drive was busy servicing read requests.	%	Yes
Disk Write Time (WMI Only)	Percentage of elapsed time that the selected disk drive was busy servicing write requests.	%	Yes
Disk Time (WMI Only)	Percentage of elapsed time that the selected disk drive was busy servicing read or write requests.	%	Yes
Current Disk Queue Length (WMI Only)	Number of requests outstanding on the disk at the time the performance data is collected.	—	Yes
Disk Read Bytes/sec (WMI Only)	Rate of transfer of bytes from the disk during read operations.	bytes/second	Yes
Disk Write Bytes/sec (WMI Only)	Rate of transfer of bytes to the disk during write operations.	bytes/second	Yes
Disk Bytes/sec (WMI Only)	Rate of transfer of bytes to and from the disk during read or write operations.	bytes/second	Yes
Disk Reads/sec (WMI Only)	Rate of read operations on the disk.	count/sec	Yes
Disk Writes/sec (WMI Only)	Rate of write operations on the disk.	count/sec	Yes
Disk Transfers/sec (WMI Only)	Rate of read and write operations on the disk.	count/sec	Yes
Average Disk Read Queue Length (WMI Only)	Average number of read requests that were queued for the selected disk during the sample interval.	—	Yes
Average Disk Write Queue Length (WMI Only)	Average number of write requests that were queued for the selected disk during the sample interval.	—	Yes
Average Disk Queue Length (WMI Only)	Average number of both read and write requests that were queued for the selected disk during the sample interval.	—	Yes

Host software performance and status

This metric class contains metrics providing performance and descriptions of software running on a host.

Metric name	Description	Units	Alertable
timestamp	Time of metric data retrieval.	milliseconds	No
Software Run Index	Unique value for each piece of software running on the host.	—	No
duration	Time difference between successive metric data retrievals.	milliseconds	No
Software Running Name	Description of this software, including the manufacturer, revision, and name by which it is commonly known.	—	No
Software Load Path	Location on long-term storage (such as a disk drive) from which this software was loaded.	—	No
Software Type	Type of this software.	—	No
Software Status	Status of this software.	—	Yes
Software CPU Consumption	Total system’s CPU resources consumed by this process.	centiseconds	Yes
Software CPU Consumption Percentage	Percentage of the total system’s CPU resources consumed by this process.	%	Yes
Software Memory Allocation	Total amount of real system memory allocated for this process.	kilobytes	Yes
User Time (WMI only)	Percentage of elapsed time that this process's threads have spent executing code in user mode.	%	Yes
IO Data Bytes/Sec (WMI only)	Rate at which the process is reading and writing bytes in I/O operations.	bytes/sec	Yes
IO Read Bytes/Sec (WMI only)	Rate at which the process is reading bytes from I/O operations.	bytes/sec	Yes
IO Write Bytes/Sec (WMI only)	Rate at which the process is writing bytes to I/O operations.	bytes/sec	Yes
Thread Count (WMI only)	Number of threads currently active in this process.	count	Yes
Handle Count (WMI only)	Total number of handles that the process has open.	count	Yes

Host system statistics

This metric class contains metrics providing statistical information about a host.

Metric name	Description	Units	Alertable
timestamp	Time of metric data retrieval.	milliseconds	No
Host Uptime	Amount of time since this host was last initialized. Note that this is different from sysUpTime in the SNMPv2-MIB [RFC1907] because sysUpTime is the uptime of the network management portion of the system.	seconds	Yes
Users in System	Number of user sessions for which this host is storing state information. A session is a collection of processes requiring a single act of user authentication and possibly subject to collective job control.	users	Yes
System Processes	Number of process contexts currently loaded or running on this system.	processes	Yes
System Max Processes	Maximum number of process contexts this system can support. If there is no fixed maximum, the value should be zero. On systems that have a fixed maximum, this object can help diagnose failures that occur when this maximum is reached.	processes	Yes

Memory usage

This metric class contains metrics that describe a device’s memory utilization.

Metric name	Description	Units	Alertable
timestamp	Time of metric data retrieval.	milliseconds	No
Memory Type	Type of memory represented by this entry.	“Physical/ Processor Memory” or “IO”	bi
Memory Size	Size of the storage represented by this entry.	kilobytes	No
Memory Used	Amount of allocated storage represented by this entry.	kilobytes	Yes
Memory Utilization	Percentage of available memory that is being used. Calculated as (Memory Used / Memory Size) * 100	%	Yes
Memory Allocation Failures	Number of memory allocation failures on this device.	number	Yes
Committed Bytes in Use (WMI only)	Ratio of memory bytes committed to the memory commit limit.	%	Yes
Available Memory (WMI only)	Amount of physical memory in bytes available to processes running on the computer.	bytes	Yes
Pages/Sec (WMI only)	Number of pages read from or written to the disk to resolve hard page faults.	count/sec	Yes
Page Faults/Sec (WMI only)	Overall rate at which faulted pages are handled by the processor.	count/sec	Yes
Demand Zero Faults/Sec (WMI only)	Number of page faults that require a zeroed page to satisfy the fault.	count/sec	Yes
Pages Input/Sec (WMI only)	Number of pages read from disk to resolve hard page faults.	count/sec	Yes
Pages Output/Sec (WMI only)	Number of pages written to disk to free up space in physical memory.	count/sec	Yes
Nonpaged Pool (WMI only)	Number of bytes in the nonpaged pool, an area of system memory (physical memory used by the operating system) for objects that cannot be written to disk, but must remain in physical memory as long as they are allocated.	bytes	Yes

Module status

The metric class contains metrics providing module status information for a device.

Metric Name	Description	Units	Alertable
timestamp	Time of metric data retrieval.	milliseconds	No
Slot	Module Slot - metric index.	—	No
Level	Module Level - metric index.	—	No
Type	Type of module.	—	No
Name	Name of a module.	—	No
Description	Description of a module.	—	No
Module Admin Status	The admin status of a module.	—	Yes
Module Operational Status	The operational status of a module.	—	Yes
Last Change Time	The last sysUpTime the module was changed.	centiseconds (TimeTicks)	Yes
Module Status	The derived status of a module.	—	Yes

ATM PVC throughput

This metric class contains metrics for percentage of utilization and throughput of ATM VCs.

For data retention purposes, this metric class is part of the aggregate metric class Interface/Path/Application Utilization and Throughput. The classes in this aggregate are ATM PVC throughput, CoS-based interface throughput, and Interface utilization and throughput.

Metric name	Description	Units	Alertable
timestamp	Time of metric data retrieval.	milliseconds	No
duration	Time difference between successive metric data retrievals.	milliseconds	No
ATM PVC Incoming Bytes	Number of inbound octets.	bytes	Yes
ATM PVC Outgoing Bytes	Number of outbound octets.	bytes	Yes
ATM PVC Total Bytes	Sum of inbound and outbound octets.	bytes	Yes
ATM PVC Incoming Packets	Number of inbound packets.	packets	Yes
ATM PVC Outgoing Packets	Number of outbound packets.	packets	Yes
ATM PVC Total Packets	Sum of inbound and outbound packets.	packets	Yes
ATM PVC VCI	ATM PVC Virtual Channel Identifier.	—	No
ATM PVC VPI	ATM PVC Virtual Path Identifier.	—	No
Class Name	Queue name.	—	No
ATM PVC Incoming Utilization	Bandwidth utilization in, based on ifSpeed.	%	Yes
ATM PVC Outgoing Utilization	Bandwidth utilization out, based on ifSpeed.	%	Yes
ATM PVC Incoming Throughput	Throughput in, based on ifSpeed.	bits/second	Yes
ATM PVC Outgoing Throughput	Throughput out, based on ifSpeed.	bits/second	Yes

CoS-based discards

This metric class contains metrics that provide statistics on how packets were discarded across different classes of traffic based on rules/policies/profiles configured on a device.

Metric name	Description	Units	Alertable
timestamp	Time of metric data retrieval.	milliseconds	No
Class(es)	Class name for Cisco devices, Class Names associated to a queue for Juniper devices.	text	No
Direction	The direction of traffic flow.	—	No
duration	Difference in time between successive metric data retrievals.	milliseconds	No
Queue Number	Queue number of the queue associated with classes. N/A with Cisco devices.	number	No
Policy Based Discards (packets)	Policy based packet discards.	packets	Yes
Policy Based Packet Discard Rate	The policy based discard rate of packets.	%	Yes
Policy Based Discards (bytes)	Policy based byte discards.	bytes	Yes
Buffer Based Discards	Buffer based discards.	packets	Yes
Buffer Based Packet Discard Rate	The buffer based discard rate of packets.	%	Yes
Total Discards	Total number of packets discarded.	packets	Yes
Total Packet Discard Rate	Overall rate of packets discarded.	%	Yes

CoS-based interface throughput

This metric class contains metrics for percent utilization and throughput of CoS-based interfaces.

Metric name	Description	Units	Alertable
timestamp	Time of metric data retrieval.	milliseconds	No
Class name	Queue name.	—	No
duration	Time difference between successive metric data retrievals.	milliseconds	No
CoS Based Incoming Bytes	Number of inbound octets.	bytes	Yes
CoS Based Outgoing Bytes	Number of outbound octets.	bytes	Yes
CoS Based Total Bytes	Sum of inbound and outbound octets.	bytes	Yes
CoS Based Incoming Packets	Number of inbound packets.	packets	Yes
CoS Based Outgoing Packets	Number of outbound packets.	packets	Yes
CoS Based Total Packets	Sum of inbound and outbound packets.	packets	Yes
CoS Based Incoming Utilization	Bandwidth utilization in, based on ifSpeed.	%	Yes
CoS Based Outgoing Utilization	Bandwidth utilization out, based on ifSpeed.	%	Yes
CoS Based Incoming Throughput	Throughput in, based on ifSpeed.	bits/second	Yes
CoS Based Outgoing Throughput	Throughput out, based on ifSpeed.	bits/second	Yes

Ethernet statistics

This metric class provides information on the Ethernet status for a device.

Metric name	Description	Units	Alertable
Time Stamp	Time of metric data retrieval.	milliseconds	No
Duration	Time difference between successive metric data retrievals.	milliseconds	No
Duplex Status	Current operating Duplex status. Unknown—1 Half Duplex—2 Full Duplex—3	number	Yes
Ethernet Interface Speed	The speed of the interface.	number	No
Ethernet Incoming Packets	Total number of inbound Ethernet data packets.	packets	Yes
Ethernet Outgoing Packets	Total number of outbound Ethernet data packets.	packets	Yes
Frame Check Seq Errors	Total number of frame check sequence errors seen.	number	Yes
Frame Check Seq Error Rate	Percentage of frame check sequence errors in incoming packets.	%	Yes
Alignment Errors	Number of alignment errors seen on Ethernet frames.	number	Yes
Late Collisions	In the Ethernet collision domain, the collisions that occur after an endpoint has finished sending the packet.	number	Yes
Excessive Collisions	In the Ethernet collision domain, excessive collisions are recorded when attempts to send a packet have failed on 16 successive retries with random backoffs.	number	Yes
Single Collisions	Number of single collisions.	number	Yes
Multiple Collisions	Number of multiple collisions.	number	Yes
Multiple Collision Rate	The rate of multiple collisions.	number	Yes
Internal MAC Transmit Errors	Number of internal MAC transmit errors. MAC errors that are recorded in this category are implementation specific.	number	Yes
Internal MAC Receive Errors	Number of internal MAC receive errors. MAC errors that are recorded in this category are implementation specific.	number	Yes
Ethernet Frames Too Long	Number of Ethernet frames that were too long.	number	Yes
Carrier Sense Errors	Number of carrier sense errors.	number	Yes
Ethernet Interface Health	Layer 2 operational health. Normal—0 Notice—1 Warning—2 Error—3	number	Yes
Ethernet Interface Health Detail	Layer-2 operational health detail. This field is an integer representation of a combination of one or more of the following states. FCS Error Rate too high Late Collisions above zero Excessive Collisions above zero MAC Transmit Errors above zero MAC Receive Errors above zero Ethernet Frames are too long Carrier Sense Errors above zero FCS Error Rate is slightly high Duplex Status changed IFC Speed decreased Duplex Status improved IFC Speed increased	number	No

Interface availability

This metric class provides availability of interfaces. Computed based on Interface status metrics.

Metric name	Description	Units	Alertable
timestamp	Time of metric data retrieval.	milliseconds	No
duration	Time difference between successive metric data retrievals.	milliseconds	No
Interface Availability	The percent of time that an interface is up.	%	Yes

Interface errors and discards

This metric class contains metrics for the number of errors seen inbound or outbound on an interface.

Metric name	Description	Units	Alertable
timestamp	Time of metric data retrieval.	milliseconds	No
Interface Incoming Errors	Number of errors seen inbound to the interface.	packets	Yes
Interface Outgoing Errors	Number of errors seen outbound from the interface.	packets	Yes
Interface Incoming Packets	Number of inbound packets. Calculated as (ifHCInUcastPkts + ifHCInMulticastPkts + ifHCInBroadcastPkts) if those exist, otherwise (ifInUcastPkts + ifInNUcastPkts).	packets	Yes
Interface Outgoing Packets	Number of outbound packets. Calculated as (ifHCOutUcastPkts + ifHCOutMulticastPkts + ifHCOutBroadcastPkts) if those exist, otherwise (ifOutUcastPkts + ifOutNUcastPkts).	packets	Yes
Interface Incoming Discards	Number of discards inbound.	packets	Yes
Interface Outgoing Discards	Number of discards outbound.	packets	Yes
Incoming Unknown Protocols	Number of inbound packets of unknown protocol.	packets	Yes
Incoming Packet Error Rate	Rate of erroneous inbound packets. Calculated as (Interface Errors Incoming ÷ Interface Packets Incoming) × 100.	%	Yes
Outgoing Packet Error Rate	Rate of erroneous outbound packets. Calculated as (Interface Errors Outgoing ÷ Interface Packets Outgoing) × 100.	%	Yes
Incoming Discards Rate	Rate of inbound packet discards. Calculated as (Interface Packets Incoming Discards ÷ Interface Packets Incoming) × 100.	%	Yes
Outgoing Discards Rate	Rate of outbound packet discards. Calculated as (Interface Packets Outgoing Discards ÷ Interface Packets Outgoing) × 100.	%	Yes
duration	Time difference between successive metric data retrievals.	milliseconds	No

Interface status

This metric class contains metrics giving the up or down status of interfaces, and is used to compute Interface availability. To collect this metric class using WMI, you must provide WMI credentials with administrative privileges.

Metric name	Description	Units	Alertable
timestamp	Time of metric data retrieval.	milliseconds	No
Administrative Status	Administrative status (up, down, or testing).	—	Yes
Operational Status	Operational status (up, down, or testing).	—	Yes
Output Queue Length	Length of the output packet queue.	packets	Yes

The Interface Status metric class includes a derived metric called Interface Status. The Interface Status metric is derived from the SNMP OIDs Interface Administrative Status (ifAdminStatus) and Interface Operational Status (ifOperStatus). The purpose of the Interface Status metric is to simplify the 3 states of ifAdminStatus and 7 states of ifOperStatus into 3 simplified states of Up(1), Down(2), and AdminDown(3). The up/down status of the Interface Status metric is meant to indicate whether an interface is administratively configured to be up and is operationally able to pass packets. The Interface Status metric can be used for alerting and is calculated as shown in the following table:

Administrative status	Operational status	Interface status
Up(1)	Up(1)	AdminUp-OperUp(1)
Up(1)	Down(2) \| Testing(3) \| Unknown(4) \| Dormant(5) \| NotPresent(6) \| LowerLayerDown(7)	AdminUp-OperLogicallyDown(2)
Down(2)	Up(1)	AdminDown(3)
Down(2)	Down(2) \| Testing(3) \| Unknown(4) \| Dormant(5) \| NotPresent(6) \| LowerLayerDown(7)	AdminDown(3)
Testing(3)	Up(1)	AdminDown(3)
Testing(3)	Down(2) \| Testing(3) \| Unknown(4) \| Dormant(5) \| NotPresent(6) \| LowerLayerDown(7)	AdminDown(3)

The Interface status metric is one component of NetIM’s Interface Health calculation. Only interfaces that are administratively configured to be up participate in the interface health calculation. Further, only interfaces in the AdminUp-OperLogicallyDown(2) state are in an unhealthy state (Default Alert Major category) because they are configured to be up but are unable to pass packets.

Interface utilization and throughput

This metric class contains metrics for percent utilization and throughput of interfaces.

For data retention purposes, this metric class is part of the aggregate metric class named “Network Utilization.” The classes in this aggregate are ATM PVC throughput, CoS-based interface throughput, and Interface utilization and throughput.

Metric name	Description	Units	Alertable
timestamp	Time of metric data retrieval.	milliseconds	No
Class name	Queue name.	—	No
duration	Time difference between successive metric data retrievals.	milliseconds	No
Interface Incoming Bytes	Number of inbound octets.	bytes	Yes
Interface Outgoing Bytes	Number of outbound octets.	bytes	Yes
Interface Total Bytes	Sum of inbound and outbound octets.	bytes	Yes
Interface Incoming Packets	Number of inbound packets.	packets	Yes
Interface Outgoing Packets	Number of outbound packets.	packets	Yes
Interface Total Packets	Sum of inbound and outbound packets.	packets	Yes
Interface Incoming Utilization	Bandwidth utilization in, based on ifSpeed.	%	Yes
Interface Outgoing Utilization	Bandwidth utilization out, based on ifSpeed.	%	Yes
Interface Incoming Throughput	Throughput in, based on ifSpeed.	bits/second	Yes
Interface Outgoing Throughput	Throughput out, based on ifSpeed.	bits/second	Yes

Interface media calls

This metric class provides the number of ingress/egress media calls that traverse an interface.

This metric class is supported for all Cisco IOS devices, although not all devices will provide this information.

Metric Name	Description	Units	Alertable
timestamp	Time of metric data retrieval.	milliseconds	No
Interface Active Incoming Calls	Incoming active media calls on this interface.	counts	Yes
Interface Active Outgoing Calls	Outgoing active media calls on this interface.	counts	Yes

Juniper LSP throughput

This metric class contains metrics for percent utilization and throughput of Juniper LSPs.

Metric name	Description	Units	Alertable
timestamp	Time of metric data retrieval.	milliseconds	No
LSP Name	Name of the LSP.	—	No
LSP Source	IP address of the source.	—	No
LSP Destination	IP address of the destination.	—	No
Class Name	Queue name.	—	No
duration	Time difference between successive metric data retrievals.	milliseconds	No
LSP Incoming Bytes	Number of inbound octets.	bytes	Yes
LSP Outgoing Bytes	Number of outbound octets.	bytes	Yes
LSP Total Bytes	Sum of inbound and outbound octets.	bytes	Yes
LSP Incoming Packets	Number of inbound packets.	packets	No
LSP Outgoing Packets	Number of outbound packets.	packets	No
LSP Total Packets	Sum of inbound and outbound packets.	packets	No
LSP Incoming Utilization	Bandwidth utilization in based on path bandwidth. Calculated as (LSP Throughput Incoming ÷ path bandwidth) × 100.	%	No
LSP Outgoing Utilization	Bandwidth utilization out based on path bandwidth. Calculated as (LSP Throughput Outgoing ÷ path bandwidth) × 100.	%	No
LSP Incoming Throughput	Path throughput inbound. Calculated as the number of inbound bytes from one poll to the next divided by the duration of the poll: (((LSP Incoming Bytes [poll n] - LSP Incoming Bytes [poll n-1]) × 8) ÷ duration) × 1000.	bits/second	No
LSP Outgoing Throughput	Path throughput outbound. Calculated as the number of outbound bytes from one poll to the next divided by the duration of the poll: (((LSP Outgoing Bytes [poll n] - LSP Outgoing Bytes [poll n-1]) × 8) ÷ duration) × 1000.	bits/second	No

IP SLA latency

This metric class contains real-time performance monitoring data for latency.

Metric name	Description	Units	Alertable
timestamp	Time of metric data retrieval.	milliseconds	No
Test Index	Identifier for a test at the time it was run.	—	No
Test Name	String used by a managing application to identify the RTT target. This string is inserted into trap notifications, but has no other significance to the agent.	—	No
Test Type	Type of RTT operation to be performed. This value must be set in the same PDU or before setting any type-specific configuration.	—	No
Protocol	Protocol to be used to perform the RTT operation. The following list defines what protocol should be used for each probe type: echo, pathEcho - ipIcmpEcho udpEcho - ipUdpEchoAppl tcpConnect - ipTcpConn http - httpAppl jitter - jitterAppl dlsw - dlswAppl dhcp - dhcpAppl ftp - ftpAppl When this protocol does not support the type, a “badValue” error will be returned.	—	No
Protocol Version	The protocol version used to perform the RTT operation.	—	No
Target Address	IP address of the target.	—	No
Target Port	Target port number. This object is applicable to udpEcho, tcpConnect, and jitter probes.	—	No
Source Address	IP address of the source. This object is applicable to all probes except dns, dlsw, and sna.	—	No
Source Port	Source port number. If this object is not specified, the application will get a port allocated by the system. This object is applicable to all probes except dns, dlsw, and sna.	—	No
Type of Service	Representation of the type of service octet in an IP header. This object is not applicable to dhcp and dns.	—	No
Additional Key	Additional key required to identify the test. For example, DNS server name for DNS tests, and URL for HTTP tests.	—	No
duration	Time difference between successive metric data retrievals.	milliseconds	No
Timeout	Specifies the duration to wait for a RTT operation completion. The value of this object cannot be set to a value that would specify a duration exceeding rttMonCtrlAdminFrequency. For connection-oriented protocols, this might cause the connection to be closed by the probe. closed, it will be assumed that the connection reestablishment will be performed. To prevent unwanted closure of connections, be sure to set this value to a realistic connection timeout.	milliseconds	No
Packet Data Request Size	Number of octets to be placed into the ARR Data portion of the request message, when using SNA protocols. For RTT request/responses of non-ARR protocols, this value represents the native payload size. REMEMBER: The ARR Header overhead is not included in this value. For echo probes the total packet size = (IP header(20) + ICMP header(8) + 8 (internal timestamps) + request size). For echo and pathEcho default request size is 28. For udp probe, default request size is 16 and for jitter probe it is 32. For dlsw probes, default request size is 0. The minimum request size for echo and pathEcho is 28 bytes, for udp it is 4 and for jitter it is 16. For udp and jitter probes, the maximum request size is 1500.	octets/native payload size	No
Packet Data Response Size	Number of octets to be placed into the ARR Data portion of the response message. This value is passed to the RTT Echo Server using a field in the ARR Header. For non-ARR RTT request/responses (that is ipIcmpecho), this value will be set by the agent to match the size of rttMonEchoAdminPktDataRequestSize, when native payloads are supported. REMEMBER: The ARR Header overhead is not included in this value. This object is supported only by SNA protocols.	octets/native payload size	No
Target Address Type	The internet address type of the target. Unknown IPv4 IPv6 IPv4z IPv6z DNS	—	No
Source Address Type	The internet address type of the source. Unknown IPv4 IPv6 IPv4z IPv6z DNS	—	No
Test Completion Status	A code that defines the completion status of the latest RTT operation.	—	No
Send Packets	Number of packets that need to be transmitted. This object is applicable only to jitter probe.	packets	No
Response Packets	The number of response packets received successfully.	packets	No
Percentage of Successful Packets	Percent of successful packets.	%	Yes
Roundtrip Latency	Average completion time of a round-trip latency test.	milliseconds	Yes
DNS Roundtrip Latency	Average completion time of a round-trip DNS latency test.	milliseconds	Yes
TCP Roundtrip Latency	Average completion time of a round-trip TCP latency test.	milliseconds	Yes
Transaction Response Time	Time taken for the server to perform the required transaction.	milliseconds	Yes

IP SLA latency and jitter

This metric class contains real-time performance monitoring data for latency and jitter.

Metric name	Description	Units	Alertable
timestamp	Time of metric data retrieval.	milliseconds	No
Test Index	Identifier for a test at the time it was run.	—	No
Test Name	String used by a managing application to identify the RTT target. This string is inserted into trap notifications, but has no other significance to the agent.	—	No
Test Type	Type of RTT operation to be performed. This value must be set in the same PDU or before setting any type-specific configuration.	—	No
Protocol	Protocol to be used to perform the RTT operation. The following list defines what protocol should be used for each probe type: echo, pathEcho - ipIcmpEcho udpEcho - ipUdpEchoAppl tcpConnect - ipTcpConn http - httpAppl jitter - jitterAppl dlsw - dlswAppl dhcp - dhcpAppl ftp - ftpAppl When this protocol does not support the type, a “badValue” error will be returned.	—	No
Target Address	IP address of the target.	—	No
Target Port	Target port number. This object is applicable to udpEcho, tcpConnect, and jitter probes.	—	No
Source Address	IP address of the source. This object is applicable to all probes except dns, dlsw, and sna.	—	No
Source Port	Source port number. If this object is not specified, the application will get a port allocated by the system. This object is applicable to all probes except dns, dlsw, and sna.	—	No
Type of Service	Representation of the type of service octet in an IP header. This object is not applicable to dhcp and dns.	—	No
duration	Time difference between successive metric data retrievals.	milliseconds	No
Timeout	Specifies the duration to wait for a RTT operation completion. The value of this object cannot be set to a value that would specify a duration exceeding rttMonCtrlAdminFrequency. For connection-oriented protocols, this might cause the connection to be closed by the probe. closed, it will be assumed that the connection reestablishment will be performed. To prevent unwanted closure of connections, be sure to set this value to a realistic connection timeout.	milliseconds	No
Jitter Interval	Inter-packet delay between packets. This object is applicable only to jitter probe.	milliseconds	No
Packet Data Request Size	Number of octets to be placed into the ARR Data portion of the request message, when using SNA protocols. For RTT request/responses of non-ARR protocols, this value represents the native payload size. REMEMBER: The ARR Header overhead is not included in this value. For echo probes the total packet size = (IP header(20) + ICMP header(8) + 8 (internal timestamps) + request size). For echo and pathEcho default request size is 28. For udp probe, default request size is 16 and for jitter probe it is 32. For dlsw probes, default request size is 0. The minimum request size for echo and pathEcho is 28 bytes, for udp it is 4 and for jitter it is 16. For udp and jitter probes, the maximum request size is 1500.	octets/native payload size	No
Packet Data Response Size	Number of octets to be placed into the ARR Data portion of the response message. This value is passed to the RTT Echo Server using a field in the ARR Header. For non-ARR RTT request/responses (that is ipIcmpecho), this value will be set by the agent to match the size of rttMonEchoAdminPktDataRequestSize, when native payloads are supported. REMEMBER: The ARR Header overhead is not included in this value. This object is supported only by SNA protocols.	octets/native payload size	No
Target Address Type	The internet address type of the target. Unknown IPv4 IPv6 IPv4z IPv6z DNS	—	No
Source Address Type	The internet address type of the source. Unknown IPv4 IPv6 IPv4z IPv6z DNS	—	No
Send Packets	Number of packets that need to be transmitted. This object is applicable only to jitter probe.	packets	No
Response Packets	The number of response packets received successfully.	packets	No
Percentage of Successful Packets	Percent of successful packets.	%	Yes
Average Roundtrip Latency	Average completion time of a round-trip latency test.	milliseconds	Yes
Minimum Roundtrip Latency	The minimum roundtrip latency during the jitter test.	milliseconds	Yes
Maximum Roundtrip Latency	The maximum roundtrip latency during the jitter test.	milliseconds	Yes
Roundtrip Jitter (Peak to Peak)	Peak to peak jitter for the jitter test.	milliseconds	Yes
Roundtrip Jitter (Maximum Absolute Deviation)	Maximum absolute deviation value for the jitter test.	milliseconds	Yes
Roundtrip Jitter (Standard Deviation)	Standard deviation value for the jitter test.	milliseconds	Yes
Roundtrip Latency Coefficient Variation	Ratio of standard deviation to average latency for the jitter test.	—	Yes
Lost Packets (Source to Destination)	Number of packets lost when sent from source to destination.	packets	Yes
Percentage of Successful Packets (Source to Destination)	Percent of successful packets when sent from source to destination.	%	Yes
Average Latency (Source to Destination)	Average completion time of a source to destination latency test.	milliseconds	Yes
Minimum Latency (Source to Destination)	Minimum source to destination latency for the jitter test.	milliseconds	Yes
Maximum Latency (Source to Destination)	Maximum source to destination latency for the jitter test.	milliseconds	Yes
Outgoing Jitter (Peak to Peak)	Outgoing peak to peak jitter for the jitter test.	milliseconds	Yes
Outgoing Jitter (Maximum Absolute Deviation)	Outgoing maximum absolute deviation value for the jitter test.	milliseconds	Yes
Outgoing Jitter (Standard Deviation)	Outgoing standard deviation value for the jitter test.	milliseconds	Yes
Outgoing Latency Coefficient Variation	Ratio of source to destination standard deviation to source to destination average latency for the jitter test.	ratio	Yes
Lost Packets (Destination to Source)	Number of packets lost when sent from destination to source.	packets	Yes
Percentage of Successful Packets (Destination to Source)	Percent of successful packets when sent from destination to source.	%	Yes
Average Latency (Destination to Source)	Average completion time of a destination to source latency test.	milliseconds	Yes
Minimum Latency (Destination to Source)	Minimum destination to source latency for the jitter test.	milliseconds	Yes
Maximum Latency (Destination to Source)	Maximum destination to source latency for the jitter test.	milliseconds	Yes
Incoming Jitter (Peak to Peak)	Incoming peak to peak jitter for the jitter test.	milliseconds	Yes
Incoming Jitter (Maximum Absolute Deviation)	Incoming maximum absolute deviation value for the jitter test.	milliseconds	Yes
Incoming Jitter (Standard Deviation)	Incoming standard deviation value for the jitter test.	milliseconds	Yes
Incoming Latency Coefficient Variation	Ratio of destination to source standard deviation to destination to source average latency for the jitter test.	ratio	Yes
Packets Arrived Out of Sequence	Number of packets that arrived out of sequence.	packets	Yes
Packets Lost Cannot Determine Direction	Number of packets that are lost for which we cannot determine the direction.	packets	Yes
Packets Arrived Late	Number of packets that arrived after the timeout.	packets	Yes
Mean Opinion Score	MOS value for the latest jitter operation.	hundreds	Yes
Calculated Planning Impairment Factor	ICPIF value for the jitter test.	—	Yes