summaryrefslogtreecommitdiff
path: root/man/knotc.8
blob: 1b89de8a49c12a62e89c69f18a36dc4095724491 (plain)
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
.TH knotc "8" "6 January 2014" "CZ.NIC Labs" "Knot DNS, version 1.4.0"
.SH NAME
.B knotc
\- Knot DNS control utility
.SH SYNOPSIS
.B knotc
[\fIparameters\fR] \fIaction\fR [\fIaction_args\fR]
.SH DESCRIPTION
.SS "Parameters:"
.TP
\fB\-c\fR, \fB\-\-config\fR \fIfile\fR
Select configuration file.
.TP
\fB\-s\fR \fIserver\fR
Remote UNIX socket/IP address (default /run/knot/knot.sock).
.TP
\fB\-p\fR \fIport\fR
Remote server port (only for IP).
.TP
\fB\-y\fR [\fIhmac\fR:]\fIname\fR:\fIkey\fR
Use key specified on the command line (default algorithm is hmac\-md5).
.TP
\fB\-k\fR \fIfile\fR
Use key file (as in config section 'keys').
.TP
\fB\-f\fR, \fB\-\-force\fR
Force operation \- override some checks.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Verbose mode \- additional runtime information.
.TP
\fB\-V\fR, \fB\-\-version\fR
Print version of the server.
.TP
\fB\-i\fR, \fB\-\-interactive\fR
Interactive mode (do not daemonize).
.TP
\fB\-h\fR, \fB\-\-help\fR
Print help and usage.
.SS "Actions:"
.TP
\fBstop\fR
Stop server (no\-op if not running).
.TP
\fBreload\fR
Reload configuration and changed zones.
.TP
\fBflush\fR
Flush journal and update zone files.
.TP
\fBstatus\fR
Check if server is running.
.TP
\fBzonestatus\fR
Show status of configured zones.
.TP
\fBrefresh\fR [\fIzone\fR]...
Refresh slave zones (all if not specified).
.TP
\fBcheckconf\fR
Check current server configuration.
.TP
\fBcheckzone\fR [\fIzone\fR]...
Check zone (all if not specified).
.TP
\fBmemstats\fR [\fIzone\fR]...
Estimate memory consumption for zone (all if not specified).
.SH EXAMPLES
.TP
.B Setup a keyfile for remote control
.TP
1. Generate key:
.TP
# dnssec\-keygen \-a hmac\-md5 \-b 256 \-n HOST knotc\-key
.TP
2. Extract secret in base64 format and create keyfile:
.TP
# echo "knotc\-key hmac\-md5 <secret>" > knotc.key
.TP
Make sure the key can be read/written only by the owner for security reasons.
.TP
.B Reload server remotely
.TP
# knotc \-s 127.0.0.1 \-k knotc.key reload
.SH "SEE ALSO"
.BR knotd (8)
.SH NOTE
The full documentation for \fBKnot DNS\fR is maintained
as a Texinfo manual. If the \fBinfo\fR program is properly
installed at your site, the \fBinfo\ Knot\fR command should
give you an access to the complete manual.