1IPMCTL(1)                           ipmctl                           IPMCTL(1)
2
3
4

NAME

6       ipmctl - Utility for managing Intel Optane DC persistent memory modules
7       (DCPMM)
8

SYNOPSIS

10       ipmctl COMMAND [OPTIONS] [TARGETS] [PROPERTIES]
11

OPTIONS

13       -h, --help
14           Run ipmctl help command.
15

DESCRIPTION

17       Utility for managing Intel Optane DC persistent memory modules (DCPMM)
18
19       Supports functionality to:
20
21       ·   Discover DCPMMs on the platform.
22
23       ·   Provision the platform memory configuration.
24
25       ·   View and update the firmware on DCPMMs.
26
27       ·   Configure data-at-rest security on DCPMMs.
28
29       ·   Monitor DCPMM health.
30
31       ·   Track performance of DCPMMs.
32
33       ·   Debug and troubleshoot DCPMMs.
34

COMMANDS

36   DEVICE DISCOVERY
37       Discover DCPMMs on the platform.
38
39       ipmctl-show-device(1)
40           Shows information about one or more DCPMMs
41
42       ipmctl-show-memory-resources(1)
43           Shows the total DCPMM memory resource allocation
44
45       ipmctl-show-socket(1)
46           Shows basic information about the physical processors
47
48       ipmctl-show-system-capabilities(1)
49           Shows the platform supported DCPMM capabilities
50
51       ipmctl-show-topology(1)
52           Shows the topology of the memory installed
53
54   MEMORY SUBSYSTEM PROVISIONING
55       Provision the platform memory configuration and configure data-at-rest
56       security on DCPMMs.
57
58       ipmctl-change-device-passphrase(1)
59           Changes the security passphrase on DCPMM
60
61       ipmctl-change-device-security(1)
62           Changes the DCPMM security lock state
63
64       ipmctl-create-goal(1)
65           Creates a memory allocation goal on one or more DCPMM
66
67       ipmctl-delete-goal(1)
68           Deletes a memory allocation goal on one or more DCPMM
69
70       ipmctl-dump-goal(1)
71           Stores the current system configuration in a file
72
73       ipmctl-enable-device-security(1)
74           Enable data-at-rest security on DCPMM
75
76       ipmctl-erase-device-data(1)
77           Erases the persistent data on one or more DCPMMs
78
79       ipmctl-load-goal(1)
80           Load a memory allocation goal from a file onto DCPMMs
81
82       ipmctl-show-goal(1)
83           Shows the memory allocation goal on one or more DCPMM
84
85       ipmctl-show-region(1)
86           Retrieves a list of persistent memory regions
87
88   INSTRUMENTATION
89       Monitor health and track performance of DCPMMs.
90
91       ipmctl-change-sensor(1)
92           Changes the threshold or enabled state for DCPMMs sensors
93
94       ipmctl-show-performance(1)
95           Shows performance metrics for one or more DCPMMs
96
97       ipmctl-show-sensor(1)
98           Shows health statistics for one or more DCPMMs
99
100   SUPPORT AND MAINTENANCE
101       View and update the firmware on DCPMMs. Other support and maintenance
102       commands.
103
104       ipmctl-acknowledge-event(1)
105           Turns off the flag that signals a corrective action on an event
106
107       ipmctl-change-preference(1)
108           Modifies one or more user preferences
109
110       ipmctl-dump-support(1)
111           Dumps a support snapshot to a file
112
113       ipmctl-help(1)
114           Shows help for the supported commands
115
116       ipmctl-modify-device(1)
117           Changes the configurable setting(s) on one or more DCPMMs
118
119       ipmctl-show-events(1)
120           Shows DCPMM related events
121
122       ipmctl-show-firmware(1)
123           Shows detailed information about the firmware
124
125       ipmctl-show-host(1)
126           Shows basic information about the host server
127
128       ipmctl-show-preferences(1)
129           Displays a list of the DCPMM software user preferences
130
131       ipmctl-update-firmware(1)
132           Updates the firmware on one or more DCPMMs.
133
134       ipmctl-version(1)
135           Shows the DCPMM host software versions
136
137   DEBUG
138       Debug and troubleshoot DCPMMs.
139
140       ipmctl-dump-debug-log(1)
141           Dumps encoded firmware debug logs from DCPMM
142
143       ipmctl-inject-error(1)
144           Injects an error or clears a previously injected error
145
146       ipmctl-run-diagnostic(1)
147           Runs a diagnostic test
148
149       ipmctl-show-acpi(1)
150           Shows the system ACPI tables related to the DCPMMs
151
152       ipmctl-show-error-log(1)
153           Shows thermal or media errors on the specified DCPMMs
154
155       ipmctl-show-pcd(1)
156           Shows the platform configuration data for one or more DCPMMs
157

SEE ALSO

159       ipmctl-show-device(1), ipmctl-show-memory-resources(1),
160       ipmctl-show-socket(1), ipmctl-show-system-capabilities(1),
161       ipmctl-show-topology(1), ipmctl-change-device-passphrase(1),
162       ipmctl-change-device-security(1), ipmctl-create-goal(1),
163       ipmctl-create-goal(1), ipmctl-delete-goal(1), ipmctl-dump-goal(1),
164       ipmctl-enable-device-security(1), ipmctl-erase-device-data(1),
165       ipmctl-load-goal(1), ipmctl-show-goal(1), ipmctl-show-region(1),
166       ipmctl-change-sensor(1), ipmctl-show-performance(1),
167       ipmctl-show-sensor(1), ipmctl-acknowledge-event(1),
168       ipmctl-change-preference(1), ipmctl-dump-support(1), ipmctl-help(1),
169       ipmctl-modify-device(1), ipmctl-show-events(1),
170       ipmctl-show-firmware(1), ipmctl-show-host(1),
171       ipmctl-show-preferences(1), ipmctl-update-firmware(1),
172       ipmctl-version(1), ipmctl-dump-debug-log(1), ipmctl-inject-error(1),
173       ipmctl-run-diagnostic(1), ipmctl-show-acpi(1),
174       ipmctl-show-error-log(1), ipmctl-show-pcd(1)
175

NOTES

177       <https://github.com/intel/ipmctl>
178
179
180
181ipmctl                            2019-10-23                         IPMCTL(1)