'\" t
.\"     Title: clevis-luks-edit
.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 03/30/2024
.\"    Manual: \ \&
.\"    Source: \ \&
.\"  Language: English
.\"
.TH "CLEVIS\-LUKS\-EDIT" "1" "03/30/2024" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
clevis-luks-edit \- Edit a binding from a clevis\-bound slot in a LUKS device
.SH "SYNOPSIS"
.sp
\fBclevis luks edit\fR [\-f] \-d DEV \-s SLT [\-c CONFIG]
.SH "OVERVIEW"
.sp
The \fBclevis luks edit\fR command edits clevis bindings from a LUKS device\&. For example:
.sp
.if n \{\
.RS 4
.\}
.nf
clevis luks edit \-d /dev/sda1 \-s 1
.fi
.if n \{\
.RE
.\}
.SH "OPTIONS"
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-d\fR
\fIDEV\fR
: The LUKS device to edit clevis\-bound pins
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-s\fR
\fISLT\fR
: The slot to use when editing the clevis binding
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-f\fR
: Proceed with the edit operation even if the config is unchanged
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-c\fR
\fICONFIG\fR
: The updated config to use
.RE
.SH "EXAMPLES"
.sp
.if n \{\
.RS 4
.\}
.nf
clevis luks list \-d /dev/sda1
1: tang \*(Aq{"url":"addr"}\*(Aq
.fi
.if n \{\
.RE
.\}
.sp
As we can see in the example above, \fB/dev/sda1\fR has one slots bound, in this case, to a \fItang\fR pin\&.
.sp
We can edit this binding by issuing the following command:
.sp
.if n \{\
.RS 4
.\}
.nf
clevis luks edit \-d /dev/sda1 \-s 1
.fi
.if n \{\
.RE
.\}
.sp
This will open a text editor \(em the one set in the $EDITOR environment variable, or \fIvi\fR, as a fallback \(em with the current configuration of this binding to be edited\&. In this case, we should have the following:
.sp
.if n \{\
.RS 4
.\}
.nf
{
    "url": "addr"
}
.fi
.if n \{\
.RE
.\}
.sp
Once at the editor, we can edit the pin configuration\&. For \fItang\fR, we could edit the \fIurl\fR, for instance\&. After completing the change, save the file and exit\&. The updated configuration will be validated for JSON, and if there are no errors, you will be shown the updated configuration and prompted whether to proceed\&.
.sp
By proceeding, the binding will be updated\&. There may be required to provide a valid LUKS passphrase for the device\&.
.sp
In the second example, we will update the same device and slot, but we will be providing the updated configuration as well:
.sp
.if n \{\
.RS 4
.\}
.nf
clevis luks edit \-d /dev/sda1 \-s 1 \-c \*(Aq{"url":"new\-addr\-here"}\*(Aq
.fi
.if n \{\
.RE
.\}
.sp
In this case, the binding update will be done in non\-interactive mode\&. Note that it may also be required to provide a LUKS passphrase for the device\&.
.SH "SEE ALSO"
.sp
\fBclevis\-luks\-list\fR(1),