confdroid/confdroid_clamav
1
0
Fork 0
Code Issues Wiki Activity
Files
b7faf48f365d4dae976f248259b27367d2d1d3ea
confdroid_clamav/doc/puppet_classes/clamav_cd_3A_3Aparams.html
Jenkins Server e708a0161d Recommit for updates in build 7
2025-06-08 13:41:02 +02:00

449 lines
9.8 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: clamav_cd::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::clamav_cd::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">clamav_cd::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: clamav_cd::params</h1>
<div class="box_info">
<dl>
<dt>Inherited by:</dt>
<dd>
<span class='object_link'><a href="clamav_cd_3A_3Amain_3A_3Adirs.html" title="puppet_classes::clamav_cd::main::dirs (puppet_class)">clamav_cd::main::dirs</a></span><br/>
<span class='object_link'><a href="clamav_cd_3A_3Amain_3A_3Afiles.html" title="puppet_classes::clamav_cd::main::files (puppet_class)">clamav_cd::main::files</a></span><br/>
<span class='object_link'><a href="clamav_cd_3A_3Amain_3A_3Aconfig.html" title="puppet_classes::clamav_cd::main::config (puppet_class)">clamav_cd::main::config</a></span><br/>
<span class='object_link'><a href="clamav_cd_3A_3Amain_3A_3Ainstall.html" title="puppet_classes::clamav_cd::main::install (puppet_class)">clamav_cd::main::install</a></span><br/>
<span class='object_link'><a href="clamav_cd_3A_3Amain_3A_3Aservice.html" title="puppet_classes::clamav_cd::main::service (puppet_class)">clamav_cd::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 clamav_cd module and is
inherited by all classes except defines.
<h2>Overview</h2>
<div class="docstring">
<div class="discussion">
<p>clamav_cd::params.pp Module name: clamav_cd Author: Arne Teuke (arne_teuke@confdroid.com)</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>Array</tt>)</span>
<em class="default">(defaults to: <tt>[&#39;clamav&#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 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 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">
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</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'manifests/params.pp', line 29</span>
class clamav_cd::params (
# installation
Array $reqpackages = [&#39;clamav&#39;,&#39;clamd&#39;],
String $pkg_ensure = &#39;present&#39;,
# 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;,
) {
# service
$cv_service = &#39;clamd@.service&#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;clamav_cd/scan_conf.erb&#39;
$cv_freshclam_file = &#39;/etc/freshclam.conf&#39;
$cv_freshclam_erb = &#39;clamav_cd/freshclam_conf.erb&#39;
$cv_freshclam_svc = &#39;/usr/lib/systemd/system/freshclam.service&#39;
$cv_freshclam_svc_erb = &#39;clamav_cd/freshclam_svc.erb&#39;
# includes must be last
include clamav_cd::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