IPMCTL-SHOW-SENSOR(1)

📦
version 03.00.00.0485 · 6 versions
, in ubuntu noble, ubuntu questing

💖 ipmctl-show-sensor — bestie edition 💖

okay so this is a page from the ipmctl manual — that's the Intel Optane PMem management tool, iykyk — and it's all about the ipmctl-show-sensor command. sit down, grab a strawberry drink 🍓, and let's get into it.

✨ NAME ✨

ipmctl-show-sensor — shows sensor data for one or more PMem modules 🦋

✨ SYNOPSIS ✨

ipmctl show [OPTIONS] -sensor [SENSORS] [TARGETS]

that's the whole vibe, no cap.

✨ DESCRIPTION ✨

so basically this command shows you the sensor data for one or more PMem modules. and like, it's not just one little number — it's the whole health report, bestie. 💅

the data includes PMem module health, temperatures, percentage remaining, up-time and more. it's giving "full checkup at the doctor but make it firmware." 👑

✨ OPTIONS ✨

  • -a, -all — shows all the attributes. everything. the full tea. 🫖
note: the all and display options are exclusive and may not be used together. pick a lane bestie, you literally cannot have both. 💀
  • -d (attributes), -display (attributes) — filters the returned attributes by explicitly specifying a comma separated list of any of the attributes defined in the Return Data section. so you're like "girl, just give me these ones." 🎀
note: the all and display options are exclusive and may not be used together. (yes, again. it's that serious.)
  • -h, -help — displays help for the command. when in doubt, ask for help. self care fr fr. 💜
  • -ddrt — used to specify DDRT as the desired transport protocol for the current invocation of ipmctl.
  • -smbus — used to specify SMBUS as the desired transport protocol for the current invocation of ipmctl.
note: the -ddrt and -smbus options are mutually exclusive and may not be used together. it's one or the other, babe, no situationships with protocols. 😭
  • -o (text|nvmxml), -output (text|nvmxml) — changes the output format. one of: "text" (default) or "nvmxml". so you can have it plain or you can have it ✨xml✨.

✨ SENSORS ✨

here's the sensor menu, bestie. the ones marked default are the ones you get when you don't ask for anything specific — like a preset order. 🌸

🌈 Health

(default) the current PMem module health as reported in the SMART log. attributes include:

  • DimmID
  • Type
  • CurrentValue

🌡️ MediaTemperature

(default) the current PMem module media temperature in Celsius. attributes include:

  • DimmID
  • Type
  • CurrentValue
  • AlarmThreshold
  • AlarmEnabled
  • ThrottlingStopThreshold
  • ThrottlingStartThreshold
  • ShutdownThreshold
  • MaxTemperature

🎛️ ControllerTemperature

(default) the current PMem module controller temperature in Celsius. attributes include:

  • DimmID
  • Type
  • CurrentValue
  • AlarmThreshold
  • AlarmEnabled
  • ThrottlingStopThreshold
  • ThrottlingStartThreshold
  • ShutdownThreshold
  • MaxTemperature

🍓 PercentageRemaining

(default) remaining PMem module's life as a percentage value of factory expected life span. lowkey the "how much juice is left in your soul" metric. attributes include:

  • DimmID
  • Type
  • CurrentValue
  • AlarmThreshold
  • AlarmEnabled

💀 LatchedDirtyShutdownCount

(default) the number of shutdowns without notification over the lifetime of the PMem module. attributes include:

  • DimmID
  • Type
  • CurrentValue

🙈 UnlatchedDirtyShutdownCount

(default) the number of shutdowns without notification over the lifetime of the PMem module. this counter is the same as LatchedDirtyShutdownCount except it will always be incremented on a dirty shutdown, even if Latch System Shutdown Status was not enabled. attributes include:

  • DimmID
  • Type
  • CurrentValue

⏰ PowerOnTime

(default) the total power-on time over the lifetime of the PMem module. attributes include:

  • DimmID
  • Type
  • CurrentValue

⏳ UpTime

(default) the total power-on time since the last power cycle of the PMem module. attributes include:

  • DimmID
  • Type
  • CurrentValue

🔄 PowerCycles

(default) the number of power cycles over the lifetime of the PMem module. attributes include:

  • DimmID
  • Type
  • CurrentValue

🐛 FwErrorCount

(default) the total number of firmware error log entries. attributes include:

  • DimmID
  • Type
  • CurrentValue

✨ TARGETS ✨

  • -dimm [DimmIDs] — restricts output to the sensors on specific PMem modules by supplying the DIMM target and one or more comma separated PMem module identifiers. the default is to display sensors for all manageable PMem modules. so if you don't say anything, it's giving everyone's business. 👀

✨ EXAMPLES ✨

gets all sensor information for all PMem modules. the whole squad, no filter:

ipmctl show -sensor

shows the media temperature sensor for the specified PMem module. just the one, main character energy:

ipmctl show -sensor MediaTemperature -dimm 0x0001

✨ LIMITATIONS ✨

in order to successfully execute this command, bestie:

  • the caller must have the appropriate privileges. 🔑
  • the specified PMem modules must be manageable by the host software.

that's it. no shortcuts, no sneaking in. 🚪

✨ RETURN DATA ✨

this command displays a table with a row for each sensor on each PMem module. applying a specific PMem module or sensor type target limits the number of rows. applying options can be used to expand or restrict the output. so like — narrow it down or open it up, your call. 💅

note: supported thresholds for a given sensor are listed as a part of the return data when using the -all or -display flag. only the alarm threshold is settable. the rest are just... there. read-only girlies. 🙈

DimmID

(default) the PMem module identifier

Type

(default) the sensor type. refer to the sensor table above. ⬆️

CurrentValue

(default) the current reading followed by the units of measurement (e.g., 57 °C or 25%)

AlarmThreshold

the threshold value at which an alarm for the respective sensor will be triggered. 🚨

AlarmEnabled

current state of the alarm threshold, where applicable. one of:

  • 0: Disabled
  • 1: Enabled
  • N/A

ThrottlingStopThreshold

the threshold value at which firmware will stop throttling to reduce overall thermals and keep the PMem module within safe operating temperatures. it's cooling down, periodt. ❄️

ThrottlingStartThreshold

the threshold value at which firmware will start throttling to reduce overall thermals and keep the PMem module within safe operating temperatures. and this is where it starts. 🔥

ShutdownThreshold

the threshold value at which device shutdown will occur. 💀

MaxTemperature

the highest temperature reported in degrees Celsius for a given media or controller sensor. this value is persistent through Power Loss and is read-only. it does not forget, and it does not change. iconic behaviour honestly. 👑

and that's the page!! 💖 this was ipmctl (that's the source/version, the whole tool it lives under), and it's dated 2024-04-22 — so like, vintage in internet years but still slaying. go check your sensors bestie, drink water, and don't use -all with -display or the mutual exclusivity police will get you 🫶✨

📦 where this page comes from