aboutsummaryrefslogtreecommitdiff
path: root/REFERENCE.md
diff options
context:
space:
mode:
authorTim Meusel <tim@bastelfreak.de>2019-08-31 19:20:44 +0200
committerTim Meusel <tim@bastelfreak.de>2019-08-31 19:20:44 +0200
commitd932153d5d19a0f20f0eec695f6964cfe509b291 (patch)
tree39090eadb491883ba866edd841a9e61d2d8b0900 /REFERENCE.md
parent803b802b3fd9c8bb2dbe7ad3cc675ad080946bb1 (diff)
downloadpuppet-ferm-d932153d5d19a0f20f0eec695f6964cfe509b291.tar.gz
puppet-ferm-d932153d5d19a0f20f0eec695f6964cfe509b291.tar.bz2
enhance puppet-strings documentation
Diffstat (limited to 'REFERENCE.md')
-rw-r--r--REFERENCE.md30
1 files changed, 28 insertions, 2 deletions
diff --git a/REFERENCE.md b/REFERENCE.md
index bd608cb..daf137d 100644
--- a/REFERENCE.md
+++ b/REFERENCE.md
@@ -20,6 +20,12 @@ _Private Classes_
* [`ferm::chain`](#fermchain): defined resource which creates all rules for one chain
* [`ferm::rule`](#fermrule): defined resource which creates a single rule in a specific chain
+**Data types**
+
+* [`Ferm::Chains`](#fermchains): a type that allows the default iptables chains
+* [`Ferm::Policies`](#fermpolicies): a list of allowed default policies for a chain
+* [`Ferm::Protocols`](#fermprotocols): a list of allowed protocolls to match
+
## Classes
### ferm
@@ -236,7 +242,7 @@ Default value: `undef`
##### `saddr`
-Data type: `Optional[String[1]]`
+Data type: `Optional[Variant[Array, String[1]]]`
The source address we want to match
@@ -244,7 +250,7 @@ Default value: `undef`
##### `daddr`
-Data type: `Optional[String[1]]`
+Data type: `Optional[Variant[Array, String[1]]]`
The destination address we want to match
@@ -274,3 +280,23 @@ Set the rule to present or absent
Default value: 'present'
+## Data types
+
+### Ferm::Chains
+
+a type that allows the default iptables chains
+
+Alias of `Enum['INPUT', 'FORWARD', 'OUTPUT']`
+
+### Ferm::Policies
+
+a list of allowed default policies for a chain
+
+Alias of `Enum['ACCEPT', 'DROP', 'REJECT']`
+
+### Ferm::Protocols
+
+a list of allowed protocolls to match
+
+Alias of `Enum['icmp', 'tcp', 'udp', 'udplite', 'icmpv6', 'esp', 'ah', 'sctp', 'mh', 'all']`
+