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

NAME

6       Net::DNS::SEC::Tools::dnssectools - General routines for the
7       DNSSEC-Tools package.
8

SYNOPSIS

10         use Net::DNS::SEC::Tools::dnssectools;
11
12         dt_adminmail($subject,$msgbody,$recipient);
13
14         $zspath = dt_cmdpath('zonesigner');
15
16         $ftype = dt_findtype($path);
17

DESCRIPTION

19       The dnssectools module provides a general set of methods for use with
20       DNSSEC-Tools utilities.
21

INTERFACES

23       The interfaces to the dnssectools module are given below.
24
25       dt_adminmail(subject,msgbody,recipient)
26           This routine emails a message to the administrative user listed in
27           the DNSSEC-Tools configuration file.
28
29           dt_adminmail() requires two parameters, both scalars.  The subject
30           parameter is the subject for the mail message.  The msgbody
31           parameter is the body of the mail message.
32
33           A third parameter, recipient, may be given to specify the message's
34           recipient.  If this is not given, then the recipient will be taken
35           from the admin-email record of the DNSSEC-Tools configuration file.
36           If recipient is "nomail", then no message will be sent and success
37           will be returned.
38
39           Return values:
40
41                   1 - the message was created and sent.
42                   0 - an invalid recipient was specified.
43
44           It relies on the the following dnssec-tools.conf configuration
45           parameters:
46
47           admin-email
48               The email address that the mail should come from.
49
50           mailer-type
51               Should be one of: sendmail, smtp, qmail.  This option is not
52               required and will default to trying sendmail and qmail to
53               deliever the mail.  If mailer-server is set to a defined value
54               but mailer-type is not, then mailer-type will default to
55
56           mailer-server
57               The server, if admin-mail is set to smtp, that the mail should
58               be delivered to.
59
60           dt_cmdpath(command)
61               This routine returns the path to a specified DNSSEC-Tools
62               command.  command should be the name only, without any leading
63               directories.  The command name is checked to ensure that it is
64               a valid DNSEC-Tools command,
65
66               Return values:
67
68                       The absolute path to the command is returned if the command
69                       is valid.
70                       Null is returned if the command is not valid.
71
72           dt_filetype(path)
73               This routine returns the type of the file named in path.  The
74               rollrec and keyrec records contained therein are counted and a
75               type determination is made.
76
77               Return values:
78
79                       "keyrec" -  At least one keyrec record was found and no
80                                   rollrec records were found.
81
82                       "rollrec" - At least one rollrec record was found and
83                                   no keyrec records were found.
84
85                       "mixed" -   At least one rollrec record and at least one
86                                   keyrec record were found.
87                                   This is most likely an erroneous file.
88
89                       "unknown" - No rollrec records nor keyrec records
90                                   were found.
91
92                       "nofile"  - The specified file does not exist.
93

95       Copyright 2006-2011 SPARTA, Inc.  All rights reserved.  See the COPYING
96       file included with the DNSSEC-Tools package for details.
97

AUTHOR

99       Wayne Morrison, tewok@users.sourceforge.net
100

SEE ALSO

102       Mail::Send.pm(3), Net::DNS::SEC::Tools::conf.pm(3)
103

POD ERRORS

105       Hey! The above document had some coding errors, which are explained
106       below:
107
108       Around line 353:
109           You forgot a '=back' before '=head1'
110
111
112
113perl v5.12.4                      2011-03-23                    dnssectools(3)
Impressum