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

NAME

6       ipmctl-load-goal - Load a memory allocation goal from a file onto
7       DCPMMs
8

SYNOPSIS

10       ipmctl load [OPTIONS] -source (path) -goal [TARGETS]
11

DESCRIPTION

13       Load a memory allocation goal from a file onto one or more DCPMMs.
14
15           Note
16           Deleting the PCD can be used as a way to prepare individual DCPMMs
17           for provisioning. See the delete -pcd command.
18
19       Unresolved directive in ipmctl-load-goal.txt -
20       include::../ipmctl-change-goal-config-warning.txt[]
21

OPTIONS

23       -f, -force
24           Reconfiguring DCPMMs is a destructive operation which requires
25           confirmation from the user. This option suppresses the
26           confirmation.
27
28       -h, -help
29           Displays help for the command.
30
31       -o (text|nvmxml), -output (text|nvmxml)
32           Changes the output format. One of: "text" (default) or "nvmxml".
33
34       -u (B|MB|MiB|GB|GiB|TB| TiB), -units (B|MB|MiB|GB|GiB|TB| TiB)
35           Changes the units that capacities are displayed in for this
36           command. One of: bytes (B), megabytes (MB), mebibytes (MiB),
37           gigabytes (GB), gibibytes (GiB), terabytes (TB) or tebibytes (TiB).
38

TARGETS

40       -dimm (DimmIDs)
41           Loads the memory allocation goal onto specific DCPMMs by supplying
42           one or more comma separated DCPMM identifiers. The default is to
43           load the memory allocation goal onto all manageable DCPMMs.
44
45       -socket (SocketIds)
46           Loads the memory allocation goal onto all manageable DCPMMs on
47           specific sockets by supplying the socket target and one or more
48           comma-separated socket identifiers. The default is to load the
49           memory allocation goal onto all manageable DCPMMs on all sockets.
50

EXAMPLES

52       Loads the configuration settings stored in "config.txt" onto all the
53       DCPMMs in the system as a memory allocation goal to be applied by the
54       BIOS on the next reboot.
55
56       ipmctl load -source config.txt -goal
57
58       Loads the configuration settings stored in "config.txt" onto a
59       specified set of DCPMMs as a memory allocation goal to be applied by
60       the BIOS on the next reboot.
61
62       ipmctl load -source config.txt -goal -dimm 1,2,3
63
64       Loads the configuration settings stored in "config.txt" onto all
65       manageable DCPMMs on sockets 1 and 2 as a memory allocation goal to be
66       applied by the BIOS on the next reboot.
67
68       ipmctl load -source config.txt -goal -socket 1,2
69

LIMITATIONS

71       In order to successfully execute this command:
72
73       ·   The caller must have the appropriate privileges.
74
75       ·   The specified DCPMM(s) must be manageable by the host software and
76           must all have the same SKU.
77
78       ·   Existing memory allocation goals that have not been applied and any
79           namespaces associated with the requested DCPMM(s) must be deleted
80           before running this command.
81
82       ·   Security state must be disabled. Changing the memory configuration
83           is a destructive operation which results in loss of data stored in
84           the persistent memory region. Therefore, data should be backed up
85           to other storage before executing this command. Targets may be
86           limited to individual DCPMMs or sockets, but all DCPMMs on affected
87           sockets must be configured when the command finishes. If the
88           selected targets make this impossible, the command will be
89           rejected. Refer to Show System Capabilities for a list of BIOS
90           supported modes.
91
92       ·   Some requests are dependent on BIOS and/or platform configuration.
93           For details, refer to the Intel® Optane™ DC Persistent Memory
94           Software Memory Allocation Rules, document number 564194. For
95           example:
96
97       ·   Provisioning DCPMMs for Memory Mode while BIOS is configured for
98           1LM only will result in unused capacity.
99
100       ·   Provisioning DCPMMs for Memory Mode while not all iMCs have at
101           least one DCPMM will result in unused capacity.
102

RETURN DATA

104       If successful, the CLI will display the memory allocation goal stored
105       on each DCPMM as documented in the command Section [Show Memory
106       Allocation Goal]. If a failure occurs, an error code and message will
107       be displayed. If a failure occurs when configuring multiple DCPMMs, the
108       process will exit and remove the memory allocation goal from any DCPMMs
109       that succeeded prior to the failure.
110
111
112
113ipmctl                            2019-10-23               IPMCTL-LOAD-GOAL(1)
Impressum