other versions
- buster-backports 02.00.00.3852+ds-1~bpo10+1
- testing 02.00.00.3852+ds-1
- unstable 02.00.00.3852+ds-1
IPMCTL(1) | ipmctl | IPMCTL(1) |
NAME¶
ipmctl - Utility for managing Intel(R) Optane(TM) persistent memory modules (PMem module)SYNOPSIS¶
ipmctl COMMAND [OPTIONS] [TARGETS] [PROPERTIES]
OPTIONS¶
-h, --helpRun ipmctl help command.
DESCRIPTION¶
Utility for managing Intel® Optane™ persistent memory modules (PMem module)Supports functionality to:
•Discover PMem modules on the platform.
•Provision the platform memory
configuration.
•View and update the firmware on PMem
modules.
•Configure data-at-rest security on PMem
modules.
•Monitor PMem module health.
•Track performance of PMem modules.
•Debug and troubleshoot PMem modules.
COMMANDS¶
DEVICE DISCOVERY¶
Discover PMem modules on the platform.Shows information about one or more PMem modules
ipmctl-show-memory-resources(1)
Shows memory allocation information for this
platform
Shows basic information about the physical
processors
ipmctl-show-system-capabilities(1)
Shows the platform supported PMem module
capabilities
Shows the topology of the memory installed
MEMORY SUBSYSTEM PROVISIONING¶
Provision the platform memory configuration and configure data-at-rest security on PMem modules.Creates a memory allocation goal on one or more PMem
module
Deletes a memory allocation goal on one or more PMem
module
Stores the current system configuration in a file
Load a memory allocation goal from a file onto PMem
modules
Shows the memory allocation goal on one or more PMem
module
Retrieves a list of persistent memory regions
INSTRUMENTATION¶
Monitor health and track performance of PMem modules.Changes the threshold or enabled state for PMem modules
sensors
Shows performance metrics for one or more PMem
modules
Shows health statistics for one or more PMem
modules
SUPPORT AND MAINTENANCE¶
View and update the firmware on PMem modules. Other support and maintenance commands.ipmctl-change-preference(1)
Modifies one or more user preferences
ipmctl-dump-support(1)
Dumps a support snapshot to a file
Shows help for the supported commands
Changes the configurable settings on one or more PMem
modules
Shows detailed information about the firmware
Displays a list of the PMem module software user
preferences
Updates the firmware on one or more PMem modules.
Shows the PMem module host software versions
DEBUG¶
Debug and troubleshoot PMem modules.ipmctl-delete-pcd(1) Clears select partition data from the PCD
Dumps encoded firmware debug logs from PMem module
Injects an error or clears a previously injected
error
Shows the current Command Access Policy
restrictions.
Shows the current Command Effect Log.
Runs a diagnostic test
Shows the system ACPI tables related to the PMem
modules
Shows thermal or media errors on the specified PMem
modules
Shows the platform configuration data for one or more
PMem modules
Dumps the active session to a file
Loads a session from a file into memory
Displays information about an active session
Starts a recording or playback session
Stops a recording or playback session
SEE ALSO¶
ipmctl-show-device(1), ipmctl-show-memory-resources(1), ipmctl-show-socket(1), ipmctl-show-system-capabilities(1), ipmctl-show-topology(1), ipmctl-create-goal(1), ipmctl-create-goal(1), ipmctl-delete-goal(1), ipmctl-dump-goal(1), ipmctl-load-goal(1), ipmctl-show-goal(1), ipmctl-show-region(1), ipmctl-change-sensor(1), ipmctl-show-performance(1), ipmctl-show-sensor(1), ipmctl-change-preference(1), ipmctl-dump-support(1), ipmctl-help(1), ipmctl-modify-device(1), ipmctl-show-firmware(1), ipmctl-show-preferences(1), ipmctl-update-firmware(1), ipmctl-version(1), impctl-delete-pcd(1), ipmctl-dump-debug-log(1), ipmctl-inject-error(1), ipmctl-show-cap(1), ipmctl-show-cel(1), ipmctl-start-diagnostic(1), ipmctl-show-acpi(1), ipmctl-show-error-log(1), ipmctl-show-pcd(1) ipmctl-dump-session(1) ipmctl-load-session(1) ipmctl-show-session(1) ipmctl-start-session(1) ipmctl-stop-session(1)NOTES¶
<https://github.com/intel/ipmctl>2021-02-28 | ipmctl |