ntpq(1)

NAME
*[B-Font]ntpq - standard NTP query program

SYNOPSIS
*[B-Font]ntpq [*[B-Font]-flags] [*[B-Font]-flag [*[I-Font]value]] [*[B-Font]--option-name[[=| ]*[I-Font]value]] [ host ...]

DESCRIPTION
The *[B-Font]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 *[B-Font]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 *[B-Font]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, *[B-Font]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 *[B-Font]ntpq utility will prompt for commands if the standard input is a terminal device. *[B-Font]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 *[B-Font]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 *[B-Font]-i or *[B-Font]-n will cause the specified query (queries) to be sent to the indicated host(s) immediately. Otherwise, *[B-Font]ntpq will attempt to read interactive format commands from the standard input.

  Internal Commands
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. A number of interactive format commands are executed entirely within the *[B-Font]ntpq utility itself and do not result in NTP mode 6 requests being sent to a server. These are described following.

A   ‘?’ by itself will print a list of all the command keywords known to this incarnation of *[B-Font]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 *[B-Font]ntpq than this manual page.

The data carried by NTP mode 6 messages consists of a list of
    items of the form ‘variable_name=value’, where the ‘=value’ is ignored, and can be omitted, in requests to the server to read variables. The *[B-Font]ntpq utility maintains an internal list in which data to be included in control messages can be assembled, and sent using the *[B-Font]readlist and *[B-Font]writelist commands described below. The *[B-Font]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 *[B-Font]rmvars command can be used to remove individual variables from the list, while the *[B-Font]clearlist command removes all variables from the list. The *[B-Font]showvars command displays the current list of optional variables.

Normally
    *[B-Font]ntpq does not authenticate requests unless they are write requests. The command ‘authenticate yes’ causes *[B-Font]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 *[B-Font]peer display. The command ‘authenticate’ causes *[B-Font]ntpq to display whether or not *[B-Font]ntpq is currently autheinticating requests.

Causes output from query commands to be "cooked", so that
    variables which are recognized by *[B-Font]ntpq will have their values reformatted for human consumption. Variables which *[B-Font]ntpq thinks should have a decodable value but didn't are marked with a trailing ‘?’.

With no argument, displays the current debug level.
    Otherwise, the debug level is changed to the indicated level.

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.

Exit
    *[B-Font]ntpq.

Set the host to which future queries will be sent.
    *[I-Font]hostname may be either a host name or a numeric address.

If  *[B-Font]yes is specified, host names are printed in information displays. If *[B-Font]no is specified, numeric addresses are printed instead. The default is *[B-Font]yes, unless modified using the command line *[B-Font]-n switch.

This command allows the specification of a key number to be
    used to authenticate configuration requests. This must correspond to the *[B-Font]controlkey key number the server has been configured to use for this purpose.

Specify the type of key to use for authenticating requests.
    *[B-Font]md5 is alway supported. If *[B-Font]ntpq was built with OpenSSL support, any digest type supported by OpenSSL can also be provided. If no argument is given, the current *[B-Font]keytype is displayed.

Sets the NTP version number which
    *[B-Font]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.

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.

Exit
    *[B-Font]ntpq.

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.

Specify a timeout period for responses to server queries.
    The default is about 5000 milliseconds. Note that since *[B-Font]ntpq retries each query once after a timeout, the total waiting time for a timeout will be twice the timeout value set.

Print the version of the
    *[B-Font]ntpq program.

  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 mode-6 message to the server and expect a single response message. The exceptions are the peers command, which sends a series of messages, and the mreadlist and mreadvar commands, which iterate over a range of associations.

Display a list of mobilized associations in the form:

    •

    •

    •

    •

    •

    •

    •

    •

    •

    •

Display the authentication statistics.

Display a list of clock variables for those associations supporting a reference clock.

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.

Send the each line of
    *[I-Font]filename to the server as run-time configuration commands in the same format as a line in the configuration file. This command is experimental until further notice and clarification. Authentication is required.

Display statistics for each local network address. Authentication is required.

Display network and reference clock I/O statistics.

Display kernel loop and PPS statistics. As with other ntpq output, times are in milliseconds. The precision value displayed is in milliseconds as well, unlike the precision system variable.

Perform the same function as the associations command, except display mobilized and unmobilized associations.

Obtain and print a list of all peers and clients showing
    *[I-Font]dstadr (associated with any given IP version).

Print a peer spreadsheet for the appropriate IP version(s).
    *[I-Font]dstadr (associated with any given IP version).

Display monitor facility statistics.

Obtain and print traffic counts collected and maintained by the monitor facility.
    With the exception of *[B-Font]sort=*[I-Font]sortorder, the options filter the list returned by *[B-Font]ntpd. The *[B-Font]limited and *[B-Font]kod options return only entries representing client addresses from which the last packet received triggered either discarding or a KoD response. The *[B-Font]mincount=*[I-Font]count option filters entries representing less than *[I-Font]count packets. The *[B-Font]laddr=*[I-Font]localaddr option filters entries for packets received on any local address other than *[I-Font]localaddr. *[B-Font]resany=*[I-Font]hexmask and *[B-Font]resall=*[I-Font]hexmask filter entries containing none or less than all, respectively, of the bits in *[I-Font]hexmask, which must begin with *[B-Font]0x. The *[I-Font]sortorder defaults to *[B-Font]lstint and may be any of *[B-Font]addr, *[B-Font]count, *[B-Font]avgint, *[B-Font]lstint, or any of those preceded by a minus sign (hyphen) to reverse the sort order. The output columns are:

    Description

    Interval in s between the receipt of the most recent packet from this address and the completion of the retrieval of the MRU list by
        *[B-Font]ntpq.

    Average interval in s between packets from this address.

    Restriction flags associated with this address.
        Most are copied unchanged from the matching *[B-Font]restrict command, however 0x400 (kod) and 0x20 (limited) flags are cleared unless the last packet from this address triggered a rate control response.

    Rate control indicator, either
        a period, *[B-Font]L or *[B-Font]K for no rate control response, rate limiting by discarding, or rate limiting with a KoD response, respectively.

    Packet mode.

    Packet version number.

    Packets received from this address.

    Source port of last packet from this address.

    DNS name, numeric address, or address followed by
        claimed DNS name which could not be verified in parentheses.

Perform the same function as the
    *[B-Font]readvar command, except for a range of association IDs. This range is determined from the association list cached by the most recent *[B-Font]associations command.

Obtain and print the old-style list of all peers and clients showing
    *[I-Font]dstadr (associated with any given IP version), rather than the *[I-Font]refid.

Perform the same function as the
    *[B-Font]associations command, except that it uses previously stored data rather than making a new query.

Display a list of peers in the form:

    Description

    single-character code indicating current value of the
        *[B-Font]select field of the

    host name (or IP number) of peer.
        The value displayed will be truncated to 15 characters unless the *[B-Font]-w flag is given, in which case the full value will be displayed on the first line, and the remaining data is displayed on the next line.

    association ID or

    stratum

    *[B-Font]u:
        unicast or manycast client, *[B-Font]b: broadcast or multicast client, *[B-Font]l: local (reference clock), *[B-Font]s: symmetric (peer), *[B-Font]A: manycast server, *[B-Font]B: broadcast server, *[B-Font]M: multicast server

    sec/min/hr since last received packet

    poll interval (log2 s)

    reach shift register (octal)

    roundtrip delay

    offset of server relative to this host

    jitter

Display a list of peers in the form:
    where the output is just like the *[B-Font]peers command except that the *[B-Font]refid is displayed in hex format and the association number is also displayed.

Show the statistics for the peer with the given
    *[I-Font]assocID.

Read the system or peer variables included in the variable list.

Display the specified variables.
    If *[I-Font]assocID is zero, the variables are from the System Variables name space, otherwise they are from the Peer Variables name space. The *[I-Font]assocID is required, as the same name can occur in both spaces. If no *[I-Font]name is included, all operative variables in the name space are displayed. In this case only, if the *[I-Font]assocID is omitted, it is assumed 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 YYYYMMDDTTTT , where YYYY is the year, MM the month of year, DD the day of month and TTTT the time of day.

Show the access control (restrict) list for
    *[B-Font]ntpq.

Write the current configuration,
    including any runtime modifications given with *[B-Font]:config or *[B-Font]config-from-file, to the ntpd host's file *[I-Font]filename. This command will be rejected by the server unless appears in the *[B-Font]ntpd configuration file. *[I-Font]filename can use strftime() format specifies to substitute the current date and time, for example, *[B-Font]q]saveconfig *[B-Font]ntp-%Y%m%d-%H%M%S.confq]. The filename used is stored in system variable *[B-Font]savedconfig. Authentication is required.

Display interval timer counters.

Write the system or peer variables included in the variable list.

Write the specified variables.
    If the *[I-Font]assocID is zero, the variables are from the System Variables name space, otherwise they are from the Peer Variables name space. The *[I-Font]assocID is required, as the same name can occur in both spaces.

Display operational summary.

Print statistics counters maintained in the protocol module.

  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 in the *[B-Font]rv and *[B-Font]as commands both in hexadecimal and in decoded short tip strings. The codes, tips and short explanations are documented on the 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.

Information resulting from protocol machine state transitions is displayed using an informal set of ASCII strings called 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.

  System Variables
The following system variables appear in the *[B-Font]rv billboard. Not all variables are displayed in some configurations.

Description

NTP software version and build time

hardware platform and version

operating system and version

leap warning indicator (0-3)

stratum (1-15)

precision (log2 s)

total roundtrip delay to the primary reference clock

total dispersion to the primary reference clock

system peer association ID

time constant and poll exponent (log2 s) (3-17)

minimum time constant (log2 s) (3-10)

date and time of day

reference ID or

reference time

combined  offset of server relative to this host

combined system jitter

frequency offset (PPM) relative to hardware clock

clock frequency wander (PPM)

clock jitter

TAI-UTC offset (s)

NTP seconds when the next leap second is/was inserted

NTP seconds when the NIST leapseconds file expires

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.

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:

Description

Autokey host name for this host

Autokey group name for this host

host flags  (see Autokey specification)

OpenSSL message digest algorithm

OpenSSL digest/signature scheme

NTP seconds at last signature update

certificate subject, issuer and certificate flags

NTP seconds when the certificate expires

  Peer Variables
The following peer variables appear in the *[B-Font]rv billboard for each association. Not all variables are displayed in some configurations.

Description

association ID

source (remote) IP address

source (remote) port

destination (local) IP address

destination (local) port

leap indicator (0-3)

stratum (0-15)

precision (log2 s)

total roundtrip delay to the primary reference clock

total root dispersion to the primary reference clock

reference ID or

reference time

reach register (octal)

unreach counter

host mode (1-6)

peer mode (1-5)

host poll exponent (log2 s) (3-17)

peer poll exponent (log2 s) (3-17)

headway (see

filter offset

filter delay

filter dispersion

filter jitter

Autokey group name for this association

unicast/broadcast bias

interleave delay (see

The *[B-Font]bias 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 *[B-Font]xleave variable appears only for the interleaved symmetric and interleaved modes. It represents the internal queuing, buffering and transmission delays for the preceding packet.

When the NTPv4 daemon is compiled with the OpenSSL software library, additional peer variables are displayed, including the following:

Description

peer flags (see Autokey specification)

Autokey server name

peer flags (see Autokey specification)

OpenSSL digest/signature scheme

initial key ID

initial key index

Autokey signature timestamp

  Clock Variables
The following clock variables appear in the *[B-Font]cv billboard for each association with a reference clock. Not all variables are displayed in some configurations.

Description

association ID

device description

ASCII time code string (specific to device)

poll messages sent

no reply

bad format

bad date or time

fudge time 1

fudge time 2

driver stratum

driver reference ID

driver flags

OPTIONS

Force IPv4 DNS name resolution.
    This option must not appear in combination with any of the following options: ipv6.

    Force DNS resolution of following host names on the command line to the IPv4 namespace.

Force IPv6 DNS name resolution.
    This option must not appear in combination with any of the following options: ipv4.

    Force DNS resolution of following host names on the command line to the IPv6 namespace.

run a command and exit.
    This option may appear an unlimited number of times.

    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).

Increase debug verbosity level.
    This option may appear an unlimited number of times.

Set the debug verbosity level.
    This option may appear an unlimited number of times. This option takes an integer number as its argument.

Force ntpq to operate in interactive mode.
    This option must not appear in combination with any of the following options: command, peers.

    Force ntpq to operate in interactive mode. Prompts will be written to the standard output and commands read from the standard input.

numeric host addresses.

    Output all host addresses in dotted-quad numeric format rather than converting to the canonical host names.

Always output status line with readvar.

    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.

Print a list of the peers.
    This option must not appear in combination with any of the following options: interactive.

    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.

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:
    hash ipv4
    or their numeric equivalent.

    The default *[I-Font]keyword for this option is:
     ipv4

    Set the default display format for S2+ refids.

Display the full 'remote' value.

    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.

Display usage information and exit.

Pass the extended usage information through a pager.

Save the option state to cfgfile.  The default is the last
    configuration file listed in the OPTION PRESETS section, below. The command will exit after updating the config file.

Load options from cfgfile.
    The no-load-opts form will disable the loading of earlier config/rc/ini files. --no-load-opts is handled early, out of order.

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.

OPTION PRESETS
Any option that is not marked as not presettable may be preset by loading values from configuration ("RC" or ".INI") file(s) and values from environment variables named:
  NTPQ_<option-name> or NTPQ
The 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.

ENVIRONMENT
See OPTION PRESETS for configuration environment variables.

FILES
See OPTION PRESETS for configuration files.

EXIT STATUS
One of the following exit values will be returned:

Successful program execution.

The operation failed or the command syntax was not valid.

A specified configuration file could not be loaded.

libopts had an internal operational error.  Please report
    it to autogen-users@lists.sourceforge.net. Thank you.

AUTHORS
The University of Delaware and Network Time Foundation

COPYRIGHT
Copyright (C) 1992-2016 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>.

BUGS
Please send bug reports to: http://bugs.ntp.org, bugs@ntp.org

NOTES
This manual page was AutoGen-erated from the ntpq option definitions.