IPMCTL-DUMP-GOAL(1)

✨ IPMCTL-DUMP-GOAL ✨ (that's section 1 of the ipmctl manual, bestie 💖)

🌸 NAME 🌸

ipmctl-dump-goal — saves your current memory allocation settings to a file 💾✨

---

🎀 SYNOPSIS 🎀

ipmctl dump [OPTIONS] -destination (path) -system -config

---

🦋 DESCRIPTION 🦋

okay so here's the vibe: this command stores the memory allocation settings you've currently got configured, for every single PMem module in the system, and writes them out to a file — so you can go replicate that exact configuration somewhere else. slay, right? 💅

Then when you wanna apply those saved settings again, you use the command Section [Load Memory Allocation Goal]. periodt. 🔥

---

✨ OPTIONS ✨

• -h, -help — shows you the help for this command. the little "wait what does this do again" button 🫶
• -ddrt — specifies DDRT as the transport protocol you want for this particular invocation of ipmctl.
• -smbus — specifies SMBUS as the transport protocol you want for this particular invocation of ipmctl.

⚠️ Note bestie: -ddrt and -smbus are mutually exclusive — you literally cannot use them together. pick one, queen 👑

• -lpmb — specifies large transport payload size for this invocation of ipmctl.
• -spmb — specifies small transport payload size for this invocation of ipmctl.

⚠️ Note again: -lpmb and -spmb are mutually exclusive too. no mixing, no matching, no exceptions 💀

• -o (text|nvmxml), -output (text|nvmxml) — changes the output format. one of: "text" (which is the default, iykyk) or "nvmxml".

---

🌈 EXAMPLES 🌈

stores the memory allocation settings from all the PMem modules into the file "config.txt":

ipmctl dump -destination config.txt -system -config

ate. no notes. 🍓

---

💜 LIMITATIONS 💜

for this command to actually go off successfully:

• the caller must have the appropriate privileges. no privileges, no dump, sorry babe 🙈
• only memory allocation settings for manageable PMem modules that have been successfully applied by the BIOS get stored in the file. unconfigured PMem modules are not included, and neither are memory allocation goals that haven't been applied. it's giving "if BIOS didn't do it, it's not in the file" 🫶

---

👑 RETURN DATA 👑

The CLI will tell you the overall status of the operation once it's done. and if a failure happens while dumping the memory allocation from multiple PMem modules? the process just stops, and the output file gets removed. gone. deleted. not me crying over a half-written config 😭

The output file is formatted as an ASCII file with one row per PMem module, and each row has these comma separated values:

• SocketID — identifier for the socket the PMem module is associated with.
• DimmHandle — PMem module device handle.
• Capacity — total capacity of the PMem module, in GiB.
• MemorySize — capacity of the PMem module allocated as Memory Mode, in GiB.
• AppDirect1Size — capacity of the PMem module allocated for the first App Direct interleave set, in GiB.
• AppDirect1Format — bit mask representing the interleave format of the first App Direct interleave set.
• AppDirect1Index — unique index of the first App Direct interleave set.
• AppDirect2Size — capacity of the PMem module allocated for the second App Direct interleave set, in GiB.
• AppDirect2Format — bit mask representing the interleave format of the second App Direct interleave set.
• AppDirect2Index — unique index of the second App Direct interleave set.

---

⭐ SAMPLE OUTPUT ⭐

Successfully dumped system configuration to file: config.csv

contents of config.csv:

#SocketID,DimmHandle,Capacity,MemorySize,AppDirect1Size,AppDirect
1Format,AppDirect1Index,AppDirect2Size,AppDirect2Format,AppDirect2Index
1,4385,64,64,0,0,0,0,0,0
1,4401,64,64,0,0,0,0,0,0
1,4417,64,64,0,0,0,0,0,0
1,4433,64,64,0,0,0,0,0,0
1,4449,64,64,0,0,0,0,0,0

---

and that's the whole page, bestie 🫶 this one's from the ipmctl girlies, dated 2024-04-22, and yes it's still section 1 — IPMCTL-DUMP-GOAL(1), no cap 💖✨