pdns_control(1)

1PDNS_CONTROL(1)          PowerDNS Authoritative Server         PDNS_CONTROL(1)
2
3
4

NAME

6       pdns_control - Control the PowerDNS nameserver
7

SYNOPSIS

9       pdns_control [OPTION]... COMMAND
10

DESCRIPTION

12       pdns_control is used to send commands to a running PowerDNS nameserver.
13

OPTIONS

15       --help Show summary of options.
16
17       --chroot=<DIR>
18              Directory where PowerDNS is chrooted.
19
20       --config-dir=<DIR>
21              Location of configuration directory (pdns.conf).
22
23       --config-name=<NAME>
24              Name  of this virtual configuration - will rename the binary im‐
25              age.
26
27       --remote-address=<ADDRESS>
28              Remote address to query.
29
30       --remote-port=<PORT>
31              Remote port to query.
32
33       --secret=<SECRET>
34              Secret needed to connect to remote PowerDNS.
35
36       --socket-dir=<DIR>
37              Where the controlsocket lives.
38

COMMANDS

40   bind-add-zone ZONE FILENAME
41       When using the BIND backend, add a zone. This zone is  added  in-memory
42       and  served  immediately.  Note  that this does not add the zone to the
43       bind-config file. FILENAME must be an absolute path.
44
45   bind-domain-extended-status [ZONE...]
46       Output an extended status of all zones, containing much  more  informa‐
47       tion  than the simple zone status, like the number of records currently
48       loaded, whether pdns is primary or secondary for the zone, the list  of
49       primaries, various timers, etc Optionally, append ZONEs to get the sta‐
50       tus of specific zones.
51
52   bind-domain-status [ZONE...]
53       When using the BIND backend, list status of all zones. Optionally,  ap‐
54       pend ZONEs to get the status of specific zones.
55
56   bind-list-rejects
57       When using the BIND backend, get a list of all rejected zones.
58
59   bind-reload-now ZONE [ZONE...]
60       When using the BIND backend, immediately reload ZONE from disk.
61
62   ccounts
63       Show the content of the cache.
64
65   current-config [diff]
66       Show  the currently running configuration. The output has the same for‐
67       mat as pdns_server --config. With the diff option only modified options
68       are included in the output.
69
70   cycle
71       Restart the nameserver so it reloads its configuration. Only works when
72       the server is running in guardian mode.
73
74   list
75       Dump all statistics and their values in a comma separated list, equiva‐
76       lent to show *.
77
78   list-zones [primary,secondary,native]
79       Show a list of zones, optionally filter on the type of zones to show.
80
81   notify ZONE
82       Adds  ZONE to the notification list, causing PowerDNS to send out noti‐
83       fications to the nameservers of a zone. Can  be  used  if  a  secondary
84       missed previous notifications or is generally hard of hearing. Use * to
85       notify for all zones. (Note that you may need to escape the *  sign  in
86       your shell.)
87
88   notify-host ZONE ADDRESS
89       Same as above but with operator specified IP ADDRESS as destination, to
90       be used if you know better than PowerDNS.
91
92   ping, rping
93       Check if the server is still alive. Will  return  'PONG'  when  it  is.
94       ping  works  when  running  inside a guardian, whereas rping works when
95       running without a guardian.
96
97   purge [RECORD]
98       Purge entries from the cache. If RECORD ends with a dollar ($) all  en‐
99       tries  that  end  with that name are removed. If no record is specified
100       the entire cache is purged.
101
102   qtypes
103       Get a count of queries per qtype on standard out.
104
105   quit
106       Tell a running pdns_server to quit.
107
108   rediscover
109       Instructs backends that new zones may have appeared  in  the  database,
110       or, in the case of the BIND backend, in named.conf.
111
112   reload
113       Instruct  the  server  to  reload  all its zones, this will not add new
114       zones.
115
116   remotes
117       Get the top number of remote addresses (clients).
118
119   respsizes
120       Get a histogram of the response sizes.
121
122   retrieve ZONE [IP]
123       Retrieve secondary ZONE from its primary. Done nearly immediately.   If
124       IP  is specified, then retrieval is forced from the specified IP.  Port
125       may be specified in AFI specific manner.
126
127   set VARIABLE VALUE
128       Set the configuration parameter VARIABLE to VALUE. Currently  only  the
129       query-logging can be set.
130
131   show STATISTIC
132       Show a single statistic, as present in the output of the list command.
133
134   show STATISTIC-PREFIX*
135       Show  all statistics which names start with the supplied STATISTIC-PRE‐
136       FIX, as a comma-separated list. Only one (ending) wildcard is allowed.
137
138   status
139       Show usage statistics. This only works if  the  server  is  running  in
140       guardian mode.
141
142   token-login MODULE SLOT PIN
143       Log on to a PKCS#11 slot. You only need to login once per slot, even if
144       you have multiple keys on single slot. Only available if  PowerDNS  was
145       compiled with PKCS#11 support.
146
147   uptime
148       Show the uptime of the running server.
149
150   version
151       Print the version of the running pdns daemon.
152

AUTHOR

157       PowerDNS.COM BV
158

COPYRIGHT

160       2001-2023, PowerDNS.COM BV
161
162
163
164
165                                 Oct 05, 2023                  PDNS_CONTROL(1)