3 # This is defaults/periodic.conf - a file full of useful variables that
4 # you can set to change the default behaviour of periodic jobs on your
5 # system. You should not edit this file! Put any overrides into one of the
6 # $periodic_conf_files instead and you will be able to update these defaults
7 # later without spamming your local configuration information.
9 # The $periodic_conf_files files should only contain values which override
10 # values set in this file. This eases the upgrade path when defaults
11 # are changed and new features are added.
13 # For a more detailed explanation of all the periodic.conf variables, please
14 # refer to the periodic.conf(5) manual page.
19 # What files override these defaults ?
20 periodic_conf_files="/etc/periodic.conf /etc/periodic.conf.local"
22 # periodic script dirs
23 local_periodic="/usr/local/etc/periodic"
25 # Max time to sleep to avoid causing congestion on download servers
26 anticongestion_sleeptime=3600
30 # These options are used by periodic(8) itself to determine what to do
31 # with the output of the sub-programs that are run, and where to send
32 # that output. $daily_output might be set to /var/log/daily.log if you
33 # wish to log the daily output and have the files rotated by newsyslog(8)
35 daily_output="root" # user or /file
36 daily_show_success="YES" # scripts returning 0
37 daily_show_info="YES" # scripts returning 1
38 daily_show_badconfig="NO" # scripts returning 2
41 daily_clean_disks_enable="NO" # Delete files daily
42 daily_clean_disks_files="[#,]* .#* a.out *.core *.CKP .emacs_[0-9]*"
43 daily_clean_disks_days=3 # If older than this
44 daily_clean_disks_verbose="YES" # Mention files deleted
47 daily_clean_tmps_enable="NO" # Delete stuff daily
48 daily_clean_tmps_dirs="/tmp" # Delete under here
49 daily_clean_tmps_days="3" # If not accessed for
50 daily_clean_tmps_ignore=".X*-lock .X11-unix .ICE-unix .font-unix .XIM-unix"
51 daily_clean_tmps_ignore="$daily_clean_tmps_ignore quota.user quota.group .snap"
52 daily_clean_tmps_ignore="$daily_clean_tmps_ignore .sujournal"
54 daily_clean_tmps_verbose="YES" # Mention files deleted
57 daily_clean_preserve_enable="YES" # Delete files daily
58 daily_clean_preserve_days=7 # If not modified for
59 daily_clean_preserve_verbose="YES" # Mention files deleted
62 daily_clean_msgs_enable="YES" # Delete msgs daily
63 daily_clean_msgs_days= # If not modified for
66 daily_clean_rwho_enable="YES" # Delete rwho daily
67 daily_clean_rwho_days=7 # If not modified for
68 daily_clean_rwho_verbose="YES" # Mention files deleted
71 daily_clean_hoststat_enable="YES" # Purge sendmail host
75 daily_backup_passwd_enable="YES" # Backup passwd & group
78 daily_backup_aliases_enable="YES" # Backup mail aliases
81 daily_backup_gpart_enable="YES" # Backup partition table/boot partition/MBR
82 daily_backup_gpart_verbose="NO" # Be verbose if new backup differs from the old one
83 daily_backup_efi_enable="NO" # Backup EFI system partition (ESP)
86 daily_backup_gmirror_enable="NO" # Backup of gmirror info (i.e., output of `gmirror list`)
87 daily_backup_gmirror_verbose="NO" # Log diff if new backup differs from the old one
90 daily_backup_zfs_enable="NO" # Backup output from zpool/zfs list
91 daily_backup_zfs_props_enable="NO" # Backup zpool/zfs filesystem properties
92 daily_backup_zfs_get_flags="all" # flags passed to `zfs get`
93 daily_backup_zfs_list_flags="" # flags passed to `zfs list`
94 daily_backup_zpool_get_flags="all" # flags passed to `zpool get`
95 daily_backup_zpool_list_flags="-v" # flags passed to `zpool list`
96 daily_backup_zfs_verbose="NO" # Report diff between the old and new backups.
99 daily_calendar_enable="NO" # Run calendar -a
102 daily_accounting_enable="YES" # Rotate acct files
103 daily_accounting_compress="NO" # Gzip rotated files
104 daily_accounting_flags=-q # Flags to /usr/sbin/sa
105 daily_accounting_save=3 # How many files to save
108 daily_news_expire_enable="YES" # Run news.expire
111 daily_status_disks_enable="YES" # Check disk status
112 daily_status_disks_df_flags="-l -h" # df(1) flags for check
115 daily_status_graid_enable="NO" # Check graid(8)
118 daily_status_zfs_enable="NO" # Check ZFS
119 daily_status_zfs_zpool_list_enable="YES" # List ZFS pools
122 daily_status_gmirror_enable="NO" # Check gmirror(8)
125 daily_status_graid3_enable="NO" # Check graid3(8)
128 daily_status_gstripe_enable="NO" # Check gstripe(8)
131 daily_status_gconcat_enable="NO" # Check gconcat(8)
134 daily_status_mfi_enable="NO" # Check mfiutil(8)
137 daily_status_network_enable="YES" # Check network status
138 daily_status_network_usedns="YES" # DNS lookups are ok
139 daily_status_network_netstat_flags="-d -W" # netstat(1) flags
142 daily_status_uptime_enable="YES" # Check system uptime
145 daily_status_mailq_enable="YES" # Check mail status
146 daily_status_mailq_shorten="NO" # Shorten output
147 daily_status_include_submit_mailq="YES" # Also submit queue
149 # 450.status-security
150 daily_status_security_enable="YES" # Security check
151 # See also "Security options" below for more options
152 daily_status_security_inline="NO" # Run inline ?
153 daily_status_security_output="root" # user or /file
155 # 460.status-mail-rejects
156 daily_status_mail_rejects_enable="YES" # Check mail rejects
157 daily_status_mail_rejects_logs=3 # How many logs to check
158 daily_status_mail_rejects_shorten="NO" # Shorten output
161 daily_ntpd_leapfile_enable="YES" # Fetch NTP leapfile
164 daily_status_ntpd_enable="NO" # Check NTP status
167 daily_queuerun_enable="YES" # Run mail queue
168 daily_submit_queuerun="YES" # Also submit queue
170 # 510.status-world-kernel
171 daily_status_world_kernel="YES" # Check the running
172 # userland/kernel version
175 daily_scrub_zfs_enable="NO"
176 daily_scrub_zfs_pools="" # empty string selects all pools
177 daily_scrub_zfs_default_threshold="35" # days between scrubs
178 #daily_scrub_zfs_${poolname}_threshold="35" # pool specific threshold
181 daily_local="/etc/daily.local" # Local scripts
186 # These options are used by periodic(8) itself to determine what to do
187 # with the output of the sub-programs that are run, and where to send
188 # that output. $weekly_output might be set to /var/log/weekly.log if you
189 # wish to log the weekly output and have the files rotated by newsyslog(8)
191 weekly_output="root" # user or /file
192 weekly_show_success="YES" # scripts returning 0
193 weekly_show_info="YES" # scripts returning 1
194 weekly_show_badconfig="NO" # scripts returning 2
197 weekly_locate_enable="YES" # Update locate weekly
200 weekly_whatis_enable="YES" # Update whatis weekly
203 weekly_noid_enable="NO" # Find unowned files
204 weekly_noid_dirs="/" # Look here
206 # 450.status-security
207 weekly_status_security_enable="YES" # Security check
208 # See also "Security options" above for more options
209 weekly_status_security_inline="NO" # Run inline ?
210 weekly_status_security_output="root" # user or /file
213 weekly_local="/etc/weekly.local" # Local scripts
218 # These options are used by periodic(8) itself to determine what to do
219 # with the output of the sub-programs that are run, and where to send
220 # that output. $monthly_output might be set to /var/log/monthly.log if you
221 # wish to log the monthly output and have the files rotated by newsyslog(8)
223 monthly_output="root" # user or /file
224 monthly_show_success="YES" # scripts returning 0
225 monthly_show_info="YES" # scripts returning 1
226 monthly_show_badconfig="NO" # scripts returning 2
229 monthly_accounting_enable="YES" # Login accounting
231 # 450.status-security
232 monthly_status_security_enable="YES" # Security check
233 # See also "Security options" above for more options
234 monthly_status_security_inline="NO" # Run inline ?
235 monthly_status_security_output="root" # user or /file
238 monthly_local="/etc/monthly.local" # Local scripts
243 security_show_success="YES" # scripts returning 0
244 security_show_info="YES" # scripts returning 1
245 security_show_badconfig="NO" # scripts returning 2
247 # These options are used by the security periodic(8) scripts spawned in
248 # daily and weekly 450.status-security.
249 security_status_logdir="/var/log" # Directory for logs
250 security_status_diff_flags="-b -u" # flags for diff output
252 # Each of the security_status_*_period options below can have one of the
254 # - NO: do not run at all
255 # - daily: only run during the daily security status
256 # - weekly: only run during the weekly security status
257 # - monthly: only run during the monthly security status
258 # Note that if periodic security scripts are run from crontab(5) directly,
259 # they will be run unless _enable or _period is set to "NO".
262 security_status_chksetuid_enable="YES"
263 security_status_chksetuid_period="daily"
266 security_status_neggrpperm_enable="YES"
267 security_status_neggrpperm_period="daily"
270 security_status_chkmounts_enable="YES"
271 security_status_chkmounts_period="daily"
272 #security_status_chkmounts_ignore="^amd:" # Don't check matching
274 security_status_noamd="NO" # Don't check amd mounts
277 security_status_chkuid0_enable="YES"
278 security_status_chkuid0_period="daily"
281 security_status_passwdless_enable="YES"
282 security_status_passwdless_period="daily"
285 security_status_logincheck_enable="YES"
286 security_status_logincheck_period="daily"
289 security_status_ipfwdenied_enable="YES"
290 security_status_ipfwdenied_period="daily"
293 security_status_ipfdenied_enable="YES"
294 security_status_ipfdenied_period="daily"
297 security_status_pfdenied_enable="YES"
298 security_status_pfdenied_period="daily"
301 security_status_ipfwlimit_enable="YES"
302 security_status_ipfwlimit_period="daily"
305 security_status_ipf6denied_enable="YES"
306 security_status_ipf6denied_period="daily"
309 security_status_kernelmsg_enable="YES"
310 security_status_kernelmsg_period="daily"
313 security_status_loginfail_enable="YES"
314 security_status_loginfail_period="daily"
317 security_status_tcpwrap_enable="YES"
318 security_status_tcpwrap_period="daily"
322 # Define source_periodic_confs, the mechanism used by /etc/periodic/*/*
323 # scripts to source defaults/periodic.conf overrides safely.
325 if [ -z "${source_periodic_confs_defined}" ]; then
326 source_periodic_confs_defined=yes
328 # Sleep for a random amount of time in order to mitigate the thundering
329 # herd problem of multiple hosts running periodic simultaneously.
330 # Will not sleep when used interactively.
331 # Will sleep at most once per invocation of periodic
333 [ -n "$PERIODIC_IS_INTERACTIVE" ] && return
334 if [ -f "$PERIODIC_ANTICONGESTION_FILE" ]; then
335 rm -f $PERIODIC_ANTICONGESTION_FILE
336 sleep `jot -r 1 0 ${anticongestion_sleeptime}`
340 # Compatibility with old daily variable names.
341 # They can be removed in stable/11.
342 security_daily_compat_var() {
343 local var=$1 dailyvar value
345 dailyvar=daily_status_security${var#security_status}
346 periodvar=${var%enable}period
347 eval value=\"\$$dailyvar\"
348 [ -z "$value" ] && return
349 echo "Warning: Variable \$$dailyvar is deprecated," \
350 "use \$$var instead." >&2
354 eval $periodvar=daily
362 check_yesno_period() {
363 local var="$1" periodvar value period
365 eval value=\"\$$var\"
371 periodvar=${var%enable}period
372 eval period=\"\$$periodvar\"
376 [Dd][Aa][Ii][Ll][Yy]) return 0 ;;
382 [Ww][Ee][Ee][Kk][Ll][Yy]) return 0 ;;
388 [Mm][Oo][Nn][Tt][Hh][Ll][Yy]) return 0 ;;
393 # Run directly from crontab(5).
395 [Nn][Oo]) return 1 ;;
400 # Script run manually.
404 echo "ASSERTION FAILED: Unexpected value for" \
405 "\$PERIODIC: '$PERIODIC'" >&2
411 source_periodic_confs() {
412 local i sourced_files
414 for i in ${periodic_conf_files}; do
415 case ${sourced_files} in
419 sourced_files="${sourced_files}:$i:"