1IPMCTL-DELETE-PCD(1)                ipmctl                IPMCTL-DELETE-PCD(1)
2
3
4

NAME

6       ipmctl-delete-pcd - Clears select partition data from the PCD
7

SYNOPSIS

9           ipmctl delete [OPTIONS] -pcd [TARGETS]
10

DESCRIPTION

12       When Config is specified, the Current, Input, and Output Data Size and
13       Start Offset values in the Configuration header are set to zero, making
14       those tables invalid.
15
16           Note
17           When Config is specified, only PCD partition 1 is modified. If the
18           platform is rebooted prior to creating a new goal on any targeted
19           PMem modules, UEFI platform firmware will detect the missing tables
20           and, if possible, restore previous config using the PCD partition 0
21           tables.
22
23           Note
24           This action can be useful when moving PMem modules from one system
25           to another, as goal creation rules may restrict provisioning PMem
26           modules with an existing configuration. Deleting the PCD can be
27           used as a way to prepare a PMem module for provisioning with the
28           create -goal or load -goal commands by clearing existing
29           configuration metadata. This allows the PMem module to be
30           provisioned in isolation using the create-goal command with the
31           -dimm option. Once the PCD has been deleted the desired goal should
32           be created before rebooting.
33
34           Warning
35           This command may result in data loss. Data should be backed up to
36           other storage before executing this command. Because of data
37           dependencies, other commands may be affected until the system has
38           been rebooted.
39

OPTIONS

41       -f, -force
42           Deleting the PCD data is a destructive operation which requires
43           confirmation from the user for each PMem module. This option
44           suppresses the confirmation.
45
46       -h, -help
47           Displays help for the command.
48
49       -ddrt
50           Used to specify DDRT as the desired transport protocol for the
51           current invocation of ipmctl.
52
53       -smbus
54           Used to specify SMBUS as the desired transport protocol for the
55           current invocation of ipmctl.
56
57           Note
58           The -ddrt and -smbus options are mutually exclusive and may not be
59           used together.
60
61       -lpmb
62           Used to specify large transport payload size for the current
63           invocation of ipmctl.
64
65       -spmb
66           Used to specify small transport payload size for the current
67           invocation of ipmctl.
68
69           Note
70           The -lpmb and -spmb options are mutually exclusive and may not be
71           used together.
72
73       -o (text|nvmxml), -output (text|nvmxml)
74           Changes the output format. One of: "text" (default) or "nvmxml".
75

TARGETS

77       -dimm [DimmIDs]
78           Deletes the PCD data on specific PMem modules by supplying one or
79           more comma-separated PMem module identifiers. The default is to
80           delete the PCD data for all manageable PMem modules.
81
82       -pcd [Config]
83           Clears the configuration management information.
84

EXAMPLES

86       Clears the Cin, Cout, Ccur tables from all manageable PMem modules
87
88           delete -dimm -pcd Config
89

LIMITATIONS

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

RETURN DATA

97       For each PMem module, the CLI will indicate the status of the
98       operation. If a failure occurs when deleting the platform configuration
99       data from multiple PMem modules, the process will continue deleting the
100       remaining PMem modules.
101
102
103
104ipmctl                            2020-05-01              IPMCTL-DELETE-PCD(1)
Impressum