docs/manpages/pdns_control.1.rst

   1 pdns_control
   2 ============
   3
   4 Synopsis
   5 --------
   6
   7 :program:`pdns_control` [*OPTION*]... *COMMAND*
   8
   9 Description
  10 -----------
  11
  12 :program:`pdns_control` is used to send commands to a running PowerDNS
  13 nameserver.
  14
  15 Options
  16 -------
  17
  18 --help                       Show summary of options.
  19 --chroot=<DIR>               Directory where PowerDNS is chrooted.
  20 --config-dir=<DIR>           Location of configuration directory (pdns.conf).
  21 --config-name=<NAME>         Name of this virtual configuration - will rename the binary image.
  22 --remote-address=<ADDRESS>   Remote address to query.
  23 --remote-port=<PORT>         Remote port to query.
  24 --secret=<SECRET>            Secret needed to connect to remote PowerDNS.
  25 --socket-dir=<DIR>           Where the controlsocket lives.
  26
  27 Commands
  28 --------
  29
  30 bind-add-zone *DOMAIN* *FILENAME*
  31 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  32
  33 When using the BIND backend, add a zone. This zone is added in-memory
  34 and served immediately. Note that this does not add the zone to the
  35 bind-config file. *FILENAME* must be an absolute path.
  36
  37 bind-domain-extended-status [*DOMAIN*...]
  38 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  39
  40 Output an extended status of all domains, containing much more information than
  41 the simple domain status, like the number of records currently loaded, whether pdns
  42 is master or slave for the domain, the list of masters, various timers, etc
  43 Optionally, append *DOMAIN*\ s to get the status of specific zones.
  44
  45 bind-domain-status [*DOMAIN*...]
  46 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  47
  48 When using the BIND backend, list status of all domains. Optionally,
  49 append *DOMAIN*\ s to get the status of specific zones.
  50
  51 bind-list-rejects
  52 ^^^^^^^^^^^^^^^^^
  53
  54 When using the BIND backend, get a list of all rejected domains.
  55
  56 bind-reload-now *DOMAIN* [*DOMAIN*...]
  57 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  58
  59 When using the BIND backend, immediately reload *DOMAIN* from disk.
  60
  61 ccounts
  62 ^^^^^^^
  63
  64 Show the content of the cache.
  65
  66 current-config [diff]
  67 ^^^^^^^^^^^^^^^^^^^^^
  68
  69 Show the currently running configuration. The output has the same format as ``pdns_server --config``. With the diff option only modified options are included in the output.
  70
  71 cycle
  72 ^^^^^
  73
  74 Restart the nameserver so it reloads its configuration. Only works
  75 when the server is running in guardian mode.
  76
  77 list
  78 ^^^^
  79
  80 Dump all variables and their values in a comma separated list,
  81 equivalent to ``show *``.
  82
  83 list-zones [master,slave,native]
  84 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  85
  86 Show a list of zones, optionally filter on the type of zones to
  87 show.
  88
  89 notify *DOMAIN*
  90 ^^^^^^^^^^^^^^^
  91
  92 Adds *DOMAIN* to the notification list, causing PowerDNS to send out
  93 notifications to the nameservers of a domain. Can be used if a slave
  94 missed previous notifications or is generally hard of hearing. Use
  95 \* to notify for all domains. (Note that you may need to escape the
  96 \* sign in your shell.)
  97
  98 notify-host *DOMAIN* *ADDRESS*
  99 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 100
 101 Same as above but with operator specified IP *ADDRESS* as
 102 destination, to be used if you know better than PowerDNS.
 103
 104 ping, rping
 105 ^^^^^^^^^^^
 106
 107 Check if the server is still alive. Will return 'PONG' when it is.
 108 ``ping`` works when running inside a guardian, whereas ``rping``
 109 works when running without a guardian.
 110
 111 purge [*RECORD*]
 112 ^^^^^^^^^^^^^^^^
 113
 114 Purge entries from the cache. If *RECORD* ends with a dollar ($) all
 115 entries that end with that name are removed. If no record is
 116 specified the entire cache is purged.
 117
 118 qtypes
 119 ^^^^^^
 120
 121 Get a count of queries per qtype on standard out.
 122
 123 quit
 124 ^^^^
 125
 126 Tell a running pdns\_server to quit.
 127
 128 rediscover
 129 ^^^^^^^^^^
 130
 131 Instructs backends that new domains may have appeared in the
 132 database, or, in the case of the BIND backend, in named.conf.
 133
 134 reload
 135 ^^^^^^
 136
 137 Instruct the server to reload all its zones, this will not add new
 138 zones.
 139
 140 remotes
 141 ^^^^^^^
 142
 143 Get the top number of remote addresses (clients).
 144
 145 respsizes
 146 ^^^^^^^^^
 147
 148 Get a histogram of the response sizes.
 149
 150 retrieve *DOMAIN*
 151 ^^^^^^^^^^^^^^^^^
 152
 153 Retrieve slave *DOMAIN* from its master. Done nearly immediately.
 154
 155 set *VARIABLE* *VALUE*
 156 ^^^^^^^^^^^^^^^^^^^^^^
 157
 158 Set the configuration parameter *VARIABLE* to *VALUE*. Currently
 159 only the query-logging can be set.
 160
 161 show *VARIABLE*
 162 ^^^^^^^^^^^^^^^
 163
 164 Show a single statistic, as present in the output of the list
 165 command.
 166
 167 status
 168 ^^^^^^
 169
 170 Show usage statistics. This only works if the server is running in
 171 guardian mode.
 172
 173 token-login *MODULE* *SLOT* *PIN*
 174 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 175
 176 Log on to a PKCS#11 slot. You only need to login once per slot, even
 177 if you have multiple keys on single slot. Only available if PowerDNS
 178 was compiled with PKCS#11 support.
 179
 180 uptime
 181 ^^^^^^
 182
 183 Show the uptime of the running server.
 184
 185 version
 186 ^^^^^^^
 187
 188 Print the version of the running pdns daemon.
 189
 190 See also
 191 --------
 192
 193 pdns\_server(1)