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

NAME

6       ipmctl-change-preferences - Modifies one or more user preferences
7

SYNOPSIS

9           ipmctl set [OPTIONS] -preferences [PROPERTIES]
10

DESCRIPTION

12       Modifies one or more user preferences in the PMem module software.
13

OPTIONS

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

PROPERTIES

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

EXAMPLES

99       Use DimmUID as the default PMem module identifier and display all
100       capacities in bytes.
101
102           ipmctl set -preferences CLI_DEFAULT_DIMM_ID=UID CLI_DEFAULT_SIZE=B
103

RETURN DATA

105       Returns the status of the operation.
106

SAMPLE OUTPUT

108           Set (Property)=(Value): Success|Error (Code)-(Description)
109
110
111
112ipmctl                            2021-05-13      IPMCTL-CHANGE-PREFERENCES(1)
Impressum