Basic Usage

The ipmctl utility has many options. A complete list of commands can be shown by executing ipmctl with no arguments, ipmctl help, or reading the ipmctl(1) man page. Running ipmctlrequires root privileges. ipmctl can also be used from UEFI. Namespaces are created using ipmctl at UEFI level or the ndctl utility.

Usage:

ipmctl COMMAND [OPTIONS] [TARGETS] [PROPERTIES]

Items in square brackets [..] are optional. Options, targets, and property values are separated by a pipe | meaning "or", and the default value is italicized. Items in parenthesis (..) indicate a user supplied value.

ipmctl commands include:

• create

• delete

• dump

• help

• load

• set

• show

• start

• version

More information can be shown for each command using the -verbose flag, which is helpful for debugging.

A video recorded by Lenovo shows How to use ipmctl commands to monitor Intel® Optane™ DC Persistent Memory Module health status on Microsoft Windows. It provides an introduction to using ipmctl. The commands are the same on Linux.

To learn more about how ipmctl works with the hardware see the Intel® Optane™ Persistent Memory OS Provisioning Specification, which describes all the firmware interface commands used for this operation.