Cisco Intersight API Temperature metrics

Temperature

Label: hw.temperature

Description: A temperature sensor, either numeric or discrete.

Data source: PhysicalEntities

Supported Metrics

This instrument supports the following 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.
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.
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.

Attributes

Label Name Description Enums
Account Moid intersight.iam.account.moid The Moid of the iam.Account. no
Airflow Direction hw.temperature.sensor.airflow_direction Describes the air flow direction near the sensor. yes
Domain Identifier intersight.domain.id The identifier of the domain to which the device belongs. The value is the device registration object's API path of the top-most ancestor. For Fabric Interconnects, the Domain Identifier is the API path of its device registration object. For IMM Chassis, Blades, and Rack servers, the Domain Identifier is the API path of the parent Fabric Interconnect's device registration object. no
Domain Name intersight.domain.name The name of the domain to which the device belongs. The value is the device registration object's hostname of the top-most ancestor. For Fabric Interconnects, the Domain Name is the hostname of its device registration object. For IMM Chassis, Blades, and Rack servers, the Domain Name is the hostname of the parent Fabric Interconnect's device registration object. no
Generation model_generation The generation of a hardware component. no
Hardware Type hw.type The type of hardware component. no
Host Identifier host.id A globally unique host ID. For Intersight resources, this is the API path to the resource where the Device Connector is running. For example, if a device connector is running on a Fabric Interconnect, the resource is network.Element. no
Host Name host.name The name assigned by a user to a specific device or resource, such as the fully qualified domain name (FQDN) of a computer or server on a network. The assigned name is used as host name for UCS server, Fabric Interconnect, Chassis, IO module and Fabric Extender. The host name is not guaranteed to be unique and may change over time. no
Host Tags host.tags The meta-data tags associated with the component's host. These tags could be used for identification, organization, or management purposes. no
Host Type host.type Type of host. yes
Identifier id An identifier for the hardware component, unique within the monitored host. For Intersight resources, this is the API path to the resource for which the metric is reported. no
License Tier intersight.license.license_info.license_type The name of the Intersight license entitlement. yes
Member Moid intersight.asset.cluster_member.moid The Moid of the asset.DeviceClusterMember. no
Model model The model of a hardware component. no
Name name An easily-recognizable name for the hardware component. no
Parent Identifier parent.id Unique identifier of the parent component (typically the id attribute of the enclosure, or disk controller). For Intersight resources, this is the API path to the parent resource. no
Parent Name parent.name Name of the parent resource. For Intersight resources, this is the name of the parent resource. no
Permission Resources permission.resources The permission resources associated with the component. For example, a component might be part of multiple organizations. All such organizations are a part of its permission resources. no
Product Family model_family The family series of a hardware component. no
Registration Moid intersight.asset.device_registration.moid The Moid of the asset.DeviceRegistration. no
Sensor Location sensor_location Indicates the location of the sensor on the hardware. yes
Sensor Name hw.temperature.sensor.name The device-specific name of the sensor from which the temperature is measured. As an example, for UCS servers this will be the IPMI defined sensor name. no
Serial Number serial_number The serial number of a hardware component. no
Vendor vendor The vendor of a hardware component. no
temperature state hw.temperature.state Indicates whether the temperature is within normal range (ok), degraded or failed state. no

Enum Airflow Direction

Value Description
inlet This sensor is located in the area where air is flowing into the hardware component.
outlet This sensor is located in the area where air is flowing out of the hardware component.

Enum Host Type

Value Description
network.Element
compute.Blade
compute.RackUnit
equipment.Chassis

Enum License Tier

Value Description
Essential The Essentials license tier offers server management with global health monitoring, inventory, proactive support through Cisco TAC integration, multi-factor authentication, along with SDK and API access
Advantage The Advantage license tier offers advanced server management with extended visibility, ecosystem integration, and automation of Cisco and third-party hardware and software, along with multi-domain solutions.

Enum Sensor Location

Value Description
server_front The sensor is located at the front of a server.
server_back The sensor is located at the back of a server.
server_cpu The sensor is located at a server's CPU.
fi_front The sensor is located at the front of a Fabric Interconnect.
fi_back The sensor is located at the back of a Fabric Interconnect.
fi_cpu The sensor is located at a Fabric Interconnect's CPU.
fi_asic The sensor is located at the Fabric Interconnect's ASIC chip.
fex_inlet The sensor is located at the air inlet area of a FEX module.
fex_outlet The sensor is located at the air outlet area of a FEX module.
fex_die The sensor is located at a FEX module's die.
fi_transceiver_lane_0 Sensor on lane 0 of the transceiver plugged into the Fabric Interconnect.
fi_transceiver_lane_1 Sensor on lane 1 of the transceiver plugged into the Fabric Interconnect.
fi_transceiver_lane_2 Sensor on lane 2 of the transceiver plugged into the Fabric Interconnect.
fi_transceiver_lane_3 Sensor on lane 3 of the transceiver plugged into the Fabric Interconnect.
fi_transceiver_lane_4 Sensor on lane 4 of the transceiver plugged into the Fabric Interconnect.
fi_transceiver_lane_5 Sensor on lane 5 of the transceiver plugged into the Fabric Interconnect.
fi_transceiver_lane_6 Sensor on lane 6 of the transceiver plugged into the Fabric Interconnect.
fi_transceiver_lane_7 Sensor on lane 7 of the transceiver plugged into the Fabric Interconnect.
fi_transceiver_lane_8 Sensor on lane 8 of the transceiver plugged into the Fabric Interconnect.

Metric Hardware Status

Name: hw.status

Description: 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.

Metric type: UpDownCounter

Value type: int64

Support information

  • imm-blade
  • imm-fi
  • imm-rack
  • umm-blade
  • umm-fi
  • umm-rack

Available metrics

Value Name
Sum hw.status
Count hw.status_count
Duration hw.status_duration
Max rate hw.status_max
Min rate hw.status_min

Metric High Critical Temperature Threshold

Name: hw.temperature.limit_high_critical

Description: The high critical temperature threshold.

Metric type: Gauge

Value type: float64

Support information

  • imm-fi

Available metrics

Value Name
Sum hw.temperature.limit_high_critical
Count hw.temperature.limit_high_critical_count
Duration hw.temperature.limit_high_critical_duration
Max rate hw.temperature.limit_high_critical_max
Min rate hw.temperature.limit_high_critical_min

Metric Low Critical Temperature Threshold

Name: hw.temperature.limit_low_critical

Description: The lower critical temperature threshold.

Metric type: Gauge

Value type: float64

Support information

  • imm-fi

Available metrics

Value Name
Sum hw.temperature.limit_low_critical
Count hw.temperature.limit_low_critical_count
Duration hw.temperature.limit_low_critical_duration
Max rate hw.temperature.limit_low_critical_max
Min rate hw.temperature.limit_low_critical_min

Metric Temperature

Name: hw.temperature

Description: 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.

Metric type: Gauge

Value type: float64

Support information

  • imm-blade
  • imm-fi
  • imm-rack
  • umm-blade
  • umm-fi
  • umm-rack

Available metrics

Value Name
Sum hw.temperature
Count hw.temperature_count
Duration hw.temperature_duration
Max rate hw.temperature_max
Min rate hw.temperature_min