'\" t
.\"     Title: ipmctl-erase-device-data
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.10
.\"      Date: 2019-12-15
.\"    Manual: ipmctl
.\"    Source: ipmctl
.\"  Language: English
.\"
.TH "IPMCTL\-ERASE\-DEVICE\-DATA" "1" "2019-12-15" "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\-erase\-device\-data \- Erases the persistent data on one or more DCPMMs on supported OS
.SH "SYNOPSIS"
.sp
.sp
.nf
ipmctl delete [OPTIONS] \-dimm [TARGETS] Passphrase=(string)
.fi
.br
.SH "DESCRIPTION"
.sp
Erases the persistent data on one or more DCPMMs. This commands invokes the DCPMM \fISecure Erase\fP
command.
.if n .sp
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
.B Note
.ps -1
.br
.sp
This command does not zero out the persistent data, but instead randomizes the data.
.sp .5v
.RE
.if n .sp
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
.B Note
.ps -1
.br
.sp
This command is subject to OS Vendor (OSV) support. It will return "Not Supported."
.sp .5v
.RE
.SH "OPTIONS"
.sp
\-f, \-force
.RS 4
Erasing DCPMM data is a destructive operation which requires confirmation from
the user for each DCPMM. This option suppresses the confirmation.
.RE
.sp
\-h, \-help
.RS 4
Displays help for the command.
.RE
.sp
\-ddrt
.RS 4
Used to specify DDRT as the desired transport protocol for the current invocation of ipmctl.
.RE
.sp
\-smbus
.RS 4
Used to specify SMBUS as the desired transport protocol for the current invocation of ipmctl.
.RE
.if n .sp
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
.B Note
.ps -1
.br
.sp
The \-ddrt and \-smbus options are mutually exclusive and may not be used together.
.sp .5v
.RE
.sp
\-master
.RS 4
Erases DCPMMs using master passphrase. Valid only if master passphrase is enabled on specified
DCPMMs (see MasterPassphraseEnabled attribute in section [Show Device]).
.RE
.sp
\-default
.RS 4
Use this option when the current master passphrase is set to the default value. Valid only
if used along with the \fI\-master\fP option. May not be combined with the Passphrase property.
.RE
.sp
\-o (text|nvmxml), \-output (text|nvmxml)
.RS 4
Changes the output format. One of: "text" (default) or "nvmxml".
.RE
.sp
\-source (path)
.RS 4
File path to a local file containing the new passphrase (1\-32 characters).
.RE
.SH "TARGETS"
.sp
\-dimm [DimmIDs]
.RS 4
Erases specific DCPMMs by supplying one or more comma\-separated DCPMM
identifiers. However, this is not recommended as it may put the system in an
undesirable state. The default is to erase all manageable DCPMMs.
.RE
.SH "PROPERTIES"
.sp
Passphrase
.RS 4
If security state is disabled, then passphrase is not required and will be ignored
if supplied.
.br
If security state is enabled, then a passphrase must be supplied.
.br
The current passphrase (1\-32 characters). For better passphrase protection, specify
an empty string (e.g., Passphrase="") to be prompted for the passphrase or to use a
file containing the passphrase with the source option.
.RE
.SH "EXAMPLES"
.sp
Security disabled DCPMMs: Erases all the persistent data on all DCPMMs in the
system.
.sp
.sp
.nf
ipmctl delete \-dimm
.fi
.br
.sp
Security enabled specifics: Erases all the persistent data on all DCPMMs in the
system.
.sp
.sp
.nf
ipmctl delete \-dimm Passphrase=123
.fi
.br
.sp
Security enabled specifics: Erases all the persistent data on all DCPMMs in the
system using the default master passphrase.
.sp
.sp
.nf
ipmctl delete \-master \-default \-dimm
.fi
.br
.sp
Security enabled specifics: Erases all the persistent data on all DCPMMs in the
system using the master passphrase.
.sp
.sp
.nf
ipmctl delete \-master \-dimm Passphrase=masterpassphrase
.fi
.br
.sp
Erases all the persistent data on all DCPMMs by having the CLI prompt for
the current passphrase.
.sp
.sp
.nf
ipmctl delete \-dimm Passphrase=""
.fi
.br
.SH "LIMITATIONS"
.sp
In order to successfully execute this command:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
The caller must have the appropriate privileges.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
The specified DCPMM(s) must be manageable by the host software, not be
in the "Frozen" or "Exceeded" lock states and any namespaces associated with the
requested DCPMM(s) must be deleted before running this command.
.RE
.sp
The command is subject to OS Vendor (OSV) support. If OSV does not provide
support, the command will return "Not Supported."
.SH "RETURN DATA"
.sp
If an empty string is provided for the passphrase property and the source option is not
included, the user will be prompted (once for all DCPMMs) to enter the current
passphrase. The passphrase characters are hidden.
.sp
Current passphrase: \fB*\fP*
.sp
For each DCPMM, the CLI will indicate the status of the security state change.
If a failure occurs when changing multiple DCPMMs, the process will exit and
not continue updating the remaining DCPMMs.
.SH "SAMPLE OUTPUT"
.sp
.sp
.nf
Erase DIMM (DimmID): Success
Erase DIMM (DimmID): Error (Code) \- (Description)
.fi
.br