---
name: "ipmctl"
section: "1"
platform: "linux"
package: "ipmctl"
version: "03.00.00.0468-1"
release: "Debian 12 (Bookworm)"
platforms: ["linux"]
url: "https://new.carta.tech/ipmctl"
---

# ipmctl(1)

Utility for managing Intel(R) Optane(TM) Persistent Memory Modules (PMem module)

## 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)](/ipmctl-show-dimm/1.md)

Shows information about one or more PMem modules

[**ipmctl-show-memory-resources**(1)](/ipmctl-show-memory-resources/1.md)

Shows memory allocation information for this platform

**[ipmctl-show-socket(1)](/ipmctl-show-socket/1.md)**

Shows basic information about the physical processors

[**ipmctl-show-system-capabilities**(1)](/ipmctl-show-system-capabilities/1.md)

Shows the platform supported PMem module capabilities

**[ipmctl-show-topology(1)](/ipmctl-show-topology/1.md)**

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)](/ipmctl-create-goal/1.md)**

Creates a memory allocation goal on one or more PMem module

**[ipmctl-delete-goal(1)](/ipmctl-delete-goal/1.md)**

Deletes a memory allocation goal on one or more PMem module

**[ipmctl-dump-goal(1)](/ipmctl-dump-goal/1.md)**

Stores the current system configuration in a file

**[ipmctl-load-goal(1)](/ipmctl-load-goal/1.md)**

Load a memory allocation goal from a file onto PMem modules

**[ipmctl-show-goal(1)](/ipmctl-show-goal/1.md)**

Shows the memory allocation goal on one or more PMem module

**[ipmctl-show-region(1)](/ipmctl-show-region/1.md)**

Retrieves a list of persistent memory regions

### INSTRUMENTATION

Monitor health and track performance of PMem modules.

[**ipmctl-set-sensor**(1)](/ipmctl-set-sensor/1.md)

Sets the threshold or enabled state for PMem modules sensors

[**ipmctl-show-performance**(1)](/ipmctl-show-performance/1.md)

Shows performance metrics for one or more PMem modules

[**ipmctl-show-sensor**(1)](/ipmctl-show-sensor/1.md)

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)](/ipmctl-set-preferences/1.md)

Modifies one or more user preferences

**ipmctl-dump-support**(1)

Dumps a support snapshot to a file

[**ipmctl-help**(1)](/ipmctl-help/1.md)

Shows help for the supported commands

[**ipmctl-set-dimm**(1)](/ipmctl-set-dimm/1.md)

Changes the configurable settings on one or more PMem modules

[**ipmctl-show-firmware**(1)](/ipmctl-show-firmware/1.md)

Shows detailed information about the firmware

[**ipmctl-show-preferences**(1)](/ipmctl-show-preferences/1.md)

Displays a list of the PMem module software user preferences

[**ipmctl-load-dimm**(1)](/ipmctl-load-dimm/1.md)

Updates the firmware on one or more PMem modules.

[**ipmctl-version**(1)](/ipmctl-version/1.md)

Shows the PMem module host software versions

### DEBUG

Debug and troubleshoot PMem modules.

[**ipmctl-delete-pcd**(1)](/ipmctl-delete-pcd/1.md) Clears select partition data from the PCD

[**ipmctl-dump-debug-log**(1)](/ipmctl-dump-debug-log/1.md)

Dumps encoded firmware debug logs from PMem module

[**ipmctl-inject-error**(1)](/ipmctl-inject-error/1.md)

Injects an error or clears a previously injected error

[**ipmctl-show-cap**(1)](/ipmctl-show-cap/1.md)

Shows the current Command Access Policy restrictions.

[**ipmctl-show-cel**(1)](/ipmctl-show-cel/1.md)

Shows the current Command Effect Log.

[**ipmctl-start-diagnostic**(1)](/ipmctl-start-diagnostic/1.md)

Runs a diagnostic test

[**ipmctl-show-system**(1)](/ipmctl-show-system/1.md)

Shows the system ACPI tables related to the PMem modules

[**ipmctl-show-error-log**(1)](/ipmctl-show-error-log/1.md)

Shows thermal or media errors on the specified PMem modules

[**ipmctl-show-pcd**(1)](/ipmctl-show-pcd/1.md)

Shows the platform configuration data for one or more PMem modules

[**ipmctl-dump-session**(1)](/ipmctl-dump-session/1.md)

Dumps the active session to a file

[**ipmctl-load-session**(1)](/ipmctl-load-session/1.md)

Loads a session from a file into memory

[**ipmctl-show-session**(1)](/ipmctl-show-session/1.md)

Displays information about an active session

[**ipmctl-start-session**(1)](/ipmctl-start-session/1.md)

Starts a recording or playback session

[**ipmctl-stop-session**(1)](/ipmctl-stop-session/1.md)

Stops a recording or playback session

## SEE ALSO

[**ipmctl-show-dimm**(1)](/ipmctl-show-dimm/1.md), [**ipmctl-show-memory-resources**(1)](/ipmctl-show-memory-resources/1.md), [**ipmctl-show-socket**(1)](/ipmctl-show-socket/1.md), [**ipmctl-show-system-capabilities**(1)](/ipmctl-show-system-capabilities/1.md), [**ipmctl-show-topology**(1)](/ipmctl-show-topology/1.md), [**ipmctl-create-goal**(1)](/ipmctl-create-goal/1.md), [**ipmctl-create-goal**(1)](/ipmctl-create-goal/1.md), [**ipmctl-delete-goal**(1)](/ipmctl-delete-goal/1.md), [**ipmctl-dump-goal**(1)](/ipmctl-dump-goal/1.md), [**ipmctl-load-goal**(1)](/ipmctl-load-goal/1.md), [**ipmctl-show-goal**(1)](/ipmctl-show-goal/1.md), [**ipmctl-show-region**(1)](/ipmctl-show-region/1.md), [**ipmctl-set-sensor**(1)](/ipmctl-set-sensor/1.md), [**ipmctl-show-performance**(1)](/ipmctl-show-performance/1.md), [**ipmctl-show-sensor**(1)](/ipmctl-show-sensor/1.md), [**ipmctl-set-preferences**(1)](/ipmctl-set-preferences/1.md), **ipmctl-dump-support**(1), [**ipmctl-help**(1)](/ipmctl-help/1.md), [**ipmctl-set-dimm**(1)](/ipmctl-set-dimm/1.md), [**ipmctl-show-firmware**(1)](/ipmctl-show-firmware/1.md), [**ipmctl-show-preferences**(1)](/ipmctl-show-preferences/1.md), [**ipmctl-load-dimm**(1)](/ipmctl-load-dimm/1.md), [**ipmctl-version**(1)](/ipmctl-version/1.md), [**ipmctl-delete-pcd**(1)](/ipmctl-delete-pcd/1.md), [**ipmctl-dump-debug-log**(1)](/ipmctl-dump-debug-log/1.md), [**ipmctl-inject-error**(1)](/ipmctl-inject-error/1.md), [**ipmctl-show-cap**(1)](/ipmctl-show-cap/1.md), [**ipmctl-show-cel**(1)](/ipmctl-show-cel/1.md), [**ipmctl-start-diagnostic**(1)](/ipmctl-start-diagnostic/1.md), [**ipmctl-show-system**(1)](/ipmctl-show-system/1.md), [**ipmctl-show-error-log**(1)](/ipmctl-show-error-log/1.md), [**ipmctl-show-pcd**(1)](/ipmctl-show-pcd/1.md) [**ipmctl-dump-session**(1)](/ipmctl-dump-session/1.md) [**ipmctl-load-session**(1)](/ipmctl-load-session/1.md) [**ipmctl-show-session**(1)](/ipmctl-show-session/1.md) [**ipmctl-start-session**(1)](/ipmctl-start-session/1.md) [**ipmctl-stop-session**(1)](/ipmctl-stop-session/1.md)

## NOTES

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