aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Meusel <tim@bastelfreak.de>2018-12-19 10:38:09 +0100
committerTim Meusel <tim@bastelfreak.de>2018-12-19 13:13:52 +0100
commit37a1f54510341219818eafb6411488ebcab63e9b (patch)
treefd1e4c800144853e3cbe3599783b630b9d0f97b7
parent750675333fdbe6c40b63c75b53e360151780fa24 (diff)
downloadpuppet-ferm-37a1f54510341219818eafb6411488ebcab63e9b.tar.gz
puppet-ferm-37a1f54510341219818eafb6411488ebcab63e9b.tar.bz2
Add puppet-strings docs for ferm::rule
-rw-r--r--manifests/rule.pp11
1 files changed, 11 insertions, 0 deletions
diff --git a/manifests/rule.pp b/manifests/rule.pp
index 7b94210..c9c363f 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 [Ferm::Chains] configure the chain where we want to add the rule
+# @param policy [Ferm::Policies] configure what we want to do with the packet (drop, accept, log...)
+# @param proto [Ferm::Protocols] 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,