1IPMCTL-ERASE-DEVICE-DATA(1)         ipmctl         IPMCTL-ERASE-DEVICE-DATA(1)
2
3
4

NAME

6       ipmctl-erase-device-data - Erases the persistent data on one or more
7       DCPMMs
8
9           Note
10           This command is subject to OS Vendor (OSV) support. It will return
11           "Not Supported."
12

SYNOPSIS

14       ipmctl delete [OPTIONS] -dimm [TARGETS] Passphrase=(string)
15

DESCRIPTION

17       Erases the persistent data on one or more DCPMMs.
18

OPTIONS

20       -f, -force
21           Erasing DCPMM data is a destructive operation which requires
22           confirmation from the user for each DCPMM. This option suppresses
23           the confirmation.
24
25       -h, -help
26           Displays help for the command.
27
28       -o (text|nvmxml), -output (text|nvmxml)
29           Changes the output format. One of: "text" (default) or "nvmxml".
30
31       -source (path)
32           File path to a local file containing the new passphrase (1-32
33           characters).
34

TARGETS

36       -dimm (DimmIDs)
37           Erases specific specifics by supplying one or more comma-separated
38           specific identifiers. However, this is not recommended as it may
39           put the system in an undesirable state. The default is to erase all
40           manageable DCPMMs.
41

PROPERTIES

43       Passphrase
44           If security state is disabled, then passphrase is not required and
45           will be ignored if supplied.
46           If security state is enabled, then a passphrase must be supplied.
47           The current passphrase (1-32 characters). For better passphrase
48           protection, specify an empty string (e.g., Passphrase="") to be
49           prompted for the passphrase or to use a file containing the
50           passphrase with the source option.
51

EXAMPLES

53       Security disabled DCPMMs: Erases all the persistent data on all DCPMMs
54       in the system.
55
56       ipmctl delete -dimm
57
58       Security enabled specifics: Erases all the persistent data on all
59       DCPMMs in the system.
60
61       ipmctl delete -dimm Passphrase=123
62
63       Erases all the persistent data on all DCPMMs by having the CLI prompt
64       for the current passphrase.
65
66       ipmctl delete -dimm Passphrase=""
67

LIMITATIONS

69       To successfully execute this command, the caller must have the
70       appropriate privileges and the specified DCPMM(s) must be manageable by
71       the host software, not be in the "Unlocked, Frozen", "Disabled,
72       Frozen", or "Exceeded" lock states and any namespaces associated with
73       the requested DCPMM(s) must be deleted before running this command.
74
75       The command is subject to OS Vendor (OSV) support. If OSV does not
76       provide support, the command will return "Not Supported."
77

RETURN DATA

79       If an empty string is provided for the passphrase property and the
80       source option is not included, the user will be prompted (once for all
81       DCPMMs) to enter the current passphrase. The passphrase characters are
82       hidden.
83
84       Current passphrase: **
85
86       For each DCPMM, the CLI will indicate the status of the security state
87       change. If a failure occurs when changing multiple DCPMMs, the process
88       will exit and not continue updating the remaining DCPMMs.
89

SAMPLE OUTPUT

91       Erase DIMM (DimmID): Success
92       Erase DIMM (DimmID): Error (Code) - (Description)
93
94
95
96ipmctl                            2019-10-23       IPMCTL-ERASE-DEVICE-DATA(1)
Impressum