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, --help

Run ipmctl help command.

DESCRIPTION¶

Utility for managing Intel® Optane™ PMem modules

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.

ipmctl-show-dimm(1)

Shows information about one or more PMem modules

ipmctl-show-memory-resources(1)

Shows memory allocation information for this platform

ipmctl-show-socket(1)

Shows basic information about the physical processors

ipmctl-show-system-capabilities(1)

Shows the platform supported PMem module capabilities

ipmctl-show-topology(1)

Shows the topology of the memory installed

MEMORY SUBSYSTEM PROVISIONING¶

Provision the platform memory configuration and configure data-at-rest security on PMem modules.

ipmctl-create-goal(1)

Creates a memory allocation goal on one or more PMem module

ipmctl-delete-goal(1)

Deletes a memory allocation goal on one or more PMem module

ipmctl-dump-goal(1)

Stores the current system configuration in a file

ipmctl-load-goal(1)

Load a memory allocation goal from a file onto PMem modules

ipmctl-show-goal(1)

Shows the memory allocation goal on one or more PMem module

ipmctl-show-region(1)

Retrieves a list of persistent memory regions

INSTRUMENTATION¶

Monitor health and track performance of PMem modules.

ipmctl-set-sensor(1)

Sets the threshold or enabled state for PMem modules sensors

ipmctl-show-performance(1)

Shows performance metrics for one or more PMem modules

ipmctl-show-sensor(1)

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-set-preferences(1)

Modifies one or more user preferences

ipmctl-dump-support(1)

Dumps a support snapshot to a file

ipmctl-help(1)

Shows help for the supported commands

ipmctl-set-dimm(1)

Changes the configurable settings on one or more PMem modules

ipmctl-show-firmware(1)

Shows detailed information about the firmware

ipmctl-show-preferences(1)

Displays a list of the PMem module software user preferences

ipmctl-load-dimm(1)

Updates the firmware on one or more PMem modules.

ipmctl-version(1)

Shows the PMem module host software versions

DEBUG¶

Debug and troubleshoot PMem modules.

ipmctl-delete-pcd(1) Clears select partition data from the PCD

ipmctl-dump-debug-log(1)

Dumps encoded firmware debug logs from PMem module

ipmctl-inject-error(1)

Injects an error or clears a previously injected error

ipmctl-show-cap(1)

Shows the current Command Access Policy restrictions.

ipmctl-show-cel(1)

Shows the current Command Effect Log.

ipmctl-start-diagnostic(1)

Runs a diagnostic test

ipmctl-show-system(1)

Shows the system ACPI tables related to the PMem modules

ipmctl-show-error-log(1)

Shows thermal or media errors on the specified PMem modules

ipmctl-show-pcd(1)

Shows the platform configuration data for one or more PMem modules

ipmctl-dump-session(1)

Dumps the active session to a file

ipmctl-load-session(1)

Loads a session from a file into memory

ipmctl-show-session(1)

Displays information about an active session

ipmctl-start-session(1)

Starts a recording or playback session

ipmctl-stop-session(1)

Stops a recording or playback session

NOTES¶

<https://github.com/intel/ipmctl>

2022-09-26