Skip to content

Commit 86ac46b

Browse files
committed
regenerate REFERENCE.md
1 parent 321a564 commit 86ac46b

1 file changed

Lines changed: 57 additions & 1 deletion

File tree

REFERENCE.md

Lines changed: 57 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,145 +166,193 @@ Data type: `String`
166166

167167
The rsyslog configuration directory.
168168

169+
Default value: `'/etc/rsyslog.d'`
170+
169171
##### <a name="-rsyslog--package_name"></a>`package_name`
170172

171173
Data type: `String`
172174

173175
The name of the rsyslog package to install.
174176

177+
Default value: `'rsyslog'`
178+
175179
##### <a name="-rsyslog--package_version"></a>`package_version`
176180

177181
Data type: `String`
178182

179183
The version of rsyslog to install.
180184

185+
Default value: `'installed'`
186+
181187
##### <a name="-rsyslog--config_file"></a>`config_file`
182188

183189
Data type: `String`
184190

185191
The global rsyslog configuration file.
186192

193+
Default value: `'/etc/rsyslog.conf'`
194+
187195
##### <a name="-rsyslog--feature_packages"></a>`feature_packages`
188196

189197
Data type: `Array`
190198

191199
List of additional rsyslog packages to install.
192200

201+
Default value: `[]`
202+
193203
##### <a name="-rsyslog--module_load_priority"></a>`module_load_priority`
194204

195205
Data type: `Integer`
196206

197207
Order the loading of rsyslog modules relative to other configuration.
198208

209+
Default value: `20`
210+
199211
##### <a name="-rsyslog--service_name"></a>`service_name`
200212

201213
Data type: `String`
202214

203215
Name of the SystemD, Upstart, or SysVInit service.
204216

217+
Default value: `'rsyslog'`
218+
205219
##### <a name="-rsyslog--service_status"></a>`service_status`
206220

207221
Data type: `String`
208222

209223
State desired for the rsyslog service.
210224

225+
Default value: `'running'`
226+
211227
##### <a name="-rsyslog--service_enabled"></a>`service_enabled`
212228

213229
Data type: `Boolean`
214230

215231
Is the service enabled or not.
216232

233+
Default value: `true`
234+
217235
##### <a name="-rsyslog--override_default_config"></a>`override_default_config`
218236

219237
Data type: `Boolean`
220238

221239
Override the default rsyslog.conf file.
222240

241+
Default value: `true`
242+
223243
##### <a name="-rsyslog--manage_package"></a>`manage_package`
224244

225245
Data type: `Boolean`
226246

227247
Toggle the managing of the rsyslog package.
228248

249+
Default value: `true`
250+
229251
##### <a name="-rsyslog--use_upstream_repo"></a>`use_upstream_repo`
230252

231253
Data type: `Boolean`
232254

233255
Toggle using the upstream Adiscon Rsyslog repository.
234256

257+
Default value: `false`
258+
235259
##### <a name="-rsyslog--manage_confdir"></a>`manage_confdir`
236260

237261
Data type: `Boolean`
238262

239263
Toggle management of the Rsyslog configuration directory.
240264

265+
Default value: `true`
266+
241267
##### <a name="-rsyslog--manage_service"></a>`manage_service`
242268

243269
Data type: `Boolean`
244270

245271
Toggle management of the rsyslog service.
246272

273+
Default value: `true`
274+
247275
##### <a name="-rsyslog--external_service"></a>`external_service`
248276

249277
Data type: `Boolean`
250278

251279
Toggle if the service is external to where rsyslog is being run.
252280
I.E. a service that starts a docker container running rsyslog.
253281

282+
Default value: `false`
283+
254284
##### <a name="-rsyslog--purge_config_files"></a>`purge_config_files`
255285

256286
Data type: `Boolean`
257287

258288
Toggle purging of unmanaged configuration files.
259289

290+
Default value: `true`
291+
260292
##### <a name="-rsyslog--global_config_priority"></a>`global_config_priority`
261293

262294
Data type: `Integer`
263295

264296
Set the global ordering of global configuration parameters in rsyslog.
265297

298+
Default value: `10`
299+
266300
##### <a name="-rsyslog--legacy_config_priority"></a>`legacy_config_priority`
267301

268302
Data type: `Integer`
269303

270304
Set the global ordering of legacy configuration parameters in rsyslog.
271305

306+
Default value: `80`
307+
272308
##### <a name="-rsyslog--template_priority"></a>`template_priority`
273309

274310
Data type: `Integer`
275311

276312
Set the global ordering of template configuration in rsyslog.
277313

314+
Default value: `50`
315+
278316
##### <a name="-rsyslog--action_priority"></a>`action_priority`
279317

280318
Data type: `Integer`
281319

282320
Set the global ordering of action configuration in rsyslog.
283321

322+
Default value: `60`
323+
284324
##### <a name="-rsyslog--input_priority"></a>`input_priority`
285325

286326
Data type: `Integer`
287327

288328
Set the global ordering of input configuration in rsyslog.
289329

330+
Default value: `30`
331+
290332
##### <a name="-rsyslog--custom_priority"></a>`custom_priority`
291333

292334
Data type: `Integer`
293335

294336
Set the global ordering of custom configuration in rsyslog.
295337

338+
Default value: `90`
339+
296340
##### <a name="-rsyslog--main_queue_priority"></a>`main_queue_priority`
297341

298342
Data type: `Integer`
299343

300344
Set the global ordering of main queue configuration in rsyslog.
301345

346+
Default value: `40`
347+
302348
##### <a name="-rsyslog--lookup_table_priority"></a>`lookup_table_priority`
303349

304350
Data type: `Integer`
305351

306352
Set the global ordering of lookup table configuration in rsyslog.
307353

354+
Default value: `70`
355+
308356
##### <a name="-rsyslog--parser_priorty"></a>`parser_priorty`
309357

310358
Set the global ordering of parser configuration in rsyslog.
@@ -315,18 +363,24 @@ Data type: `Integer`
315363

316364
Set the global ordering of rulesets configuration in rsyslog.
317365

366+
Default value: `65`
367+
318368
##### <a name="-rsyslog--filter_priority"></a>`filter_priority`
319369

320370
Data type: `Integer`
321371

322372
Set the global ordering of filter configuration in rsyslog.
323373

374+
Default value: `55`
375+
324376
##### <a name="-rsyslog--target_file"></a>`target_file`
325377

326378
Data type: `String`
327379

328380
Target file to insert configuration into.
329381

382+
Default value: `'50_rsyslog.conf'`
383+
330384
##### <a name="-rsyslog--conf_permissions"></a>`conf_permissions`
331385

332386
Data type: `Stdlib::Filemode`
@@ -365,6 +419,8 @@ Data type: `Integer`
365419

366420

367421

422+
Default value: `45`
423+
368424
### <a name="rsyslog--base"></a>`rsyslog::base`
369425

370426
This class manages the base installation for rsyslog
@@ -2340,7 +2396,7 @@ Alias of `Enum['smfile', 'smfwd', 'smtradfile', 'smtradfwd']`
23402396

23412397
Enumerable custom type for rsyslog property operators
23422398

2343-
Alias of `Enum['contains', 'isequal', 'startswith', 'regex', 'ereregex', '!contains', '!isequal', '!startswith', '!regex', '!ereregex']`
2399+
Alias of `Enum['contains', 'isequal', 'startswith', 'endswith', 'regex', 'ereregex', '!contains', '!isequal', '!startswith', '!endswith', '!regex', '!ereregex']`
23442400

23452401
### <a name="Rsyslog--Queue--Parameters"></a>`Rsyslog::Queue::Parameters`
23462402

0 commit comments

Comments
 (0)