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 if [ $(sysctl -n security.jail.jailed) = 0 ]; then
82 # Backup partition table/boot partition/MBR
83 daily_backup_gpart_enable="YES"
85 daily_backup_gpart_enable="NO"
87 daily_backup_gpart_verbose="NO" # Be verbose if new backup differs from the old one
88 daily_backup_efi_enable="NO" # Backup EFI system partition (ESP)
91 daily_backup_gmirror_enable="NO" # Backup of gmirror info (i.e., output of `gmirror list`)
92 daily_backup_gmirror_verbose="NO" # Log diff if new backup differs from the old one
95 daily_backup_zfs_enable="NO" # Backup output from zpool/zfs list
96 daily_backup_zfs_props_enable="NO" # Backup zpool/zfs filesystem properties
97 daily_backup_zfs_get_flags="all" # flags passed to `zfs get`
98 daily_backup_zfs_list_flags="" # flags passed to `zfs list`
99 daily_backup_zpool_get_flags="all" # flags passed to `zpool get`
100 daily_backup_zpool_list_flags="-v" # flags passed to `zpool list`
101 daily_backup_zfs_verbose="NO" # Report diff between the old and new backups.
104 daily_calendar_enable="NO" # Run calendar -a
107 daily_accounting_enable="YES" # Rotate acct files
108 daily_accounting_compress="NO" # Gzip rotated files
109 daily_accounting_flags=-q # Flags to /usr/sbin/sa
110 daily_accounting_save=3 # How many files to save
113 daily_news_expire_enable="YES" # Run news.expire
116 daily_status_disks_enable="YES" # Check disk status
117 daily_status_disks_df_flags="-l -h" # df(1) flags for check
120 daily_status_graid_enable="NO" # Check graid(8)
123 daily_status_zfs_enable="NO" # Check ZFS
124 daily_status_zfs_zpool_list_enable="YES" # List ZFS pools
127 daily_status_gmirror_enable="NO" # Check gmirror(8)
130 daily_status_graid3_enable="NO" # Check graid3(8)
133 daily_status_gstripe_enable="NO" # Check gstripe(8)
136 daily_status_gconcat_enable="NO" # Check gconcat(8)
139 daily_status_mfi_enable="NO" # Check mfiutil(8)
142 daily_status_network_enable="YES" # Check network status
143 daily_status_network_usedns="YES" # DNS lookups are ok
144 daily_status_network_netstat_flags="-d -W" # netstat(1) flags
147 daily_status_uptime_enable="YES" # Check system uptime
150 daily_status_mailq_enable="YES" # Check mail status
151 daily_status_mailq_shorten="NO" # Shorten output
152 daily_status_include_submit_mailq="YES" # Also submit queue
154 # 450.status-security
155 daily_status_security_enable="YES" # Security check
156 # See also "Security options" below for more options
157 daily_status_security_inline="NO" # Run inline ?
158 daily_status_security_output="root" # user or /file
160 # 460.status-mail-rejects
161 daily_status_mail_rejects_enable="YES" # Check mail rejects
162 daily_status_mail_rejects_logs=3 # How many logs to check
163 daily_status_mail_rejects_shorten="NO" # Shorten output
166 daily_ntpd_leapfile_enable="YES" # Fetch NTP leapfile
169 daily_status_ntpd_enable="NO" # Check NTP status
172 daily_queuerun_enable="YES" # Run mail queue
173 daily_submit_queuerun="YES" # Also submit queue
175 # 510.status-world-kernel
176 daily_status_world_kernel="YES" # Check the running
177 # userland/kernel version
180 daily_scrub_zfs_enable="NO"
181 daily_scrub_zfs_pools="" # empty string selects all pools
182 daily_scrub_zfs_default_threshold="35" # days between scrubs
183 #daily_scrub_zfs_${poolname}_threshold="35" # pool specific threshold
186 daily_local="/etc/daily.local" # Local scripts
191 # These options are used by periodic(8) itself to determine what to do
192 # with the output of the sub-programs that are run, and where to send
193 # that output. $weekly_output might be set to /var/log/weekly.log if you
194 # wish to log the weekly output and have the files rotated by newsyslog(8)
196 weekly_output="root" # user or /file
197 weekly_show_success="YES" # scripts returning 0
198 weekly_show_info="YES" # scripts returning 1
199 weekly_show_badconfig="NO" # scripts returning 2
202 weekly_locate_enable="YES" # Update locate weekly
205 weekly_whatis_enable="YES" # Update whatis weekly
208 weekly_noid_enable="NO" # Find unowned files
209 weekly_noid_dirs="/" # Look here
211 # 450.status-security
212 weekly_status_security_enable="YES" # Security check
213 # See also "Security options" above for more options
214 weekly_status_security_inline="NO" # Run inline ?
215 weekly_status_security_output="root" # user or /file
218 weekly_local="/etc/weekly.local" # Local scripts
223 # These options are used by periodic(8) itself to determine what to do
224 # with the output of the sub-programs that are run, and where to send
225 # that output. $monthly_output might be set to /var/log/monthly.log if you
226 # wish to log the monthly output and have the files rotated by newsyslog(8)
228 monthly_output="root" # user or /file
229 monthly_show_success="YES" # scripts returning 0
230 monthly_show_info="YES" # scripts returning 1
231 monthly_show_badconfig="NO" # scripts returning 2
234 monthly_accounting_enable="YES" # Login accounting
236 # 450.status-security
237 monthly_status_security_enable="YES" # Security check
238 # See also "Security options" above for more options
239 monthly_status_security_inline="NO" # Run inline ?
240 monthly_status_security_output="root" # user or /file
243 monthly_local="/etc/monthly.local" # Local scripts
248 security_show_success="YES" # scripts returning 0
249 security_show_info="YES" # scripts returning 1
250 security_show_badconfig="NO" # scripts returning 2
252 # These options are used by the security periodic(8) scripts spawned in
253 # daily and weekly 450.status-security.
254 security_status_logdir="/var/log" # Directory for logs
255 security_status_diff_flags="-b -u" # flags for diff output
257 # Each of the security_status_*_period options below can have one of the
259 # - NO: do not run at all
260 # - daily: only run during the daily security status
261 # - weekly: only run during the weekly security status
262 # - monthly: only run during the monthly security status
263 # Note that if periodic security scripts are run from crontab(5) directly,
264 # they will be run unless _enable or _period is set to "NO".
267 security_status_chksetuid_enable="YES"
268 security_status_chksetuid_period="daily"
271 security_status_neggrpperm_enable="YES"
272 security_status_neggrpperm_period="daily"
275 security_status_chkmounts_enable="YES"
276 security_status_chkmounts_period="daily"
277 #security_status_chkmounts_ignore="^amd:" # Don't check matching
279 security_status_noamd="NO" # Don't check amd mounts
282 security_status_chkuid0_enable="YES"
283 security_status_chkuid0_period="daily"
286 security_status_passwdless_enable="YES"
287 security_status_passwdless_period="daily"
290 security_status_logincheck_enable="YES"
291 security_status_logincheck_period="daily"
294 security_status_ipfwdenied_enable="YES"
295 security_status_ipfwdenied_period="daily"
298 security_status_ipfdenied_enable="YES"
299 security_status_ipfdenied_period="daily"
302 security_status_pfdenied_enable="YES"
303 security_status_pfdenied_period="daily"
306 security_status_ipfwlimit_enable="YES"
307 security_status_ipfwlimit_period="daily"
310 security_status_ipf6denied_enable="YES"
311 security_status_ipf6denied_period="daily"
314 security_status_kernelmsg_enable="YES"
315 security_status_kernelmsg_period="daily"
318 security_status_loginfail_enable="YES"
319 security_status_loginfail_period="daily"
322 security_status_tcpwrap_enable="YES"
323 security_status_tcpwrap_period="daily"
327 # Define source_periodic_confs, the mechanism used by /etc/periodic/*/*
328 # scripts to source defaults/periodic.conf overrides safely.
330 if [ -z "${source_periodic_confs_defined}" ]; then
331 source_periodic_confs_defined=yes
333 # Sleep for a random amount of time in order to mitigate the thundering
334 # herd problem of multiple hosts running periodic simultaneously.
335 # Will not sleep when used interactively.
336 # Will sleep at most once per invocation of periodic
338 [ -n "$PERIODIC_IS_INTERACTIVE" ] && return
339 if [ -f "$PERIODIC_ANTICONGESTION_FILE" ]; then
340 rm -f $PERIODIC_ANTICONGESTION_FILE
341 sleep `jot -r 1 0 ${anticongestion_sleeptime}`
345 # Compatibility with old daily variable names.
346 # They can be removed in stable/11.
347 security_daily_compat_var() {
348 local var=$1 dailyvar value
350 dailyvar=daily_status_security${var#security_status}
351 periodvar=${var%enable}period
352 eval value=\"\$$dailyvar\"
353 [ -z "$value" ] && return
354 echo "Warning: Variable \$$dailyvar is deprecated," \
355 "use \$$var instead." >&2
359 eval $periodvar=daily
367 check_yesno_period() {
368 local var="$1" periodvar value period
370 eval value=\"\$$var\"
376 periodvar=${var%enable}period
377 eval period=\"\$$periodvar\"
381 [Dd][Aa][Ii][Ll][Yy]) return 0 ;;
387 [Ww][Ee][Ee][Kk][Ll][Yy]) return 0 ;;
393 [Mm][Oo][Nn][Tt][Hh][Ll][Yy]) return 0 ;;
398 # Run directly from crontab(5).
400 [Nn][Oo]) return 1 ;;
405 # Script run manually.
409 echo "ASSERTION FAILED: Unexpected value for" \
410 "\$PERIODIC: '$PERIODIC'" >&2
416 source_periodic_confs() {
417 local i sourced_files
419 for i in ${periodic_conf_files}; do
420 case ${sourced_files} in
424 sourced_files="${sourced_files}:$i:"