diff options
author | Ryan Coleman <ryan@puppetlabs.com> | 2012-01-25 10:49:22 -0800 |
---|---|---|
committer | Ryan Coleman <ryan@puppetlabs.com> | 2012-01-25 10:49:22 -0800 |
commit | 21b5e5f1df7a87d30781a8cb34fd9769d78211b1 (patch) | |
tree | 6c24da800d2e9938ddcfa8522d49e833d41bb86a /README.md | |
parent | 5da6f68934c3b5ce5e74d252b953265eee62802a (diff) |
Add parameters table to README
Prior to this commit, parameters were explained in the context of example
declarations. This commit adds a table explaining the parameters, the valid
values and default values. This is meant to mirror how it's done in the bacula module
http://forge.puppetlabs.com/puppetlabs/bacula
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 29 |
1 files changed, 28 insertions, 1 deletions
@@ -1,10 +1,14 @@ # puppet-rsyslog +================ Manage rsyslog client and server via Puppet -## How to use +## Usage +======== ### Client +---------- + #### Using default values ``` class { 'rsyslog::client': } @@ -41,6 +45,29 @@ Manage rsyslog client and server via Puppet Both can be installed at the same time. + +### Parameters +============== +The following lists all the class parameters this module accepts. + + RSYSLOG::SERVER CLASS PARAMETER VALUES DESCRIPTION + -------------------------------------------------------------- + enable_tcp true,false Enable TCP listener. Defaults to true. + enable_udp true,false Enable UDP listener. Defaults to true. + server_dir STRING Folder where logs will be stored on the server. Defaults to '/srv/log/' + custom_config STRING Specify your own template to use for server config. Defaults to undef. Example usage: custom_config => 'rsyslog/my_config.erb' + high_precision_timestamps true,false Whether or not to use high precision timestamps. + + RSYSLOG::CLIENT CLASS PARAMETER VALUES DESCRIPTION + -------------------------------------------------------------- + log_remote true,false Log Remotely. Defaults to true. + remote_type 'tcp','udp' Which protocol to use when logging remotely. Defaults to 'tcp'. + log_local true,false Log locally. Defualts to false. + log_auth_local true,false Just log auth facility locally. Defaults to false. + custom_config STRING Specify your own template to use for client config. Defaults to undef. Example usage: custom_config => 'rsyslog/my_config.erb + server STRING Rsyslog server to log to. Will be used in the client configuration file. + + ### Other notes Due to a missing feature in current RELP versions (InputRELPServerBindRuleset option), |