Cisco Intersight API Host Power and Status metrics

Host Power and Status

Label: hw.host

Description: A Server or Fabric Interconnect.

Data source: PhysicalEntities

Supported Metrics

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

Attributes

Label Name Description Enums
Account Moid intersight.iam.account.moid The Moid of the iam.Account. no
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
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 Image Version host.image.version The version string of the host OS image. 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
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
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
Serial Number serial_number The serial number of a hardware component. no
Vendor vendor The vendor of a hardware component. no

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.

Metric Host Energy

Name: hw.host.energy

Description: Total energy consumed by the entire physical host, in joules.

Metric type: Counter

Value type: float64

Support information

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

Available metrics

Value Name
Sum hw.host.energy
Count hw.host.energy_count
Duration hw.host.energy_duration

Metric Host Power

Name: hw.host.power

Description: Instantaneous power consumed by the entire physical host, in Watts.

Metric type: Gauge

Value type: float64

Support information

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

Available metrics

Value Name
Sum hw.host.power
Count hw.host.power_count
Duration hw.host.power_duration
Max rate hw.host.power_max
Min rate hw.host.power_min

Metric Host Power State

Name: hw.host.power_state

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

Metric type: UpDownCounter

Value type: int64

Support information

  • imm-blade
  • imm-rack
  • umm-blade
  • umm-chassis
  • umm-rack

Available metrics

Value Name
Sum hw.host.power_state
Count hw.host.power_state_count
Duration hw.host.power_state_duration
Max rate hw.host.power_state_max
Min rate hw.host.power_state_min