'\" t
.\"     Title: ipmctl-change-device-passphrase
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.10
.\"      Date: 2020-03-02
.\"    Manual: ipmctl
.\"    Source: ipmctl
.\"  Language: English
.\"
.TH "IPMCTL\-CHANGE\-DEVICE\-PASSPHRASE" "1" "2020-03-02" "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\-change\-device\-passphrase \- Changes the security passphrase on DCPMM on supported OS
.SH "SYNOPSIS"
.sp
.sp
.nf
ipmctl set [OPTIONS] \-dimm [TARGETS] Passphrase=(string) NewPassphrase=(string)
ConfirmPassphrase=(string)
.fi
.br
.SH "DESCRIPTION"
.sp
Changes the security passphrase on one or more DCPMMs.
.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
\-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
Changes the 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
\-source (path)
.RS 4
File path to a local file containing the new passphrase (1\-32 characters).
.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 file does not need to contain the ConfirmPassphrase property
.sp .5v
.RE
.SH "TARGETS"
.sp
\-dimm [DimmIDs]
.RS 4
Changes the passphrase on 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 change the
passphrase on all manageable DCPMMs.
.RE
.SH "PROPERTIES"
.sp
Passphrase
.RS 4
The current passphrase (1\-32 characters). For better passphrase protection, specify an
empty string (e.g., Passphrase="") to be prompted for the current passphrase or to use
a file containing the passphrases with the source option.
.RE
.sp
NewPassphrase
.RS 4
The new passphrase (1\-32 characters). For better passphrase protection,
specify an empty string (e.g., NewPassphrase="") to be prompted for the
passphrase or to use a file containing the passphrase with the source option.
.RE
.sp
ConfirmPassphrase
.RS 4
Confirmation of the new passphrase (1\-32 character and must match
NewPassphrase). For better passphrase protection, specify an empty string
(e.g., ConfirmPassphrase="") to be prompted for the passphrase or to use a
file containing the passphrase with the source option.
.RE
.SH "EXAMPLES"
.sp
Changes the passphrase from mypassphrase to mynewpassphrase on all DCPMMs.
.sp
.sp
.nf
ipmctl set \-dimm Passphrase=mypassphrase NewPassphrase=mynewpassphrase
 ConfirmPassphrase=mynewpassphrase
.fi
.br
.sp
Changes the passphrase on all DCPMMs by having the CLI prompt for the
current and new passphrases.
.sp
.sp
.nf
ipmctl set \-dimm Passphrase="" NewPassphrase="" ConfirmPassphrase=""
.fi
.br
.sp
Changes the passphrase on all DCPMMs by supplying the current and new
passphrases from the specified file. In this example, the format of the file
would be:
.sp
#ascii
.br
Passphrase=myOldPassphrase
.br
NewPassphrase=myNewPassphrase
.sp
.sp
.nf
ipmctl set \-source passphrase.file \-dimm Passphrase="" NewPassphrase=""
ConfirmPassphrase=""
.fi
.br
.sp
Changes the default master passphrase to masterpassphrase on all DCPMMs.
.sp
.sp
.nf
ipmctl set \-master \-default \-dimm NewPassphrase=masterpassphrase ConfirmPassphrase=
masterpassphrase
.fi
.br
.sp
Changes the master passphrase from masterpassphrase to newmasterpassphrase on
all DCPMMs.
.sp
.sp
.nf
ipmctl set \-master \-dimm Passphrase=masterpassphrase NewPassphrase=newmasterpassphrase
ConfirmPassphrase=newmasterpassphrase
.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 must be manageable by the host software, have
security enabled and not be in the "Frozen" or "Exceeded" lock states.
.RE
.sp
Command is subject to OS Vendor (OSV) support. If OSV does not provide support,
command will return "Not Supported."
.SH "RETURN DATA"
.sp
If empty strings are provided for the passphrase properties and the source
option is not included, the user will be prompted (once for all DCPMM) to enter
the current passphrase, then again for the new passphrase and then again to
confirm the new passphrase as described below. The passphrase characters are
hidden.
.sp
Current passphrase: ****
.sp
For each DIMM, the CLI will indicate the status of the passphrase change
operation. If a failure occurs when updating the passphrase on multiple DCPMMs,
the process will exit and not continue updating the remaining DCPMMs.
.SH "SAMPLE OUTPUT"
.sp
.sp
.nf
Change passphrase on DIMM (DimmID): Success
.fi
.br
.sp
.sp
.nf
Change passphrase on DIMM (DimmID): Error (Code)\-(Description)
.fi
.br