'\" t
.\"     Title: ipmctl-show-system-capabilities
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.16
.\"      Date: 2021-12-29
.\"    Manual: ipmctl
.\"    Source: ipmctl
.\"  Language: English
.\"
.TH "IPMCTL\-SHOW\-SYSTEM\-CAPABILITIES" "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-system-capabilities \- Shows the platform supported PMem module capabilities.
.SH "SYNOPSIS"
.sp
.if n .RS 4
.nf
.fam C
ipmctl show [OPTIONS] \-system \-capabilities
.fam
.fi
.if n .RE
.SH "DESCRIPTION"
.sp
Shows the capabilities of the current platform as determined by platform firmware
(BIOS) and this application.
.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 "EXAMPLES"
.sp
Displays the supported PMem module capabilities
.sp
.if n .RS 4
.nf
.fam C
ipmctl show \-system \-capabilities
.fam
.fi
.if n .RE
.SH "RETURN DATA"
.sp
The default behavior is to return the default attributes listed below; the options can be
used to expand or restrict the output.
.sp
PlatformConfigSupported
.RS 4
(Default) Whether the platform level configuration of PMem modules can be modified
with the host software. One of:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
0: Changes must be made in the BIOS.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
1: The command [Create Memory Allocation Goal] is supported.
.RE
.RE
.sp
Alignment
.RS 4
(Default) Capacity alignment requirement for all memory types as reported by the BIOS.
.RE
.sp
AllowedVolatileMode
.RS 4
(Default) The volatile mode allowed as determined by BIOS setup. One of:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
1LM: One\-level volatile mode. All configured PMem module resources
on the platform assigned for memory usage are not in use.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
2LM: Two\-level volatile mode/Memory Mode. PMem module resources
configured as memory act as system memory. Any DDR on the platform
will act as a cache working in conjunction with the PMem modules.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
Unknown: The allowed volatile mode cannot be determined.
.RE
.RE
.sp
CurrentVolatileMode
.RS 4
(Default) The current volatile mode. One of:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
1LM: One\-level volatile mode. All configured PMem module resources
on the platform assigned for memory usage are not in use.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
2LM: Two\-level volatile mode/Memory Mode. PMem module resources
configured as memory act as system memory. Any DDR on the platform
will act as a cache working in conjunction with the PMem modules.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
Unknown: The current volatile mode cannot be determined.
.RE
.RE
.sp
AllowedAppDirectMode
.RS 4
(Default) The App Direct mode allowed as determined by BIOS setup. One of:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
Disabled: App Direct support is currently disabled by the BIOS.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
App Direct: App Direct support is currently enabled by the BIOS.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
Unknown: The current App Direct support cannot be determined.
.RE
.RE
.sp
ModesSupported
.RS 4
A list of PMem module modes supported by the BIOS. Refer to the command
[Show Dimm] to determine the modes supported by the individual
PMem modules. At least one of:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
1LM: One\-level volatile mode. All configured PMem module resources
on the platform assigned for memory usage are not in use.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
2LM: Two\-level volatile mode/Memory Mode. PMem module resources
configured as memory act as system memory. Any DDR on the platform
will act as a cache working in conjunction with the PMem modules.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
App Direct: PMem module resources are under direct load/store control
of the application. DDR is unaffected.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
Unknown: The current mode cannot be determined.
.RE
.RE
.sp
SupportedAppDirectSettings
.RS 4
The BIOS supported list of App Direct interleave settings in the format:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
x[Way] \- [(IMCSize) iMC x (ChannelSize) Channel] followed by the input
format for the command [Set Preferences]:
(ByOne|(IMCSize)_(ChannelSize)).
.RE
.RE
.sp
RecommendedAppDirectSettings
.RS 4
The BIOS recommended list of App Direct interleave settings in the format:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
x[Way] \- [(IMCSize) iMC x (ChannelSize) Channel] followed by the input format for
the command [Set Preferences]:
(ByOne|(IMCSize)_(ChannelSize)).
.RE
.RE
.sp
MinNamespaceSize
.RS 4
The minimum allowed namespace size as reported by the driver.
.RE
.sp
AppDirectMirrorSupported
.RS 4
If the BIOS supports App Direct mirroring. One of:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
0: Not supported
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
1: Supported
.RE
.RE
.sp
DimmSpareSupported
.RS 4
If the BIOS supports PMem module sparing. One of:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
0: Not supported
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
1: Supported
.RE
.RE
.sp
AppDirectMigrationSupported
.RS 4
If the BIOS supports App Direct migration. One of:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
0: Not supported
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
1: Supported
.RE
.RE
.sp
RenameNamespaceSupported
.RS 4
If the host software supports renaming a namespace. One of:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
0: Not supported
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
1: Supported
.RE
.RE
.sp
GrowAppDirectNamespaceSupported
.RS 4
If the host software supports increasing the capacity of an App Direct
namespace. One of:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
0: Not supported
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
1: Supported
.RE
.RE
.sp
ShrinkAppDirectNamespaceSupported
.RS 4
If the host software supports decreasing the capacity of an App Direct
namespace. One of:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
0: Not supported
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
1: Supported
.RE
.RE
.sp
InitiateScrubSupported
.RS 4
If the platform and host software support initiating an address range scrub on the
PMem modules in the system. One of:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
0: Not supported
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
1: Supported
.RE
.RE
.sp
AdrSupported
.RS 4
Whether the platform supports asynchronous DRAM refresh (ADR). One of:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
0: Not supported. If ADR is not supported, App Direct data integrity cannot be
assured during system interruptions.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
1: Supported
.RE
.RE
.sp
EraseDeviceDataSupported
.RS 4
Whether Erase Device Data is supported.
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
0: Not supported
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
1: Supported
.RE
.RE
.sp
EnableDeviceSecuritySupported
.RS 4
Whether Enable Device Security is supported.
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
0: Not supported
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
1: Supported
.RE
.RE
.sp
DisableDeviceSecuritySupported
.RS 4
Whether Change Device Security property Lockstate = Disabled is supported.
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
0: Not supported
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
1: Supported
.RE
.RE
.sp
UnlockDeviceSecuritySupported
.RS 4
Whether Change Device Security property Lockstate = Unlocked is supported.
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
0: Not supported
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
1: Supported
.RE
.RE
.sp
FreezeDeviceSecuritySupported
.RS 4
Whether Change Device Security property Lockstate = Frozen is supported.
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
0: Not supported
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
1: Supported
.RE
.RE
.sp
ChangeDevicePassphraseSupported
.RS 4
Whether Change Device Passphrase is supported.
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
0: Not supported
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
1: Supported
.RE
.RE
.sp
ChangeMasterPassphraseSupported
.RS 4
Whether Change Master Passphrase is supported.
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
0: Not supported
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
1: Supported
.RE
.RE
.sp
MasterEraseDeviceDataSupported
.RS 4
Whether Master Erase Device Data is supported.
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
0: Not supported
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
1: Supported
.RE
.RE