NAME
spanel-build-bind-zones-from-powerdns-db - Build BIND zones from PowerDNS zones in database
VERSION
This document describes version 0.002 of spanel-build-bind-zones-from-powerdns-db (from Perl distribution App-Spanel-BuildBindZonesFromPowerDNSDB), released on 2019-08-29.
SYNOPSIS
Usage:
% spanel-build-bind-zones-from-powerdns-db [options]
DESCRIPTION
This script will export domains in your PowerDNS database as BIND zones then write them to the current directory with names <servername>/db.<domainname> (so example.com
from server123
will be written to ./server123/db.example.com
).
Will not override existing files unless --overwrite
(-O
) is specified.
You can select domains to export using include-domain
option.
OPTIONS
*
marks required options.
Main options
- --default-ns-json=s
-
See
--default-ns
. - --default-ns=s@
-
Can be specified multiple times.
- --domain-id=s
- --overwrite, -O
-
Whether to overwrite existing output files.
Database options
Filtering options
- --exclude-server=s@
-
Can be specified multiple times.
- --exclude-servers-json=s
-
See
--exclude-server
. - --include-domain=s@
-
Can be specified multiple times.
- --include-domains-json=s
-
See
--include-domain
. - --include-server=s@
-
Can be specified multiple times.
- --include-servers-json=s
-
See
--include-server
.
Logging options
- --debug
-
Shortcut for --log-level=debug.
- --log-level=s
-
Set log level.
- --quiet
-
Shortcut for --log-level=error.
- --trace
-
Shortcut for --log-level=trace.
- --verbose
-
Shortcut for --log-level=info.
Output options
- --format=s
-
Choose output format, e.g. json, text.
Default value:
undef
- --json
-
Set output format to json.
- --naked-res
-
When outputing as JSON, strip result envelope.
Default value:
0
By default, when outputing as JSON, the full enveloped result is returned, e.g.:
[200,"OK",[1,2,3],{"func.extra"=>4}]
The reason is so you can get the status (1st element), status message (2nd element) as well as result metadata/extra result (4th element) instead of just the result (3rd element). However, sometimes you want just the result, e.g. when you want to pipe the result for more post-processing. In this case you can use `--naked-res` so you just get:
[1,2,3]
Workaround options
- --no-workaround-cname-and-other-data
-
This is a workaround for a common misconfiguration in PowerDNS DB. Bind will reject the whole zone if there is CNAME record for a name (e.g. 'www') as well as other record types (e.g. 'A' or 'TXT'). The workaround is to skip those A/TXT records and only keep the CNAME record.
- --no-workaround-no-ns
-
This is a workaround for a common misconfiguration in PowerDNS DB. This will add some NS records specified in `default_ns`.
- --no-workaround-root-cname
-
CNAME on a root node (host='') does not make sense, so the workaround is to ignore the root CNAME.
Other options
COMPLETION
This script has shell tab completion capability with support for several shells.
bash
To activate bash completion for this script, put:
complete -C spanel-build-bind-zones-from-powerdns-db spanel-build-bind-zones-from-powerdns-db
in your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.
It is recommended, however, that you install modules using cpanm-shcompgen which can activate shell completion for scripts immediately.
tcsh
To activate tcsh completion for this script, put:
complete spanel-build-bind-zones-from-powerdns-db 'p/*/`spanel-build-bind-zones-from-powerdns-db`/'
in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.
It is also recommended to install shcompgen (see above).
other shells
For fish and zsh, install shcompgen as described above.
HOMEPAGE
Please visit the project's homepage at https://metacpan.org/release/App-Spanel-BuildBindZonesFromPowerDNSDB.
SOURCE
Source repository is at https://github.com/perlancar/perl-App-Spanel-BuildBindZonesFromPowerDNSDB.
BUGS
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-Spanel-BuildBindZonesFromPowerDNSDB
When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.
AUTHOR
perlancar <perlancar@cpan.org>
COPYRIGHT AND LICENSE
This software is copyright (c) 2019 by perlancar@cpan.org.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.