NTPQ(8) | System Manager's Manual (user) | NTPQ(8) |
ntpq
—
ntpq |
[-flags ] [-flag
[value]] [--option-name [[=|
]value]] [ host ...] |
ntpq
utility program is used to query NTP servers
which implement the standard NTP mode 6 control message formats defined in
Appendix B of the NTPv3 specification RFC1305, requesting information about
current state and/or changes in that state. The same formats are used in
NTPv4, although some of the variables have changed and new ones added. The
description on this page is for the NTPv4 variables. 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
ntpq
utility can also obtain and print a list of peers
in a common format by sending multiple queries to the server. If one or more
request options is included on the command line when
ntpq
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,
ntpq
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 ntpq
utility will prompt for commands
if the standard input is a terminal device. ntpq
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
ntpq
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. Specifying a command line option other than
-i
or -n
will cause the
specified query (queries) to be sent to the indicated host(s) immediately.
Otherwise, ntpq
will attempt to read interactive
format commands from the standard input.
ntpq
utility itself and do not
result in NTP mode 6 requests being sent to a server. These are described
following.
help
[command_keyword]?
’ by itself will print a list of
all the command keywords known to this incarnation of
ntpq
. A ‘?
’
followed by a command keyword will print function and usage information
about the command. This command is probably a better source of information
about ntpq
than this manual page.addvars
variable_name [=value
]
...
rmvars
variable_name ...
clearvars
variable_name=value
’, where
the ‘=value
’ is ignored, and can be
omitted, in requests to the server to read variables. The
ntpq
utility maintains an internal list in which
data to be included in control messages can be assembled, and sent using
the readlist
and writelist
commands described below. The addvars
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 rmvars
command
can be used to remove individual variables from the list, while the
clearlist
command removes all variables from the
list.authenticate
[yes | no]ntpq
does not authenticate requests
unless they are write requests. The command
‘authenticate yes
’ causes
ntpq
to send authentication with all requests it
makes. Authenticated requests causes some servers to handle requests
slightly differently, and can occasionally melt the CPU in fuzzballs if
you turn authentication on before doing a peer
display. The command ‘authenticate
’
causes ntpq
to display whether or not
ntpq
is currently autheinticating requests.cooked
ntpq
will have
their values reformatted for human consumption. Variables which
ntpq
thinks should have a decodable value but
didn't are marked with a trailing
‘?
’.debug
[more
| less
|
off
]delay
millisecondshost
hostnamehostnames
[yes
| no
]yes
is specified, host names are printed in
information displays. If no
is specified, numeric
addresses are printed instead. The default is yes
,
unless modified using the command line -n
switch.keyid
keyidntpversion
[1
| 2
|
3
| 4
]ntpq
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.quit
ntpq
passwd
raw
timeout
millisecondsntpq
retries each query once after a timeout, the total waiting time for a
timeout will be twice the timeout value set.-4
,
--ipv4
Force DNS resolution of following host names on the command line to the IPv4 namespace.
-6
,
--ipv6
Force DNS resolution of following host names on the command line to the IPv6 namespace.
-c
cmd,
--command
=cmdThe 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).
-d
,
--debug-level
-D
number,
--set-debug-level
=number-p
,
--peers
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.
-i
,
--interactive
Force ntpq to operate in interactive mode. Prompts will be written to the standard output and commands read from the standard input.
-n
,
--numeric
Output all host addresses in dotted-quad numeric format rather than converting to the canonical host names.
--old-rv
By default, ntpq now suppresses the associd=... line that precedes the output of readvar (alias rv) when a single variable is requested, such as ntpq -c "rv 0 offset". This option causes ntpq to include both lines of output for a single-variable readvar. Using an environment variable to preset this option in a script will enable both older and newer ntpq to behave identically in this regard.
-?
,
--help
-!
,
--more-help
->
[cfgfile], --save-opts
[=cfgfile]-<
cfgfile,
--load-opts
=cfgfile,
--no-load-opts
--version
[{v|c|n}]NTPQ_<option-name> or NTPQThe environmental presets take precedence (are processed later than) the configuration files. The homerc files are "$HOME", and ".". If any of these are directories, then the file .ntprc is searched for within those directories. cvt_prog='/usr/local/gnu/share/autogen/texi2mdoc' cvt_prog=`cd `dirname "$cvt_prog"` >/dev/null && pwd
December 24 2013 | SunOS 5.10 |