2 .\" Copyright (c) 2000 Brian Somers <brian@Awfulhak.org>
3 .\" All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\" notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\" notice, this list of conditions and the following disclaimer in the
12 .\" documentation and/or other materials provided with the distribution.
14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 .Nd periodic job configuration information
37 contains a description of how daily, weekly and monthly system maintenance
41 directory and parts may be overridden by a file of the same name in
43 which itself may be overridden by the
44 .Pa /etc/periodic.conf.local
50 is actually sourced as a shell script from each of the periodic scripts
51 and is intended to simply provide default configuration variables.
53 The following variables are used by
56 .Bl -tag -offset 4n -width 2n
59 List of directories to search for periodic scripts.
60 This list is always prefixed with
62 and is only used when an argument to
64 is not an absolute directory name.
65 .It Ao Ar dir Ac Ns Va _output
66 .Pq Vt path No or Vt list
67 What to do with the output of the scripts executed from
70 If this variable is set to an absolute path name, output is logged to
71 that file, otherwise it is taken as one or more space separated email
72 addresses and mailed to those users.
73 If this variable is not set or is empty, output is sent to standard output.
75 For an unattended machine, suitable values for
81 .Dq Li /var/log/daily.log ,
82 .Dq Li /var/log/weekly.log ,
84 .Dq Li /var/log/monthly.log
87 will rotate these files (if they exists) at the appropriate times.
88 .It Ao Ar dir Ac Ns Va _show_success
89 .It Ao Ar dir Ac Ns Va _show_info
90 .It Ao Ar dir Ac Ns Va _show_badconfig
92 These variables control whether
94 will mask the output of the executed scripts based on their return code
97 is the base directory name in which each script resides).
98 If the return code of a script is
101 .Ao Ar dir Ac Ns Va _show_success
105 will mask the script's output.
106 If the return code of a script is
109 .Ao Ar dir Ac Ns Va _show_info
113 will mask the script's output.
114 If the return code of a script is
117 .Ao Ar dir Ac Ns Va _show_badconfig
121 will mask the script's output.
122 If these variables are set to neither
135 manual page for how script return codes are interpreted.
136 .It Va anticongestion_sleeptime
138 The maximum number of seconds to randomly sleep in order to smooth bursty loads
139 on a shared resource, such as a download mirror.
142 The following variables are used by the standard scripts that reside in
143 .Pa /etc/periodic/daily :
144 .Bl -tag -offset 4n -width 2n
145 .It Va daily_clean_disks_enable
149 if you want to remove all files matching
150 .Va daily_clean_disks_files
152 .It Va daily_clean_disks_files
154 Set to a list of file names to match.
155 Wild cards are permitted.
156 .It Va daily_clean_disks_days
159 .Va daily_clean_disks_enable
162 this must also be set to the number of days old that a file's access
163 and modification times must be before it is deleted.
164 .It Va daily_clean_disks_verbose
168 if you want the removed files to be reported in your daily output.
169 .It Va daily_clean_tmps_enable
173 if you want to clear temporary directories daily.
174 .It Va daily_clean_tmps_dirs
176 Set to the list of directories to clear if
177 .Va daily_clean_tmps_enable
180 .It Va daily_clean_tmps_days
183 .Va daily_clean_tmps_enable
184 is set, this must also be set to the number of days old that a file's access
185 and modification times must be before it is deleted.
186 .It Va daily_clean_tmps_ignore
188 Set to the list of files that should not be deleted when
189 .Va daily_clean_tmps_enable
192 Wild card characters are permitted.
193 .It Va daily_clean_tmps_verbose
197 if you want the removed files to be reported in your daily output.
198 .It Va daily_clean_preserve_enable
202 if you wish to remove old files from
204 .It Va daily_clean_preserve_days
206 Set to the number of days that files must not have been modified before
208 .It Va daily_clean_preserve_verbose
212 if you want the removed files to be reported in your daily output.
213 .It Va daily_clean_msgs_enable
217 if you wish old system messages to be purged.
218 .It Va daily_clean_msgs_days
220 Set to the number of days that files must not have been modified before
222 If this variable is left blank, the
225 .It Va daily_clean_rwho_enable
229 if you wish old files in
232 .It Va daily_clean_rwho_days
234 Set to the number of days that files must not have been modified before
236 .It Va daily_clean_rwho_verbose
240 if you want the removed files to be reported in your daily output.
241 .It Va daily_clean_hoststat_enable
247 to automatically purge stale entries from
250 Files will be deleted using the same criteria as
252 would normally use when determining whether to believe the cached information,
254 .Pa /etc/mail/sendmail.cf .
255 .It Va daily_backup_efi_enable
259 to create backup of EFI System Partion (ESP).
260 .It Va daily_backup_gpart_enable
264 to create backups of partition tables, and bootcode partition contents.
265 .It Va daily_backup_gpart_verbose
269 to be verbose if existing backups for kern.geom.conftxt or the partition tables differ
270 from the new backups.
271 .It Va daily_backup_passwd_enable
276 .Pa /etc/master.passwd
279 files backed up and reported on.
280 Reporting consists of checking both files for modifications and running
285 .It Va daily_backup_aliases_enable
290 .Pa /etc/mail/aliases
291 file backed up and modifications to be displayed in your daily output.
292 .It Va daily_calendar_enable
299 .It Va daily_accounting_enable
303 if you want to rotate your daily accounting files.
304 No rotations are necessary unless
305 .Va accounting_enable
308 .It Va daily_accounting_compress
312 if you want your daily accounting files to be compressed using
314 .It Va daily_accounting_save
317 .Va daily_accounting_enable
318 is set, this may also be set to the number of daily accounting files that are
322 .It Va daily_accounting_flags
324 Set to the arguments to pass to the
326 utility (in addition to
329 .Va daily_accounting_enable
334 .It Va daily_news_expire_enable
339 .Pa /etc/news.expire .
340 .It Va daily_status_disks_enable
346 (with the arguments supplied in
347 .Va daily_status_disks_df_flags )
350 .It Va daily_status_disks_df_flags
352 Set to the arguments for the
355 .Va daily_status_disks_enable
360 .It Va daily_status_zfs_enable
369 .It Va daily_status_zfs_zpool_list_enable
379 .Va daily_status_zfs_enable
382 .It Va daily_status_gmirror_enable
387 .Nm gmirror Cm status
391 .It Va daily_status_graid3_enable
400 .It Va daily_status_gstripe_enable
405 .Nm gstripe Cm status
409 .It Va daily_status_gconcat_enable
414 .Nm gconcat Cm status
418 .It Va daily_status_mfi_enable
423 .Nm mfiutil Cm status
427 .It Va daily_status_network_enable
433 .It Va daily_status_network_netstat_flags
435 Set to additional arguments for the
438 .Va daily_status_network_enable
443 .It Va daily_status_network_usedns
451 option (to do DNS lookups).
452 .It Va daily_status_uptime_enable
466 .It Va daily_status_mailq_enable
472 .It Va daily_status_mailq_shorten
476 if you want to shorten the
479 .Va daily_status_mailq_enable
482 .It Va daily_status_include_submit_mailq
486 if you also want to run
488 on the submit mail queue when
489 .Va daily_status_mailq_enable
492 This may not work with MTAs other than
494 .It Va daily_status_security_enable
498 if you want to run the security check.
499 The security check is another set of
502 The system defaults are in
503 .Pa /etc/periodic/security .
504 Local scripts should be placed in
505 .Pa /usr/local/etc/periodic/security .
508 manual page for more information.
509 .It Va daily_status_security_inline
513 if you want the security check output inline.
514 The default is to either mail or log the output according to the value of
515 .Va daily_status_security_output .
516 .It Va daily_status_security_output
518 Where to send the output of the security check if
519 .Va daily_status_security_inline
522 This variable behaves in the same way as the
524 variables above, namely it can be set either to one or more email addresses
525 or to an absolute file name.
526 .It Va daily_status_mail_rejects_enable
530 if you want to summarise mail rejections logged to
532 for the previous day.
533 .It Va daily_status_mail_rejects_logs
535 Set to the number of maillog files that should be checked
536 for yesterday's mail rejects.
537 .It Va daily_status_ntpd_enable
541 if you want to enable NTP status check.
542 .It Va daily_status_world_kernel
546 to check the running userland and kernel are in sync.
547 .It Va daily_queuerun_enable
551 if you want to manually run the mail queue at least once a day.
552 .It Va daily_submit_queuerun
556 if you also want to manually run the submit mail queue at least once a day
558 .Va daily_queuerun_enable
561 .It Va daily_scrub_zfs_enable
565 if you want to run a zfs scrub periodically.
566 .It Va daily_scrub_zfs_pools
568 A space separated list of names of zfs pools to scrub.
569 If the list is empty or not set, all zfs pools are scrubbed.
570 .It Va daily_scrub_zfs_default_threshold
572 Number of days between a scrub if no pool-specific threshold is set.
573 If not set, the default value is 35, corresponding to 5 weeks.
574 .It Va daily_scrub_zfs_ Ns Ao Ar poolname Ac Ns Va _threshold
577 .Va daily_scrub_zfs_default_threshold
578 but specific to the pool
579 .Ao Ar poolname Ac Ns .
582 Set to a list of extra scripts that should be run after all other
584 All scripts must be absolute path names.
587 The following variables are used by the standard scripts that reside in
588 .Pa /etc/periodic/weekly :
589 .Bl -tag -offset 4n -width 2n
590 .It Va weekly_locate_enable
595 .Pa /usr/libexec/locate.updatedb .
596 This script is run using
600 and generates the table used by the
603 .It Va weekly_whatis_enable
608 .Pa /usr/libexec/makewhatis.local .
609 This script regenerates the database used by the
612 .It Va weekly_noid_enable
616 if you want to locate orphaned files on the system.
617 An orphaned file is one with an invalid owner or group.
618 .It Va weekly_noid_dirs
620 A list of directories under which orphaned files are searched for.
621 This would usually be set to
623 .It Va weekly_status_security_enable
625 Weekly counterpart of
626 .Va daily_status_security_enable .
627 .It Va weekly_status_security_inline
629 Weekly counterpart of
630 .Va daily_status_security_inline .
631 .It Va weekly_status_security_output
633 Weekly counterpart of
634 .Va daily_status_security_output .
635 .It Va weekly_status_pkg_enable
641 to list installed packages which are out of date.
645 .Va weekly_status_pkg_enable
648 this variable specifies the program that is used to determine the out of
653 As an example, this variable might be set to
656 .Pa ports/sysutils/portupgrade
657 port has been installed.
658 .It Va pkg_version_index
660 This variable specifies the
664 that should be used by
666 Because the dependency tree may be substantially different between versions of
668 there may be more than one
677 it will also be necessary to arrange that the correct
680 using environment variables and that
681 .Va pkg_version_index
683 .Pa /etc/periodic.conf
684 .Pq Dq Li pkg_version_index= .
687 Set to a list of extra scripts that should be run after all other
689 All scripts must be absolute path names.
692 The following variables are used by the standard scripts that reside in
693 .Pa /etc/periodic/monthly :
694 .Bl -tag -offset 4n -width 2n
695 .It Va monthly_accounting_enable
699 if you want to do login accounting using the
702 .It Va monthly_status_security_enable
704 Monthly counterpart of
705 .Va daily_status_security_enable .
706 .It Va monthly_status_security_inline
708 Monthly counterpart of
709 .Va daily_status_security_inline .
710 .It Va monthly_status_security_output
712 Monthly counterpart of
713 .Va daily_status_security_output .
716 Set to a list of extra scripts that should be run after all other
718 All scripts must be absolute path names.
721 The following variables are used by the standard scripts that reside in
722 .Pa /etc/periodic/security .
723 Those scripts are usually run from daily
724 .Pq Va daily_status_security_enable ,
726 .Pq Va weekly_status_security_enable ,
728 .Pq Va monthly_status_security_enable
732 of each script can be configured as
738 Note that when periodic security scripts are run from
740 they will be always run unless their
746 .Bl -tag -offset 4n -width 2n
747 .It Va security_status_diff_flags
749 Set to the arguments to pass to the
751 utility when generating differences.
754 .It Va security_status_chksetuid_enable
758 to compare the modes and modification times of setuid executables with
759 the previous day's values.
760 .It Va security_status_chksetuid_period
768 .It Va security_status_chkportsum_enable
772 to verify checksums of all installed packages against the known checksums in
774 .It Va security_status_chkportsum_period
782 .It Va security_status_neggrpperm_enable
786 to check for files where the group of a file has less permissions than
788 When users are in more than 14 supplemental groups these negative
789 permissions may not be enforced via NFS shares.
790 .It Va security_status_neggrpperm_period
798 .It Va security_status_chkmounts_enable
802 to check for changes mounted file systems to the previous day's values.
803 .It Va security_status_chkmounts_period
811 .It Va security_status_noamd
815 if you want to ignore
817 mounts when comparing against yesterday's file system mounts in the
818 .Va security_status_chkmounts_enable
820 .It Va security_status_chkuid0_enable
825 .Pa /etc/master.passwd
826 for accounts with UID 0.
827 .It Va security_status_chkuid0_period
835 .It Va security_status_passwdless_enable
840 .Pa /etc/master.passwd
841 for accounts with empty passwords.
842 .It Va security_status_passwdless_period
850 .It Va security_status_logincheck_enable
858 for more information.
859 .It Va security_status_logincheck_period
867 .It Va security_status_ipfwdenied_enable
871 to show log entries for packets denied by
873 since yesterday's check.
874 .It Va security_status_ipfwdenied_period
882 .It Va security_status_ipfdenied_enable
886 to show log entries for packets denied by
888 since yesterday's check.
889 .It Va security_status_ipfdenied_period
897 .It Va security_status_pfdenied_enable
901 to show log entries for packets denied by
903 since yesterday's check.
904 .It Va security_status_pfdenied_period
912 .It Va security_status_ipfwlimit_enable
918 rules that have reached their verbosity limit.
919 .It Va security_status_ipfwlimit_period
927 .It Va security_status_kernelmsg_enable
933 entries since yesterday's check.
934 .It Va security_status_kernelmsg_period
942 .It Va security_status_loginfail_enable
946 to display failed logins from
947 .Pa /var/log/messages
949 .It Va security_status_loginfail_period
957 .It Va security_status_tcpwrap_enable
961 to display connections denied by tcpwrappers (see
964 .Pa /var/log/messages
965 during the previous day.
966 .It Va security_status_tcpwrap_period
976 .Bl -tag -width ".Pa /etc/defaults/periodic.conf"
977 .It Pa /etc/defaults/periodic.conf
978 The default configuration file.
979 This file contains all default variables and values.
980 .It Pa /etc/periodic.conf
981 The usual system specific variable override file.
982 .It Pa /etc/periodic.conf.local
983 An additional override file, useful when
984 .Pa /etc/periodic.conf
985 is shared or distributed.
1013 .An Brian Somers Aq Mt brian@Awfulhak.org