diff options
Diffstat (limited to 'docs/puppet_classes/ferm.html')
| -rw-r--r-- | docs/puppet_classes/ferm.html | 297 |
1 files changed, 297 insertions, 0 deletions
diff --git a/docs/puppet_classes/ferm.html b/docs/puppet_classes/ferm.html new file mode 100644 index 0000000..74c4b67 --- /dev/null +++ b/docs/puppet_classes/ferm.html @@ -0,0 +1,297 @@ +<!DOCTYPE html> +<html> + <head> + <meta charset="utf-8"> +<meta name="viewport" content="width=device-width, initial-scale=1.0"> +<title> + Puppet Class: ferm + + — 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> » + <span class='title'><span class='object_link'>Puppet Classes</span></span> + » + <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{'ferm': + manage_service => 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> + + + + — + <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> + + + + — + <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> + + + + — + <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'>forward_policy</span> + + + <span class='type'>(<tt>Ferm::Policies</tt>)</span> + + + + — + <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> + + + + — + <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> + + + + — + <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> + + + + — + <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"> + + +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'manifests/init.pp', line 31</span> + +class ferm ( + Boolean $manage_service, + Boolean $manage_configfile, + Stdlib::Absolutepath $configfile, + Ferm::Policies $forward_policy, + Ferm::Policies $output_policy, + Ferm::Policies $input_policy, + Hash $rules, +) { + contain ferm::install + contain ferm::config + contain ferm::service + + Class['ferm::install'] + -> Class['ferm::config'] + ~> Class['ferm::service'] + + $rules.each |$rulename, $attributes| { + ferm::rule{$rulename: + * => $attributes, + } + } + # import all exported resources with ferm rules for this node + Ferm::Rule <<| tag == $trusted['certname'] |>> +}</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 |