table of contents
IPMCTL-CHANGE-DEVICE-SECURITY(1) | ipmctl | IPMCTL-CHANGE-DEVICE-SECURITY(1) |
NAME¶
ipmctl-change-device-security - Changes the DCPMM security lock stateSYNOPSIS¶
ipmctl set [OPTIONS] -dimm [TARGETS] Lockstate=(Unlocked|Disabled|Frozen) Passphrase=(string)
DESCRIPTION¶
Changes the data-at-rest security lock state for the persistent memory on one or more DCPMMs.Note
This command is subject to OS Vendor (OSV) support. It will return
"Not Supported."
An exception is if the DCPMM is Unlocked Seurity State, then transitioning to
Disabled is permitted.
OPTIONS¶
-h, -help-o (text|nvmxml), -output (text|nvmxml)
-source (path)
TARGETS¶
-dimm (DimmIDs)PROPERTIES¶
LockStatePassphrase
EXAMPLES¶
Unlocks device 0x0001.ipmctl set -dimm 0x0001 LockState=Unlocked Passphrase=""
Unlocks device 0x0001 by supplying the passphrase in the file "mypassphrase.file". In this example, the format of the file would be:
#ascii
Passphrase=myPassphrase
ipmctl set -source myfile.file -dimm 0x0001 LockState=Unlocked Passphrase=""
LIMITATIONS¶
To successfully execute this command, the caller must have the appropriate privileges and the specified DCPMMs must be manageable by the host software, have security enabled, not be in the "Unlocked, Frozen", "Disabled, Frozen", or "Exceeded" lock states, and not executing a long operation (ARS, Overwrite, FWUpdate).The command is subject to OS Vendor (OSV) support. If OSV does not provide support, the command may return "Not Supported." An exception is if the DCPMM is Unlocked (via UEFI or OSV tool), then transitioning to Disabled is possible regardless of OSV support.
RETURN DATA¶
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.Current passphrase: **
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.
SAMPLE OUTPUT¶
Unlock DIMM (DimmID): Success Unlock DIMM (DimmID): Error (Code) - (Description) Remove passphrase from DIMM (DimmID): Success Remove passphrase from DIMM (DimmID): Error (Code) - (Description)
2019-10-28 | ipmctl |