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
|
<!-- ---
title: NTP-CTL(8) ntpd-rs 1.6.2 | ntpd-rs
--- -->
# 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 address
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 defaults to
*plain*. Alternatively the format *prometheus* is available to display the
output in an OpenMetrics/Prometheus compatible format.
`-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 command 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-daemon.8.md),
[ntp-metrics-exporter(8)](ntp-metrics-exporter.8.md),
[ntp.toml(5)](ntp.toml.5.md)
|
