confdroid/confdroid_clamav
1
0
Fork 0
Code Issues Wiki Activity
Files
b792fcb679eecf30e500636da7d275fbc6d3b3a4
confdroid_clamav/doc/puppet_classes/cd_clamav_3A_3Aparams.html
Jenkins Server b792fcb679 recommit for updates in build 1
2025-05-06 14:58:04 +02:00

455 lines
10 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Puppet Class: cd_clamav::params
&mdash; Documentation by YARD 0.9.36
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "puppet_classes::cd_clamav::params";
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 (c)</a> &raquo;
<span class='title'><span class='object_link'>Puppet Classes</span></span>
&raquo;
<span class="title">cd_clamav::params</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: cd_clamav::params</h1>
<div class="box_info">
<dl>
<dt>Inherited by:</dt>
<dd>
<span class='object_link'><a href="cd_clamav_3A_3Amain_3A_3Adirs.html" title="puppet_classes::cd_clamav::main::dirs (puppet_class)">cd_clamav::main::dirs</a></span><br/>
<span class='object_link'><a href="cd_clamav_3A_3Amain_3A_3Afiles.html" title="puppet_classes::cd_clamav::main::files (puppet_class)">cd_clamav::main::files</a></span><br/>
<span class='object_link'><a href="cd_clamav_3A_3Amain_3A_3Aconfig.html" title="puppet_classes::cd_clamav::main::config (puppet_class)">cd_clamav::main::config</a></span><br/>
<span class='object_link'><a href="cd_clamav_3A_3Amain_3A_3Ainstall.html" title="puppet_classes::cd_clamav::main::install (puppet_class)">cd_clamav::main::install</a></span><br/>
<span class='object_link'><a href="cd_clamav_3A_3Amain_3A_3Aservice.html" title="puppet_classes::cd_clamav::main::service (puppet_class)">cd_clamav::main::service</a></span><br/>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>
manifests/params.pp
</dd>
</dl>
</div>
<h2>Summary</h2>
Class holds all parameters for the cd_clamav module and is
inherited by all classes except defines.
<h2>Overview</h2>
<div class="docstring">
<div class="discussion">
<p>cd_clamav::params.pp Module name: cd_clamav Author: Arne Teuke (arne_teuke@confdroid.com) License: This file is part of cd_clamav.</p>
<p>cd_clamav is used for providing automatic configuration of Clamav. Copyright © 2019 confdroid (copyright@confdroid.com) This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.</p>
<p>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
<p>You should have received a copy of the GNU General Public License along with this program. If not, see <a href="http://www.gnu.org/licenses">www.gnu.org/licenses</a>/.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>reqpackages</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>[&#39;clamav&#39;,&#39;clamav-update&#39;,&#39;clamd&#39;]</tt>)</em>
&mdash;
<div class='inline'>
<p>List of packages to install.</p>
</div>
</li>
<li>
<span class='name'>pkg_ensure</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;present&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>which <a href="https://confdroid.com/2017/05/puppet-type-package/">package type</a> to choose, i.e. <code>latest</code> or <code>present</code>.</p>
</div>
</li>
<li>
<span class='name'>cv_logfile</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;/var/log/clamd.scan&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>where to log messages for the clamd service.</p>
</div>
</li>
<li>
<span class='name'>cv_logfileunlock</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;no&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>whether log file should be locked for writing -the lock protects againstrunning clamd multiple times</p>
</div>
</li>
<li>
<span class='name'>cv_logfilemaxsize</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;2M&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>themax size for the logfile. This also enables logrotation.</p>
</div>
</li>
<li>
<span class='name'>cv_logtime</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;yes&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Whether to log the time with each message.</p>
</div>
</li>
<li>
<span class='name'>cv_logclean</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;no&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>whether to log clean files. Useful in debugging but drastically increases the log size.</p>
</div>
</li>
<li>
<span class='name'>cv_logsyslog</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;yes&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Use system logger (can work together with LogFile).</p>
</div>
</li>
<li>
<span class='name'>cv_logfacility</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;LOG_MAIL&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>type of syslog messages - please refer to ‘man syslog’for facility names</p>
</div>
</li>
<li>
<span class='name'>cv_logverbose</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;no&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Whether to log verbose.</p>
</div>
</li>
<li>
<span class='name'>cv_logrotate</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;yes&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>whether to enable log rotation. Always enabled when LogFileMaxSize is enabled.</p>
</div>
</li>
<li>
<span class='name'>cv_preludeenable</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;no&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>whether to enable prelude output.</p>
</div>
</li>
<li>
<span class='name'>cv_preludeanalyzername</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;ClamAV&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>name of the analyzer used by prelude-admin.</p>
</div>
</li>
</ul>
</div><div class="method_details_list">
<table class="source_code">
<tr>
<td>
<pre class="lines">
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</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'manifests/params.pp', line 46</span>
class cd_clamav::params (
# installation
$reqpackages = [&#39;clamav&#39;,&#39;clamav-update&#39;,&#39;clamd&#39;],
$pkg_ensure = &#39;present&#39;,
# clamd
$cv_logfile = &#39;/var/log/clamd.scan&#39;,
$cv_logfileunlock = &#39;no&#39;,
$cv_logfilemaxsize = &#39;2M&#39;,
$cv_logtime = &#39;yes&#39;,
$cv_logclean = &#39;no&#39;,
$cv_logsyslog = &#39;yes&#39;,
$cv_logfacility = &#39;LOG_MAIL&#39;,
$cv_logverbose = &#39;no&#39;,
$cv_logrotate = &#39;yes&#39;,
$cv_preludeenable = &#39;no&#39;,
$cv_preludeanalyzername = &#39;ClamAV&#39;,
) {
# service
$cv_service = &#39;clamd@.service&#39;
# dirs
$cv_config_d_dir = &#39;/etc/clamd.d&#39;
# files
$cv_clamd_config_file = &quot;${cv_config_d_dir}/scan.conf&quot;
$cv_clamd_config_erb = &#39;cd_clamav/scan_conf.erb&#39;
$cv_freshclam_file = &#39;/etc/freshclam.conf&#39;
$cv_freshclam_erb = &#39;cd_clamav/freshclam_conf.erb&#39;
# includes must be last
include cd_clamav::main::config
}</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>
Reference in New Issue View Git Blame Copy Permalink