Cisco Intersight API Power Supply metrics

Power Supply

Label: hw.power_supply

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

Data source: PhysicalEntities

Supported Metrics

This instrument supports the following Metrics:

Label Name Description
Energy hw.energy Energy consumed by a hardware component, in joules.
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.
Max Power Limit hw.power_supply.limit_max The maximum output power of the power supply.
Output Energy hw.energy_out Output energy delivered by the power supply, in Joules.
Output Power hw.power_out Output power delivered by the power supply, in Watts.
Power hw.power Instantaneous power consumed by a hardware component, in Watts.
Power Supply Utilization hw.power_supply.utilization Utilization of the power supply as a percentage of its maximum output.

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
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
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
Power Supply State hw.power_supply.state The state of the power supply, e.g., ok, degraded, failed. 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 Energy

Name: hw.energy

Description: Energy consumed by a hardware component, in joules.

Metric type: Counter

Value type: float64

Support information

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

Available metrics

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

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-chassis
  • imm-fi
  • imm-rack
  • umm-chassis
  • 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 Max Power Limit

Name: hw.power_supply.limit_max

Description: The maximum output power of the power supply.

Metric type: UpDownCounter

Value type: int64

Support information

  • imm-fi
  • umm-fi

Available metrics

Value Name
Sum hw.power_supply.limit_max
Count hw.power_supply.limit_max_count
Duration hw.power_supply.limit_max_duration
Max rate hw.power_supply.limit_max_max
Min rate hw.power_supply.limit_max_min

Metric Output Energy

Name: hw.energy_out

Description: Output energy delivered by the power supply, in Joules.

Metric type: Counter

Value type: float64

Support information

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

Available metrics

Value Name
Sum hw.energy_out
Count hw.energy_out_count
Duration hw.energy_out_duration

Metric Output Power

Name: hw.power_out

Description: Output power delivered by the power supply, in Watts.

Metric type: Gauge

Value type: float64

Support information

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

Available metrics

Value Name
Sum hw.power_out
Count hw.power_out_count
Duration hw.power_out_duration
Max rate hw.power_out_max
Min rate hw.power_out_min

Metric Power

Name: hw.power

Description: Instantaneous power consumed by a hardware component, in Watts.

Metric type: Gauge

Value type: float64

Support information

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

Available metrics

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

Metric Power Supply Utilization

Name: hw.power_supply.utilization

Description: Utilization of the power supply as a percentage of its maximum output.

Metric type: Gauge

Value type: float64

Support information

  • imm-fi
  • umm-fi

Available metrics

Value Name
Sum hw.power_supply.utilization
Count hw.power_supply.utilization_count
Duration hw.power_supply.utilization_duration
Max rate hw.power_supply.utilization_max
Min rate hw.power_supply.utilization_min