1
1
# Reference
2
+
2
3
<!-- DO NOT EDIT: This document was generated by Puppet Strings -->
3
4
4
5
## Table of Contents
5
6
6
- ** Defined types**
7
+ ### Defined types
7
8
8
9
* [ ` registry::service ` ] ( #registryservice ) : Defined resource type that manages service entries
9
10
* [ ` registry::value ` ] ( #registryvalue ) : High level abstraction on top of registry_key and registry_value resources
10
11
11
- ** Resource types**
12
+ ### Resource types
12
13
13
14
* [ ` registry_key ` ] ( #registry_key ) : Manages registry keys on Windows
14
15
* [ ` registry_value ` ] ( #registry_value ) : Manages registry values on Windows systems.
15
16
16
17
## Defined types
17
18
18
- ### registry::service
19
+ ### ` registry::service `
19
20
20
21
Manages the values in the key HKLM\System\CurrentControlSet\Services\$ name\
21
22
@@ -50,7 +51,7 @@ Data type: `present, absent`
50
51
51
52
52
53
53
- Default value: 'UNSET'
54
+ Default value: ` 'UNSET' `
54
55
55
56
##### ` display_name `
56
57
@@ -59,23 +60,23 @@ Data type: `Any`
59
60
The Display Name of the service. Defaults to the title of
60
61
the resource.
61
62
62
- Default value: 'UNSET'
63
+ Default value: ` 'UNSET' `
63
64
64
65
##### ` description `
65
66
66
67
Data type: ` Any `
67
68
68
69
A description of the service
69
70
70
- Default value: 'UNSET'
71
+ Default value: ` 'UNSET' `
71
72
72
73
##### ` command `
73
74
74
75
Data type: ` Any `
75
76
76
77
The command to execute
77
78
78
- Default value: 'UNSET'
79
+ Default value: ` 'UNSET' `
79
80
80
81
##### ` start `
81
82
@@ -85,9 +86,9 @@ The starting mode of the service. (Note, the native service
85
86
resource can also be used to manage this setting.)
86
87
[ automatic, manual, disabled ]
87
88
88
- Default value: 'UNSET'
89
+ Default value: ` 'UNSET' `
89
90
90
- ### registry::value
91
+ ### ` registry::value `
91
92
92
93
Actions:
93
94
- Manage the parent key if not already managed.
@@ -133,7 +134,7 @@ The name of the registry value to manage. This will be copied from
133
134
the resource title if not specified. The special value of
134
135
'(default)' may be used to manage the default value of the key.
135
136
136
- Default value: ` undef `
137
+ Default value: `` undef ` `
137
138
138
139
##### ` type `
139
140
@@ -143,7 +144,7 @@ The type the registry value. Defaults to 'string'. See the output of
143
144
` puppet describe registry_value ` for a list of supported types in the
144
145
"type" parameter.
145
146
146
- Default value: 'string'
147
+ Default value: ` 'string' `
147
148
148
149
##### ` data `
149
150
@@ -155,11 +156,11 @@ Data type: `Optional[Variant[
155
156
156
157
The data to place inside the registry value.
157
158
158
- Default value: ` undef `
159
+ Default value: `` undef ` `
159
160
160
161
## Resource types
161
162
162
- ### registry_key
163
+ ### ` registry_key `
163
164
164
165
Manages registry keys on Windows
165
166
@@ -169,11 +170,11 @@ The following properties are available in the `registry_key` type.
169
170
170
171
##### ` ensure `
171
172
172
- Valid values: present, absent
173
+ Valid values: ` present ` , ` absent `
173
174
174
175
The basic property that the resource should be in.
175
176
176
- Default value: present
177
+ Default value: ` present `
177
178
178
179
#### Parameters
179
180
@@ -183,43 +184,48 @@ The following parameters are available in the `registry_key` type.
183
184
184
185
The path to the registry key to manage
185
186
187
+ ##### ` provider `
188
+
189
+ The specific backend to use for this ` registry_key ` resource. You will seldom need to specify this --- Puppet will
190
+ usually discover the appropriate provider for your platform.
191
+
186
192
##### ` purge_values `
187
193
188
- Valid values: ` true ` , ` false `
194
+ Valid values: `` true `` , `` false ` `
189
195
190
196
Common boolean for munging and validation.
191
197
192
- Default value: ` false `
198
+ Default value: `` false ` `
193
199
194
- ### registry_value
200
+ ### ` registry_value `
195
201
196
202
Manages registry values on Windows systems.
197
203
198
204
#### Properties
199
205
200
206
The following properties are available in the ` registry_value ` type.
201
207
208
+ ##### ` data `
209
+
210
+ The data stored in the registry value.
211
+
212
+ Default value: ` '' `
213
+
202
214
##### ` ensure `
203
215
204
- Valid values: present, absent
216
+ Valid values: ` present ` , ` absent `
205
217
206
218
The basic property that the resource should be in.
207
219
208
- Default value: present
220
+ Default value: ` present `
209
221
210
222
##### ` type `
211
223
212
- Valid values: string, array, dword, qword, binary, expand
224
+ Valid values: ` string ` , ` array ` , ` dword ` , ` qword ` , ` binary ` , ` expand `
213
225
214
226
The Windows data type of the registry value.
215
227
216
- Default value: string
217
-
218
- ##### ` data `
219
-
220
- The data stored in the registry value.
221
-
222
- Default value: ''
228
+ Default value: ` string `
223
229
224
230
#### Parameters
225
231
@@ -229,3 +235,8 @@ The following parameters are available in the `registry_value` type.
229
235
230
236
The path to the registry value to manage.
231
237
238
+ ##### ` provider `
239
+
240
+ The specific backend to use for this ` registry_value ` resource. You will seldom need to specify this --- Puppet will
241
+ usually discover the appropriate provider for your platform.
242
+
0 commit comments