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

COMMANDS

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

SEE ALSO

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

NOTES

177       https://github.com/intel/ipmctl
178
179
180
181ipmctl                            2023-07-20                         IPMCTL(1)