IPMCTL User Guide
HomePMDKNDCTLBlog
Version 1.x
Version 1.x
  • IPMCTL User Guide
  • Installing IPMCTL
    • Installing IPMCTL packages on Linux
    • Building and Installing IPMCTL from Source on Linux
    • Installing IPMCTL on Microsoft Windows using the MSI Installer
    • Building and Installing IPMCTL on Microsoft Windows from Source
  • Basic Usage
  • Module Discovery
    • Show System Capabilities
    • Show Socket
    • Show Topology
    • Show Memory Resources
    • Show Device
  • Provisioning
    • Concepts
    • Create Memory Allocation Goal
    • Provision App Direct
    • Provision Memory Mode
    • Provision Mixed Mode
    • Show Memory Allocation Goal
    • Dump Memory Allocation Settings
    • Load Memory Allocation Goal
    • Delete Memory Allocation Goal
  • Security
    • Enable Device Security
    • Change Device Passphrase
    • Change Device Security
    • Erase Device Data
  • Instrumentation
    • Show Sensor
    • Change Sensor Settings
    • Show Device Performance
  • Debug
    • Run Diagnostic
    • Show Error Log
    • Dump Debug Log
    • Show ACPI Tables
    • Show Device Platform Configuration Data
    • Delete Device Platform Configuration Data
    • Inject Error
  • Support and Maintenance
    • Show Events
    • Version and Firmware
Powered by GitBook
On this page

Was this helpful?

Basic Usage

PreviousBuilding and Installing IPMCTL on Microsoft Windows from SourceNextModule Discovery

Last updated 5 years ago

Was this helpful?

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 .

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:

  • help

  • load

  • set

  • delete

  • show

  • create

  • dump

  • start

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

A video recorded by Lenovo shows . It provides an introduction for using ipmctl. The commands are the same on Linux.

ndctl utility
How to use ipmctl commands to monitor Intel® Optane™ DC Persistent Memory Module health status on Microsoft Windows