From 065bc752923fbc2e078f776aa52009c07010696a Mon Sep 17 00:00:00 2001 From: Mike Riddle Date: Mon, 31 Jul 2023 20:39:40 -0400 Subject: [PATCH] Finalize RockyLinux 8 support (#142) --- .github/workflows/pr_tests.yml | 1 + .gitignore | 1 + .gitlab-ci.yml | 1 + REFERENCE.md | 870 ++++++++++++++++----------------- 4 files changed, 432 insertions(+), 441 deletions(-) diff --git a/.github/workflows/pr_tests.yml b/.github/workflows/pr_tests.yml index e4bc468..1780c4a 100644 --- a/.github/workflows/pr_tests.yml +++ b/.github/workflows/pr_tests.yml @@ -117,6 +117,7 @@ jobs: puppet_version: '~> 8.0' ruby_version: 3.1 experimental: true + fail-fast: false env: PUPPET_VERSION: ${{matrix.puppet.puppet_version}} steps: diff --git a/.gitignore b/.gitignore index 706aeb6..410b067 100644 --- a/.gitignore +++ b/.gitignore @@ -24,3 +24,4 @@ dist /junit /log /doc +/Gemfile.lock diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 3fffd9a..61c8989 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -340,6 +340,7 @@ pup7.pe-unit: <<: *pup_7_pe <<: *unit_tests +# Commenting until Puppet 8 is released #pup8.x-unit: # <<: *pup_8_x # <<: *unit_tests diff --git a/REFERENCE.md b/REFERENCE.md index 142ff1d..7bf5f35 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -9,7 +9,7 @@ #### Public Classes * [`rsyslog`](#rsyslog): Set up Rsyslog 8 -* [`rsyslog::server`](#rsyslogserver): Sets up the RSyslog server +* [`rsyslog::server`](#rsyslog--server): Sets up the RSyslog server #### Private Classes @@ -23,23 +23,23 @@ ### Defined types -* [`rsyslog::rule`](#rsyslogrule): Adds a rule -* [`rsyslog::rule::console`](#rsyslogruleconsole): Add a rule for writing logs to the console -* [`rsyslog::rule::data_source`](#rsyslogruledata_source): Add a rule for collecting logs from files on the system -* [`rsyslog::rule::drop`](#rsyslogruledrop): Add a rule to drop content -* [`rsyslog::rule::local`](#rsyslogrulelocal): Add a rule targeting writing local system logs -* [`rsyslog::rule::other`](#rsyslogruleother): Adds an arbitrary rule -* [`rsyslog::rule::remote`](#rsyslogruleremote): Adds a rule to send messages to one or more remote system -* [`rsyslog::template::list`](#rsyslogtemplatelist): Add a template list to the rsyslog configuration file -* [`rsyslog::template::plugin`](#rsyslogtemplateplugin): Add template plugins to the rsyslog configuration file. -* [`rsyslog::template::string`](#rsyslogtemplatestring): Add template strings to the rsyslog configuration -* [`rsyslog::template::subtree`](#rsyslogtemplatesubtree): Add template subtrees to the rsyslog configuration +* [`rsyslog::rule`](#rsyslog--rule): Adds a rule +* [`rsyslog::rule::console`](#rsyslog--rule--console): Add a rule for writing logs to the console +* [`rsyslog::rule::data_source`](#rsyslog--rule--data_source): Add a rule for collecting logs from files on the system +* [`rsyslog::rule::drop`](#rsyslog--rule--drop): Add a rule to drop content +* [`rsyslog::rule::local`](#rsyslog--rule--local): Add a rule targeting writing local system logs +* [`rsyslog::rule::other`](#rsyslog--rule--other): Adds an arbitrary rule +* [`rsyslog::rule::remote`](#rsyslog--rule--remote): Adds a rule to send messages to one or more remote system +* [`rsyslog::template::list`](#rsyslog--template--list): Add a template list to the rsyslog configuration file +* [`rsyslog::template::plugin`](#rsyslog--template--plugin): Add template plugins to the rsyslog configuration file. +* [`rsyslog::template::string`](#rsyslog--template--string): Add template strings to the rsyslog configuration +* [`rsyslog::template::subtree`](#rsyslog--template--subtree): Add template subtrees to the rsyslog configuration ### Data types -* [`Rsyslog::Boolean`](#rsyslogboolean): Representation of boolean values that are translated to 'on' and 'off' in Rsyslog configuration -* [`Rsyslog::Options`](#rsyslogoptions): Hash of options to be used for Rsyslog global, legacy global or module configuration -* [`Rsyslog::QueueType`](#rsyslogqueuetype): Rsyslog Queue Types +* [`Rsyslog::Boolean`](#Rsyslog--Boolean): Representation of boolean values that are translated to 'on' and 'off' in Rsyslog configuration +* [`Rsyslog::Options`](#Rsyslog--Options): Hash of options to be used for Rsyslog global, legacy global or module configuration +* [`Rsyslog::QueueType`](#Rsyslog--QueueType): Rsyslog Queue Types ## Classes @@ -56,29 +56,29 @@ See ``rsyslog::config`` for additional, detailed configuration. The following parameters are available in the `rsyslog` class: -* [`service_name`](#service_name) -* [`package_name`](#package_name) -* [`tls_package_name`](#tls_package_name) -* [`trusted_nets`](#trusted_nets) -* [`enable_tls_logging`](#enable_tls_logging) -* [`log_servers`](#log_servers) -* [`failover_log_servers`](#failover_log_servers) -* [`queue_spool_directory`](#queue_spool_directory) -* [`rule_dir`](#rule_dir) -* [`tcp_server`](#tcp_server) -* [`tcp_listen_port`](#tcp_listen_port) -* [`tls_tcp_server`](#tls_tcp_server) -* [`tls_tcp_listen_port`](#tls_tcp_listen_port) -* [`udp_server`](#udp_server) -* [`udp_listen_address`](#udp_listen_address) -* [`udp_listen_port`](#udp_listen_port) -* [`read_journald`](#read_journald) -* [`logrotate`](#logrotate) -* [`pki`](#pki) -* [`app_pki_external_source`](#app_pki_external_source) -* [`app_pki_dir`](#app_pki_dir) - -##### `service_name` +* [`service_name`](#-rsyslog--service_name) +* [`package_name`](#-rsyslog--package_name) +* [`tls_package_name`](#-rsyslog--tls_package_name) +* [`trusted_nets`](#-rsyslog--trusted_nets) +* [`enable_tls_logging`](#-rsyslog--enable_tls_logging) +* [`log_servers`](#-rsyslog--log_servers) +* [`failover_log_servers`](#-rsyslog--failover_log_servers) +* [`queue_spool_directory`](#-rsyslog--queue_spool_directory) +* [`rule_dir`](#-rsyslog--rule_dir) +* [`tcp_server`](#-rsyslog--tcp_server) +* [`tcp_listen_port`](#-rsyslog--tcp_listen_port) +* [`tls_tcp_server`](#-rsyslog--tls_tcp_server) +* [`tls_tcp_listen_port`](#-rsyslog--tls_tcp_listen_port) +* [`udp_server`](#-rsyslog--udp_server) +* [`udp_listen_address`](#-rsyslog--udp_listen_address) +* [`udp_listen_port`](#-rsyslog--udp_listen_port) +* [`read_journald`](#-rsyslog--read_journald) +* [`logrotate`](#-rsyslog--logrotate) +* [`pki`](#-rsyslog--pki) +* [`app_pki_external_source`](#-rsyslog--app_pki_external_source) +* [`app_pki_dir`](#-rsyslog--app_pki_dir) + +##### `service_name` Data type: `String` @@ -86,7 +86,7 @@ The name of the Rsyslog service; typically ``rsyslog`` Default value: `'rsyslog'` -##### `package_name` +##### `package_name` Data type: `String` @@ -94,7 +94,7 @@ The name of the Rsyslog package to install; typically ``rsyslog`` Default value: `'rsyslog'` -##### `tls_package_name` +##### `tls_package_name` Data type: `String` @@ -102,7 +102,7 @@ The name of the Rsyslog package to install TLS utilities; typically ``rsyslog-gn Default value: `"${package_name}-gnutls"` -##### `trusted_nets` +##### `trusted_nets` Data type: `Simplib::Netlist` @@ -113,7 +113,7 @@ A list of subnets (in CIDR notation) permitted access Default value: `simplib::lookup('simp_options::trusted_nets', {'default_value' => ['127.0.0.1/32'] })` -##### `enable_tls_logging` +##### `enable_tls_logging` Data type: `Boolean` @@ -124,9 +124,9 @@ Enable the TLS libraries where applicable ``rsyslog::server::tls_tcp_server``) will load the ``imtcp`` module and configure it for TLS. -Default value: ``false`` +Default value: `false` -##### `log_servers` +##### `log_servers` Data type: `Simplib::Netlist` @@ -137,7 +137,7 @@ A list of primary Rsyslog servers Default value: `simplib::lookup('simp_options::syslog::log_servers', { 'default_value' => [] })` -##### `failover_log_servers` +##### `failover_log_servers` Data type: `Simplib::Netlist` @@ -149,7 +149,7 @@ A list of the failover Rsyslog servers Default value: `simplib::lookup('simp_options::syslog::failover_log_servers', { 'default_value' => [] })` -##### `queue_spool_directory` +##### `queue_spool_directory` Data type: `Stdlib::Absolutepath` @@ -157,7 +157,7 @@ The path to the directory where Rsyslog should store disk message queues Default value: `'/var/spool/rsyslog'` -##### `rule_dir` +##### `rule_dir` Data type: `Stdlib::Absolutepath` @@ -165,7 +165,7 @@ The path at which all managed rules will begin Default value: `'/etc/rsyslog.simp.d'` -##### `tcp_server` +##### `tcp_server` Data type: `Boolean` @@ -175,9 +175,9 @@ Make this host listen for ``TCP`` connections instead. * Only enable this if necessary. -Default value: ``false`` +Default value: `false` -##### `tcp_listen_port` +##### `tcp_listen_port` Data type: `Simplib::Port` @@ -185,15 +185,15 @@ The port upon which to listen for regular ``TCP`` connections Default value: `514` -##### `tls_tcp_server` +##### `tls_tcp_server` Data type: `Boolean` Make this host listen for ``TLS`` enabled ``TCP`` connections -Default value: ``false`` +Default value: `false` -##### `tls_tcp_listen_port` +##### `tls_tcp_listen_port` Data type: `Simplib::Port` @@ -201,7 +201,7 @@ The port upon which to listen for ``TLS`` enabled ``TCP`` connections Default value: `6514` -##### `udp_server` +##### `udp_server` Data type: `Boolean` @@ -210,9 +210,9 @@ Make this host listen for ``UDP`` connections * This really should not be enabled unless you have devices that cannot speak ``TLS`` -Default value: ``false`` +Default value: `false` -##### `udp_listen_address` +##### `udp_listen_address` Data type: `String` @@ -223,7 +223,7 @@ The address upon which to listen for ``UDP`` connections Default value: `'127.0.0.1'` -##### `udp_listen_port` +##### `udp_listen_port` Data type: `Simplib::Port` @@ -231,15 +231,15 @@ The port upon which to listen for ``UDP`` connections Default value: `514` -##### `read_journald` +##### `read_journald` Data type: `Boolean` Enable the processing of ``journald`` messages natively in Rsyslog -Default value: ``true`` +Default value: `true` -##### `logrotate` +##### `logrotate` Data type: `Boolean` @@ -250,7 +250,7 @@ Ensure that ``logrotate`` is enabled on this system Default value: `simplib::lookup('simp_options::logrotate', {'default_value' => false})` -##### `pki` +##### `pki` Data type: `Variant[Boolean,Enum['simp']]` @@ -268,7 +268,7 @@ Data type: `Variant[Boolean,Enum['simp']]` Default value: `simplib::lookup('simp_options::pki', {'default_value' => false})` -##### `app_pki_external_source` +##### `app_pki_external_source` Data type: `String` @@ -279,7 +279,7 @@ Data type: `String` Default value: `simplib::lookup('simp_options::pki::source', {'default_value' => '/etc/pki/simp/x509'})` -##### `app_pki_dir` +##### `app_pki_dir` Data type: `Stdlib::Absolutepath` @@ -288,7 +288,7 @@ and $default_net_stream_driver_key_file Default value: `'/etc/pki/simp_apps/rsyslog/x509'` -### `rsyslog::server` +### `rsyslog::server` This class is designed to configure the externally facing interfaces for a RSyslog system. If you do not need external connectivity, you should just use @@ -298,11 +298,11 @@ the stock ``rsyslog`` Class. The following parameters are available in the `rsyslog::server` class: -* [`enable_firewall`](#enable_firewall) -* [`enable_selinux`](#enable_selinux) -* [`enable_tcpwrappers`](#enable_tcpwrappers) +* [`enable_firewall`](#-rsyslog--server--enable_firewall) +* [`enable_selinux`](#-rsyslog--server--enable_selinux) +* [`enable_tcpwrappers`](#-rsyslog--server--enable_tcpwrappers) -##### `enable_firewall` +##### `enable_firewall` Data type: `Boolean` @@ -310,15 +310,15 @@ Enable the SIMP firewall rules for RSyslog Default value: `simplib::lookup('simp_options::firewall', { 'default_value' => false })` -##### `enable_selinux` +##### `enable_selinux` Data type: `Optional[Boolean]` Enable the SIMP SELinux rules for RSyslog -Default value: `$facts['selinux_enforced']` +Default value: `$facts['os']['selinux']['enforced']` -##### `enable_tcpwrappers` +##### `enable_tcpwrappers` Data type: `Boolean` @@ -328,7 +328,7 @@ Default value: `simplib::lookup('simp_options::tcpwrappers', { 'default_value' = ## Defined types -### `rsyslog::rule` +### `rsyslog::rule` This is used by the various ``rsyslog::rule::*`` Defined Types to apply rules to the system. @@ -375,10 +375,10 @@ rsyslog::rule::other { '98_discard_info.conf': The following parameters are available in the `rsyslog::rule` defined type: -* [`name`](#name) -* [`content`](#content) +* [`name`](#-rsyslog--rule--name) +* [`content`](#-rsyslog--rule--content) -##### `name` +##### `name` Data type: `Pattern['^[^/]\S+/\S+\.conf$']` @@ -386,13 +386,13 @@ The filename that you will be dropping into place * **WARNING:** This must **NOT** be an absolute path! -##### `content` +##### `content` Data type: `String` The **exact content** of the rule to place in the target file -### `rsyslog::rule::console` +### `rsyslog::rule::console` These rules first in priority. In general, the order will be: @@ -426,29 +426,29 @@ rsyslog::rule::console { 'emergency_rule': The following parameters are available in the `rsyslog::rule::console` defined type: -* [`name`](#name) -* [`rule`](#rule) -* [`users`](#users) +* [`name`](#-rsyslog--rule--console--name) +* [`rule`](#-rsyslog--rule--console--rule) +* [`users`](#-rsyslog--rule--console--users) -##### `name` +##### `name` Data type: `String` The filename that you will be dropping into place -##### `rule` +##### `rule` Data type: `String` The Rsyslog ``EXPRESSION`` to filter on -##### `users` +##### `users` Data type: `Array[String]` Users to which to send the console messages -### `rsyslog::rule::data_source` +### `rsyslog::rule::data_source` In general, the order will be: @@ -491,22 +491,22 @@ rsyslog::rule::data_source { 'new_input': The following parameters are available in the `rsyslog::rule::data_source` defined type: -* [`name`](#name) -* [`rule`](#rule) +* [`name`](#-rsyslog--rule--data_source--name) +* [`rule`](#-rsyslog--rule--data_source--rule) -##### `name` +##### `name` Data type: `String` The filename that you will be dropping into place -##### `rule` +##### `rule` Data type: `String` The Rsyslog ``EXPRESSION`` to filter on -### `rsyslog::rule::drop` +### `rsyslog::rule::drop` In general, the order will be: @@ -541,22 +541,22 @@ rsyslog::rule::drop { 'drop_bad_stuff': The following parameters are available in the `rsyslog::rule::drop` defined type: -* [`name`](#name) -* [`rule`](#rule) +* [`name`](#-rsyslog--rule--drop--name) +* [`rule`](#-rsyslog--rule--drop--rule) -##### `name` +##### `name` Data type: `String` The filename that you will be dropping into place -##### `rule` +##### `rule` Data type: `String` The Rsyslog ``EXPRESSION`` to filter on -### `rsyslog::rule::local` +### `rsyslog::rule::local` **NOTE:** Any option that is not explicitly documented here matches the ``ruleset`` options in the Rsyslog documentation. @@ -608,69 +608,69 @@ rsyslog::rule::local { 'collect_openldap': The following parameters are available in the `rsyslog::rule::local` defined type: -* [`name`](#name) -* [`rule`](#rule) -* [`target_log_file`](#target_log_file) -* [`stop_processing`](#stop_processing) -* [`dyna_file`](#dyna_file) -* [`template`](#template) -* [`dyna_file_cache_size`](#dyna_file_cache_size) -* [`zip_level`](#zip_level) -* [`very_robust_zip`](#very_robust_zip) -* [`flush_interval`](#flush_interval) -* [`async_writing`](#async_writing) -* [`flush_on_tx_end`](#flush_on_tx_end) -* [`io_buffer_size`](#io_buffer_size) -* [`dir_owner`](#dir_owner) -* [`dir_owner_num`](#dir_owner_num) -* [`dir_group`](#dir_group) -* [`dir_group_num`](#dir_group_num) -* [`file_owner`](#file_owner) -* [`file_owner_num`](#file_owner_num) -* [`file_group`](#file_group) -* [`file_group_num`](#file_group_num) -* [`file_create_mode`](#file_create_mode) -* [`dir_create_mode`](#dir_create_mode) -* [`fail_on_chown_failure`](#fail_on_chown_failure) -* [`create_dirs`](#create_dirs) -* [`sync`](#sync) -* [`sig_provider`](#sig_provider) -* [`cry_provider`](#cry_provider) -* [`queue_validation_log_level`](#queue_validation_log_level) -* [`queue_filename`](#queue_filename) -* [`queue_spool_directory`](#queue_spool_directory) -* [`queue_size`](#queue_size) -* [`queue_dequeue_batch_size`](#queue_dequeue_batch_size) -* [`queue_max_disk_space`](#queue_max_disk_space) -* [`queue_high_watermark`](#queue_high_watermark) -* [`queue_low_watermark`](#queue_low_watermark) -* [`queue_full_delay_mark`](#queue_full_delay_mark) -* [`queue_light_delay_mark`](#queue_light_delay_mark) -* [`queue_discard_mark`](#queue_discard_mark) -* [`queue_discard_severity`](#queue_discard_severity) -* [`queue_checkpoint_interval`](#queue_checkpoint_interval) -* [`queue_sync_queue_files`](#queue_sync_queue_files) -* [`queue_type`](#queue_type) -* [`queue_worker_threads`](#queue_worker_threads) -* [`queue_timeout_shutdown`](#queue_timeout_shutdown) -* [`queue_timeout_action_completion`](#queue_timeout_action_completion) -* [`queue_timeout_enqueue`](#queue_timeout_enqueue) -* [`queue_timeout_worker_thread_shutdown`](#queue_timeout_worker_thread_shutdown) -* [`queue_worker_thread_minimum_messages`](#queue_worker_thread_minimum_messages) -* [`queue_max_file_size`](#queue_max_file_size) -* [`queue_save_on_shutdown`](#queue_save_on_shutdown) -* [`queue_dequeue_slowdown`](#queue_dequeue_slowdown) -* [`queue_dequeue_time_begin`](#queue_dequeue_time_begin) -* [`queue_dequeue_time_end`](#queue_dequeue_time_end) -* [`content`](#content) - -##### `name` +* [`name`](#-rsyslog--rule--local--name) +* [`rule`](#-rsyslog--rule--local--rule) +* [`target_log_file`](#-rsyslog--rule--local--target_log_file) +* [`stop_processing`](#-rsyslog--rule--local--stop_processing) +* [`dyna_file`](#-rsyslog--rule--local--dyna_file) +* [`template`](#-rsyslog--rule--local--template) +* [`dyna_file_cache_size`](#-rsyslog--rule--local--dyna_file_cache_size) +* [`zip_level`](#-rsyslog--rule--local--zip_level) +* [`very_robust_zip`](#-rsyslog--rule--local--very_robust_zip) +* [`flush_interval`](#-rsyslog--rule--local--flush_interval) +* [`async_writing`](#-rsyslog--rule--local--async_writing) +* [`flush_on_tx_end`](#-rsyslog--rule--local--flush_on_tx_end) +* [`io_buffer_size`](#-rsyslog--rule--local--io_buffer_size) +* [`dir_owner`](#-rsyslog--rule--local--dir_owner) +* [`dir_owner_num`](#-rsyslog--rule--local--dir_owner_num) +* [`dir_group`](#-rsyslog--rule--local--dir_group) +* [`dir_group_num`](#-rsyslog--rule--local--dir_group_num) +* [`file_owner`](#-rsyslog--rule--local--file_owner) +* [`file_owner_num`](#-rsyslog--rule--local--file_owner_num) +* [`file_group`](#-rsyslog--rule--local--file_group) +* [`file_group_num`](#-rsyslog--rule--local--file_group_num) +* [`file_create_mode`](#-rsyslog--rule--local--file_create_mode) +* [`dir_create_mode`](#-rsyslog--rule--local--dir_create_mode) +* [`fail_on_chown_failure`](#-rsyslog--rule--local--fail_on_chown_failure) +* [`create_dirs`](#-rsyslog--rule--local--create_dirs) +* [`sync`](#-rsyslog--rule--local--sync) +* [`sig_provider`](#-rsyslog--rule--local--sig_provider) +* [`cry_provider`](#-rsyslog--rule--local--cry_provider) +* [`queue_validation_log_level`](#-rsyslog--rule--local--queue_validation_log_level) +* [`queue_filename`](#-rsyslog--rule--local--queue_filename) +* [`queue_spool_directory`](#-rsyslog--rule--local--queue_spool_directory) +* [`queue_size`](#-rsyslog--rule--local--queue_size) +* [`queue_dequeue_batch_size`](#-rsyslog--rule--local--queue_dequeue_batch_size) +* [`queue_max_disk_space`](#-rsyslog--rule--local--queue_max_disk_space) +* [`queue_high_watermark`](#-rsyslog--rule--local--queue_high_watermark) +* [`queue_low_watermark`](#-rsyslog--rule--local--queue_low_watermark) +* [`queue_full_delay_mark`](#-rsyslog--rule--local--queue_full_delay_mark) +* [`queue_light_delay_mark`](#-rsyslog--rule--local--queue_light_delay_mark) +* [`queue_discard_mark`](#-rsyslog--rule--local--queue_discard_mark) +* [`queue_discard_severity`](#-rsyslog--rule--local--queue_discard_severity) +* [`queue_checkpoint_interval`](#-rsyslog--rule--local--queue_checkpoint_interval) +* [`queue_sync_queue_files`](#-rsyslog--rule--local--queue_sync_queue_files) +* [`queue_type`](#-rsyslog--rule--local--queue_type) +* [`queue_worker_threads`](#-rsyslog--rule--local--queue_worker_threads) +* [`queue_timeout_shutdown`](#-rsyslog--rule--local--queue_timeout_shutdown) +* [`queue_timeout_action_completion`](#-rsyslog--rule--local--queue_timeout_action_completion) +* [`queue_timeout_enqueue`](#-rsyslog--rule--local--queue_timeout_enqueue) +* [`queue_timeout_worker_thread_shutdown`](#-rsyslog--rule--local--queue_timeout_worker_thread_shutdown) +* [`queue_worker_thread_minimum_messages`](#-rsyslog--rule--local--queue_worker_thread_minimum_messages) +* [`queue_max_file_size`](#-rsyslog--rule--local--queue_max_file_size) +* [`queue_save_on_shutdown`](#-rsyslog--rule--local--queue_save_on_shutdown) +* [`queue_dequeue_slowdown`](#-rsyslog--rule--local--queue_dequeue_slowdown) +* [`queue_dequeue_time_begin`](#-rsyslog--rule--local--queue_dequeue_time_begin) +* [`queue_dequeue_time_end`](#-rsyslog--rule--local--queue_dequeue_time_end) +* [`content`](#-rsyslog--rule--local--content) + +##### `name` Data type: `String` The filename that you will be dropping into place -##### `rule` +##### `rule` Data type: `Optional[String[1]]` @@ -682,9 +682,9 @@ The Rsyslog ``EXPRESSION`` to filter on * This **must** be set if ``$content`` is undefined -Default value: ``undef`` +Default value: `undef` -##### `target_log_file` +##### `target_log_file` Data type: `Optional[Stdlib::Absolutepath]` @@ -692,17 +692,17 @@ The target log file that omfile will be writing to * This **must** be set if ``$dyna_file`` is undefined -Default value: ``undef`` +Default value: `undef` -##### `stop_processing` +##### `stop_processing` Data type: `Boolean` Do not forward logs to any further ``ruleset``s after processing this ``ruleset`` -Default value: ``false`` +Default value: `false` -##### `dyna_file` +##### `dyna_file` Data type: `Optional[String[1]]` @@ -716,17 +716,17 @@ Set a ``dynamic`` filename using the property replacer rules * Rsyslog templates can be created using the ``rsyslog::template::*`` defined types -Default value: ``undef`` +Default value: `undef` -##### `template` +##### `template` Data type: `Optional[String[1]]` -Default value: ``undef`` +Default value: `undef` -##### `dyna_file_cache_size` +##### `dyna_file_cache_size` Data type: `Integer[0]` @@ -734,7 +734,7 @@ Data type: `Integer[0]` Default value: `10` -##### `zip_level` +##### `zip_level` Data type: `Integer[0,9]` @@ -742,15 +742,15 @@ Data type: `Integer[0,9]` Default value: `0` -##### `very_robust_zip` +##### `very_robust_zip` Data type: `Boolean` -Default value: ``true`` +Default value: `true` -##### `flush_interval` +##### `flush_interval` Data type: `Integer[0]` @@ -758,95 +758,95 @@ Data type: `Integer[0]` Default value: `0` -##### `async_writing` +##### `async_writing` Data type: `Boolean` -Default value: ``false`` +Default value: `false` -##### `flush_on_tx_end` +##### `flush_on_tx_end` Data type: `Boolean` -Default value: ``true`` +Default value: `true` -##### `io_buffer_size` +##### `io_buffer_size` Data type: `Optional[Integer[0]]` -Default value: ``undef`` +Default value: `undef` -##### `dir_owner` +##### `dir_owner` Data type: `Optional[String[1]]` -Default value: ``undef`` +Default value: `undef` -##### `dir_owner_num` +##### `dir_owner_num` Data type: `Optional[Integer[0]]` -Default value: ``undef`` +Default value: `undef` -##### `dir_group` +##### `dir_group` Data type: `Optional[String[1]]` -Default value: ``undef`` +Default value: `undef` -##### `dir_group_num` +##### `dir_group_num` Data type: `Optional[Integer[0]]` -Default value: ``undef`` +Default value: `undef` -##### `file_owner` +##### `file_owner` Data type: `Optional[String[1]]` -Default value: ``undef`` +Default value: `undef` -##### `file_owner_num` +##### `file_owner_num` Data type: `Optional[Integer[0]]` -Default value: ``undef`` +Default value: `undef` -##### `file_group` +##### `file_group` Data type: `Optional[String[1]]` -Default value: ``undef`` +Default value: `undef` -##### `file_group_num` +##### `file_group_num` Data type: `Optional[Integer[0]]` -Default value: ``undef`` +Default value: `undef` -##### `file_create_mode` +##### `file_create_mode` Data type: `Stdlib::Filemode` @@ -854,7 +854,7 @@ Data type: `Stdlib::Filemode` Default value: `simplib::dlookup('rsyslog::rule::local', 'file_create_mode', $name, { 'default_value' => '0640' })` -##### `dir_create_mode` +##### `dir_create_mode` Data type: `Stdlib::Filemode` @@ -862,47 +862,47 @@ Data type: `Stdlib::Filemode` Default value: `simplib::dlookup('rsyslog::rule::local', 'dir_create_mode', $name, { 'default_value' => '0750' })` -##### `fail_on_chown_failure` +##### `fail_on_chown_failure` Data type: `Boolean` -Default value: ``true`` +Default value: `true` -##### `create_dirs` +##### `create_dirs` Data type: `Boolean` -Default value: ``true`` +Default value: `true` -##### `sync` +##### `sync` Data type: `Boolean` -Default value: ``false`` +Default value: `false` -##### `sig_provider` +##### `sig_provider` Data type: `Optional[String[1]]` -Default value: ``undef`` +Default value: `undef` -##### `cry_provider` +##### `cry_provider` Data type: `Optional[String[1]]` -Default value: ``undef`` +Default value: `undef` -##### `queue_validation_log_level` +##### `queue_validation_log_level` Data type: `Simplib::PuppetLogLevel` @@ -910,111 +910,111 @@ Data type: `Simplib::PuppetLogLevel` Default value: `simplib::dlookup('rsyslog::rule::local', 'queue_validation_log_level', $name, { 'default_value' => 'warning' })` -##### `queue_filename` +##### `queue_filename` Data type: `Optional[Stdlib::Absolutepath]` -Default value: ``undef`` +Default value: `undef` -##### `queue_spool_directory` +##### `queue_spool_directory` Data type: `Optional[Stdlib::Absolutepath]` -Default value: ``undef`` +Default value: `undef` -##### `queue_size` +##### `queue_size` Data type: `Optional[Integer[0]]` -Default value: ``undef`` +Default value: `undef` -##### `queue_dequeue_batch_size` +##### `queue_dequeue_batch_size` Data type: `Optional[Integer[0]]` -Default value: ``undef`` +Default value: `undef` -##### `queue_max_disk_space` +##### `queue_max_disk_space` Data type: `Optional[Integer[0]]` -Default value: ``undef`` +Default value: `undef` -##### `queue_high_watermark` +##### `queue_high_watermark` Data type: `Optional[Integer[0]]` -Default value: ``undef`` +Default value: `undef` -##### `queue_low_watermark` +##### `queue_low_watermark` Data type: `Optional[Integer[0]]` -Default value: ``undef`` +Default value: `undef` -##### `queue_full_delay_mark` +##### `queue_full_delay_mark` Data type: `Optional[Integer[0]]` -Default value: ``undef`` +Default value: `undef` -##### `queue_light_delay_mark` +##### `queue_light_delay_mark` Data type: `Optional[Integer[0]]` -Default value: ``undef`` +Default value: `undef` -##### `queue_discard_mark` +##### `queue_discard_mark` Data type: `Optional[Integer[0]]` -Default value: ``undef`` +Default value: `undef` -##### `queue_discard_severity` +##### `queue_discard_severity` Data type: `Optional[Integer[0]]` -Default value: ``undef`` +Default value: `undef` -##### `queue_checkpoint_interval` +##### `queue_checkpoint_interval` Data type: `Optional[Integer[0]]` -Default value: ``undef`` +Default value: `undef` -##### `queue_sync_queue_files` +##### `queue_sync_queue_files` Data type: `Boolean` -Default value: ``false`` +Default value: `false` -##### `queue_type` +##### `queue_type` Data type: `Rsyslog::QueueType` @@ -1022,55 +1022,55 @@ Data type: `Rsyslog::QueueType` Default value: `'Direct'` -##### `queue_worker_threads` +##### `queue_worker_threads` Data type: `Optional[Integer[0]]` -Default value: ``undef`` +Default value: `undef` -##### `queue_timeout_shutdown` +##### `queue_timeout_shutdown` Data type: `Optional[Integer[0]]` -Default value: ``undef`` +Default value: `undef` -##### `queue_timeout_action_completion` +##### `queue_timeout_action_completion` Data type: `Optional[Integer[0]]` -Default value: ``undef`` +Default value: `undef` -##### `queue_timeout_enqueue` +##### `queue_timeout_enqueue` Data type: `Optional[Integer[0]]` -Default value: ``undef`` +Default value: `undef` -##### `queue_timeout_worker_thread_shutdown` +##### `queue_timeout_worker_thread_shutdown` Data type: `Optional[Integer[0]]` -Default value: ``undef`` +Default value: `undef` -##### `queue_worker_thread_minimum_messages` +##### `queue_worker_thread_minimum_messages` Data type: `Optional[Integer[0]]` -Default value: ``undef`` +Default value: `undef` -##### `queue_max_file_size` +##### `queue_max_file_size` Data type: `Optional[String[1]]` @@ -1078,39 +1078,39 @@ Data type: `Optional[String[1]]` Default value: `simplib::dlookup('rsyslog::rule::local', 'queue_max_file_size', $name, { 'default_value' => undef })` -##### `queue_save_on_shutdown` +##### `queue_save_on_shutdown` Data type: `Boolean` -Default value: ``false`` +Default value: `false` -##### `queue_dequeue_slowdown` +##### `queue_dequeue_slowdown` Data type: `Optional[Integer[0]]` -Default value: ``undef`` +Default value: `undef` -##### `queue_dequeue_time_begin` +##### `queue_dequeue_time_begin` Data type: `Optional[Integer[0]]` -Default value: ``undef`` +Default value: `undef` -##### `queue_dequeue_time_end` +##### `queue_dequeue_time_end` Data type: `Optional[Integer[0]]` -Default value: ``undef`` +Default value: `undef` -##### `content` +##### `content` Data type: `Optional[String[1]]` @@ -1120,9 +1120,9 @@ the **entire* content of the rsyslog::rule * If you do specify this, ``$rule`` will be ignored -Default value: ``undef`` +Default value: `undef` -### `rsyslog::rule::other` +### `rsyslog::rule::other` The main reason to use this is to ensure proper ordering in the stack. If you want to insert a rule anywhere, use the ``$rsyslog::rule`` Defined Type @@ -1162,22 +1162,22 @@ rsyslog::rule::other { 'send_local0_away': The following parameters are available in the `rsyslog::rule::other` defined type: -* [`name`](#name) -* [`rule`](#rule) +* [`name`](#-rsyslog--rule--other--name) +* [`rule`](#-rsyslog--rule--other--rule) -##### `name` +##### `name` Data type: `String` The filename that you will be dropping into place -##### `rule` +##### `rule` Data type: `String` The Rsyslog ``EXPRESSION`` to filter on -### `rsyslog::rule::remote` +### `rsyslog::rule::remote` The rule will include a forwarding ('omfwd') action for each primary and failover syslog server specified via ``$dest`` and @@ -1246,66 +1246,66 @@ rsyslog::rule::remote { 'send_local0_away': The following parameters are available in the `rsyslog::rule::remote` defined type: -* [`name`](#name) -* [`rule`](#rule) -* [`stop_processing`](#stop_processing) -* [`template`](#template) -* [`dest`](#dest) -* [`dest_type`](#dest_type) -* [`failover_log_servers`](#failover_log_servers) -* [`tcp_framing`](#tcp_framing) -* [`zip_level`](#zip_level) -* [`max_error_messages`](#max_error_messages) -* [`compression_mode`](#compression_mode) -* [`compression_stream_flush_on_tx_end`](#compression_stream_flush_on_tx_end) -* [`rebind_interval`](#rebind_interval) -* [`keep_alive`](#keep_alive) -* [`keep_alive_probes`](#keep_alive_probes) -* [`keep_alive_interval`](#keep_alive_interval) -* [`keep_alive_time`](#keep_alive_time) -* [`action_resume_interval`](#action_resume_interval) -* [`action_resume_retry_count`](#action_resume_retry_count) -* [`stream_driver`](#stream_driver) -* [`stream_driver_mode`](#stream_driver_mode) -* [`stream_driver_auth_mode`](#stream_driver_auth_mode) -* [`stream_driver_permitted_peers`](#stream_driver_permitted_peers) -* [`resend_last_msg_on_reconnect`](#resend_last_msg_on_reconnect) -* [`udp_send_to_all`](#udp_send_to_all) -* [`queue_validation_log_level`](#queue_validation_log_level) -* [`queue_filename`](#queue_filename) -* [`queue_spool_directory`](#queue_spool_directory) -* [`queue_size`](#queue_size) -* [`queue_dequeue_batch_size`](#queue_dequeue_batch_size) -* [`queue_max_disk_space`](#queue_max_disk_space) -* [`queue_high_watermark`](#queue_high_watermark) -* [`queue_low_watermark`](#queue_low_watermark) -* [`queue_full_delay_mark`](#queue_full_delay_mark) -* [`queue_light_delay_mark`](#queue_light_delay_mark) -* [`queue_discard_mark`](#queue_discard_mark) -* [`queue_discard_severity`](#queue_discard_severity) -* [`queue_checkpoint_interval`](#queue_checkpoint_interval) -* [`queue_sync_queue_files`](#queue_sync_queue_files) -* [`queue_type`](#queue_type) -* [`queue_worker_threads`](#queue_worker_threads) -* [`queue_timeout_shutdown`](#queue_timeout_shutdown) -* [`queue_timeout_action_completion`](#queue_timeout_action_completion) -* [`queue_timeout_enqueue`](#queue_timeout_enqueue) -* [`queue_timeout_worker_thread_shutdown`](#queue_timeout_worker_thread_shutdown) -* [`queue_worker_thread_minimum_messages`](#queue_worker_thread_minimum_messages) -* [`queue_max_file_size`](#queue_max_file_size) -* [`queue_save_on_shutdown`](#queue_save_on_shutdown) -* [`queue_dequeue_slowdown`](#queue_dequeue_slowdown) -* [`queue_dequeue_time_begin`](#queue_dequeue_time_begin) -* [`queue_dequeue_time_end`](#queue_dequeue_time_end) -* [`content`](#content) - -##### `name` +* [`name`](#-rsyslog--rule--remote--name) +* [`rule`](#-rsyslog--rule--remote--rule) +* [`stop_processing`](#-rsyslog--rule--remote--stop_processing) +* [`template`](#-rsyslog--rule--remote--template) +* [`dest`](#-rsyslog--rule--remote--dest) +* [`dest_type`](#-rsyslog--rule--remote--dest_type) +* [`failover_log_servers`](#-rsyslog--rule--remote--failover_log_servers) +* [`tcp_framing`](#-rsyslog--rule--remote--tcp_framing) +* [`zip_level`](#-rsyslog--rule--remote--zip_level) +* [`max_error_messages`](#-rsyslog--rule--remote--max_error_messages) +* [`compression_mode`](#-rsyslog--rule--remote--compression_mode) +* [`compression_stream_flush_on_tx_end`](#-rsyslog--rule--remote--compression_stream_flush_on_tx_end) +* [`rebind_interval`](#-rsyslog--rule--remote--rebind_interval) +* [`keep_alive`](#-rsyslog--rule--remote--keep_alive) +* [`keep_alive_probes`](#-rsyslog--rule--remote--keep_alive_probes) +* [`keep_alive_interval`](#-rsyslog--rule--remote--keep_alive_interval) +* [`keep_alive_time`](#-rsyslog--rule--remote--keep_alive_time) +* [`action_resume_interval`](#-rsyslog--rule--remote--action_resume_interval) +* [`action_resume_retry_count`](#-rsyslog--rule--remote--action_resume_retry_count) +* [`stream_driver`](#-rsyslog--rule--remote--stream_driver) +* [`stream_driver_mode`](#-rsyslog--rule--remote--stream_driver_mode) +* [`stream_driver_auth_mode`](#-rsyslog--rule--remote--stream_driver_auth_mode) +* [`stream_driver_permitted_peers`](#-rsyslog--rule--remote--stream_driver_permitted_peers) +* [`resend_last_msg_on_reconnect`](#-rsyslog--rule--remote--resend_last_msg_on_reconnect) +* [`udp_send_to_all`](#-rsyslog--rule--remote--udp_send_to_all) +* [`queue_validation_log_level`](#-rsyslog--rule--remote--queue_validation_log_level) +* [`queue_filename`](#-rsyslog--rule--remote--queue_filename) +* [`queue_spool_directory`](#-rsyslog--rule--remote--queue_spool_directory) +* [`queue_size`](#-rsyslog--rule--remote--queue_size) +* [`queue_dequeue_batch_size`](#-rsyslog--rule--remote--queue_dequeue_batch_size) +* [`queue_max_disk_space`](#-rsyslog--rule--remote--queue_max_disk_space) +* [`queue_high_watermark`](#-rsyslog--rule--remote--queue_high_watermark) +* [`queue_low_watermark`](#-rsyslog--rule--remote--queue_low_watermark) +* [`queue_full_delay_mark`](#-rsyslog--rule--remote--queue_full_delay_mark) +* [`queue_light_delay_mark`](#-rsyslog--rule--remote--queue_light_delay_mark) +* [`queue_discard_mark`](#-rsyslog--rule--remote--queue_discard_mark) +* [`queue_discard_severity`](#-rsyslog--rule--remote--queue_discard_severity) +* [`queue_checkpoint_interval`](#-rsyslog--rule--remote--queue_checkpoint_interval) +* [`queue_sync_queue_files`](#-rsyslog--rule--remote--queue_sync_queue_files) +* [`queue_type`](#-rsyslog--rule--remote--queue_type) +* [`queue_worker_threads`](#-rsyslog--rule--remote--queue_worker_threads) +* [`queue_timeout_shutdown`](#-rsyslog--rule--remote--queue_timeout_shutdown) +* [`queue_timeout_action_completion`](#-rsyslog--rule--remote--queue_timeout_action_completion) +* [`queue_timeout_enqueue`](#-rsyslog--rule--remote--queue_timeout_enqueue) +* [`queue_timeout_worker_thread_shutdown`](#-rsyslog--rule--remote--queue_timeout_worker_thread_shutdown) +* [`queue_worker_thread_minimum_messages`](#-rsyslog--rule--remote--queue_worker_thread_minimum_messages) +* [`queue_max_file_size`](#-rsyslog--rule--remote--queue_max_file_size) +* [`queue_save_on_shutdown`](#-rsyslog--rule--remote--queue_save_on_shutdown) +* [`queue_dequeue_slowdown`](#-rsyslog--rule--remote--queue_dequeue_slowdown) +* [`queue_dequeue_time_begin`](#-rsyslog--rule--remote--queue_dequeue_time_begin) +* [`queue_dequeue_time_end`](#-rsyslog--rule--remote--queue_dequeue_time_end) +* [`content`](#-rsyslog--rule--remote--content) + +##### `name` Data type: `String` The filename that you will be dropping into place -##### `rule` +##### `rule` Data type: `Optional[String[1]]` @@ -1318,25 +1318,25 @@ The Rsyslog ``EXPRESSION`` to filter on * Correct: ``rule => "prifilt('*.*')" * Incorrect: ``rule => "if prifilt('*.*') then"`` -Default value: ``undef`` +Default value: `undef` -##### `stop_processing` +##### `stop_processing` Data type: `Boolean` Do not forward logs to any further ``ruleset``s after processing this ``ruleset`` -Default value: ``false`` +Default value: `false` -##### `template` +##### `template` Data type: `Optional[String[1]]` The template that should be used to format the content -Default value: ``undef`` +Default value: `undef` -##### `dest` +##### `dest` Data type: `Simplib::Netlist` @@ -1346,7 +1346,7 @@ If filled, logs matching ``$rule`` will be sent to **all hosts** in this Array. Default value: `[]` -##### `dest_type` +##### `dest_type` Data type: `Enum['tcp','udp','relp']` @@ -1358,7 +1358,7 @@ The destination type for all entries in ``$dest`` Default value: `'tcp'` -##### `failover_log_servers` +##### `failover_log_servers` Data type: `Simplib::Netlist` @@ -1369,7 +1369,7 @@ this ``rule`` Default value: `[]` -##### `tcp_framing` +##### `tcp_framing` Data type: `Enum['traditional','octet-counted']` @@ -1377,7 +1377,7 @@ Data type: `Enum['traditional','octet-counted']` Default value: `'traditional'` -##### `zip_level` +##### `zip_level` Data type: `Integer[0,9]` @@ -1385,7 +1385,7 @@ Data type: `Integer[0,9]` Default value: `0` -##### `max_error_messages` +##### `max_error_messages` Data type: `Integer[0]` @@ -1393,7 +1393,7 @@ Data type: `Integer[0]` Default value: `5` -##### `compression_mode` +##### `compression_mode` Data type: `Enum['none','single','stream:always']` @@ -1401,55 +1401,55 @@ Data type: `Enum['none','single','stream:always']` Default value: `'none'` -##### `compression_stream_flush_on_tx_end` +##### `compression_stream_flush_on_tx_end` Data type: `Boolean` -Default value: ``true`` +Default value: `true` -##### `rebind_interval` +##### `rebind_interval` Data type: `Optional[Integer[0]]` -Default value: ``undef`` +Default value: `undef` -##### `keep_alive` +##### `keep_alive` Data type: `Optional[Boolean]` -Default value: ``undef`` +Default value: `undef` -##### `keep_alive_probes` +##### `keep_alive_probes` Data type: `Optional[Integer[0]]` -Default value: ``undef`` +Default value: `undef` -##### `keep_alive_interval` +##### `keep_alive_interval` Data type: `Optional[Integer[0]]` -Default value: ``undef`` +Default value: `undef` -##### `keep_alive_time` +##### `keep_alive_time` Data type: `Optional[Integer[0]]` -Default value: ``undef`` +Default value: `undef` -##### `action_resume_interval` +##### `action_resume_interval` Data type: `Integer[0]` @@ -1457,15 +1457,15 @@ Data type: `Integer[0]` Default value: `30` -##### `action_resume_retry_count` +##### `action_resume_retry_count` Data type: `Integer[-1]` -Default value: `-` +Default value: `-1` -##### `stream_driver` +##### `stream_driver` Data type: `Optional[String[1]]` @@ -1476,9 +1476,9 @@ Data type: `Optional[String[1]]` * Overridden by 'DefaultNetstreamDriver' global stream configuration specified by ``rsyslog::config::default_net_stream_driver``. -Default value: ``undef`` +Default value: `undef` -##### `stream_driver_mode` +##### `stream_driver_mode` Data type: `Integer[0]` @@ -1488,7 +1488,7 @@ Data type: `Integer[0]` Default value: `1` -##### `stream_driver_auth_mode` +##### `stream_driver_auth_mode` Data type: `String` @@ -1498,7 +1498,7 @@ forwarding actions for remote servers if TLS is enabled and Default value: `'x509/name'` -##### `stream_driver_permitted_peers` +##### `stream_driver_permitted_peers` Data type: `Optional[String[1]]` @@ -1528,25 +1528,25 @@ Data type: `Optional[String[1]]` will use to match against the certificate presented from the remote server. -Default value: ``undef`` +Default value: `undef` -##### `resend_last_msg_on_reconnect` +##### `resend_last_msg_on_reconnect` Data type: `Boolean` -Default value: ``true`` +Default value: `true` -##### `udp_send_to_all` +##### `udp_send_to_all` Data type: `Boolean` -Default value: ``false`` +Default value: `false` -##### `queue_validation_log_level` +##### `queue_validation_log_level` Data type: `Simplib::PuppetLogLevel` @@ -1554,111 +1554,111 @@ Data type: `Simplib::PuppetLogLevel` Default value: `simplib::dlookup('rsyslog::rule::remote', 'queue_validation_log_level', $name, { 'default_value' => 'warning' })` -##### `queue_filename` +##### `queue_filename` Data type: `Optional[String[1]]` -Default value: ``undef`` +Default value: `undef` -##### `queue_spool_directory` +##### `queue_spool_directory` Data type: `Optional[Stdlib::Absolutepath]` -Default value: ``undef`` +Default value: `undef` -##### `queue_size` +##### `queue_size` Data type: `Optional[Integer[0]]` -Default value: ``undef`` +Default value: `undef` -##### `queue_dequeue_batch_size` +##### `queue_dequeue_batch_size` Data type: `Optional[Integer[0]]` -Default value: ``undef`` +Default value: `undef` -##### `queue_max_disk_space` +##### `queue_max_disk_space` Data type: `Optional[Integer[0]]` -Default value: ``undef`` +Default value: `undef` -##### `queue_high_watermark` +##### `queue_high_watermark` Data type: `Optional[Integer[0]]` -Default value: ``undef`` +Default value: `undef` -##### `queue_low_watermark` +##### `queue_low_watermark` Data type: `Optional[Integer[0]]` -Default value: ``undef`` +Default value: `undef` -##### `queue_full_delay_mark` +##### `queue_full_delay_mark` Data type: `Optional[Integer[0]]` -Default value: ``undef`` +Default value: `undef` -##### `queue_light_delay_mark` +##### `queue_light_delay_mark` Data type: `Optional[Integer[0]]` -Default value: ``undef`` +Default value: `undef` -##### `queue_discard_mark` +##### `queue_discard_mark` Data type: `Optional[Integer[0]]` -Default value: ``undef`` +Default value: `undef` -##### `queue_discard_severity` +##### `queue_discard_severity` Data type: `Optional[Integer[0]]` -Default value: ``undef`` +Default value: `undef` -##### `queue_checkpoint_interval` +##### `queue_checkpoint_interval` Data type: `Optional[Integer[0]]` -Default value: ``undef`` +Default value: `undef` -##### `queue_sync_queue_files` +##### `queue_sync_queue_files` Data type: `Boolean` -Default value: ``false`` +Default value: `false` -##### `queue_type` +##### `queue_type` Data type: `Rsyslog::QueueType` @@ -1666,95 +1666,95 @@ Data type: `Rsyslog::QueueType` Default value: `'LinkedList'` -##### `queue_worker_threads` +##### `queue_worker_threads` Data type: `Optional[Integer[0]]` -Default value: ``undef`` +Default value: `undef` -##### `queue_timeout_shutdown` +##### `queue_timeout_shutdown` Data type: `Optional[Integer[0]]` -Default value: ``undef`` +Default value: `undef` -##### `queue_timeout_action_completion` +##### `queue_timeout_action_completion` Data type: `Optional[Integer[0]]` -Default value: ``undef`` +Default value: `undef` -##### `queue_timeout_enqueue` +##### `queue_timeout_enqueue` Data type: `Optional[Integer[0]]` -Default value: ``undef`` +Default value: `undef` -##### `queue_timeout_worker_thread_shutdown` +##### `queue_timeout_worker_thread_shutdown` Data type: `Optional[Integer[0]]` -Default value: ``undef`` +Default value: `undef` -##### `queue_worker_thread_minimum_messages` +##### `queue_worker_thread_minimum_messages` Data type: `Optional[Integer[0]]` -Default value: ``undef`` +Default value: `undef` -##### `queue_max_file_size` +##### `queue_max_file_size` Data type: `Optional[String[1]]` -Default value: ``undef`` +Default value: `undef` -##### `queue_save_on_shutdown` +##### `queue_save_on_shutdown` Data type: `Boolean` -Default value: ``true`` +Default value: `true` -##### `queue_dequeue_slowdown` +##### `queue_dequeue_slowdown` Data type: `Optional[Integer[0]]` -Default value: ``undef`` +Default value: `undef` -##### `queue_dequeue_time_begin` +##### `queue_dequeue_time_begin` Data type: `Optional[Integer[0]]` -Default value: ``undef`` +Default value: `undef` -##### `queue_dequeue_time_end` +##### `queue_dequeue_time_end` Data type: `Optional[Integer[0]]` -Default value: ``undef`` +Default value: `undef` -##### `content` +##### `content` Data type: `Optional[String[1]]` @@ -1764,9 +1764,9 @@ the **entire* content of the rsyslog::rule * If you do specify this, ``$rule`` will be ignored -Default value: ``undef`` +Default value: `undef` -### `rsyslog::template::list` +### `rsyslog::template::list` RSyslog list templates can contain properties and constants. In order to capture this functionality, we have opted for making a hash of these. The @@ -1798,22 +1798,22 @@ template(name="example_list" type="list") { The following parameters are available in the `rsyslog::template::list` defined type: -* [`name`](#name) -* [`content`](#content) +* [`name`](#-rsyslog--template--list--name) +* [`content`](#-rsyslog--template--list--content) -##### `name` +##### `name` Data type: `String` The literal name (not path) of the ``file`` that will be written -##### `content` +##### `content` Data type: `Hash[String,String,1]` The rsyslog list content that you wish to add to the system, as a Hash -### `rsyslog::template::plugin` +### `rsyslog::template::plugin` **NOTE:** Plugins are **as-is**. This means that you will only supply the plugin name and assume that the plugin has already been loaded by RSyslog. @@ -1836,16 +1836,16 @@ template(name="example_plugin" type="plugin" plugin="my_plugin") The following parameters are available in the `rsyslog::template::plugin` defined type: -* [`name`](#name) -* [`plugin`](#plugin) +* [`name`](#-rsyslog--template--plugin--name) +* [`plugin`](#-rsyslog--template--plugin--plugin) -##### `name` +##### `name` Data type: `String` The literal name of the ``file`` (not the full path) that will be used -##### `plugin` +##### `plugin` Data type: `String` @@ -1853,7 +1853,7 @@ The rsyslog plugin content that you wish to add to the system * This is provided, without formatting, directly into the target file -### `rsyslog::template::string` +### `rsyslog::template::string` You'll need to write the entire template line due to the complexity of the rsyslog configuration parameters. @@ -1878,16 +1878,16 @@ template(name="example" type="string" string="/var/log/hosts/%HOSTNAME%/example. The following parameters are available in the `rsyslog::template::string` defined type: -* [`name`](#name) -* [`string`](#string) +* [`name`](#-rsyslog--template--string--name) +* [`string`](#-rsyslog--template--string--string) -##### `name` +##### `name` Data type: `String` The literal name of the ``file`` (not file path) that will be used -##### `string` +##### `string` Data type: `String` @@ -1895,7 +1895,7 @@ The rsyslog template string that you wish to add to the system * This is fed, without formatting, directly into the target file -### `rsyslog::template::subtree` +### `rsyslog::template::subtree` You'll need to write the entire subtree line due to the complexity of the rsyslog configuration parameters. @@ -1921,17 +1921,17 @@ template(name="example" type="subtree" subtree="$!usr!tp12") The following parameters are available in the `rsyslog::template::subtree` defined type: -* [`name`](#name) -* [`subtree`](#subtree) -* [`variables`](#variables) +* [`name`](#-rsyslog--template--subtree--name) +* [`subtree`](#-rsyslog--template--subtree--subtree) +* [`variables`](#-rsyslog--template--subtree--variables) -##### `name` +##### `name` Data type: `String` The literal name of the ``file`` (not a path) that will be used -##### `subtree` +##### `subtree` Data type: `String` @@ -1939,7 +1939,7 @@ The rsyslog subtree content that you wish to add to the system * This is fed, without formatting, directly into the subtree parameter -##### `variables` +##### `variables` Data type: `Array[String]` @@ -1949,34 +1949,22 @@ Default value: `[]` ## Data types -### `Rsyslog::Boolean` +### `Rsyslog::Boolean` Representation of boolean values that are translated to 'on' and 'off' in Rsyslog configuration -Alias of +Alias of `Variant[Enum['on','off'], Boolean]` -```puppet -Variant[Enum['on','off'], Boolean] -``` - -### `Rsyslog::Options` +### `Rsyslog::Options` Hash of options to be used for Rsyslog global, legacy global or module configuration -Alias of +Alias of `Hash[String, Variant[Numeric,String]]` -```puppet -Hash[String, Variant[Numeric,String]] -``` - -### `Rsyslog::QueueType` +### `Rsyslog::QueueType` Rsyslog Queue Types -Alias of - -```puppet -Enum['FixedArray', 'LinkedList', 'Direct', 'Disk'] -``` +Alias of `Enum['FixedArray', 'LinkedList', 'Direct', 'Disk']`