ipmctl-show-goal(1)

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

NAME

6       ipmctl-show-goal - Shows the memory allocation goal on one or more PMem
7       modules
8

SYNOPSIS

10           ipmctl show [OPTIONS] -goal [TARGETS] [PROPERTIES]
11

DESCRIPTION

13       Shows the memory allocation goal on one or more PMem modules. Once the
14       goal is successfully applied by the platform firmware (BIOS), it is no
15       longer displayed. Use the command [Show Memory Resources] to view the
16       system-wide memory resources or the command [Show Persistent Memory]
17       for detailed persistent memory information.
18

OPTIONS

20       -a, -all
21           Shows all attributes.
22
23           Note
24           The all and display options are exclusive and may not be used
25           together.
26
27       -d (attributes), -display (attributes)
28           Filters the returned attributes by explicitly specifying a comma
29           separated list of any of the attributes defined in the Return Data
30           section.
31
32           Note
33           The all and display options are exclusive and may not be used
34           together.
35
36       -h, -help
37           Displays help for the command.
38
39       -ddrt
40           Used to specify DDRT as the desired transport protocol for the
41           current invocation of ipmctl.
42
43       -smbus
44           Used to specify SMBUS as the desired transport protocol for the
45           current invocation of ipmctl.
46
47           Note
48           The -ddrt and -smbus 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
54       -u (B|MB|MiB|GB|GiB|TB| TiB), -units (B|MB|MiB|GB|GiB|TB| TiB)
55           Changes the units that capacities are displayed in for this
56           command. One of: bytes (B), megabytes (MB), mebibytes (MiB),
57           gigabytes (GB), gibibytes (GiB), terabytes (TB) or tebibytes (TiB).
58

TARGETS

60       -dimm [DimmIDs]
61           Restricts output to specific PMem modules by supplying one or more
62           comma separated PMem module identifiers. The default is to display
63           all manageable PMem modules with memory allocation goals.
64
65       -socket [SocketIDs]
66           Restricts output to the PMem modules on specific sockets by
67           supplying the socket target and one or more comma separated socket
68           identifiers. The default is to display all manageable PMem modules
69           on all sockets with memory allocation goals.
70

EXAMPLES

72       Shows the default memory allocation goal attributes for each PMem
73       module.
74
75           ipmctl show -goal
76
77       Shows all the memory allocation goal attributes for the PMem modules on
78       socket 1.
79
80           ipmctl show -a -goal -socket 1
81

LIMITATIONS

83       In order to successfully execute this command:
84
85       •   The caller must have the appropriate privileges.
86
87       •   The specified PMem modules must be manageable by the host software.
88

RETURN DATA

90       The default behavior is to display a table with the default attributes
91       for each PMem module; applying options changes the output to a more
92       detailed format.
93
94       SocketID
95           (Default) The processor socket identifier where the PMem module is
96           installed.
97
98       DimmID
99           (Default) The PMem module identifier
100
101       MemorySize
102           (Default) The PMem module capacity that will be configured in
103           Memory Mode.
104
105       AppDirect1Size
106           (Default) The PMem module capacity that will be configured as the
107           first App Direct interleave set if applicable.
108
109       AppDirect1Index
110           Unique identifier of the first App Direct interleave set.
111
112           •   N/A: If no App Direct interleave set
113
114           •   Numeric value if App Direct interleave set is present.
115
116       AppDirect1Settings
117           The settings for the first App Direct interleave set in the format:
118           x(Way) [- (Size) iMC] [x (Size) Channel]
119
120       AppDirect2Size
121           (Default) The PMem module capacity that will be configured as the
122           second App Direct interleave set if applicable.
123
124       AppDirect2Index
125           Unique identifier of the second App Direct interleave set.
126
127           •   N/A: If no App Direct interleave set
128
129           •   Numeric value if App Direct interleave set is present.
130
131       AppDirect2Settings
132           The settings for the second App Direct interleave set in the
133           format: x(Way) [- (Size) iMC] [x (Size) Channel]
134
135       Status
136           The status of the memory allocation goal. One of:
137
138           •   Unknown: The status cannot be determined.
139
140           •   New: A reboot is required for the memory allocation goal to be
141               processed by the BIOS.
142
143           •   Failed - Bad request: The BIOS failed to process the memory
144               allocation goal because it was invalid.
145
146           •   Failed - Not enough resources: There were not enough resources
147               for the BIOS to process the memory allocation goal.
148
149           •   Failed - Firmware error: The BIOS failed to process the memory
150               allocation goal due to a firmware error.
151
152           •   Failed - Unknown: The BIOS failed to process the memory
153               allocation goal due to an unknown error.
154

SAMPLE OUTPUT

156       If a new memory allocation goal has been created, a prompt to reboot
157       will be presented.
158
159           A reboot is required to process new memory allocation goals.
160
161
162
163ipmctl                            2023-07-20               IPMCTL-SHOW-GOAL(1)