aboutsummaryrefslogtreecommitdiff
path: root/REFERENCE.md
diff options
context:
space:
mode:
authorRob Thomas <xrobau@gmail.com>2018-10-08 12:03:59 +1000
committerGitHub <noreply@github.com>2018-10-08 12:03:59 +1000
commit47dca14a37f9970f9c34b1210651eabaf46fba04 (patch)
treec3682d6ff2eaa8f15f2c319cf4b7f658a21ce8f3 /REFERENCE.md
parent0609e86911bf7adc3caffb8d0659ed6af03409d3 (diff)
downloadpuppet-sshkeys_core-47dca14a37f9970f9c34b1210651eabaf46fba04.tar.gz
puppet-sshkeys_core-47dca14a37f9970f9c34b1210651eabaf46fba04.tar.bz2
Document 'options' param of ssh_authorized_key
I ended up having to trawl through the source code to figure out how to do this, so I'm sure that someone ELSE would like to save their time by having it documented!
Diffstat (limited to 'REFERENCE.md')
-rw-r--r--REFERENCE.md12
1 files changed, 11 insertions, 1 deletions
diff --git a/REFERENCE.md b/REFERENCE.md
index b72e9ee..6f80106 100644
--- a/REFERENCE.md
+++ b/REFERENCE.md
@@ -92,7 +92,17 @@ Default value: absent
##### `options`
Key options; see sshd(8) for possible values. Multiple values
-should be specified as an array.
+should be specified as an array. For example, you could use the
+following to install a SSH CA that allows someone with the
+'superuser' principal to log in as root
+
+ ssh_authorized_key { 'Company SSH CA':
+ ensure => present,
+ user => 'root',
+ type => 'ssh-ed25519',
+ key => 'AAAAC3NzaC[...]CeA5kG',
+ options => [ 'cert-authority', 'principals="superuser"' ],
+ }
#### Parameters