68 lines
1.6 KiB
ReStructuredText
68 lines
1.6 KiB
ReStructuredText
cdist-type__ssh_authorized_key(7)
|
|
=================================
|
|
|
|
NAME
|
|
----
|
|
cdist-type__ssh_authorized_key - Manage a single ssh authorized key entry
|
|
|
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
|
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
Manage a single authorized key entry in an authorized_key file.
|
|
This type was created to be used by the __ssh_authorized_keys type.
|
|
|
|
|
|
REQUIRED PARAMETERS
|
|
-------------------
|
|
file
|
|
the authorized_keys file to which the given key should be added
|
|
|
|
key
|
|
a string containing the ssh keytype, base 64 encoded key and optional
|
|
trailing comment which shall be added to the given authorized_keys file.
|
|
|
|
|
|
OPTIONAL PARAMETERS
|
|
-------------------
|
|
comment
|
|
explicit comment instead of the one which may be trailing the given key
|
|
|
|
option
|
|
an option to set for this authorized_key entry.
|
|
Can be specified multiple times.
|
|
See sshd(8) for available options.
|
|
|
|
state
|
|
if the given keys should be 'present' or 'absent', defaults to 'present'.
|
|
|
|
|
|
EXAMPLES
|
|
--------
|
|
|
|
.. code-block:: sh
|
|
|
|
__ssh_authorized_key some-id \
|
|
--file "/home/user/.ssh/autorized_keys" \
|
|
--key "$(cat ~/.ssh/id_rsa.pub)"
|
|
|
|
__ssh_authorized_key some-id \
|
|
--file "/home/user/.ssh/autorized_keys" \
|
|
--key "$(cat ~/.ssh/id_rsa.pub)" \
|
|
--option 'command="/path/to/script"' \
|
|
--option 'environment="FOO=bar"' \
|
|
--comment 'one to rule them all'
|
|
|
|
|
|
SEE ALSO
|
|
--------
|
|
- `cdist-type(7) <cdist-type.html>`_
|
|
- `cdist__ssh_authorized_keys(7) <cdist__ssh_authorized_keys.html>`_
|
|
- sshd(8)
|
|
|
|
COPYING
|
|
-------
|
|
Copyright \(C) 2014 Steven Armstrong. Free use of this software is
|
|
granted under the terms of the GNU General Public License version 3 (GPLv3).
|