| 1 | REC_CONTROL(1) |
|---|
| 2 | ============== |
|---|
| 3 | bert hubert <bert.hubert@netherlabs.nl> |
|---|
| 4 | v3.0, 19 April 2006 |
|---|
| 5 | |
|---|
| 6 | NAME |
|---|
| 7 | ---- |
|---|
| 8 | rec_control - control pdns_recursor |
|---|
| 9 | |
|---|
| 10 | SYNOPSIS |
|---|
| 11 | -------- |
|---|
| 12 | 'rec_control' [--help] [--socket-dir] [--socket-pid] command .. |
|---|
| 13 | |
|---|
| 14 | DESCRIPTION |
|---|
| 15 | ----------- |
|---|
| 16 | rec_control(1) allows the operator to control a running instance |
|---|
| 17 | of the pdns_recursor. |
|---|
| 18 | |
|---|
| 19 | The commands that can be passed to the recursor are described on |
|---|
| 20 | http://doc.powerdns.com/rec-control.html |
|---|
| 21 | |
|---|
| 22 | EXAMPLES |
|---|
| 23 | -------- |
|---|
| 24 | |
|---|
| 25 | To stop the recursor by hand, run: |
|---|
| 26 | |
|---|
| 27 | # rec_control quit |
|---|
| 28 | |
|---|
| 29 | To dump the cache to disk, execute: |
|---|
| 30 | |
|---|
| 31 | # rec_control dump-cache /tmp/the-cache |
|---|
| 32 | |
|---|
| 33 | OPTIONS |
|---|
| 34 | ------- |
|---|
| 35 | |
|---|
| 36 | --help:: |
|---|
| 37 | provide this helpful message |
|---|
| 38 | |
|---|
| 39 | --socket-dir:: |
|---|
| 40 | Where the controlsocket will live |
|---|
| 41 | |
|---|
| 42 | --socket-pid:: |
|---|
| 43 | When running in SMP mode, pid of pdns_recursor to control |
|---|
| 44 | |
|---|
| 45 | --timeout:: |
|---|
| 46 | Number of seconds to wait for the remote PowerDNS Recursor to |
|---|
| 47 | respond. Set to 0 for infinite. |
|---|
| 48 | |
|---|
| 49 | COMMANDS |
|---|
| 50 | -------- |
|---|
| 51 | dump-cache filename:: |
|---|
| 52 | Dumps the entire cache to the filename mentioned. This file should |
|---|
| 53 | not exist already, PowerDNS will refuse to overwrite it. While |
|---|
| 54 | dumping, the recursor will not answer questions. |
|---|
| 55 | |
|---|
| 56 | get statistic:: |
|---|
| 57 | Retrieve a statistic. For items that can be queried, see |
|---|
| 58 | http://doc.powerdns.com/recursor-stats.html |
|---|
| 59 | |
|---|
| 60 | get-all:: |
|---|
| 61 | Retrieve all known statistics. |
|---|
| 62 | |
|---|
| 63 | ping:: |
|---|
| 64 | Check if server is alive. |
|---|
| 65 | |
|---|
| 66 | quit:: |
|---|
| 67 | Request shutdown of the recursor |
|---|
| 68 | |
|---|
| 69 | reload-zones:: |
|---|
| 70 | Reload authoritative and forward zones. Retains current configuration |
|---|
| 71 | in case of errors. |
|---|
| 72 | |
|---|
| 73 | top-remotes:: |
|---|
| 74 | Shows the top-20 most active remote hosts. Statistics are over the |
|---|
| 75 | last 'remotes-ringbuffer-entries' queries, which defaults to 0. |
|---|
| 76 | |
|---|
| 77 | wipe-cache domain0 [domain1]:: |
|---|
| 78 | Wipe entries from the cache. This is useful if, for example, an |
|---|
| 79 | important server has a new IP address, but the TTL has not yet |
|---|
| 80 | expired. Multiple domain names can be passed. Note that you must |
|---|
| 81 | terminate a domain with a .! So to wipe powerdns.org, issue |
|---|
| 82 | 'rec_control wipe-cache powerdns.org.'. |
|---|
| 83 | Versions beyond 3.1 don't need the trailing dot. Consider not only |
|---|
| 84 | wiping 'www.domain.com.' but also 'domain.com.', as the cached nameservers |
|---|
| 85 | or target of CNAME may continue to be undesired. |
|---|
| 86 | |
|---|
| 87 | BUGS |
|---|
| 88 | ---- |
|---|
| 89 | None known. File new ones at http://wiki.powerdns.com. |
|---|
| 90 | |
|---|
| 91 | AUTHOR |
|---|
| 92 | ------ |
|---|
| 93 | Written by PowerDNS.COM BV, bert hubert, <bert.hubert@netherlabs.nl> |
|---|
| 94 | |
|---|
| 95 | RESOURCES |
|---|
| 96 | --------- |
|---|
| 97 | Website: http://wiki.powerdns.com, http://www.powerdns.com |
|---|
| 98 | |
|---|
| 99 | SEE ALSO |
|---|
| 100 | -------- |
|---|
| 101 | pdns_recursor(1) |
|---|
| 102 | |
|---|
| 103 | COPYING |
|---|
| 104 | ------- |
|---|
| 105 | Copyright (C) 2006 PowerDNS.COM BV. Free use of this software |
|---|
| 106 | is granted under the terms of the GNU General Public License (GPL) version |
|---|
| 107 | 2. |
|---|
| 108 | |
|---|
