IPMCTL-SHOW-REGION(1)

💖 ipmctl-show-region — bestie edition 💖

okay so this is a page from the ipmctl manual, and it's literally all about showing you the persistent memory regions your server is holding. grab a snack, we're doing this. 🍓

---

✨ NAME ✨

ipmctl-show-region — pulls up a whole list of persistent memory regions. that's it, that's the job. 👑

---

🌸 SYNOPSIS 🌸

ipmctl show [OPTIONS] -region [TARGETS]

---

🦋 DESCRIPTION 🦋

It retrieves a list of persistent memory regions made of PMem module capacity. so like, the regions? it lists them. for you. no cap. ✨

---

💅 OPTIONS 💅

• -a, -all — shows every single attribute. the full tea, nothing held back.

Note: the all and display options are exclusive and may not be used together. pick one, bestie, you can't have both. 🙈

• -d (attributes), -display (attributes) — filters the attributes that come back by you explicitly handing over a comma separated list of any of the attributes defined in the Return Data section. you're the curator now. 🎀

Note: the all and display options are exclusive and may not be used together. fr fr.

• -h, -help — displays help for the command. when in doubt, ask the command itself. iconic behaviour honestly.
• -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 giving "choose your fighter". 💀

• -lpmb — used to specify large transport payload size for the current invocation of ipmctl.
• -spmb — used to specify small transport payload size for the current invocation of ipmctl.

Note: the -lpmb and -spmb options are mutually exclusive and may not be used together. again. one or the other. periodt.

• -nfit — used to specify NFIT table as the source instead of PCD (default) for the current invocation of ipmctl. spicy alternative source energy. 🔥
• -o (text|nvmxml), -output (text|nvmxml) — changes the output format. one of: "text" (default) or "nvmxml".
• -u (B|MB|MiB|GB|GiB|TB|TiB), -units (B|MB|MiB|GB|GiB|TB|TiB) — changes the units that capacities are displayed in for this command. one of: bytes (B), megabytes (MB), mebibytes (MiB), gigabytes (GB), gibibytes (GiB), terabytes (TB) or tebibytes (TiB). so many units, so little time. 🌈

---

🎀 TARGETS 🎀

• -socket [SocketIDs] — restricts output to the persistent memory regions on specific sockets by supplying the socket target and one or more comma separated socket identifiers. the default is to display all sockets. (yes, all of them. every last one. 🫶)

---

⭐ EXAMPLES ⭐

shows all attributes of all persistent memory regions in the server:

ipmctl show -a -region

---

💀 LIMITATIONS 💀

in order to successfully execute this command:

• the caller must have the appropriate privileges. no privileges, no regions, sorry bestie. 🔐
• all the underlying PMem modules should be unlocked to accurately reflect the available capacities. the specified PMem modules must be manageable by the host software.

---

👑 RETURN DATA 👑

the default behavior is to display a table with the default attributes listed below; applying options changes the output to a more detailed format. glow-up via flags, basically. ✨

• ISetID — (default) the region unique identifier. also known as interleave set cookie. 🍪 yes really, a cookie.
• PersistentMemoryType — (default) a comma separated list of the underlying types of persistent memory capacity in the region. one or more of:
  • AppDirect: App Direct capacity interleaved across two or more PMem modules that is fully mapped into the system physical address space.
  • AppDirectNotInterleaved: App Direct capacity wholly contained on a single PMem modules that is fully mapped into the system physical address space.
• Capacity — (default) total usable capacity, both allocated and unallocated.
• FreeCapacity — (default) remaining usable capacity. the leftovers. 🍓
• SocketID — (default) socket ID to which the region belongs.
• HealthState — the rolled up health of the underlying PMem modules. one of:
  • Unknown: the region health cannot be determined. 🤷
  • Healthy: all underlying PMem module persistent memory capacity is available. we love to see it.
  • Pending: a new memory allocation goal has been created but not applied. reboot or delete any existing memory allocation goals before creating namespaces on the region.
  • Error: there is an issue with some or all of the underlying PMem module capacity because the interleave set has failed. one of:
    • PMem module missing (serial number of PMem module from the Platform Config Data not found in the PMem module list)
    • PMem module not configured
    • failure to retrieve AppDirect I/O structures from NFIT (system physical address missing)
    • interleave set or PMem module region initialization failure (out of memory)
  • Locked: one or more of the of the underlying PMem modules are locked. 🔒
• DimmID — a list of all the PMem modules that are part of this reg.

---

that's the whole page, bestie, you ate it. 💅 this one's from the ipmctl manual, dated 2024-04-22, and it's page IPMCTL-SHOW-REGION(1) if you ever need to find it again. mwah. 💖🦋✨