File: pdnsutil.1

package info (click to toggle)
pdns 5.0.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 10,824 kB
  • sloc: cpp: 101,247; sh: 5,616; makefile: 2,318; sql: 860; ansic: 675; python: 635; yacc: 245; perl: 161; lex: 131
file content (808 lines) | stat: -rw-r--r-- 21,635 bytes parent folder | download
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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
.\" Man page generated from reStructuredText.
.
.
.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
..
.TH "PDNSUTIL" "1" "Feb 19, 2026" "" "PowerDNS Authoritative Server"
.SH NAME
pdnsutil \- PowerDNS record and DNSSEC command and control
.SH SYNOPSIS
.sp
\fBpdnsutil\fP [OPTION]... \fICOMMAND\fP
.SH DESCRIPTION
.sp
\fBpdnsutil\fP (formerly \fBpdnssec\fP) is a powerful command that is the
operator\-friendly gateway into DNSSEC and zone management for PowerDNS.
Behind the scenes, \fBpdnsutil\fP manipulates a PowerDNS backend database,
which also means that for many databases, \fBpdnsutil\fP can be run
remotely, and can configure key material on different servers.
.SH OPTIONS
.INDENT 0.0
.TP
.B  \-h\fP,\fB  \-\-help
Show summary of options
.TP
.B  \-v\fP,\fB  \-\-verbose
Be more verbose
.TP
.B  \-f\fP,\fB  \-\-force
Force an action
.TP
.B  \-q\fP,\fB  \-\-quiet
Be quiet
.TP
.BI \-\-config\-name \ <NAME>
Virtual configuration name
.TP
.BI \-\-config\-dir \ <DIR>
Location of pdns.conf. Default is /etc/powerdns.
.UNINDENT
.SH COMMANDS
.sp
There are many available commands. Most commands follow the pattern
\fBpdnsutil <object> <action> [arguments...]\fP, where \fB<object>\fP is a noun and \fB<action>\fP is a verb; a few commands which do not apply to any particular object
kind use only the verb.
.SH AUTOPRIMARY COMMANDS
.sp
autoprimary add \fIIP\fP \fINAMESERVER\fP [\fIACCOUNT\fP]
.INDENT 0.0
.INDENT 3.5
Add a autoprimary entry into the backend. This enables receiving zone
updates from other servers.
.UNINDENT
.UNINDENT
.sp
autoprimary list
.INDENT 0.0
.INDENT 3.5
List all autoprimaries.
.UNINDENT
.UNINDENT
.sp
autoprimary remove \fIIP\fP \fINAMESERVER\fP
.INDENT 0.0
.INDENT 3.5
Remove an autoprimary from backend. Not supported by BIND backend.
.UNINDENT
.UNINDENT
.SH CATALOG ZONE COMMANDS
.sp
catalog list\-members \fICATALOG\fP
.INDENT 0.0
.INDENT 3.5
List all members of catalog zone \fICATALOG\fP"
.UNINDENT
.UNINDENT
.sp
catalog set \fIZONE\fP [\fICATALOG\fP]
.INDENT 0.0
.INDENT 3.5
Change the catalog of \fIZONE\fP to \fICATALOG\fP\&. If \fICATALOG\fP is omitted,
removes \fIZONE\fP from the catalog it is in.
.UNINDENT
.UNINDENT
.SH ZONE METADATA COMMANDS
.sp
metadata add \fIZONE\fP \fIKIND\fP \fIVALUE\fP [\fIVALUE\fP]...
.INDENT 0.0
.INDENT 3.5
Append \fIVALUE\fP to the existing \fIKIND\fP metadata for \fIZONE\fP\&.
Will return an error if \fIKIND\fP does not support multiple values, use
\fBmetadata set\fP for these values.
.UNINDENT
.UNINDENT
.sp
metadata get \fIZONE\fP [\fIKIND\fP]...
.INDENT 0.0
.INDENT 3.5
Get zone metadata. If no \fIKIND\fP given, lists all known.
.UNINDENT
.UNINDENT
.sp
metadata set \fIZONE\fP \fIKIND\fP [\fIVALUE\fP]...
.INDENT 0.0
.INDENT 3.5
Set zone metadata \fIKIND\fP for \fIZONE\fP to \fIVALUE\fP, replacing all existing
values of \fIKIND\fP\&. An omitted value clears it.
.UNINDENT
.UNINDENT
.SH NETWORK COMMANDS
.sp
network list
.INDENT 0.0
.INDENT 3.5
List all defined networks with their chosen views.
.UNINDENT
.UNINDENT
.sp
network set \fINET\fP [\fIVIEW\fP]
.INDENT 0.0
.INDENT 3.5
Set the \fIVIEW\fP for a the \fINET\fP network, or delete if no \fIVIEW\fP argument.
.UNINDENT
.UNINDENT
.SH ZONE RECORD COMMANDS
.sp
In these commands, the \fBrrset\fP object name may also be written as \fBrecord\fP\&.
.sp
rrset add \fIZONE\fP \fINAME\fP \fITYPE\fP [\fITTL\fP] \fICONTENT\fP
.INDENT 0.0
.INDENT 3.5
Add one or more records of \fINAME\fP and \fITYPE\fP to \fIZONE\fP with \fICONTENT\fP
and optional \fITTL\fP\&. If \fITTL\fP is not set, the configured \fIdefault\-ttl\fP will be used.
\fINAME\fP must be absolute.
.UNINDENT
.UNINDENT
.sp
rrset delete \fIZONE\fP \fINAME\fP \fITYPE\fP
.INDENT 0.0
.INDENT 3.5
Delete named RRSET from zone.
\fINAME\fP must be absolute.
.UNINDENT
.UNINDENT
.sp
rrset hash \fIZONE\fP \fIRNAME\fP
.INDENT 0.0
.INDENT 3.5
This convenience command hashes the name \fIRNAME\fP according to the
NSEC3 settings of \fIZONE\fP\&. Refuses to hash for zones with no NSEC3
settings.
.UNINDENT
.UNINDENT
.sp
rrset replace \fIZONE\fP \fINAME\fP \fITYPE\fP [\fITTL\fP] \fICONTENT\fP [\fICONTENT\fP\&...]
.INDENT 0.0
.INDENT 3.5
Replace existing \fINAME\fP in zone \fIZONE\fP with a new set.
.UNINDENT
.UNINDENT
.SH TSIG RELATED COMMANDS
.sp
These commands manipulate TSIG key information in the database. Some
commands require an \fIALGORITHM\fP, which can be any of the following:
.INDENT 0.0
.IP \(bu 2
hmac\-md5
.IP \(bu 2
hmac\-sha1
.IP \(bu 2
hmac\-sha224
.IP \(bu 2
hmac\-sha256
.IP \(bu 2
hmac\-sha384
.IP \(bu 2
hmac\-sha512
.UNINDENT
.sp
tsigkey activate \fIZONE\fP \fINAME\fP {\fBprimary\fP,\fBsecondary\fP,\fBproducer\fP,\fBconsumer\fP}
.INDENT 0.0
.INDENT 3.5
Enable TSIG authenticated AXFR using the key \fINAME\fP for zone \fIZONE\fP\&.
This sets the \fBTSIG\-ALLOW\-AXFR\fP (primary/producer) or \fBAXFR\-MASTER\-TSIG\fP
(secondary/consumer) zone metadata.
.UNINDENT
.UNINDENT
.sp
tsigkey deactivate \fIZONE\fP \fINAME\fP {\fBprimary\fP,\fBsecondary\fP,\fBproducer\fP,\fBconsumer\fP}
.INDENT 0.0
.INDENT 3.5
Disable TSIG authenticated AXFR using the key \fINAME\fP for zone
\fIZONE\fP\&.
.UNINDENT
.UNINDENT
.sp
tsigkey delete \fINAME\fP
.INDENT 0.0
.INDENT 3.5
Delete the TSIG key \fINAME\fP\&. Warning: this does not deactivate said key.
.UNINDENT
.UNINDENT
.sp
tsigkey generate \fINAME\fP \fIALGORITHM\fP
.INDENT 0.0
.INDENT 3.5
Generate new TSIG key with name \fINAME\fP and the specified algorithm.
.UNINDENT
.UNINDENT
.sp
tsigkey import \fINAME\fP \fIALGORITHM\fP \fIKEY\fP
.INDENT 0.0
.INDENT 3.5
Import \fIKEY\fP of the specified algorithm as \fINAME\fP\&.
.UNINDENT
.UNINDENT
.sp
tsigkey list
.INDENT 0.0
.INDENT 3.5
Show a list of all configured TSIG keys.
.UNINDENT
.UNINDENT
.SH VIEWS COMMANDS
.sp
views add\-zone \fIVIEW\fP \fIZONE..VARIANT\fP
.INDENT 0.0
.INDENT 3.5
Add the given \fIZONE\fP \fIVARIANT\fP to a \fIVIEW\fP\&.
.UNINDENT
.UNINDENT
.sp
views del\-zone \fIVIEW\fP \fIZONE..VARIANT\fP
.INDENT 0.0
.INDENT 3.5
Remove a \fIZONE\fP \fIVARIANT\fP from a \fIVIEW\fP\&.
.UNINDENT
.UNINDENT
.sp
views list \fIVIEW\fP
.INDENT 0.0
.INDENT 3.5
List all zones within \fIVIEW\fP\&.
.UNINDENT
.UNINDENT
.sp
views list\-all
.INDENT 0.0
.INDENT 3.5
List all view names.
.UNINDENT
.UNINDENT
.SH ZONE MANIPULATION COMMANDS
.sp
zone check \fIZONE\fP
.INDENT 0.0
.INDENT 3.5
Check zone \fIZONE\fP for correctness.
.UNINDENT
.UNINDENT
.sp
zone check\-all [exit\-on\-error]
.INDENT 0.0
.INDENT 3.5
Check all zones for correctness, aborting upon finding the first error
in any zone if "exit\-on\-error" is specified.
.UNINDENT
.UNINDENT
.sp
zone clear \fIZONE\fP
.INDENT 0.0
.INDENT 3.5
Clear the records in zone \fIZONE\fP, but leave actual zone and
settings unchanged
.UNINDENT
.UNINDENT
.sp
zone create \fIZONE\fP
.INDENT 0.0
.INDENT 3.5
Create an empty zone named \fIZONE\fP\&.
.UNINDENT
.UNINDENT
.sp
zone delete \fIZONE\fP
.INDENT 0.0
.INDENT 3.5
Delete the zone named \fIZONE\fP\&.
.UNINDENT
.UNINDENT
.sp
zone edit \fIZONE\fP
.INDENT 0.0
.INDENT 3.5
Opens \fIZONE\fP in zonefile format (regardless of backend it was loaded
from) in the editor set in the environment variable \fBEDITOR\fP\&. if
\fBEDITOR\fP is empty, \fIpdnsutil\fP falls back to using \fIeditor\fP\&.
.UNINDENT
.UNINDENT
.sp
zone increase\-serial \fIZONE\fP
.INDENT 0.0
.INDENT 3.5
Increases the SOA\-serial by 1. Uses SOA\-EDIT.
.UNINDENT
.UNINDENT
.sp
zone list \fIZONE\fP
.INDENT 0.0
.INDENT 3.5
Show all records for \fIZONE\fP\&.
.UNINDENT
.UNINDENT
.sp
zone list\-all \fIKIND\fP
.INDENT 0.0
.INDENT 3.5
List all active zone names of the given \fIKIND\fP (primary, secondary,
native, producer, consumer), or all if none given. Passing \-\-verbose or
\-v will also include disabled or empty zones.
.UNINDENT
.UNINDENT
.sp
zone load \fIZONE\fP \fIFILE\fP
.INDENT 0.0
.INDENT 3.5
Load records for \fIZONE\fP from \fIFILE\fP\&. If \fIZONE\fP already exists, all
records are overwritten, this operation is atomic. If \fIZONE\fP doesn\(aqt
exist, it is created.
.UNINDENT
.UNINDENT
.sp
zone set\-account \fIZONE\fP \fIACCOUNT\fP
.INDENT 0.0
.INDENT 3.5
Change the account (owner) of \fIZONE\fP to \fIACCOUNT\fP\&.
.UNINDENT
.UNINDENT
.sp
zone set\-kind \fIZONE\fP \fIKIND\fP
.INDENT 0.0
.INDENT 3.5
Change the kind of \fIZONE\fP to \fIKIND\fP (primary, secondary, native, producer,
consumer).
.UNINDENT
.UNINDENT
.sp
zone set\-option \fIZONE\fP [\fIproducer\fP | \fIconsumer\fP] [\fIcoo\fP | \fIunique\fP | \fIgroup\fP] \fIVALUE\fP [\fIVALUE\fP ...]
.INDENT 0.0
.INDENT 3.5
Set or remove an option for \fIZONE\fP\&. Providing an empty value removes
an option.
.UNINDENT
.UNINDENT
.sp
zone set\-options\-json \fIZONE\fP \fIJSONFILE\fP
.INDENT 0.0
.INDENT 3.5
Change the options of \fIZONE\fP to the contents of \fIJSONFILE\fP\&.
.UNINDENT
.UNINDENT
.sp
zone zonemd\-verify\-file \fIZONE\fP \fIFILE\fP
.INDENT 0.0
.INDENT 3.5
Validate ZONEMD for \fIZONE\fP read from \fIFILE\fP\&.
.UNINDENT
.UNINDENT
.SH SECONDARY ZONE COMMANDS
.sp
zone change\-primary \fIZONE\fP \fIPRIMARY\fP [\fIPRIMARY\fP]...
.INDENT 0.0
.INDENT 3.5
Change the primaries for secondary zone \fIZONE\fP to new primaries \fIPRIMARY\fP\&. All
\fIPRIMARY\fPs need to to be space\-separated IP addresses with an optional port.
.UNINDENT
.UNINDENT
.sp
zone create\-secondary \fIZONE\fP \fIPRIMARY\fP [\fIPRIMARY\fP]...
.INDENT 0.0
.INDENT 3.5
Create a new secondary zone \fIZONE\fP with primaries \fIPRIMARY\fP\&. All \fIPRIMARY\fPs
need to to be space\-separated IP addresses with an optional port.
.UNINDENT
.UNINDENT
.SH DNSSEC-RELATED COMMANDS
.sp
Several commands manipulate the DNSSEC keys and options for zones. Some
of these commands require an \fIALGORITHM\fP to be set. The following
algorithms are supported:
.INDENT 0.0
.IP \(bu 2
rsasha1
.IP \(bu 2
rsasha1\-nsec3\-sha1
.IP \(bu 2
rsasha256
.IP \(bu 2
rsasha512
.IP \(bu 2
ecdsa256
.IP \(bu 2
ecdsa384
.IP \(bu 2
ed25519
.IP \(bu 2
ed448
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
ed25519 and ed448 algorithms will only be available if adequate cryptographic
libraries have been available while compiling PowerDNS on your particular
system.
.UNINDENT
.UNINDENT
.sp
In addition to the algorithm, some commands below may ask for a key size in
bits. The key size may be omitted for the ECC algorithms, which support only
one valid size per algorithm; for ECDSA256 and ED25519, it is 256;
for ECDSA384, it is 384; and for ED448, it is... 456.
.sp
zone dnssec\-disable \fIZONE\fP
.INDENT 0.0
.INDENT 3.5
Deactivate all keys and unset PRESIGNED in \fIZONE\fP\&.
.UNINDENT
.UNINDENT
.sp
zone export\-dnskey \fIZONE\fP \fIKEY_ID\fP
.INDENT 0.0
.INDENT 3.5
Export DNSKEY and DS of key with key id \fIKEY_ID\fP within zone \fIZONE\fP to
standard output.
.UNINDENT
.UNINDENT
.sp
zone export\-ds \fIZONE\fP
.INDENT 0.0
.INDENT 3.5
Export all KSK DS records for \fIZONE\fP to standard output.
.UNINDENT
.UNINDENT
.sp
zone list\-keys [\fIZONE\fP]
.INDENT 0.0
.INDENT 3.5
List DNSSEC information for all keys or for \fIZONE\fP only. Passing
\-\-verbose or \-v will also include the keys for disabled or empty zones.
.UNINDENT
.UNINDENT
.sp
zone rectify \fIZONE\fP
.INDENT 0.0
.INDENT 3.5
Calculates the \(aqordername\(aq and \(aqauth\(aq fields for a zone called
\fIZONE\fP so they comply with DNSSEC settings. Can be used to fix up
migrated data.
.UNINDENT
.UNINDENT
.sp
zone rectify\-all
.INDENT 0.0
.INDENT 3.5
Calculates the \(aqordername\(aq and \(aqauth\(aq fields for all zones so they
comply with DNSSEC settings. Can be used to fix up migrated data.
.UNINDENT
.UNINDENT
.sp
zone secure \fIZONE\fP
.INDENT 0.0
.INDENT 3.5
Configures a zone called \fIZONE\fP with reasonable DNSSEC settings. You
should manually run \(aqpdnsutil zone rectify\(aq afterwards.
.UNINDENT
.UNINDENT
.sp
zone secure\-all [\fBincrease\-serial\fP]
.INDENT 0.0
.INDENT 3.5
Configures all zones that are not currently signed with reasonable
DNSSEC settings. Setting \fBincrease\-serial\fP will increase the
serial of those zones too. You should manually run \(aqpdnsutil
zone rectify\-all\(aq afterwards.
.UNINDENT
.UNINDENT
.sp
zone set\-nsec3 \fIZONE\fP [\(aq\fIHASH\-ALGORITHM\fP \fIFLAGS\fP \fIITERATIONS\fP \fISALT\fP\(aq] [\fBnarrow\fP]
.INDENT 0.0
.INDENT 3.5
Sets NSEC3 parameters for this zone. The quoted parameters are 4
values that are used for the NSEC3PARAM record and decide how
NSEC3 records are created. The NSEC3 parameters must be quoted on
the command line. \fIHASH\-ALGORITHM\fP must be 1 (SHA\-1). Setting
\fIFLAGS\fP to 1 enables NSEC3 opt\-out operation. Only do this if you
know you need it. For \fIITERATIONS\fP, please consult
\fI\%RFC 5155\fP\&.
.sp
And be aware that a high number might overload validating
resolvers and that a limit can be set with \fBmax\-nsec3\-iterations\fP
in \fBpdns.conf\fP\&. The \fISALT\fP is a hexadecimal string encoding the bits
for the salt, or \- to use no salt.
.sp
Setting \fBnarrow\fP will make PowerDNS send out "white lies" (\fI\%RFC 7129\fP)
about the next secure record to prevent zone enumeration. Instead of
looking it up in the database, it will send out the hash + 1 as the next
secure record. Narrow mode requires online signing capabilities by the
nameserver and therefore zone transfers are denied.
.sp
If only the zone is provided as argument, the 4\-parameter quoted string
defaults to \fB\(aq1 0 0 \-\(aq\fP, as recommended by \fI\%RFC 9276\fP\&.
.sp
A sample commandline would be:
.sp
\fBpdnsutil zone set\-nsec3 powerdnssec.org \(aq1 1 1 ab\(aq narrow\fP
.sp
\fBWARNING\fP: If running in RSASHA1 mode (algorithm 5 or 7), switching
from NSEC to NSEC3 will require a DS update in the parent zone.
.UNINDENT
.UNINDENT
.sp
zone set\-presigned \fIZONE\fP
.INDENT 0.0
.INDENT 3.5
Switches \fIZONE\fP to presigned operation, utilizing in\-zone RRSIGs.
.UNINDENT
.UNINDENT
.sp
zone set\-publish\-cdnskey \fIZONE\fP [\fBdelete\fP]
.INDENT 0.0
.INDENT 3.5
Set \fIZONE\fP to publish CDNSKEY records. Add \(aqdelete\(aq to publish a CDNSKEY
with a DNSSEC delete algorithm.
.UNINDENT
.UNINDENT
.sp
zone set\-publish\-cds \fIZONE\fP [\fIDIGESTALGOS\fP]
.INDENT 0.0
.INDENT 3.5
Set \fIZONE\fP to respond to queries for its CDS records. the optional
argument \fIDIGESTALGOS\fP should be a comma\-separated list of DS
algorithms to use. By default, this is 2 (SHA\-256). 0 will publish a
CDS with a DNSSEC delete algorithm.
.UNINDENT
.UNINDENT
.sp
zone show \fIZONE\fP
.INDENT 0.0
.INDENT 3.5
Shows various details of the zone called \fIZONE\fP, including its
DNSSEC related settings.
.UNINDENT
.UNINDENT
.sp
zone unset\-nsec3 \fIZONE\fP
.INDENT 0.0
.INDENT 3.5
Converts \fIZONE\fP to NSEC operations. \fBWARNING\fP: If running in
RSASHA1 mode (algorithm 5 or 7), switching from NSEC to NSEC3 will
require a DS update at the parent zone!
.UNINDENT
.UNINDENT
.sp
zone unset\-presigned \fIZONE\fP
.INDENT 0.0
.INDENT 3.5
Disables presigned operation for \fIZONE\fP\&.
.UNINDENT
.UNINDENT
.sp
zone unset\-publish\-cdnskey \fIZONE\fP
.INDENT 0.0
.INDENT 3.5
Set \fIZONE\fP to stop publishing CDNSKEY records.
.UNINDENT
.UNINDENT
.sp
zone unset\-publish\-cds \fIZONE\fP
.INDENT 0.0
.INDENT 3.5
Set \fIZONE\fP to stop responding to queries for its CDS records.
.UNINDENT
.UNINDENT
.SH ZONE KEY COMMANDS
.sp
zone activate\-key \fIZONE\fP \fIKEY_ID\fP
.INDENT 0.0
.INDENT 3.5
Activate a key with id \fIKEY_ID\fP within a zone called \fIZONE\fP\&.
.UNINDENT
.UNINDENT
.sp
zone add\-key \fIZONE\fP [\fBKSK\fP,\fBZSK\fP] [\fBactive\fP,\fBinactive\fP] [\fBpublished\fP,\fBunpublished\fP] \fIALGORITHM\fP [\fIKEYBITS\fP]
.INDENT 0.0
.INDENT 3.5
Create a new key for zone \fIZONE\fP, and make it a KSK (default) or a ZSK, with
the specified \fIALGORITHM\fP and \fIKEYBITS\fP\&. If \fIKEYBITS\fP is omitted, the value
of setting\-default\-ksk\-size or setting\-default\-zsk\-size are
used.
.sp
The key is inactive by default, set it to \fBactive\fP to immediately use it
to sign \fIZONE\fP\&. The key is published in the zone by default, set it to
\fBunpublished\fP to keep it from being returned in a DNSKEY query, which is
useful for algorithm rollovers.
.sp
Prints the id of the added key.
.UNINDENT
.UNINDENT
.sp
zone deactivate\-key \fIZONE\fP \fIKEY_ID\fP
.INDENT 0.0
.INDENT 3.5
Deactivate a key with id KEY_ID within a zone called \fIZONE\fP\&.
.UNINDENT
.UNINDENT
.sp
zone export\-key \fIZONE\fP \fIKEY_ID\fP
.INDENT 0.0
.INDENT 3.5
Export full (private) key with key id \fIKEY_ID\fP within zone \fIZONE\fP to
standard output. The format used is compatible with BIND and NSD/LDNS.
.UNINDENT
.UNINDENT
.sp
zone export\-key\-pem \fIZONE\fP \fIKEY_ID\fP
.INDENT 0.0
.INDENT 3.5
Export full (private) key with key id \fIKEY_ID\fP within zone \fIZONE\fP to
standard output in the PEM file format. The format is compatible with
many non\-DNS software products.
.UNINDENT
.UNINDENT
.sp
zone generate\-key {\fBKSK\fP,\fBZSK\fP} [\fIALGORITHM\fP] [\fIKEYBITS\fP]
.INDENT 0.0
.INDENT 3.5
Generate a ZSK or KSK with specified algorithm and bits and print it
on standard output. If \fIALGORITHM\fP is not set, ECDSA256 is used.
If \fIKEYBITS\fP is not set, an appropriate keysize is selected
for \fIALGORITHM\fP: for RSA keys, 2048 bits for KSK and 1024 bits for ZSK;
for ECC keys, the algorithm\-required size as mentioned above.
.UNINDENT
.UNINDENT
.sp
zone import\-key \fIZONE\fP \fIFILE\fP [\fBKSK\fP,\fBZSK\fP] [\fBactive\fP,\fBinactive\fP] [\fBpublished\fP,\fBunpublished\fP]
.INDENT 0.0
.INDENT 3.5
Import from \fIFILE\fP a full (private) key for the zone \fIZONE\fP\&. The
format used is compatible with BIND and NSD/LDNS. \fBKSK\fP or \fBZSK\fP
specifies the flags this key should have on import. Defaults to KSK,
active and published. Prints the id of the added key.
.UNINDENT
.UNINDENT
.sp
zone import\-key\-pem \fIZONE\fP \fIFILE\fP \fIALGORITHM\fP {\fBKSK\fP,\fBZSK\fP}
.INDENT 0.0
.INDENT 3.5
Import from PEM \fIFILE\fP a full (private) key for the zone \fIZONE\fP with a
specified \fIALGORITHM\fP\&. The format used is compatible with many non\-DNS
software products. \fBKSK\fP or \fBZSK\fP specifies the flags this key should
have on import. Prints the id of the added key.
.UNINDENT
.UNINDENT
.sp
zone publish\-key \fIZONE\fP \fIKEY_ID\fP
.INDENT 0.0
.INDENT 3.5
Publish the key with id \fIKEY_ID\fP within zone \fIZONE\fP\&.
.UNINDENT
.UNINDENT
.sp
zone remove\-key \fIZONE\fP \fIKEY_ID\fP
.INDENT 0.0
.INDENT 3.5
Remove a key with id \fIKEY_ID\fP from zone \fIZONE\fP\&.
.UNINDENT
.UNINDENT
.sp
zone unpublish\-key \fIZONE\fP \fIKEY_ID\fP
.INDENT 0.0
.INDENT 3.5
Unpublish the key with id \fIKEY_ID\fP within zone \fIZONE\fP\&.
.UNINDENT
.UNINDENT
.SH OTHER/MISCELLANEOUS COMMANDS
.sp
b2b\-migrate \fIOLD\fP \fINEW\fP
.INDENT 0.0
.INDENT 3.5
Migrate data from one backend to another.
Needs \fBlaunch=OLD,NEW\fP in the configuration.
.UNINDENT
.UNINDENT
.sp
backend\-cmd \fIBACKEND\fP \fICMD\fP [\fICMD...\fP]
.INDENT 0.0
.INDENT 3.5
Send a text command to a backend for execution. GSQL backends will
take SQL commands, other backends may take different things. Be
careful!
.UNINDENT
.UNINDENT
.sp
backend\-lookup \fIBACKEND\fP \fINAME\fP [\fITYPE\fP [\fICLIENT_IP_SUBNET\fP]]
.INDENT 0.0
.INDENT 3.5
Perform a backend record lookup.
.UNINDENT
.UNINDENT
.sp
bench\-db [\fIFILE\fP]
.INDENT 0.0
.INDENT 3.5
Perform a benchmark of the backend\-database.
\fIFILE\fP can be a file with a list, one per line, of zone names to use for this.
If \fIFILE\fP is not specified, powerdns.com is used.
.UNINDENT
.UNINDENT
.sp
create\-bind\-db \fIFILENAME\fP
.INDENT 0.0
.INDENT 3.5
Create DNSSEC database (sqlite3) at \fIFILENAME\fP for the BIND backend.
Remember to set \fBbind\-dnssec\-db=*FILE*\fP in your \fBpdns.conf\fP\&.
.UNINDENT
.UNINDENT
.sp
hash\-password [\fIWORK_FACTOR\fP]
.INDENT 0.0
.INDENT 3.5
This convenience command reads a password (not echoed) from standard
input and returns a hashed and salted version, for use as a webserver
password or api key.
An optional scrypt work factor can be specified, in powers of two,
otherwise it defaults to 1024.
.UNINDENT
.UNINDENT
.sp
ipdecrypt \fIIP_ADDRESS\fP PASSPHRASE_OR_KEY [\fBkey\fP]
.INDENT 0.0
.INDENT 3.5
Decrypt an IP address according to the \(aqipcipher\(aq standard. If the
passphrase is a base64 key, add the word "key" after it.
.UNINDENT
.UNINDENT
.sp
ipencrypt \fIIP_ADDRESS\fP PASSPHRASE_OR_KEY [\fBkey\fP]
.INDENT 0.0
.INDENT 3.5
Encrypt an IP address according to the \(aqipcipher\(aq standard. If the
passphrase is a base64 key, add the word "key" after it.
.UNINDENT
.UNINDENT
.sp
list\-algorithms [with\-backend]
.INDENT 0.0
.INDENT 3.5
List all DNSSEC algorithms supported, optionally also listing the
cryptographic library used if "with\-backend" is specified.
.UNINDENT
.UNINDENT
.sp
test\-schema \fIZONE\fP
.INDENT 0.0
.INDENT 3.5
Test database schema, this creates the zone \fIZONE\fP
.UNINDENT
.UNINDENT
.sp
raw\-lua\-from\-content \fITYPE\fP \fICONTENT\fP
.INDENT 0.0
.INDENT 3.5
Display record contents in a form suitable for dnsdist\(aqs \fISpoofRawAction\fP\&.
.UNINDENT
.UNINDENT
.SH SEE ALSO
.sp
pdns_server (1), pdns_control (1)
.SH AUTHOR
PowerDNS.COM BV
.SH COPYRIGHT
PowerDNS.COM BV
.\" Generated by docutils manpage writer.
.