'\" t
.\"     Title: ipmctl-show-goal
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.16
.\"      Date: 2021-12-29
.\"    Manual: ipmctl
.\"    Source: ipmctl
.\"  Language: English
.\"
.TH "IPMCTL\-SHOW\-GOAL" "1" "2021-12-29" "ipmctl" "ipmctl"
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.ss \n[.ss] 0
.nh
.ad l
.de URL
\fI\\$2\fP <\\$1>\\$3
..
.als MTO URL
.if \n[.g] \{\
.  mso www.tmac
.  am URL
.    ad l
.  .
.  am MTO
.    ad l
.  .
.  LINKSTYLE blue R < >
.\}
.SH "NAME"
ipmctl-show-goal \- Shows the memory allocation goal on one or more PMem modules
.SH "SYNOPSIS"
.sp
.if n .RS 4
.nf
.fam C
ipmctl show [OPTIONS] \-goal [TARGETS] [PROPERTIES]
.fam
.fi
.if n .RE
.SH "DESCRIPTION"
.sp
Shows the memory allocation goal on one or more PMem modules. Once the goal is
successfully applied by the platform firmware (BIOS), it is no longer
displayed. Use the command [Show Memory Resources] to view
the system\-wide memory resources or the command
[Show Persistent Memory] for detailed persistent memory information.
.SH "OPTIONS"
.sp
\-a, \-all
.RS 4
Shows all attributes.
.RE
.if n .sp
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
.B Note
.ps -1
.br
.sp
The all and display options are exclusive and may not be used together.
.sp .5v
.RE
.sp
\-d (attributes), \-display (attributes)
.RS 4
Filters the returned attributes by explicitly specifying a comma separated
list of any of the attributes defined in the Return Data section.
.RE
.if n .sp
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
.B Note
.ps -1
.br
.sp
The all and display options are exclusive and may not be used together.
.sp .5v
.RE
.sp
\-h, \-help
.RS 4
Displays help for the command.
.RE
.sp
\-ddrt
.RS 4
Used to specify DDRT as the desired transport protocol for the current invocation of ipmctl.
.RE
.sp
\-smbus
.RS 4
Used to specify SMBUS as the desired transport protocol for the current invocation of ipmctl.
.RE
.if n .sp
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
.B Note
.ps -1
.br
.sp
The \-ddrt and \-smbus options are mutually exclusive and may not be used together.
.sp .5v
.RE
.sp
\-o (text|nvmxml), \-output (text|nvmxml)
.RS 4
Changes the output format. One of: "text" (default) or "nvmxml".
.RE
.sp
\-u (B|MB|MiB|GB|GiB|TB| TiB), \-units (B|MB|MiB|GB|GiB|TB| TiB)
.RS 4
Changes the units that capacities are displayed in for this command. One of:
bytes (B), megabytes (MB), mebibytes (MiB), gigabytes (GB), gibibytes (GiB),
terabytes (TB) or tebibytes (TiB).
.RE
.SH "TARGETS"
.sp
\-dimm [DimmIDs]
.RS 4
Restricts output to specific PMem modules by supplying one or more comma separated
PMem module identifiers. The default is to display all manageable PMem modules with memory
allocation goals.
.RE
.sp
\-socket [SocketIDs]
.RS 4
Restricts output to the PMem modules on specific sockets by supplying the socket
target and one or more comma separated socket identifiers. The default is to
display all manageable PMem modules on all sockets with memory allocation goals.
.RE
.SH "EXAMPLES"
.sp
Shows the default memory allocation goal attributes for each PMem module.
.sp
.if n .RS 4
.nf
.fam C
ipmctl show \-goal
.fam
.fi
.if n .RE
.sp
Shows all the memory allocation goal attributes for the PMem modules on socket 1.
.sp
.if n .RS 4
.nf
.fam C
ipmctl show \-a \-goal \-socket 1
.fam
.fi
.if n .RE
.SH "LIMITATIONS"
.sp
In order to successfully execute this command:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
The caller must have the appropriate privileges.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
The specified PMem modules must be manageable by the host software.
.RE
.SH "RETURN DATA"
.sp
The default behavior is to display a table with the default attributes for each
PMem module; applying options changes the output to a more detailed format.
.sp
SocketID
.RS 4
(Default) The processor socket identifier where the PMem module is installed.
.RE
.sp
DimmID
.RS 4
(Default) The PMem module identifier
.RE
.sp
MemorySize
.RS 4
(Default) The PMem module capacity that will be configured in Memory Mode.
.RE
.sp
AppDirect1Size
.RS 4
(Default) The PMem module capacity that will be configured as the first App Direct
interleave set if applicable.
.RE
.sp
AppDirect1Index
.RS 4
Unique identifier of the first App Direct interleave set.
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
N/A: If no App Direct interleave set
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
Numeric value if App Direct interleave set is present.
.RE
.RE
.sp
AppDirect1Settings
.RS 4
The settings for the first App Direct interleave set in the format: x(Way)
[\- (Size) iMC] [x (Size) Channel]
.RE
.sp
AppDirect2Size
.RS 4
(Default) The PMem module capacity that will be configured as the second App
Direct interleave set if applicable.
.RE
.sp
AppDirect2Index
.RS 4
Unique identifier of the second App Direct interleave set.
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
N/A: If no App Direct interleave set
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
Numeric value if App Direct interleave set is present.
.RE
.RE
.sp
AppDirect2Settings
.RS 4
The settings for the second App Direct interleave set in the format: x(Way)
[\- (Size) iMC] [x (Size) Channel]
.RE
.sp
Status
.RS 4
The status of the memory allocation goal. One of:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
Unknown: The status cannot be determined.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
New: A reboot is required for the memory allocation goal to be processed by
the BIOS.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
Failed \- Bad request: The BIOS failed to process the memory allocation goal
because it was invalid.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
Failed \- Not enough resources: There were not enough resources for the BIOS
to process the memory allocation goal.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
Failed \- Firmware error: The BIOS failed to process the memory allocation
goal due to a firmware error.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
Failed \- Unknown: The BIOS failed to process the memory allocation goal due
to an unknown error.
.RE
.RE
.SH "SAMPLE OUTPUT"
.sp
If a new memory allocation goal has been created, a prompt to reboot will be
presented.
.sp
.if n .RS 4
.nf
.fam C
A reboot is required to process new memory allocation goals.
.fam
.fi
.if n .RE