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 Unresolved directive in ipmctl-create-goal.txt -
26 include::../ipmctl-change-goal-config-warning.txt[]
27
29 -f, -force
30 Reconfiguring DCPMMs is a destructive operation which requires
31 confirmation from the user. This option suppresses the
32 confirmation.
33 -h, -help
35 Displays help for the command.
36 -o (text|nvmxml), -output (text|nvmxml)
38 Changes the output format. One of: "text" (default) or "nvmxml".
39 -u (B|MB|MiB|GB|GiB|TB| TiB), -units (B|MB|MiB|GB|GiB|TB| TiB)
41 Changes the units that capacities are displayed in for this
42 command. One of: bytes (B), megabytes (MB), mebibytes (MiB),
43 gigabytes (GB), gibibytes (GiB), terabytes (TB) or tebibytes (TiB).
44
46 -dimm [(DimmIDs)]
47 Creates a memory allocation goal on specific DCPMMs by optionally
48 supplying one or more comma-separated DCPMM identifiers. This list
49 must include all unconfigured DCPMMs on the affected socket(s). The
50 default is to configure all manageable DCPMMs on all sockets.
51 -socket (SocketIds)
53 Creates a memory allocation goal on specific DCPMMs by supplying
54 one or more comma-separated DCPMM identifiers. This list must
55 include all unconfigured DCPMMs on the affected socket(s). The
56 default is to configure all manageable DCPMMs on all sockets.
57
59 MemoryMode
60 Percentage of the total capacity to use in Memory Mode (0-100).
61 Default = 0.
62 PersistentMemoryType
64 If MemoryMode is not 100%, the type of persistent memory to create.
65 · "AppDirect": (Default) Create App Direct capacity utilizing
67 hardware interleaving across the requested DCPMMs if applicable
68 given the specified target.
69 · "AppDirectNotInterleaved": Create App Direct capacity that is
71 not interleaved any other DCPMMs.
72 NamespaceLabelVersion
74 The version of the namespace label storage area (LSA) index block
75 · "1.2": (Default) Defined in UEFI 2.7a - sections 13.19
77 · "1.1": Legacy 1.1 namespace label support
79 Reserved
81 Reserve a percentage (0-100) of the requested DCPMM App Direct
82 capacity that will not be mapped into the system physical address
83 space and will be presented as Reserved Capacity with Show Device
84 and Show Memory Resources Commands.
85
87 Configures all the DCPMM capacity in Memory Mode.
88 ipmctl create -goal MemoryMode=100
90 Configures all the DCPMM capacity as App Direct.
92 ipmctl create -goal PersistentMemoryType=AppDirect
94 Configures the capacity on each DCPMM with 20% of the capacity in
96 Memory Mode and the remaining as App Direct capacity that does not use
97 hardware interleaving.
98 ipmctl create -goal MemoryMode=20 PersistentMemoryType=AppDirectNotInterleaved
100 Configures the DCPMM capacity across the entire system with 25% of the
102 capacity in Memory Mode, 25% reserved and the remaining 50% as App
103 Direct. Configures the DCPMM capacity across the entire system with 25%
104 of the capacity in Memory Mode and the remaining 75% as App Direct.
105 ipmctl create -goal MemoryMode=25 PersistentMemoryType=AppDirect Reserved=25
107
109 In order to successfully execute this command:
110 · The caller must have the appropriate privileges.
112 · The specified DCPMM(s) must be manageable by the host software and
114 must all have the same SKU.
115 · Existing memory allocation goals that have not been applied and any
117 namespaces associated with the requested DCPMM(s) must be deleted
118 before running this command.
119 · Security state must be disabled. Changing the memory configuration
121 is a destructive operation which results in loss of data stored in
122 the persistent memory region. Therefore, data should be backed up
123 to other storage before executing this command. Targets may be
124 limited to individual DCPMMs or sockets, but all DCPMMs on affected
125 sockets must be configured when the command finishes. If the
126 selected targets make this impossible, the command will be
127 rejected. Refer to Show System Capabilities for a list of BIOS
128 supported modes.
129 · Some requests are dependent on BIOS and/or platform configuration.
131 For details, refer to the Intel® Optane™ DC Persistent Memory
132 Software Memory Allocation Rules, document number 564194. For
133 example:
134 · Provisioning DCPMMs for Memory Mode while BIOS is configured for
136 1LM only will result in unused capacity.
137 · Provisioning DCPMMs for Memory Mode while not all iMCs have at
139 least one DCPMM will result in unused capacity.
140
142 Minor adjustments (up to 10%) in the requested capacities are sometimes
143 necessary to align properly according to the platform rules. There are
144 also some situations that require additional confirmation from the user
145 because they may result in a non- optimal configuration (i.e., reduced
146 performance). These are described below.:
147 The requested goal may result in a non-optimal configuration due to the
149 population of DIMMs in the system
150 Memory Mode capacity requested but the population of DRAM DIMMs and
152 DCPMMs in the system may result in reduced performance (i.e., the ratio
153 of DRAM and DCPMMs is not balanced, DRAM and DCPMMs are not on the same
154 channel or not all the same size).
155 The requested goal may result in a non-optimal configuration due to the
157 population of DIMMs in the system.
158 App Direct capacity requested but the population of DCPMMs in the
159 system may result in reduced performance (i.e., DCPMMs are not the same
160 size or populated asymmetrically across the socket).
161 The requested goal will result in App Direct capacity which is not
163 supported by the host software.
164 App Direct capacity requested but App Direct is not supported by the
165 currently installed host software.
166 The requested goal will result in Memory Mode capacity that is unusable
168 with the currently selected platform BIOS volatile mode.
169 Memory Mode capacity requested by the platform BIOS is currently set to
170 1LM Mode.
171 The requested goal was adjusted more than 10% to find a valid
173 configuration.
174 > 10% adjustment from the requested goal
175 The amount of mapped memory was limited based on the SKU resulting in
177 un-mapped capacity.
178 Mapped memory was limited based on the CPU SKU.
179 Therefore, before making any changes to the configuration, a prompt is
181 displayed showing the memory allocation goals that will be created on
182 each DCPMM as documented in the command Section [Show Memory Allocation
183 Goal], along with any additional confirmation messages. The force
184 option can be used to override this confirmation and proceed directly
185 with creating the goals.
186 The following configuration will be applied:
188 SocketID DimmID MemorySize AppDirect1Size AppDirect2Size (Refer to
189 the command Section [Show Memory Allocation Goal])
190 [Additional Confirmation Messages (see above)] Do you want to
191 continue?
192ipmctl 2019-04-10 IPMCTL-CREATE-GOAL(1)