SEARCH
NEW RPMS
DIRECTORIES
ABOUT
FAQ
VARIOUS
BLOG
DONATE


YUM REPOSITORY

 
 

MAN page from Fedora 30 ipmctl-01.00.00.3474-1.fc30.x86_64.rpm

IPMCTL\-CHANGE\-DEVICE\-SECURITY

Section: ipmctl (1)
Updated: 2019-08-27
Index 

NAME

ipmctl-change-device-security - Changes the DCPMM security lock state


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 Disabledis permitted.

 

SYNOPSIS

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 moreDCPMMs. 

OPTIONS

-h, -help

Displays help for the command.

-o (text|nvmxml), -output (text|nvmxml)

Changes the output format. One of: "text" (default) or "nvmxml".

-source (path)

File path to a local file containing the new passphrase (1-32 characters).
 

TARGETS

-dimm (DimmIDs)

Changes the lock state of a specific DCPMMs by supplying one or more commaseparated DCPMM identifiers. However, this is not recommended as it may putthe system in an undesirable state. The default is to modify all manageableDCPMMs.
 

PROPERTIES

LockState

The desired lock state.

*"Disabled": Removes the passphrase on an DCPMM to disable security. Permittedonly when LockState is Unlocked.

*"Unlocked": Unlocks the persistent memory on a locked DCPMM.

*"Frozen": Prevents further lock state changes to the DCPMM until the nextreboot.

Passphrase

The current passphrase (1-32 characters). For better passphrase protection, specify anempty string (e.g., Passphrase="") to be prompted for the current passphrase or to usea file containing the passphrases with the source option.
 

EXAMPLES

Unlocks device 0x0001.

ipmctl set -dimm 0x0001 LockState=Unlocked Passphrase=""

Unlocks device 0x0001 by supplying the passphrase in the file "mypassphrase.file". In thisexample, the format of the file would be:

#ascii
Passphrase=myPassphrase

ipmctl set -source myfile.file -dimm 0x0001 LockState=UnlockedPassphrase=""

 

LIMITATIONS

To successfully execute this command, the caller must have the appropriate privilegesand the specified DCPMMs must be manageable by the host software, havesecurity 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 ofOSV support. 

RETURN DATA

If an empty string is provided for the passphrase property and the source option is notincluded, the user will be prompted (once for all DCPMMs) to enter the currentpassphrase. 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 andnot continue updating the remaining DCPMMs. 

SAMPLE OUTPUT

Unlock DIMM (DimmID): SuccessUnlock DIMM (DimmID): Error (Code) - (Description)Remove passphrase from DIMM (DimmID): SuccessRemove passphrase from DIMM (DimmID): Error (Code) - (Description)


 

Index

NAME
SYNOPSIS
DESCRIPTION
OPTIONS
TARGETS
PROPERTIES
EXAMPLES
LIMITATIONS
RETURN DATA
SAMPLE OUTPUT

This document was created byman2html,using the manual pages.