767173cec2
Update 4.2.8p14 --> 4.2.8p15 Summary: Systems that use a CMAC algorithm in ntp.keys will not release a bit of memory on each packet that uses a CMAC keyid, eventually causing ntpd to run out of memory and fail. The CMAC cleanup from https://bugs.ntp.org/3447, part of ntp-4.2.8p11, introduced a bug whereby the CMAC data structure was no longer completely removed. MFC after: 3 days Security: NTP Bug 3661
1589 lines
40 KiB
Plaintext
1589 lines
40 KiB
Plaintext
.de1 NOP
|
|
. it 1 an-trap
|
|
. if \\n[.$] \,\\$*\/
|
|
..
|
|
.ie t \
|
|
.ds B-Font [CB]
|
|
.ds I-Font [CI]
|
|
.ds R-Font [CR]
|
|
.el \
|
|
.ds B-Font B
|
|
.ds I-Font I
|
|
.ds R-Font R
|
|
.TH ntpq 1ntpqman "23 Jun 2020" "4.2.8p15" "User Commands"
|
|
.\"
|
|
.\" EDIT THIS FILE WITH CAUTION (in-mem file)
|
|
.\"
|
|
.\" It has been AutoGen-ed June 23, 2020 at 02:20:56 AM by AutoGen 5.18.5
|
|
.\" From the definitions ntpq-opts.def
|
|
.\" and the template file agman-cmd.tpl
|
|
.SH NAME
|
|
\f\*[B-Font]ntpq\fP
|
|
\- standard NTP query program
|
|
.SH SYNOPSIS
|
|
\f\*[B-Font]ntpq\fP
|
|
.\" Mixture of short (flag) options and long options
|
|
[\f\*[B-Font]\-flags\f[]]
|
|
[\f\*[B-Font]\-flag\f[] [\f\*[I-Font]value\f[]]]
|
|
[\f\*[B-Font]\-\-option-name\f[][[=| ]\f\*[I-Font]value\f[]]]
|
|
[ host ...]
|
|
.sp \n(Ppu
|
|
.ne 2
|
|
|
|
.SH DESCRIPTION
|
|
.sp \n(Ppu
|
|
.ne 2
|
|
|
|
The
|
|
\f\*[B-Font]ntpq\fP
|
|
utility program is used to query NTP servers to monitor NTP operations
|
|
and performance, requesting
|
|
information about current state and/or changes in that state.
|
|
The program may be run either in interactive mode or controlled using
|
|
command line arguments.
|
|
Requests to read and write arbitrary
|
|
variables can be assembled, with raw and pretty-printed output
|
|
options being available.
|
|
The
|
|
\f\*[B-Font]ntpq\fP
|
|
utility can also obtain and print a
|
|
list of peers in a common format by sending multiple queries to the
|
|
server.
|
|
.sp \n(Ppu
|
|
.ne 2
|
|
|
|
If one or more request options is included on the command line
|
|
when
|
|
\f\*[B-Font]ntpq\fP
|
|
is executed, each of the requests will be sent
|
|
to the NTP servers running on each of the hosts given as command
|
|
line arguments, or on localhost by default.
|
|
If no request options
|
|
are given,
|
|
\f\*[B-Font]ntpq\fP
|
|
will attempt to read commands from the
|
|
standard input and execute these on the NTP server running on the
|
|
first host given on the command line, again defaulting to localhost
|
|
when no other host is specified.
|
|
The
|
|
\f\*[B-Font]ntpq\fP
|
|
utility will prompt for
|
|
commands if the standard input is a terminal device.
|
|
.sp \n(Ppu
|
|
.ne 2
|
|
|
|
\f\*[B-Font]ntpq\fP
|
|
uses NTP mode 6 packets to communicate with the
|
|
NTP server, and hence can be used to query any compatible server on
|
|
the network which permits it.
|
|
Note that since NTP is a UDP protocol
|
|
this communication will be somewhat unreliable, especially over
|
|
large distances in terms of network topology.
|
|
The
|
|
\f\*[B-Font]ntpq\fP
|
|
utility makes
|
|
one attempt to retransmit requests, and will time requests out if
|
|
the remote host is not heard from within a suitable timeout
|
|
time.
|
|
.sp \n(Ppu
|
|
.ne 2
|
|
|
|
Note that in contexts where a host name is expected, a
|
|
\f\*[B-Font]\-4\f[]
|
|
qualifier preceding the host name forces resolution to the IPv4
|
|
namespace, while a
|
|
\f\*[B-Font]\-6\f[]
|
|
qualifier forces resolution to the IPv6 namespace.
|
|
For examples and usage, see the
|
|
\*[Lq]NTP Debugging Techniques\*[Rq]
|
|
page.
|
|
.sp \n(Ppu
|
|
.ne 2
|
|
|
|
Specifying a
|
|
command line option other than
|
|
\f\*[B-Font]\-i\f[]
|
|
or
|
|
\f\*[B-Font]\-n\f[]
|
|
will
|
|
cause the specified query (queries) to be sent to the indicated
|
|
host(s) immediately.
|
|
Otherwise,
|
|
\f\*[B-Font]ntpq\fP
|
|
will attempt to read
|
|
interactive format commands from the standard input.
|
|
.SS "Internal Commands"
|
|
.sp \n(Ppu
|
|
.ne 2
|
|
|
|
Interactive format commands consist of a keyword followed by zero
|
|
to four arguments.
|
|
Only enough characters of the full keyword to
|
|
uniquely identify the command need be typed.
|
|
.sp \n(Ppu
|
|
.ne 2
|
|
|
|
A
|
|
number of interactive format commands are executed entirely within
|
|
the
|
|
\f\*[B-Font]ntpq\fP
|
|
utility itself and do not result in NTP
|
|
requests being sent to a server.
|
|
These are described following.
|
|
.TP 15
|
|
.NOP \f\*[B-Font]?\f[] [\f\*[I-Font]command\f[]]
|
|
.br
|
|
.ns
|
|
.TP 15
|
|
.NOP \f\*[B-Font]help\f[] [\f\*[I-Font]command\f[]]
|
|
A
|
|
\[oq]\&?\[cq]
|
|
by itself will print a list of all the commands
|
|
known to
|
|
\f\*[B-Font]ntpq\fP.
|
|
A
|
|
\[oq]\&?\[cq]
|
|
followed by a command name will print function and usage
|
|
information about the command.
|
|
.br
|
|
.ns
|
|
.TP 15
|
|
.NOP \f\*[B-Font]addvars\f[] \f\*[I-Font]name\f[][\&=\f\*[I-Font]value\f[]][,...]
|
|
.br
|
|
.ns
|
|
.TP 15
|
|
.NOP \f\*[B-Font]rmvars\f[] \f\*[I-Font]name\f[][,...]
|
|
.br
|
|
.ns
|
|
.TP 15
|
|
.NOP \f\*[B-Font]clearvars\f[]
|
|
.br
|
|
.ns
|
|
.TP 15
|
|
.NOP \f\*[B-Font]showvars\f[]
|
|
The arguments to this command consist of a list of
|
|
items of the form
|
|
\f\*[I-Font]name\f[][\&=\f\*[I-Font]value\f[]],
|
|
where the
|
|
.NOP \&=\f\*[I-Font]value\f[]
|
|
is ignored, and can be omitted,
|
|
in requests to the server to read variables.
|
|
The
|
|
\f\*[B-Font]ntpq\fP
|
|
utility maintains an internal list in which data to be included in
|
|
messages can be assembled, and displayed or set using the
|
|
\f\*[B-Font]readlist\f[]
|
|
and
|
|
\f\*[B-Font]writelist\f[]
|
|
commands described below.
|
|
The
|
|
\f\*[B-Font]addvars\f[]
|
|
command allows variables and their optional values to be added to
|
|
the list.
|
|
If more than one variable is to be added, the list should
|
|
be comma-separated and not contain white space.
|
|
The
|
|
\f\*[B-Font]rmvars\f[]
|
|
command can be used to remove individual variables from the list,
|
|
while the
|
|
\f\*[B-Font]clearvars\f[]
|
|
command removes all variables from the
|
|
list.
|
|
The
|
|
\f\*[B-Font]showvars\f[]
|
|
command displays the current list of optional variables.
|
|
.br
|
|
.ns
|
|
.TP 15
|
|
.NOP \f\*[B-Font]authenticate\f[] [\f\*[B-Font]yes\f[]|\f\*[B-Font]no\f[]]
|
|
Normally
|
|
\f\*[B-Font]ntpq\fP
|
|
does not authenticate requests unless
|
|
they are write requests.
|
|
The command
|
|
\f\*[B-Font]authenticate\f[] \f\*[B-Font]yes\f[]
|
|
causes
|
|
\f\*[B-Font]ntpq\fP
|
|
to send authentication with all requests it
|
|
makes.
|
|
Authenticated requests causes some servers to handle
|
|
requests slightly differently.
|
|
The command
|
|
\f\*[B-Font]authenticate\f[]
|
|
causes
|
|
\f\*[B-Font]ntpq\fP
|
|
to display whether or not
|
|
it is currently authenticating requests.
|
|
.br
|
|
.ns
|
|
.TP 15
|
|
.NOP \f\*[B-Font]cooked\f[]
|
|
Causes output from query commands to be "cooked", so that
|
|
variables which are recognized by
|
|
\f\*[B-Font]ntpq\fP
|
|
will have their
|
|
values reformatted for human consumption.
|
|
Variables which
|
|
\f\*[B-Font]ntpq\fP
|
|
could not decode completely are
|
|
marked with a trailing
|
|
\[oq]\&?\[cq].
|
|
.br
|
|
.ns
|
|
.TP 15
|
|
.NOP \f\*[B-Font]debug\f[] [\f\*[B-Font]more\f[]|\f\*[B-Font]less\f[]|\f\*[B-Font]off\f[]]
|
|
With no argument, displays the current debug level.
|
|
Otherwise, the debugging level is changed as indicated.
|
|
.br
|
|
.ns
|
|
.TP 15
|
|
.NOP \f\*[B-Font]delay\f[] [\f\*[I-Font]milliseconds\f[]]
|
|
Specify a time interval to be added to timestamps included in
|
|
requests which require authentication.
|
|
This is used to enable
|
|
(unreliable) server reconfiguration over long delay network paths
|
|
or between machines whose clocks are unsynchronized.
|
|
Actually the
|
|
server does not now require timestamps in authenticated requests,
|
|
so this command may be obsolete.
|
|
Without any arguments, displays the current delay.
|
|
.br
|
|
.ns
|
|
.TP 15
|
|
.NOP \f\*[B-Font]drefid\f[] [\f\*[B-Font]hash\f[]|\f\*[B-Font]ipv4\f[]]
|
|
Display refids as IPv4 or hash.
|
|
Without any arguments, displays whether refids are shown as IPv4
|
|
addresses or hashes.
|
|
.br
|
|
.ns
|
|
.TP 15
|
|
.NOP \f\*[B-Font]exit\f[]
|
|
Exit
|
|
\f\*[B-Font]ntpq\fP.
|
|
.br
|
|
.ns
|
|
.TP 15
|
|
.NOP \f\*[B-Font]host\f[] [\f\*[I-Font]name\f[]]
|
|
Set the host to which future queries will be sent.
|
|
The
|
|
\f\*[I-Font]name\f[]
|
|
may be either a host name or a numeric address.
|
|
Without any arguments, displays the current host.
|
|
.br
|
|
.ns
|
|
.TP 15
|
|
.NOP \f\*[B-Font]hostnames\f[] [\f\*[B-Font]yes\f[]|\f\*[B-Font]no\f[]]
|
|
If
|
|
\f\*[B-Font]yes\f[]
|
|
is specified, host names are printed in
|
|
information displays.
|
|
If
|
|
\f\*[B-Font]no\f[]
|
|
is specified, numeric
|
|
addresses are printed instead.
|
|
The default is
|
|
\f\*[B-Font]yes\f[],
|
|
unless
|
|
modified using the command line
|
|
\f\*[B-Font]\-n\f[]
|
|
switch.
|
|
Without any arguments, displays whether host names or numeric addresses
|
|
are shown.
|
|
.br
|
|
.ns
|
|
.TP 15
|
|
.NOP \f\*[B-Font]keyid\f[] [\f\*[I-Font]keyid\f[]]
|
|
This command allows the specification of a key number to be
|
|
used to authenticate configuration requests.
|
|
This must correspond
|
|
to the
|
|
\f\*[B-Font]controlkey\f[]
|
|
key number the server has been configured to use for this
|
|
purpose.
|
|
Without any arguments, displays the current
|
|
\f\*[I-Font]keyid\f[].
|
|
.br
|
|
.ns
|
|
.TP 15
|
|
.NOP \f\*[B-Font]keytype\f[] [\f\*[I-Font]digest\f[]]
|
|
Specify the digest algorithm to use for authenticating requests, with default
|
|
\f\*[B-Font]MD5\f[].
|
|
If
|
|
\f\*[B-Font]ntpq\fP
|
|
was built with OpenSSL support, and OpenSSL is installed,
|
|
\f\*[I-Font]digest\f[]
|
|
can be any message digest algorithm supported by OpenSSL.
|
|
If no argument is given, the current
|
|
\f\*[B-Font]keytype\f[] \f\*[I-Font]digest\f[]
|
|
algorithm used is displayed.
|
|
.br
|
|
.ns
|
|
.TP 15
|
|
.NOP \f\*[B-Font]ntpversion\f[] [\f\*[B-Font]1\f[]|\f\*[B-Font]2\f[]|\f\*[B-Font]3\f[]|\f\*[B-Font]4\f[]]
|
|
Sets the NTP version number which
|
|
\f\*[B-Font]ntpq\fP
|
|
claims in
|
|
packets.
|
|
Defaults to 3, and note that mode 6 control messages (and
|
|
modes, for that matter) didn't exist in NTP version 1.
|
|
There appear
|
|
to be no servers left which demand version 1.
|
|
With no argument, displays the current NTP version that will be used
|
|
when communicating with servers.
|
|
.br
|
|
.ns
|
|
.TP 15
|
|
.NOP \f\*[B-Font]passwd\f[]
|
|
This command prompts you to type in a password (which will not
|
|
be echoed) which will be used to authenticate configuration
|
|
requests.
|
|
The password must correspond to the key configured for
|
|
use by the NTP server for this purpose if such requests are to be
|
|
successful.
|
|
.br
|
|
.ns
|
|
.TP 15
|
|
.NOP \f\*[B-Font]poll\f[] [\f\*[I-Font]n\f[]] [\f\*[B-Font]verbose\f[]]
|
|
Poll an NTP server in client mode
|
|
\f\*[I-Font]n\f[]
|
|
times.
|
|
Poll not implemented yet.
|
|
.br
|
|
.ns
|
|
.TP 15
|
|
.NOP \f\*[B-Font]quit\f[]
|
|
Exit
|
|
\f\*[B-Font]ntpq\fP.
|
|
.br
|
|
.ns
|
|
.TP 15
|
|
.NOP \f\*[B-Font]raw\f[]
|
|
Causes all output from query commands is printed as received
|
|
from the remote server.
|
|
The only formating/interpretation done on
|
|
the data is to transform nonascii data into a printable (but barely
|
|
understandable) form.
|
|
.br
|
|
.ns
|
|
.TP 15
|
|
.NOP \f\*[B-Font]timeout\f[] [\f\*[I-Font]milliseconds\f[]]
|
|
Specify a timeout period for responses to server queries.
|
|
The
|
|
default is about 5000 milliseconds.
|
|
Without any arguments, displays the current timeout period.
|
|
Note that since
|
|
\f\*[B-Font]ntpq\fP
|
|
retries each query once after a timeout, the total waiting time for
|
|
a timeout will be twice the timeout value set.
|
|
.br
|
|
.ns
|
|
.TP 15
|
|
.NOP \f\*[B-Font]version\f[]
|
|
Display the version of the
|
|
\f\*[B-Font]ntpq\fP
|
|
program.
|
|
.PP
|
|
.SS "Control Message Commands"
|
|
Association ids are used to identify system, peer and clock variables.
|
|
System variables are assigned an association id of zero and system name
|
|
space, while each association is assigned a nonzero association id and
|
|
peer namespace.
|
|
Most control commands send a single message to the server and expect a
|
|
single response message.
|
|
The exceptions are the
|
|
\f\*[B-Font]peers\f[]
|
|
command, which sends a series of messages,
|
|
and the
|
|
\f\*[B-Font]mreadlist\f[]
|
|
and
|
|
\f\*[B-Font]mreadvar\f[]
|
|
commands, which iterate over a range of associations.
|
|
.TP 10
|
|
.NOP \f\*[B-Font]apeers\f[]
|
|
Display a list of peers in the form:
|
|
.Dl [tally]remote refid assid st t when pool reach delay offset jitter
|
|
where the output is just like the
|
|
\f\*[B-Font]peers\f[]
|
|
command except that the
|
|
\f\*[B-Font]refid\f[]
|
|
is displayed in hex format and the association number is also displayed.
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]associations\f[]
|
|
Display a list of mobilized associations in the form:
|
|
.Dl ind assid status conf reach auth condition last_event cnt
|
|
.RS
|
|
.IP \fB\(bu\fP 2
|
|
.IP \fB\(bu\fP 2 \f\*[B-Font]ind\f[] \f\*[B-Font]Ta\f[] \f\*[B-Font]index\f[] \f\*[B-Font]on\f[] \f\*[B-Font]this\f[] \f\*[B-Font]list\f[]
|
|
.IP \fB\(bu\fP 2 \f\*[B-Font]assid\f[] \f\*[B-Font]Ta\f[] \f\*[B-Font]association\f[] \f\*[B-Font]id\f[]
|
|
.IP \fB\(bu\fP 2 \f\*[B-Font]status\f[] \f\*[B-Font]Ta\f[] \f\*[B-Font]peer\f[] \f\*[B-Font]status\f[] \f\*[B-Font]word\f[]
|
|
.IP \fB\(bu\fP 2 \f\*[B-Font]conf\f[] \f\*[B-Font]Ta\f[] \f\*[B-Font]yes\f[]: \f\*[B-Font]No\f[] \f\*[B-Font]persistent,\f[] \f\*[B-Font]no\f[]: \f\*[B-Font]No\f[] \f\*[B-Font]ephemeral\f[]
|
|
.IP \fB\(bu\fP 2 \f\*[B-Font]reach\f[] \f\*[B-Font]Ta\f[] \f\*[B-Font]yes\f[]: \f\*[B-Font]No\f[] \f\*[B-Font]reachable,\f[] \f\*[B-Font]no\f[]: \f\*[B-Font]No\f[] \f\*[B-Font]unreachable\f[]
|
|
.IP \fB\(bu\fP 2 \f\*[B-Font]auth\f[] \f\*[B-Font]Ta\f[] \f\*[B-Font]ok\f[], \f\*[B-Font]yes\f[], \f\*[B-Font]bad\f[] \f\*[B-Font]No\f[] \f\*[B-Font]and\f[] \f\*[B-Font]none\f[]
|
|
.IP \fB\(bu\fP 2 \f\*[B-Font]condition\f[] \f\*[B-Font]Ta\f[] \f\*[B-Font]selection\f[] \f\*[B-Font]status\f[] \f\*[B-Font]\&(see\f[] \f\*[B-Font]the\f[] \f\*[B-Font]select\f[] \f\*[B-Font]No\f[] \f\*[B-Font]field\f[] \f\*[B-Font]of\f[] \f\*[B-Font]the\f[] \f\*[B-Font]peer\f[] \f\*[B-Font]status\f[] \f\*[B-Font]word\&)\f[]
|
|
.IP \fB\(bu\fP 2 \f\*[B-Font]last_event\f[] \f\*[B-Font]Ta\f[] \f\*[B-Font]event\f[] \f\*[B-Font]report\f[] \f\*[B-Font]\&(see\f[] \f\*[B-Font]the\f[] \f\*[B-Font]event\f[] \f\*[B-Font]No\f[] \f\*[B-Font]field\f[] \f\*[B-Font]of\f[] \f\*[B-Font]the\f[] \f\*[B-Font]peer\f[] \f\*[B-Font]status\f[] \f\*[B-Font]word\&)\f[]
|
|
.IP \fB\(bu\fP 2 \f\*[B-Font]cnt\f[] \f\*[B-Font]Ta\f[] \f\*[B-Font]event\f[] \f\*[B-Font]count\f[] \f\*[B-Font]\&(see\f[] \f\*[B-Font]the\f[] \f\*[B-Font]count\f[] \f\*[B-Font]No\f[] \f\*[B-Font]field\f[] \f\*[B-Font]of\f[] \f\*[B-Font]the\f[] \f\*[B-Font]peer\f[] \f\*[B-Font]status\f[] \f\*[B-Font]word\&)\f[]
|
|
.RE
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]authinfo\f[]
|
|
Display the authentication statistics counters:
|
|
time since reset, stored keys, free keys, key lookups, keys not found,
|
|
uncached keys, expired keys, encryptions, decryptions.
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]clocklist\f[] [\f\*[I-Font]associd\f[]]
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]cl\f[] [\f\*[I-Font]associd\f[]]
|
|
Display all clock variables in the variable list for those associations
|
|
supporting a reference clock.
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]clockvar\f[] [\f\*[I-Font]associd\f[]] [\f\*[I-Font]name\f[][\&=\f\*[I-Font]value\f[]][] ,...]
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]cv\f[] [\f\*[I-Font]associd\f[]] [\f\*[I-Font]name\f[][\&=\f\*[I-Font]value\f[]][] ,...]
|
|
Display a list of clock variables for those associations supporting a
|
|
reference clock.
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]:config\f[] \f\*[I-Font]configuration command line\f[]
|
|
Send the remainder of the command line, including whitespace, to the
|
|
server as a run-time configuration command in the same format as a line
|
|
in the configuration file.
|
|
This command is experimental until further notice and clarification.
|
|
Authentication is of course required.
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]config-from-file\f[] \f\*[I-Font]filename\f[]
|
|
Send each line of
|
|
\f\*[I-Font]filename\f[]
|
|
to the server as run-time configuration commands in the same format as
|
|
lines in the configuration file.
|
|
This command is experimental until further notice and clarification.
|
|
Authentication is required.
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]ifstats\f[]
|
|
Display status and statistics counters for each local network interface address:
|
|
interface number, interface name and address or broadcast, drop, flag,
|
|
ttl, mc, received, sent, send failed, peers, uptime.
|
|
Authentication is required.
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]iostats\f[]
|
|
Display network and reference clock I/O statistics:
|
|
time since reset, receive buffers, free receive buffers, used receive buffers,
|
|
low water refills, dropped packets, ignored packets, received packets,
|
|
packets sent, packet send failures, input wakeups, useful input wakeups.
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]kerninfo\f[]
|
|
Display kernel loop and PPS statistics:
|
|
associd, status, pll offset, pll frequency, maximum error,
|
|
estimated error, kernel status, pll time constant, precision,
|
|
frequency tolerance, pps frequency, pps stability, pps jitter,
|
|
calibration interval, calibration cycles, jitter exceeded,
|
|
stability exceeded, calibration errors.
|
|
As with other ntpq output, times are in milliseconds; very small values
|
|
may be shown as exponentials.
|
|
The precision value displayed is in milliseconds as well, unlike the
|
|
precision system variable.
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]lassociations\f[]
|
|
Perform the same function as the associations command, except display
|
|
mobilized and unmobilized associations, including all clients.
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]lopeers\f[] [\f\*[B-Font]\-4\f[]|\f\*[B-Font]\-6\f[]]
|
|
Display a list of all peers and clients showing
|
|
\f\*[B-Font]dstadr\f[]
|
|
(associated with the given IP version).
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]lpassociations\f[]
|
|
Display the last obtained list of associations, including all clients.
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]lpeers\f[] [\f\*[B-Font]\-4\f[]|\f\*[B-Font]\-6\f[]]
|
|
Display a list of all peers and clients (associated with the given IP version).
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]monstats\f[]
|
|
Display monitor facility status, statistics, and limits:
|
|
enabled, addresses, peak addresses, maximum addresses,
|
|
reclaim above count, reclaim older than, kilobytes, maximum kilobytes.
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]mreadlist\f[] \f\*[I-Font]associdlo\f[] \f\*[I-Font]associdhi\f[]
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]mrl\f[] \f\*[I-Font]associdlo\f[] \f\*[I-Font]associdhi\f[]
|
|
Perform the same function as the
|
|
\f\*[B-Font]readlist\f[]
|
|
command for a range of association ids.
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]mreadvar\f[] \f\*[I-Font]associdlo\f[] \f\*[I-Font]associdhi\f[] [\f\*[I-Font]name\f[]][,...]
|
|
This range may be determined from the list displayed by any
|
|
command showing associations.
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]mrv\f[] \f\*[I-Font]associdlo\f[] \f\*[I-Font]associdhi\f[] [\f\*[I-Font]name\f[]][,...]
|
|
Perform the same function as the
|
|
\f\*[B-Font]readvar\f[]
|
|
command for a range of association ids.
|
|
This range may be determined from the list displayed by any
|
|
command showing associations.
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]mrulist\f[] [\f\*[B-Font]limited\f[] | \f\*[B-Font]kod\f[] | \f\*[B-Font]mincount\f[]\&=\f\*[I-Font]count\f[] | \f\*[B-Font]laddr\f[]\&=\f\*[I-Font]localaddr\f[] | \f\*[B-Font]sort\f[]\&=[\&-]\f\*[I-Font]sortorder\f[] | \f\*[B-Font]resany\f[]\&=\f\*[I-Font]hexmask\f[] | \f\*[B-Font]resall\f[]\&=\f\*[I-Font]hexmask\f[]]
|
|
Display traffic counts of the most recently seen source addresses
|
|
collected and maintained by the monitor facility.
|
|
With the exception of
|
|
\f\*[B-Font]sort\f[]\&=[\&-]\f\*[I-Font]sortorder\f[],
|
|
the options filter the list returned by
|
|
\fCntpd\f[]\fR(8)\f[].
|
|
The
|
|
\f\*[B-Font]limited\f[]
|
|
and
|
|
\f\*[B-Font]kod\f[]
|
|
options return only entries representing client addresses from which the
|
|
last packet received triggered either discarding or a KoD response.
|
|
The
|
|
\f\*[B-Font]mincount\f[]=\f\*[I-Font]count\f[]
|
|
option filters entries representing less than
|
|
\f\*[I-Font]count\f[]
|
|
packets.
|
|
The
|
|
\f\*[B-Font]laddr\f[]=\f\*[I-Font]localaddr\f[]
|
|
option filters entries for packets received on any local address other than
|
|
\f\*[I-Font]localaddr\f[].
|
|
\f\*[B-Font]resany\f[]=\f\*[I-Font]hexmask\f[]
|
|
and
|
|
\f\*[B-Font]resall\f[]=\f\*[I-Font]hexmask\f[]
|
|
filter entries containing none or less than all, respectively, of the bits in
|
|
\f\*[I-Font]hexmask\f[],
|
|
which must begin with
|
|
\f\*[B-Font]0x\f[].
|
|
The
|
|
\f\*[I-Font]sortorder\f[]
|
|
defaults to
|
|
\f\*[B-Font]lstint\f[]
|
|
and may be
|
|
\f\*[B-Font]addr\f[],
|
|
\f\*[B-Font]avgint\f[],
|
|
\f\*[B-Font]count\f[],
|
|
\f\*[B-Font]lstint\f[],
|
|
or any of those preceded by
|
|
\[oq]\&-\[cq]
|
|
to reverse the sort order.
|
|
The output columns are:
|
|
.RS
|
|
.TP 10
|
|
.NOP Column
|
|
Description
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]lstint\f[]
|
|
Interval in seconds between the receipt of the most recent packet from
|
|
this address and the completion of the retrieval of the MRU list by
|
|
\f\*[B-Font]ntpq\fP.
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]avgint\f[]
|
|
Average interval in s between packets from this address.
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]rstr\f[]
|
|
Restriction flags associated with this address.
|
|
Most are copied unchanged from the matching
|
|
\f\*[B-Font]restrict\f[]
|
|
command, however 0x400 (kod) and 0x20 (limited) flags are cleared unless
|
|
the last packet from this address triggered a rate control response.
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]r\f[]
|
|
Rate control indicator, either
|
|
a period,
|
|
\f\*[B-Font]L\f[]
|
|
or
|
|
\f\*[B-Font]K\f[]
|
|
for no rate control response,
|
|
rate limiting by discarding, or rate limiting with a KoD response, respectively.
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]m\f[]
|
|
Packet mode.
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]v\f[]
|
|
Packet version number.
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]count\f[]
|
|
Packets received from this address.
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]rport\f[]
|
|
Source port of last packet from this address.
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]remote\f[] \f\*[B-Font]address\f[]
|
|
host or DNS name, numeric address, or address followed by
|
|
claimed DNS name which could not be verified in parentheses.
|
|
.RE
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]opeers\f[] [\f\*[B-Font]\-4\f[] | \f\*[B-Font]\-6\f[]]
|
|
Obtain and print the old-style list of all peers and clients showing
|
|
\f\*[B-Font]dstadr\f[]
|
|
(associated with the given IP version),
|
|
rather than the
|
|
\f\*[B-Font]refid\f[].
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]passociations\f[]
|
|
Perform the same function as the
|
|
\f\*[B-Font]associations\f[]
|
|
command,
|
|
except that it uses previously stored data rather than making a new query.
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]peers\f[]
|
|
Display a list of peers in the form:
|
|
.Dl [tally]remote refid st t when pool reach delay offset jitter
|
|
.RS
|
|
.TP 10
|
|
.NOP Variable
|
|
Description
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font][tally]\f[]
|
|
single-character code indicating current value of the
|
|
\f\*[B-Font]select\f[]
|
|
field of the
|
|
.Lk decode.html#peer "peer status word"
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]remote\f[]
|
|
host name (or IP number) of peer.
|
|
The value displayed will be truncated to 15 characters unless the
|
|
\f\*[B-Font]ntpq\fP
|
|
\f\*[B-Font]\-w\f[]
|
|
option is given, in which case the full value will be displayed
|
|
on the first line, and if too long,
|
|
the remaining data will be displayed on the next line.
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]refid\f[]
|
|
source IP address or
|
|
.Lk decode.html#kiss "'kiss code"
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]st\f[]
|
|
stratum: 0 for local reference clocks, 1 for servers with local
|
|
reference clocks, ..., 16 for unsynchronized server clocks
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]t\f[]
|
|
\f\*[B-Font]u\f[]:
|
|
unicast or manycast client,
|
|
\f\*[B-Font]b\f[]:
|
|
broadcast or multicast client,
|
|
\f\*[B-Font]p\f[]:
|
|
pool source,
|
|
\f\*[B-Font]l\f[]:
|
|
local (reference clock),
|
|
\f\*[B-Font]s\f[]:
|
|
symmetric (peer),
|
|
\f\*[B-Font]A\f[]:
|
|
manycast server,
|
|
\f\*[B-Font]B\f[]:
|
|
broadcast server,
|
|
\f\*[B-Font]M\f[]:
|
|
multicast server
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]when\f[]
|
|
time in seconds, minutes, hours, or days since the last packet
|
|
was received, or
|
|
\[oq]\&-\[cq]
|
|
if a packet has never been received
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]poll\f[]
|
|
poll interval (s)
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]reach\f[]
|
|
reach shift register (octal)
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]delay\f[]
|
|
roundtrip delay
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]offset\f[]
|
|
offset of server relative to this host
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]jitter\f[]
|
|
offset RMS error estimate.
|
|
.RE
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]pstats\f[] \f\*[I-Font]associd\f[]
|
|
Display the statistics for the peer with the given
|
|
\f\*[I-Font]associd\f[]:
|
|
associd, status, remote host, local address, time last received,
|
|
time until next send, reachability change, packets sent,
|
|
packets received, bad authentication, bogus origin, duplicate,
|
|
bad dispersion, bad reference time, candidate order.
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]readlist\f[] [\f\*[I-Font]associd\f[]]
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]rl\f[] [\f\*[I-Font]associd\f[]]
|
|
Display all system or peer variables.
|
|
If the
|
|
\f\*[I-Font]associd\f[]
|
|
is omitted, it is assumed to be zero.
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]readvar\f[] [\f\*[I-Font]associd\f[] \f\*[I-Font]name\f[][=\f\*[I-Font]value\f[]] [, ...]]
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]rv\f[] [\f\*[I-Font]associd\f[] \f\*[I-Font]name\f[][=\f\*[I-Font]value\f[]] [, ...]]
|
|
Display the specified system or peer variables.
|
|
If
|
|
\f\*[I-Font]associd\f[]
|
|
is zero, the variables are from the
|
|
\fISystem\f[] \fIVariables\f[]
|
|
name space, otherwise they are from the
|
|
\fIPeer\f[] \fIVariables\f[]
|
|
name space.
|
|
The
|
|
\f\*[I-Font]associd\f[]
|
|
is required, as the same name can occur in both spaces.
|
|
If no
|
|
\f\*[I-Font]name\f[]
|
|
is included, all operative variables in the name space are displayed.
|
|
In this case only, if the
|
|
\f\*[I-Font]associd\f[]
|
|
is omitted, it is assumed to be zero.
|
|
Multiple names are specified with comma separators and without whitespace.
|
|
Note that time values are represented in milliseconds
|
|
and frequency values in parts-per-million (PPM).
|
|
Some NTP timestamps are represented in the format
|
|
\f\*[I-Font]YYYY\f[]\f\*[I-Font]MM\f[] \f\*[I-Font]DD\f[] \f\*[I-Font]TTTT\f[],
|
|
where
|
|
\f\*[I-Font]YYYY\f[]
|
|
is the year,
|
|
\f\*[I-Font]MM\f[]
|
|
the month of year,
|
|
\f\*[I-Font]DD\f[]
|
|
the day of month and
|
|
\f\*[I-Font]TTTT\f[]
|
|
the time of day.
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]reslist\f[]
|
|
Display the access control (restrict) list for
|
|
\f\*[B-Font]ntpq\fP.
|
|
Authentication is required.
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]saveconfig\f[] \f\*[I-Font]filename\f[]
|
|
Save the current configuration,
|
|
including any runtime modifications made by
|
|
\f\*[B-Font]:config\f[]
|
|
or
|
|
\f\*[B-Font]config-from-file\f[],
|
|
to the NTP server host file
|
|
\f\*[I-Font]filename\f[].
|
|
This command will be rejected by the server unless
|
|
.Lk miscopt.html#saveconfigdir "saveconfigdir"
|
|
appears in the
|
|
\fCntpd\f[]\fR(8)\f[]
|
|
configuration file.
|
|
\f\*[I-Font]filename\f[]
|
|
can use
|
|
\fCdate\f[]\fR(1)\f[]
|
|
format specifiers to substitute the current date and time, for
|
|
example,
|
|
.in +4
|
|
\f\*[B-Font]saveconfig\f[] \fIntp-%Y%m%d-%H%M%S.conf\f[].
|
|
.in -4
|
|
The filename used is stored in system variable
|
|
\f\*[B-Font]savedconfig\f[].
|
|
Authentication is required.
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]sysinfo\f[]
|
|
Display system operational summary:
|
|
associd, status, system peer, system peer mode, leap indicator,
|
|
stratum, log2 precision, root delay, root dispersion,
|
|
reference id, reference time, system jitter, clock jitter,
|
|
clock wander, broadcast delay, symm. auth. delay.
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]sysstats\f[]
|
|
Display system uptime and packet counts maintained in the
|
|
protocol module:
|
|
uptime, sysstats reset, packets received, current version,
|
|
older version, bad length or format, authentication failed,
|
|
declined, restricted, rate limited, KoD responses,
|
|
processed for time.
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]timerstats\f[]
|
|
Display interval timer counters:
|
|
time since reset, timer overruns, calls to transmit.
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]writelist\f[] \f\*[I-Font]associd\f[]
|
|
Set all system or peer variables included in the variable list.
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]writevar\f[] \f\*[I-Font]associd\f[] \f\*[I-Font]name\f[]=\f\*[I-Font]value\f[] [, ...]
|
|
Set the specified variables in the variable list.
|
|
If the
|
|
\f\*[I-Font]associd\f[]
|
|
is zero, the variables are from the
|
|
\fISystem\f[] \fIVariables\f[]
|
|
name space, otherwise they are from the
|
|
\fIPeer\f[] \fIVariables\f[]
|
|
name space.
|
|
The
|
|
\f\*[I-Font]associd\f[]
|
|
is required, as the same name can occur in both spaces.
|
|
Authentication is required.
|
|
.PP
|
|
.SS Status Words and Kiss Codes
|
|
The current state of the operating program is shown
|
|
in a set of status words
|
|
maintained by the system.
|
|
Status information is also available on a per-association basis.
|
|
These words are displayed by the
|
|
\f\*[B-Font]readlist\f[]
|
|
and
|
|
\f\*[B-Font]associations\f[]
|
|
commands both in hexadecimal and in decoded short tip strings.
|
|
The codes, tips and short explanations are documented on the
|
|
.Lk decode.html "Event Messages and Status Words"
|
|
page.
|
|
The page also includes a list of system and peer messages,
|
|
the code for the latest of which is included in the status word.
|
|
.sp \n(Ppu
|
|
.ne 2
|
|
|
|
Information resulting from protocol machine state transitions
|
|
is displayed using an informal set of ASCII strings called
|
|
.Lk decode.html#kiss "kiss codes" .
|
|
The original purpose was for kiss-o'-death (KoD) packets
|
|
sent by the server to advise the client of an unusual condition.
|
|
They are now displayed, when appropriate,
|
|
in the reference identifier field in various billboards.
|
|
.SS System Variables
|
|
The following system variables appear in the
|
|
\f\*[B-Font]readlist\f[]
|
|
billboard.
|
|
Not all variables are displayed in some configurations.
|
|
.sp \n(Ppu
|
|
.ne 2
|
|
|
|
.TP 10
|
|
.NOP Variable
|
|
Description
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]status\f[]
|
|
.Lk decode.html#sys "system status word"
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]version\f[]
|
|
NTP software version and build time
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]processor\f[]
|
|
hardware platform and version
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]system\f[]
|
|
operating system and version
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]leap\f[]
|
|
leap warning indicator (0-3)
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]stratum\f[]
|
|
stratum (1-15)
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]precision\f[]
|
|
precision (log2 s)
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]rootdelay\f[]
|
|
total roundtrip delay to the primary reference clock
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]rootdisp\f[]
|
|
total dispersion to the primary reference clock
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]refid\f[]
|
|
reference id or
|
|
.Lk decode.html#kiss "kiss code"
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]reftime\f[]
|
|
reference time
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]clock\f[]
|
|
date and time of day
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]peer\f[]
|
|
system peer association id
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]tc\f[]
|
|
time constant and poll exponent (log2 s) (3-17)
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]mintc\f[]
|
|
minimum time constant (log2 s) (3-10)
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]offset\f[]
|
|
combined offset of server relative to this host
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]frequency\f[]
|
|
frequency drift (PPM) relative to hardware clock
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]sys_jitter\f[]
|
|
combined system jitter
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]clk_wander\f[]
|
|
clock frequency wander (PPM)
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]clk_jitter\f[]
|
|
clock jitter
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]tai\f[]
|
|
TAI-UTC offset (s)
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]leapsec\f[]
|
|
NTP seconds when the next leap second is/was inserted
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]expire\f[]
|
|
NTP seconds when the NIST leapseconds file expires
|
|
.PP
|
|
The jitter and wander statistics are exponentially-weighted RMS averages.
|
|
The system jitter is defined in the NTPv4 specification;
|
|
the clock jitter statistic is computed by the clock discipline module.
|
|
.sp \n(Ppu
|
|
.ne 2
|
|
|
|
When the NTPv4 daemon is compiled with the OpenSSL software library,
|
|
additional system variables are displayed,
|
|
including some or all of the following,
|
|
depending on the particular Autokey dance:
|
|
.TP 10
|
|
.NOP Variable
|
|
Description
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]host\f[]
|
|
Autokey host name for this host
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]ident\f[]
|
|
Autokey group name for this host
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]flags\f[]
|
|
host flags (see Autokey specification)
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]digest\f[]
|
|
OpenSSL message digest algorithm
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]signature\f[]
|
|
OpenSSL digest/signature scheme
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]update\f[]
|
|
NTP seconds at last signature update
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]cert\f[]
|
|
certificate subject, issuer and certificate flags
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]until\f[]
|
|
NTP seconds when the certificate expires
|
|
.PP
|
|
.SS Peer Variables
|
|
The following peer variables appear in the
|
|
\f\*[B-Font]readlist\f[]
|
|
billboard for each association.
|
|
Not all variables are displayed in some configurations.
|
|
.sp \n(Ppu
|
|
.ne 2
|
|
|
|
.TP 10
|
|
.NOP Variable
|
|
Description
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]associd\f[]
|
|
association id
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]status\f[]
|
|
.Lk decode.html#peer "peer status word"
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]srcadr\f[]
|
|
source (remote) IP address
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]srcport\f[]
|
|
source (remote) port
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]dstadr\f[]
|
|
destination (local) IP address
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]dstport\f[]
|
|
destination (local) port
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]leap\f[]
|
|
leap indicator (0-3)
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]stratum\f[]
|
|
stratum (0-15)
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]precision\f[]
|
|
precision (log2 s)
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]rootdelay\f[]
|
|
total roundtrip delay to the primary reference clock
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]rootdisp\f[]
|
|
total root dispersion to the primary reference clock
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]refid\f[]
|
|
reference id or
|
|
.Lk decode.html#kiss "kiss code"
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]reftime\f[]
|
|
reference time
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]rec\f[]
|
|
last packet received time
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]reach\f[]
|
|
reach register (octal)
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]unreach\f[]
|
|
unreach counter
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]hmode\f[]
|
|
host mode (1-6)
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]pmode\f[]
|
|
peer mode (1-5)
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]hpoll\f[]
|
|
host poll exponent (log2 s) (3-17)
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]ppoll\f[]
|
|
peer poll exponent (log2 s) (3-17)
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]headway\f[]
|
|
headway (see
|
|
.Lk rate.html "Rate Management and the Kiss-o'-Death Packet" )
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]flash\f[]
|
|
.Lk decode.html#flash "flash status word"
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]keyid\f[]
|
|
symmetric key id
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]offset\f[]
|
|
filter offset
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]delay\f[]
|
|
filter delay
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]dispersion\f[]
|
|
filter dispersion
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]jitter\f[]
|
|
filter jitter
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]bias\f[]
|
|
unicast/broadcast bias
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]xleave\f[]
|
|
interleave delay (see
|
|
.Lk xleave.html "NTP Interleaved Modes" )
|
|
.PP
|
|
The
|
|
\f\*[B-Font]bias\f[]
|
|
variable is calculated when the first broadcast packet is received
|
|
after the calibration volley.
|
|
It represents the offset of the broadcast subgraph relative to the
|
|
unicast subgraph.
|
|
The
|
|
\f\*[B-Font]xleave\f[]
|
|
variable appears only for the interleaved symmetric and interleaved modes.
|
|
It represents the internal queuing, buffering and transmission delays
|
|
for the preceding packet.
|
|
.sp \n(Ppu
|
|
.ne 2
|
|
|
|
When the NTPv4 daemon is compiled with the OpenSSL software library,
|
|
additional peer variables are displayed, including the following:
|
|
.TP 10
|
|
.NOP Variable
|
|
Description
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]flags\f[]
|
|
peer flags (see Autokey specification)
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]host\f[]
|
|
Autokey server name
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]flags\f[]
|
|
peer flags (see Autokey specification)
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]signature\f[]
|
|
OpenSSL digest/signature scheme
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]initsequence\f[]
|
|
initial key id
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]initkey\f[]
|
|
initial key index
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]timestamp\f[]
|
|
Autokey signature timestamp
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]ident\f[]
|
|
Autokey group name for this association
|
|
.PP
|
|
.SS Clock Variables
|
|
The following clock variables appear in the
|
|
\f\*[B-Font]clocklist\f[]
|
|
billboard for each association with a reference clock.
|
|
Not all variables are displayed in some configurations.
|
|
.TP 10
|
|
.NOP Variable
|
|
Description
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]associd\f[]
|
|
association id
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]status\f[]
|
|
.Lk decode.html#clock "clock status word"
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]device\f[]
|
|
device description
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]timecode\f[]
|
|
ASCII time code string (specific to device)
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]poll\f[]
|
|
poll messages sent
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]noreply\f[]
|
|
no reply
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]badformat\f[]
|
|
bad format
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]baddata\f[]
|
|
bad date or time
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]fudgetime1\f[]
|
|
fudge time 1
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]fudgetime2\f[]
|
|
fudge time 2
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]stratum\f[]
|
|
driver stratum
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]refid\f[]
|
|
driver reference id
|
|
.br
|
|
.ns
|
|
.TP 10
|
|
.NOP \f\*[B-Font]flags\f[]
|
|
driver flags
|
|
.PP
|
|
.SH "OPTIONS"
|
|
.TP
|
|
.NOP \f\*[B-Font]\-4\f[], \f\*[B-Font]\-\-ipv4\f[]
|
|
Force IPv4 name resolution.
|
|
This option must not appear in combination with any of the following options:
|
|
ipv6.
|
|
.sp
|
|
Force resolution of following host names on the command line
|
|
to the IPv4 namespace.
|
|
.TP
|
|
.NOP \f\*[B-Font]\-6\f[], \f\*[B-Font]\-\-ipv6\f[]
|
|
Force IPv6 name resolution.
|
|
This option must not appear in combination with any of the following options:
|
|
ipv4.
|
|
.sp
|
|
Force resolution of following host names on the command line
|
|
to the IPv6 namespace.
|
|
.TP
|
|
.NOP \f\*[B-Font]\-c\f[] \f\*[I-Font]cmd\f[], \f\*[B-Font]\-\-command\f[]=\f\*[I-Font]cmd\f[]
|
|
run a command and exit.
|
|
This option may appear an unlimited number of times.
|
|
.sp
|
|
The following argument is interpreted as an interactive format command
|
|
and is added to the list of commands to be executed on the specified
|
|
host(s).
|
|
.TP
|
|
.NOP \f\*[B-Font]\-d\f[], \f\*[B-Font]\-\-debug\-level\f[]
|
|
Increase debug verbosity level.
|
|
This option may appear an unlimited number of times.
|
|
.sp
|
|
.TP
|
|
.NOP \f\*[B-Font]\-D\f[] \f\*[I-Font]number\f[], \f\*[B-Font]\-\-set\-debug\-level\f[]=\f\*[I-Font]number\f[]
|
|
Set the debug verbosity level.
|
|
This option may appear an unlimited number of times.
|
|
This option takes an integer number as its argument.
|
|
.sp
|
|
.TP
|
|
.NOP \f\*[B-Font]\-i\f[], \f\*[B-Font]\-\-interactive\f[]
|
|
Force ntpq to operate in interactive mode.
|
|
This option must not appear in combination with any of the following options:
|
|
command, peers.
|
|
.sp
|
|
Force \fBntpq\fP to operate in interactive mode.
|
|
Prompts will be written to the standard output and
|
|
commands read from the standard input.
|
|
.TP
|
|
.NOP \f\*[B-Font]\-n\f[], \f\*[B-Font]\-\-numeric\f[]
|
|
numeric host addresses.
|
|
.sp
|
|
Output all host addresses in dotted-quad numeric format rather than
|
|
converting to the canonical host names.
|
|
.TP
|
|
.NOP \f\*[B-Font]\-\-old\-rv\f[]
|
|
Always output status line with readvar.
|
|
.sp
|
|
By default, \fBntpq\fP now suppresses the \fBassocid=...\fP
|
|
line that precedes the output of \fBreadvar\fP
|
|
(alias \fBrv\fP) when a single variable is requested, such as
|
|
\fBntpq \-c "rv 0 offset"\fP.
|
|
This option causes \fBntpq\fP to include both lines of output
|
|
for a single-variable \fBreadvar\fP.
|
|
Using an environment variable to
|
|
preset this option in a script will enable both older and
|
|
newer \fBntpq\fP to behave identically in this regard.
|
|
.TP
|
|
.NOP \f\*[B-Font]\-p\f[], \f\*[B-Font]\-\-peers\f[]
|
|
Print a list of the peers.
|
|
This option must not appear in combination with any of the following options:
|
|
interactive.
|
|
.sp
|
|
Print a list of the peers known to the server as well as a summary
|
|
of their state. This is equivalent to the 'peers' interactive command.
|
|
.TP
|
|
.NOP \f\*[B-Font]\-r\f[] \f\*[I-Font]keyword\f[], \f\*[B-Font]\-\-refid\f[]=\f\*[I-Font]keyword\f[]
|
|
Set default display type for S2+ refids.
|
|
This option takes a keyword as its argument. The argument sets an enumeration value that can
|
|
be tested by comparing them against the option value macro.
|
|
The available keywords are:
|
|
.in +4
|
|
.nf
|
|
.na
|
|
hash ipv4
|
|
.fi
|
|
or their numeric equivalent.
|
|
.in -4
|
|
.sp
|
|
The default
|
|
\f\*[I-Font]keyword\f[]
|
|
for this option is:
|
|
.ti +4
|
|
ipv4
|
|
.sp
|
|
Set the default display format for S2+ refids.
|
|
.TP
|
|
.NOP \f\*[B-Font]\-w\f[], \f\*[B-Font]\-\-wide\f[]
|
|
Display the full 'remote' value.
|
|
.sp
|
|
Display the full value of the 'remote' value. If this requires
|
|
more than 15 characters, display the full value, emit a newline,
|
|
and continue the data display properly indented on the next line.
|
|
.TP
|
|
.NOP \f\*[B-Font]\-\&?\f[], \f\*[B-Font]\-\-help\f[]
|
|
Display usage information and exit.
|
|
.TP
|
|
.NOP \f\*[B-Font]\-\&!\f[], \f\*[B-Font]\-\-more-help\f[]
|
|
Pass the extended usage information through a pager.
|
|
.TP
|
|
.NOP \f\*[B-Font]\->\f[] [\f\*[I-Font]cfgfile\f[]], \f\*[B-Font]\-\-save-opts\f[] [=\f\*[I-Font]cfgfile\f[]]
|
|
Save the option state to \fIcfgfile\fP. The default is the \fIlast\fP
|
|
configuration file listed in the \fBOPTION PRESETS\fP section, below.
|
|
The command will exit after updating the config file.
|
|
.TP
|
|
.NOP \f\*[B-Font]\-<\f[] \f\*[I-Font]cfgfile\f[], \f\*[B-Font]\-\-load-opts\f[]=\f\*[I-Font]cfgfile\f[], \f\*[B-Font]\-\-no-load-opts\f[]
|
|
Load options from \fIcfgfile\fP.
|
|
The \fIno-load-opts\fP form will disable the loading
|
|
of earlier config/rc/ini files. \fI\-\-no-load-opts\fP is handled early,
|
|
out of order.
|
|
.TP
|
|
.NOP \f\*[B-Font]\-\-version\f[] [{\f\*[I-Font]v|c|n\f[]}]
|
|
Output version of program and exit. The default mode is `v', a simple
|
|
version. The `c' mode will print copyright information and `n' will
|
|
print the full copyright notice.
|
|
.PP
|
|
.SH "OPTION PRESETS"
|
|
Any option that is not marked as \fInot presettable\fP may be preset
|
|
by loading values from configuration ("RC" or ".INI") file(s) and values from
|
|
environment variables named:
|
|
.nf
|
|
\fBNTPQ_<option-name>\fP or \fBNTPQ\fP
|
|
.fi
|
|
.ad
|
|
The environmental presets take precedence (are processed later than)
|
|
the configuration files.
|
|
The \fIhomerc\fP files are "\fI$HOME\fP", and "\fI.\fP".
|
|
If any of these are directories, then the file \fI.ntprc\fP
|
|
is searched for within those directories.
|
|
.SH "ENVIRONMENT"
|
|
See \fBOPTION PRESETS\fP for configuration environment variables.
|
|
.SH "FILES"
|
|
See \fBOPTION PRESETS\fP for configuration files.
|
|
.SH "EXIT STATUS"
|
|
One of the following exit values will be returned:
|
|
.TP
|
|
.NOP 0 " (EXIT_SUCCESS)"
|
|
Successful program execution.
|
|
.TP
|
|
.NOP 1 " (EXIT_FAILURE)"
|
|
The operation failed or the command syntax was not valid.
|
|
.TP
|
|
.NOP 66 " (EX_NOINPUT)"
|
|
A specified configuration file could not be loaded.
|
|
.TP
|
|
.NOP 70 " (EX_SOFTWARE)"
|
|
libopts had an internal operational error. Please report
|
|
it to autogen-users@lists.sourceforge.net. Thank you.
|
|
.PP
|
|
.SH "AUTHORS"
|
|
The University of Delaware and Network Time Foundation
|
|
.SH "COPYRIGHT"
|
|
Copyright (C) 1992-2020 The University of Delaware and Network Time Foundation all rights reserved.
|
|
This program is released under the terms of the NTP license, <http://ntp.org/license>.
|
|
.SH "BUGS"
|
|
Please send bug reports to: http://bugs.ntp.org, bugs@ntp.org
|
|
.SH "NOTES"
|
|
This manual page was \fIAutoGen\fP-erated from the \fBntpq\fP
|
|
option definitions.
|