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.
138 The following variables are used by the standard scripts that reside in
139 .Pa /etc/periodic/daily :
140 .Bl -tag -offset 4n -width 2n
141 .It Va daily_clean_disks_enable
145 if you want to remove all files matching
146 .Va daily_clean_disks_files
148 .It Va daily_clean_disks_files
150 Set to a list of file names to match.
151 Wild cards are permitted.
152 .It Va daily_clean_disks_days
155 .Va daily_clean_disks_enable
158 this must also be set to the number of days old that a file's access
159 and modification times must be before it is deleted.
160 .It Va daily_clean_disks_verbose
164 if you want the removed files to be reported in your daily output.
165 .It Va daily_clean_tmps_enable
169 if you want to clear temporary directories daily.
170 .It Va daily_clean_tmps_dirs
172 Set to the list of directories to clear if
173 .Va daily_clean_tmps_enable
176 .It Va daily_clean_tmps_days
179 .Va daily_clean_tmps_enable
180 is set, this must also be set to the number of days old that a file's access
181 and modification times must be before it is deleted.
182 .It Va daily_clean_tmps_ignore
184 Set to the list of files that should not be deleted when
185 .Va daily_clean_tmps_enable
188 Wild card characters are permitted.
189 .It Va daily_clean_tmps_verbose
193 if you want the removed files to be reported in your daily output.
194 .It Va daily_clean_preserve_enable
198 if you wish to remove old files from
200 .It Va daily_clean_preserve_days
202 Set to the number of days that files must not have been modified before
204 .It Va daily_clean_preserve_verbose
208 if you want the removed files to be reported in your daily output.
209 .It Va daily_clean_msgs_enable
213 if you wish old system messages to be purged.
214 .It Va daily_clean_msgs_days
216 Set to the number of days that files must not have been modified before
218 If this variable is left blank, the
221 .It Va daily_clean_rwho_enable
225 if you wish old files in
228 .It Va daily_clean_rwho_days
230 Set to the number of days that files must not have been modified before
232 .It Va daily_clean_rwho_verbose
236 if you want the removed files to be reported in your daily output.
237 .It Va daily_clean_hoststat_enable
243 to automatically purge stale entries from
246 Files will be deleted using the same criteria as
248 would normally use when determining whether to believe the cached information,
250 .Pa /etc/mail/sendmail.cf .
251 .It Va daily_backup_passwd_enable
256 .Pa /etc/master.passwd
259 files backed up and reported on.
260 Reporting consists of checking both files for modifications and running
265 .It Va daily_backup_aliases_enable
270 .Pa /etc/mail/aliases
271 file backed up and modifications to be displayed in your daily output.
272 .It Va daily_calendar_enable
279 .It Va daily_accounting_enable
283 if you want to rotate your daily accounting files.
284 No rotations are necessary unless
285 .Va accounting_enable
288 .It Va daily_accounting_compress
292 if you want your daily accounting files to be compressed using
294 .It Va daily_accounting_save
297 .Va daily_accounting_enable
298 is set, this may also be set to the number of daily accounting files that are
302 .It Va daily_accounting_flags
304 Set to the arguments to pass to the
306 utility (in addition to
309 .Va daily_accounting_enable
314 .It Va daily_news_expire_enable
319 .Pa /etc/news.expire .
320 .It Va daily_status_disks_enable
326 (with the arguments supplied in
327 .Va daily_status_disks_df_flags )
330 .It Va daily_status_disks_df_flags
332 Set to the arguments for the
335 .Va daily_status_disks_enable
340 .It Va daily_status_zfs_enable
349 .It Va daily_status_zfs_zpool_list_enable
359 .Va daily_status_zfs_enable
362 .It Va daily_status_gmirror_enable
367 .Nm gmirror Cm status
371 .It Va daily_status_graid3_enable
380 .It Va daily_status_gstripe_enable
385 .Nm gstripe Cm status
389 .It Va daily_status_gconcat_enable
394 .Nm gconcat Cm status
398 .It Va daily_status_network_enable
404 .It Va daily_status_network_netstat_flags
406 Set to additional arguments for the
409 .Va daily_status_network_enable
414 .It Va daily_status_network_usedns
422 option (to do DNS lookups).
423 .It Va daily_status_rwho_enable
437 .It Va daily_status_mailq_enable
443 .It Va daily_status_mailq_shorten
447 if you want to shorten the
450 .Va daily_status_mailq_enable
453 .It Va daily_status_include_submit_mailq
457 if you also want to run
459 on the submit mail queue when
460 .Va daily_status_mailq_enable
463 This may not work with MTAs other than
465 .It Va daily_status_security_enable
469 if you want to run the security check.
470 The security check is another set of
473 The system defaults are in
474 .Pa /etc/periodic/security .
475 Local scripts should be placed in
476 .Pa /usr/local/etc/periodic/security .
479 manual page for more information.
480 .It Va daily_status_security_inline
484 if you want the security check output inline.
485 The default is to either mail or log the output according to the value of
486 .Va daily_status_security_output .
487 .It Va daily_status_security_output
489 Where to send the output of the security check if
490 .Va daily_status_security_inline
493 This variable behaves in the same way as the
495 variables above, namely it can be set either to one or more email addresses
496 or to an absolute file name.
497 .It Va daily_status_mail_rejects_enable
501 if you want to summarise mail rejections logged to
503 for the previous day.
504 .It Va daily_status_mail_rejects_logs
506 Set to the number of maillog files that should be checked
507 for yesterday's mail rejects.
508 .It Va daily_status_ntpd
512 if you want to enable NTP status check.
513 .It Va daily_status_world_kernel
517 to check the running userland and kernel are in sync.
518 .It Va daily_queuerun_enable
522 if you want to manually run the mail queue at least once a day.
523 .It Va daily_submit_queuerun
527 if you also want to manually run the submit mail queue at least once a day
529 .Va daily_queuerun_enable
532 .It Va daily_scrub_zfs_enable
536 if you want to run a zfs scrub periodically.
537 .It Va daily_scrub_zfs_pools
539 A space separated list of names of zfs pools to scrub.
540 If the list is empty or not set, all zfs pools are scrubbed.
541 .It Va daily_scrub_zfs_default_threshold
543 Number of days between a scrub if no pool-specific threshold is set.
544 If not set, the default value is 35, corresponding to 5 weeks.
545 .It Va daily_scrub_zfs_ Ns Ao Ar poolname Ac Ns Va _threshold
548 .Va daily_scrub_zfs_default_threshold
549 but specific to the pool
550 .Ao Ar poolname Ac Ns .
553 Set to a list of extra scripts that should be run after all other
555 All scripts must be absolute path names.
558 The following variables are used by the standard scripts that reside in
559 .Pa /etc/periodic/weekly :
560 .Bl -tag -offset 4n -width 2n
561 .It Va weekly_locate_enable
566 .Pa /usr/libexec/locate.updatedb .
567 This script is run using
571 and generates the table used by the
574 .It Va weekly_whatis_enable
579 .Pa /usr/libexec/makewhatis.local .
580 This script regenerates the database used by the
583 .It Va weekly_catman_enable
588 .Pa /usr/libexec/catman.local .
589 This script processes all out of date manual pages, speeding up the
591 command at the expense of disk space.
592 .It Va weekly_noid_enable
596 if you want to locate orphaned files on the system.
597 An orphaned file is one with an invalid owner or group.
598 .It Va weekly_noid_dirs
600 A list of directories under which orphaned files are searched for.
601 This would usually be set to
603 .It Va weekly_status_security_enable
605 Weekly counterpart of
606 .Va daily_status_security_enable .
607 .It Va weekly_status_security_inline
609 Weekly counterpart of
610 .Va daily_status_security_inline .
611 .It Va weekly_status_security_output
613 Weekly counterpart of
614 .Va daily_status_security_output .
615 .It Va weekly_status_pkg_enable
621 to list installed packages which are out of date.
625 .Va weekly_status_pkg_enable
628 this variable specifies the program that is used to determine the out of
633 As an example, this variable might be set to
636 .Pa ports/sysutils/portupgrade
637 port has been installed.
638 .It Va pkg_version_index
640 This variable specifies the
644 that should be used by
646 Because the dependency tree may be substantially different between versions of
648 there may be more than one
657 it will also be necessary to arrange that the correct
660 using environment variables and that
661 .Va pkg_version_index
663 .Pa /etc/periodic.conf
664 .Pq Dq Li pkg_version_index= .
667 Set to a list of extra scripts that should be run after all other
669 All scripts must be absolute path names.
672 The following variables are used by the standard scripts that reside in
673 .Pa /etc/periodic/monthly :
674 .Bl -tag -offset 4n -width 2n
675 .It Va monthly_accounting_enable
679 if you want to do login accounting using the
682 .It Va monthly_status_security_enable
684 Monthly counterpart of
685 .Va daily_status_security_enable .
686 .It Va monthly_status_security_inline
688 Monthly counterpart of
689 .Va daily_status_security_inline .
690 .It Va monthly_status_security_output
692 Monthly counterpart of
693 .Va daily_status_security_output .
696 Set to a list of extra scripts that should be run after all other
698 All scripts must be absolute path names.
701 The following variables are used by the standard scripts that reside in
702 .Pa /etc/periodic/security .
703 Those scripts are usually run from daily
704 .Pq Va daily_status_security_enable ,
706 .Pq Va weekly_status_security_enable ,
708 .Pq Va monthly_status_security_enable
712 of each script can be configured as
718 Note that when periodic security scripts are run from
720 they will be always run unless their
726 .Bl -tag -offset 4n -width 2n
727 .It Va security_status_diff_flags
729 Set to the arguments to pass to the
731 utility when generating differences.
734 .It Va security_status_chksetuid_enable
738 to compare the modes and modification times of setuid executables with
739 the previous day's values.
740 .It Va security_status_chksetuid_period
748 .It Va security_status_chkportsum_enable
752 to verify checksums of all installed packages against the known checksums in
754 .It Va security_status_chkportsum_period
762 .It Va security_status_neggrpperm_enable
766 to check for files where the group of a file has less permissions than
768 When users are in more than 14 supplemental groups these negative
769 permissions may not be enforced via NFS shares.
770 .It Va security_status_neggrpperm_period
778 .It Va security_status_chkmounts_enable
782 to check for changes mounted file systems to the previous day's values.
783 .It Va security_status_chkmounts_period
791 .It Va security_status_noamd
795 if you want to ignore
797 mounts when comparing against yesterday's file system mounts in the
798 .Va security_status_chkmounts_enable
800 .It Va security_status_chkuid0_enable
805 .Pa /etc/master.passwd
806 for accounts with UID 0.
807 .It Va security_status_chkuid0_period
815 .It Va security_status_passwdless_enable
820 .Pa /etc/master.passwd
821 for accounts with empty passwords.
822 .It Va security_status_passwdless_period
830 .It Va security_status_logincheck_enable
838 for more information.
839 .It Va security_status_logincheck_period
847 .It Va security_status_ipfwdenied_enable
851 to show log entries for packets denied by
853 since yesterday's check.
854 .It Va security_status_ipfwdenied_period
862 .It Va security_status_ipfdenied_enable
866 to show log entries for packets denied by
868 since yesterday's check.
869 .It Va security_status_ipfdenied_period
877 .It Va security_status_pfdenied_enable
881 to show log entries for packets denied by
883 since yesterday's check.
884 .It Va security_status_pfdenied_period
892 .It Va security_status_ipfwlimit_enable
898 rules that have reached their verbosity limit.
899 .It Va security_status_ipfwlimit_period
907 .It Va security_status_kernelmsg_enable
913 entries since yesterday's check.
914 .It Va security_status_kernelmsg_period
922 .It Va security_status_loginfail_enable
926 to display failed logins from
927 .Pa /var/log/messages
929 .It Va security_status_loginfail_period
937 .It Va security_status_tcpwrap_enable
941 to display connections denied by tcpwrappers (see
944 .Pa /var/log/messages
945 during the previous day.
946 .It Va security_status_tcpwrap_period
956 .Bl -tag -width ".Pa /etc/defaults/periodic.conf"
957 .It Pa /etc/defaults/periodic.conf
958 The default configuration file.
959 This file contains all default variables and values.
960 .It Pa /etc/periodic.conf
961 The usual system specific variable override file.
962 .It Pa /etc/periodic.conf.local
963 An additional override file, useful when
964 .Pa /etc/periodic.conf
965 is shared or distributed.
993 .An Brian Somers Aq Mt brian@Awfulhak.org