SPECS.md

Specifications

• Specifications
  • Collections
  • Paths, class IDs, SNMP MIBs and YANG models
    • Meraki
    • REDFISH
      • UCS
    • CIMC: Class IDs
      • UCS
    • UCSM
    • SNMP
    • TELEMETRY
      • Nexus 3K, Nexus 9K
        • C9372PX: NX-OS 9.3(7)
      • NCS
        • NCS-540: IOS-XR 7.4.1
        • NCS-540L: IOS-XR 7.7.1 LNT
        • NCS-55A2: IOS-XR 7.3.2
        • NCS-5504: IOS-XR 7.2.2
        • NCS-5508: IOS-XR 7.3.2
      • ASR-9K
        • ASR-9001: IOS-XR 7.3.1
        • ASR-9904: IOS-XR 7.3.2
        • ASR-9903: IOS-XR 7.3.2
      • Cisco 8201
        • IOS-XR 7.3.2 LNT
        • IOS-XR 7.7.1 LNT
        • IOS-XR 7.10.1 LNT
  • Power consumption ratio (PCR)

Collections

Data source	Configuration	Measurement(s)	Collection scripts	Frequency	Data enrichment script (tags)	Dashboard(s)
NCS	ncs-540.cfg ncs-50xx.cfg ncs-540L.cfg ncs-560-er.cfg	Cisco-IOS-XR-sysadmin-fretta-envmon-ui:environment/oper/power/location/pem_attributes Cisco-IOS-XR-envmon-oper:environmental-monitoring/rack/nodes/node/sensor-types/sensor-type/sensor-names/sensor-name Cisco-IOS-XR-envmon-oper:power-management/rack/chassis Cisco-IOS-XR-envmon-oper:power-management/rack/consumers/consumer-nodes/consumer-node Cisco-IOS-XR-envmon-oper:power-management/rack/producers/producer-nodes/producer-node Cisco-IOS-XR-sysadmin-uea-envmon-ui:environment/oper/power/location/pem_attributes _Others:* Cisco-IOS-XR-infra-statsd-oper:infra-statistics/interfaces/interface/total/data-rate (bandwidth, traffic) Cisco-IOS-XR-pfi-im-cmd-oper:interfaces/interface-briefs/interface-brief (interface states)	telegraf-xr-and-nxos.conf	30-60-120s	telegraf-mapping.conf	Power Carbon emissions Cost Carbon emissions - historical - Fretta Bandwidth Utilization
ASR 9K	asr-9903.cfg asr-9904.cfg	Power: Cisco-IOS-XR-sysadmin-asr9k-envmon-ui:environment/oper/power/location/pemattributes _Others: Cisco-IOS-XR-infra-statsd-oper:infra-statistics/interfaces/interface/total/data-rate (bandwidth, traffic) Cisco-IOS-XR-pfi-im-cmd-oper:interfaces/interface-briefs/interface-brief (interface states)	telegraf-xr-and-nxos.conf	30s	telegraf-mapping.conf	Power Carbon emissions Cost Bandwidth Utilization
Cisco 8K	cisco-router-8201.cfg	Cisco-IOS-XR-envmon-oper:environmental-monitoring/rack/nodes/node/sensor-types/sensor-type/sensor-names/sensor-name Cisco-IOS-XR-envmon-oper:power-management/rack/chassis Cisco-IOS-XR-envmon-oper:power-management/rack/consumers/consumer-nodes/consumer-node Cisco-IOS-XR-envmon-oper:power-management/rack/producers/producer-nodes/producer-node Cisco-IOS-XR-invmgr-oper:inventory/entities/entity/attributes/env-sensor-info Cisco-IOS-XR-invmgr-oper:inventory/entities/entity/attributes/inv-basic-bag Others: Cisco-IOS-XR-infra-statsd-oper:infra-statistics/interfaces/interface/total/data-rate (bandwidth, traffic) Cisco-IOS-XR-pfi-im-cmd-oper:interfaces/interface-briefs/interface-brief (interface states)	telegraf-xr-and-nxos.conf	30s	telegraf-mapping.conf	Power Carbon emissions Cost PCR versus Traffic Bandwidth Utilization
Meraki		meraki-switch	stack/telegraf/telegraf.d/meraki/get-meraki-power.py stack/telegraf/telegraf.d/telegraf-switch-meraki.conf	1h	telegraf-mapping.conf	Meraki
Nexus	nexus9k-c9372px.cfg	show environment power	telegraf-xr-and-nxos.conf	30s	telegraf-mapping.conf	Power Carbon emissions Cost Cost - Nexus and UCS
ACI APIC		apic-switch	get-switch-power.py telegraf-switch-apic.conf	3m	telegraf-mapping.conf	Power Carbon emissions Cost
UCS REDFISH		redfish_power_powersupplies redfish_thermal_temperatures	telegraf-redfish.conf	60m	telegraf-mapping.conf	Cost - UCS and Nexus
UCS CIMC		cimc-ucs-power cimc-ucs-temperature cimc-ucs-utilization	get-ucs-power-temp-util-idb.py telegraf-ucs-cimc.conf	60m	telegraf-mapping.conf	UCS UCS - Rack view
UCSM		ucsm-chassis-power ucsm-server-power ucsm-fabric-interconnect-power	get-ucsm-power-temp-util-idb.py telegraf-ucsm.conf	60m	telegraf-mapping.conf
Raritan PDUs		raritan-pdu	get-raritan.py telegraf-raritan-pdu.conf	1m	telegraf-mapping.conf	Raritan PDUs
Eaton PDUs		eaton_input_power eaton_output_power	telegraf-eaton-pdu.conf	60s	telegraf-mapping.conf	Eaton PDUs
Electricity Maps - CO2 emissions/kWh		electricity-map	get-co2eqkwh.py telegraf-electricitymap.conf	15m	telegraf-mapping.conf	Carbon emissions Carbon emissions - historical - Fretta

Paths, class IDs, SNMP MIBs and YANG models

The resources considered for power and temperature information are documented below.

Note: For sample device configuration of the IOS-XR, NX-OS devices, refer to the configuration files located here.

Note: The elements highlighted in bold are those that have been used for the visualizations.

Meraki

Element	Operation ID
organization	getOrganizationSummaryTopSwitchesByEnergyUsage
switch/port	getDeviceSwitchPortsStatuses

REDFISH

UCS

Redfish property path
redfish_power_powersupplies
redfish_thermal_temperatures

CIMC: Class IDs

References:

• CIMC Python SDK source code
• CIMC MIM
• Class IDs

UCS

Class ID	Python constant
powerMonitor	NamingId.POWER_MONITOR
equipmentPsu	NamingId.EQUIPMENT_PSU
powerBudget	NamingId.POWER_BUDGET
consumedPower	NamingId.CONSUMED_POWER
cpuPowerLimit	NamingId.CPU_POWER_LIMIT
maxCpuPower	NamingId.MAX_CPU_POWER
minCpuPower	NamingId.MIN_CPU_POWER
maxMemoryPower	NamingId.MAX_MEMORY_POWER
maxPower	NamingId.MAX_POWER
minPower	NamingId.MIN_POWER
memoryPowerLimit	NamingId.MEMORY_POWER_LIMIT
computeMbPowerStats	NamingId.COMPUTE_MB_POWER_STATS
power	NamingId.POWER
powerLimit	NamingId.POWER_LIMIT
powerState	NamingId.POWER_STATE

UCSM

UCSM property path
EquipmentChassisStats
ComputeMbPowerStats
EquipmentPsuInputStats

SNMP

References:

• Cisco MIBs
• Eaton MIBs

TELEMETRY

Reference:

• YANG models for IOS-XR, IOS-XE, NX-OS platforms

Nexus 3K, Nexus 9K

C9372PX: NX-OS 9.3(7)

NX-API command

Fields

show env power

psmodel actual_out actual_input tot_capa ps_status powersup/voltage_level=12i powersup/power_summary/ps_redun_mode powersup/power_summary/ps_oper_mode powersup/power_summary/tot_pow_capacity powersup/power_summary/tot_gridA_capacity powersup/power_summary/tot_gridB_capacity powersup/power_summary/cumulative_power powersup/power_summary/tot_pow_out_actual_draw powersup/power_summary/tot_pow_input_actual_draw powersup/power_summary/tot_pow_alloc_budgeted powersup/power_summary/available_pow powersup/TABLE_psinfo

NCS

NCS-540: IOS-XR 7.4.1

Model	Telemetry Path(s)
Cisco-IOS-XR-sysadmin-fretta-envmon-ui.yang	Cisco-IOS-XR-sysadmin-fretta-envmon-ui:environment/oper/power Specifically in Grafana: - [...]/location/pem_attributes/system_power_input - [...]/location/pem_attributes/power_resrv_and_alloc
Cisco-IOS-XR-invmgr-oper.yang	- Cisco-IOS-XR-invmgr-oper:inventory/racks/rack/powershelf - Cisco-IOS-XR-invmgr-oper:inventory/entities/entity/attributes/inv-basic-bag/allocated-power - [...]
Cisco-IOS-XR-plat-chas-invmgr-ng-oper.yang	Cisco-IOS-XR-plat-chas-invmgr-ng-oper:platform-inventory/racks/rack/attributes/fru-info/module-power-administrative-state (only state)
Cisco-IOS-XR-sdr-invmgr-diag-oper.yang	- Cisco-IOS-XR-sdr-invmgr-diag-oper:diag/racks/rack/fan-trays/fan-tray/fanses/fans/information/power-consumption - Cisco-IOS-XR-sdr-invmgr-diag-oper:diag/racks/rack/power-shelfs/power-shelf/power-shelf-name - Cisco-IOS-XR-sdr-invmgr-diag-oper:diag/racks/rack/power-shelfs/power-shelf/power-supplies/power-supply/power-supply-name
openconfig-platform.yang	openconfig-platform:components/component/state
Cisco-IOS-XR-sysadmin-show-inv.yang	Cisco-IOS-XR-sysadmin-show-inv:inventory/power (power supplies)
Others: Cisco-IOS-XR-infra-statsd-oper.yang Cisco-IOS-XR-pfi-im-cmd-oper.yang	Cisco-IOS-XR-infra-statsd-oper:infra-statistics/interfaces/interface/total/data-rate/[input/output]-data-rate Cisco-IOS-XR-pfi-im-cmd-oper:interfaces/interface-briefs/interface-brief/type Cisco-IOS-XR-pfi-im-cmd-oper:interfaces/interface-briefs/interface-brief/state Cisco-IOS-XR-pfi-im-cmd-oper:interfaces/interface-briefs/interface-brief/bandwidth

NCS-540L: IOS-XR 7.7.1 LNT

Model	Telemetry Path(s)	Observations
Cisco-IOS-XR-envmon-oper.yang	- Cisco-IOS-XR-envmon-oper:environmental-monitoring - Cisco-IOS-XR-envmon-oper:environmental-monitoring/rack/nodes/node/sensor-types/sensor-type/sensor-names/sensor-name - Cisco-IOS-XR-envmon-oper:environmental-monitoring/rack/nodes/node/sensor-types/sensor-type/type - Cisco-IOS-XR-envmon-oper:environmental-monitoring/rack/nodes/node/sensor-types/sensor-type/type=power - Cisco-IOS-XR-envmon-oper:power-management - Cisco-IOS-XR-envmon-oper:power-management/rack/producers Specifically, in Grafana: - [...]/producer-node/pem_info_array/current_in_a - [...]/producer-node/pem_info_array/current_in_b - [...]/producer-node/pem_info_array/voltage_in_a - [...]/producer-node/pem_info_array/voltage_in_b - [...]/producer-node/pem_info_array/voltage_out - [...]/producer-node/pem_info_array/current_out - Cisco-IOS-XR-envmon-oper:power-management/rack/consumers/consumer-nodes - Cisco-IOS-XR-envmon-oper:power-management/rack/chassis
Others: Cisco-IOS-XR-infra-statsd-oper.yang Cisco-IOS-XR-pfi-im-cmd-oper.yang	Cisco-IOS-XR-infra-statsd-oper:infra-statistics/interfaces/interface/total/data-rate/[input/output]-data-rate Cisco-IOS-XR-pfi-im-cmd-oper:interfaces/interface-briefs/interface-brief/type Cisco-IOS-XR-pfi-im-cmd-oper:interfaces/interface-briefs/interface-brief/state Cisco-IOS-XR-pfi-im-cmd-oper:interfaces/interface-briefs/interface-brief/bandwidth

NCS-55A2: IOS-XR 7.3.2

Model	Telemetry Path(s)
Cisco-IOS-XR-sysadmin-fretta-envmon-ui.yang	Cisco-IOS-XR-sysadmin-fretta-envmon-ui:environment/oper/power Specifically, in Grafana: - [...]/location/pem_attributes/system_power_input

Additionally, see table above, section Others.

NCS-5504: IOS-XR 7.2.2

See table below.

NCS-5508: IOS-XR 7.3.2

Model	Telemetry Path(s)
Cisco-IOS-XR-sysadmin-fretta-envmon-ui.yang	Cisco-IOS-XR-sysadmin-fretta-envmon-ui:environment/oper/power Specifically, in Grafana: - [...]/location/pem_attributes/power_consumed/value

Additionally, see table above, section Others.

ASR-9K

ASR-9001: IOS-XR 7.3.1

Model	Telemetry Path(s)	Observations
Cisco-IOS-XR-sysadmin-asr9k-envmon-ui.yang	- Cisco-IOS-XR-sysadmin-asr9k-envmon-ui:environment/oper/power/location - [...]/pem_attributes/input_power_to_ps - [...]/pem_attributes/output_power_from_ps - [...]/pem_attributes/power_resrv_and_alloc - [...]/pem_attributes/protection_power_capacity - [...]/pem_attributes/system_power_input - [...]/pem_attributes/system_power_used - [...]/pem_attributes/usable_power_capacity
	- Cisco-IOS-XR-sysadmin-asr9k-envmon-ui:environment/all/location - [...]/power/pem_attributes/power_allocated - [...]/power/pem_attributes/power_consumed - [...]/power/pem_attributes/power_level - [...]/power/pem_attributes/power_status
	- Cisco-IOS-XR-sysadmin-asr9k-envmon-ui:power-mgmt/config (no data here)
Cisco-IOS-XR-sdr-invmgr-diag-oper.yang	- Cisco-IOS-XR-sdr-invmgr-diag-oper:diag/racks/rack/power-shelfs/power-shelf/power-supplies/power-supply - Cisco-IOS-XR-sdr-invmgr-diag-oper:diag/racks/rack/slots (power-consumption per card instances of slot)
Cisco-IOS-XR-drivers-media-eth-oper.yang	- Cisco-IOS-XR-drivers-media-eth-oper:ethernet-interface/interfaces/interface/phy-info/phy-details/transceiver-tx-power - Cisco-IOS-XR-drivers-media-eth-oper:ethernet-interface/interfaces/interface/phy-info/phy-details/transceiver-rx-power	Optics
openconfig-platform.yang	- openconfig-platform:components/component/linecard/power-admin-state (not a measurement) - openconfig-platform:components/component/power-supply - openconfig-platform:components/component/state/allocated-power - openconfig-platform:components/component/state/used-power
	- openconfig-platform:components/component/transceiver/physical-channels/channel/state/input-power - openconfig-platform:components/component/transceiver/physical-channels/channel/state/output-power - openconfig-platform:components/component/transceiver/state/input-power - openconfig-platform:components/component/transceiver/state/output-power	Optical
Others: Cisco-IOS-XR-infra-statsd-oper.yang Cisco-IOS-XR-pfi-im-cmd-oper.yang	Cisco-IOS-XR-infra-statsd-oper:infra-statistics/interfaces/interface/total/data-rate/[input/output]-data-rate Cisco-IOS-XR-pfi-im-cmd-oper:interfaces/interface-briefs/interface-brief/type Cisco-IOS-XR-pfi-im-cmd-oper:interfaces/interface-briefs/interface-brief/state Cisco-IOS-XR-pfi-im-cmd-oper:interfaces/interface-briefs/interface-brief/bandwidth

ASR-9904: IOS-XR 7.3.2

ASR-9903: IOS-XR 7.3.2

Model	Telemetry Path(s)	Observations
Cisco-IOS-XR-sysadmin-asr9k-envmon-ui.yang	- Cisco-IOS-XR-sysadmin-asr9k-envmon-ui:environment/oper/power/location - [...]/pem_attributes/input_power_to_ps - [...]/pem_attributes/output_power_from_ps - [...]/pem_attributes/power_resrv_and_alloc - [...]/pem_attributes/protection_power_capacity - [...]/pem_attributes/system_power_input - [...]/pem_attributes/system_power_used - [...]/pem_attributes/usable_power_capacity
	- Cisco-IOS-XR-sysadmin-asr9k-envmon-ui:environment/all/location - [...]/power/pem_attributes/power_allocated - [...]/power/pem_attributes/power_consumed - [...]/power/pem_attributes/power_level - [...]/power/pem_attributes/power_status

Cisco 8201

IOS-XR 7.3.2 LNT

Model	Telemetry Path(s)	Observations
Cisco-IOS-XR-pwrmgmt-cfg.yang	Cisco-IOS-XR-pwrmgmt-cfg:power-management
Cisco-IOS-XR-envmon-cfg.yang	Cisco-IOS-XR-envmon-cfg:environmental-monitoring
Cisco-IOS-XR-envmon-oper.yang	- Cisco-IOS-XR-envmon-oper:environmental-monitoring - Cisco-IOS-XR-envmon-oper:environmental-monitoring/rack/nodes/node/sensor-types/sensor-type/sensor-names/sensor-name - Cisco-IOS-XR-envmon-oper:environmental-monitoring/rack/nodes/node/sensor-types/sensor-type/type - Cisco-IOS-XR-envmon-oper:environmental-monitoring/rack/nodes/node/sensor-types/sensor-type/type=power - Cisco-IOS-XR-envmon-oper:power-management - Cisco-IOS-XR-envmon-oper:power-management/rack/producers Specifically, in Grafana: - [...]/producer-node/pem_info_array/current_in_a - [...]/producer-node/pem_info_array/current_in_b - [...]/producer-node/pem_info_array/voltage_in_a - [...]/producer-node/pem_info_array/voltage_in_b - [...]/producer-node/pem_info_array/voltage_out - [...]/producer-node/pem_info_array/current_out - Cisco-IOS-XR-envmon-oper:power-management/rack/consumers/consumer-nodes - Cisco-IOS-XR-envmon-oper:power-management/rack/chassis
Cisco-IOS-XR-invmgr-oper.yang	- Cisco-IOS-XR-invmgr-oper:inventory/entities/entity/attributes/inv-basic-bag/allocated-power - Cisco-IOS-XR-invmgr-oper:inventory/entities/entity/attributes/inv-basic-bag/power-capacity - Cisco-IOS-XR-invmgr-oper:inventory/entities/entity/attributes/fru-info/power-administrative-state - Cisco-IOS-XR-invmgr-oper:inventory/entities/entity/attributes/fru-info/power-current-measurement - Cisco-IOS-XR-invmgr-oper:inventory/entities/entity/attributes/fru-info/power-administrative-state - Cisco-IOS-XR-invmgr-oper:inventory/entities/entity/attributes/inv-eeprom-info/eeprom/power-consumption - Cisco-IOS-XR-invmgr-oper:inventory/entities/entity/attributes/env-sensor-info[="Name of a power sensor?", e.g. 0/RP0/CPU0-MB_1_125V_IIN] - Cisco-IOS-XR-invmgr-oper:inventory/racks/rack
Cisco-IOS-XR-invmgr-diag-oper.yang	Cisco-IOS-XR-invmgr-diag-oper:diag/racks/rack/power-shelfs
Cisco-IOS-XR-plat-chas-invmgr-ng-oper	? cannot be resolved - has information only on "is-powered" state ?
Cisco-IOS-XR-controller-optics-oper.yang	Cisco-IOS-XR-controller-optics-oper:optics-oper/optics-ports/optics-port/optics-info/voltage	Optics
openconfig-platform.yang	- openconfig-platform:components/component/linecard/power-admin-state (not a measurement) - openconfig-platform:components/component/power-supply - openconfig-platform:components/component/state/allocated-power - openconfig-platform:components/component/state/used-power
Others: Cisco-IOS-XR-infra-statsd-oper.yang Cisco-IOS-XR-pfi-im-cmd-oper.yang Cisco-IOS-XR-invmgr-oper.yang	Cisco-IOS-XR-infra-statsd-oper:infra-statistics/interfaces/interface/total/data-rate/[input/output]-data-rate Cisco-IOS-XR-pfi-im-cmd-oper:interfaces/interface-briefs/interface-brief/type Cisco-IOS-XR-pfi-im-cmd-oper:interfaces/interface-briefs/interface-brief/state Cisco-IOS-XR-pfi-im-cmd-oper:interfaces/interface-briefs/interface-brief/bandwidth Cisco-IOS-XR-invmgr-oper:inventory/entities/entity/attributes/inv-basic-bag

IOS-XR 7.7.1 LNT

Same metrics as above.

Cisco-IOS-XR-envmon-oper:power-management/rack/producers/producer-node/pem_info_array/current_*|voltage_* changed data type: string -> integer.

IOS-XR 7.10.1 LNT

Same metrics as above.

Additional fields introduced:

Model	Telemetry Path(s)	Observations
Cisco-IOS-XR-envmon-oper.yang	Cisco-IOS-XR-envmon-oper:power-management/rack/producers - [...]/producer-node/pem_info_array/mcurrent_in_a - [...]/producer-node/pem_info_array/mcurrent_in_b - [...]/producer-node/pem_info_array/mvoltage_in_a** - [...]/producer-node/pem_info_array/mvoltage_in_b - [...]/producer-node/pem_info_array/mvoltage_out - [...]/producer-node/pem_info_array/mcurrent_out	Units of measurement in mA | mV. The initial fields current_in_a, current_in_b, voltage_in_a, voltage_in_b, current_out, voltage_out are now in A | V.

Power consumption ratio (PCR)

This measurement shows the ratio between the rate of power and the rate of data per second, or, inversely, between the rate of data and the rate of power.

$PCR = \frac{input\_power\_used}{[input | output\_]data\_rate} [\frac{W}{Gbps}]$

Answers the question: How much power is used for 1 Gbps data rate?