.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "CDIST-TYPE__SSH_AUTHORIZED_KEY" "7" "Sep 26, 2023" "7.0.0" "cdist"
.SH NAME
.sp
cdist\-type__ssh_authorized_key \- Manage a single ssh authorized key entry
.SH DESCRIPTION
.sp
Manage a single authorized key entry in an authorized_key file.
This type was created to be used by the __ssh_authorized_keys type.
.SH REQUIRED PARAMETERS
.INDENT 0.0
.TP
.B file
The authorized_keys file where the given key should be managed.
.TP
.B key
The ssh key which shall be managed in this authorized_keys file.
Must be a string containing the ssh keytype, base 64 encoded key and
optional trailing comment which shall be added to the given
authorized_keys file.
.UNINDENT
.SH OPTIONAL PARAMETERS
.INDENT 0.0
.TP
.B comment
Use this comment instead of the one which may be trailing in the key.
.TP
.B option
An option to set for this authorized_key entry.
Can be specified multiple times.
See sshd(8) for available options.
.TP
.B state
If the managed key should be \(aqpresent\(aq or \(aqabsent\(aq, defaults to \(aqpresent\(aq.
.UNINDENT
.SH MESSAGES
.INDENT 0.0
.TP
.B added to \fIfile\fP (\fIentry\fP)
The key \fIentry\fP (with optional comment) was added to \fIfile\fP\&.
.TP
.B removed from \fIfile\fP (\fIentry\fP)
The key \fIentry\fP (with optional comment) was removed from \fIfile\fP\&.
.UNINDENT
.SH EXAMPLES
.INDENT 0.0
.INDENT 3.5
.sp
.EX
__ssh_authorized_key some\-id \e
   \-\-file \(dq/home/user/.ssh/autorized_keys\(dq \e
   \-\-key \(dq$(cat ~/.ssh/id_rsa.pub)\(dq

__ssh_authorized_key some\-id \e
   \-\-file \(dq/home/user/.ssh/autorized_keys\(dq \e
   \-\-key \(dq$(cat ~/.ssh/id_rsa.pub)\(dq \e
   \-\-option \(aqcommand=\(dq/path/to/script\(dq\(aq \e
   \-\-option \(aqenvironment=\(dqFOO=bar\(dq\(aq \e
   \-\-comment \(aqone to rule them all\(aq
.EE
.UNINDENT
.UNINDENT
.SH SEE ALSO
.sp
\fBcdist\-type__ssh_authorized_keys\fP(7), \fBsshd\fP(8)
.SH AUTHORS
.sp
Steven Armstrong <\fI\%steven\-cdist\-\-@\-\-armstrong.cc\fP>
.SH COPYING
.sp
Copyright (C) 2014 Steven Armstrong. You can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.
.SH COPYRIGHT
ungleich GmbH 2021
.\" Generated by docutils manpage writer.
.