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       Unresolved directive in ipmctl-load-goal.txt -
16       include::../ipmctl-change-goal-config-warning.txt[]
17

OPTIONS

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

TARGETS

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

EXAMPLES

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

LIMITATIONS

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

RETURN DATA

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