Go to main content

man pages section 8: System Administration Commands

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

named-checkconf (8)

Name

named-checkconf - named configuration file syntax checking tool

Synopsis

named-checkconf [-chjlvz] [-p [-x ]] [-t directory] {filename}

Description

NAMED-CHECKCONF(8)                  BIND 9                  NAMED-CHECKCONF(8)



NAME
       named-checkconf - named configuration file syntax checking tool

SYNOPSIS
       named-checkconf [-chjlvz] [-p [-x ]] [-t directory] {filename}

DESCRIPTION
       named-checkconf  checks  the  syntax, but not the semantics, of a named
       configuration file. The file, along with all files included by  it,  is
       parsed  and  checked  for  syntax  errors.  If  no  file  is specified,
       /etc/named.conf is read by default.

       Note: files that named reads  in  separate  parser  contexts,  such  as
       rndc.key  and bind.keys, are not automatically read by named-checkconf.
       Configuration errors in these files may cause named  to  fail  to  run,
       even  if  named-checkconf was successful.  However, named-checkconf can
       be run on these files explicitly.

OPTIONS
       -h     This option prints the usage summary and exits.

       -j     When loading a zonefile, this option instructs named to read the
              journal if it exists.

       -l     This  option lists all the configured zones. Each line of output
              contains the zone name, class (e.g. IN), view,  and  type  (e.g.
              primary or secondary).

       -c     This  option specifies that only the "core" configuration should
              be checked. This suppresses the loading of plugin  modules,  and
              causes all parameters to plugin statements to be ignored.

       -i     This option ignores warnings on deprecated options.

       -p     This  option  prints  out  the  named.conf and included files in
              canonical form if no errors  were  detected.  See  also  the  -x
              option.

       -t directory
              This  option  instructs  named  to  chroot to directory, so that
              include directives in the configuration file are processed as if
              run by a similarly chrooted named.

       -v     This  option  prints  the version of the named-checkconf program
              and exits.

       -x     When printing the configuration files in  canonical  form,  this
              option obscures shared secrets by replacing them with strings of
              question marks (?). This allows the contents of  named.conf  and
              related  files  to  be shared - for example, when submitting bug
              reports - without compromising private data. This option  cannot
              be used without -p.

       -z     This  option  performs  a test load of all zones of type primary
              found in named.conf.

       filename
              This indicates the name of the configuration file to be checked.
              If not specified, it defaults to /etc/named.conf.

RETURN VALUES
       named-checkconf returns an exit status of 1 if errors were detected and
       0 otherwise.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+--------------------------+
       |ATTRIBUTE TYPE |     ATTRIBUTE VALUE      |
       +---------------+--------------------------+
       |Availability   | network/dns/bind         |
       +---------------+--------------------------+
       |Stability      | Pass-through uncommitted |
       +---------------+--------------------------+

SEE ALSO
       named(8), named-checkzone(8), BIND 9 Administrator Reference Manual.

AUTHOR
       Internet Systems Consortium

COPYRIGHT
       2022, Internet Systems Consortium



NOTES
       Source code for open source software components in Oracle  Solaris  can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source                was                downloaded                from
       http://ftp.isc.org/isc/bind9/9.16.29/bind-9.16.29.tar.xz.

       Further information about this software can be found on the open source
       community website at http://www.isc.org/software/bind/.



9.16.29                           2022-05-10                NAMED-CHECKCONF(8)