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

NAME

6       ipmctl-delete-goal - Deletes the memory allocation goal from PMem
7       modules
8

SYNOPSIS

10           ipmctl delete [OPTIONS] -goal [TARGETS]
11

DESCRIPTION

13       Deletes the memory allocation goal from one or more PMem modules. This
14       command only deletes a memory allocation goal request that has not yet
15       been processed by platform firmware (BIOS).
16
17       If the PMem module target is used and the specified PMem modules do not
18       include all PMem modules that are part of a memory allocation goal
19       request the result will be PMem modules (those not included) that have
20       a broken request which will be rejected by platform firmware (BIOS)
21       upon the next reboot.
22

OPTIONS

24       -h, -help
25           Displays help for the command.
26
27       -ddrt
28           Used to specify DDRT as the desired transport protocol for the
29           current invocation of ipmctl.
30
31       -smbus
32           Used to specify SMBUS as the desired transport protocol for the
33           current invocation of ipmctl.
34
35           Note
36           The -ddrt and -smbus options are mutually exclusive and may not be
37           used together.
38
39       -lpmb
40           Used to specify large transport payload size for the current
41           invocation of ipmctl.
42
43       -spmb
44           Used to specify small transport payload size for the current
45           invocation of ipmctl.
46
47           Note
48           The -lpmb and -spmb options are mutually exclusive and may not be
49           used together.
50
51       -o (text|nvmxml), -output (text|nvmxml)
52           Changes the output format. One of: "text" (default) or "nvmxml".
53

TARGETS

55       -dimm [DimmIDs]
56           Deletes the memory allocation goal from specific PMem modules by
57           optionally supplying one or more comma separated PMem module
58           identifiers. The default is to delete the memory allocation goals
59           from all manageable PMem modules.
60
61       -socket [SocketIds]
62           Deletes the memory allocation goal from the PMem modules on
63           specific sockets by supplying the socket target and one or more
64           comma separated socket identifiers. The default is to delete the
65           memory allocation goals from manageable PMem modules on all
66           sockets.
67

EXAMPLES

69       Deletes the memory allocation goal from all PMem modules on all
70       sockets.
71
72           ipmctl delete -goal
73

LIMITATIONS

75       In order to successfully execute this command:
76
77       ·   The caller must have the appropriate privileges.
78
79       ·   The specified PMem modules must be manageable by the host software
80           and unlocked if security is enabled.
81
82       ·   Given socket and all specified PMem modules must contain a memory
83           allocation goal.
84

RETURN DATA

86       For each PMem module, the CLI will indicate the status of the
87       operation. If a failure occurs when deleting the memory allocation
88       goals from multiple PMem modules, the process will output a failure
89       message for those PMem modules that failed and a success message for
90       those that succeeded.
91

SAMPLE OUTPUT

93           Delete memory allocation goal from PMem module (DimmID): Success
94
95           Delete memory allocation goal from PMem module (DimmID): Error (Code) - (Description)
96
97
98
99ipmctl                            2020-12-03             IPMCTL-DELETE-GOAL(1)