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

NAME

6       ipmctl - Utility for managing Intel(R) Optane(TM) persistent memory
7       modules (PMem module)
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™ persistent memory modules (PMem
18       module)
19
20       Supports functionality to:
21
22       •   Discover PMem modules on the platform.
23
24       •   Provision the platform memory configuration.
25
26       •   View and update the firmware on PMem modules.
27
28       •   Configure data-at-rest security on PMem modules.
29
30       •   Monitor PMem module health.
31
32       •   Track performance of PMem modules.
33
34       •   Debug and troubleshoot PMem modules.
35

COMMANDS

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

SEE ALSO

162       ipmctl-show-device(1), ipmctl-show-memory-resources(1),
163       ipmctl-show-socket(1), ipmctl-show-system-capabilities(1),
164       ipmctl-show-topology(1), ipmctl-create-goal(1), ipmctl-create-goal(1),
165       ipmctl-delete-goal(1), ipmctl-dump-goal(1), ipmctl-load-goal(1),
166       ipmctl-show-goal(1), ipmctl-show-region(1), ipmctl-change-sensor(1),
167       ipmctl-show-performance(1), ipmctl-show-sensor(1),
168       ipmctl-change-preference(1), ipmctl-dump-support(1), ipmctl-help(1),
169       ipmctl-modify-device(1), ipmctl-show-firmware(1),
170       ipmctl-show-preferences(1), ipmctl-update-firmware(1),
171       ipmctl-version(1), impctl-delete-pcd(1), ipmctl-dump-debug-log(1),
172       ipmctl-inject-error(1), ipmctl-show-cap(1), ipmctl-show-cel(1),
173       ipmctl-start-diagnostic(1), ipmctl-show-acpi(1),
174       ipmctl-show-error-log(1), ipmctl-show-pcd(1) ipmctl-dump-session(1)
175       ipmctl-load-session(1) ipmctl-show-session(1) ipmctl-start-session(1)
176       ipmctl-stop-session(1)
177

NOTES

179       https://github.com/intel/ipmctl
180
181
182
183ipmctl                            2021-08-24                         IPMCTL(1)