aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--REFERENCE.md30
-rw-r--r--types/chains.pp1
-rw-r--r--types/policies.pp1
3 files changed, 30 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']`
+
diff --git a/types/chains.pp b/types/chains.pp
index 3ddf0f8..e916359 100644
--- a/types/chains.pp
+++ b/types/chains.pp
@@ -1 +1,2 @@
+# @summary a type that allows the default iptables chains
type Ferm::Chains = Enum['INPUT', 'FORWARD', 'OUTPUT']
diff --git a/types/policies.pp b/types/policies.pp
index ffc8a6e..03be6ce 100644
--- a/types/policies.pp
+++ b/types/policies.pp
@@ -1 +1,2 @@
+# @summary a list of allowed default policies for a chain
type Ferm::Policies = Enum['ACCEPT','DROP', 'REJECT']