ipmctl-delete-pcd - Man Page

Clears select partition data from the PCD

Synopsis

ipmctl delete [OPTIONS] -pcd [TARGETS]

Description

When Config is specified, the Current, Input, and Output Data Size and Start Offset values in the Configuration header are set to zero, making those tables invalid.

Note

When Config is specified, only PCD partition 1 is modified. If the platform is rebooted prior to creating a new goal on any targeted PMem modules, UEFI platform firmware will detect the missing tables and, if possible, restore previous config using the PCD partition 0 tables.

Note

This action can be useful when moving PMem modules from one system to another, as goal creation rules may restrict provisioning PMem modules with an existing configuration. Deleting the PCD can be used as a way to prepare a PMem module for provisioning with the create -goal or load -goal commands by clearing existing configuration metadata. This allows the PMem module to be provisioned in isolation using the create-goal command with the -dimm option. Once the PCD has been deleted the desired goal should be created before rebooting.

Warning

This command may result in data loss. Data should be backed up to other storage before executing this command. Because of data dependencies, other commands may be affected until the system has been rebooted.

Options

-f, -force

Deleting the PCD data is a destructive operation which requires confirmation from the user for each PMem module. This option suppresses the confirmation.

-h, -help

Displays help for the command.

-ddrt

Used to specify DDRT as the desired transport protocol for the current invocation of ipmctl.

-smbus

Used to specify SMBUS as the desired transport protocol for the current invocation of ipmctl.
Note

The -ddrt and -smbus options are mutually exclusive and may not be used together.

-lpmb

Used to specify large transport payload size for the current invocation of ipmctl.

-spmb

Used to specify small transport payload size for the current invocation of ipmctl.
Note

The -lpmb and -spmb options are mutually exclusive and may not be used together.

-o (text|nvmxml), -output (text|nvmxml)

Changes the output format. One of: "text" (default) or "nvmxml".

Targets

-dimm [DimmIDs]

Deletes the PCD data on specific PMem modules by supplying one or more comma separated PMem module identifiers. The default is to delete the PCD data for all manageable PMem modules.

-pcd [Config]

Clears the configuration management information.

Examples

Clears the Cin, Cout, Ccur tables from all manageable PMem modules

delete -dimm -pcd Config

Limitations

The specified PMem modules must be manageable by the host software, and if data-at-rest security is enabled, the PMem modules must be unlocked. Any existing namespaces associated with the requested PMem modules should be deleted before running this command.

Return Data

For each PMem module, the CLI will indicate the status of the operation. If a failure occurs when deleting the platform configuration data from multiple PMem modules, the process will continue deleting the remaining PMem modules.

Referenced By

ipmctl(1).

2020-10-15 ipmctl