Cisco Intersight API supported metrics overview

Overview

Electric Current

Label: hw.current

Description: An electric current sensor, either numeric or discrete.

Supported metrics:

Label Name Description
Electric Current hw.current Electric current measured by the sensor in Ampere. In case of a transceiver, this is the laser bias current, which is the amount of electrical current supplied to the laser diode within the transceiver to generate the optical signal for transmission. Transceiver electric current metric requires advantage license and is available only if transceiver is present and DOM(Digital optical monitoring) is enabled.

Fan

Label: hw.fan

Description: A fan in a Server, Chassis, Fabric Interconnect or PSU.

Supported metrics:

Label Name Description
Fan Speed hw.fan.speed Fan speed in revolutions per minute (rpm).
Fan Speed Ratio hw.fan.speed_ratio Fan speed expressed as a percentage of its maximum speed.
Hardware Status hw.status The operational status: 1 (true) or 0 (false) for each of the possible states. At query time, you can use the following aggregation functions: 1. Use longMax aggregation to determine if the component was up at least once during each rollup interval. 2. Use longMin aggregation to determine if the component was down at least once during each rollup interval. 3. Use ( longSum / count ) to determine the percentage of time when the component was up during each rollup interval.

Host Power and Status

Label: hw.host

Description: A Server or Fabric Interconnect.

Supported metrics:

Label Name Description
Host Energy hw.host.energy Total energy consumed by the entire physical host, in joules.
Host Power hw.host.power Instantaneous power consumed by the entire physical host, in Watts.
Host Power State hw.host.power_state The power state of the host: 1 (on) or 0 (off). At query time, you can use the following aggregation functions: 1. Use longMax aggregation to determine if the host was on at least once during each rollup interval. 2. Use longMin aggregation to determine if the host was off at least once during each rollup interval. 3. Use ( longSum / hw.host.power_state_count ) to determine the percentage of time when the host was on during each rollup interval.

Memory Module

Label: hw.memory

Description: A memory module in a Server or Fabric Interconnect.

Supported metrics:

Label Name Description
Correctable ECC Errors hw.errors_correctable_ecc_errors Number of correctable ECC errors that were detected on the memory module. This metric is only available when the host is in a powered-on state.
Uncorrectable ECC Errors hw.errors_uncorrectable_ecc_errors Number of uncorrectable ECC errors that were detected on the memory module. This metric is only available when the host is in a powered-on state.
Memory Size hw.memory.size The size of the memory module. This metric is only available when the host is in a powered-on state.
Hardware Status hw.status The operational status of the memory module.

Network Interface

Label: hw.network

Description: A physical or logical network interface on a Server, IOM or Fabric Interconnect.

Supported metrics:

Label Name Description
Network Carrier Sense Errors hw.errors_network_carrier_sense Number of times the absence of a carrier signal is detected on the interface before attempting to transmit data.
Network Late Collision Errors hw.errors_network_late_collisions Number of times collisions are detected after the collision window has elapsed on the network interface.
Network Link Failure Errors hw.errors_network_link_failures Number of times the loss of connectivity has been detected on the network interface.
Total Network RX Errors hw.errors_network_receive_all Number of errors encountered during the reception of data by the network interface which is reported as the summation of all the receive errors.
Network RX CRC Errors hw.errors_network_receive_crc Number of received packets (or frames) that have failed the CRC check on the network interface.
Network RX Discard Errors hw.errors_network_receive_discard Number of packets (or frames) that are received but not processed and discarded by the network interface.
Network No Buffer Errors hw.errors_network_receive_no_buffer Number of received frames that were dropped due to unavailability of the buffer on the network interface.
Network RX Pause Frames hw.errors_network_receive_pause Number of received pause packets (or frames) on the network interface.
Network Runt Errors hw.errors_network_receive_runt Number of received ethernet frames with a size smaller than the IEEE 802.3's minimum length of 64 octets.
Network Too Long Errors hw.errors_network_receive_too_long Number of oversized packets (or frames) received on the network interface.
Network Too Short Errors hw.errors_network_receive_too_short Number of undersized packets (or frames) received on the network interface.
Network Signal Loss Errors hw.errors_network_signal_losses Number of times the loss of signal has been detected on the network interface.
Network Sync Loss Errors hw.errors_network_sync_losses Number of times the synchronization between the transmitting and receiving devices is lost during data transmission on the network interface.
Total Network TX Errors hw.errors_network_transmit_all Number of errors encountered during the transmission of data from the network interface which is reported as the summation of all the transmit errors.
Network TX Deferred Errors hw.errors_network_transmit_deferred Number of packets (or frames) that have been temporarily postponed or delayed from immediate transmission by the network interface.
Network TX Discard Errors hw.errors_network_transmit_discard Number of packets (or frames) that are not successfully transmitted and are instead discarded by the network interface.
Network Jabber Errors hw.errors_network_transmit_jabber Number of transmitted ethernet frames with a size more than the length allowed by the Ethernet standard.
Network TX Pause Frames hw.errors_network_transmit_pause Number of transmitted pause packets (or frames) on the network interface.
Network Receive Drop Errors hw.errors_receive_drops Number of receive packets (or frames) that were dropped.
Network Transmit Drop Errors hw.errors_transmit_drops Number of transmit packets (or frames) that were dropped.
Operational Link Speed hw.network.bandwidth.limit The operational speed of the network interface, in bytes per second.
Network TX Buffer Credit Left hw.network.bb_credit_left_transmit The available buffer credits for the network interface. This ensures that the sender never transmits a packet that the network interface does not have a buffer to hold it in.
Network RX Buffer Credit Limit hw.network.bb_credit_limit_receive The maximum number of buffer credits that the network interface can have. The sender never transmits a packet to the network interface beyond this limit.
Network TX Buffer Credit Limit hw.network.bb_credit_limit_transmit The maximum number of buffer credits that the network interface can have. The network interface never transmits a packet to the receiver beyond this limit.
Network Interface Resets hw.network.interface_resets Number of times the interface is reset.
Network Bytes hw.network.io_all Received and transmitted network traffic in bytes.
Network RX Bytes hw.network.io_receive Received network traffic in bytes.
Network RX Broadcast Bytes hw.network.io_receive_broadcast Received broadcast network traffic in bytes.
Network RX Multicast Bytes hw.network.io_receive_multicast Received multicast network traffic in bytes.
Network RX Unicast Bytes hw.network.io_receive_unicast Received unicast network traffic in bytes.
Network TX Bytes hw.network.io_transmit Transmitted network traffic in bytes.
Network TX Broadcast Bytes hw.network.io_transmit_broadcast Transmitted broadcast network traffic in bytes.
Network TX Multicast Bytes hw.network.io_transmit_multicast Transmitted multicast network traffic in bytes.
Network TX Unicast Bytes hw.network.io_transmit_unicast Transmitted unicast network traffic in bytes.
Network RX Packets hw.network.packets_receive Received network traffic in packets (or frames).
RX Packets Size 1024 to 1518 hw.network.packets_receive_1024_to_1518 Received network traffic in packets (or frames) with size between 1024 and 1518.
RX Packets Size 128 to 255 hw.network.packets_receive_128_to_255 Received network traffic in packets (or frames) with size between 128 and 255.
RX Packets Size 1519 or Above hw.network.packets_receive_1519_to_max Received network traffic in packets (or frames) with size of 255 or above.
RX Packets Size 256 to 511 hw.network.packets_receive_256_to_511 Received network traffic in packets (or frames) with size between 256 and 511.
RX Packets Size 512 to 1023 hw.network.packets_receive_512_to_1023 Received network traffic in packets (or frames) with size between 512 and 1023.
RX Packets Size 64 hw.network.packets_receive_64 Received network traffic in packets (or frames) with size of 64.
RX Packets Size 65 to 127 hw.network.packets_receive_65_to_127 Received network traffic in packets (or frames) with size between 65 and 127.
Network RX Broadcast Packets hw.network.packets_receive_broadcast Received broadcast network traffic in packets (or frames).
Network RX Multicast Packets hw.network.packets_receive_multicast Received multicast network traffic in packets (or frames).
Network RX Priority Pause Frames hw.network.packets_receive_ppp Received priority pause frames on the network interface.
Network RX RSS Packets hw.network.packets_receive_rss Received network traffic in packets (or frames) that were processed using RSS.
Network RX Unicast Packets hw.network.packets_receive_unicast Received unicast network traffic in packets (or frames).
Network TX Packets hw.network.packets_transmit Transmitted network traffic in packets (or frames).
Network TX Broadcast Packets hw.network.packets_transmit_broadcast Transmitted broadcast network traffic in packets (or frames).
Network TX Multicast Packets hw.network.packets_transmit_multicast Transmitted multicast network traffic in packets (or frames).
Network TX Priority Pause Frames hw.network.packets_transmit_ppp Transmitted priority pause frames on the network interface.
Network TX TSO Packets hw.network.packets_transmit_tso Transmitted network traffic in packets (or frames) that were processed using TSO.
Network TX Unicast Packets hw.network.packets_transmit_unicast Transmitted unicast network traffic in packets (or frames).
Link Status hw.network.up Link status: 1 (up) or 0 (down).

Power Supply

Label: hw.power_supply

Description: A PSU on a Server, Chassis or Fabric Interconnect.

Supported metrics:

Label Name Description
Energy hw.energy Energy consumed by a hardware component, in joules.
Output Energy hw.energy_out Output energy delivered by the power supply, in Joules.
Power hw.power Instantaneous power consumed by a hardware component, in Watts.
Output Power hw.power_out Output power delivered by the power supply, in Watts.
Max Power Limit hw.power_supply.limit_max The maximum output power of the power supply.
Power Supply Utilization hw.power_supply.utilization Utilization of the power supply as a percentage of its maximum output.
Hardware Status hw.status The operational status: 1 (true) or 0 (false) for each of the possible states. At query time, you can use the following aggregation functions: 1. Use longMax aggregation to determine if the component was up at least once during each rollup interval. 2. Use longMin aggregation to determine if the component was down at least once during each rollup interval. 3. Use ( longSum / count ) to determine the percentage of time when the component was up during each rollup interval.

Signal Power

Label: hw.signal_power

Description: A signal power sensor, either numeric or discrete.

Supported metrics:

Label Name Description
Rx Power hw.signal_power_receive Power in decibels per milliwatt (dBm) at which a sensor receives its signal. Transceiver receive power metric requires an advantage license and is available only if a transceiver is present and DOM (Digital optical monitoring) is enabled.
Tx Power hw.signal_power_transmit Power in decibels per milliwatt (dBm) at which a sensor transmits its signal. Transceiver transmit power metric requires an advantage license and is available only if a transceiver is present and DOM (Digital optical monitoring) is enabled.

Temperature

Label: hw.temperature

Description: A temperature sensor, either numeric or discrete.

Supported metrics:

Label Name Description
Hardware Status hw.status The operational status: 1 (true) or 0 (false) for each of the possible states. At query time, you can use the following aggregation functions: 1. Use longMax aggregation to determine if the component was up at least once during each rollup interval. 2. Use longMin aggregation to determine if the component was down at least once during each rollup interval. 3. Use ( longSum / count ) to determine the percentage of time when the component was up during each rollup interval.
Temperature hw.temperature Temperature in degrees Celsius. Server CPU temperature metrics are available only when the host is in a powered-on state. In case of a transceiver, it is the operating temperature. Transceiver temperature metric requires an advantage license and is available only if a transceiver is present and DOM (Digital optical monitoring) is enabled.
High Critical Temperature Threshold hw.temperature.limit_high_critical The high critical temperature threshold.
Low Critical Temperature Threshold hw.temperature.limit_low_critical The lower critical temperature threshold.

Voltage

Label: hw.voltage

Description: A voltage sensor, either numeric or discrete.

Supported metrics:

Label Name Description
Voltage hw.voltage Voltage measured by the sensor in Volts. Transceiver voltage metric requires an advantage license and is available only if a transceiver is present and DOM (Digital optical monitoring) is enabled.

System CPU

Label: system.cpu

Description: System-level processor metrics. The value of the 'host.id' attribute identifies the host resource.

Supported metrics:

Label Name Description
Idle CPU Utilization system.cpu.utilization_idle The percentage of CPU capacity unused during periods of inactivity.
System CPU Utilization system.cpu.utilization_system The percentage of CPU time consumed by the operating system's kernel processes.
User CPU Utilization system.cpu.utilization_user The percentage of CPU time utilized by user-launched applications and processes.

System Memory

Label: system.memory

Description: System-level memory metrics.

Supported metrics:

Label Name Description
Cached System Memory system.memory.usage_cached The cached memory of the system, in bytes.
Free System Memory system.memory.usage_free The free memory of the system, in bytes.
Used System Memory system.memory.usage_used The memory usage of the system, in bytes.
Memory Utilization system.memory.utilization The memory utilization of the system, as a percentage.