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 Partition (ESP).
260 .It Va daily_backup_gmirror_enable
264 to create backup of gmirror information (i.e., output of
265 .Nm gmirror Cm list ) ,
268 .It Va daily_backup_gmirror_verbose
272 to report a diff between the new backup and the existing backup
274 .It Va daily_backup_gpart_enable
278 to create backups of partition tables, and bootcode partition contents.
279 .It Va daily_backup_gpart_verbose
283 to be verbose if existing backups for kern.geom.conftxt or the partition tables differ
284 from the new backups.
285 .It Va daily_backup_passwd_enable
290 .Pa /etc/master.passwd
293 files backed up and reported on.
294 Reporting consists of checking both files for modifications and running
299 .It Va daily_backup_aliases_enable
304 .Pa /etc/mail/aliases
305 file backed up and modifications to be displayed in your daily output.
306 .It Va daily_backup_zfs_enable
310 to create backup of the output generated from the
315 .It Va daily_backup_zfs_list_flags
317 Set to the arguments for the
320 The default is standard behavior.
321 .It Va daily_backup_zpool_list_flags
323 Set to the arguments for the
328 .It Va daily_backup_zfs_props_enable
332 to create backup of the output generated from the
337 .It Va daily_backup_zfs_get_flags
339 Set to the arguments for the
344 .It Va daily_backup_zpool_get_flags
346 Set to the arguments for the
351 .It Va daily_backup_zfs_verbose
355 to report a diff between the new backup and the existing backup
357 .It Va daily_calendar_enable
364 .It Va daily_accounting_enable
368 if you want to rotate your daily accounting files.
369 No rotations are necessary unless
370 .Va accounting_enable
373 .It Va daily_accounting_compress
377 if you want your daily accounting files to be compressed using
379 .It Va daily_accounting_save
382 .Va daily_accounting_enable
383 is set, this may also be set to the number of daily accounting files that are
387 .It Va daily_accounting_flags
389 Set to the arguments to pass to the
391 utility (in addition to
394 .Va daily_accounting_enable
399 .It Va daily_news_expire_enable
404 .Pa /etc/news.expire .
405 .It Va daily_status_disks_enable
411 (with the arguments supplied in
412 .Va daily_status_disks_df_flags )
415 .It Va daily_status_disks_df_flags
417 Set to the arguments for the
420 .Va daily_status_disks_enable
425 .It Va daily_status_zfs_enable
434 .It Va daily_status_zfs_zpool_list_enable
444 .Va daily_status_zfs_enable
447 .It Va daily_status_gmirror_enable
452 .Nm gmirror Cm status
456 .It Va daily_status_graid3_enable
465 .It Va daily_status_gstripe_enable
470 .Nm gstripe Cm status
474 .It Va daily_status_gconcat_enable
479 .Nm gconcat Cm status
483 .It Va daily_status_mfi_enable
488 .Nm mfiutil Cm status
492 .It Va daily_status_network_enable
498 .It Va daily_status_network_netstat_flags
500 Set to additional arguments for the
503 .Va daily_status_network_enable
508 .It Va daily_status_network_usedns
516 option (to do DNS lookups).
517 .It Va daily_status_uptime_enable
531 .It Va daily_status_mailq_enable
537 .It Va daily_status_mailq_shorten
541 if you want to shorten the
544 .Va daily_status_mailq_enable
547 .It Va daily_status_include_submit_mailq
551 if you also want to run
553 on the submit mail queue when
554 .Va daily_status_mailq_enable
557 This may not work with MTAs other than
559 .It Va daily_status_security_enable
563 if you want to run the security check.
564 The security check is another set of
567 The system defaults are in
568 .Pa /etc/periodic/security .
569 Local scripts should be placed in
570 .Pa /usr/local/etc/periodic/security .
573 manual page for more information.
574 .It Va daily_status_security_inline
578 if you want the security check output inline.
579 The default is to either mail or log the output according to the value of
580 .Va daily_status_security_output .
581 .It Va daily_status_security_output
583 Where to send the output of the security check if
584 .Va daily_status_security_inline
587 This variable behaves in the same way as the
589 variables above, namely it can be set either to one or more email addresses
590 or to an absolute file name.
591 .It Va daily_status_mail_rejects_enable
595 if you want to summarise mail rejections logged to
597 for the previous day.
598 .It Va daily_status_mail_rejects_logs
600 Set to the number of maillog files that should be checked
601 for yesterday's mail rejects.
602 .It Va daily_status_ntpd_enable
606 if you want to enable NTP status check.
607 .It Va daily_status_world_kernel
611 to check the running userland and kernel are in sync.
612 .It Va daily_queuerun_enable
616 if you want to manually run the mail queue at least once a day.
617 .It Va daily_submit_queuerun
621 if you also want to manually run the submit mail queue at least once a day
623 .Va daily_queuerun_enable
626 .It Va daily_scrub_zfs_enable
630 if you want to run a zfs scrub periodically.
631 .It Va daily_scrub_zfs_pools
633 A space separated list of names of zfs pools to scrub.
634 If the list is empty or not set, all zfs pools are scrubbed.
635 .It Va daily_scrub_zfs_default_threshold
637 Number of days between a scrub if no pool-specific threshold is set.
638 If not set, the default value is 35, corresponding to 5 weeks.
639 .It Va daily_scrub_zfs_ Ns Ao Ar poolname Ac Ns Va _threshold
642 .Va daily_scrub_zfs_default_threshold
643 but specific to the pool
644 .Ao Ar poolname Ac Ns .
647 Set to a list of extra scripts that should be run after all other
649 All scripts must be absolute path names.
652 The following variables are used by the standard scripts that reside in
653 .Pa /etc/periodic/weekly :
654 .Bl -tag -offset 4n -width 2n
655 .It Va weekly_locate_enable
660 .Pa /usr/libexec/locate.updatedb .
661 This script is run using
665 and generates the table used by the
668 .It Va weekly_whatis_enable
673 .Pa /usr/libexec/makewhatis.local .
674 This script regenerates the database used by the
677 .It Va weekly_noid_enable
681 if you want to locate orphaned files on the system.
682 An orphaned file is one with an invalid owner or group.
683 .It Va weekly_noid_dirs
685 A list of directories under which orphaned files are searched for.
686 This would usually be set to
688 .It Va weekly_status_security_enable
690 Weekly counterpart of
691 .Va daily_status_security_enable .
692 .It Va weekly_status_security_inline
694 Weekly counterpart of
695 .Va daily_status_security_inline .
696 .It Va weekly_status_security_output
698 Weekly counterpart of
699 .Va daily_status_security_output .
700 .It Va weekly_status_pkg_enable
706 to list installed packages which are out of date.
710 .Va weekly_status_pkg_enable
713 this variable specifies the program that is used to determine the out of
718 As an example, this variable might be set to
721 .Pa ports/sysutils/portupgrade
722 port has been installed.
723 .It Va pkg_version_index
725 This variable specifies the
729 that should be used by
731 Because the dependency tree may be substantially different between versions of
733 there may be more than one
742 it will also be necessary to arrange that the correct
745 using environment variables and that
746 .Va pkg_version_index
748 .Pa /etc/periodic.conf
749 .Pq Dq Li pkg_version_index= .
752 Set to a list of extra scripts that should be run after all other
754 All scripts must be absolute path names.
757 The following variables are used by the standard scripts that reside in
758 .Pa /etc/periodic/monthly :
759 .Bl -tag -offset 4n -width 2n
760 .It Va monthly_accounting_enable
764 if you want to do login accounting using the
767 .It Va monthly_status_security_enable
769 Monthly counterpart of
770 .Va daily_status_security_enable .
771 .It Va monthly_status_security_inline
773 Monthly counterpart of
774 .Va daily_status_security_inline .
775 .It Va monthly_status_security_output
777 Monthly counterpart of
778 .Va daily_status_security_output .
781 Set to a list of extra scripts that should be run after all other
783 All scripts must be absolute path names.
786 The following variables are used by the standard scripts that reside in
787 .Pa /etc/periodic/security .
788 Those scripts are usually run from daily
789 .Pq Va daily_status_security_enable ,
791 .Pq Va weekly_status_security_enable ,
793 .Pq Va monthly_status_security_enable
797 of each script can be configured as
803 Note that when periodic security scripts are run from
805 they will be always run unless their
811 .Bl -tag -offset 4n -width 2n
812 .It Va security_status_diff_flags
814 Set to the arguments to pass to the
816 utility when generating differences.
819 .It Va security_status_chksetuid_enable
823 to compare the modes and modification times of setuid executables with
824 the previous day's values.
825 .It Va security_status_chksetuid_period
833 .It Va security_status_chkportsum_enable
837 to verify checksums of all installed packages against the known checksums in
839 .It Va security_status_chkportsum_period
847 .It Va security_status_neggrpperm_enable
851 to check for files where the group of a file has less permissions than
853 When users are in more than 14 supplemental groups these negative
854 permissions may not be enforced via NFS shares.
855 .It Va security_status_neggrpperm_period
863 .It Va security_status_chkmounts_enable
867 to check for changes mounted file systems to the previous day's values.
868 .It Va security_status_chkmounts_period
876 .It Va security_status_noamd
880 if you want to ignore
882 mounts when comparing against yesterday's file system mounts in the
883 .Va security_status_chkmounts_enable
885 .It Va security_status_chkuid0_enable
890 .Pa /etc/master.passwd
891 for accounts with UID 0.
892 .It Va security_status_chkuid0_period
900 .It Va security_status_passwdless_enable
905 .Pa /etc/master.passwd
906 for accounts with empty passwords.
907 .It Va security_status_passwdless_period
915 .It Va security_status_logincheck_enable
923 for more information.
924 .It Va security_status_logincheck_period
932 .It Va security_status_ipfwdenied_enable
936 to show log entries for packets denied by
938 since yesterday's check.
939 .It Va security_status_ipfwdenied_period
947 .It Va security_status_ipfdenied_enable
951 to show log entries for packets denied by
953 since yesterday's check.
954 .It Va security_status_ipfdenied_period
962 .It Va security_status_pfdenied_enable
966 to show log entries for packets denied by
968 since yesterday's check.
969 .It Va security_status_pfdenied_period
977 .It Va security_status_ipfwlimit_enable
983 rules that have reached their verbosity limit.
984 .It Va security_status_ipfwlimit_period
992 .It Va security_status_kernelmsg_enable
998 entries since yesterday's check.
999 .It Va security_status_kernelmsg_period
1007 .It Va security_status_loginfail_enable
1011 to display failed logins from
1012 .Pa /var/log/messages
1013 in the previous day.
1014 .It Va security_status_loginfail_period
1022 .It Va security_status_tcpwrap_enable
1026 to display connections denied by tcpwrappers (see
1027 .Xr hosts_access 5 )
1029 .Pa /var/log/messages
1030 during the previous day.
1031 .It Va security_status_tcpwrap_period
1041 .Bl -tag -width ".Pa /etc/defaults/periodic.conf"
1042 .It Pa /etc/defaults/periodic.conf
1043 The default configuration file.
1044 This file contains all default variables and values.
1045 .It Pa /etc/periodic.conf
1046 The usual system specific variable override file.
1047 .It Pa /etc/periodic.conf.local
1048 An additional override file, useful when
1049 .Pa /etc/periodic.conf
1050 is shared or distributed.
1078 .An Brian Somers Aq Mt brian@Awfulhak.org