1IPMCTL-DUMP-GOAL(1)                 ipmctl                 IPMCTL-DUMP-GOAL(1)
2
3
4

NAME

6       ipmctl-dump-goal - Stores the current configured memory allocation
7       settings to a file
8

SYNOPSIS

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

DESCRIPTION

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

OPTIONS

19       -h, -help
20           Displays help for the command.
21
22       -ddrt
23           Used to specify DDRT as the desired transport protocol for the
24           current invocation of ipmctl.
25
26       -smbus
27           Used to specify SMBUS as the desired transport protocol for the
28           current invocation of ipmctl.
29
30           Note
31           The -ddrt and -smbus options are mutually exclusive and may not be
32           used together.
33
34       -lpmb
35           Used to specify large transport payload size for the current
36           invocation of ipmctl.
37
38       -spmb
39           Used to specify small transport payload size for the current
40           invocation of ipmctl.
41
42           Note
43           The -lpmb and -spmb options are mutually exclusive and may not be
44           used together.
45
46       -o (text|nvmxml), -output (text|nvmxml)
47           Changes the output format. One of: "text" (default) or "nvmxml".
48

EXAMPLES

50       Stores the memory allocation settings from all the PMem modules into
51       the file "config.txt".
52
53           ipmctl dump -destination config.txt -system -config
54

LIMITATIONS

56       In order to successfully execute this command:
57
58       •   The caller must have the appropriate privileges.
59
60       •   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

RETURN DATA

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
71       The output file is formatted as an ASCII file with one row per PMem
72       module containing the following comma separated values.
73
74       SocketID
75           Identifier for the socket the PMem module is associated with.
76
77       DimmHandle
78           PMem module device handle.
79
80       Capacity
81           Total capacity of the PMem module in GiB.
82
83       MemorySize
84           Capacity of the PMem module allocated as Memory Mode in GiB.
85
86       AppDirect1Size
87           Capacity of the PMem module allocated for the first App Direct
88           interleave set in GiB.
89
90       AppDirect1Format
91           Bit mask representing the interleave format of the first App Direct
92           interleave set.
93
94       AppDirect1Index
95           Unique index of the first App Direct interleave set.
96
97       AppDirect2Size
98           Capacity of the PMem module allocated for the second App Direct
99           interleave set in GiB.
100
101       AppDirect2Format
102           Bit mask representing the interleave format of the second App
103           Direct interleave set.
104
105       AppDirect2Index
106           Unique index of the second App Direct interleave set.
107

SAMPLE OUTPUT

109           Successfully dumped system configuration to file: config.csv
110
111       config.csv contents:
112
113           #SocketID,DimmHandle,Capacity,MemorySize,AppDirect1Size,AppDirect
114           1Format,AppDirect1Index,AppDirect2Size,AppDirect2Format,AppDirect2Index
115           1,4385,64,64,0,0,0,0,0,0
116           1,4401,64,64,0,0,0,0,0,0
117           1,4417,64,64,0,0,0,0,0,0
118           1,4433,64,64,0,0,0,0,0,0
119           1,4449,64,64,0,0,0,0,0,0
120
121
122
123ipmctl                            2023-01-19               IPMCTL-DUMP-GOAL(1)