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_passwd_enable
260 .Pa /etc/master.passwd
263 files backed up and reported on.
264 Reporting consists of checking both files for modifications and running
269 .It Va daily_backup_aliases_enable
274 .Pa /etc/mail/aliases
275 file backed up and modifications to be displayed in your daily output.
276 .It Va daily_calendar_enable
283 .It Va daily_accounting_enable
287 if you want to rotate your daily accounting files.
288 No rotations are necessary unless
289 .Va accounting_enable
292 .It Va daily_accounting_compress
296 if you want your daily accounting files to be compressed using
298 .It Va daily_accounting_save
301 .Va daily_accounting_enable
302 is set, this may also be set to the number of daily accounting files that are
306 .It Va daily_accounting_flags
308 Set to the arguments to pass to the
310 utility (in addition to
313 .Va daily_accounting_enable
318 .It Va daily_news_expire_enable
323 .Pa /etc/news.expire .
324 .It Va daily_status_disks_enable
330 (with the arguments supplied in
331 .Va daily_status_disks_df_flags )
334 .It Va daily_status_disks_df_flags
336 Set to the arguments for the
339 .Va daily_status_disks_enable
344 .It Va daily_status_zfs_enable
353 .It Va daily_status_zfs_zpool_list_enable
363 .Va daily_status_zfs_enable
366 .It Va daily_status_gmirror_enable
371 .Nm gmirror Cm status
375 .It Va daily_status_graid3_enable
384 .It Va daily_status_gstripe_enable
389 .Nm gstripe Cm status
393 .It Va daily_status_gconcat_enable
398 .Nm gconcat Cm status
402 .It Va daily_status_mfi_enable
407 .Nm mfiutil Cm status
411 .It Va daily_status_network_enable
417 .It Va daily_status_network_netstat_flags
419 Set to additional arguments for the
422 .Va daily_status_network_enable
427 .It Va daily_status_network_usedns
435 option (to do DNS lookups).
436 .It Va daily_status_rwho_enable
450 .It Va daily_status_mailq_enable
456 .It Va daily_status_mailq_shorten
460 if you want to shorten the
463 .Va daily_status_mailq_enable
466 .It Va daily_status_include_submit_mailq
470 if you also want to run
472 on the submit mail queue when
473 .Va daily_status_mailq_enable
476 This may not work with MTAs other than
478 .It Va daily_status_security_enable
482 if you want to run the security check.
483 The security check is another set of
486 The system defaults are in
487 .Pa /etc/periodic/security .
488 Local scripts should be placed in
489 .Pa /usr/local/etc/periodic/security .
492 manual page for more information.
493 .It Va daily_status_security_inline
497 if you want the security check output inline.
498 The default is to either mail or log the output according to the value of
499 .Va daily_status_security_output .
500 .It Va daily_status_security_output
502 Where to send the output of the security check if
503 .Va daily_status_security_inline
506 This variable behaves in the same way as the
508 variables above, namely it can be set either to one or more email addresses
509 or to an absolute file name.
510 .It Va daily_status_mail_rejects_enable
514 if you want to summarise mail rejections logged to
516 for the previous day.
517 .It Va daily_status_mail_rejects_logs
519 Set to the number of maillog files that should be checked
520 for yesterday's mail rejects.
521 .It Va daily_status_ntpd
525 if you want to enable NTP status check.
526 .It Va daily_status_world_kernel
530 to check the running userland and kernel are in sync.
531 .It Va daily_queuerun_enable
535 if you want to manually run the mail queue at least once a day.
536 .It Va daily_submit_queuerun
540 if you also want to manually run the submit mail queue at least once a day
542 .Va daily_queuerun_enable
545 .It Va daily_scrub_zfs_enable
549 if you want to run a zfs scrub periodically.
550 .It Va daily_scrub_zfs_pools
552 A space separated list of names of zfs pools to scrub.
553 If the list is empty or not set, all zfs pools are scrubbed.
554 .It Va daily_scrub_zfs_default_threshold
556 Number of days between a scrub if no pool-specific threshold is set.
557 If not set, the default value is 35, corresponding to 5 weeks.
558 .It Va daily_scrub_zfs_ Ns Ao Ar poolname Ac Ns Va _threshold
561 .Va daily_scrub_zfs_default_threshold
562 but specific to the pool
563 .Ao Ar poolname Ac Ns .
566 Set to a list of extra scripts that should be run after all other
568 All scripts must be absolute path names.
571 The following variables are used by the standard scripts that reside in
572 .Pa /etc/periodic/weekly :
573 .Bl -tag -offset 4n -width 2n
574 .It Va weekly_locate_enable
579 .Pa /usr/libexec/locate.updatedb .
580 This script is run using
584 and generates the table used by the
587 .It Va weekly_whatis_enable
592 .Pa /usr/libexec/makewhatis.local .
593 This script regenerates the database used by the
596 .It Va weekly_catman_enable
601 .Pa /usr/libexec/catman.local .
602 This script processes all out of date manual pages, speeding up the
604 command at the expense of disk space.
605 .It Va weekly_noid_enable
609 if you want to locate orphaned files on the system.
610 An orphaned file is one with an invalid owner or group.
611 .It Va weekly_noid_dirs
613 A list of directories under which orphaned files are searched for.
614 This would usually be set to
616 .It Va weekly_status_security_enable
618 Weekly counterpart of
619 .Va daily_status_security_enable .
620 .It Va weekly_status_security_inline
622 Weekly counterpart of
623 .Va daily_status_security_inline .
624 .It Va weekly_status_security_output
626 Weekly counterpart of
627 .Va daily_status_security_output .
628 .It Va weekly_status_pkg_enable
634 to list installed packages which are out of date.
638 .Va weekly_status_pkg_enable
641 this variable specifies the program that is used to determine the out of
646 As an example, this variable might be set to
649 .Pa ports/sysutils/portupgrade
650 port has been installed.
651 .It Va pkg_version_index
653 This variable specifies the
657 that should be used by
659 Because the dependency tree may be substantially different between versions of
661 there may be more than one
670 it will also be necessary to arrange that the correct
673 using environment variables and that
674 .Va pkg_version_index
676 .Pa /etc/periodic.conf
677 .Pq Dq Li pkg_version_index= .
680 Set to a list of extra scripts that should be run after all other
682 All scripts must be absolute path names.
685 The following variables are used by the standard scripts that reside in
686 .Pa /etc/periodic/monthly :
687 .Bl -tag -offset 4n -width 2n
688 .It Va monthly_accounting_enable
692 if you want to do login accounting using the
695 .It Va monthly_status_security_enable
697 Monthly counterpart of
698 .Va daily_status_security_enable .
699 .It Va monthly_status_security_inline
701 Monthly counterpart of
702 .Va daily_status_security_inline .
703 .It Va monthly_status_security_output
705 Monthly counterpart of
706 .Va daily_status_security_output .
709 Set to a list of extra scripts that should be run after all other
711 All scripts must be absolute path names.
714 The following variables are used by the standard scripts that reside in
715 .Pa /etc/periodic/security .
716 Those scripts are usually run from daily
717 .Pq Va daily_status_security_enable ,
719 .Pq Va weekly_status_security_enable ,
721 .Pq Va monthly_status_security_enable
725 of each script can be configured as
731 Note that when periodic security scripts are run from
733 they will be always run unless their
739 .Bl -tag -offset 4n -width 2n
740 .It Va security_status_diff_flags
742 Set to the arguments to pass to the
744 utility when generating differences.
747 .It Va security_status_chksetuid_enable
751 to compare the modes and modification times of setuid executables with
752 the previous day's values.
753 .It Va security_status_chksetuid_period
761 .It Va security_status_chkportsum_enable
765 to verify checksums of all installed packages against the known checksums in
767 .It Va security_status_chkportsum_period
775 .It Va security_status_neggrpperm_enable
779 to check for files where the group of a file has less permissions than
781 When users are in more than 14 supplemental groups these negative
782 permissions may not be enforced via NFS shares.
783 .It Va security_status_neggrpperm_period
791 .It Va security_status_chkmounts_enable
795 to check for changes mounted file systems to the previous day's values.
796 .It Va security_status_chkmounts_period
804 .It Va security_status_noamd
808 if you want to ignore
810 mounts when comparing against yesterday's file system mounts in the
811 .Va security_status_chkmounts_enable
813 .It Va security_status_chkuid0_enable
818 .Pa /etc/master.passwd
819 for accounts with UID 0.
820 .It Va security_status_chkuid0_period
828 .It Va security_status_passwdless_enable
833 .Pa /etc/master.passwd
834 for accounts with empty passwords.
835 .It Va security_status_passwdless_period
843 .It Va security_status_logincheck_enable
851 for more information.
852 .It Va security_status_logincheck_period
860 .It Va security_status_ipfwdenied_enable
864 to show log entries for packets denied by
866 since yesterday's check.
867 .It Va security_status_ipfwdenied_period
875 .It Va security_status_ipfdenied_enable
879 to show log entries for packets denied by
881 since yesterday's check.
882 .It Va security_status_ipfdenied_period
890 .It Va security_status_pfdenied_enable
894 to show log entries for packets denied by
896 since yesterday's check.
897 .It Va security_status_pfdenied_period
905 .It Va security_status_ipfwlimit_enable
911 rules that have reached their verbosity limit.
912 .It Va security_status_ipfwlimit_period
920 .It Va security_status_kernelmsg_enable
926 entries since yesterday's check.
927 .It Va security_status_kernelmsg_period
935 .It Va security_status_loginfail_enable
939 to display failed logins from
940 .Pa /var/log/messages
942 .It Va security_status_loginfail_period
950 .It Va security_status_tcpwrap_enable
954 to display connections denied by tcpwrappers (see
957 .Pa /var/log/messages
958 during the previous day.
959 .It Va security_status_tcpwrap_period
969 .Bl -tag -width ".Pa /etc/defaults/periodic.conf"
970 .It Pa /etc/defaults/periodic.conf
971 The default configuration file.
972 This file contains all default variables and values.
973 .It Pa /etc/periodic.conf
974 The usual system specific variable override file.
975 .It Pa /etc/periodic.conf.local
976 An additional override file, useful when
977 .Pa /etc/periodic.conf
978 is shared or distributed.
1006 .An Brian Somers Aq Mt brian@Awfulhak.org