1IPMCTL-DUMP-GOAL(1) ipmctl IPMCTL-DUMP-GOAL(1)
2
6 ipmctl-dump-goal - Stores the current configured memory allocation
7 settings to a file
8
10 ipmctl dump [OPTIONS] -destination (path) -system -config
11
13 Store the currently configured memory allocation settings for all PMem
14 modules in the system to a file in order to replicate the configuration
15 elsewhere. Apply the stored memory allocation settings using the
16 command Section [Load Memory Allocation Goal].
17
19 -h, -help
20 Displays help for the command.
21 -ddrt
23 Used to specify DDRT as the desired transport protocol for the
24 current invocation of ipmctl.
25 -smbus
27 Used to specify SMBUS as the desired transport protocol for the
28 current invocation of ipmctl.
29 Note
31 The -ddrt and -smbus options are mutually exclusive and may not be
32 used together.
33 -lpmb
35 Used to specify large transport payload size for the current
36 invocation of ipmctl.
37 -spmb
39 Used to specify small transport payload size for the current
40 invocation of ipmctl.
41 Note
43 The -lpmb and -spmb options are mutually exclusive and may not be
44 used together.
45 -o (text|nvmxml), -output (text|nvmxml)
47 Changes the output format. One of: "text" (default) or "nvmxml".
48
50 Stores the memory allocation settings from all the PMem modules into
51 the file "config.txt".
52 ipmctl dump -destination config.txt -system -config
54
56 In order to successfully execute this command:
57 • The caller must have the appropriate privileges.
59 • Only memory allocation settings for manageable PMem modules that
61 have been successfully applied by the BIOS are stored in the file.
62 Unconfigured PMem modules are not included, nor are memory
63 allocation goals that have not been applied.
64
66 The CLI will indicate the overall status of the operation when
67 complete. If a failure occurs when dumping the memory allocation from
68 multiple PMem modules, the process will stop and the output file will
69 be removed.
70 The output file is formatted as an ASCII file with one row per PMem
72 module containing the following comma separated values.
73 SocketID
75 Identifier for the socket the PMem module is associated with.
76 DimmHandle
78 PMem module device handle.
79 Capacity
81 Total capacity of the PMem module in GiB.
82 MemorySize
84 Capacity of the PMem module allocated as Memory Mode in GiB.
85 AppDirect1Size
87 Capacity of the PMem module allocated for the first App Direct
88 interleave set in GiB.
89 AppDirect1Format
91 Bit mask representing the interleave format of the first App Direct
92 interleave set.
93 AppDirect1Mirrored
95 State indicating if the first App Direct interleave set is
96 mirrored.
97 • 0 - The first App Direct interleave set is not mirrored.
99 • 1 - The first App Direct interleave set is mirrored.
101 AppDirect1Index
103 Unique index of the first App Direct interleave set.
104 AppDirect2Size
106 Capacity of the PMem module allocated for the second App Direct
107 interleave set in GiB.
108 AppDirect2Format
110 Bit mask representing the interleave format of the second App
111 Direct interleave set.
112 AppDirect2Mirrored
114 State indicating if the second App Direct interleave set is
115 mirrored.
116 • 0 - The second App Direct interleave set is not mirrored.
118 • 1 - The second App Direct interleave set is mirrored.
120 AppDirect2Index
122 Unique index of the second App Direct interleave set.
123
125 Successfully dumped system configuration to file: config.csv
126 config.csv contents:
128 #SocketID,DimmHandle,Capacity,MemorySize,AppDirect1Size,AppDirect
130 1Format,AppDirect
131 1Mirrored,AppDirect1Index,AppDirect2Size,AppDirect2Format,AppDire
132 ct2Mirrored,AppDirect2Index
133 1,4385,64,64,0,0,0,0,0,0,0,0
134 1,4401,64,64,0,0,0,0,0,0,0,0
135 1,4417,64,64,0,0,0,0,0,0,0,0
136 1,4433,64,64,0,0,0,0,0,0,0,0
137 1,4449,64,64,0,0,0,0,0,0,0,0
138ipmctl 2022-02-01 IPMCTL-DUMP-GOAL(1)