home | help
NTP-CTL(8)			     ntpd-rs			      NTP-CTL(8)

NAME
     ntp-ctl - management client for the ntpd-rs ntp-daemon process

SYNOPSIS
     ntp-ctl validate [-c path]
     ntp-ctl status [-f format] [-c path]
     ntp-ctl force-sync [-c path]
     ntp-ctl -h
     ntp-ctl -v

DESCRIPTION
     The  ntp-ctl  management  client  allows  management of some aspects of the
     ntpd-rs daemon.  Currently the management client only allows displaying the
     current status of the daemon and validating a configuration file for  usage
     with the daemon.

OPTIONS
     -c path, --config=path
	    Path to the configuration file from which the observation socket ad-
	    dress  will  be  retrieved.   If  not  specified  this  defaults  to
	    /etc/ntpd-rs/ntp.toml.

     -f format, --format=format
	    The output format for the status command.  If not specified this de-
	    faults to plain.  Alternatively the format prometheus  is  available
	    to	display  the output in an OpenMetrics/Prometheus compatible for-
	    mat.

     -h, --help
	    Display usage instructions.

     -v, --version
	    Display version information.

COMMANDS
     validate
	    Checks if the configuration specified (or  /etc/ntpd-rs/ntp.toml  by
	    default) is valid.

     status
	    Returns status information about the current state of the ntp-daemon
	    that the client connects to.

     force-sync
	    Interactively run a single synchronization of your clock.  This com-
	    mand can be used to do a one-off synchronization to the time sources
	    configured in your configuration file.  This command should never be
	    used without any validation by a human operator.

SEE ALSO
     ntp-daemon(8), ntp-metrics-exporter(8), ntp.toml(5)

ntpd-rs 1.9.0							      NTP-CTL(8)

home | help