Files
confdroid_clamav/doc/puppet_classes/confdroid_clamav_3A_3Aparams.html

673 lines
14 KiB
HTML
Raw Normal View History

2026-09-22 11:56:38 +02:00
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Puppet Class: confdroid_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::confdroid_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">confdroid_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: confdroid_clamav::params</h1>
<div class="box_info">
<dl>
<dt>Inherited by:</dt>
<dd>
<span class='object_link'><a href="confdroid_clamav_3A_3Amain_3A_3Adirs.html" title="puppet_classes::confdroid_clamav::main::dirs (puppet_class)">confdroid_clamav::main::dirs</a></span><br/>
<span class='object_link'><a href="confdroid_clamav_3A_3Amain_3A_3Afiles.html" title="puppet_classes::confdroid_clamav::main::files (puppet_class)">confdroid_clamav::main::files</a></span><br/>
<span class='object_link'><a href="confdroid_clamav_3A_3Amain_3A_3Aconfig.html" title="puppet_classes::confdroid_clamav::main::config (puppet_class)">confdroid_clamav::main::config</a></span><br/>
<span class='object_link'><a href="confdroid_clamav_3A_3Amain_3A_3Ainstall.html" title="puppet_classes::confdroid_clamav::main::install (puppet_class)">confdroid_clamav::main::install</a></span><br/>
<span class='object_link'><a href="confdroid_clamav_3A_3Amain_3A_3Aservice.html" title="puppet_classes::confdroid_clamav::main::service (puppet_class)">confdroid_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 confdroid_clamav module and is
inherited by all classes except defines.
<h2>Overview</h2>
<div class="docstring">
<div class="discussion">
<p>confdroid_clamav::params.pp Module name: confdroid_clamav Author: 12ww1160 (12ww1160@confdroid.com)</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
2026-09-22 12:46:07 +02:00
<span class='name'>cv_reqpackages</span>
2026-09-22 11:56:38 +02:00
<span class='type'>(<tt>Array</tt>)</span>
<em class="default">(defaults to: <tt>[&#39;clamav&#39;,&#39;clamd&#39;,&#39;s-nail&#39;]</tt>)</em>
&mdash;
<div class='inline'>
<p>List of packages to install.</p>
</div>
</li>
<li>
2026-09-22 12:46:07 +02:00
<span class='name'>cv_pkg_ensure</span>
2026-09-22 11:56:38 +02:00
<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 against running 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>the max 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 syslogfor 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>
<li>
<span class='name'>cv_tcpsocket</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;3310&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>socket port</p>
</div>
</li>
<li>
<span class='name'>cv_tcpaddress</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;localhost&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>ip address to listen on</p>
</div>
</li>
<li>
<span class='name'>cv_alert_email</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;you@example.com&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>email address to send alerts</p>
</div>
</li>
<li>
<span class='name'>cv_cron_hour</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;2&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>which hour the scan should start</p>
</div>
</li>
<li>
<span class='name'>cv_cron_minute</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;0&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>which minute the scan should start</p>
</div>
</li>
<li>
<span class='name'>cv_cron_user</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;root&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>which user should run the cron job</p>
</div>
</li>
<li>
<span class='name'>cv_scan_dir</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;/&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>which directory should be scanned</p>
</div>
</li>
<li>
<span class='name'>cv_alert_file</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;tmp/clamav-alert.txt&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>location and name of the alert file</p>
</div>
</li>
<li>
<span class='name'>cv_enable_freshclam</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>true</tt>)</em>
&mdash;
<div class='inline'>
<p>whether to enable the freshclam service</p>
</div>
</li>
<li>
<span class='name'>cv_enable_clamd</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>true</tt>)</em>
&mdash;
<div class='inline'>
<p>whether to enable the clamd service</p>
2026-09-22 12:46:07 +02:00
</div>
</li>
<li>
<span class='name'>cv_use_excludepaths</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>true</tt>)</em>
&mdash;
<div class='inline'>
<p>whether to use advanced exclude paths</p>
2026-09-22 11:56:38 +02:00
</div>
</li>
</ul>
</div><div class="method_details_list">
<table class="source_code">
<tr>
<td>
<pre class="lines">
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
2026-09-22 12:46:07 +02:00
89
90
91</pre>
2026-09-22 11:56:38 +02:00
</td>
<td>
2026-09-22 12:46:07 +02:00
<pre class="code"><span class="info file"># File 'manifests/params.pp', line 40</span>
2026-09-22 11:56:38 +02:00
class confdroid_clamav::params (
# installation
2026-09-22 12:46:07 +02:00
Array $cv_reqpackages = [&#39;clamav&#39;,&#39;clamd&#39;,&#39;s-nail&#39;],
String $cv_pkg_ensure = &#39;present&#39;,
2026-09-22 11:56:38 +02:00
# clamd
String $cv_logfile = &#39;/var/log/clamd.scan&#39;,
String $cv_logfileunlock = &#39;no&#39;,
String $cv_logfilemaxsize = &#39;2M&#39;,
String $cv_logtime = &#39;yes&#39;,
String $cv_logclean = &#39;no&#39;,
String $cv_logsyslog = &#39;yes&#39;,
String $cv_logfacility = &#39;LOG_MAIL&#39;,
String $cv_logverbose = &#39;no&#39;,
String $cv_logrotate = &#39;yes&#39;,
String $cv_preludeenable = &#39;no&#39;,
String $cv_preludeanalyzername = &#39;ClamAV&#39;,
String $cv_tcpsocket = &#39;3310&#39;,
String $cv_tcpaddress = &#39;localhost&#39;,
String $cv_alert_email = &#39;you@example.com&#39;,
String $cv_cron_hour = &#39;2&#39;,
String $cv_cron_minute = &#39;0&#39;,
String $cv_cron_user = &#39;root&#39;,
String $cv_scan_dir = &#39;/&#39;,
String $cv_alert_file = &#39;tmp/clamav-alert.txt&#39;,
Boolean $cv_enable_freshclam = true,
Boolean $cv_enable_clamd = true,
2026-09-22 12:46:07 +02:00
Boolean $cv_use_excludepaths = true
2026-09-22 11:56:38 +02:00
) {
# service
$cv_service = &#39;clamd@scan&#39;
$cv_freshclam = &#39;freshclam&#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;confdroid_clamav/scan_conf.erb&#39;
$cv_freshclam_file = &#39;/etc/freshclam.conf&#39;
$cv_freshclam_erb = &#39;confdroid_clamav/freshclam_conf.erb&#39;
$cv_freshclam_svc = &#39;/usr/lib/systemd/system/freshclam.service&#39;
$cv_freshclam_svc_erb = &#39;confdroid_clamav/freshclam_svc.erb&#39;
$cv_shell_script = &quot;${cv_config_d_dir}/scan.sh&quot;
$cv_shell_script_erb = &#39;confdroid_clamav/scan.sh.erb&#39;
# includes must be last
include confdroid_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>