aboutsummaryrefslogtreecommitdiff
path: root/docs/puppet_defined_types/ferm_3A_3Achain.html
blob: a3576c1b3e8064960bdcbdbb66e783d9a5deec55 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
  Defined Type: ferm::chain
  
    &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_defined_types::ferm::chain";
  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_defined_type_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'>Defined Types</span></span>
     &raquo; 
    <span class="title">ferm::chain</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>Defined Type: ferm::chain</h1>
<div class="box_info">
  <dl>
    <dt>Defined in:</dt>
    <dd>
      manifests/chain.pp
    </dd>
  </dl>
</div>

<h2>Overview</h2>
<div class="docstring">
  <div class="discussion">
    <p>defined resource which creates all rules for one chain</p>

  </div>
</div>
<div class="tags">
  <p class="tag_title">Parameters:</p>
<ul class="param">
  
    <li>
      
        <span class='name'>policy</span>
      
      
        <span class='type'>(<tt>Ferm::Policies</tt>)</span>
      
      
      
        &mdash;
        <div class='inline'><p>Set the default policy for a CHAIN</p>
</div>
      
    </li>
  
    <li>
      
        <span class='name'>chain</span>
      
      
        <span class='type'>(<tt>Ferm::Chains</tt>)</span>
      
      
        <em class="default">(defaults to: <tt>$name</tt>)</em>
      
      
        &mdash;
        <div class='inline'><p>name of the chain that should be managed</p>
</div>
      
    </li>
  
</ul>


</div><div class="method_details_list">
  <table class="source_code">
    <tr>
      <td>
        <pre class="lines">


4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20</pre>
      </td>
      <td>
        <pre class="code"><span class="info file"># File 'manifests/chain.pp', line 4</span>

define ferm::chain (
  Ferm::Policies $policy,
  Ferm::Chains $chain = $name,
) {

  # concat resource for the chain
  $filename = downcase($chain)
  concat{&quot;/etc/ferm.d/chains/${chain}.conf&quot;:
    ensure  =&gt; &#39;present&#39;,
  }

  concat::fragment{&quot;${chain}-policy&quot;:
    target  =&gt; &quot;/etc/ferm.d/chains/${chain}.conf&quot;,
    content =&gt; epp(&quot;${module_name}/ferm_chain_header.conf.epp&quot;, {&#39;policy&#39; =&gt; $policy }),
    order   =&gt; &#39;01&#39;,
  }
}</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>