1IPMCTL-CREATE-GOAL(1) ipmctl IPMCTL-CREATE-GOAL(1)
2
6 ipmctl-create-goal - Creates a memory allocation goal on one or more
7 DCPMM
8
10 ipmctl create [OPTIONS] -goal [TARGETS] [PROPERTIES]
11
13 Creates a memory allocation goal on one or more for the BIOS to read on
14 the next reboot in order to map the DCPMM capacity into the system
15 address space. Persistent memory can then be utilized by creating a
16 namespace.
17 Note
19 The capacity values presented by this command are a target goal or
20 request to platform firmware. The actual capacity values are
21 subject to change due to rounding and alignment requirements. If
22 the goal request is invalid or not possible it may be rejected by
23 platform firmware.
24 Note
26 Deleting the PCD can be used as a way to prepare individual DCPMMs
27 for provisioning. See the delete -pcd command.
28 Unresolved directive in ipmctl-create-goal.txt -
30 include::../ipmctl-change-goal-config-warning.txt[]
31
33 -f, -force
34 Reconfiguring DCPMMs is a destructive operation which requires
35 confirmation from the user. This option suppresses the
36 confirmation.
37 -h, -help
39 Displays help for the command.
40 -o (text|nvmxml), -output (text|nvmxml)
42 Changes the output format. One of: "text" (default) or "nvmxml".
43 -u (B|MB|MiB|GB|GiB|TB| TiB), -units (B|MB|MiB|GB|GiB|TB| TiB)
45 Changes the units that capacities are displayed in for this
46 command. One of: bytes (B), megabytes (MB), mebibytes (MiB),
47 gigabytes (GB), gibibytes (GiB), terabytes (TB) or tebibytes (TiB).
48
50 -dimm [(DimmIDs)]
51 Creates a memory allocation goal on specific DCPMMs by optionally
52 supplying one or more comma-separated DCPMM identifiers. This list
53 must include all unconfigured DCPMMs on the affected socket(s). The
54 default is to configure all manageable DCPMMs on all sockets.
55 -socket (SocketIds)
57 Creates the memory allocation goal onto all manageable DCPMMs on
58 specific sockets by supplying the socket target and one or more
59 comma-separated socket identifiers. The default is to create the
60 memory allocation goal onto all manageable DCPMMs on all sockets.
61
63 MemoryMode
64 Percentage of the total capacity to use in Memory Mode (0-100).
65 Default = 0.
66 PersistentMemoryType
68 If MemoryMode is not 100%, the type of persistent memory to create.
69 · "AppDirect": (Default) Create App Direct capacity utilizing
71 hardware interleaving across the requested DCPMMs if applicable
72 given the specified target.
73 · "AppDirectNotInterleaved": Create App Direct capacity that is
75 not interleaved any other DCPMMs.
76 NamespaceLabelVersion
78 The version of the namespace label storage area (LSA) index block
79 · "1.2": (Default) Defined in UEFI 2.7a - sections 13.19
81 · "1.1": Legacy 1.1 namespace label support
83 Reserved
85 Reserve a percentage (0-100) of the requested DCPMM App Direct
86 capacity that will not be mapped into the system physical address
87 space and will be presented as Reserved Capacity with Show Device
88 and Show Memory Resources Commands.
89
91 Configures all the DCPMM capacity in Memory Mode.
92 ipmctl create -goal MemoryMode=100
94 Configures all the DCPMM capacity as App Direct.
96 ipmctl create -goal PersistentMemoryType=AppDirect
98 Configures the capacity on each DCPMM with 20% of the capacity in
100 Memory Mode and the remaining as App Direct capacity that does not use
101 hardware interleaving.
102 ipmctl create -goal MemoryMode=20 PersistentMemoryType=AppDirectNotInterleaved
104 Configures the DCPMM capacity across the entire system with 25% of the
106 capacity in Memory Mode, 25% reserved and the remaining 50% as App
107 Direct. Configures the DCPMM capacity across the entire system with 25%
108 of the capacity in Memory Mode and the remaining 75% as App Direct.
109 ipmctl create -goal MemoryMode=25 PersistentMemoryType=AppDirect Reserved=25
111
113 In order to successfully execute this command:
114 · The caller must have the appropriate privileges.
116 · The specified DCPMM(s) must be manageable by the host software and
118 must all have the same SKU.
119 · Existing memory allocation goals that have not been applied and any
121 namespaces associated with the requested DCPMM(s) must be deleted
122 before running this command.
123 · Security state must be disabled. Changing the memory configuration
125 is a destructive operation which results in loss of data stored in
126 the persistent memory region. Therefore, data should be backed up
127 to other storage before executing this command. Targets may be
128 limited to individual DCPMMs or sockets, but all DCPMMs on affected
129 sockets must be configured when the command finishes. If the
130 selected targets make this impossible, the command will be
131 rejected. Refer to Show System Capabilities for a list of BIOS
132 supported modes.
133 · Some requests are dependent on BIOS and/or platform configuration.
135 For details, refer to the Intel® Optane™ DC Persistent Memory
136 Software Memory Allocation Rules, document number 564194. For
137 example:
138 · Provisioning DCPMMs for Memory Mode while BIOS is configured for
140 1LM only will result in unused capacity.
141 · Provisioning DCPMMs for Memory Mode while not all iMCs have at
143 least one DCPMM will result in unused capacity.
144
146 Minor adjustments (up to 10%) in the requested capacities are sometimes
147 necessary to align properly according to the platform rules. There are
148 also some situations that require additional confirmation from the user
149 because they may result in a non- optimal configuration (i.e., reduced
150 performance). These are described below.:
151 The requested goal may result in a non-optimal configuration due to the
153 population of DIMMs in the system
154 Memory Mode capacity requested but the population of DRAM DIMMs and
156 DCPMMs in the system may result in reduced performance (i.e., the ratio
157 of DRAM and DCPMMs is not balanced, DRAM and DCPMMs are not on the same
158 channel or not all the same size).
159 The requested goal may result in a non-optimal configuration due to the
161 population of DIMMs in the system.
162 App Direct capacity requested but the population of DCPMMs in the
163 system may result in reduced performance (i.e., DCPMMs are not the same
164 size or populated asymmetrically across the socket).
165 The requested goal will result in App Direct capacity which is not
167 supported by the host software.
168 App Direct capacity requested but App Direct is not supported by the
169 currently installed host software.
170 The requested goal will result in Memory Mode capacity that is unusable
172 with the currently selected platform BIOS volatile mode.
173 Memory Mode capacity requested by the platform BIOS is currently set to
174 1LM Mode.
175 The requested goal was adjusted more than 10% to find a valid
177 configuration.
178 > 10% adjustment from the requested goal
179 The amount of mapped memory was limited based on the SKU resulting in
181 un-mapped capacity.
182 Mapped memory was limited based on the CPU SKU.
183 Therefore, before making any changes to the configuration, a prompt is
185 displayed showing the memory allocation goals that will be created on
186 each DCPMM as documented in the command Section [Show Memory Allocation
187 Goal], along with any additional confirmation messages. The force
188 option can be used to override this confirmation and proceed directly
189 with creating the goals.
190 The following configuration will be applied:
192 SocketID DimmID MemorySize AppDirect1Size AppDirect2Size (Refer to
193 the command Section [Show Memory Allocation Goal])
194 [Additional Confirmation Messages (see above)] Do you want to
195 continue?
196ipmctl 2019-10-23 IPMCTL-CREATE-GOAL(1)