19c2daa00SOllivier Robert<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 29c2daa00SOllivier Robert 39c2daa00SOllivier Robert<html> 49c2daa00SOllivier Robert 59c2daa00SOllivier Robert <head> 69c2daa00SOllivier Robert <meta name="generator" content="HTML Tidy, see www.w3.org"> 79c2daa00SOllivier Robert <title>ntpq - standard NTP query program</title> 89c2daa00SOllivier Robert <link href="scripts/style.css" type="text/css" rel="stylesheet"> 99c2daa00SOllivier Robert </head> 109c2daa00SOllivier Robert 119c2daa00SOllivier Robert <body> 129c2daa00SOllivier Robert <h3><tt>ntpq</tt> - standard NTP query program</h3> 139c2daa00SOllivier Robert <img src="pic/bustardfly.gif" alt="gif" align="left"><a href="http://www.eecis.udel.edu/~mills/pictures.html">from <i>Pogo</i>, Walt Kelly</a> 149c2daa00SOllivier Robert <p>A typical NTP monitoring packet</p> 159c2daa00SOllivier Robert <p>Last update: <csobj format="ShortTime" h="24" locale="00000409" region="0" t="DateTime" w="50">21:38</csobj> UTC <csobj format="LongDate" h="24" locale="00000409" region="0" t="DateTime" w="230">Sunday, January 26, 2003</csobj></p> 169c2daa00SOllivier Robert <br clear="left"> 179c2daa00SOllivier Robert <h4>More Help</h4> 189c2daa00SOllivier Robert <script type="text/javascript" language="javascript" src="scripts/links12.txt"></script> 199c2daa00SOllivier Robert <hr> 209c2daa00SOllivier Robert <h4>Synopsis</h4> 219c2daa00SOllivier Robert <tt>ntpq [-inp] [-c <i>command</i>] [<i>host</i>] [...]</tt> 229c2daa00SOllivier Robert <h4>Description</h4> 239c2daa00SOllivier Robert <p>The <tt>ntpq</tt> utility program is used to monitor NTP daemon <tt>ntpd</tt> operations and determine performance. It uses the standard NTP mode 6 control message formats defined in Appendix B of the NTPv3 specification RFC1305. 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.</p> 249c2daa00SOllivier Robert <p>The program can 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 <tt>ntpq</tt> can also obtain and print a list of peers in a common format by sending multiple queries to the server.</p> 259c2daa00SOllivier Robert <p>If one or more request options is included on the command line when <tt>ntpq</tt> 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, <tt>ntpq</tt> 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. <tt>ntpq</tt>will prompt for commands if the standard input is a terminal device.</p> 269c2daa00SOllivier Robert <p><tt>ntpq</tt> 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. <tt>ntpq</tt> makes one attempt to retransmit requests, and will time requests out if the remote host is not heard from within a suitable timeout time.</p> 279c2daa00SOllivier Robert <p>Note that in contexts where a host name is expected, a <tt>-4</tt> qualifier preceding the host name forces DNS resolution to the IPv4 namespace, while a <tt>-6</tt> qualifier forces DNS resolution to the IPv6 namespace.</p> 289c2daa00SOllivier Robert <p>For examples and usage, see the <a href="debug.html">NTP Debugging Techniques</a> page.</p> 299c2daa00SOllivier Robert <p>Command line options are described following. Specifying a command line option other than <tt>-i</tt> or <tt>-n</tt> will cause the specified query (queries) to be sent to the indicated host(s) immediately. Otherwise, <tt>ntpq</tt> will attempt to read interactive format commands from the standard input.</p> 309c2daa00SOllivier Robert <dl> 319c2daa00SOllivier Robert <dt><tt>-4</tt> 329c2daa00SOllivier Robert <dd>Force DNS resolution of following host names on the command line to the IPv4 namespace. 339c2daa00SOllivier Robert <dt><tt>-6</tt> 349c2daa00SOllivier Robert <dd>Force DNS resolution of following host names on the command line to the IPv6 namespace. 359c2daa00SOllivier Robert <dt><tt>-c</tt> 369c2daa00SOllivier Robert <dd>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). Multiple <tt>-c</tt> options may be given. 379c2daa00SOllivier Robert <dt><tt>-d</tt> 389c2daa00SOllivier Robert <dd>Turn on debugging mode. 399c2daa00SOllivier Robert <dt><tt>-i</tt> 409c2daa00SOllivier Robert <dd>Force <tt>ntpq</tt> to operate in interactive mode. Prompts will be written to the standard output and commands read from the standard input. 419c2daa00SOllivier Robert <dt><tt>-n</tt> 429c2daa00SOllivier Robert <dd>Output all host addresses in dotted-quad numeric format rather than converting to the canonical host names. 439c2daa00SOllivier Robert <dt><tt>-p</tt> 449c2daa00SOllivier Robert <dd>Print a list of the peers known to the server as well as a summary of their state. This is equivalent to the <tt>peers</tt> interactive command. 459c2daa00SOllivier Robert </dl> 469c2daa00SOllivier Robert <h4>Internal Commands</h4> 479c2daa00SOllivier Robert <p>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. The output of a command is normally sent to the standard output, but optionally the output of individual commands may be sent to a file by appending a <tt>></tt>, followed by a file name, to the command line. A number of interactive format commands are executed entirely within the <tt>ntpq</tt> program itself and do not result in NTP mode 6 requests being sent to a server. These are described following.</p> 489c2daa00SOllivier Robert <dl> 499c2daa00SOllivier Robert <dt><tt>? [<i>command_keyword</i>]</tt><br> 509c2daa00SOllivier Robert <tt>helpl [<i>command_keyword</i>]</tt> 519c2daa00SOllivier Robert <dd>A <tt>?</tt> by itself will print a list of all the command keywords known to this incarnation of <tt>ntpq</tt>. A <tt>?</tt> followed by a command keyword will print function and usage information about the command. This command is probably a better source of information about <tt>ntpq</tt> than this manual page. 529c2daa00SOllivier Robert <dt><tt>addvars <i>variable_name</i> [ = <i>value</i>] [...]</tt><br> 539c2daa00SOllivier Robert <tt>rmvars <i>variable_name</i> [...]</tt><br> 549c2daa00SOllivier Robert <tt>clearvars</tt> 559c2daa00SOllivier Robert <dd>The data carried by NTP mode 6 messages consists of a list of items of the form <tt><i>variable_name</i> = <i>value</i></tt>, where the <tt>= <i>value</i></tt> is ignored, and can be omitted, in requests to the server to read variables. <tt>ntpq</tt> maintains an internal list in which data to be included in control messages can be assembled, and sent using the <tt>readlist</tt> and <tt>writelist</tt> commands described below. The <tt>addvars</tt> 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 <tt>rmvars</tt> command can be used to remove individual variables from the list, while the <tt>clearlist</tt> command removes all variables from the list. 569c2daa00SOllivier Robert <dt><tt>cooked</tt> 579c2daa00SOllivier Robert <dd>Causes output from query commands to be "cooked", so that variables which are recognized by <tt>ntpq</tt> will have their values reformatted for human consumption. Variables which <tt>ntpq</tt> thinks should have a decodable value but didn't are marked with a trailing <tt>?</tt>. 589c2daa00SOllivier Robert <dt><tt>debug more | less | off</tt> 599c2daa00SOllivier Robert <dd>Turns internal query program debugging on and off. 609c2daa00SOllivier Robert <dt><tt>delay <i>milliseconds</i></tt> 619c2daa00SOllivier Robert <dd>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. 629c2daa00SOllivier Robert <dt><tt>host <i>hostname</i></tt> 639c2daa00SOllivier Robert <dd>Set the host to which future queries will be sent. Hostname may be either a host name or a numeric address. 649c2daa00SOllivier Robert <dt><tt>hostnames [yes | no]</tt> 659c2daa00SOllivier Robert <dd>If <tt>yes</tt> is specified, host names are printed in information displays. If <tt>no</tt> is specified, numeric addresses are printed instead. The default is <tt>yes</tt>, unless modified using the command line <tt>-n</tt> switch. 669c2daa00SOllivier Robert <dt><tt>keyid <i>keyid</i></tt> 679c2daa00SOllivier Robert <dd>This command specifies the key number to be used to authenticate configuration requests. This must correspond to a key number the server has been configured to use for this purpose. 689c2daa00SOllivier Robert <dt><tt>ntpversion 1 | 2 | 3 | 4</tt> 699c2daa00SOllivier Robert <dd>Sets the NTP version number which <tt>ntpq</tt> claims in packets. Defaults to 3, Note that mode 6 control messages (and modes, for that matter) didn't exist in NTP version 1. 709c2daa00SOllivier Robert <dt><tt>passwd</tt> 719c2daa00SOllivier Robert <dd>This command prompts for a password (which will not be echoed) which will be used to authenticate configuration requests. The password must correspond to the key configured for NTP server for this purpose. 729c2daa00SOllivier Robert <dt><tt>quit</tt> 739c2daa00SOllivier Robert <dd>Exit <tt>ntpq</tt>. 749c2daa00SOllivier Robert <dt><tt>raw</tt> 759c2daa00SOllivier Robert <dd>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. 769c2daa00SOllivier Robert <dt><tt>timeout <i>millseconds</i></tt> 779c2daa00SOllivier Robert <dd>Specify a timeout period for responses to server queries. The default is about 5000 milliseconds. Note that since <tt>ntpq</tt> retries each query once after a timeout, the total waiting time for a timeout will be twice the timeout value set. 789c2daa00SOllivier Robert </dl> 799c2daa00SOllivier Robert <h4>Control Message Commands</h4> 809c2daa00SOllivier Robert <p>Each association known to an NTP server has a 16 bit integer association identifier. NTP control messages which carry peer variables must identify the peer the values correspond to by including its association ID. An association ID of 0 is special, and indicates the variables are system variables, whose names are drawn from a separate name space.</p> 819c2daa00SOllivier Robert <p>Control message commands result in one or more NTP mode 6 messages being sent to the server, and cause the data returned to be printed in some format. Most commands currently implemented send a single message and expect a single response. The current exceptions are the peers command, which will send a preprogrammed series of messages to obtain the data it needs, and the mreadlist and mreadvar commands, which will iterate over a range of associations.</p> 829c2daa00SOllivier Robert <dl> 839c2daa00SOllivier Robert <dt><tt>associations</tt> 849c2daa00SOllivier Robert <dd>Obtains and prints a list of association identifiers and peer statuses for in-spec peers of the server being queried. The list is printed in columns. The first of these is an index numbering the associations from 1 for internal use, the second the actual association identifier returned by the server and the third the status word for the peer. This is followed by a number of columns containing data decoded from the status word See the peers command for a decode of the <tt>condition</tt> field. Note that the data returned by the <tt>associations"</tt> command is cached internally in <tt>ntpq</tt>. The index is then of use when dealing with stupid servers which use association identifiers which are hard for humans to type, in that for any subsequent commands which require an association identifier as an argument, the form &index may be used as an alternative. 859c2daa00SOllivier Robert <dt><tt>clockvar [<i>assocID</i>] [<i>variable_name</i> [ = <i>value</i> [...]] [...]</tt> 869c2daa00SOllivier Robert <dt><tt>cv [<i>assocID</i>] [<i>variable_name</i> [ = <i>value</i> [...] ][...]</tt> 879c2daa00SOllivier Robert <dd>Requests that a list of the server's clock variables be sent. Servers which have a radio clock or other external synchronization will respond positively to this. If the association identifier is omitted or zero the request is for the variables of the <tt>system clock</tt> and will generally get a positive response from all servers with a clock. If the server treats clocks as pseudo-peers, and hence can possibly have more than one clock connected at once, referencing the appropriate peer association ID will show the variables of a particular clock. Omitting the variable list will cause the server to return a default variable display. 889c2daa00SOllivier Robert <dt><tt>lassociations</tt> 899c2daa00SOllivier Robert <dd>Obtains and prints a list of association identifiers and peer statuses for all associations for which the server is maintaining state. This command differs from the <tt>associations</tt> command only for servers which retain state for out-of-spec client associations (i.e., fuzzballs). Such associations are normally omitted from the display when the <tt>associations</tt> command is used, but are included in the output of <tt>lassociations</tt>. 909c2daa00SOllivier Robert <dt><tt>lpassociations</tt> 919c2daa00SOllivier Robert <dd>Print data for all associations, including out-of-spec client associations, from the internally cached list of associations. This command differs from <tt>passociations</tt> only when dealing with fuzzballs. 929c2daa00SOllivier Robert <dt><tt>lpeers</tt> 939c2daa00SOllivier Robert <dd>Like R peers, except a summary of all associations for which the server is maintaining state is printed. This can produce a much longer list of peers from fuzzball servers. 949c2daa00SOllivier Robert <dt><tt>mreadlist <i>assocID</i> <i>assocID</i></tt><br> 959c2daa00SOllivier Robert <tt>mrl <i>assocID</i> <i>assocID</i></tt> 969c2daa00SOllivier Robert <dd>Like the <tt>readlist</tt> command, except the query is done for each of a range of (nonzero) association IDs. This range is determined from the association list cached by the most recent <tt>associations</tt> command. 979c2daa00SOllivier Robert <dt><tt>mreadvar <i>assocID</i> <i>assocID</i> [ <i>variable_name</i> [ = <i>value</i>[ ... ]</tt><br> 989c2daa00SOllivier Robert <tt>mrv <i>assocID</i> <i>assocID</i> [ <i>variable_name</i> [ = <i>value</i>[ ... ]</tt> 999c2daa00SOllivier Robert <dd>Like the <tt>readvar</tt> command, except the query is done for each of a range of (nonzero) association IDs. This range is determined from the association list cached by the most recent <tt>associations</tt> command. 1009c2daa00SOllivier Robert <dt><tt>opeers</tt> 1019c2daa00SOllivier Robert <dd>An old form of the <tt>peers</tt> command with the reference ID replaced by the local interface address. 1029c2daa00SOllivier Robert <dt><tt>passociations</tt> 1039c2daa00SOllivier Robert <dd>Displays association data concerning in-spec peers from the internally cached list of associations. This command performs identically to the <tt>associations</tt> except that it displays the internally stored data rather than making a new query. 1049c2daa00SOllivier Robert <dt><tt>peers</tt> 1059c2daa00SOllivier Robert <dd>Obtains a current list peers of the server, along with a summary of each peer's state. Summary information includes the address of the remote peer, the reference ID (0.0.0.0 if this is unknown), the stratum of the remote peer, the type of the peer (local, unicast, multicast or broadcast), when the last packet was received, the polling interval, in seconds, the reachability register, in octal, and the current estimated delay, offset and dispersion of the peer, all in milliseconds. The character at the left margin of each line shows the synchronization status of the association and is a valuable diagnostic tool. The encoding and meaning of this character, called the tally code, is given later in this page. 1069c2daa00SOllivier Robert <dt><tt>pstatus <i>assocID</i></tt> 1079c2daa00SOllivier Robert <dd>Sends a read status request to the server for the given association. The names and values of the peer variables returned will be printed. Note that the status word from the header is displayed preceding the variables, both in hexadecimal and in pidgeon English. 1089c2daa00SOllivier Robert <dt><tt>readlist [ <i>assocID</i> ]</tt><br> 1099c2daa00SOllivier Robert <tt>rl [ <i>assocID</i> ]</tt> 1109c2daa00SOllivier Robert <dd>Requests that the values of the variables in the internal variable list be returned by the server. If the association ID is omitted or is 0 the variables are assumed to be system variables. Otherwise they are treated as peer variables. If the internal variable list is empty a request is sent without data, which should induce the remote server to return a default display. 1119c2daa00SOllivier Robert <dt><tt>readvar <i>assocID</i> <i>variable_name</i> [ = <i>value</i> ] [ ...]</tt><br> 1129c2daa00SOllivier Robert <tt>rv <i>assocID</i> [ <i>variable_name</i> [ = <i>value</i> ] [...]</tt> 1139c2daa00SOllivier Robert <dd>Requests that the values of the specified variables be returned by the server by sending a read variables request. If the association ID is omitted or is given as zero the variables are system variables, otherwise they are peer variables and the values returned will be those of the corresponding peer. Omitting the variable list will send a request with no data which should induce the server to return a default display. The encoding and meaning of the variables derived from NTPv3 is given in RFC-1305; the encoding and meaning of the additional NTPv4 variables are given later in this page. 1149c2daa00SOllivier Robert <dt><tt>writevar <i>assocID</i> <i>variable_name</i> [ = <i>value</i> [ ...]</tt> 1159c2daa00SOllivier Robert <dd>Like the readvar request, except the specified variables are written instead of read. 1169c2daa00SOllivier Robert <dt><tt>writelist [ <i>assocID</i> ]</tt> 1179c2daa00SOllivier Robert <dd>Like the readlist request, except the internal list variables are written instead of read. 1189c2daa00SOllivier Robert </dl> 1199c2daa00SOllivier Robert <h4>Tally Codes</h4> 1209c2daa00SOllivier Robert <p>The character in the left margin in the <tt>peers</tt> billboard, called the tally code, shows the fate of each association in the clock selection process. Following is a list of these characters, the pigeon used in the <tt>rv</tt> command, and a short explanation of the condition revealed.</p> 1219c2daa00SOllivier Robert <dl> 1229c2daa00SOllivier Robert <dt><tt>space reject</tt> 1239c2daa00SOllivier Robert <dd>The peer is discarded as unreachable, synchronized to this server (synch loop) or outrageous synchronization distance. 1249c2daa00SOllivier Robert <dt><tt>x falsetick</tt> 1259c2daa00SOllivier Robert <dd>The peer is discarded by the intersection algorithm as a falseticker. 1269c2daa00SOllivier Robert <dt><tt>. excess</tt> 1279c2daa00SOllivier Robert <dd>The peer is discarded as not among the first ten peers sorted by synchronization distance and so is probably a poor candidate for further consideration. 1289c2daa00SOllivier Robert <dt><tt>- outlyer</tt> 1299c2daa00SOllivier Robert <dd>The peer is discarded by the clustering algorithm as an outlyer. 1309c2daa00SOllivier Robert <dt><tt>+ candidat</tt> 1319c2daa00SOllivier Robert <dd>The peer is a survivor and a candidate for the combining algorithm. 1329c2daa00SOllivier Robert <dt><tt># selected</tt> 1339c2daa00SOllivier Robert <dd>The peer is a survivor, but not among the first six peers sorted by synchronization distance. If the association is ephemeral, it may be demobilized to conserve resources. <dt><tt>* sys.peer</tt> 1349c2daa00SOllivier Robert <dd>The peer has been declared the system peer and lends its variables to the system variables. 1359c2daa00SOllivier Robert <dt><tt>o pps.peer</tt> 1369c2daa00SOllivier Robert <dd>The peer has been declared the system peer and lends its variables to thesystem variables. However, the actual system synchronization is derived from a pulse-per-second (PPS) signal, either indirectly via the PPS reference clock driver or directly via kernel interface. 1379c2daa00SOllivier Robert </dl> 1389c2daa00SOllivier Robert <h4>System Variables</h4> 1399c2daa00SOllivier Robert <p>The <tt>status, leap, stratum, precision, rootdelay, rootdispersion, refid, reftime, poll, offset, and frequency</tt> variables are described in RFC-1305 specification. Additional NTPv4 system variables include the following.</p> 1409c2daa00SOllivier Robert <dl> 1419c2daa00SOllivier Robert <dt><tt>version</tt> 1429c2daa00SOllivier Robert <dd>Everything you might need to know about the software version and generation time. 1439c2daa00SOllivier Robert <dt><tt>processor</tt> 1449c2daa00SOllivier Robert <dd>The processor and kernel identification string. 1459c2daa00SOllivier Robert <dt><tt>system</tt> 1469c2daa00SOllivier Robert <dd>The operating system version and release identifier. 1479c2daa00SOllivier Robert <dt><tt>state</tt> 1489c2daa00SOllivier Robert <dd>The state of the clock discipline state machine. The values are described in the architecture briefing on the NTP Project page linked from www.ntp.org. 1499c2daa00SOllivier Robert <dt><tt>peer</tt> 1509c2daa00SOllivier Robert <dd>The internal integer used to identify the association currently designated the system peer. 1519c2daa00SOllivier Robert <dt><tt>jitter</tt> 1529c2daa00SOllivier Robert <dd>The estimated time error of the system clock measured as an exponential average of RMS time differences. 1539c2daa00SOllivier Robert <dt><tt>stability</tt> 1549c2daa00SOllivier Robert <dd>The estimated frequency stability of the system clock measured as an exponential average of RMS frequency differences. 1559c2daa00SOllivier Robert </dl> 1569c2daa00SOllivier Robert <p>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 dance:</p> 1579c2daa00SOllivier Robert <dl> 1589c2daa00SOllivier Robert <dt><tt>flags</tt> 1599c2daa00SOllivier Robert <dd>The current flags word bits and message digest algorithm identifier (NID) in hex format. The high order 16 bits of the four-byte word contain the NID from the OpenSSL ligrary, while the low-order bits are interpreted as follows: 1609c2daa00SOllivier Robert <dd> 1619c2daa00SOllivier Robert <dl> 1629c2daa00SOllivier Robert <dt><tt>0x01</tt> 1639c2daa00SOllivier Robert <dd>autokey enabled 1649c2daa00SOllivier Robert <dt><tt>0x02</tt> 1659c2daa00SOllivier Robert <dd>NIST leapseconds file loaded 1669c2daa00SOllivier Robert <dt><tt>0x10</tt> 1679c2daa00SOllivier Robert <dd>PC identity scheme 1689c2daa00SOllivier Robert <dt><tt>0x20</tt> 1699c2daa00SOllivier Robert <dd>IFF identity scheme 1709c2daa00SOllivier Robert <dt><tt>0x40</tt> 1719c2daa00SOllivier Robert <dd>GQ identity scheme 1729c2daa00SOllivier Robert </dl> 1739c2daa00SOllivier Robert <dt><tt>hostname</tt> 1749c2daa00SOllivier Robert <dd>The name of the host as returned by the Unix <tt>gethostname()</tt> library function. 1759c2daa00SOllivier Robert <dt><tt>hostkey</tt> 1769c2daa00SOllivier Robert <dd>The NTP filestamp of the host key file. 1779c2daa00SOllivier Robert <dt><tt>cert</tt> 1789c2daa00SOllivier Robert <dd>A list of certificates held by the host. Each entry includes the subject, issuer, flags and NTP filestamp in order. The bits are interpreted as follows: 1799c2daa00SOllivier Robert <dd> 1809c2daa00SOllivier Robert <dl> 1819c2daa00SOllivier Robert <dt><tt>0x01</tt> 1829c2daa00SOllivier Robert <dd>certificate has been signed by the server 1839c2daa00SOllivier Robert <dt><tt>0x02</tt> 1849c2daa00SOllivier Robert <dd>certificate is trusted 1859c2daa00SOllivier Robert <dt><tt>0x04</tt> 1869c2daa00SOllivier Robert <dd>certificate is private 1879c2daa00SOllivier Robert <dt><tt>0x08</tt> 1889c2daa00SOllivier Robert <dd>certificate contains errors and should not be trusted 1899c2daa00SOllivier Robert </dl> 1909c2daa00SOllivier Robert <dt><tt>leapseconds</tt> 1919c2daa00SOllivier Robert <dd>The NTP filestamp of the NIST leapseconds file. 1929c2daa00SOllivier Robert <dt><tt>refresh</tt> 1939c2daa00SOllivier Robert <dd>The NTP timestamp when the host public cryptographic values were refreshed and signed. 1949c2daa00SOllivier Robert <dt><tt>signature</tt> 1959c2daa00SOllivier Robert <dd>The host digest/signature scheme name from the OpenSSL library. 1969c2daa00SOllivier Robert <dt><tt>tai</tt> 1979c2daa00SOllivier Robert <dd>The TAI-UTC offset in seconds obtained from the NIST leapseconds table. 1989c2daa00SOllivier Robert </dl> 1999c2daa00SOllivier Robert <h4>Peer Variables</h4> 2009c2daa00SOllivier Robert <p>The <tt>status, srcadr, srcport, dstadr, dstport, leap, stratum, precision, rootdelay, rootdispersion, readh, hmode, pmode, hpoll, ppoll, offset, delay, dspersion, reftime</tt> variables are described in the RFC-1305 specification, as are the timestamps <tt>org, rec and xmt</tt>. Additional NTPv4 system variables include the following.</p> 2019c2daa00SOllivier Robert <dl> 2029c2daa00SOllivier Robert <dt><tt>flash</tt> 2039c2daa00SOllivier Robert <dd>The flash code for the most recent packet received. The encoding and meaning of these codes is given later in this page. 2049c2daa00SOllivier Robert <dt><tt>jitter</tt> 2059c2daa00SOllivier Robert <dd>The estimated time error of the peer clock measured as an exponential average of RMS time differences. 2069c2daa00SOllivier Robert <dt><tt>unreach</tt> 2079c2daa00SOllivier Robert <dd>The value of the counter which records the number of poll intervals since the last valid packet was received. 2089c2daa00SOllivier Robert </dl> 2099c2daa00SOllivier Robert <p>When the NTPv4 daemon is compiled with the OpenSSL software library, additional peer variables are displayed, including the following:</p> 2109c2daa00SOllivier Robert <dl> 2119c2daa00SOllivier Robert <dt><tt>flags</tt> 2129c2daa00SOllivier Robert <dd>The current flag bits. This word is the server host status word with additional bits used by the Autokey state machine. See the source code for the bit encoding. 2139c2daa00SOllivier Robert <dt><tt>hostname</tt> 2149c2daa00SOllivier Robert <dd>The server host name. 2159c2daa00SOllivier Robert <dt><tt>initkey <i>key</i></tt> 2169c2daa00SOllivier Robert <dd>The initial key used by the key list generator in the Autokey protocol. 2179c2daa00SOllivier Robert <dt><tt>initsequence <i>index</i></tt> 2189c2daa00SOllivier Robert <dd>The initial index used by the key list generator in the Autokey protocol. 2199c2daa00SOllivier Robert <dt><tt>signature</tt> 2209c2daa00SOllivier Robert <dd>The server message digest/signature scheme name from the OpenSSL software library. 2219c2daa00SOllivier Robert <dt><tt>timestamp <i>time</i></tt> 2229c2daa00SOllivier Robert <dd>The NTP timestamp when the last Autokey key list was generated and signed. 2239c2daa00SOllivier Robert </dl> 2249c2daa00SOllivier Robert <h4>Flash Codes</h4> 2259c2daa00SOllivier Robert <p>The <tt>flash</tt> code is a valuable debugging aid displayed in the peer variables list. It shows the results of the original sanity checks defined in the NTP specification RFC-1305 and additional ones added in NTPv4. There are 12 tests designated <tt>TEST1</tt> through <tt>TEST12</tt>. The tests are performed in a certain order designed to gain maximum diagnostic information while protecting against accidental or malicious errors. The <tt>flash</tt> variable is initialized to zero as each packet is received. If after each set of tests one or more bits are set, the packet is discarded.</p> 2269c2daa00SOllivier Robert <p>Tests <tt>TEST1</tt> through <tt>TEST3</tt> check the packet timestamps from which the offset and delay are calculated. If any bits are set, the packet is discarded; otherwise, the packet header variables are saved. <tt>TEST4</tt> and <tt>TEST5</tt> are associated with access control and cryptographic authentication. If any bits are set, the packet is discarded immediately with nothing changed.</p> 2279c2daa00SOllivier Robert <p>Tests <tt>TEST6</tt> through <tt>TEST8</tt> check the health of the server. If any bits are set, the packet is discarded; otherwise, the offset and delay relative to the server are calculated and saved. <tt>TEST9</tt> checks the health of the association itself. If any bits are set, the packet is discarded; otherwise, the saved variables are passed to the clock filter and mitigation algorithms.</p> 2289c2daa00SOllivier Robert <p>Tests <tt>TEST10</tt> through <tt>TEST12</tt> check the authentication state using Autokey public-key cryptography, as described in the <a href="authopt.html">Authentication Options</a> page. If any bits are set and the association has previously been marked reachable, the packet is discarded; otherwise, the originate and receive timestamps are saved, as required by the NTP protocol, and processing continues.</p> 2299c2daa00SOllivier Robert <p>The <tt>flash</tt> bits for each test are defined as follows.</p> 2309c2daa00SOllivier Robert <dl> 2319c2daa00SOllivier Robert <dt><tt>0x001 TEST1</tt> 2329c2daa00SOllivier Robert <dd>Duplicate packet. The packet is at best a casual retransmission and at worst a malicious replay. 2339c2daa00SOllivier Robert <dt><tt>0x002 TEST2</tt> 2349c2daa00SOllivier Robert <dd>Bogus packet. The packet is not a reply to a message previously sent. This can happen when the NTP daemon is restarted and before somebody else notices. 2359c2daa00SOllivier Robert <dt><tt>0x004 TEST3</tt> 2369c2daa00SOllivier Robert <dd>Unsynchronized. One or more timestamp fields are invalid. This normally happens when the first packet from a peer is received. 2379c2daa00SOllivier Robert <dt><tt>0x008 TEST4</tt> 2389c2daa00SOllivier Robert <dd>Access is denied. See the <a href="accopt.html">Access Control Options</a> page. 2399c2daa00SOllivier Robert <dt><tt>0x010 TEST5</tt> 2409c2daa00SOllivier Robert <dd>Cryptographic authentication fails. See the <a href="authopt.html">Authentication Options</a> page. 2419c2daa00SOllivier Robert <dt><tt>0x020TEST6</tt> 2429c2daa00SOllivier Robert <dd>The server is unsynchronized. Wind up its clock first. 2439c2daa00SOllivier Robert <dt><tt>0x040 TEST7</tt> 2449c2daa00SOllivier Robert <dd>The server stratum is at the maximum than 15. It is probably unsynchronized and its clock needs to be wound up. 2459c2daa00SOllivier Robert <dt><tt>0x080 TEST8</tt> 2469c2daa00SOllivier Robert <dd>Either the root delay or dispersion is greater than one second, which is highly unlikely unless the peer is unsynchronized to Mars. 2479c2daa00SOllivier Robert <dt><tt>0x100 TEST9</tt> 2489c2daa00SOllivier Robert <dd>Either the peer delay or dispersion is greater than one second, which is higly unlikely unless the peer is on Mars. 2499c2daa00SOllivier Robert <dt><tt>0x200 TEST10</tt> 2509c2daa00SOllivier Robert <dd>The autokey protocol has detected an authentication failure. See the <a href="authopt.html">Authentication Options</a> page. 2519c2daa00SOllivier Robert <dt><tt>0x400 TEST11</tt> 2529c2daa00SOllivier Robert <dd>The autokey protocol has not verified the server or peer is proventic and has valid public key credentials. See the <a href="authopt.html">Authentication Options</a> page. 2539c2daa00SOllivier Robert <dt><tt>0x800 TEST12</tt> 2549c2daa00SOllivier Robert <dd>A protocol or configuration error has occurred in the public key algorithms or a possible intrusion event has been detected. See the <a href="authopt.html">Authentication Options</a> page. 2559c2daa00SOllivier Robert </dl> 2569c2daa00SOllivier Robert <h4>Bugs</h4> 2579c2daa00SOllivier Robert <p>The peers command is non-atomic and may occasionally result in spurious error messages about invalid associations occurring and terminating the command. The timeout time is a fixed constant, which means you wait a long time for timeouts since it assumes sort of a worst case. The program should improve the timeout estimate as it sends queries to a particular host, but doesn't.</p> 2589c2daa00SOllivier Robert <hr> 2599c2daa00SOllivier Robert <script type="text/javascript" language="javascript" src="scripts/footer.txt"></script> 2609c2daa00SOllivier Robert </body> 2619c2daa00SOllivier Robert 2629c2daa00SOllivier Robert</html> 263
