Merge pull request #32 from bastelfreak/log2

Implement logging to kernel log

1 files changed, 11 insertions, 0 deletions

diff --git a/manifests/rule.pp b/manifests/rule.pp
index 7b94210..6f448f9 100644
--- a/manifests/rule.pp
+++ b/manifests/rule.pp
@@ -1,3 +1,14 @@
+# defined resource which creates a single rule in a specific chain
+# @param chain Configure the chain where we want to add the rule
+# @param policy Configure what we want to do with the packet (drop, accept, log...)
+# @param proto Which protocol do we want to match, typically UDP or TCP
+# @param comment A comment that will be added to the ferm config and to ip{,6}tables
+# @param dport The destination port, can be a range as string or a single port number as integer
+# @param sport The source port, can be a range as string or a single port number as integer
+# @param saddr The source address we want to match
+# @param daddr The destination address we want to match
+# @param proto_options Optional parameters that will be passed to the protocol (for example to match specific ICMP types)
+# @param ensure Set the rule to present or absent
 define ferm::rule (
   Ferm::Chains $chain,
   Ferm::Policies $policy,