File: pdns_control.1

package info (click to toggle)
pdns 4.4.1-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 8,856 kB
  • sloc: cpp: 78,652; sh: 5,405; makefile: 2,096; sql: 822; ruby: 598; yacc: 228; ansic: 208; lex: 130; perl: 48; python: 4
file content (188 lines) | stat: -rw-r--r-- 5,826 bytes parent folder | download | duplicates (2)
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
.\" Man page generated from reStructuredText.
.
.TH "PDNS_CONTROL" "1" "Feb 06, 2021" "" "PowerDNS Authoritative Server"
.SH NAME
pdns_control \- Control the PowerDNS nameserver
.
.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
\fBpdns_control\fP [\fIOPTION\fP]... \fICOMMAND\fP
.SH DESCRIPTION
.sp
\fBpdns_control\fP is used to send commands to a running PowerDNS
nameserver.
.SH OPTIONS
.INDENT 0.0
.TP
.B \-\-help
Show summary of options.
.TP
.BI \-\-chroot\fB= <DIR>
Directory where PowerDNS is chrooted.
.TP
.BI \-\-config\-dir\fB= <DIR>
Location of configuration directory (pdns.conf).
.TP
.BI \-\-config\-name\fB= <NAME>
Name of this virtual configuration \- will rename the binary image.
.TP
.BI \-\-remote\-address\fB= <ADDRESS>
Remote address to query.
.TP
.BI \-\-remote\-port\fB= <PORT>
Remote port to query.
.TP
.BI \-\-secret\fB= <SECRET>
Secret needed to connect to remote PowerDNS.
.TP
.BI \-\-socket\-dir\fB= <DIR>
Where the controlsocket lives.
.UNINDENT
.SH COMMANDS
.SS bind\-add\-zone \fIDOMAIN\fP \fIFILENAME\fP
.sp
When using the BIND backend, add a zone. This zone is added in\-memory
and served immediately. Note that this does not add the zone to the
bind\-config file. \fIFILENAME\fP must be an absolute path.
.SS bind\-domain\-extended\-status [\fIDOMAIN\fP\&...]
.sp
Output an extended status of all domains, containing much more information than
the simple domain status, like the number of records currently loaded, whether pdns
is master or slave for the domain, the list of masters, various timers, etc
Optionally, append \fIDOMAIN\fPs to get the status of specific zones.
.SS bind\-domain\-status [\fIDOMAIN\fP\&...]
.sp
When using the BIND backend, list status of all domains. Optionally,
append \fIDOMAIN\fPs to get the status of specific zones.
.SS bind\-list\-rejects
.sp
When using the BIND backend, get a list of all rejected domains.
.SS bind\-reload\-now \fIDOMAIN\fP [\fIDOMAIN\fP\&...]
.sp
When using the BIND backend, immediately reload \fIDOMAIN\fP from disk.
.SS ccounts
.sp
Show the content of the cache.
.SS current\-config [diff]
.sp
Show the currently running configuration. The output has the same format as \fBpdns_server \-\-config\fP\&. With the diff option only modified options are included in the output.
.SS cycle
.sp
Restart the nameserver so it reloads its configuration. Only works
when the server is running in guardian mode.
.SS list
.sp
Dump all statistics and their values in a comma separated list,
equivalent to \fBshow *\fP\&.
.SS list\-zones [master,slave,native]
.sp
Show a list of zones, optionally filter on the type of zones to
show.
.SS notify \fIDOMAIN\fP
.sp
Adds \fIDOMAIN\fP to the notification list, causing PowerDNS to send out
notifications to the nameservers of a domain. Can be used if a slave
missed previous notifications or is generally hard of hearing. Use
* to notify for all domains. (Note that you may need to escape the
* sign in your shell.)
.SS notify\-host \fIDOMAIN\fP \fIADDRESS\fP
.sp
Same as above but with operator specified IP \fIADDRESS\fP as
destination, to be used if you know better than PowerDNS.
.SS ping, rping
.sp
Check if the server is still alive. Will return \(aqPONG\(aq when it is.
\fBping\fP works when running inside a guardian, whereas \fBrping\fP
works when running without a guardian.
.SS purge [\fIRECORD\fP]
.sp
Purge entries from the cache. If \fIRECORD\fP ends with a dollar ($) all
entries that end with that name are removed. If no record is
specified the entire cache is purged.
.SS qtypes
.sp
Get a count of queries per qtype on standard out.
.SS quit
.sp
Tell a running pdns_server to quit.
.SS rediscover
.sp
Instructs backends that new domains may have appeared in the
database, or, in the case of the BIND backend, in named.conf.
.SS reload
.sp
Instruct the server to reload all its zones, this will not add new
zones.
.SS remotes
.sp
Get the top number of remote addresses (clients).
.SS respsizes
.sp
Get a histogram of the response sizes.
.SS retrieve \fIDOMAIN\fP [IP]
.sp
Retrieve slave \fIDOMAIN\fP from its master. Done nearly immediately.
If IP is specified, then retrieval is forced from the specified IP.
Port may be specified in AFI specific manner.
.SS set \fIVARIABLE\fP \fIVALUE\fP
.sp
Set the configuration parameter \fIVARIABLE\fP to \fIVALUE\fP\&. Currently
only the query\-logging can be set.
.SS show \fISTATISTIC\fP
.sp
Show a single statistic, as present in the output of the list
command.
.SS show \fISTATISTIC\-PREFIX\fP*
.sp
Show all statistics which names start with the supplied \fISTATISTIC\-PREFIX\fP,
as a comma\-separated list. Only one (ending) wildcard is allowed.
.SS status
.sp
Show usage statistics. This only works if the server is running in
guardian mode.
.SS token\-login \fIMODULE\fP \fISLOT\fP \fIPIN\fP
.sp
Log on to a PKCS#11 slot. You only need to login once per slot, even
if you have multiple keys on single slot. Only available if PowerDNS
was compiled with PKCS#11 support.
.SS uptime
.sp
Show the uptime of the running server.
.SS version
.sp
Print the version of the running pdns daemon.
.SH SEE ALSO
.sp
pdns_server (1), pdnsutil (1)
.SH AUTHOR
PowerDNS.COM BV
.SH COPYRIGHT
2001-2019, PowerDNS.COM BV
.\" Generated by docutils manpage writer.
.