'\" t
.\"     Title: ipmctl-show-preferences
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.16
.\"      Date: 2021-12-29
.\"    Manual: ipmctl
.\"    Source: ipmctl
.\"  Language: English
.\"
.TH "IPMCTL\-SHOW\-PREFERENCES" "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-preferences \- Displays a list of the PMem module software user preferences
.SH "SYNOPSIS"
.sp
.if n .RS 4
.nf
.fam C
ipmctl show [OPTIONS] \-preferences
.fam
.fi
.if n .RE
.SH "DESCRIPTION"
.sp
Displays a list of the PMem module software user preferences and their current values.
.SH "OPTIONS"
.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
.SH "EXAMPLES"
.sp
Displays the current values for all the user preferences.
.sp
.if n .RS 4
.nf
.fam C
ipmctl show \-preferences
.fam
.fi
.if n .RE
.SH "RETURN DATA"
.sp
CLI_DEFAULT_DIMM_ID
.RS 4
The default display of PMem module identifiers. One of:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
UID: Use the DimmUID attribute as defined in the command [Show Dimm].
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
HANDLE: Use the DimmHandle attribute as defined in the command [Show Dimm].
This is the default.
.RE
.RE
.sp
CLI_DEFAULT_SIZE
.RS 4
The default display of capacities in the CLI. One of:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
AUTO: Automatically choose the best format for each capacity in binary
multiples of bytes (i.e., B, MiB, GiB or TiB). This is the default.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
AUTO_10: AUTO_10: Automatically choose the best format for each capacity in
decimal multiples of bytes (i.e., B, MB, GB or TB).
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
B: Displays all capacities in bytes.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
MB: Displays all capacities in megabytes.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
MiB: Displays all capacities in mebibytes.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
GB: Displays all capacities in gigabytes.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
GiB: Displays all capacities in gibibytes.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
TB: Displays all capacities in terabytes.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
TiB: Displays all capacities in tebibytes.
.RE
.RE
.sp
APPDIRECT_SETTINGS
.RS 4
The interleave settings to use when creating App Direct capacity in the
format: (IMCSize_ChannelSize). The default is "RECOMMENDED" which uses the
BIOS recommended App Direct settings returned by the command
[Show System Capabilities].
.RE
.sp
DBG_LOG_LEVEL
.RS 4
Whether debug logging is enabled in the PMem module host software. These logs
pertain to the operation of the command\-line tool only and do not reflect any
logging functionality of the PMem module. One of:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
0: Logging is disabled. This is the default.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
1: Log Errors.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
2: Log Warnings, Errors.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
3: Log Informational, Warnings, Errors.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
4: Log Verbose, Informational, Warnings, Errors.
.RE
.RE