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
— 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 > »
< span class = 'title' > < span class = 'object_link' > Puppet Classes< / span > < / span >
»
< 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 > [' clamav' ,' clamd' ,' s-nail' ]< / tt > )< / em >
—
< 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 > ' present' < / tt > )< / em >
—
< 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 > ' /var/log/clamd.scan' < / tt > )< / em >
—
< 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 > ' no' < / tt > )< / em >
—
< 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 > ' 2M' < / tt > )< / em >
—
< 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 > ' yes' < / tt > )< / em >
—
< 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 > ' no' < / tt > )< / em >
—
< 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 > ' yes' < / tt > )< / em >
—
< 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 > ' LOG_MAIL' < / tt > )< / em >
—
< div class = 'inline' >
< p > type of syslog messages - please refer to ‘ ’ < / p >
< / div >
< / li >
< li >
< span class = 'name' > cv_logverbose< / span >
< span class = 'type' > (< tt > String< / tt > )< / span >
< em class = "default" > (defaults to: < tt > ' no' < / tt > )< / em >
—
< 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 > ' yes' < / tt > )< / em >
—
< 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 > ' no' < / tt > )< / em >
—
< 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 > ' ClamAV' < / tt > )< / em >
—
< 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 > ' 3310' < / tt > )< / em >
—
< 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 > ' localhost' < / tt > )< / em >
—
< 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 > ' you@example.com' < / tt > )< / em >
—
< 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 > ' 2' < / tt > )< / em >
—
< 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 > ' 0' < / tt > )< / em >
—
< 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 > ' root' < / tt > )< / em >
—
< 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 > ' /' < / tt > )< / em >
—
< 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 > ' tmp/clamav-alert.txt' < / tt > )< / em >
—
< 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 >
—
< 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 >
—
< 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 >
—
< div class = 'inline' >
< p > whether to use advanced exclude paths< / p >
2026-09-22 11:56:38 +02:00
< / div >
< / li >
2026-09-22 13:17:45 +02:00
< li >
< span class = 'name' > cv_concurrentdatabasereload< / span >
< span class = 'type' > (< tt > String< / tt > )< / span >
< em class = "default" > (defaults to: < tt > ' no' < / tt > )< / em >
2026-09-22 13:39:15 +02:00
—
< div class = 'inline' >
< p > whether to enable concurrent database reloads. This is useful when you have multiple clamd instances running on the same machine. If you have only one clamd instance, this should be set to ‘ ’ < / p >
< / div >
2026-09-22 13:17:45 +02:00
< / li >
2026-09-22 11:56:38 +02:00
< / ul >
< / div > < div class = "method_details_list" >
< table class = "source_code" >
< tr >
< td >
< pre class = "lines" >
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
2026-09-22 13:17:45 +02:00
91
2026-09-22 13:39:15 +02:00
92
93
94
95
96
97
98< / pre >
2026-09-22 11:56:38 +02:00
< / td >
< td >
2026-09-22 13:39:15 +02:00
< pre class = "code" > < span class = "info file" > # File 'manifests/params.pp', line 44< / span >
2026-09-22 11:56:38 +02:00
class confdroid_clamav::params (
# installation
2026-09-22 13:17:45 +02:00
Array $cv_reqpackages = [' clamav' ,' clamd' ,' s-nail' ],
String $cv_pkg_ensure = ' present' ,
2026-09-22 11:56:38 +02:00
# clamd
2026-09-22 13:17:45 +02:00
String $cv_logfile = ' /var/log/clamd.scan' ,
String $cv_logfileunlock = ' no' ,
String $cv_logfilemaxsize = ' 2M' ,
String $cv_logtime = ' yes' ,
String $cv_logclean = ' no' ,
String $cv_logsyslog = ' yes' ,
String $cv_logfacility = ' LOG_MAIL' ,
String $cv_logverbose = ' no' ,
String $cv_logrotate = ' yes' ,
String $cv_preludeenable = ' no' ,
String $cv_preludeanalyzername = ' ClamAV' ,
String $cv_tcpsocket = ' 3310' ,
String $cv_tcpaddress = ' localhost' ,
String $cv_alert_email = ' you@example.com' ,
String $cv_cron_hour = ' 2' ,
String $cv_cron_minute = ' 0' ,
String $cv_cron_user = ' root' ,
String $cv_scan_dir = ' /' ,
String $cv_alert_file = ' tmp/clamav-alert.txt' ,
Boolean $cv_enable_freshclam = true,
Boolean $cv_enable_clamd = true,
Boolean $cv_use_excludepaths = true,
String $cv_concurrentdatabasereload = ' no' ,
2026-09-22 11:56:38 +02:00
) {
# service
$cv_service = ' clamd@scan'
$cv_freshclam = ' freshclam'
# dirs
$cv_config_d_dir = ' /etc/clamd.d'
# files
$cv_clamd_config_file = " ${cv_config_d_dir}/scan.conf"
$cv_clamd_config_erb = ' confdroid_clamav/scan_conf.erb'
$cv_freshclam_file = ' /etc/freshclam.conf'
$cv_freshclam_erb = ' confdroid_clamav/freshclam_conf.erb'
$cv_freshclam_svc = ' /usr/lib/systemd/system/freshclam.service'
$cv_freshclam_svc_erb = ' confdroid_clamav/freshclam_svc.erb'
2026-09-22 13:39:15 +02:00
$cv_clamd_svc = ' /usr/lib/systemd/system/clamd@.service'
$cv_clamd_svc_erb = ' confdroid_clamav/clamd_svc.erb'
2026-09-22 11:56:38 +02:00
$cv_shell_script = " ${cv_config_d_dir}/scan.sh"
$cv_shell_script_erb = ' confdroid_clamav/scan.sh.erb'
# 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 >
