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

NAME

6       ipmctl-show-preferences - Displays a list of the PMem module software
7       user preferences
8

SYNOPSIS

10           ipmctl show [OPTIONS] -preferences
11

DESCRIPTION

13       Displays a list of the PMem module software user preferences and their
14       current values.
15

OPTIONS

17       -h, -help
18           Displays help for the command.
19
20       -ddrt
21           Used to specify DDRT as the desired transport protocol for the
22           current invocation of ipmctl.
23
24       -smbus
25           Used to specify SMBUS as the desired transport protocol for the
26           current invocation of ipmctl.
27
28           Note
29           The -ddrt and -smbus options are mutually exclusive and may not be
30           used together.
31
32       -o (text|nvmxml), -output (text|nvmxml)
33           Changes the output format. One of: "text" (default) or "nvmxml".
34

EXAMPLES

36       Displays the current values for all the user preferences.
37
38           ipmctl show -preferences
39

RETURN DATA

41       CLI_DEFAULT_DIMM_ID
42           The default display of PMem module identifiers. One of:
43
44           •   UID: Use the DimmUID attribute as defined in the command [Show
45               Dimm].
46
47           •   HANDLE: Use the DimmHandle attribute as defined in the command
48               [Show Dimm]. This is the default.
49
50       CLI_DEFAULT_SIZE
51           The default display of capacities in the CLI. One of:
52
53           •   AUTO: Automatically choose the best format for each capacity in
54               binary multiples of bytes (i.e., B, MiB, GiB or TiB). This is
55               the default.
56
57           •   AUTO_10: AUTO_10: Automatically choose the best format for each
58               capacity in decimal multiples of bytes (i.e., B, MB, GB or TB).
59
60           •   B: Displays all capacities in bytes.
61
62           •   MB: Displays all capacities in megabytes.
63
64           •   MiB: Displays all capacities in mebibytes.
65
66           •   GB: Displays all capacities in gigabytes.
67
68           •   GiB: Displays all capacities in gibibytes.
69
70           •   TB: Displays all capacities in terabytes.
71
72           •   TiB: Displays all capacities in tebibytes.
73
74       APPDIRECT_SETTINGS
75           The interleave settings to use when creating App Direct capacity in
76           the format: (IMCSize_ChannelSize). The default is "RECOMMENDED"
77           which uses the BIOS recommended App Direct settings returned by the
78           command [Show System Capabilities].
79
80       DBG_LOG_LEVEL
81           Whether debug logging is enabled in the PMem module host software.
82           These logs pertain to the operation of the command-line tool only
83           and do not reflect any logging functionality of the PMem module.
84           One of:
85
86           •   0: Logging is disabled. This is the default.
87
88           •   1: Log Errors.
89
90           •   2: Log Warnings, Errors.
91
92           •   3: Log Informational, Warnings, Errors.
93
94           •   4: Log Verbose, Informational, Warnings, Errors.
95
96
97
98ipmctl                            2023-07-20        IPMCTL-SHOW-PREFERENCES(1)