Implement periodic hammer2 snapshots.
[dragonfly.git] / share / man / man5 / periodic.conf.5
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: head/share/man/man5/periodic.conf.5 323550 2017-09-13 16:35:16Z gordon $
27 .\"
28 .Dd June 8, 2020
29 .Dt PERIODIC.CONF 5
30 .Os
31 .Sh NAME
32 .Nm periodic.conf
33 .Nd periodic job configuration information
34 .Sh DESCRIPTION
35 The file
36 .Nm
37 contains a description of how daily, weekly and monthly system maintenance
38 jobs should run.
39 It resides in the
40 .Pa /etc/defaults
41 directory and parts may be overridden by a file of the same name in
42 .Pa /etc ,
43 which itself may be overridden by the
44 .Pa /etc/periodic.conf.local
45 file.
46 .Pp
47 The
48 .Nm
49 file
50 is actually sourced as a shell script from each of the periodic scripts
51 and is intended to simply provide default configuration variables.
52 .Pp
53 The following variables are used by
54 .Xr periodic 8
55 itself:
56 .Bl -tag -offset 4n -width 2n
57 .It Va local_periodic
58 .Pq Vt str
59 List of directories to search for periodic scripts.
60 This list is always prefixed with
61 .Pa /etc/periodic ,
62 and is only used when an argument to
63 .Xr periodic 8
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
68 the directory
69 .Ar dir .
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.
74 .Pp
75 For an unattended machine, suitable values for
76 .Va daily_output ,
77 .Va weekly_output ,
78 and
79 .Va monthly_output
80 might be
81 .Dq Li /var/log/daily.log ,
82 .Dq Li /var/log/weekly.log ,
83 and
84 .Dq Li /var/log/monthly.log
85 respectively, as
86 .Xr newsyslog 8
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
91 .Pq Vt bool
92 These variables control whether
93 .Xr periodic 8
94 will mask the output of the executed scripts based on their return code
95 (where
96 .Ar dir
97 is the base directory name in which each script resides).
98 If the return code of a script is
99 .Sq 0
100 and
101 .Ao Ar dir Ac Ns Va _show_success
102 is set to
103 .Dq Li NO ,
104 .Xr periodic 8
105 will mask the script's output.
106 If the return code of a script is
107 .Sq 1
108 and
109 .Ao Ar dir Ac Ns Va _show_info
110 is set to
111 .Dq Li NO ,
112 .Xr periodic 8
113 will mask the script's output.
114 If the return code of a script is
115 .Sq 2
116 and
117 .Ao Ar dir Ac Ns Va _show_badconfig
118 is set to
119 .Dq Li NO ,
120 .Xr periodic 8
121 will mask the script's output.
122 If these variables are set to neither
123 .Dq Li YES
124 nor
125 .Dq Li NO ,
126 they default to
127 .Dq Li YES ,
128 .Dq Li YES
129 and
130 .Dq Li NO
131 respectively.
132 .Pp
133 Refer to the
134 .Xr periodic 8
135 manual page for how script return codes are interpreted.
136 .It Va anticongestion_sleeptime
137 .Pq Vt int
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.
140 .El
141 .Pp
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
146 .Pq Vt bool
147 Set to
148 .Dq Li YES
149 if you want to remove all files matching
150 .Va daily_clean_disks_files
151 daily.
152 .It Va daily_clean_disks_files
153 .Pq Vt str
154 Set to a list of file names to match.
155 Wild cards are permitted.
156 .It Va daily_clean_disks_days
157 .Pq Vt num
158 When
159 .Va daily_clean_disks_enable
160 is set to
161 .Dq Li YES ,
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
165 .Pq Vt bool
166 Set to
167 .Dq Li YES
168 if you want the removed files to be reported in your daily output.
169 .It Va daily_clean_tmps_enable
170 .Pq Vt bool
171 Set to
172 .Dq Li YES
173 if you want to clear temporary directories daily.
174 .It Va daily_clean_tmps_dirs
175 .Pq Vt str
176 Set to the list of directories to clear if
177 .Va daily_clean_tmps_enable
178 is set to
179 .Dq Li YES .
180 .It Va daily_clean_tmps_days
181 .Pq Vt num
182 When
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
187 .Pq Vt str
188 Set to the list of files that should not be deleted when
189 .Va daily_clean_tmps_enable
190 is set to
191 .Dq Li YES .
192 Wild card characters are permitted.
193 .It Va daily_clean_tmps_verbose
194 .Pq Vt bool
195 Set to
196 .Dq Li YES
197 if you want the removed files to be reported in your daily output.
198 .It Va daily_clean_preserve_enable
199 .Pq Vt bool
200 Set to
201 .Dq Li YES
202 if you wish to remove old files from
203 .Pa /var/preserve .
204 .It Va daily_clean_preserve_days
205 .Pq Vt num
206 Set to the number of days that files must not have been modified before
207 they are deleted.
208 .It Va daily_clean_preserve_verbose
209 .Pq Vt bool
210 Set to
211 .Dq Li YES
212 if you want the removed files to be reported in your daily output.
213 .It Va daily_clean_msgs_enable
214 .Pq Vt bool
215 Set to
216 .Dq Li YES
217 if you wish old system messages to be purged.
218 .It Va daily_clean_msgs_days
219 .Pq Vt num
220 Set to the number of days that files must not have been modified before
221 they are deleted.
222 If this variable is left blank, the
223 .Xr msgs 1
224 default is used.
225 .It Va daily_clean_rwho_enable
226 .Pq Vt bool
227 Set to
228 .Dq Li YES
229 if you wish old files in
230 .Pa /var/who
231 to be purged.
232 .It Va daily_clean_rwho_days
233 .Pq Vt num
234 Set to the number of days that files must not have been modified before
235 they are deleted.
236 .It Va daily_clean_rwho_verbose
237 .Pq Vt bool
238 Set to
239 .Dq Li YES
240 if you want the removed files to be reported in your daily output.
241 .It Va daily_clean_hoststat_enable
242 .Pq Vt bool
243 Set to
244 .Dq Li YES
245 to run
246 .Nm sendmail Fl bH
247 to automatically purge stale entries from
248 .Xr sendmail 8 Ns 's
249 host status cache.
250 Files will be deleted using the same criteria as
251 .Xr sendmail 8
252 would normally use when determining whether to believe the cached information,
253 as configured in
254 .Pa /etc/mail/sendmail.cf .
255 .It Va daily_clean_hammer_enable
256 .Pq Vt bool
257 Set to
258 .Dq Li YES
259 if you want
260 .Xr HAMMER 5
261 file systems to be snapshot, pruned and reblocked.
262 .It Va daily_clean_hammer_verbose
263 .Pq Vt bool
264 Set to
265 .Dq Li YES
266 if you wish more verbose output.
267 .It Va daily_clean_hammer_pfslist
268 .Pq Vt str
269 Set to a list of
270 .Xr HAMMER 5
271 filesystems and pseudo-filesystems to clean.
272 If this variable is left blank, the default
273 .Xr hammer 8
274 .Ic cleanup
275 actions occur.
276 .It Va daily_clean_hammer2_enable
277 .Pq Vt bool
278 Set to
279 .Dq Li YES
280 if you want
281 to run
282 .Xr hammer2 8
283 .Cm cleanup .
284 This will e.g.\&
285 .Ic bulkfree
286 .Xr hammer2 8
287 file systems.
288 .It Va daily_clean_hammer2_verbose
289 .Pq Vt bool
290 Set to
291 .Dq Li YES
292 if you wish more verbose output.
293 .It Va daily_clean_hammer2_pfslist
294 .Pq Vt str
295 Set to a list of
296 .Xr hammer2 8
297 filesystems and pseudo-filesystems to clean.
298 If this variable is left blank, the default
299 .Xr hammer2 8
300 .Ic cleanup
301 actions occur.
302 .It Va daily_backup_passwd_enable
303 .Pq Vt bool
304 Set to
305 .Dq Li YES
306 if you want the
307 .Pa /etc/master.passwd
308 and
309 .Pa /etc/group
310 files backed up and reported on.
311 Reporting consists of checking both files for modifications and running
312 .Xr chkgrp 8
313 on the
314 .Pa group
315 file.
316 .It Va daily_backup_aliases_enable
317 .Pq Vt bool
318 Set to
319 .Dq Li YES
320 if you want the
321 .Pa /etc/mail/aliases
322 file backed up and modifications to be displayed in your daily output.
323 .It Va daily_calendar_enable
324 .Pq Vt bool
325 Set to
326 .Dq Li YES
327 if you want to run
328 .Nm calendar Fl a
329 daily.
330 .It Va daily_accounting_enable
331 .Pq Vt bool
332 Set to
333 .Dq Li YES
334 if you want to rotate your daily accounting files.
335 No rotations are necessary unless
336 .Va accounting_enable
337 is enabled in
338 .Xr rc.conf 5 .
339 .It Va daily_accounting_compress
340 .Pq Vt bool
341 Set to
342 .Dq Li YES
343 if you want your daily accounting files to be compressed using
344 .Xr gzip 1 .
345 .It Va daily_accounting_save
346 .Pq Vt num
347 When
348 .Va daily_accounting_enable
349 is set, this may also be set to the number of daily accounting files that are
350 to be saved.
351 The default is
352 .Dq Li 3 .
353 .It Va daily_accounting_flags
354 .Pq Vt str
355 Set to the arguments to pass to the
356 .Xr sa 8
357 utility (in addition to
358 .Fl s )
359 when
360 .Va daily_accounting_enable
361 is set to
362 .Dq Li YES .
363 The default is
364 .Fl q .
365 .It Va daily_news_expire_enable
366 .Pq Vt bool
367 Set to
368 .Dq Li YES
369 if you want to run
370 .Pa /etc/news.expire .
371 .It Va daily_snapshot_hammer2_capacity
372 .Pq Vt num
373 Storage usage threshold, in percents. Snapshots won't be created once
374 used capacity exceeds this limit. Default is 90.
375 .It Va daily_snapshot_hammer2_dirs
376 .Pq Vt str
377 Space-separated list of directories on HAMMER2 filesystem(s) to snapshot.
378 Default is (a special keyword) "auto" which means snapshots will be created
379 for all currently mounted HAMMER2 volumes.
380 .It Va daily_snapshot_hammer2_enable
381 .Pq Vt bool
382 Set to
383 .Dq Li YES
384 if you want to create daily snapshots of directories on HAMMER2 filesystem(s).
385 .It Va daily_snapshot_hammer2_keep
386 .Pq Vt num or "auto"
387 Maximum number of daily snapshots to keep for each configured HAMMER2 directory.
388 If set to "auto", 15 is used as the initial value, but more snapshots can be
389 kept actually, according to free storage capacity.
390 .It Va daily_snapshot_hammer2_tag
391 .Pq Vt str
392 Tag to be used for daily snapshots labels. Default is "daily".
393 The actual label is then composed adhering to this pattern:
394 <path>.<flag>.<year><month><day>.<hour>:<minute>
395 .It Va daily_status_disks_enable
396 .Pq Vt bool
397 Set to
398 .Dq Li YES
399 if you want to run
400 .Xr df 1
401 (with the arguments supplied in
402 .Va daily_status_disks_df_flags )
403 and
404 .Nm dump Fl W .
405 .It Va daily_status_disks_df_flags
406 .Pq Vt str
407 Set to the arguments for the
408 .Xr df 1
409 utility when
410 .Va daily_status_disks_enable
411 is set to
412 .Dq Li YES .
413 .It Va daily_status_mfi_enable
414 .Pq Vt bool
415 Set to
416 .Dq Li YES
417 if you want to run
418 .Nm mfiutil Cm status
419 on your
420 .Xr mfi 4
421 devices.
422 .It Va daily_status_network_enable
423 .Pq Vt bool
424 Set to
425 .Dq Li YES
426 if you want to run
427 .Nm netstat Fl i .
428 .It Va daily_status_network_netstat_flags
429 .Pq Vt str
430 Set to additional arguments for the
431 .Xr netstat 1
432 utility when
433 .Va daily_status_network_enable
434 is set to
435 .Dq Li YES .
436 The default is
437 .Fl d .
438 .It Va daily_status_network_usedns
439 .Pq Vt bool
440 Set to
441 .Dq Li YES
442 if you want to run
443 .Xr netstat 1
444 without the
445 .Fl n
446 option (to do DNS lookups).
447 .It Va daily_status_uptime_enable
448 .Pq Vt bool
449 Set to
450 .Dq Li YES
451 if you want to run
452 .Xr uptime 1
453 (or
454 .Xr ruptime 1
455 if
456 .Va rwhod_enable
457 is set to
458 .Dq Li YES
459 in
460 .Pa /etc/rc.conf ) .
461 .It Va daily_status_mailq_enable
462 .Pq Vt bool
463 Set to
464 .Dq Li YES
465 if you want to run
466 .Xr mailq 1 .
467 .It Va daily_status_mailq_shorten
468 .Pq Vt bool
469 Set to
470 .Dq Li YES
471 if you want to shorten the
472 .Xr mailq 1
473 output when
474 .Va daily_status_mailq_enable
475 is set to
476 .Dq Li YES .
477 .It Va daily_status_include_submit_mailq
478 .Pq Vt bool
479 Set to
480 .Dq Li YES
481 if you also want to run
482 .Xr mailq 1
483 on the submit mail queue when
484 .Va daily_status_mailq_enable
485 is set to
486 .Dq Li YES .
487 This may not work with MTAs other than
488 .Xr sendmail 8 .
489 .It Va daily_status_security_enable
490 .Pq Vt bool
491 Set to
492 .Dq Li YES
493 if you want to run the security check.
494 The security check is another set of
495 .Xr periodic 8
496 scripts.
497 The system defaults are in
498 .Pa /etc/periodic/security .
499 Local scripts should be placed in
500 .Pa /usr/local/etc/periodic/security .
501 See the
502 .Xr periodic 8
503 manual page for more information.
504 .It Va daily_status_security_inline
505 .Pq Vt bool
506 Set to
507 .Dq Li YES
508 if you want the security check output inline.
509 The default is to either mail or log the output according to the value of
510 .Va daily_status_security_output .
511 .It Va daily_status_security_output
512 .Pq Vt str
513 Where to send the output of the security check if
514 .Va daily_status_security_inline
515 is set to
516 .Dq Li NO .
517 This variable behaves in the same way as the
518 .Va *_output
519 variables above, namely it can be set either to one or more email addresses
520 or to an absolute file name.
521 .It Va daily_status_mail_rejects_enable
522 .Pq Vt bool
523 Set to
524 .Dq Li YES
525 if you want to summarise mail rejections logged to
526 .Pa /var/log/maillog
527 for the previous day.
528 .It Va daily_status_mail_rejects_logs
529 .Pq Vt num
530 Set to the number of maillog files that should be checked
531 for yesterday's mail rejects.
532 .It Va daily_status_mail_rejects_shorten
533 .Pq Vt bool
534 Set to
535 .Dq Li YES
536 if you want to shorten the mail rejections output.
537 .It Va daily_queuerun_enable
538 .Pq Vt bool
539 Set to
540 .Dq Li YES
541 if you want to manually run the mail queue at least once a day.
542 .It Va daily_submit_queuerun
543 .Pq Vt bool
544 Set to
545 .Dq Li YES
546 if you also want to manually run the submit mail queue at least once a day
547 when
548 .Va daily_queuerun_enable
549 is set to
550 .Dq Li YES .
551 .It Va daily_local
552 .Pq Vt str
553 Set to a list of extra scripts that should be run after all other
554 daily scripts.
555 All scripts must be absolute path names.
556 .El
557 .Pp
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
562 .Pq Vt bool
563 Set to
564 .Dq Li YES
565 if you want to run
566 .Pa /usr/libexec/locate.updatedb .
567 This script is run using
568 .Nm nice Fl 5
569 as user
570 .Dq Li nobody ,
571 and generates the table used by the
572 .Xr locate 1
573 command.
574 .It Va weekly_whatis_enable
575 .Pq Vt bool
576 Set to
577 .Dq Li YES
578 if you want to run
579 .Pa /usr/libexec/makewhatis.local .
580 This script regenerates the database used by the
581 .Xr apropos 1
582 command.
583 .It Va weekly_noid_enable
584 .Pq Vt bool
585 Set to
586 .Dq Li YES
587 if you want to locate orphaned files on the system.
588 An orphaned file is one with an invalid owner or group.
589 .It Va weekly_noid_dirs
590 .Pq Vt str
591 A list of directories under which orphaned files are searched for.
592 This would usually be set to
593 .Pa / .
594 .It Va weekly_snapshot_hammer2_capacity
595 .Pq Vt num
596 Weekly counterpart of
597 .Va daily_snapshot_hammer2_capacity .
598 .It Va weekly_snapshot_hammer2_dirs
599 .Pq Vt str
600 Weekly counterpart of
601 .Va daily_snapshot_hammer2_dirs .
602 .It Va weekly_snapshot_hammer2_enable
603 .Pq Vt bool
604 Set to
605 .Dq Li YES
606 if you want to create weekly snapshots of directories on HAMMER2 filesystem(s).
607 .It Va weekly_snapshot_hammer2_keep
608 .Pq Vt num or "auto"
609 Weekly counterpart of
610 .Va daily_snapshot_hammer2_keep .
611 If set to "auto", 6 is used as the initial value.
612 .It Va weekly_snapshot_hammer2_tag
613 .Pq Vt str
614 Weekly counterpart of
615 .Va daily_snapshot_hammer2_tag .
616 Default is "weekly".
617 .It Va weekly_status_security_enable
618 .Pq Vt bool
619 Weekly counterpart of
620 .Va daily_status_security_enable .
621 .It Va weekly_status_security_inline
622 .Pq Vt bool
623 Weekly counterpart of
624 .Va daily_status_security_inline .
625 .It Va weekly_status_security_output
626 .Pq Vt str
627 Weekly counterpart of
628 .Va daily_status_security_output .
629 .It Va weekly_local
630 .Pq Vt str
631 Set to a list of extra scripts that should be run after all other
632 weekly scripts.
633 All scripts must be absolute path names.
634 .El
635 .Pp
636 The following variables are used by the standard scripts that reside in
637 .Pa /etc/periodic/monthly :
638 .Bl -tag -offset 4n -width 2n
639 .It Va monthly_accounting_enable
640 .Pq Vt bool
641 Set to
642 .Dq Li YES
643 if you want to do login accounting using the
644 .Xr ac 8
645 command.
646 .It Va monthly_snapshot_hammer2_capacity
647 .Pq Vt num
648 Monthly counterpart of
649 .Va daily_snapshot_hammer2_capacity .
650 .It Va monthly_snapshot_hammer2_dirs
651 .Pq Vt str
652 Monthly counterpart of
653 .Va daily_snapshot_hammer2_dirs .
654 .It Va monthly_snapshot_hammer2_enable
655 .Pq Vt bool
656 Set to
657 .Dq Li YES
658 if you want to create monthly snapshots of directories on HAMMER2 filesystem(s).
659 .It Va monthly_snapshot_hammer2_keep
660 .Pq Vt num or "auto"
661 Monthly counterpart of
662 .Va daily_snapshot_hammer2_keep .
663 If set to "auto", 12 is used as the initial value.
664 .It Va monthly_snapshot_hammer2_tag
665 .Pq Vt str
666 Monthly counterpart of
667 .Va daily_snapshot_hammer2_tag .
668 Default is "monthly".
669 .It Va monthly_status_security_enable
670 .Pq Vt bool
671 Monthly counterpart of
672 .Va daily_status_security_enable .
673 .It Va monthly_status_security_inline
674 .Pq Vt bool
675 Monthly counterpart of
676 .Va daily_status_security_inline .
677 .It Va monthly_status_security_output
678 .Pq Vt str
679 Monthly counterpart of
680 .Va daily_status_security_output .
681 .It Va monthly_local
682 .Pq Vt str
683 Set to a list of extra scripts that should be run after all other
684 monthly scripts.
685 All scripts must be absolute path names.
686 .El
687 .Pp
688 The following variables are used by the standard scripts that reside in
689 .Pa /etc/periodic/security .
690 Those scripts are usually run from daily
691 .Pq Va daily_status_security_enable ,
692 weekly
693 .Pq Va weekly_status_security_enable ,
694 and monthly
695 .Pq Va monthly_status_security_enable
696 periodic hooks.
697 The
698 .Va ..._period
699 of each script can be configured as
700 .Dq daily ,
701 .Dq weekly ,
702 .Dq monthly
703 or
704 .Dq NO .
705 Note that when periodic security scripts are run from
706 .Xr crontab 5 ,
707 they will be always run unless their
708 .Va ..._enable
709 or
710 .Va ..._period
711 variable is set to
712 .Dq NO .
713 .Bl -tag -offset 4n -width 2n
714 .It Va security_status_logdir
715 .Pq Vt str
716 The directory where the security scripts expect the system's log files.
717 The default is
718 .Pa /var/log .
719 .It Va security_status_diff_flags
720 .Pq Vt str
721 Set to the arguments to pass to the
722 .Xr diff 1
723 utility when generating differences.
724 The default is
725 .Fl b u .
726 .It Va security_status_chksetuid_enable
727 .Pq Vt bool
728 Set to
729 .Dq Li YES
730 to compare the modes and modification times of setuid executables with
731 the previous day's values.
732 .It Va security_status_chksetuid_period
733 .Pq Vt str
734 Set to either
735 .Dq Li daily ,
736 .Dq Li weekly ,
737 .Dq Li monthly
738 or
739 .Dq Li NO .
740 .It Va security_status_neggrpperm_enable
741 .Pq Vt bool
742 Set to
743 .Dq Li YES
744 to check for files where the group of a file has less permissions than
745 the world at large.
746 When users are in more than 14 supplemental groups these negative
747 permissions may not be enforced via NFS shares.
748 .It Va security_status_neggrpperm_period
749 .Pq Vt str
750 Set to either
751 .Dq Li daily ,
752 .Dq Li weekly ,
753 .Dq Li monthly
754 or
755 .Dq Li NO .
756 .It Va security_status_chkmounts_enable
757 .Pq Vt bool
758 Set to
759 .Dq Li YES
760 to check for changes mounted file systems to the previous day's values.
761 .It Va security_status_chkmounts_period
762 .Pq Vt str
763 Set to either
764 .Dq Li daily ,
765 .Dq Li weekly ,
766 .Dq Li monthly
767 or
768 .Dq Li NO .
769 .It Va security_status_nomfs
770 .Pq Vt bool
771 Set to
772 .Dq Li YES
773 if you want to ignore
774 .Xr mfs 8
775 mounts when comparing against yesterday's file system mounts in the
776 .Va security_status_chkmounts_enable
777 check.
778 .It Va security_status_chkuid0_enable
779 .Pq Vt bool
780 Set to
781 .Dq Li YES
782 to check
783 .Pa /etc/master.passwd
784 for accounts with UID 0.
785 .It Va security_status_chkuid0_period
786 .Pq Vt str
787 Set to either
788 .Dq Li daily ,
789 .Dq Li weekly ,
790 .Dq Li monthly
791 or
792 .Dq Li NO .
793 .It Va security_status_passwdless_enable
794 .Pq Vt bool
795 Set to
796 .Dq Li YES
797 to check
798 .Pa /etc/master.passwd
799 for accounts with empty passwords.
800 .It Va security_status_passwdless_period
801 .Pq Vt str
802 Set to either
803 .Dq Li daily ,
804 .Dq Li weekly ,
805 .Dq Li monthly
806 or
807 .Dq Li NO .
808 .It Va security_status_logincheck_enable
809 .Pq Vt bool
810 Set to
811 .Dq Li YES
812 to check
813 .Pa /etc/login.conf
814 ownership, see
815 .Xr login.conf 5
816 for more information.
817 .It Va security_status_logincheck_period
818 .Pq Vt str
819 Set to either
820 .Dq Li daily ,
821 .Dq Li weekly ,
822 .Dq Li monthly
823 or
824 .Dq Li NO .
825 .It Va security_status_ipfwdenied_enable
826 .Pq Vt bool
827 Set to
828 .Dq Li YES
829 to show log entries for packets denied by
830 .Xr ipfw 8
831 since yesterday's check.
832 .It Va security_status_ipfwdenied_period
833 .Pq Vt str
834 Set to either
835 .Dq Li daily ,
836 .Dq Li weekly ,
837 .Dq Li monthly
838 or
839 .Dq Li NO .
840 .It Va security_status_pfdenied_enable
841 .Pq Vt bool
842 Set to
843 .Dq Li YES
844 to show log entries for packets denied by
845 .Xr pf 4
846 since yesterday's check.
847 .It Va security_status_pfdenied_period
848 .Pq Vt str
849 Set to either
850 .Dq Li daily ,
851 .Dq Li weekly ,
852 .Dq Li monthly
853 or
854 .Dq Li NO .
855 .It Va security_status_ipfwlimit_enable
856 .Pq Vt bool
857 Set to
858 .Dq Li YES
859 to display
860 .Xr ipfw 8
861 rules that have reached their verbosity limit.
862 .It Va security_status_ipfwlimit_period
863 .Pq Vt str
864 Set to either
865 .Dq Li daily ,
866 .Dq Li weekly ,
867 .Dq Li monthly
868 or
869 .Dq Li NO .
870 .It Va security_status_ip6fwdenied_enable
871 .Pq Vt bool
872 Set to
873 .Dq Li YES
874 to show log entries for packets denied by
875 .Xr ip6fw 8
876 since yesterday's check.
877 .It Va security_status_ip6fwdenied_period
878 .Pq Vt str
879 Set to either
880 .Dq Li daily ,
881 .Dq Li weekly ,
882 .Dq Li monthly
883 or
884 .Dq Li NO .
885 .It Va security_status_ip6fwlimit_enable
886 .Pq Vt bool
887 Set to
888 .Dq Li YES
889 to display
890 .Xr ip6fw 8
891 rules that have reached their verbosity limit.
892 .It Va security_status_ip6fwlimit_period
893 .Pq Vt str
894 Set to either
895 .Dq Li daily ,
896 .Dq Li weekly ,
897 .Dq Li monthly
898 or
899 .Dq Li NO .
900 .It Va security_status_kernelmsg_enable
901 .Pq Vt bool
902 Set to
903 .Dq Li YES
904 to show new
905 .Xr dmesg 8
906 entries since yesterday's check.
907 .It Va security_status_kernelmsg_period
908 .Pq Vt str
909 Set to either
910 .Dq Li daily ,
911 .Dq Li weekly ,
912 .Dq Li monthly
913 or
914 .Dq Li NO .
915 .It Va security_status_loginfail_enable
916 .Pq Vt bool
917 Set to
918 .Dq Li YES
919 to display failed logins from
920 .Pa /var/log/messages
921 in the previous day.
922 .It Va security_status_loginfail_period
923 .Pq Vt str
924 Set to either
925 .Dq Li daily ,
926 .Dq Li weekly ,
927 .Dq Li monthly
928 or
929 .Dq Li NO .
930 .It Va security_status_tcpwrap_enable
931 .Pq Vt bool
932 Set to
933 .Dq Li YES
934 to display connections denied by tcpwrappers (see
935 .Xr hosts_access 5 )
936 from
937 .Pa /var/log/messages
938 during the previous day.
939 .It Va security_status_tcpwrap_period
940 .Pq Vt str
941 Set to either
942 .Dq Li daily ,
943 .Dq Li weekly ,
944 .Dq Li monthly
945 or
946 .Dq Li NO .
947 .El
948 .Sh FILES
949 .Bl -tag -width ".Pa /etc/defaults/periodic.conf"
950 .It Pa /etc/defaults/periodic.conf
951 The default configuration file.
952 This file contains all default variables and values.
953 .It Pa /etc/periodic.conf
954 The usual system specific variable override file.
955 .It Pa /etc/periodic.conf.local
956 An additional override file, useful when
957 .Pa /etc/periodic.conf
958 is shared or distributed.
959 .El
960 .Sh SEE ALSO
961 .Xr apropos 1 ,
962 .Xr calendar 1 ,
963 .Xr df 1 ,
964 .Xr diff 1 ,
965 .Xr gzip 1 ,
966 .Xr locate 1 ,
967 .Xr man 1 ,
968 .Xr msgs 1 ,
969 .Xr netstat 1 ,
970 .Xr nice 1 ,
971 .Xr HAMMER 5 ,
972 .Xr login.conf 5 ,
973 .Xr rc.conf 5 ,
974 .Xr ac 8 ,
975 .Xr chkgrp 8 ,
976 .Xr dump 8 ,
977 .Xr hammer 8 ,
978 .Xr hammer2 8 ,
979 .Xr mfs 8 ,
980 .Xr newsyslog 8 ,
981 .Xr periodic 8 ,
982 .Xr sendmail 8
983 .Sh HISTORY
984 The
985 .Nm
986 file appeared in
987 .Fx 4.1 .
988 .Sh AUTHORS
989 .An Brian Somers Aq Mt brian@Awfulhak.org