donutsd(1)

1DONUTSD(1)            User Contributed Perl Documentation           DONUTSD(1)
2
3
4

NAME

6       donutsd - Run the donuts syntax checker periodically and report the
7       results to an administrator
8

SYNOPSIS

10         donutsd [-z FREQ] [-t TMPDIR] [-f FROM] [-s SMTPSERVER] [-a DONUTSARGS]
11                 [-x] [-v] [-i zonelistfile] [ZONEFILE ZONENAME ZONECONTACT]
12

DESCRIPTION

14       donutsd runs donuts on a set of zone files every so often (the
15       frequency is specified by the -z flag which defaults to 24 hours) and
16       watches for changes in the results.  These changes may be due to the
17       time-sensitive nature of DNSSEC-related records (e.g., RRSIG validity
18       periods) or because parent/child relationships have changed.  If any
19       changes have occurred in the output since the last run of donuts on a
20       particular zone file, the results are emailed to the specified zone
21       administrator's email address.
22

OPTIONS

24       -v  Turns on more verbose output.
25
26       -o  Run once and quit, as opposed to sleeping or re-running forever.
27
28       -a ARGUMENTS
29           Specifies command line arguments to be passed to donuts executions.
30
31       -z TIME
32           Sleeps TIME seconds between calls to donuts.  The DNSSEC-Tools
33           timetrans program can be used to convert from large time units
34           (e.g., weeks and days) to seconds.
35
36       -e ADDRESS
37           Mail ADDRESS with a summary of the results from all the files.
38           These are the last few lines of the donuts output for each zone
39           that details the number of errors found.
40
41       -s SMTPSERVER
42           When sending mail, send it to the SMTPSERVER specified.  The
43           default is localhost.
44
45       -f FROMADDR
46           When sending mail, use FROMADDR for the From: address.
47
48       -x  Send the diff output in the email message as well as the donuts
49           output.
50
51       -t TMPDIR
52           Store temporary files in TMPDIR.
53
54       -i INPUTZONES
55           See the next section details.
56

ZONE ARGUMENTS

58       The rest of the arguments to donutsd should be triplets of the
59       following information:
60
61       ZONEFILE
62           The zone file to examine.
63
64       ZONENAME
65           The zonename that file is supposed to be defining.
66
67       ZONECONTACT
68           An email address of the zone administrator (or a comma-separated
69           list of addresses.)  The results will be sent to this email
70           address.
71
72       Additionally, instead of listing all the zones you wish to monitor on
73       the command line, you can use the -i flag which specifies a file to be
74       read listing the TRIPLES instead.  Each line in this file should
75       contain one triple with white-space separating the arguments.
76
77       Example:
78
79          db.zonefile1.com   zone1.com   admin@zone1.com
80          db.zonefile2.com   zone2.com   admin@zone2.com,admin2@zone2.com
81
82       For even more control, you can specify an XML file (whose name must end
83       in .xml) that describes the same information.  This also allows for
84       per-zone customization of the donuts arguments.  The XML::Smart Perl
85       module must be installed in order to use this feature.
86
87        <donutsd>
88          <zones>
89           <zone>
90             <file>db.example.com</file>
91             <name>example.com</name>
92             <contact>admin@example.com</contact>
93             <!-- this is not a signed zone therefore we'll
94                  add these args so we don't display DNSSEC errors -->
95             <donutsargs>-i DNSSEC</donutsargs>
96           </zone>
97          </zones>
98        </donutsd>
99
100       The donutsd tree may also contain a configs section where command-line
101       flags can be specified:
102
103        <donutsd>
104         <configs>
105          <config><flag>a</flag><value>--features live --level 8</value></config>
106          <config><flag>e</flag><value>wes@example.com</value></config>
107         </configs>
108         <zones>
109          ...
110         </zones>
111        </donutsd>
112
113       Real command line flags will be used in preference to those specified
114       in the .xml file, however.
115

EXAMPLE

117         donutsd -a "--features live --level 8" -f root@example.com \
118            db.example.com example.com admin@example.com
119

COPYRIGHT

121       Copyright 2005-2013 SPARTA, Inc.  All rights reserved.  See the COPYING
122       file included with the DNSSEC-Tools package for details.
123

AUTHOR

125       Wes Hardaker <hardaker@users.sourceforge.net>
126