File: rec_control.1

package info (click to toggle)
pdns-recursor 4.1.11-1+deb10u1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 7,936 kB
  • sloc: cpp: 54,211; javascript: 26,587; sh: 11,872; makefile: 453; xml: 37
file content (303 lines) | stat: -rw-r--r-- 9,726 bytes parent folder | download
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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
.\" Man page generated from reStructuredText.
.
.TH "REC_CONTROL" "1" "Jan 31, 2019" "4.1" "PowerDNS Recursor"
.SH NAME
rec_control \- Command line tool to control a running Recursor
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.sp
\fBrec_control\fP [\fIOPTION\fP]... \fICOMMAND\fP [\fICOMMAND\-OPTION\fP]...
.SH DESCRIPTION
.sp
\fBrec_control\fP allows the operator to query and control a running
instance of the PowerDNS Recursor.
.sp
\fBrec_control\fP talks to the recursor via a the \(aqcontrolsocket\(aq. Which
is usually located in \fB/var/run\fP . The \fI\-\-socket\-dir\fP or the \fI\-\-config\-dir\fP
and \fI\-\-config\-name\fP switches control to which process \fBrec_control\fP
connects.
.SH EXAMPLES
.sp
To see if the Recursor is alive, run:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# rec_control ping
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To stop the recursor by hand, run:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# rec_control quit
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To dump the cache to disk, execute:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# rec_control dump\-cache /tmp/the\-cache
.ft P
.fi
.UNINDENT
.UNINDENT
.SH OPTIONS
.INDENT 0.0
.TP
.B \-\-help
provide this helpful message.
.TP
.BI \-\-config\-dir\fB= <path>
Directory where the recursor.conf lives.
.TP
.BI \-\-config\-name\fB= <name>
Name of the virtual configuration.
.TP
.BI \-\-socket\-dir\fB= <path>
Where the controlsocket will live, please
use \fB\-\-config\-dir\fP instead.
.TP
.BI \-\-socket\-pid\fB= <pid>
When running in SMP mode, pid of \fBpdns_recursor\fP to
control.
.TP
.BI \-\-timeout\fB= <num>
Number of seconds to wait for the remote PowerDNS
Recursor to respond. Set to 0 for infinite.
.UNINDENT
.SH COMMANDS
.INDENT 0.0
.TP
.B add\-nta \fIDOMAIN\fP [\fIREASON\fP]
Add a Negative Trust Anchor for \fIDOMAIN\fP, suffixed optionally with
\fIREASON\fP\&.
.TP
.B add\-ta \fIDOMAIN\fP \fIDSRECORD\fP
Add a Trust Anchor for \fIDOMAIN\fP with DS record data \fIDSRECORD\fP\&. This adds
the new Trust Anchor to the existing set of Trust Anchors for \fIDOMAIN\fP\&.
.TP
.B current\-queries
Shows the currently active queries.
.TP
.B clear\-nta \fIDOMAIN\fP\&...
Remove Negative Trust Anchor for one or more \fIDOMAIN\fPs. Set domain to
\(aq*\(aq to remove all NTA\(aqs.
.TP
.B clear\-ta [\fIDOMAIN\fP]...
Remove Trust Anchor for one or more \fIDOMAIN\fPs. Note that removing the
root trust anchor is not possible.
.TP
.B dump\-cache \fIFILENAME\fP
Dumps the entire cache to \fIFILENAME\fP\&. This file should not exist already,
PowerDNS will refuse to overwrite it. While dumping, the recursor will not
answer questions.
.sp
Typical PowerDNS Recursors run multiple threads, therefore you\(aqll see
duplicate, different entries for the same domains. The negative cache is
also dumped to the same file. The per\-thread positive and negative cache
dumps are separated with an appropriate comment.
.TP
.B dump\-edns \fIFILENAME\fP
Dumps the EDNS status to the filename mentioned. This file should not exist
already, PowerDNS will refuse to overwrite it. While dumping, the recursor
will not answer questions.
.TP
.B dump\-nsspeeds \fIFILENAME\fP
Dumps the nameserver speed statistics to the \fIFILENAME\fP mentioned. This
file should not exist already, PowerDNS will refuse to overwrite it. While
dumping, the recursor will not answer questions. Statistics are kept per
thread, and the dumps end up in the same file.
.TP
.B dump\-rpz \fIZONE NAME\fP \fIFILE NAME\fP
Dumps the content of the RPZ zone named \fIZONE NAME\fP to the \fIFILENAME\fP
mentioned. This file should not exist already, PowerDNS will refuse to
overwrite it otherwise. While dumping, the recursor will not answer
questions.
.TP
.B get \fISTATISTIC\fP [\fISTATISTIC\fP]...
Retrieve a statistic. For items that can be queried, see
\&../metrics
.TP
.B get\-all
Retrieve all known statistics.
.TP
.B get\-ntas
Get a list of the currently configured Negative Trust Anchors.
.TP
.B get\-tas
Get a list of the currently configured Trust Anchors.
.TP
.B get\-parameter \fIKEY\fP [\fIKEY\fP]...
Retrieves the specified configuration parameter(s).
.TP
.B get\-qtypelist
Retrieves QType statistics. Queries from cache aren\(aqt being counted yet.
.TP
.B help
Shows a list of supported commands understood by the running
\fBpdns_recursor\fP
.TP
.B ping
Check if server is alive.
.TP
.B quit
Request shutdown of the recursor.
.TP
.B quit\-nicely
Request nice shutdown of the recursor.
.TP
.B reload\-acls
Reloads ACLs.
.TP
.B reload\-lua\-script [\fIFILENAME\fP]
(Re)loads Lua script \fIFILENAME\fP\&. If \fIFILENAME\fP is empty, attempt to reload
the currently loaded script. This replaces the script currently loaded.
.TP
.B reload\-lua\-config [\fIFILENAME\fP]
(Re)loads Lua configuration \fIFILENAME\fP\&. If \fIFILENAME\fP is empty, attempt
to reload the currently loaded file. Note that \fIFILENAME\fP will be fully
executed, any settings changed at runtime that are not modified in this
file, will still be active. Reloading RPZ, especially by AXFR, can take
some time; during which the recursor will not answer questions.
.TP
.B reload\-zones
Reload authoritative and forward zones. Retains current configuration in
case of errors.
.TP
.B set\-carbon\-server \fICARBON SERVER\fP [\fICARBON OURNAME\fP]
Set the carbon\-server setting to \fICARBON SERVER\fP\&. If \fICARBON OURNAME\fP is
not empty, also set the carbon\-ourname setting to \fICARBON OURNAME\fP\&.
.TP
.B set\-dnssec\-log\-bogus \fISETTING\fP
Set dnssec\-log\-bogus setting to \fISETTING\fP\&. Set to \(aqon\(aq or \(aqyes\(aq to log
DNSSEC validation failures and to \(aqno\(aq or \(aqoff\(aq to disable logging these
failures.
.TP
.B set\-max\-cache\-entries \fINUM\fP
Change the maximum number of entries in the DNS cache.  If reduced, the
cache size will start shrinking to this number as part of the normal
cache purging process, which might take a while.
.TP
.B set\-max\-packetcache\-entries \fINUM\fP
Change the maximum number of entries in the packet cache.  If reduced, the
cache size will start shrinking to this number as part of the normal
cache purging process, which might take a while.
.TP
.B set\-minimum\-ttl \fINUM\fP
Set minimum\-ttl\-override to \fINUM\fP\&.
.TP
.B top\-queries
Shows the top\-20 queries. Statistics are over the last
\(aqstats\-ringbuffer\-entries\(aq queries.
.TP
.B top\-pub\-queries
Shows the top\-20 queries grouped by public suffix list. Statistics are over
the last \(aqstats\-ringbuffer\-entries\(aq queries.
.TP
.B top\-largeanswer\-remotes
Shows the top\-20 remote hosts causing large answers. Statistics are over
the last \(aqstats\-ringbuffer\-entries\(aq queries.
.TP
.B top\-remotes
Shows the top\-20 most active remote hosts. Statistics are over the last
\(aqstats\-ringbuffer\-entries\(aq queries.
.TP
.B top\-servfail\-queries
Shows the top\-20 queries causing servfail responses. Statistics are over
the last \(aqstats\-ringbuffer\-entries\(aq queries.
.TP
.B top\-pub\-servfail\-queries
Shows the top\-20 queries causing servfail responses grouped by public
suffix list. Statistics are over the last \(aqstats\-ringbuffer\-entries\(aq
queries.
.TP
.B top\-servfail\-remotes
Shows the top\-20 most active remote hosts causing servfail responses.
Statistics are over the last \(aqstats\-ringbuffer\-entries\(aq queries.
.TP
.B trace\-regex \fIREGEX\fP
Emit resolution trace for matching queries. Empty regex to disable trace.
.sp
Queries matching this regular expression will generate voluminous tracing
output. Be aware that matches from the packet cache will still not generate
tracing. To unset the regex, pass \fBtrace\-regex\fP without a new regex.
.sp
The regular expression is matched against domain queries terminated with a
\(aq.\(aq. For example the regex \(aqpowerdns.com$\(aq will not match a query for
\(aqwww.powerdns.com\(aq, since the attempted match will be with
\(aqwww.powerdns.com.\(aq.
.sp
In addition, since this is a regular expression, to exclusively match
queries for \(aqwww.powerdns.com\(aq, one should escape the dots:
\(aq^www.powerdns.com.$\(aq.
.sp
Multiple matches can be chained with the \(aq|\(aq operator. For example, to
match all queries for Dutch (.nl) and German (.de) domain names, use:
\(aq.nl.$|.de.$\(aq.
.TP
.B unload\-lua\-script
Unloads Lua script if one was loaded.
.TP
.B version
Report running version.
.TP
.B wipe\-cache \fIDOMAIN\fP [\fIDOMAIN\fP] [...]
Wipe entries for \fIDOMAIN\fP (exact name match) from the cache. This is useful
if, for example, an important server has a new IP address, but the TTL has
not yet expired. Multiple domain names can be passed.
\fIDOMAIN\fP can be suffixed with a \(aq$\(aq. to delete the whole tree from the
cache. i.e. \(aqpowerdns.com$\(aq will remove all cached entries under and
including the powerdns.com name.
.sp
\fBNote\fP: this command also wipes the negative cache.
.sp
\fBWarning\fP: Don\(aqt just wipe "www.somedomain.com", its NS records or CNAME
target may still be undesired, so wipe "somedomain.com" as well.
.UNINDENT
.SH SEE ALSO
.sp
\fBpdns_recursor(1)\fP
.SH AUTHOR
PowerDNS.COM BV
.SH COPYRIGHT
2001-2018, PowerDNS.COM BV
.\" Generated by docutils manpage writer.
.