1CLEVIS-LUKS-EDIT(1)                                        CLEVIS-LUKS-EDIT(1)
2
3
4

NAME

6       clevis-luks-edit - Edit a binding from a clevis-bound slot in a LUKS
7       device
8

SYNOPSIS

10       clevis luks edit [-f] -d DEV -s SLT [-c CONFIG]
11

OVERVIEW

13       The clevis luks edit command edits clevis bindings from a LUKS device.
14       For example:
15
16           clevis luks edit -d /dev/sda1 -s 1
17

OPTIONS

19       •   -d DEV : The LUKS device to edit clevis-bound pins
20
21       •   -s SLT : The slot to use when editing the clevis binding
22
23       •   -f : Proceed with the edit operation even if the config is
24           unchanged
25
26       •   -c CONFIG : The updated config to use
27

EXAMPLES

29           clevis luks list -d /dev/sda1
30           1: tang '{"url":"addr"}'
31
32       As we can see in the example above, /dev/sda1 has one slots bound, in
33       this case, to a tang pin.
34
35       We can edit this binding by issuing the following command:
36
37           clevis luks edit -d /dev/sda1 -s 1
38
39       This will open a text editor — the one set in the $EDITOR environment
40       variable, or vi, as a fallback — with the current configuration of this
41       binding to be edited. In this case, we should have the following:
42
43           {
44               "url": "addr"
45           }
46
47       Once at the editor, we can edit the pin configuration. For tang, we
48       could edit the url, for instance. After completing the change, save the
49       file and exit. The updated configuration will be validated for JSON,
50       and if there are no errors, you will be shown the updated configuration
51       and prompted whether to proceed.
52
53       By proceeding, the binding will be updated. There may be required to
54       provide a valid LUKS passphrase for the device.
55
56       In the second example, we will update the same device and slot, but we
57       will be providing the updated configuration as well:
58
59           clevis luks edit -d /dev/sda1 -s 1 -c '{"url":"new-addr-here"}'
60
61       In this case, the binding update will be done in non-interactive mode.
62       Note that it may also be required to provide a LUKS passphrase for the
63       device.
64

SEE ALSO

66       clevis-luks-list(1),
67
68
69
70                                  10/29/2021               CLEVIS-LUKS-EDIT(1)
Impressum