preview/push
preview
reads the dnsconfig.js file (or equivalent), determines what changes are to be made, and prints them. push
is the same but executes the changes.
--config name
Specifies the name of the main configuration file, normally
dnsconfig.js
.
--creds name
Specifies the name of the credentials file, normally
creds.json
. Typically the file is read. If the executable bit is set, the file is executed and the output is used as the configuration. See [creds.json][creds-json.md] for details.
--providers name,name2
Specifies a comma-separated list of providers to enable. The default is all providers. A provider can opt out of being in the default list by
"_exclude_from_defaults": "true"
to the credentials entry for that provider. In that case, the provider will only be activated if it is included in--providers
.
--domains value
Specifies a comma-separated list of domains to include. Typically all domains are included in
preview
/push
. Wildcards are not permitted except*
at the start of the entry. For example,--domains example.com,*.in-addr.arpa
would includeexample.com
plus all reverse lookup domains.
--v foo=bar
Sets the variable
foo
to the valuebar
prior to interpreting the configuration file. Multiple-v
options can be used.
--notify
Enables sending notifications to the destinations configured in
creds.json
.
--dev
Developer mode. Normally
helpers.js
is embedded in the dnscontrol executable. With this flag, the local filehelpers.js
is read instead.
--expect-no-changes
If set, a non-zero exit code is returned if there are changes. Normally DNSControl sets the exit code based on whether or not there were protocol errors or other reasons the program can not continue. With this flag set, the exit code indicates if any changes were required. This is typically used with
preview
to allow scripts to determine if changes would happen ifpush
was used. For example, one might want to rundnscontrol preview --expect-no-changes
daily to determine if changes have been made to a domain outside of DNSControl.
--no-populate
Do not auto-create non-existing zones at the provider. Normally non-existent zones are automatically created at a provider (unless the provider does not implement zone creation). This flag disables that feature.
--full
Add headings, providers names, notifications of no changes, etc. to the output. Normally the output of
preview
/push
is extremely brief. This makes the output more verbose. Useful for debugging.
--bindserial value
Force BIND serial numbers to this value. Normally the BIND provider generates SOA serial numbers automatically. This flag forces the serial number generator to output the value specified for all domains. This is generally used for reproducibility in testing pipelines.
--report name
Write a machine-parseable report of corrections to the file named
name
. If no name is specified, no report is generated. See JSON Reports
ppreview/ppush
Starting in v4.9
The ppreview
/ppush
subcommands are a preview of a future feature where zone data is gathered concurrently. The commands will go away when they replace the existing preview
/push
commands.
--cmode value
Concurrency mode. Specifies what kind of providers should be run concurrently.
default
-- Providers are run sequentially or concurrently depending on whether the provider is marked as having been tested to run concurrently.none
-- All providers are run sequentially. This is the safest mode. It can be used if a concurrency bug is discovered.all
-- This is unsafe. It runs all providers concurrently, even the ones that have not be validated to run concurrently. It is generally only used for demonstrating bugs.
Last updated