7
7
### Classes
8
8
9
9
* [ ` patching_as_code ` ] ( #patching_as_code ) : Framework for patch management as code. Works alongside the puppetlabs/pe_patch or albatrossflavour/os_patching modules
10
- * [ ` patching_as_code::high_prio_reboot ` ] ( #patching_as_codehigh_prio_reboot ) : This class gets called by init.pp to reboot the node. You can use Hiera to set a different default for the reboot_delay if desired.
11
- * [ ` patching_as_code::linux::patchday ` ] ( #patching_as_codelinuxpatchday ) : This class gets called by init.pp to perform the actual patching on Linux.
12
- * [ ` patching_as_code::reboot ` ] ( #patching_as_codereboot ) : This class gets called by init.pp to reboot the node. You can use Hiera to set a different default for the reboot_delay if desired.
13
- * [ ` patching_as_code::windows::patchday ` ] ( #patching_as_codewindowspatchday ) : This class gets called by init.pp to perform the actual patching on Windows.
14
- * [ ` patching_as_code::wu ` ] ( #patching_as_codewu ) : class patching_as_code::wu
10
+ * [ ` patching_as_code::high_prio_reboot ` ] ( #patching_as_code--high_prio_reboot ) : This class gets called by init.pp to reboot the node. You can use Hiera to set a different default for the reboot_delay if desired.
11
+ * [ ` patching_as_code::linux::patchday ` ] ( #patching_as_code--linux--patchday ) : This class gets called by init.pp to perform the actual patching on Linux.
12
+ * [ ` patching_as_code::reboot ` ] ( #patching_as_code--reboot ) : This class gets called by init.pp to reboot the node. You can use Hiera to set a different default for the reboot_delay if desired.
13
+ * [ ` patching_as_code::windows::patchday ` ] ( #patching_as_code--windows--patchday ) : This class gets called by init.pp to perform the actual patching on Windows.
14
+ * [ ` patching_as_code::wu ` ] ( #patching_as_code--wu ) : class patching_as_code::wu
15
15
16
16
### Defined types
17
17
18
- * [ ` patching_as_code::kb ` ] ( #patching_as_codekb ) : This define gets called by init.pp to install Windows KB patches.
18
+ * [ ` patching_as_code::kb ` ] ( #patching_as_code--kb ) : This define gets called by init.pp to install Windows KB patches.
19
19
20
20
### Resource types
21
21
24
24
25
25
### Functions
26
26
27
- * [ ` patching_as_code::dedupe_arch ` ] ( #patching_as_codededupe_arch )
28
- * [ ` patching_as_code::high_prio_last_run ` ] ( #patching_as_codehigh_prio_last_run )
29
- * [ ` patching_as_code::is_patchday ` ] ( #patching_as_codeis_patchday )
30
- * [ ` patching_as_code::last_run ` ] ( #patching_as_codelast_run )
31
- * [ ` patching_as_code::process_patch_groups ` ] ( #patching_as_codeprocess_patch_groups )
27
+ * [ ` patching_as_code::dedupe_arch ` ] ( #patching_as_code--dedupe_arch )
28
+ * [ ` patching_as_code::high_prio_last_run ` ] ( #patching_as_code--high_prio_last_run )
29
+ * [ ` patching_as_code::is_patchday ` ] ( #patching_as_code--is_patchday )
30
+ * [ ` patching_as_code::last_run ` ] ( #patching_as_code--last_run )
31
+ * [ ` patching_as_code::process_patch_groups ` ] ( #patching_as_code--process_patch_groups )
32
32
33
33
### Tasks
34
34
@@ -68,39 +68,39 @@ class {'patching_as_code':
68
68
69
69
The following parameters are available in the ` patching_as_code ` class:
70
70
71
- * [ ` Variant ` ] ( #Variant )
72
- * [ ` patch_schedule ` ] ( #patch_schedule )
73
- * [ ` blocklist ` ] ( #blocklist )
74
- * [ ` allowlist ` ] ( #allowlist )
75
- * [ ` blocklist_choco ` ] ( #blocklist_choco )
76
- * [ ` allowlist_choco ` ] ( #allowlist_choco )
77
- * [ ` high_priority_patch_group ` ] ( #high_priority_patch_group )
78
- * [ ` high_priority_list ` ] ( #high_priority_list )
79
- * [ ` high_priority_list_choco ` ] ( #high_priority_list_choco )
80
- * [ ` unsafe_process_list ` ] ( #unsafe_process_list )
81
- * [ ` pre_patch_commands ` ] ( #pre_patch_commands )
82
- * [ ` post_patch_commands ` ] ( #post_patch_commands )
83
- * [ ` pre_reboot_commands ` ] ( #pre_reboot_commands )
84
- * [ ` fact_upload ` ] ( #fact_upload )
85
- * [ ` enable_patching ` ] ( #enable_patching )
86
- * [ ` security_only ` ] ( #security_only )
87
- * [ ` high_priority_only ` ] ( #high_priority_only )
88
- * [ ` patch_choco ` ] ( #patch_choco )
89
- * [ ` use_pe_patch ` ] ( #use_pe_patch )
90
- * [ ` classify_pe_patch ` ] ( #classify_pe_patch )
91
- * [ ` patch_on_metered_links ` ] ( #patch_on_metered_links )
92
- * [ ` plan_patch_fact ` ] ( #plan_patch_fact )
93
- * [ ` patch_group ` ] ( #patch_group )
94
-
95
- ##### <a name =" Variant " ></a >` Variant `
71
+ * [ ` Variant ` ] ( #-patching_as_code-- Variant )
72
+ * [ ` patch_schedule ` ] ( #-patching_as_code-- patch_schedule )
73
+ * [ ` blocklist ` ] ( #-patching_as_code-- blocklist )
74
+ * [ ` allowlist ` ] ( #-patching_as_code-- allowlist )
75
+ * [ ` blocklist_choco ` ] ( #-patching_as_code-- blocklist_choco )
76
+ * [ ` allowlist_choco ` ] ( #-patching_as_code-- allowlist_choco )
77
+ * [ ` high_priority_patch_group ` ] ( #-patching_as_code-- high_priority_patch_group )
78
+ * [ ` high_priority_list ` ] ( #-patching_as_code-- high_priority_list )
79
+ * [ ` high_priority_list_choco ` ] ( #-patching_as_code-- high_priority_list_choco )
80
+ * [ ` unsafe_process_list ` ] ( #-patching_as_code-- unsafe_process_list )
81
+ * [ ` pre_patch_commands ` ] ( #-patching_as_code-- pre_patch_commands )
82
+ * [ ` post_patch_commands ` ] ( #-patching_as_code-- post_patch_commands )
83
+ * [ ` pre_reboot_commands ` ] ( #-patching_as_code-- pre_reboot_commands )
84
+ * [ ` fact_upload ` ] ( #-patching_as_code-- fact_upload )
85
+ * [ ` enable_patching ` ] ( #-patching_as_code-- enable_patching )
86
+ * [ ` security_only ` ] ( #-patching_as_code-- security_only )
87
+ * [ ` high_priority_only ` ] ( #-patching_as_code-- high_priority_only )
88
+ * [ ` patch_choco ` ] ( #-patching_as_code-- patch_choco )
89
+ * [ ` use_pe_patch ` ] ( #-patching_as_code-- use_pe_patch )
90
+ * [ ` classify_pe_patch ` ] ( #-patching_as_code-- classify_pe_patch )
91
+ * [ ` patch_on_metered_links ` ] ( #-patching_as_code-- patch_on_metered_links )
92
+ * [ ` plan_patch_fact ` ] ( #-patching_as_code-- plan_patch_fact )
93
+ * [ ` patch_group ` ] ( #-patching_as_code-- patch_group )
94
+
95
+ ##### <a name =" -patching_as_code-- Variant" ></a >` Variant `
96
96
97
97
Data type: ` String, Array[String] `
98
98
99
99
patch_group
100
100
Name(s) of the patch_group(s) for this node. Must match one or more of the patch groups in $patch_schedule
101
101
To assign multiple patch groups, provide this parameter as an array
102
102
103
- ##### <a name =" patch_schedule " ></a >` patch_schedule `
103
+ ##### <a name =" -patching_as_code-- patch_schedule" ></a >` patch_schedule `
104
104
105
105
Data type: ` Hash `
106
106
@@ -114,57 +114,57 @@ Options:
114
114
* ** : max_runs ** ` String ` : How many Puppet runs during the patch window can Puppet install patches. Must be at least 1.
115
115
* ** : reboot ** ` String ` : Reboot behavior, valid options: 'always', 'never', 'ifneeded'
116
116
117
- ##### <a name =" blocklist " ></a >` blocklist `
117
+ ##### <a name =" -patching_as_code-- blocklist" ></a >` blocklist `
118
118
119
119
Data type: ` Array `
120
120
121
121
List of updates to block from installing
122
122
123
- ##### <a name =" allowlist " ></a >` allowlist `
123
+ ##### <a name =" -patching_as_code-- allowlist" ></a >` allowlist `
124
124
125
125
Data type: ` Array `
126
126
127
127
List of updates that are allowed to be installed. Any updates not on this list get blocked.
128
128
129
- ##### <a name =" blocklist_choco " ></a >` blocklist_choco `
129
+ ##### <a name =" -patching_as_code-- blocklist_choco" ></a >` blocklist_choco `
130
130
131
131
Data type: ` Array `
132
132
133
133
List of Chocolatey updates to block from installing
134
134
135
- ##### <a name =" allowlist_choco " ></a >` allowlist_choco `
135
+ ##### <a name =" -patching_as_code-- allowlist_choco" ></a >` allowlist_choco `
136
136
137
137
Data type: ` Array `
138
138
139
139
List of Chocolatey updates that are allowed to be installed. Any Chocolatey updates not on this list get blocked.
140
140
141
- ##### <a name =" high_priority_patch_group " ></a >` high_priority_patch_group `
141
+ ##### <a name =" -patching_as_code-- high_priority_patch_group" ></a >` high_priority_patch_group `
142
142
143
143
Data type: ` String `
144
144
145
145
Name of the high_priority_patch_group for this node. Must match a patch group in ` $patch_schedule `
146
146
This patch schedule will only be used for patches in the ` $high_priority_list ` .
147
147
148
- ##### <a name =" high_priority_list " ></a >` high_priority_list `
148
+ ##### <a name =" -patching_as_code-- high_priority_list" ></a >` high_priority_list `
149
149
150
150
Data type: ` Array `
151
151
152
152
List of updates to install on the patch schedule set by ` $high_priority_patch_group ` .
153
153
154
- ##### <a name =" high_priority_list_choco " ></a >` high_priority_list_choco `
154
+ ##### <a name =" -patching_as_code-- high_priority_list_choco" ></a >` high_priority_list_choco `
155
155
156
156
Data type: ` Array `
157
157
158
158
List of Chocolatey updates to install on the patch schedule set by ` $high_priority_patch_group ` .
159
159
160
- ##### <a name =" unsafe_process_list " ></a >` unsafe_process_list `
160
+ ##### <a name =" -patching_as_code-- unsafe_process_list" ></a >` unsafe_process_list `
161
161
162
162
Data type: ` Array `
163
163
164
164
List of processes that will cause patching to be skipped if any of the processes in the list are active on the system.
165
165
Prepend an entry with ` {full} ` to match against the full process arguments.
166
166
167
- ##### <a name =" pre_patch_commands " ></a >` pre_patch_commands `
167
+ ##### <a name =" -patching_as_code-- pre_patch_commands" ></a >` pre_patch_commands `
168
168
169
169
Data type: ` Hash `
170
170
@@ -176,7 +176,7 @@ Options:
176
176
* ** : path ** ` String ` : The path for the command
177
177
* ** : provider ** ` String ` : The provider for the command
178
178
179
- ##### <a name =" post_patch_commands " ></a >` post_patch_commands `
179
+ ##### <a name =" -patching_as_code-- post_patch_commands" ></a >` post_patch_commands `
180
180
181
181
Data type: ` Hash `
182
182
@@ -188,7 +188,7 @@ Options:
188
188
* ** : path ** ` String ` : The path for the command
189
189
* ** : provider ** ` String ` : The provider for the command
190
190
191
- ##### <a name =" pre_reboot_commands " ></a >` pre_reboot_commands `
191
+ ##### <a name =" -patching_as_code-- pre_reboot_commands" ></a >` pre_reboot_commands `
192
192
193
193
Data type: ` Hash `
194
194
@@ -201,26 +201,26 @@ Options:
201
201
* ** : provider ** ` String ` : The provider for the command
202
202
Note: the provider for the command gets forced to ` posix ` on Linux and ` powershell ` on Windows
203
203
204
- ##### <a name =" fact_upload " ></a >` fact_upload `
204
+ ##### <a name =" -patching_as_code-- fact_upload" ></a >` fact_upload `
205
205
206
206
Data type: ` Boolean `
207
207
208
208
How os_patching/pe_patch handles changes to fact cache. Defaults to true.
209
209
When true (default), ` puppet fact upload ` occurs as expected
210
210
When false, changes to fact cache are not uploaded
211
211
212
- Default value: `` true ` `
212
+ Default value: ` true `
213
213
214
- ##### <a name =" enable_patching " ></a >` enable_patching `
214
+ ##### <a name =" -patching_as_code-- enable_patching" ></a >` enable_patching `
215
215
216
216
Data type: ` Boolean `
217
217
218
218
Controls if ` patching_as_code ` is allowed to install any updates. Can be used to disable patching with a single override.
219
219
Can be used to disable patching with a single override.
220
220
221
- Default value: `` true ` `
221
+ Default value: ` true `
222
222
223
- ##### <a name =" security_only " ></a >` security_only `
223
+ ##### <a name =" -patching_as_code-- security_only" ></a >` security_only `
224
224
225
225
Data type: ` Boolean `
226
226
@@ -229,9 +229,9 @@ When using `os_patching`, security updates can only be applied to Linux.
229
229
If patching of Chocolatey packages is enabled, Chocolatey packages will still update even if
230
230
` security_only ` is set to ` true ` .
231
231
232
- Default value: `` false ` `
232
+ Default value: ` false `
233
233
234
- ##### <a name =" high_priority_only " ></a >` high_priority_only `
234
+ ##### <a name =" -patching_as_code-- high_priority_only" ></a >` high_priority_only `
235
235
236
236
Data type: ` Boolean `
237
237
@@ -240,25 +240,25 @@ regular patches from being installed, and will skip a pending reboot at the begi
240
240
run if a pending reboot is detected. A pending reboot may still happen at the end of the patch run,
241
241
as long as the patch schedule set by ` $high_priority_patch_group ` allows reboots to occur.
242
242
243
- Default value: `` false ` `
243
+ Default value: ` false `
244
244
245
- ##### <a name =" patch_choco " ></a >` patch_choco `
245
+ ##### <a name =" -patching_as_code-- patch_choco" ></a >` patch_choco `
246
246
247
247
Data type: ` Boolean `
248
248
249
249
Also patch outdated Chocolatey packages (on Windows)
250
250
251
- Default value: `` false ` `
251
+ Default value: ` false `
252
252
253
- ##### <a name =" use_pe_patch " ></a >` use_pe_patch `
253
+ ##### <a name =" -patching_as_code-- use_pe_patch" ></a >` use_pe_patch `
254
254
255
255
Data type: ` Boolean `
256
256
257
257
Use the pe_patch module if available (PE 2019.8+). Defaults to true.
258
258
259
- Default value: `` true ` `
259
+ Default value: ` true `
260
260
261
- ##### <a name =" classify_pe_patch " ></a >` classify_pe_patch `
261
+ ##### <a name =" -patching_as_code-- classify_pe_patch" ></a >` classify_pe_patch `
262
262
263
263
Data type: ` Boolean `
264
264
@@ -269,9 +269,9 @@ When disabled (default), you can use PE's own "PE Patch Management" groups
269
269
to classify nodes with pe_patch. In that case, please make sure you match
270
270
the patch_group variable in pe_patch with the patch_group in patching_as_code
271
271
272
- Default value: `` false ` `
272
+ Default value: ` false `
273
273
274
- ##### <a name =" patch_on_metered_links " ></a >` patch_on_metered_links `
274
+ ##### <a name =" -patching_as_code-- patch_on_metered_links" ></a >` patch_on_metered_links `
275
275
276
276
Data type: ` Boolean `
277
277
@@ -280,42 +280,42 @@ metered link. This setting only has affect for Windows operating systems.
280
280
When enabled, patching are installed even over a metered link.
281
281
When disabled (default), patches are not installed over a metered link.
282
282
283
- Default value: `` false ` `
283
+ Default value: ` false `
284
284
285
- ##### <a name =" plan_patch_fact " ></a >` plan_patch_fact `
285
+ ##### <a name =" -patching_as_code-- plan_patch_fact" ></a >` plan_patch_fact `
286
286
287
287
Data type: ` Optional[String] `
288
288
289
289
Reserved parameter for running ` patching_as_code ` via a Plan (future functionality).
290
290
291
- Default value: `` undef ` `
291
+ Default value: ` undef `
292
292
293
- ##### <a name =" patch_group " ></a >` patch_group `
293
+ ##### <a name =" -patching_as_code-- patch_group" ></a >` patch_group `
294
294
295
295
Data type: ` Variant[String,Array[String]] `
296
296
297
297
298
298
299
- ### <a name =" patching_as_codehigh_prio_reboot " ></a >` patching_as_code::high_prio_reboot `
299
+ ### <a name =" patching_as_code--high_prio_reboot " ></a >` patching_as_code::high_prio_reboot `
300
300
301
301
Class: patching_as_code::high_prio_reboot
302
302
303
303
#### Parameters
304
304
305
305
The following parameters are available in the ` patching_as_code::high_prio_reboot ` class:
306
306
307
- * [ ` reboot_if_needed ` ] ( #reboot_if_needed )
308
- * [ ` reboot_delay ` ] ( #reboot_delay )
307
+ * [ ` reboot_if_needed ` ] ( #-patching_as_code--high_prio_reboot-- reboot_if_needed )
308
+ * [ ` reboot_delay ` ] ( #-patching_as_code--high_prio_reboot-- reboot_delay )
309
309
310
- ##### <a name =" reboot_if_needed " ></a >` reboot_if_needed `
310
+ ##### <a name =" -patching_as_code--high_prio_reboot-- reboot_if_needed" ></a >` reboot_if_needed `
311
311
312
312
Data type: ` Boolean `
313
313
314
314
Only reboot the node if a system reboot is pending. This parameter is passed automatically from init.pp
315
315
316
- Default value: `` true ` `
316
+ Default value: ` true `
317
317
318
- ##### <a name =" reboot_delay " ></a >` reboot_delay `
318
+ ##### <a name =" -patching_as_code--high_prio_reboot-- reboot_delay" ></a >` reboot_delay `
319
319
320
320
Data type: ` Integer `
321
321
@@ -324,69 +324,69 @@ To override for patching, specify an alternate value by setting the patching_as_
324
324
325
325
Default value: ` 120 `
326
326
327
- ### <a name =" patching_as_codelinuxpatchday " ></a >` patching_as_code::linux::patchday `
327
+ ### <a name =" patching_as_code--linux--patchday " ></a >` patching_as_code::linux::patchday `
328
328
329
329
Class: patching_as_code::linux::patchday
330
330
331
331
#### Parameters
332
332
333
333
The following parameters are available in the ` patching_as_code::linux::patchday ` class:
334
334
335
- * [ ` updates ` ] ( #updates )
336
- * [ ` choco_updates ` ] ( #choco_updates )
337
- * [ ` high_prio_updates ` ] ( #high_prio_updates )
338
- * [ ` high_prio_choco_updates ` ] ( #high_prio_choco_updates )
335
+ * [ ` updates ` ] ( #-patching_as_code--linux--patchday-- updates )
336
+ * [ ` choco_updates ` ] ( #-patching_as_code--linux--patchday-- choco_updates )
337
+ * [ ` high_prio_updates ` ] ( #-patching_as_code--linux--patchday-- high_prio_updates )
338
+ * [ ` high_prio_choco_updates ` ] ( #-patching_as_code--linux--patchday-- high_prio_choco_updates )
339
339
340
- ##### <a name =" updates " ></a >` updates `
340
+ ##### <a name =" -patching_as_code--linux--patchday-- updates" ></a >` updates `
341
341
342
342
Data type: ` Array `
343
343
344
344
List of Linux packages to update.
345
345
346
- ##### <a name =" choco_updates " ></a >` choco_updates `
346
+ ##### <a name =" -patching_as_code--linux--patchday-- choco_updates" ></a >` choco_updates `
347
347
348
348
Data type: ` Array `
349
349
350
350
List of Chocolatey packages to update, which should always be empty for Linux. This parameter exists only for compability.
351
351
352
352
Default value: ` [] `
353
353
354
- ##### <a name =" high_prio_updates " ></a >` high_prio_updates `
354
+ ##### <a name =" -patching_as_code--linux--patchday-- high_prio_updates" ></a >` high_prio_updates `
355
355
356
356
Data type: ` Array `
357
357
358
358
List of high-priority Linux packages to update.
359
359
360
360
Default value: ` [] `
361
361
362
- ##### <a name =" high_prio_choco_updates " ></a >` high_prio_choco_updates `
362
+ ##### <a name =" -patching_as_code--linux--patchday-- high_prio_choco_updates" ></a >` high_prio_choco_updates `
363
363
364
364
Data type: ` Array `
365
365
366
366
List of high-priority Chocolatey packages to update, which should always be empty for Linux. This parameter exists only for compability.
367
367
368
368
Default value: ` [] `
369
369
370
- ### <a name =" patching_as_codereboot " ></a >` patching_as_code::reboot `
370
+ ### <a name =" patching_as_code--reboot " ></a >` patching_as_code::reboot `
371
371
372
372
Class: patching_as_code::reboot
373
373
374
374
#### Parameters
375
375
376
376
The following parameters are available in the ` patching_as_code::reboot ` class:
377
377
378
- * [ ` reboot_if_needed ` ] ( #reboot_if_needed )
379
- * [ ` reboot_delay ` ] ( #reboot_delay )
378
+ * [ ` reboot_if_needed ` ] ( #-patching_as_code--reboot-- reboot_if_needed )
379
+ * [ ` reboot_delay ` ] ( #-patching_as_code--reboot-- reboot_delay )
380
380
381
- ##### <a name =" reboot_if_needed " ></a >` reboot_if_needed `
381
+ ##### <a name =" -patching_as_code--reboot-- reboot_if_needed" ></a >` reboot_if_needed `
382
382
383
383
Data type: ` Boolean `
384
384
385
385
Only reboot the node if a system reboot is pending. This parameter is passed automatically from init.pp
386
386
387
- Default value: `` true ` `
387
+ Default value: ` true `
388
388
389
- ##### <a name =" reboot_delay " ></a >` reboot_delay `
389
+ ##### <a name =" -patching_as_code--reboot-- reboot_delay" ></a >` reboot_delay `
390
390
391
391
Data type: ` Integer `
392
392
@@ -395,88 +395,88 @@ To override for patching, specify an alternate value by setting the patching_as_
395
395
396
396
Default value: ` 120 `
397
397
398
- ### <a name =" patching_as_codewindowspatchday " ></a >` patching_as_code::windows::patchday `
398
+ ### <a name =" patching_as_code--windows--patchday " ></a >` patching_as_code::windows::patchday `
399
399
400
400
Class: patching_as_code::windows::patchday
401
401
402
402
#### Parameters
403
403
404
404
The following parameters are available in the ` patching_as_code::windows::patchday ` class:
405
405
406
- * [ ` updates ` ] ( #updates )
407
- * [ ` choco_updates ` ] ( #choco_updates )
408
- * [ ` high_prio_updates ` ] ( #high_prio_updates )
409
- * [ ` high_prio_choco_updates ` ] ( #high_prio_choco_updates )
406
+ * [ ` updates ` ] ( #-patching_as_code--windows--patchday-- updates )
407
+ * [ ` choco_updates ` ] ( #-patching_as_code--windows--patchday-- choco_updates )
408
+ * [ ` high_prio_updates ` ] ( #-patching_as_code--windows--patchday-- high_prio_updates )
409
+ * [ ` high_prio_choco_updates ` ] ( #-patching_as_code--windows--patchday-- high_prio_choco_updates )
410
410
411
- ##### <a name =" updates " ></a >` updates `
411
+ ##### <a name =" -patching_as_code--windows--patchday-- updates" ></a >` updates `
412
412
413
413
Data type: ` Array `
414
414
415
415
List of Windows KB patches to install.
416
416
417
- ##### <a name =" choco_updates " ></a >` choco_updates `
417
+ ##### <a name =" -patching_as_code--windows--patchday-- choco_updates" ></a >` choco_updates `
418
418
419
419
Data type: ` Array `
420
420
421
421
List of Chocolatey packages to update.
422
422
423
- ##### <a name =" high_prio_updates " ></a >` high_prio_updates `
423
+ ##### <a name =" -patching_as_code--windows--patchday-- high_prio_updates" ></a >` high_prio_updates `
424
424
425
425
Data type: ` Array `
426
426
427
427
List of high-priority Windows KB patches to install.
428
428
429
429
Default value: ` [] `
430
430
431
- ##### <a name =" high_prio_choco_updates " ></a >` high_prio_choco_updates `
431
+ ##### <a name =" -patching_as_code--windows--patchday-- high_prio_choco_updates" ></a >` high_prio_choco_updates `
432
432
433
433
Data type: ` Array `
434
434
435
435
List of high-priority Chocolatey packages to update.
436
436
437
437
Default value: ` [] `
438
438
439
- ### <a name =" patching_as_codewu " ></a >` patching_as_code::wu `
439
+ ### <a name =" patching_as_code--wu " ></a >` patching_as_code::wu `
440
440
441
441
class patching_as_code::wu
442
442
443
443
## Defined types
444
444
445
- ### <a name =" patching_as_codekb " ></a >` patching_as_code::kb `
445
+ ### <a name =" patching_as_code--kb " ></a >` patching_as_code::kb `
446
446
447
447
define patching_as_code::kb
448
448
449
449
#### Parameters
450
450
451
451
The following parameters are available in the ` patching_as_code::kb ` defined type:
452
452
453
- * [ ` ensure ` ] ( #ensure )
454
- * [ ` kb ` ] ( #kb )
455
- * [ ` maintwindow ` ] ( #maintwindow )
453
+ * [ ` ensure ` ] ( #-patching_as_code--kb-- ensure )
454
+ * [ ` kb ` ] ( #-patching_as_code--kb-- kb )
455
+ * [ ` maintwindow ` ] ( #-patching_as_code--kb-- maintwindow )
456
456
457
- ##### <a name =" ensure " ></a >` ensure `
457
+ ##### <a name =" -patching_as_code--kb-- ensure" ></a >` ensure `
458
458
459
459
Data type: ` String `
460
460
461
461
When set to 'enabled' or 'present', will allow this resource to be applied. Removing updates is currently not supported.
462
462
463
463
Default value: ` 'enabled' `
464
464
465
- ##### <a name =" kb " ></a >` kb `
465
+ ##### <a name =" -patching_as_code--kb-- kb" ></a >` kb `
466
466
467
467
Data type: ` String `
468
468
469
469
Name of the KB patch to install.
470
470
471
471
Default value: ` $name `
472
472
473
- ##### <a name =" maintwindow " ></a >` maintwindow `
473
+ ##### <a name =" -patching_as_code--kb-- maintwindow" ></a >` maintwindow `
474
474
475
475
Data type: ` Optional[String] `
476
476
477
477
Name of the patch window to use for installing the patch.
478
478
479
- Default value: `` undef ` `
479
+ Default value: ` undef `
480
480
481
481
## Resource types
482
482
@@ -488,21 +488,21 @@ Define a package resource to patch
488
488
489
489
The following parameters are available in the ` patch_package ` type.
490
490
491
- * [ ` chocolatey ` ] ( #chocolatey )
492
- * [ ` name ` ] ( #name )
493
- * [ ` patch_window ` ] ( #patch_window )
491
+ * [ ` chocolatey ` ] ( #-patch_package-- chocolatey )
492
+ * [ ` name ` ] ( #-patch_package-- name )
493
+ * [ ` patch_window ` ] ( #-patch_package-- patch_window )
494
494
495
- ##### <a name =" chocolatey " ></a >` chocolatey `
495
+ ##### <a name =" -patch_package-- chocolatey" ></a >` chocolatey `
496
496
497
497
Whether this is a Chocolatey package (Windows only)
498
498
499
- ##### <a name =" name " ></a >` name `
499
+ ##### <a name =" -patch_package-- name" ></a >` name `
500
500
501
501
namevar
502
502
503
503
Name of the package to patch
504
504
505
- ##### <a name =" patch_window " ></a >` patch_window `
505
+ ##### <a name =" -patch_package-- patch_window" ></a >` patch_window `
506
506
507
507
Puppet schedule to link package resource to
508
508
@@ -514,27 +514,27 @@ Perform a clean reboot if it was pending before this agent run
514
514
515
515
The following parameters are available in the ` reboot_if_pending ` type.
516
516
517
- * [ ` name ` ] ( #name )
518
- * [ ` os ` ] ( #os )
519
- * [ ` patch_window ` ] ( #patch_window )
517
+ * [ ` name ` ] ( #-reboot_if_pending-- name )
518
+ * [ ` os ` ] ( #-reboot_if_pending-- os )
519
+ * [ ` patch_window ` ] ( #-reboot_if_pending-- patch_window )
520
520
521
- ##### <a name =" name " ></a >` name `
521
+ ##### <a name =" -reboot_if_pending-- name" ></a >` name `
522
522
523
523
namevar
524
524
525
525
Name of this resource (has no function)
526
526
527
- ##### <a name =" os " ></a >` os `
527
+ ##### <a name =" -reboot_if_pending-- os" ></a >` os `
528
528
529
529
OS type from kernel fact
530
530
531
- ##### <a name =" patch_window " ></a >` patch_window `
531
+ ##### <a name =" -reboot_if_pending-- patch_window" ></a >` patch_window `
532
532
533
533
Puppet schedule to link the reboot resource to
534
534
535
535
## Functions
536
536
537
- ### <a name =" patching_as_codededupe_arch " ></a >` patching_as_code::dedupe_arch `
537
+ ### <a name =" patching_as_code--dedupe_arch " ></a >` patching_as_code::dedupe_arch `
538
538
539
539
Type: Ruby 4.x API
540
540
@@ -552,7 +552,7 @@ Data type: `Array`
552
552
553
553
554
554
555
- ### <a name =" patching_as_codehigh_prio_last_run " ></a >` patching_as_code::high_prio_last_run `
555
+ ### <a name =" patching_as_code--high_prio_last_run " ></a >` patching_as_code::high_prio_last_run `
556
556
557
557
Type: Ruby 4.x API
558
558
@@ -576,7 +576,7 @@ Data type: `Array`
576
576
577
577
578
578
579
- ### <a name =" patching_as_codeis_patchday " ></a >` patching_as_code::is_patchday `
579
+ ### <a name =" patching_as_code--is_patchday " ></a >` patching_as_code::is_patchday `
580
580
581
581
Type: Puppet Language
582
582
@@ -606,7 +606,7 @@ Data type: `String`
606
606
607
607
608
608
609
- ### <a name =" patching_as_codelast_run " ></a >` patching_as_code::last_run `
609
+ ### <a name =" patching_as_code--last_run " ></a >` patching_as_code::last_run `
610
610
611
611
Type: Ruby 4.x API
612
612
@@ -630,7 +630,7 @@ Data type: `Array`
630
630
631
631
632
632
633
- ### <a name =" patching_as_codeprocess_patch_groups " ></a >` patching_as_code::process_patch_groups `
633
+ ### <a name =" patching_as_code--process_patch_groups " ></a >` patching_as_code::process_patch_groups `
634
634
635
635
Type: Puppet Language
636
636
0 commit comments