clevis-luks-edit.1.adoc 1.9 KB

  2. ===================
  3. :doctype: manpage
  4. == NAME
  5. clevis-luks-edit - Edit a binding from a clevis-bound slot in a LUKS device
  6. == SYNOPSIS
  7. *clevis luks edit* [-f] -d DEV -s SLT [-c CONFIG]
  8. == OVERVIEW
  9. The *clevis luks edit* command edits clevis bindings from a LUKS device.
  10. For example:
  11. clevis luks edit -d /dev/sda1 -s 1
  12. == OPTIONS
  13. * *-d* _DEV_ :
  14. The LUKS device to edit clevis-bound pins
  15. * *-s* _SLT_ :
  16. The slot to use when editing the clevis binding
  17. * *-f* :
  18. Proceed with the edit operation even if the config is unchanged
  19. * *-c* _CONFIG_ :
  20. The updated config to use
  21. == EXAMPLES
  22. clevis luks list -d /dev/sda1
  23. 1: tang '{"url":"addr"}'
  24. As we can see in the example above, */dev/sda1* has one slots bound, in this case, to a _tang_ pin.
  25. We can edit this binding by issuing the following command:
  26. clevis luks edit -d /dev/sda1 -s 1
  27. This will open a text editor -- the one set in the $EDITOR environment variable, or _vi_, as a fallback -- with the current
  28. configuration of this binding to be edited. In this case, we should have the following:
  29. {
  30. "url": "addr"
  31. }
  32. Once at the editor, we can edit the pin configuration. For _tang_, we could edit the _url_, for instance. After completing the change,
  33. save the file and exit. The updated configuration will be validated for JSON, and if there are no errors, you will be shown the
  34. updated configuration and prompted whether to proceed.
  35. By proceeding, the binding will be updated. There may be required to provide a valid LUKS passphrase for the device.
  36. In the second example, we will update the same device and slot, but we will be providing the updated configuration as well:
  37. clevis luks edit -d /dev/sda1 -s 1 -c '{"url":"new-addr-here"}'
  38. In this case, the binding update will be done in non-interactive mode. Note that it may also be required to provide a LUKS
  39. passphrase for the device.
  40. == SEE ALSO
  41. link:clevis-luks-list.1.adoc[*clevis-luks-list*(1)],