1IPMCTL-LOAD-GOAL(1) ipmctl IPMCTL-LOAD-GOAL(1)
2
6 ipmctl-load-goal - Creates a memory allocation goal request from a file
7
9 ipmctl load [OPTIONS] -source (path) -goal [TARGETS]
10
12 Creates a memory allocation goal request from a file onto one or more
13 PMem modules.
14 Note
16 Deleting the PCD can be used as a way to prepare individual PMem
17 modules for provisioning. See the delete -pcd command.
18 Warning
20 This command may result in data loss. Data should be backed up to
21 other storage before executing this command.
22 Note
24 Changing a memory allocation goal modifies how the platform
25 firmware maps persistent memory in the System Physical Address
26 space (SPA) which may result in data loss or inaccessible data, but
27 does not explicitly delete or modify user data found in persistent
28 memory.
29
31 -f, -force
32 Reconfiguring PMem modules is a destructive operation which
33 requires confirmation from the user. This option suppresses the
34 confirmation. The force flag will also suppress the security
35 enabled warning as well as all other warning prompts.
36 -h, -help
38 Displays help for the command.
39 -ddrt
41 Used to specify DDRT as the desired transport protocol for the
42 current invocation of ipmctl.
43 -smbus
45 Used to specify SMBUS as the desired transport protocol for the
46 current invocation of ipmctl.
47 Note
49 The -ddrt and -smbus options are mutually exclusive and may not be
50 used together.
51 -lpmb
53 Used to specify large transport payload size for the current
54 invocation of ipmctl.
55 -spmb
57 Used to specify small transport payload size for the current
58 invocation of ipmctl.
59 Note
61 The -lpmb and -spmb options are mutually exclusive and may not be
62 used together.
63 -o (text|nvmxml), -output (text|nvmxml)
65 Changes the output format. One of: "text" (default) or "nvmxml".
66 The "nvmxml" format implies the "-force" flag.
67 -u (B|MB|MiB|GB|GiB|TB| TiB), -units (B|MB|MiB|GB|GiB|TB| TiB)
69 Changes the units that capacities are displayed in for this
70 command. One of: bytes (B), megabytes (MB), mebibytes (MiB),
71 gigabytes (GB), gibibytes (GiB), terabytes (TB) or tebibytes (TiB).
72
74 -dimm [DimmIDs]
75 Loads the memory allocation goal onto specific PMem modules by
76 supplying one or more comma separated PMem module identifiers. This
77 list must include all unconfigured PMem modules on the affected
78 sockets. The default is to load the memory allocation goal onto all
79 manageable PMem modules.
80 -socket [SocketIDs]
82 Loads the memory allocation goal onto all manageable PMem modules
83 on specific sockets by supplying the socket target and one or more
84 comma separated socket identifiers. The default is to load the
85 memory allocation goal onto all manageable PMem modules on all
86 sockets.
87
89 Loads the configuration settings stored in "config.txt" onto all the
90 PMem modules in the system as a memory allocation goal to be applied by
91 the BIOS on the next reboot.
92 ipmctl load -source config.txt -goal
94 Loads the configuration settings stored in "config.txt" onto a
96 specified set of PMem modules as a memory allocation goal to be applied
97 by the BIOS on the next reboot.
98 ipmctl load -source config.txt -goal -dimm 1,2,3
100 Loads the configuration settings stored in "config.txt" onto all
102 manageable PMem modules on sockets 1 and 2 as a memory allocation goal
103 to be applied by the BIOS on the next reboot.
104 ipmctl load -source config.txt -goal -socket 1,2
106
108 In order to successfully execute this command:
109 • The caller must have the appropriate privileges.
111 • The specified PMem modules must be manageable by the host software
113 and must all have the same SKU.
114 • SKU based maximum total mapped memory is enforced. See section [CPU
116 Maximum Mapped Memory Limiting].
117 • Existing memory allocation goals that have not been applied and any
119 namespaces associated with the requested PMem modules must be
120 deleted before running this command.
121 • Goal requests may not be applied by platform firmware (BIOS) if the
123 PMem module is in security enabled, locked state.
124 Note
126 It is recommended to disable security prior to reboot if requesting
127 a new goal.
128 Note
130 A goal request may be initiated even if a target PMem module is in
131 security state enabled, but care must be taken to ensure the PMem
132 module is in either unlocked or disabled security state prior to
133 the platform firmware (BIOS) provisioning flow following a reboot.
134 In addition, a warning will be presented to the user: WARNING: Goal
135 will not be applied unless security is disabled prior to platform
136 firmware (BIOS) provisioning!
137 • Changing the memory configuration is a destructive operation which
139 results in loss of data stored in the persistent memory region.
140 Therefore, data should be backed up to other storage before
141 executing this command. Targets may be limited to individual PMem
142 modules or sockets, but all PMem modules on affected sockets must
143 be configured when the command finishes. If the selected targets
144 make this impossible, the command will be rejected. Refer to [Show
145 System Capabilities] for a list of BIOS supported modes.
146 • Some requests are dependent on BIOS and/or platform configuration.
148 For details, see the Intel® Optane™ DC Persistent Memory Software
149 Memory Allocation Rules Specification for Windows, Linux and UEFI,
150 document number 564194. For example:
151 • Provisioning PMem modules for Memory Mode while BIOS is
153 configured for 1LM only will result in unused capacity.
154 • Provisioning PMem modules for Memory Mode while not all iMCs
156 have at least one PMem module will result in unused capacity.
157
159 If successful, the CLI will display the memory allocation goal stored
160 on each PMem module as documented in the command Section [Show Memory
161 Allocation Goal]. If a failure occurs, an error code and message will
162 be displayed. If a failure occurs when configuring multiple PMem
163 modules, the process will exit and remove the memory allocation goal
164 from any PMem modules that succeeded prior to the failure.
165ipmctl 2023-07-20 IPMCTL-LOAD-GOAL(1)