summaryrefslogtreecommitdiff
path: root/man/knsupdate.1.in
blob: 847475bee71b33f54acac8fca912c884df194f97 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
.TH "knsupdate" "1" "April 2013" "CZ.NIC Labs" "Knot DNS, version @VERSION@"
.SH NAME
.TP 10
.B knsupdate
\- Dynamic DNS update utility (libknot equivalent of ISC nsupdate)
.SH SYNOPSIS
.B knsupdate
[\fIoptions\fR] [\fIfilename\fR]

.SH DESCRIPTION

The utility sends Dynamic DNS update message to DNS server. Update content is
read from a file (if the parameter \fIfilename\fR is given) or from standard
input. The format of the update is described in \fBINPUT FORMAT\fR section.

.SH OPTIONS
.TP 4
.BI -d
Enable debugging messages.
.TP
.BI -v
Use TCP protocol instead of the default UDP.
.TP
.BI -p \ port
Set the port to use when connecting to server and the port was not explicitly
specified in the update. The default is 53.
.TP
.BI -t \ timeout
The timeout of the update request in seconds. The default is 12. If set to
zero, the timeout is infinite.
.TP
.BI -r \ retries
The number of retries for UDP requests. The default is 3. Partial timeout for
each try is computed from total timeout (option \fB-t\fR).
.TP
.BI -k \ keyfile
Use TSIG or SIG\-0 key stored in file to authenticate the request. The tool
supports keys generated by ISC \fBdnssec\-keygen\fR. The key comprises of
public (.key extension) and private part (.private extension). Either of these
file names or a name without the extension can be specified as \fIkeyfile\fR
parameter.

.TP
.BI -y \ \fR[\fIhmac:\fR]\fIname:key
Use TSIG key to authenticate the request. The \fIhmac\fR part specifies the
algorithm (the default is hmac\-md5), \fIname\fR specifies the key name, and
\fIkey\fR specifies the shared secret encoded in Base64.

.TP
\fB\-\-help\fR
Print help.

.TP
\fB\-\-version\fR
Print program version.

.TP
Options \fB-k\fR and \fB-y\fR cannot be used mutually.

.SH INPUT FORMAT

The input format is textual and is made up of commands. Every command is placed
on a separate line of the input. Lines starting with a semicolon are comments
and are not processed.

List of commands format and their description:

.TP
\fBserver\fR \fIname\fR [\fIport\fR]

Specifies a receiving server of the dynamic update message. Parameter \fIname\fR
can be either a host name or an IP address. If the \fIport\fR is not specified,
default port is used. The default port value can be controlled using program
option \fB-p\fR.

.TP
\fBzone\fR \fIname\fR

Specifies that all updates are done within a zone named \fIname\fR. If not used,
the default zone is the root zone.

.TP
\fBorigin\fR \fIname\fR

Specifies fully qualified domain name suffix which is appended to
non-fqd owners in update commands. The default origin is the root zone.

.TP
\fBclass\fR \fIname\fR

Sets \fIname\fR as a default class for all updates. If not used, the default
class is IN.

.TP
\fBttl\fR \fIvalue\fR

Sets \fIvalue\fR as a default TTL (time to live) in seconds. If not used, the
default value is zero.

.TP
\fBkey\fB \fIname\fR \fIkey\fR

Specifies TSIG key to authenticate the request. This command has the same
semantics as the program option \fB\-y\fR, except that the MAC algorithm
cannot be set.

.TP
[\fBupdate\fR] \fBadd\fR \fIname\fR \fIttl\fR [\fIclass\fR] \fItype\fR \fIdata\fR

Adds a request to add a new resource record into the zone. Please note that if the
\fIname\fR is not fully qualified domain name, current \fIorigin\fR name is appended to it.

.TP
[\fBupdate\fR] \fBdel\fR[\fBete\fR] \fIname\fR [\fIttl\fR] [\fIclass\fR] [\fItype\fR] [\fIdata\fR]

Adds a request to remove all (or matching \fIclass\fR, \fItype\fR, \fIdata\fR)
resource records from the zone. There is the same requirement for the
\fIname\fR parameter as in the \fBupdate add\fR command. The \fIttl\fR item is ignored.

.TP
\fBshow\fR

Displays current content of the update message.

.TP
\fBsend\fR

Sends the current update message and cleans the list of updates.

.TP
\fBanswer\fR

Displays the last answer from the server.

.TP
\fBdebug\fR

Enable debugging. This command has the same meaning as program option \fB\-d\fR.

.SH BUGS

Please note that there are slight differences from ISC nsupdate and some
features are not supported. Any bugs, comments, or feature requests can be sent
to \fBknot-dns@labs.nic.cz\fR.
.SH SEE ALSO
.BI khost\fR(8),
.BI kdig\fR(8).