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 DCPMM software.
13

OPTIONS

15       -h, -help
16           Displays help for the command.
17
18       -o (text|nvmxml), -output (text|nvmxml)
19           Changes the output format. One of: "text" (default) or "nvmxml".
20

PROPERTIES

22       CLI_DEFAULT_DIMM_ID
23           The default display of DCPMM identifiers. One of:
24
25           ·   "UID": Use the DimmUID attribute as defined in the section Show
26               Device.
27
28           ·   "HANDLE": Use the DimmHandle attribute as defined in section
29               Show Device. This is the default
30
31       CLI_DEFAULT_SIZE
32           The default display of capacities in the CLI. One of:
33
34           ·   "AUTO": Automatically choose the best format for each capacity
35               in binary multiples of bytes (i.e., B, MiB, GiB or TiB). This
36               is the default.
37
38           ·   "AUTO_10": Automatically choose the best format for each
39               capacity in decimal multiples of bytes (i.e., B, MB, GB or TB).
40
41           ·   "B": Displays all capacities in bytes.
42
43           ·   "MB": Displays all capacities in megabytes.
44
45           ·   "MiB": Displays all capacities in mebibytes.
46
47           ·   "GB": Displays all capacities in gigabytes.
48
49           ·   "GiB": Displays all capacities in gibibytes.
50
51           ·   "TB": Displays all capacities in terabytes.
52
53           ·   "TiB": Displays all capacities in tebibytes.
54
55       APPDIRECT_SETTINGS
56           The interleave settings to use when creating App Direct capacity in
57           the format: (IMCSize_ChannelSize). Must be one of the BIOS
58           supported App Direct settings returned by the command Show System
59           Capabilities.
60
61           Note
62           ByOne is not a valid setting for this preference. The default is
63           "RECOMMENDED" which uses the BIOS recommended App Direct settings.
64
65           Note
66           The same interleave settings are used for all the App Direct
67           capacity in the system. Therefore, if any App Direct capacity
68           already exists, this preference cannot be changed.
69
70       APPDIRECT_GRANULARITY
71           The minimum App Direct granularity per DCPMM supported by the
72           command Create Memory Allocation Goal. One of:
73
74           ·   "RECOMMENDED": Use the recommended App Direct granularity of 32
75               GiB.
76
77           ·   "1": Allows 1 GiB App Direct granularity which may result in
78               App Direct region sizes that are not recommended.
79
80       PERFORMANCE_MONITOR_ENABLED
81           Whether or not the monitor is periodically storing performance
82           metrics for the DCPMMs in the host server. One of:
83
84           ·   "0": Disable performance monitoring.
85
86           ·   "1": Enable performance monitoring. This is the default.
87
88       PERFORMANCE_MONITOR_INTERVAL_MINUTES
89           The interval in minutes that the monitor is storing performance
90           metrics (if enabled). The default value is 180 minutes and must be
91           >= 1.
92
93       EVENT_MONITOR_ENABLED
94           Whether or not the monitor is periodically checking for DCPMM
95           events.
96
97           ·   "0": Disable event monitoring.
98
99           ·   "1": Enable event monitoring. This is the default.
100
101       EVENT_MONITOR_INTERVAL_MINUTES
102           The interval in minutes that the monitor is checking for DCPMM
103           events (if enabled). The default value is 1 minutes and must be >=
104           1.
105
106       EVENT_LOG_MAX
107           The maximum number of events to keep in the management software.
108           The default value is 0 (no limit). The valid range is 0 -
109           2,147,483,647.
110
111       DBG_LOG_MAX
112           The maximum number of debug log entries to keep in the management
113           software. The default value is 0 (no limit). The valid range is 0 -
114           2,147,483,647.
115
116       DBG_LOG_LEVEL
117           Whether debug logging is enabled in the DCPMM host software. These
118           logs pertain to the operation of the command-line tool only and do
119           not reflect any logging functionality of the DCPMM. One of:
120
121           ·   "0": Logging is disabled. This is the default.
122
123           ·   "1": Log Errors.
124
125           ·   "2": Log Warnings, Errors.
126
127           ·   "3": Log Informational, Warnings, Errors.
128
129           ·   "4": Log Verbose, Informational, Warnings, Errors.
130

EXAMPLES

132       Use DimmUID as the default DCPMM identifier, and display all capacities
133       in bytes.
134
135       ipmctl set -preferences CLI_DEFAULT_DIMM_ID=UID CLI_DEFAULT_SIZE=B
136

RETURN DATA

138       Returns the status of the operation.
139

SAMPLE OUTPUT

141       Set (Property)=(Value): Success|Error (Code)-(Description)
142
143
144
145ipmctl                            2019-04-10      IPMCTL-CHANGE-PREFERENCES(1)
Impressum