annotate modules/sshkeys_core/REFERENCE.md @ 480:2c3e745be8d2

Update server defs and own modules to match * $osver and $fqdn and others are now all in $facts * Firewall swapped action for jump and has new way to do IPv6 * SSH server setup changed * Resolve warnings from fileserver.conf * has_key() no longer exists because Puppet can do "key in array" * Some variables are now more strictly typed Also: * Try to configure full IPv6 DNS resolver * Clean up old config - unused servers and some CentOS complexity
author IBBoard <dev@ibboard.co.uk>
date Thu, 29 Aug 2024 18:58:49 +0100
parents adf6fe9bbc17
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
388
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1 # Reference
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
2
478
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
3 <!-- DO NOT EDIT: This document was generated by Puppet Strings -->
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
4
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
5 ## Table of Contents
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
6
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
7 ### Resource types
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
8
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
9 * [`ssh_authorized_key`](#ssh_authorized_key): Manages SSH authorized keys. Currently only type 2 keys are supported.
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
10 * [`sshkey`](#sshkey): Installs and manages ssh host keys.
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
11
388
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
12 ## Resource types
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
13
478
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
14 ### <a name="ssh_authorized_key"></a>`ssh_authorized_key`
388
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
15
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
16 In their native habitat, SSH keys usually appear as a single long line, in
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
17 the format `<TYPE> <KEY> <NAME/COMMENT>`. This resource type requires you
478
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
18 to split that line into several attributes.
388
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
19
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
20 To ensure that only the currently approved keys are present, you can purge
478
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
21 unmanaged SSH keys on a per-user basis.
388
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
22
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
23 This will remove any keys in `~/.ssh/authorized_keys` that aren't being
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
24 managed with `ssh_authorized_key` resources. See the documentation of the
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
25 `user` type for more details.
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
26
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
27 **Autorequires:** If Puppet is managing the user account in which this
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
28 SSH key should be installed, the `ssh_authorized_key` resource will autorequire
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
29 that user.
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
30
478
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
31 #### Examples
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
32
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
33 ##### Thus, a key that appears in your `~/.ssh/id_rsa.pub` file like this...
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
34
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
35 ```puppet
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
36
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
37 ssh-rsa AAAAB3Nza[...]qXfdaQ== nick@magpie.example.com
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
38 ```
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
39
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
40 ##### ...would translate to the following resource:
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
41
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
42 ```puppet
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
43
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
44 ssh_authorized_key { 'nick@magpie.example.com':
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
45 ensure => present,
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
46 user => 'nick',
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
47 type => 'ssh-rsa',
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
48 key => 'AAAAB3Nza[...]qXfdaQ==',
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
49 }
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
50 ```
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
51
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
52 ##### Do this with the `user` resource type's `purge_ssh_keys` attribute:
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
53
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
54 ```puppet
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
55
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
56 user { 'nick':
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
57 ensure => present,
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
58 purge_ssh_keys => true,
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
59 }
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
60 ```
388
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
61
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
62 #### Properties
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
63
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
64 The following properties are available in the `ssh_authorized_key` type.
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
65
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
66 ##### `ensure`
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
67
478
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
68 Valid values: `present`, `absent`
388
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
69
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
70 The basic property that the resource should be in.
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
71
478
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
72 Default value: `present`
388
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
73
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
74 ##### `key`
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
75
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
76 The public key itself; generally a long string of hex characters. The `key`
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
77 attribute may not contain whitespace.
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
78
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
79 Make sure to omit the following in this attribute (and specify them in
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
80 other attributes):
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
81
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
82 * Key headers, such as 'ssh-rsa' --- put these in the `type` attribute.
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
83 * Key identifiers / comments, such as 'joe@joescomputer.local' --- put these in
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
84 the `name` attribute/resource title.
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
85
478
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
86 ##### `options`
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
87
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
88 Key options; see sshd(8) for possible values. Multiple values
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
89 should be specified as an array. For example, you could use the
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
90 following to install a SSH CA that allows someone with the
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
91 'superuser' principal to log in as root
388
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
92
478
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
93 ssh_authorized_key { 'Company SSH CA':
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
94 ensure => present,
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
95 user => 'root',
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
96 type => 'ssh-ed25519',
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
97 key => 'AAAAC3NzaC[...]CeA5kG',
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
98 options => [ 'cert-authority', 'principals=\"superuser\"' ],
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
99 }
388
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
100
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
101 ##### `target`
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
102
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
103 The absolute filename in which to store the SSH key. This
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
104 property is optional and should be used only in cases where keys
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
105 are stored in a non-standard location, for instance when not in
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
106 `~user/.ssh/authorized_keys`. The parent directory must be present
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
107 if the target is in a privileged path.
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
108
478
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
109 Default value: `absent`
388
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
110
478
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
111 ##### `type`
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
112
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
113 Valid values: `ssh-dss`, `ssh-rsa`, `ecdsa-sha2-nistp256`, `ecdsa-sha2-nistp384`, `ecdsa-sha2-nistp521`, `ssh-ed25519`, `sk-ecdsa-sha2-nistp256@openssh.com`, `sk-ssh-ed25519@openssh.com`, `ssh-rsa-cert-v01@openssh.com`, `ssh-ed25519-cert-v01@openssh.com`, `ssh-dss-cert-v01@openssh.com`, `ecdsa-sha2-nistp256-cert-v01@openssh.com`, `ecdsa-sha2-nistp384-cert-v01@openssh.com`, `ecdsa-sha2-nistp521-cert-v01@openssh.com`, `dsa`, `ed25519`, `rsa`, `ecdsa-sk`, `ed25519-sk`
388
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
114
478
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
115 Aliases: `"dsa"=>"ssh-dss", "ed25519"=>"ssh-ed25519", "rsa"=>"ssh-rsa", "ecdsa-sk"=>"sk-ecdsa-sha2-nistp256@openssh.com", "ed25519-sk"=>"sk-ssh-ed25519@openssh.com"`
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
116
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
117 The encryption type used.
388
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
118
478
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
119 ##### `user`
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
120
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
121 The user account in which the SSH key should be installed. The resource
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
122 will autorequire this user if it is being managed as a `user` resource.
388
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
123
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
124 #### Parameters
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
125
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
126 The following parameters are available in the `ssh_authorized_key` type.
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
127
478
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
128 * [`drop_privileges`](#-ssh_authorized_key--drop_privileges)
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
129 * [`name`](#-ssh_authorized_key--name)
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
130 * [`provider`](#-ssh_authorized_key--provider)
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
131
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
132 ##### <a name="-ssh_authorized_key--drop_privileges"></a>`drop_privileges`
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
133
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
134 Valid values: `true`, `false`, `yes`, `no`
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
135
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
136 Whether to drop privileges when writing the key file. This is
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
137 useful for creating files in paths not writable by the target user. Note
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
138 the possible security implications of managing file ownership and
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
139 permissions as a privileged user.
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
140
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
141 Default value: `true`
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
142
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
143 ##### <a name="-ssh_authorized_key--name"></a>`name`
388
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
144
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
145 namevar
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
146
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
147 The SSH key comment. This can be anything, and doesn't need to match
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
148 the original comment from the `.pub` file.
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
149
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
150 Due to internal limitations, this must be unique across all user accounts;
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
151 if you want to specify one key for multiple users, you must use a different
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
152 comment for each instance.
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
153
478
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
154 ##### <a name="-ssh_authorized_key--provider"></a>`provider`
388
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
155
478
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
156 The specific backend to use for this `ssh_authorized_key` resource. You will seldom need to specify this --- Puppet will
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
157 usually discover the appropriate provider for your platform.
388
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
158
478
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
159 ### <a name="sshkey"></a>`sshkey`
388
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
160
478
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
161 By default, this type will install keys into `/etc/ssh/ssh_known_hosts`.
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
162 To manage ssh keys in a different `known_hosts` file, such as a user's personal
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
163 `known_hosts`, pass its path to the `target` parameter. See the
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
164 `ssh_authorized_key` type to manage authorized keys.
388
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
165
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
166 #### Properties
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
167
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
168 The following properties are available in the `sshkey` type.
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
169
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
170 ##### `ensure`
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
171
478
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
172 Valid values: `present`, `absent`
388
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
173
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
174 The basic property that the resource should be in.
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
175
478
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
176 Default value: `present`
388
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
177
478
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
178 ##### `host_aliases`
388
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
179
478
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
180 Any aliases the host might have. Multiple values must be
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
181 specified as an array.
388
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
182
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
183 ##### `key`
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
184
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
185 The key itself; generally a long string of uuencoded characters. The `key`
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
186 attribute may not contain whitespace.
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
187
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
188 Make sure to omit the following in this attribute (and specify them in
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
189 other attributes):
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
190
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
191 * Key headers, such as 'ssh-rsa' --- put these in the `type` attribute.
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
192 * Key identifiers / comments, such as 'joescomputer.local' --- put these in
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
193 the `name` attribute/resource title.
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
194
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
195 ##### `target`
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
196
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
197 The file in which to store the ssh key. Only used by
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
198 the `parsed` provider.
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
199
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
200 #### Parameters
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
201
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
202 The following parameters are available in the `sshkey` type.
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
203
478
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
204 * [`name`](#-sshkey--name)
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
205 * [`provider`](#-sshkey--provider)
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
206 * [`type`](#-sshkey--type)
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
207
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
208 ##### <a name="-sshkey--name"></a>`name`
388
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
209
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
210 namevar
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
211
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
212 The host name that the key is associated with.
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
213
478
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
214 ##### <a name="-sshkey--provider"></a>`provider`
388
750d36241580 Add missing dependency modules
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
215
478
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
216 The specific backend to use for this `sshkey` resource. You will seldom need to specify this --- Puppet will usually
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
217 discover the appropriate provider for your platform.
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
218
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
219 ##### <a name="-sshkey--type"></a>`type`
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
220
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
221 Valid values: `ssh-dss`, `ssh-ed25519`, `ssh-rsa`, `ecdsa-sha2-nistp256`, `ecdsa-sha2-nistp384`, `ecdsa-sha2-nistp521`, `sk-ecdsa-sha2-nistp256@openssh.com`, `sk-ssh-ed25519@openssh.com`, `dsa`, `ed25519`, `rsa`, `ecdsa-sk`, `ed25519-sk`
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
222
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
223 namevar
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
224
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
225 Aliases: `"dsa"=>"ssh-dss", "ed25519"=>"ssh-ed25519", "rsa"=>"ssh-rsa", "ecdsa-sk"=>"sk-ecdsa-sha2-nistp256@openssh.com", "ed25519-sk"=>"sk-ssh-ed25519@openssh.com"`
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
226
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
227 The encryption type used. Probably ssh-dss or ssh-rsa.
adf6fe9bbc17 Update Puppet modules to latest versions
IBBoard <dev@ibboard.co.uk>
parents: 388
diff changeset
228