'\" t
.\"     Title: ipmctl
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.12
.\"      Date: 2021-02-17
.\"    Manual: ipmctl
.\"    Source: ipmctl
.\"  Language: English
.\"
.TH "IPMCTL" "1" "2021-02-17" "ipmctl" "ipmctl"
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.ss \n[.ss] 0
.nh
.ad l
.de URL
\fI\\$2\fP <\\$1>\\$3
..
.als MTO URL
.if \n[.g] \{\
.  mso www.tmac
.  am URL
.    ad l
.  .
.  am MTO
.    ad l
.  .
.  LINKSTYLE blue R < >
.\}
.SH "NAME"
ipmctl \- Utility for managing Intel(R) Optane(TM) persistent memory modules (PMem module)
.SH "SYNOPSIS"
.sp
.if n .RS 4
.nf
.fam C
ipmctl COMMAND [OPTIONS] [TARGETS] [PROPERTIES]
.fam
.fi
.if n .RE
.SH "OPTIONS"
.sp
\-h, \-\-help
.RS 4
Run ipmctl help command.
.RE
.SH "DESCRIPTION"
.sp
Utility for managing Intel\(rg Optane\(tm persistent memory modules (PMem module)
.sp
Supports functionality to:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
Discover PMem modules on the platform.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
Provision the platform memory configuration.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
View and update the firmware on PMem modules.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
Configure data\-at\-rest security on PMem modules.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
Monitor PMem module health.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
Track performance of PMem modules.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
Debug and troubleshoot PMem modules.
.RE
.SH "COMMANDS"
.SS "DEVICE DISCOVERY"
.sp
Discover PMem modules on the platform.
.sp
\fBipmctl\-show\-device\fP(1)
.RS 4
Shows information about one or more PMem modules
.RE
.sp
\fBipmctl\-show\-memory\-resources\fP(1)
.RS 4
Shows memory allocation information for this platform
.RE
.sp
\fBipmctl\-show\-socket(1)\fP
.RS 4
Shows basic information about the physical processors
.RE
.sp
\fBipmctl\-show\-system\-capabilities\fP(1)
.RS 4
Shows the platform supported PMem module capabilities
.RE
.sp
\fBipmctl\-show\-topology(1)\fP
.RS 4
Shows the topology of the memory installed
.RE
.SS "MEMORY SUBSYSTEM PROVISIONING"
.sp
Provision the platform memory configuration and configure data\-at\-rest security
on PMem modules.
.sp
\fBipmctl\-create\-goal(1)\fP
.RS 4
Creates a memory allocation goal on one or more PMem module
.RE
.sp
\fBipmctl\-delete\-goal(1)\fP
.RS 4
Deletes a memory allocation goal on one or more PMem module
.RE
.sp
\fBipmctl\-dump\-goal(1)\fP
.RS 4
Stores the current system configuration in a file
.RE
.sp
\fBipmctl\-load\-goal(1)\fP
.RS 4
Load a memory allocation goal from a file onto PMem modules
.RE
.sp
\fBipmctl\-show\-goal(1)\fP
.RS 4
Shows the memory allocation goal on one or more PMem module
.RE
.sp
\fBipmctl\-show\-region(1)\fP
.RS 4
Retrieves a list of persistent memory regions
.RE
.SS "INSTRUMENTATION"
.sp
Monitor health and track performance of PMem modules.
.sp
\fBipmctl\-change\-sensor\fP(1)
.RS 4
Changes the threshold or enabled state for PMem modules sensors
.RE
.sp
\fBipmctl\-show\-performance\fP(1)
.RS 4
Shows performance metrics for one or more PMem modules
.RE
.sp
\fBipmctl\-show\-sensor\fP(1)
.RS 4
Shows health statistics for one or more PMem modules
.RE
.SS "SUPPORT AND MAINTENANCE"
.sp
View and update the firmware on PMem modules. Other support and maintenance commands.
.sp
\fBipmctl\-change\-preference\fP(1)
.RS 4
Modifies one or more user preferences
.RE
.sp
\fBipmctl\-dump\-support\fP(1)
.RS 4
Dumps a support snapshot to a file
.RE
.sp
\fBipmctl\-help\fP(1)
.RS 4
Shows help for the supported commands
.RE
.sp
\fBipmctl\-modify\-device\fP(1)
.RS 4
Changes the configurable settings on one or more PMem modules
.RE
.sp
\fBipmctl\-show\-firmware\fP(1)
.RS 4
Shows detailed information about the firmware
.RE
.sp
\fBipmctl\-show\-preferences\fP(1)
.RS 4
Displays a list of the PMem module software user preferences
.RE
.sp
\fBipmctl\-update\-firmware\fP(1)
.RS 4
Updates the firmware on one or more PMem modules.
.RE
.sp
\fBipmctl\-version\fP(1)
.RS 4
Shows the PMem module host software versions
.RE
.SS "DEBUG"
.sp
Debug and troubleshoot PMem modules.
.sp
\fBipmctl\-delete\-pcd\fP(1)
Clears select partition data from the PCD
.sp
\fBipmctl\-dump\-debug\-log\fP(1)
.RS 4
Dumps encoded firmware debug logs from PMem module
.RE
.sp
\fBipmctl\-inject\-error\fP(1)
.RS 4
Injects an error or clears a previously injected error
.RE
.sp
\fBipmctl\-show\-cap\fP(1)
.RS 4
Shows the current Command Access Policy restrictions.
.RE
.sp
\fBipmctl\-show\-cel\fP(1)
.RS 4
Shows the current Command Effect Log.
.RE
.sp
\fBipmctl\-start\-diagnostic\fP(1)
.RS 4
Runs a diagnostic test
.RE
.sp
\fBipmctl\-show\-acpi\fP(1)
.RS 4
Shows the system ACPI tables related to the PMem modules
.RE
.sp
\fBipmctl\-show\-error\-log\fP(1)
.RS 4
Shows thermal or media errors on the specified PMem modules
.RE
.sp
\fBipmctl\-show\-pcd\fP(1)
.RS 4
Shows the platform configuration data for one or more PMem modules
.RE
.sp
\fBipmctl\-dump\-session\fP(1)
.RS 4
Dumps the active session to a file
.RE
.sp
\fBipmctl\-load\-session\fP(1)
.RS 4
Loads a session from a file into memory
.RE
.sp
\fBipmctl\-show\-session\fP(1)
.RS 4
Displays information about an active session
.RE
.sp
\fBipmctl\-start\-session\fP(1)
.RS 4
Starts a recording or playback session
.RE
.sp
\fBipmctl\-stop\-session\fP(1)
.RS 4
Stops a recording or playback session
.RE
.SH "SEE ALSO"
.sp
\fBipmctl\-show\-device\fP(1),
\fBipmctl\-show\-memory\-resources\fP(1),
\fBipmctl\-show\-socket\fP(1),
\fBipmctl\-show\-system\-capabilities\fP(1),
\fBipmctl\-show\-topology\fP(1),
\fBipmctl\-create\-goal\fP(1),
\fBipmctl\-create\-goal\fP(1),
\fBipmctl\-delete\-goal\fP(1),
\fBipmctl\-dump\-goal\fP(1),
\fBipmctl\-load\-goal\fP(1),
\fBipmctl\-show\-goal\fP(1),
\fBipmctl\-show\-region\fP(1),
\fBipmctl\-change\-sensor\fP(1),
\fBipmctl\-show\-performance\fP(1),
\fBipmctl\-show\-sensor\fP(1),
\fBipmctl\-change\-preference\fP(1),
\fBipmctl\-dump\-support\fP(1),
\fBipmctl\-help\fP(1),
\fBipmctl\-modify\-device\fP(1),
\fBipmctl\-show\-firmware\fP(1),
\fBipmctl\-show\-preferences\fP(1),
\fBipmctl\-update\-firmware\fP(1),
\fBipmctl\-version\fP(1),
\fBimpctl\-delete\-pcd\fP(1),
\fBipmctl\-dump\-debug\-log\fP(1),
\fBipmctl\-inject\-error\fP(1),
\fBipmctl\-show\-cap\fP(1),
\fBipmctl\-show\-cel\fP(1),
\fBipmctl\-start\-diagnostic\fP(1),
\fBipmctl\-show\-acpi\fP(1),
\fBipmctl\-show\-error\-log\fP(1),
\fBipmctl\-show\-pcd\fP(1)
\fBipmctl\-dump\-session\fP(1)
\fBipmctl\-load\-session\fP(1)
\fBipmctl\-show\-session\fP(1)
\fBipmctl\-start\-session\fP(1)
\fBipmctl\-stop\-session\fP(1)
.SH "NOTES"
.sp
.URL "https://github.com/intel/ipmctl" "" ""