1IPMCTL-ENABLE-DEVICE-SECURITY(1)    ipmctl    IPMCTL-ENABLE-DEVICE-SECURITY(1)
2
3
4

NAME

6       ipmctl-enable-device-security - Enable data-at-rest security on DCPMM
7
8           Note
9           This command is subject to OS Vendor (OSV) support. It will return
10           "Not Supported."
11

SYNOPSIS

13       ipmctl set [OPTIONS] -dimm [TARGETS] NewPassphrase=(string)
14       ConfirmPassphrase=(string)
15

DESCRIPTION

17       Enable data-at-rest security for the persistent memory on one or more
18       DCPMMs by setting a passphrase.
19

OPTIONS

21       -h, -help
22           Displays help for the command.
23
24       -source (path)
25           File path to a local file containing the new passphrase (1-32
26           characters).
27
28           Note
29           The file does not need to contain the ConfirmPassphrase property
30

TARGETS

32       -dimm (DimmIDs)
33           Set the passphrase on specific DCPMMs by supplying one or more
34           comma separated DCPMM identifiers. However, this is not recommended
35           as it may put the system in an undesirable state. The default is to
36           set the passphrase on all manageable DCPMMs.
37

PROPERTIES

39       NewPassphrase
40           The new passphrase (1-32 characters). For better passphrase
41           protection, specify an empty string (e.g., NewPassphrase="") to be
42           prompted for the passphrase or to use a file containing the
43           passphrase with the source option.
44
45       ConfirmPassphrase
46           Confirmation of the new passphrase (1-32 character and must match
47           NewPassphrase). For better passphrase protection, specify an empty
48           string (e.g., ConfirmPassphrase="") to be prompted for the
49           passphrase or to use a file containing the passphrase with the
50           source option.
51

EXAMPLES

53       Set a passphrase on DIMM 0x0001.
54
55       ipmctl set -dimm 0x0001 NewPassphrase=123 ConfirmPassphrase=123
56
57       Sets a passphrase on DCPMM 0x0001 by supplying the passphrase in the
58       file mypassphrase.file. In this example, the format of the file would
59       be:
60
61       #ascii
62       NewPassphrase=myNewPassphrase
63
64       ipmctl set -source mypassphrase.file -dimm 0x0001 NewPassphrase="" ConfirmPassphrase=""
65

LIMITATIONS

67       In order to successfully execute this command:
68
69       The caller must have the appropriate privileges. The specified DCPMM
70       must have security disabled and be manageable by the host software.
71
72       There must not be any goal creation pending.
73
74       Command is subject to OS Vendor (OSV) support. If OSV does not provide
75       support, command will return "Not Supported."
76

RETURN DATA

78       If empty strings are provided for the passphrase properties and the
79       source option is not included, the user will be prompted (once for all
80       DCPMMs) to enter the new passphrase and then again to confirm the new
81       passphrase as described below. The passphrase characters will be
82       hidden.
83
84       New passphrase: ****
85
86       Confirm new passphrase: ****
87
88       For each DCPMM, the CLI will indicate the status of the set passphrase
89       operation. If a failure occurs when setting the passphrase on multiple
90       DCPMMs, the process will exit and not continue updating the remaining
91       DCPMMs.
92

SAMPLE OUTPUT

94       Set passphrase on DIMM (DimmID): Success
95       Set passphrase on DIMM (DimmID): Error (Code) - (Description)
96
97
98
99ipmctl                            2019-10-23  IPMCTL-ENABLE-DEVICE-SECURITY(1)
Impressum