xref: /freebsd/share/man/man5/periodic.conf.5 (revision c03c5b1c)
1.\"-
2.\" Copyright (c) 2000 Brian Somers <brian@Awfulhak.org>
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
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.
13.\"
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
24.\" SUCH DAMAGE.
25.\"
26.\" $FreeBSD$
27.\"
28.Dd March 7, 2022
29.Dt PERIODIC.CONF 5
30.Os
31.Sh NAME
32.Nm periodic.conf
33.Nd periodic job configuration information
34.Sh DESCRIPTION
35The file
36.Nm
37contains a description of how daily, weekly and monthly system maintenance
38jobs should run.
39It resides in the
40.Pa /etc/defaults
41directory and parts may be overridden by a file of the same name in
42.Pa /etc ,
43which itself may be overridden by the
44.Pa /etc/periodic.conf.local
45file.
46.Pp
47The
48.Nm
49file
50is actually sourced as a shell script from each of the periodic scripts
51and is intended to simply provide default configuration variables.
52.Pp
53The following variables are used by
54.Xr periodic 8
55itself:
56.Bl -tag -offset 4n -width 2n
57.It Va local_periodic
58.Pq Vt str
59List of directories to search for periodic scripts.
60This list is always prefixed with
61.Pa /etc/periodic ,
62and is only used when an argument to
63.Xr periodic 8
64is not an absolute directory name.
65.It Ao Ar dir Ac Ns Va _output
66.Pq Vt path No or Vt list
67What to do with the output of the scripts executed from
68the directory
69.Ar dir .
70If this variable is set to an absolute path name, output is logged to
71that file, otherwise it is taken as one or more space separated email
72addresses and mailed to those users.
73If this variable is not set or is empty, output is sent to standard output.
74.Pp
75For an unattended machine, suitable values for
76.Va daily_output ,
77.Va weekly_output ,
78and
79.Va monthly_output
80might be
81.Dq Li /var/log/daily.log ,
82.Dq Li /var/log/weekly.log ,
83and
84.Dq Li /var/log/monthly.log
85respectively, as
86.Xr newsyslog 8
87will 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
91.Pq Vt bool
92These variables control whether
93.Xr periodic 8
94will mask the output of the executed scripts based on their return code
95(where
96.Ar dir
97is the base directory name in which each script resides).
98If the return code of a script is
99.Sq 0
100and
101.Ao Ar dir Ac Ns Va _show_success
102is set to
103.Dq Li NO ,
104.Xr periodic 8
105will mask the script's output.
106If the return code of a script is
107.Sq 1
108and
109.Ao Ar dir Ac Ns Va _show_info
110is set to
111.Dq Li NO ,
112.Xr periodic 8
113will mask the script's output.
114If the return code of a script is
115.Sq 2
116and
117.Ao Ar dir Ac Ns Va _show_badconfig
118is set to
119.Dq Li NO ,
120.Xr periodic 8
121will mask the script's output.
122If these variables are set to neither
123.Dq Li YES
124nor
125.Dq Li NO ,
126they default to
127.Dq Li YES ,
128.Dq Li YES
129and
130.Dq Li NO
131respectively.
132.Pp
133Refer to the
134.Xr periodic 8
135manual page for how script return codes are interpreted.
136.It Va anticongestion_sleeptime
137.Pq Vt int
138The maximum number of seconds to randomly sleep in order to smooth bursty loads
139on a shared resource, such as a download mirror.
140.El
141.Pp
142The 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
146.Pq Vt bool
147Set to
148.Dq Li YES
149if you want to remove all files matching
150.Va daily_clean_disks_files
151daily.
152.It Va daily_clean_disks_files
153.Pq Vt str
154Set to a list of file names to match.
155Wild cards are permitted.
156.It Va daily_clean_disks_days
157.Pq Vt num
158When
159.Va daily_clean_disks_enable
160is set to
161.Dq Li YES ,
162this must also be set to the number of days old that a file's access
163and modification times must be before it is deleted.
164.It Va daily_clean_disks_verbose
165.Pq Vt bool
166Set to
167.Dq Li YES
168if you want the removed files to be reported in your daily output.
169.It Va daily_clean_tmps_enable
170.Pq Vt bool
171Set to
172.Dq Li YES
173if you want to clear temporary directories daily.
174.It Va daily_clean_tmps_dirs
175.Pq Vt str
176Set to the list of directories to clear if
177.Va daily_clean_tmps_enable
178is set to
179.Dq Li YES .
180.It Va daily_clean_tmps_days
181.Pq Vt num
182When
183.Va daily_clean_tmps_enable
184is set, this must also be set to the number of days old that a file's access
185and modification times must be before it is deleted.
186.It Va daily_clean_tmps_ignore
187.Pq Vt str
188Set to the list of files that should not be deleted when
189.Va daily_clean_tmps_enable
190is set to
191.Dq Li YES .
192Wild card characters are permitted.
193.It Va daily_clean_tmps_verbose
194.Pq Vt bool
195Set to
196.Dq Li YES
197if you want the removed files to be reported in your daily output.
198.It Va daily_clean_preserve_enable
199.Pq Vt bool
200Set to
201.Dq Li YES
202if you wish to remove old files from
203.Pa /var/preserve .
204.It Va daily_clean_preserve_days
205.Pq Vt num
206Set to the number of days that files must not have been modified before
207they are deleted.
208.It Va daily_clean_preserve_verbose
209.Pq Vt bool
210Set to
211.Dq Li YES
212if you want the removed files to be reported in your daily output.
213.It Va daily_clean_msgs_enable
214.Pq Vt bool
215Set to
216.Dq Li YES
217if you wish old system messages to be purged.
218.It Va daily_clean_msgs_days
219.Pq Vt num
220Set to the number of days that files must not have been modified before
221they are deleted.
222If this variable is left blank, the
223.Xr msgs 1
224default is used.
225.It Va daily_clean_rwho_enable
226.Pq Vt bool
227Set to
228.Dq Li YES
229if you wish old files in
230.Pa /var/who
231to be purged.
232.It Va daily_clean_rwho_days
233.Pq Vt num
234Set to the number of days that files must not have been modified before
235they are deleted.
236.It Va daily_clean_rwho_verbose
237.Pq Vt bool
238Set to
239.Dq Li YES
240if you want the removed files to be reported in your daily output.
241.It Va daily_clean_hoststat_enable
242.Pq Vt bool
243Set to
244.Dq Li YES
245to run
246.Nm sendmail Fl bH
247to automatically purge stale entries from
248.Xr sendmail 8 Ns 's
249host status cache.
250Files will be deleted using the same criteria as
251.Xr sendmail 8
252would normally use when determining whether to believe the cached information,
253as configured in
254.Pa /etc/mail/sendmail.cf .
255.It Va daily_backup_efi_enable
256.Pq Vt bool
257Set to
258.Dq Li YES
259to create backup of EFI System Partition (ESP).
260.It Va daily_backup_gmirror_enable
261.Pq Vt bool
262Set to
263.Dq Li YES
264to create backup of gmirror information (i.e., output of
265.Nm gmirror Cm list ) ,
266see
267.Xr gmirror 8 .
268.It Va daily_backup_gmirror_verbose
269.Pq Vt bool
270Set to
271.Dq Li YES
272to report a diff between the new backup and the existing backup
273in the daily output.
274.It Va daily_backup_gpart_enable
275.Pq Vt bool
276Set to
277.Dq Li YES
278to create backups of partition tables, and bootcode partition contents.
279.It Va daily_backup_gpart_verbose
280.Pq Vt bool
281Set to
282.Dq Li YES
283to be verbose if existing backups for kern.geom.conftxt or the partition tables differ
284from the new backups.
285.It Va daily_backup_passwd_enable
286.Pq Vt bool
287Set to
288.Dq Li YES
289if you want the
290.Pa /etc/master.passwd
291and
292.Pa /etc/group
293files backed up and reported on.
294Reporting consists of checking both files for modifications and running
295.Xr chkgrp 8
296on the
297.Pa group
298file.
299.It Va daily_backup_aliases_enable
300.Pq Vt bool
301Set to
302.Dq Li YES
303if you want the
304.Pa /etc/mail/aliases
305file backed up and modifications to be displayed in your daily output.
306.It Va daily_backup_zfs_enable
307.Pq Vt bool
308Set to
309.Dq Li YES
310to create backup of the output generated from the
311.Xr zfs-list 8
312and
313.Xr zpool-list 8
314utilities.
315.It Va daily_backup_zfs_list_flags
316.Pq Vt str
317Set to the arguments for the
318.Xr zfs-list 8
319utility.
320The default is standard behavior.
321.It Va daily_backup_zpool_list_flags
322.Pq Vt str
323Set to the arguments for the
324.Xr zpool-list 8
325utility.
326The default is
327.Fl v .
328.It Va daily_backup_zfs_props_enable
329.Pq Vt bool
330Set to
331.Dq Li YES
332to create backup of the output generated from the
333.Xr zfs-get 8
334and
335.Xr zpool-get 8
336utilities.
337.It Va daily_backup_zfs_get_flags
338.Pq Vt str
339Set to the arguments for the
340.Xr zfs-get 8
341utility.
342The default is
343.Cm all .
344.It Va daily_backup_zpool_get_flags
345.Pq Vt str
346Set to the arguments for the
347.Xr zpool-get 8
348utility.
349The default is
350.Cm all .
351.It Va daily_backup_zfs_verbose
352.Pq Vt bool
353Set to
354.Dq Li YES
355to report a diff between the new backup and the existing backup
356in the daily output.
357.It Va daily_calendar_enable
358.Pq Vt bool
359Set to
360.Dq Li YES
361if you want to run
362.Nm calendar Fl a
363daily.
364.It Va daily_accounting_enable
365.Pq Vt bool
366Set to
367.Dq Li YES
368if you want to rotate your daily process accounting files.
369No rotations are necessary unless
370.Va accounting_enable
371is enabled in
372.Xr rc.conf 5 .
373.It Va daily_accounting_compress
374.Pq Vt bool
375Set to
376.Dq Li YES
377if you want your daily accounting files to be compressed using
378.Xr gzip 1 .
379.It Va daily_accounting_save
380.Pq Vt num
381When
382.Va daily_accounting_enable
383is set, this may also be set to the number of daily accounting files that are
384to be saved.
385The default is
386.Dq Li 3 .
387.It Va daily_accounting_flags
388.Pq Vt str
389Set to the arguments to pass to the
390.Xr sa 8
391utility (in addition to
392.Fl s )
393when
394.Va daily_accounting_enable
395is set to
396.Dq Li YES .
397The default is
398.Fl q .
399.It Va daily_status_disks_enable
400.Pq Vt bool
401Set to
402.Dq Li YES
403if you want to run
404.Xr df 1
405(with the arguments supplied in
406.Va daily_status_disks_df_flags )
407and
408.Nm dump Fl W .
409.It Va daily_status_disks_df_flags
410.Pq Vt str
411Set to the arguments for the
412.Xr df 1
413utility when
414.Va daily_status_disks_enable
415is set to
416.Dq Li YES .
417The default is
418.Fl l Fl h .
419.It Va daily_status_zfs_enable
420.Pq Vt bool
421Set to
422.Dq Li YES
423if you want to run
424.Nm zpool Cm status
425on your
426.Xr zfs 8
427pools.
428.It Va daily_status_zfs_zpool_list_enable
429.Pq Vt bool
430Set to
431.Dq Li YES
432if you want to run
433.Nm zpool Cm list
434on your
435.Xr zfs 8
436pools.
437Requires
438.Va daily_status_zfs_enable
439to be set to
440.Li YES .
441.It Va daily_status_gmirror_enable
442.Pq Vt bool
443Set to
444.Dq Li YES
445if you want to run
446.Nm gmirror Cm status
447on your
448.Xr gmirror 8
449devices.
450.It Va daily_status_graid3_enable
451.Pq Vt bool
452Set to
453.Dq Li YES
454if you want to run
455.Nm graid3 Cm status
456on your
457.Xr graid3 8
458devices.
459.It Va daily_status_gstripe_enable
460.Pq Vt bool
461Set to
462.Dq Li YES
463if you want to run
464.Nm gstripe Cm status
465on your
466.Xr gstripe 8
467devices.
468.It Va daily_status_gconcat_enable
469.Pq Vt bool
470Set to
471.Dq Li YES
472if you want to run
473.Nm gconcat Cm status
474on your
475.Xr gconcat 8
476devices.
477.It Va daily_status_mfi_enable
478.Pq Vt bool
479Set to
480.Dq Li YES
481if you want to run
482.Nm mfiutil Cm status
483on your
484.Xr mfi 4
485devices.
486.It Va daily_status_network_enable
487.Pq Vt bool
488Set to
489.Dq Li YES
490if you want to run
491.Nm netstat Fl i .
492.It Va daily_status_network_netstat_flags
493.Pq Vt str
494Set to additional arguments for the
495.Xr netstat 1
496utility when
497.Va daily_status_network_enable
498is set to
499.Dq Li YES .
500The default is
501.Fl d W .
502.It Va daily_status_network_usedns
503.Pq Vt bool
504Set to
505.Dq Li YES
506if you want to run
507.Xr netstat 1
508without the
509.Fl n
510option (to do DNS lookups).
511.It Va daily_status_uptime_enable
512.Pq Vt bool
513Set to
514.Dq Li YES
515if you want to run
516.Xr uptime 1
517(or
518.Xr ruptime 1
519if
520.Va rwhod_enable
521is set to
522.Dq Li YES
523in
524.Pa /etc/rc.conf ) .
525.It Va daily_status_mailq_enable
526.Pq Vt bool
527Set to
528.Dq Li YES
529if you want to run
530.Xr mailq 1 .
531.It Va daily_status_mailq_shorten
532.Pq Vt bool
533Set to
534.Dq Li YES
535if you want to shorten the
536.Xr mailq 1
537output when
538.Va daily_status_mailq_enable
539is set to
540.Dq Li YES .
541.It Va daily_status_include_submit_mailq
542.Pq Vt bool
543Set to
544.Dq Li YES
545if you also want to run
546.Xr mailq 1
547on the submit mail queue when
548.Va daily_status_mailq_enable
549is set to
550.Dq Li YES .
551This may not work with MTAs other than
552.Xr sendmail 8 .
553.It Va daily_status_security_enable
554.Pq Vt bool
555Set to
556.Dq Li YES
557if you want to run the security check.
558The security check is another set of
559.Xr periodic 8
560scripts.
561The system defaults are in
562.Pa /etc/periodic/security .
563Local scripts should be placed in
564.Pa /usr/local/etc/periodic/security .
565See the
566.Xr periodic 8
567manual page for more information.
568.It Va daily_status_security_inline
569.Pq Vt bool
570Set to
571.Dq Li YES
572if you want the security check output inline.
573The default is to either mail or log the output according to the value of
574.Va daily_status_security_output .
575.It Va daily_status_security_output
576.Pq Vt str
577Where to send the output of the security check if
578.Va daily_status_security_inline
579is set to
580.Dq Li NO .
581This variable behaves in the same way as the
582.Va *_output
583variables above, namely it can be set either to one or more email addresses
584or to an absolute file name.
585.It Va daily_status_mail_rejects_enable
586.Pq Vt bool
587Set to
588.Dq Li YES
589if you want to summarise mail rejections logged to
590.Pa /var/log/maillog
591for the previous day.
592.It Va daily_status_mail_rejects_logs
593.Pq Vt num
594Set to the number of maillog files that should be checked
595for yesterday's mail rejects.
596.It Va daily_status_ntpd_enable
597.Pq Vt bool
598Set to
599.Dq Li YES
600if you want to enable NTP status check.
601.It Va daily_status_world_kernel
602.Pq Vt bool
603Set to
604.Dq Li YES
605to check the running userland and kernel are in sync.
606.It Va daily_queuerun_enable
607.Pq Vt bool
608Set to
609.Dq Li YES
610if you want to manually run the mail queue at least once a day.
611.It Va daily_submit_queuerun
612.Pq Vt bool
613Set to
614.Dq Li YES
615if you also want to manually run the submit mail queue at least once a day
616when
617.Va daily_queuerun_enable
618is set to
619.Dq Li YES .
620.It Va daily_scrub_zfs_enable
621.Pq Vt bool
622Set to
623.Dq Li YES
624if you want to run a zfs scrub periodically.
625.It Va daily_scrub_zfs_pools
626.Pq Vt str
627A space separated list of names of zfs pools to scrub.
628If the list is empty or not set, all zfs pools are scrubbed.
629.It Va daily_scrub_zfs_default_threshold
630.Pq Vt int
631Number of days between a scrub if no pool-specific threshold is set.
632If not set, the default value is 35, corresponding to 5 weeks.
633.It Va daily_scrub_zfs_ Ns Ao Ar poolname Ac Ns Va _threshold
634.Pq Vt int
635The same as
636.Va daily_scrub_zfs_default_threshold
637but specific to the pool
638.Ao Ar poolname Ac Ns .
639.It Va daily_local
640.Pq Vt str
641Set to a list of extra scripts that should be run after all other
642daily scripts.
643All scripts must be absolute path names.
644.El
645.Pp
646The following variables are used by the standard scripts that reside in
647.Pa /etc/periodic/weekly :
648.Bl -tag -offset 4n -width 2n
649.It Va weekly_locate_enable
650.Pq Vt bool
651Set to
652.Dq Li YES
653if you want to run
654.Pa /usr/libexec/locate.updatedb .
655This script is run using
656.Nm nice Fl 5
657as user
658.Dq Li nobody ,
659and generates the table used by the
660.Xr locate 1
661command.
662.It Va weekly_whatis_enable
663.Pq Vt bool
664Set to
665.Dq Li YES
666if you want to run
667.Pa /usr/libexec/makewhatis.local .
668This script regenerates the database used by the
669.Xr apropos 1
670command.
671.It Va weekly_noid_enable
672.Pq Vt bool
673Set to
674.Dq Li YES
675if you want to locate orphaned files on the system.
676An orphaned file is one with an invalid owner or group.
677.It Va weekly_noid_dirs
678.Pq Vt str
679A list of directories under which orphaned files are searched for.
680This would usually be set to
681.Pa / .
682.It Va weekly_status_security_enable
683.Pq Vt bool
684Weekly counterpart of
685.Va daily_status_security_enable .
686.It Va weekly_status_security_inline
687.Pq Vt bool
688Weekly counterpart of
689.Va daily_status_security_inline .
690.It Va weekly_status_security_output
691.Pq Vt str
692Weekly counterpart of
693.Va daily_status_security_output .
694.It Va weekly_status_pkg_enable
695.Pq Vt bool
696Set to
697.Dq Li YES
698if you want to use
699.Xr pkg-version 8
700to list installed packages which are out of date.
701.It Va pkg_version
702.Pq Vt str
703When
704.Va weekly_status_pkg_enable
705is set to
706.Dq Li YES ,
707this variable specifies the program that is used to determine the out of
708date packages.
709If unset, the
710.Xr pkg-version 8
711program is used.
712As an example, this variable might be set to
713.Dq Li portversion
714if the
715.Pa ports/sysutils/portupgrade
716port has been installed.
717.It Va pkg_version_index
718.Pq Vt str
719This variable specifies the
720.Pa INDEX
721file from
722.Pa /usr/ports
723that should be used by
724.Xr pkg-version 8 .
725Because the dependency tree may be substantially different between versions of
726.Fx ,
727there may be more than one
728.Pa INDEX
729file in
730.Pa /usr/ports .
731.Pp
732Note, if the
733.Va pkg_version
734variable is set to
735.Dq Li portversion ,
736it will also be necessary to arrange that the correct
737.Pa INDEX
738file is specified
739using environment variables and that
740.Va pkg_version_index
741is cleared in
742.Pa /etc/periodic.conf
743.Pq Dq Li pkg_version_index= .
744.It Va weekly_local
745.Pq Vt str
746Set to a list of extra scripts that should be run after all other
747weekly scripts.
748All scripts must be absolute path names.
749.El
750.Pp
751The following variables are used by the standard scripts that reside in
752.Pa /etc/periodic/monthly :
753.Bl -tag -offset 4n -width 2n
754.It Va monthly_accounting_enable
755.Pq Vt bool
756Set to
757.Dq Li YES
758if you want to do login accounting using the
759.Xr ac 8
760command.
761.It Va monthly_status_security_enable
762.Pq Vt bool
763Monthly counterpart of
764.Va daily_status_security_enable .
765.It Va monthly_status_security_inline
766.Pq Vt bool
767Monthly counterpart of
768.Va daily_status_security_inline .
769.It Va monthly_status_security_output
770.Pq Vt str
771Monthly counterpart of
772.Va daily_status_security_output .
773.It Va monthly_local
774.Pq Vt str
775Set to a list of extra scripts that should be run after all other
776monthly scripts.
777All scripts must be absolute path names.
778.El
779.Pp
780The following variables are used by the standard scripts that reside in
781.Pa /etc/periodic/security .
782Those scripts are usually run from daily
783.Pq Va daily_status_security_enable ,
784weekly
785.Pq Va weekly_status_security_enable ,
786and monthly
787.Pq Va monthly_status_security_enable
788periodic hooks.
789The
790.Va ..._period
791of each script can be configured as
792.Dq daily ,
793.Dq weekly ,
794.Dq monthly
795or
796.Dq NO .
797Note that when periodic security scripts are run from
798.Xr crontab 5 ,
799they will be always run unless their
800.Va ..._enable
801or
802.Va ..._period
803variable is set to
804.Dq NO .
805.Bl -tag -offset 4n -width 2n
806.It Va security_status_diff_flags
807.Pq Vt str
808Set to the arguments to pass to the
809.Xr diff 1
810utility when generating differences.
811The default is
812.Fl b u .
813.It Va security_status_chksetuid_enable
814.Pq Vt bool
815Set to
816.Dq Li YES
817to compare the modes and modification times of setuid executables with
818the previous day's values.
819.It Va security_status_chksetuid_period
820.Pq Vt str
821Set to either
822.Dq Li daily ,
823.Dq Li weekly ,
824.Dq Li monthly
825or
826.Dq Li NO .
827.It Va security_status_chkportsum_enable
828.Pq Vt bool
829Set to
830.Dq Li YES
831to verify checksums of all installed packages against the known checksums in
832.Pa /var/db/pkg .
833.It Va security_status_chkportsum_period
834.Pq Vt str
835Set to either
836.Dq Li daily ,
837.Dq Li weekly ,
838.Dq Li monthly
839or
840.Dq Li NO .
841.It Va security_status_neggrpperm_enable
842.Pq Vt bool
843Set to
844.Dq Li YES
845to check for files where the group of a file has less permissions than
846the world at large.
847When users are in more than 14 supplemental groups these negative
848permissions may not be enforced via NFS shares.
849.It Va security_status_neggrpperm_period
850.Pq Vt str
851Set to either
852.Dq Li daily ,
853.Dq Li weekly ,
854.Dq Li monthly
855or
856.Dq Li NO .
857.It Va security_status_chkmounts_enable
858.Pq Vt bool
859Set to
860.Dq Li YES
861to check for changes mounted file systems to the previous day's values.
862.It Va security_status_chkmounts_period
863.Pq Vt str
864Set to either
865.Dq Li daily ,
866.Dq Li weekly ,
867.Dq Li monthly
868or
869.Dq Li NO .
870.It Va security_status_noamd
871.Pq Vt bool
872Set to
873.Dq Li YES
874if you want to ignore
875.Xr amd 8
876mounts when comparing against yesterday's file system mounts in the
877.Va security_status_chkmounts_enable
878check.
879.It Va security_status_chkuid0_enable
880.Pq Vt bool
881Set to
882.Dq Li YES
883to check
884.Pa /etc/master.passwd
885for accounts with UID 0.
886.It Va security_status_chkuid0_period
887.Pq Vt str
888Set to either
889.Dq Li daily ,
890.Dq Li weekly ,
891.Dq Li monthly
892or
893.Dq Li NO .
894.It Va security_status_passwdless_enable
895.Pq Vt bool
896Set to
897.Dq Li YES
898to check
899.Pa /etc/master.passwd
900for accounts with empty passwords.
901.It Va security_status_passwdless_period
902.Pq Vt str
903Set to either
904.Dq Li daily ,
905.Dq Li weekly ,
906.Dq Li monthly
907or
908.Dq Li NO .
909.It Va security_status_logincheck_enable
910.Pq Vt bool
911Set to
912.Dq Li YES
913to check
914.Pa /etc/login.conf
915ownership, see
916.Xr login.conf 5
917for more information.
918.It Va security_status_logincheck_period
919.Pq Vt str
920Set to either
921.Dq Li daily ,
922.Dq Li weekly ,
923.Dq Li monthly
924or
925.Dq Li NO .
926.It Va security_status_ipfwdenied_enable
927.Pq Vt bool
928Set to
929.Dq Li YES
930to show log entries for packets denied by
931.Xr ipfw 8
932since yesterday's check.
933.It Va security_status_ipfwdenied_period
934.Pq Vt str
935Set to either
936.Dq Li daily ,
937.Dq Li weekly ,
938.Dq Li monthly
939or
940.Dq Li NO .
941.It Va security_status_ipfdenied_enable
942.Pq Vt bool
943Set to
944.Dq Li YES
945to show log entries for packets denied by
946.Xr ipf 8
947since yesterday's check.
948.It Va security_status_ipfdenied_period
949.Pq Vt str
950Set to either
951.Dq Li daily ,
952.Dq Li weekly ,
953.Dq Li monthly
954or
955.Dq Li NO .
956.It Va security_status_pfdenied_enable
957.Pq Vt bool
958Set to
959.Dq Li YES
960to show log entries for packets denied by
961.Xr pf 4
962since yesterday's check.
963.It Va security_status_pfdenied_period
964.Pq Vt str
965Set to either
966.Dq Li daily ,
967.Dq Li weekly ,
968.Dq Li monthly
969or
970.Dq Li NO .
971.It Va security_status_ipfwlimit_enable
972.Pq Vt bool
973Set to
974.Dq Li YES
975to display
976.Xr ipfw 8
977rules that have reached their verbosity limit.
978.It Va security_status_ipfwlimit_period
979.Pq Vt str
980Set to either
981.Dq Li daily ,
982.Dq Li weekly ,
983.Dq Li monthly
984or
985.Dq Li NO .
986.It Va security_status_kernelmsg_enable
987.Pq Vt bool
988Set to
989.Dq Li YES
990to show new
991.Xr dmesg 8
992entries since yesterday's check.
993.It Va security_status_kernelmsg_period
994.Pq Vt str
995Set to either
996.Dq Li daily ,
997.Dq Li weekly ,
998.Dq Li monthly
999or
1000.Dq Li NO .
1001.It Va security_status_loginfail_enable
1002.Pq Vt bool
1003Set to
1004.Dq Li YES
1005to display failed logins from
1006.Pa /var/log/messages
1007in the previous day.
1008.It Va security_status_loginfail_period
1009.Pq Vt str
1010Set to either
1011.Dq Li daily ,
1012.Dq Li weekly ,
1013.Dq Li monthly
1014or
1015.Dq Li NO .
1016.It Va security_status_tcpwrap_enable
1017.Pq Vt bool
1018Set to
1019.Dq Li YES
1020to display connections denied by tcpwrappers (see
1021.Xr hosts_access 5 )
1022from
1023.Pa /var/log/messages
1024during the previous day.
1025.It Va security_status_tcpwrap_period
1026.Pq Vt str
1027Set to either
1028.Dq Li daily ,
1029.Dq Li weekly ,
1030.Dq Li monthly
1031or
1032.Dq Li NO .
1033.El
1034.Sh FILES
1035.Bl -tag -width ".Pa /etc/defaults/periodic.conf"
1036.It Pa /etc/defaults/periodic.conf
1037The default configuration file.
1038This file contains all default variables and values.
1039.It Pa /etc/periodic.conf
1040The usual system specific variable override file.
1041.It Pa /etc/periodic.conf.local
1042An additional override file, useful when
1043.Pa /etc/periodic.conf
1044is shared or distributed.
1045.El
1046.Sh SEE ALSO
1047.Xr apropos 1 ,
1048.Xr calendar 1 ,
1049.Xr df 1 ,
1050.Xr diff 1 ,
1051.Xr gzip 1 ,
1052.Xr locate 1 ,
1053.Xr man 1 ,
1054.Xr msgs 1 ,
1055.Xr netstat 1 ,
1056.Xr nice 1 ,
1057.Xr login.conf 5 ,
1058.Xr rc.conf 5 ,
1059.Xr ac 8 ,
1060.Xr chkgrp 8 ,
1061.Xr dump 8 ,
1062.Xr newsyslog 8 ,
1063.Xr periodic 8 ,
1064.Xr pkg-version 8 ,
1065.Xr sendmail 8
1066.Sh HISTORY
1067The
1068.Nm
1069file appeared in
1070.Fx 4.1 .
1071.Sh AUTHORS
1072.An Brian Somers Aq Mt brian@Awfulhak.org
1073