IPMCTL-SHOW-GOAL(1)

💖 IPMCTL-SHOW-GOAL(1) 💖

okay bestie, welcome to the ipmctl manual page, this one's called ipmctl-show-goal and it's literally about seeing the memory allocation goal on your PMem modules. yes, the whole page. get comfy, grab a boba, let's go ✨

---

🌸 NAME 🌸

ipmctl-show-goal — shows the memory allocation goal on one or more PMem modules. that's it. that's the whole job. she's simple, she's iconic 👑

---

🎀 SYNOPSIS 🎀

ipmctl show [OPTIONS] -goal [TARGETS] [PROPERTIES]

---

🦋 DESCRIPTION 🦋

So here's the tea bestie: this command shows you the memory allocation goal on one or more PMem modules. ✨

But here's the plot twist — the second the goal gets successfully applied by the platform firmware (BIOS), it is no longer displayed. like, she's gone, she did her job, she's moved on. periodt. 💅

If you want the system-wide memory resources instead, go hit up the command [Show Memory Resources]. And if you want the detailed persistent memory info, that's the command [Show Persistent Memory]. iykyk 🫶

---

✨ OPTIONS ✨

• -a, -all — shows all the attributes. everything. the whole wardrobe. 👑

Note 📌 — the all and display options are exclusive and may not be used together. pick a lane bestie, you can't 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. like a little shopping list for data. 🛍️

Note 📌 — the all and display options are exclusive and may not be used together. same rule, no cap.

• -h, -help — displays help for the command. when in doubt, ask her for help, she's not judgy 🥺
• -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 one or the other", fr fr.

• -o (text|nvmxml), -output (text|nvmxml) — changes the output format. one of: "text" (default) or "nvmxml". glow-up for your terminal output 🌈
• -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). yes all seven, she contains multitudes 💜

---

🎯 TARGETS 🎯

• -dimm [DimmIDs] — restricts output to specific PMem modules by supplying one or more comma separated PMem module identifiers. the default is to display all manageable PMem modules with memory allocation goals.
• -socket [SocketIDs] — restricts output to the PMem modules on specific sockets by supplying the socket target and one or more comma separated socket identifiers. the default is to display all manageable PMem modules on all sockets with memory allocation goals. socket by socket, we love a targeted queen 🦋

---

🌈 EXAMPLES 🌈

shows the default memory allocation goal attributes for each PMem module:

ipmctl show -goal

shows all the memory allocation goal attributes for the PMem modules on socket 1:

ipmctl show -a -goal -socket 1

---

💀 LIMITATIONS 💀

in order to successfully execute this command, there are rules, bestie, and we respect them:

• the caller must have the appropriate privileges. sorry, no guest access 💅
• 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 for each PMem module; applying options changes the output to a more detailed format. main character energy ✨

• SocketID — (Default) the processor socket identifier where the PMem module is installed.
• DimmID — (Default) the PMem module identifier.
• MemorySize — (Default) the PMem module capacity that will be configured in Memory Mode.
• AppDirect1Size — (Default) the PMem module capacity that will be configured as the first App Direct interleave set if applicable.
• AppDirect1Index — unique identifier of the first App Direct interleave set.
  • N/A: if no App Direct interleave set
  • numeric value if App Direct interleave set is present.
• AppDirect1Settings — the settings for the first App Direct interleave set in the format: x(Way) [- (Size) iMC] [x (Size) Channel]
• AppDirect2Size — (Default) the PMem module capacity that will be configured as the second App Direct interleave set if applicable.
• AppDirect2Index — unique identifier of the second App Direct interleave set.
  • N/A: if no App Direct interleave set
  • numeric value if App Direct interleave set is present.
• AppDirect2Settings — the settings for the second App Direct interleave set in the format: x(Way) [- (Size) iMC] [x (Size) Channel]
• Status — the status of the memory allocation goal. one of:
  • Unknown: the status cannot be determined. 🫠
  • New: a reboot is required for the memory allocation goal to be processed by the BIOS.
  • Failed - Bad request: the BIOS failed to process the memory allocation goal because it was invalid.
  • Failed - Not enough resources: there were not enough resources for the BIOS to process the memory allocation goal.
  • Failed - Firmware error: the BIOS failed to process the memory allocation goal due to a firmware error.
  • Failed - Unknown: the BIOS failed to process the memory allocation goal due to an unknown error.

---

🍓 SAMPLE OUTPUT 🍓

if a new memory allocation goal has been created, a prompt to reboot will be presented. and honestly? she'll be very polite about it 💅

A reboot is required to process new memory allocation goals.

---

and that's the whole page bestie, you ate that 💅✨ this was ipmctl, dated 2024-04-22, page IPMCTL-SHOW-GOAL(1) — go forth and show those goals, you've got this fr fr 🫶👑