aboutsummaryrefslogtreecommitdiff
path: root/docs/puppet_classes/ferm.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/puppet_classes/ferm.html')
-rw-r--r--docs/puppet_classes/ferm.html316
1 files changed, 0 insertions, 316 deletions
diff --git a/docs/puppet_classes/ferm.html b/docs/puppet_classes/ferm.html
deleted file mode 100644
index cbabd5c..0000000
--- a/docs/puppet_classes/ferm.html
+++ /dev/null
@@ -1,316 +0,0 @@
-<!DOCTYPE html>
-<html>
- <head>
- <meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1.0">
-<title>
- Puppet Class: ferm
-
- &mdash; Documentation by YARD 0.9.12
-
-</title>
-
- <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
-
- <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
-
-<script type="text/javascript" charset="utf-8">
- pathId = "puppet_classes::ferm";
- relpath = '../';
-</script>
-
-
- <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
-
- <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
-
-
- </head>
- <body>
- <div class="nav_wrap">
- <iframe id="nav" src="../puppet_class_list.html?1"></iframe>
- <div id="resizer"></div>
- </div>
-
- <div id="main" tabindex="-1">
- <div id="header">
- <div id="menu">
-
- <a href="../_index.html">Index (f)</a> &raquo;
- <span class='title'><span class='object_link'>Puppet Classes</span></span>
- &raquo;
- <span class="title">ferm</span>
-
-</div>
-
- <div id="search">
-
- <a class="full_list_link" id="puppet_class_list_link"
- href="../puppet_class_list.html">
-
- <svg width="24" height="24">
- <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
- <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
- <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
- </svg>
- </a>
-
-</div>
- <div class="clear"></div>
- </div>
-
- <div id="content"><h1>Puppet Class: ferm</h1>
-<div class="box_info">
-
-
- <dl>
- <dt>Defined in:</dt>
- <dd>
- manifests/init.pp
- </dd>
- </dl>
-</div>
-
-<h2>Overview</h2>
-<div class="docstring">
- <div class="discussion">
- <p>Class: ferm</p>
-
-<p>This class manages ferm installation and rule generation on modern linux systems</p>
-
-<p>class{&#39;ferm&#39;:
- manage_service =&gt; true,
-}</p>
-
- </div>
-</div>
-<div class="tags">
-
- <div class="examples">
- <p class="tag_title">Examples:</p>
-
-
- <p class="example_title"><div class='inline'><p>deploy ferm and start it</p>
-</div></p>
-
- <pre class="example code"><code></code></pre>
-
- </div>
-<p class="tag_title">Parameters:</p>
-<ul class="param">
-
- <li>
-
- <span class='name'>manage_service</span>
-
-
- <span class='type'>(<tt>Boolean</tt>)</span>
-
-
-
- &mdash;
- <div class='inline'><p>disable/enable the management of the ferm daemon
-Default value: false
-Allowed values: (true|false)</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>manage_configfile</span>
-
-
- <span class='type'>(<tt>Boolean</tt>)</span>
-
-
-
- &mdash;
- <div class='inline'><p>disable/enable the management of the ferm default config
-Default value: false
-Allowed values: (true|false)</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>configfile</span>
-
-
- <span class='type'>(<tt>Stdlib::Absolutepath</tt>)</span>
-
-
-
- &mdash;
- <div class='inline'><p>path to the config file
-Default value: /etc/ferm.conf
-Allowed values: Stdlib::Absolutepath</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>disable_conntrack</span>
-
-
- <span class='type'>(<tt>Boolean</tt>)</span>
-
-
-
- &mdash;
- <div class='inline'><p>disable/enable the generation of conntrack rules
-Default value: false
-Allowed values: (true|false)</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>forward_policy</span>
-
-
- <span class='type'>(<tt>Ferm::Policies</tt>)</span>
-
-
-
- &mdash;
- <div class='inline'><p>default policy for the FORWARD chain
-Default value: DROP
-Allowed values: (ACCEPT|DROP|REJECT)</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>output_policy</span>
-
-
- <span class='type'>(<tt>Ferm::Policies</tt>)</span>
-
-
-
- &mdash;
- <div class='inline'><p>default policy for the OUTPUT chain
-Default value: ACCEPT
-Allowed values: (ACCEPT|DROP|REJECT)</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>input_policy</span>
-
-
- <span class='type'>(<tt>Ferm::Policies</tt>)</span>
-
-
-
- &mdash;
- <div class='inline'><p>default policy for the INPUT chain
-Default value: DROP
-Allowed values: (ACCEPT|DROP|REJECT)</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>rules</span>
-
-
- <span class='type'>(<tt>Hash</tt>)</span>
-
-
-
- &mdash;
- <div class='inline'><p>a hash that holds all data for ferm::rule
-Default value: Empty Hash
-Allowed value: Any Hash</p>
-</div>
-
- </li>
-
-</ul>
-
-
-</div><div class="method_details_list">
- <table class="source_code">
- <tr>
- <td>
- <pre class="lines">
-
-
-34
-35
-36
-37
-38
-39
-40
-41
-42
-43
-44
-45
-46
-47
-48
-49
-50
-51
-52
-53
-54
-55
-56
-57
-58
-59</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'manifests/init.pp', line 34</span>
-
-class ferm (
- Boolean $manage_service,
- Boolean $manage_configfile,
- Stdlib::Absolutepath $configfile,
- Boolean $disable_conntrack,
- Ferm::Policies $forward_policy,
- Ferm::Policies $output_policy,
- Ferm::Policies $input_policy,
- Hash $rules,
-) {
- contain ferm::install
- contain ferm::config
- contain ferm::service
-
- Class[&#39;ferm::install&#39;]
- -&gt; Class[&#39;ferm::config&#39;]
- ~&gt; Class[&#39;ferm::service&#39;]
-
- $rules.each |$rulename, $attributes| {
- ferm::rule{$rulename:
- * =&gt; $attributes,
- }
- }
- # import all exported resources with ferm rules for this node
- Ferm::Rule &lt;&lt;| tag == $trusted[&#39;certname&#39;] |&gt;&gt;
-}</pre>
- </td>
- </tr>
- </table>
-</div>
-</div>
-
- <div id="footer">
- Generated by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>.
-</div>
-
- </div>
- </body>
-</html> \ No newline at end of file