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
7       DCPMM
8

SYNOPSIS

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

DESCRIPTION

13       Shows the memory allocation goal on one or more DCPMMs. Once the goal
14       is successfully applied by the BIOS, it is no longer displayed. Use the
15       command Section [Show Memory Resources] to view the system-wide memory
16       resources or the command Show Persistent Memory for detailed persistent
17       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
29           comma-separated list of any of the attributes defined in the Return
30           Data 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       -o (text|nvmxml), -output (text|nvmxml)
40           Changes the output format. One of: "text" (default) or "nvmxml".
41
42       -u (B|MB|MiB|GB|GiB|TB| TiB), -units (B|MB|MiB|GB|GiB|TB| TiB)
43           Changes the units that capacities are displayed in for this
44           command. One of: bytes (B), megabytes (MB), mebibytes (MiB),
45           gigabytes (GB), gibibytes (GiB), terabytes (TB) or tebibytes (TiB).
46

TARGETS

48       -dimm (DimmIDs)
49           Restricts output to specific DCPMMs by supplying one or more comma
50           separated DCPMM identifiers. The default is to display all
51           manageable DCPMMs with memory allocation goals.
52
53       -socket (SocketIds)
54           Restricts output to the DCPMMs on specific sockets by supplying the
55           socket target and one or more comma-separated socket identifiers.
56           The default is to display all manageable DCPMMs on all sockets with
57           memory allocation goals.
58

EXAMPLES

60       Shows the default memory allocation goal attributes for each DCPMM.
61
62       ipmctl show -goal
63
64       Shows all the memory allocation goal attributes for the DCPMMs on
65       socket 1.
66
67       ipmctl show -a -goal -socket 1
68

LIMITATIONS

70       The specified DCPMMs must be manageable by the host software.
71

RETURN DATA

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

SAMPLE OUTPUT

139       If a new memory allocation goal has been created, a prompt to reboot
140       will be presented.
141
142       A reboot is required to process new memory allocation goals.
143
144
145
146ipmctl                            2019-10-23               IPMCTL-SHOW-GOAL(1)