table of contents
IPMCTL-ENABLE-DEVICE-SECURITY(1) | ipmctl | IPMCTL-ENABLE-DEVICE-SECURITY(1) |
NAME¶
ipmctl-enable-device-security - Enable data-at-rest security on DCPMM on supported OS
SYNOPSIS¶
ipmctl set [OPTIONS] -dimm [TARGETS] NewPassphrase=(string) ConfirmPassphrase=(string)
DESCRIPTION¶
Enable data-at-rest security for the persistent memory on one or more DCPMMs by setting a passphrase.
Note
This command is subject to OS Vendor (OSV) support. It will return "Not Supported."
OPTIONS¶
-h, -help
-ddrt
-smbus
Note
The -ddrt and -smbus options are mutually exclusive and may not be used together.
-source (path)
Note
The file does not need to contain the ConfirmPassphrase property
TARGETS¶
-dimm [DimmIDs]
PROPERTIES¶
NewPassphrase
ConfirmPassphrase
EXAMPLES¶
Set a passphrase on DIMM 0x0001.
ipmctl set -dimm 0x0001 NewPassphrase=123 ConfirmPassphrase=123
Sets a passphrase on DCPMM 0x0001 by supplying the passphrase in the file mypassphrase.file. In this example, the format of the file would be:
#ascii
NewPassphrase=myNewPassphrase
ipmctl set -source mypassphrase.file -dimm 0x0001 NewPassphrase="" ConfirmPassphrase=""
LIMITATIONS¶
In order to successfully execute this command:
Command is subject to OS Vendor (OSV) support. If OSV does not provide support, command will return "Not Supported."
RETURN DATA¶
If empty strings are provided for the passphrase properties and the source option is not included, the user will be prompted (once for all DCPMMs) to enter the new passphrase and then again to confirm the new passphrase as described below. The passphrase characters will be hidden.
New passphrase: ****
Confirm new passphrase: ****
For each DCPMM, the CLI will indicate the status of the set passphrase operation. If a failure occurs when setting the passphrase on multiple DCPMMs, the process will exit and not continue updating the remaining DCPMMs.
SAMPLE OUTPUT¶
Set passphrase on DIMM (DimmID): Success
Set passphrase on DIMM (DimmID): Error (Code) - (Description)
2019-12-15 | ipmctl |