12b15cb3dSCy Schubert<html lang="en"> 22b15cb3dSCy Schubert<head> 32b15cb3dSCy Schubert<title>ntpq: Network Time Protocol Query User's Manual</title> 42b15cb3dSCy Schubert<meta http-equiv="Content-Type" content="text/html"> 52b15cb3dSCy Schubert<meta name="description" content="ntpq: Network Time Protocol Query User's Manual"> 62b15cb3dSCy Schubert<meta name="generator" content="makeinfo 4.7"> 72b15cb3dSCy Schubert<link title="Top" rel="top" href="#Top"> 82b15cb3dSCy Schubert<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage"> 92b15cb3dSCy Schubert<meta http-equiv="Content-Style-Type" content="text/css"> 102b15cb3dSCy Schubert<style type="text/css"><!-- 112b15cb3dSCy Schubert pre.display { font-family:inherit } 122b15cb3dSCy Schubert pre.format { font-family:inherit } 132b15cb3dSCy Schubert pre.smalldisplay { font-family:inherit; font-size:smaller } 142b15cb3dSCy Schubert pre.smallformat { font-family:inherit; font-size:smaller } 152b15cb3dSCy Schubert pre.smallexample { font-size:smaller } 162b15cb3dSCy Schubert pre.smalllisp { font-size:smaller } 172b15cb3dSCy Schubert span.sc { font-variant:small-caps } 182b15cb3dSCy Schubert span.roman { font-family: serif; font-weight: normal; } 192b15cb3dSCy Schubert--></style> 202b15cb3dSCy Schubert</head> 212b15cb3dSCy Schubert<body> 222b15cb3dSCy Schubert<h1 class="settitle">ntpq: Network Time Protocol Query User's Manual</h1> 232b15cb3dSCy Schubert <div class="shortcontents"> 242b15cb3dSCy Schubert<h2>Short Contents</h2> 252b15cb3dSCy Schubert<ul> 262b15cb3dSCy Schubert<a href="#Top">ntpq: Network Time Protocol Query User Manual</a> 272b15cb3dSCy Schubert</ul> 282b15cb3dSCy Schubert</div> 292b15cb3dSCy Schubert 302b15cb3dSCy Schubert 312b15cb3dSCy Schubert 322b15cb3dSCy Schubert<div class="node"> 332b15cb3dSCy Schubert<p><hr> 342b15cb3dSCy Schubert<a name="Top"></a>Next: <a rel="next" accesskey="n" href="#ntpq-Description">ntpq Description</a>, 352b15cb3dSCy SchubertPrevious: <a rel="previous" accesskey="p" href="#dir">(dir)</a>, 362b15cb3dSCy SchubertUp: <a rel="up" accesskey="u" href="#dir">(dir)</a> 372b15cb3dSCy Schubert<br> 382b15cb3dSCy Schubert</div> 392b15cb3dSCy Schubert 402b15cb3dSCy Schubert<h2 class="unnumbered">ntpq: Network Time Protocol Query User Manual</h2> 412b15cb3dSCy Schubert 422b15cb3dSCy Schubert<p>The <code>ntpq</code> utility program is used to 432b15cb3dSCy Schubertmonitor the operational status 442b15cb3dSCy Schubertand determine the performance of 452b15cb3dSCy Schubert<code>ntpd</code>, the NTP daemon. 462b15cb3dSCy Schubert 47*09100258SXin LI <p>This document applies to version 4.2.8p11 of <code>ntpq</code>. 482b15cb3dSCy Schubert 492b15cb3dSCy Schubert<ul class="menu"> 502b15cb3dSCy Schubert<li><a accesskey="1" href="#ntpq-Description">ntpq Description</a> 512b15cb3dSCy Schubert<li><a accesskey="2" href="#ntpq-Invocation">ntpq Invocation</a>: Invoking ntpq 522b15cb3dSCy Schubert<li><a accesskey="3" href="#Usage">Usage</a> 532b15cb3dSCy Schubert<li><a accesskey="4" href="#Internal-Commands">Internal Commands</a> 542b15cb3dSCy Schubert<li><a accesskey="5" href="#Control-Message-Commands">Control Message Commands</a> 552b15cb3dSCy Schubert<li><a accesskey="6" href="#Status-Words-and-Kiss-Codes">Status Words and Kiss Codes</a> 562b15cb3dSCy Schubert<li><a accesskey="7" href="#System-Variables">System Variables</a> 572b15cb3dSCy Schubert<li><a accesskey="8" href="#Peer-Variables">Peer Variables</a> 582b15cb3dSCy Schubert<li><a accesskey="9" href="#Clock-Variables">Clock Variables</a> 592b15cb3dSCy Schubert</ul> 602b15cb3dSCy Schubert 612b15cb3dSCy Schubert<div class="node"> 622b15cb3dSCy Schubert<p><hr> 632b15cb3dSCy Schubert<a name="ntpq-Description"></a>Next: <a rel="next" accesskey="n" href="#Usage">Usage</a>, 642b15cb3dSCy SchubertPrevious: <a rel="previous" accesskey="p" href="#Top">Top</a>, 652b15cb3dSCy SchubertUp: <a rel="up" accesskey="u" href="#Top">Top</a> 662b15cb3dSCy Schubert<br> 672b15cb3dSCy Schubert</div> 682b15cb3dSCy Schubert 692b15cb3dSCy Schubert<!-- node-name, next, previous, up --> 702b15cb3dSCy Schubert<h3 class="section">Description</h3> 712b15cb3dSCy Schubert 722b15cb3dSCy Schubert<p>The <code>ntpq</code> utility program is used to monitor NTP daemon <code>ntpd</code> operations and determine performance. 732b15cb3dSCy SchubertIt uses the standard NTP mode 6 control message formats defined in 742b15cb3dSCy SchubertAppendix B of the NTPv3 specification RFC1305. 752b15cb3dSCy SchubertThe same formats are used in NTPv4, although some of the variable names have changed and new ones added. 762b15cb3dSCy SchubertThe description on this page is for the NTPv4 variables. 772b15cb3dSCy Schubert 782b15cb3dSCy Schubert <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 <code>ntpq</code> can also obtain and print a list of peers in a common format by sending multiple queries to the server. 792b15cb3dSCy Schubert 802b15cb3dSCy Schubert <p>If one or more request options is included on the command line when <code>ntpq</code> 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, <code>ntpq</code> 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. <code>ntpq</code> will prompt for commands if the standard input is a terminal device. 812b15cb3dSCy Schubert 822b15cb3dSCy Schubert <p><code>ntpq</code> 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. <code>ntpq</code> makes one attempt to retransmit requests, and will time requests out if the remote host is not heard from within a suitable timeout time. 832b15cb3dSCy Schubert 842b15cb3dSCy Schubert <p>Note that in contexts where a host name is expected, a <code>-4</code> qualifier preceding the host name forces DNS resolution to the IPv4 namespace, while a <code>-6</code> qualifier forces DNS resolution to the IPv6 namespace. 852b15cb3dSCy Schubert 862b15cb3dSCy Schubert <p>For examples and usage, see the <a href="debug.html">NTP Debugging Techniques</a> page. 872b15cb3dSCy Schubert 882b15cb3dSCy Schubert<div class="node"> 892b15cb3dSCy Schubert<p><hr> 902b15cb3dSCy Schubert<a name="ntpq-Invocation"></a> 912b15cb3dSCy Schubert<br> 922b15cb3dSCy Schubert</div> 932b15cb3dSCy Schubert 942b15cb3dSCy Schubert<h3 class="section">Invoking ntpq</h3> 952b15cb3dSCy Schubert 962b15cb3dSCy Schubert<p><a name="index-ntpq-1"></a><a name="index-standard-NTP-query-program-2"></a> 972b15cb3dSCy Schubert 982b15cb3dSCy Schubert <p>The 992b15cb3dSCy Schubert<code>ntpq</code> 100*09100258SXin LIutility program is used to query NTP servers to monitor NTP operations 101*09100258SXin LIand performance, requesting 1022b15cb3dSCy Schubertinformation about current state and/or changes in that state. 1032b15cb3dSCy SchubertThe program may be run either in interactive mode or controlled using 1042b15cb3dSCy Schubertcommand line arguments. 1052b15cb3dSCy SchubertRequests to read and write arbitrary 1062b15cb3dSCy Schubertvariables can be assembled, with raw and pretty-printed output 1072b15cb3dSCy Schubertoptions being available. 1082b15cb3dSCy SchubertThe 1092b15cb3dSCy Schubert<code>ntpq</code> 1102b15cb3dSCy Schubertutility can also obtain and print a 1112b15cb3dSCy Schubertlist of peers in a common format by sending multiple queries to the 1122b15cb3dSCy Schubertserver. 1132b15cb3dSCy Schubert 1142b15cb3dSCy Schubert <p>If one or more request options is included on the command line 1152b15cb3dSCy Schubertwhen 1162b15cb3dSCy Schubert<code>ntpq</code> 1172b15cb3dSCy Schubertis executed, each of the requests will be sent 1182b15cb3dSCy Schubertto the NTP servers running on each of the hosts given as command 1192b15cb3dSCy Schubertline arguments, or on localhost by default. 1202b15cb3dSCy SchubertIf no request options 1212b15cb3dSCy Schubertare given, 1222b15cb3dSCy Schubert<code>ntpq</code> 1232b15cb3dSCy Schubertwill attempt to read commands from the 1242b15cb3dSCy Schubertstandard input and execute these on the NTP server running on the 1252b15cb3dSCy Schubertfirst host given on the command line, again defaulting to localhost 1262b15cb3dSCy Schubertwhen no other host is specified. 1272b15cb3dSCy SchubertThe 1282b15cb3dSCy Schubert<code>ntpq</code> 1292b15cb3dSCy Schubertutility will prompt for 1302b15cb3dSCy Schubertcommands if the standard input is a terminal device. 1312b15cb3dSCy Schubert 1322b15cb3dSCy Schubert <p><code>ntpq</code> 1332b15cb3dSCy Schubertuses NTP mode 6 packets to communicate with the 1342b15cb3dSCy SchubertNTP server, and hence can be used to query any compatible server on 1352b15cb3dSCy Schubertthe network which permits it. 1362b15cb3dSCy SchubertNote that since NTP is a UDP protocol 1372b15cb3dSCy Schubertthis communication will be somewhat unreliable, especially over 1382b15cb3dSCy Schubertlarge distances in terms of network topology. 1392b15cb3dSCy SchubertThe 1402b15cb3dSCy Schubert<code>ntpq</code> 1412b15cb3dSCy Schubertutility makes 1422b15cb3dSCy Schubertone attempt to retransmit requests, and will time requests out if 1432b15cb3dSCy Schubertthe remote host is not heard from within a suitable timeout 1442b15cb3dSCy Schuberttime. 1452b15cb3dSCy Schubert 146*09100258SXin LI <p>Note that in contexts where a host name is expected, a 147*09100258SXin LI<code>-4</code> 148*09100258SXin LIqualifier preceding the host name forces resolution to the IPv4 149*09100258SXin LInamespace, while a 150*09100258SXin LI<code>-6</code> 151*09100258SXin LIqualifier forces resolution to the IPv6 namespace. 152*09100258SXin LIFor examples and usage, see the 153*09100258SXin LINTP Debugging Techniques 154*09100258SXin LIpage. 155*09100258SXin LI 1562b15cb3dSCy Schubert <p>Specifying a 1572b15cb3dSCy Schubertcommand line option other than 1582b15cb3dSCy Schubert<code>-i</code> 1592b15cb3dSCy Schubertor 1602b15cb3dSCy Schubert<code>-n</code> 1612b15cb3dSCy Schubertwill 1622b15cb3dSCy Schubertcause the specified query (queries) to be sent to the indicated 1632b15cb3dSCy Schuberthost(s) immediately. 1642b15cb3dSCy SchubertOtherwise, 1652b15cb3dSCy Schubert<code>ntpq</code> 1662b15cb3dSCy Schubertwill attempt to read 1672b15cb3dSCy Schubertinteractive format commands from the standard input. 1682b15cb3dSCy Schubert 1692b15cb3dSCy Schubert<h5 class="subsubsection">Internal Commands</h5> 1702b15cb3dSCy Schubert 1712b15cb3dSCy Schubert<p>Interactive format commands consist of a keyword followed by zero 1722b15cb3dSCy Schubertto four arguments. 1732b15cb3dSCy SchubertOnly enough characters of the full keyword to 1742b15cb3dSCy Schubertuniquely identify the command need be typed. 1752b15cb3dSCy Schubert 1762b15cb3dSCy Schubert <p>A 1772b15cb3dSCy Schubertnumber of interactive format commands are executed entirely within 1782b15cb3dSCy Schubertthe 1792b15cb3dSCy Schubert<code>ntpq</code> 180*09100258SXin LIutility itself and do not result in NTP 1812b15cb3dSCy Schubertrequests being sent to a server. 1822b15cb3dSCy SchubertThese are described following. 1832b15cb3dSCy Schubert <dl> 184*09100258SXin LI<dt><code>?</code> <code>[</code><kbd>command</kbd><code>]</code><br><dt><code>help</code> <code>[</code><kbd>command</kbd><code>]</code><dd>A 1852b15cb3dSCy Schubert? 186*09100258SXin LIby itself will print a list of all the commands 187*09100258SXin LIknown to 1882b15cb3dSCy Schubert<code>ntpq</code> 1892b15cb3dSCy SchubertA 1902b15cb3dSCy Schubert? 191*09100258SXin LIfollowed by a command name will print function and usage 1922b15cb3dSCy Schubertinformation about the command. 193*09100258SXin LI<br><dt><code>addvars</code> <kbd>name</kbd><code>[=</code><kbd>value</kbd><code>]</code><code>[,...]</code><br><dt><code>rmvars</code> <kbd>name</kbd><code>[,...]</code><br><dt><code>clearvars</code><br><dt><code>showvars</code><dd>The arguments to this command consist of a list of 1942b15cb3dSCy Schubertitems of the form 195*09100258SXin LI<kbd>name</kbd><code>[=</code><kbd>value</kbd><code>]</code>, 1962b15cb3dSCy Schubertwhere the 197*09100258SXin LI.No = Ns Ar value 1982b15cb3dSCy Schubertis ignored, and can be omitted, 1992b15cb3dSCy Schubertin requests to the server to read variables. 2002b15cb3dSCy SchubertThe 2012b15cb3dSCy Schubert<code>ntpq</code> 202*09100258SXin LIutility maintains an internal list in which data to be included in 203*09100258SXin LImessages can be assembled, and displayed or set using the 2042b15cb3dSCy Schubert<code>readlist</code> 2052b15cb3dSCy Schubertand 2062b15cb3dSCy Schubert<code>writelist</code> 2072b15cb3dSCy Schubertcommands described below. 2082b15cb3dSCy SchubertThe 2092b15cb3dSCy Schubert<code>addvars</code> 2102b15cb3dSCy Schubertcommand allows variables and their optional values to be added to 2112b15cb3dSCy Schubertthe list. 2122b15cb3dSCy SchubertIf more than one variable is to be added, the list should 2132b15cb3dSCy Schubertbe comma-separated and not contain white space. 2142b15cb3dSCy SchubertThe 2152b15cb3dSCy Schubert<code>rmvars</code> 2162b15cb3dSCy Schubertcommand can be used to remove individual variables from the list, 2172b15cb3dSCy Schubertwhile the 218*09100258SXin LI<code>clearvars</code> 2192b15cb3dSCy Schubertcommand removes all variables from the 2202b15cb3dSCy Schubertlist. 2212b15cb3dSCy SchubertThe 2222b15cb3dSCy Schubert<code>showvars</code> 2232b15cb3dSCy Schubertcommand displays the current list of optional variables. 2242b15cb3dSCy Schubert<br><dt><code>authenticate</code> <code>[yes|no]</code><dd>Normally 2252b15cb3dSCy Schubert<code>ntpq</code> 2262b15cb3dSCy Schubertdoes not authenticate requests unless 2272b15cb3dSCy Schubertthey are write requests. 2282b15cb3dSCy SchubertThe command 229*09100258SXin LI<code>authenticate</code> <code>yes</code> 2302b15cb3dSCy Schubertcauses 2312b15cb3dSCy Schubert<code>ntpq</code> 2322b15cb3dSCy Schubertto send authentication with all requests it 2332b15cb3dSCy Schubertmakes. 2342b15cb3dSCy SchubertAuthenticated requests causes some servers to handle 235*09100258SXin LIrequests slightly differently. 2362b15cb3dSCy SchubertThe command 237*09100258SXin LI<code>authenticate</code> 2382b15cb3dSCy Schubertcauses 2392b15cb3dSCy Schubert<code>ntpq</code> 2402b15cb3dSCy Schubertto display whether or not 241*09100258SXin LIit is currently authenticating requests. 2422b15cb3dSCy Schubert<br><dt><code>cooked</code><dd>Causes output from query commands to be "cooked", so that 2432b15cb3dSCy Schubertvariables which are recognized by 2442b15cb3dSCy Schubert<code>ntpq</code> 2452b15cb3dSCy Schubertwill have their 2462b15cb3dSCy Schubertvalues reformatted for human consumption. 2472b15cb3dSCy SchubertVariables which 2482b15cb3dSCy Schubert<code>ntpq</code> 249*09100258SXin LIcould not decode completely are 2502b15cb3dSCy Schubertmarked with a trailing 2512b15cb3dSCy Schubert?. 2522b15cb3dSCy Schubert<br><dt><code>debug</code> <code>[more|less|off]</code><dd>With no argument, displays the current debug level. 253*09100258SXin LIOtherwise, the debugging level is changed as indicated. 254*09100258SXin LI<br><dt><code>delay</code> <code>[</code><kbd>milliseconds</kbd><code>]</code><dd>Specify a time interval to be added to timestamps included in 2552b15cb3dSCy Schubertrequests which require authentication. 2562b15cb3dSCy SchubertThis is used to enable 2572b15cb3dSCy Schubert(unreliable) server reconfiguration over long delay network paths 2582b15cb3dSCy Schubertor between machines whose clocks are unsynchronized. 2592b15cb3dSCy SchubertActually the 2602b15cb3dSCy Schubertserver does not now require timestamps in authenticated requests, 2612b15cb3dSCy Schubertso this command may be obsolete. 262*09100258SXin LIWithout any arguments, displays the current delay. 263*09100258SXin LI<br><dt><code>drefid</code> <code>[hash|ipv4]</code><dd>Display refids as IPv4 or hash. 264*09100258SXin LIWithout any arguments, displays whether refids are shown as IPv4 265*09100258SXin LIaddresses or hashes. 2662b15cb3dSCy Schubert<br><dt><code>exit</code><dd>Exit 2672b15cb3dSCy Schubert<code>ntpq</code> 268*09100258SXin LI<br><dt><code>host</code> <code>[</code><kbd>name</kbd><code>]</code><dd>Set the host to which future queries will be sent. 269*09100258SXin LIThe 270*09100258SXin LI<kbd>name</kbd> 2712b15cb3dSCy Schubertmay be either a host name or a numeric address. 272*09100258SXin LIWithout any arguments, displays the current host. 2732b15cb3dSCy Schubert<br><dt><code>hostnames</code> <code>[yes|no]</code><dd>If 2742b15cb3dSCy Schubert<code>yes</code> 2752b15cb3dSCy Schubertis specified, host names are printed in 2762b15cb3dSCy Schubertinformation displays. 2772b15cb3dSCy SchubertIf 2782b15cb3dSCy Schubert<code>no</code> 2792b15cb3dSCy Schubertis specified, numeric 2802b15cb3dSCy Schubertaddresses are printed instead. 2812b15cb3dSCy SchubertThe default is 2822b15cb3dSCy Schubert<code>yes</code>, 2832b15cb3dSCy Schubertunless 2842b15cb3dSCy Schubertmodified using the command line 2852b15cb3dSCy Schubert<code>-n</code> 2862b15cb3dSCy Schubertswitch. 287*09100258SXin LIWithout any arguments, displays whether host names or numeric addresses 288*09100258SXin LIare shown. 289*09100258SXin LI<br><dt><code>keyid</code> <code>[</code><kbd>keyid</kbd><code>]</code><dd>This command allows the specification of a key number to be 2902b15cb3dSCy Schubertused to authenticate configuration requests. 2912b15cb3dSCy SchubertThis must correspond 292276da39aSCy Schubertto the 293276da39aSCy Schubert<code>controlkey</code> 294276da39aSCy Schubertkey number the server has been configured to use for this 2952b15cb3dSCy Schubertpurpose. 296*09100258SXin LIWithout any arguments, displays the current 297*09100258SXin LI<kbd>keyid</kbd>. 298*09100258SXin LI<br><dt><code>keytype</code> <code>[</code><kbd>digest</kbd><code>]</code><dd>Specify the digest algorithm to use for authenticating requests, with default 299*09100258SXin LI<code>MD5</code>. 3002b15cb3dSCy SchubertIf 3012b15cb3dSCy Schubert<code>ntpq</code> 302*09100258SXin LIwas built with OpenSSL support, and OpenSSL is installed, 303*09100258SXin LI<kbd>digest</kbd> 304*09100258SXin LIcan be any message digest algorithm supported by OpenSSL. 3052b15cb3dSCy SchubertIf no argument is given, the current 306*09100258SXin LI<code>keytype</code> <kbd>digest</kbd> 307*09100258SXin LIalgorithm used is displayed. 3082b15cb3dSCy Schubert<br><dt><code>ntpversion</code> <code>[1|2|3|4]</code><dd>Sets the NTP version number which 3092b15cb3dSCy Schubert<code>ntpq</code> 3102b15cb3dSCy Schubertclaims in 3112b15cb3dSCy Schubertpackets. 3122b15cb3dSCy SchubertDefaults to 3, and note that mode 6 control messages (and 3132b15cb3dSCy Schubertmodes, for that matter) didn't exist in NTP version 1. 3142b15cb3dSCy SchubertThere appear 3152b15cb3dSCy Schubertto be no servers left which demand version 1. 3162b15cb3dSCy SchubertWith no argument, displays the current NTP version that will be used 3172b15cb3dSCy Schubertwhen communicating with servers. 3182b15cb3dSCy Schubert<br><dt><code>passwd</code><dd>This command prompts you to type in a password (which will not 3192b15cb3dSCy Schubertbe echoed) which will be used to authenticate configuration 3202b15cb3dSCy Schubertrequests. 3212b15cb3dSCy SchubertThe password must correspond to the key configured for 3222b15cb3dSCy Schubertuse by the NTP server for this purpose if such requests are to be 3232b15cb3dSCy Schubertsuccessful. 324*09100258SXin LI<br><dt><code>poll</code> <code>[</code><kbd>n</kbd><code>]</code> <code>[verbose]</code><dd>Poll an NTP server in client mode 3252b15cb3dSCy Schubert<kbd>n</kbd> 326*09100258SXin LItimes. 327*09100258SXin LIPoll not implemented yet. 3282b15cb3dSCy Schubert<br><dt><code>quit</code><dd>Exit 3292b15cb3dSCy Schubert<code>ntpq</code> 3302b15cb3dSCy Schubert<br><dt><code>raw</code><dd>Causes all output from query commands is printed as received 3312b15cb3dSCy Schubertfrom the remote server. 3322b15cb3dSCy SchubertThe only formating/interpretation done on 3332b15cb3dSCy Schubertthe data is to transform nonascii data into a printable (but barely 3342b15cb3dSCy Schubertunderstandable) form. 335*09100258SXin LI<br><dt><code>timeout</code> <code>[</code><kbd>milliseconds</kbd><code>]</code><dd>Specify a timeout period for responses to server queries. 3362b15cb3dSCy SchubertThe 3372b15cb3dSCy Schubertdefault is about 5000 milliseconds. 338*09100258SXin LIWithout any arguments, displays the current timeout period. 3392b15cb3dSCy SchubertNote that since 3402b15cb3dSCy Schubert<code>ntpq</code> 3412b15cb3dSCy Schubertretries each query once after a timeout, the total waiting time for 3422b15cb3dSCy Schuberta timeout will be twice the timeout value set. 343*09100258SXin LI<br><dt><code>version</code><dd>Display the version of the 3442b15cb3dSCy Schubert<code>ntpq</code> 3452b15cb3dSCy Schubertprogram. 3462b15cb3dSCy Schubert</dl> 3472b15cb3dSCy Schubert 3482b15cb3dSCy Schubert<h5 class="subsubsection">Control Message Commands</h5> 3492b15cb3dSCy Schubert 350*09100258SXin LI<p>Association ids are used to identify system, peer and clock variables. 351*09100258SXin LISystem variables are assigned an association id of zero and system name 352*09100258SXin LIspace, while each association is assigned a nonzero association id and 353*09100258SXin LIpeer namespace. 354*09100258SXin LIMost control commands send a single message to the server and expect a 355*09100258SXin LIsingle response message. 3562b15cb3dSCy SchubertThe exceptions are the 3572b15cb3dSCy Schubert<code>peers</code> 3582b15cb3dSCy Schubertcommand, which sends a series of messages, 3592b15cb3dSCy Schubertand the 3602b15cb3dSCy Schubert<code>mreadlist</code> 3612b15cb3dSCy Schubertand 3622b15cb3dSCy Schubert<code>mreadvar</code> 3632b15cb3dSCy Schubertcommands, which iterate over a range of associations. 3642b15cb3dSCy Schubert <dl> 365*09100258SXin LI<dt><code>apeers</code><dd>Display a list of peers in the form: 366*09100258SXin LI <pre class="example"> [tally]remote refid assid st t when pool reach delay offset jitter 367*09100258SXin LI </pre> 368*09100258SXin LI <p>where the output is just like the 369*09100258SXin LI<code>peers</code> 370*09100258SXin LIcommand except that the 371*09100258SXin LI<code>refid</code> 372*09100258SXin LIis displayed in hex format and the association number is also displayed. 373*09100258SXin LI<br><dt><code>associations</code><dd>Display a list of mobilized associations in the form: 3742b15cb3dSCy Schubert <pre class="example"> ind assid status conf reach auth condition last_event cnt 3752b15cb3dSCy Schubert </pre> 3762b15cb3dSCy Schubert <dl> 377*09100258SXin LI<dt>Sy Variable Ta Sy Description<br><dt><code>ind</code> <code>Ta</code> <code>index</code> <code>on</code> <code>this</code> <code>list</code><br><dt><code>assid</code> <code>Ta</code> <code>association</code> <code>id</code><br><dt><code>status</code> <code>Ta</code> <code>peer</code> <code>status</code> <code>word</code><br><dt><code>conf</code> <code>Ta</code> <code>yes</code>: <code>No</code> <code>persistent,</code> <code>no</code>: <code>No</code> <code>ephemeral</code><br><dt><code>reach</code> <code>Ta</code> <code>yes</code>: <code>No</code> <code>reachable,</code> <code>no</code>: <code>No</code> <code>unreachable</code><br><dt><code>auth</code> <code>Ta</code> <code>ok</code>, <code>yes</code>, <code>bad</code> <code>No</code> <code>and</code> <code>none</code><br><dt><code>condition</code> <code>Ta</code> <code>selection</code> <code>status</code> <code>(see</code> <code>the</code> <code>select</code> <code>No</code> <code>field</code> <code>of</code> <code>the</code> <code>peer</code> <code>status</code> <code>word)</code><br><dt><code>last_event</code> <code>Ta</code> <code>event</code> <code>report</code> <code>(see</code> <code>the</code> <code>event</code> <code>No</code> <code>field</code> <code>of</code> <code>the</code> <code>peer</code> <code>status</code> <code>word)</code><br><dt><code>cnt</code> <code>Ta</code> <code>event</code> <code>count</code> <code>(see</code> <code>the</code> <code>count</code> <code>No</code> <code>field</code> <code>of</code> <code>the</code> <code>peer</code> <code>status</code> <code>word)</code><dd></dl> 378*09100258SXin LI <br><dt><code>authinfo</code><dd>Display the authentication statistics counters: 379*09100258SXin LItime since reset, stored keys, free keys, key lookups, keys not found, 380*09100258SXin LIuncached keys, expired keys, encryptions, decryptions. 381*09100258SXin LI<br><dt><code>clocklist</code> <code>[</code><kbd>associd</kbd><code>]</code><br><dt><code>cl</code> <code>[</code><kbd>associd</kbd><code>]</code><dd>Display all clock variables in the variable list for those associations 382*09100258SXin LIsupporting a reference clock. 383*09100258SXin LI<br><dt><code>clockvar</code> <code>[</code><kbd>associd</kbd><code>]</code> <code>[</code><kbd>name</kbd><code>[=</code><kbd>value</kbd><code>]]</code><code>[,...]</code><br><dt><code>cv</code> <code>[</code><kbd>associd</kbd><code>]</code> <code>[</code><kbd>name</kbd><code>[=</code><kbd>value</kbd><code>]]</code><code>[,...]</code><dd>Display a list of clock variables for those associations supporting a 384*09100258SXin LIreference clock. 385*09100258SXin LI<br><dt><code>:config</code> <kbd>configuration command line</kbd><dd>Send the remainder of the command line, including whitespace, to the 386*09100258SXin LIserver as a run-time configuration command in the same format as a line 387*09100258SXin LIin the configuration file. 388*09100258SXin LIThis command is experimental until further notice and clarification. 389*09100258SXin LIAuthentication is of course required. 390*09100258SXin LI<br><dt><code>config-from-file</code> <kbd>filename</kbd><dd>Send each line of 3912b15cb3dSCy Schubert<kbd>filename</kbd> 392*09100258SXin LIto the server as run-time configuration commands in the same format as 393*09100258SXin LIlines in the configuration file. 394*09100258SXin LIThis command is experimental until further notice and clarification. 395*09100258SXin LIAuthentication is required. 396*09100258SXin LI<br><dt><code>ifstats</code><dd>Display status and statistics counters for each local network interface address: 397*09100258SXin LIinterface number, interface name and address or broadcast, drop, flag, 398*09100258SXin LIttl, mc, received, sent, send failed, peers, uptime. 399*09100258SXin LIAuthentication is required. 400*09100258SXin LI<br><dt><code>iostats</code><dd>Display network and reference clock I/O statistics: 401*09100258SXin LItime since reset, receive buffers, free receive buffers, used receive buffers, 402*09100258SXin LIlow water refills, dropped packets, ignored packets, received packets, 403*09100258SXin LIpackets sent, packet send failures, input wakeups, useful input wakeups. 404*09100258SXin LI<br><dt><code>kerninfo</code><dd>Display kernel loop and PPS statistics: 405*09100258SXin LIassocid, status, pll offset, pll frequency, maximum error, 406*09100258SXin LIestimated error, kernel status, pll time constant, precision, 407*09100258SXin LIfrequency tolerance, pps frequency, pps stability, pps jitter, 408*09100258SXin LIcalibration interval, calibration cycles, jitter exceeded, 409*09100258SXin LIstability exceeded, calibration errors. 410*09100258SXin LIAs with other ntpq output, times are in milliseconds; very small values 411*09100258SXin LImay be shown as exponentials. 412*09100258SXin LIThe precision value displayed is in milliseconds as well, unlike the 413*09100258SXin LIprecision system variable. 414*09100258SXin LI<br><dt><code>lassociations</code><dd>Perform the same function as the associations command, except display 415*09100258SXin LImobilized and unmobilized associations, including all clients. 416*09100258SXin LI<br><dt><code>lopeers</code> <code>[-4|-6]</code><dd>Display a list of all peers and clients showing 417*09100258SXin LI<code>dstadr</code> 418*09100258SXin LI(associated with the given IP version). 419*09100258SXin LI<br><dt><code>lpassociations</code><dd>Display the last obtained list of associations, including all clients. 420*09100258SXin LI<br><dt><code>lpeers</code> <code>[-4|-6]</code><dd>Display a list of all peers and clients (associated with the given IP version). 421*09100258SXin LI<br><dt><code>monstats</code><dd>Display monitor facility status, statistics, and limits: 422*09100258SXin LIenabled, addresses, peak addresses, maximum addresses, 423*09100258SXin LIreclaim above count, reclaim older than, kilobytes, maximum kilobytes. 424*09100258SXin LI<br><dt><code>mreadlist</code> <kbd>associdlo</kbd> <kbd>associdhi</kbd><br><dt><code>mrl</code> <kbd>associdlo</kbd> <kbd>associdhi</kbd><dd>Perform the same function as the 425*09100258SXin LI<code>readlist</code> 426*09100258SXin LIcommand for a range of association ids. 427*09100258SXin LI<br><dt><code>mreadvar</code> <kbd>associdlo</kbd> <kbd>associdhi</kbd> <code>[</code><kbd>name</kbd><code>]</code><code>[,...]</code><dd>This range may be determined from the list displayed by any 428*09100258SXin LIcommand showing associations. 429*09100258SXin LI<br><dt><code>mrv</code> <kbd>associdlo</kbd> <kbd>associdhi</kbd> <code>[</code><kbd>name</kbd><code>]</code><code>[,...]</code><dd>Perform the same function as the 430*09100258SXin LI<code>readvar</code> 431*09100258SXin LIcommand for a range of association ids. 432*09100258SXin LIThis range may be determined from the list displayed by any 433*09100258SXin LIcommand showing associations. 434*09100258SXin LI<br><dt><code>mrulist</code> <code>[limited | kod | mincount=</code><kbd>count</kbd><code> | laddr=</code><kbd>localaddr</kbd><code> | sort=[-]</code><kbd>sortorder</kbd><code> | resany=</code><kbd>hexmask</kbd><code> | resall=</code><kbd>hexmask</kbd><code>]</code><dd>Display traffic counts of the most recently seen source addresses 435*09100258SXin LIcollected and maintained by the monitor facility. 4362b15cb3dSCy SchubertWith the exception of 437*09100258SXin LI<code>sort</code>=<code>[-]</code><kbd>sortorder</kbd>, 4382b15cb3dSCy Schubertthe options filter the list returned by 439*09100258SXin LI<code>ntpd(8)</code>. 4402b15cb3dSCy SchubertThe 4412b15cb3dSCy Schubert<code>limited</code> 4422b15cb3dSCy Schubertand 4432b15cb3dSCy Schubert<code>kod</code> 444*09100258SXin LIoptions return only entries representing client addresses from which the 445*09100258SXin LIlast packet received triggered either discarding or a KoD response. 4462b15cb3dSCy SchubertThe 4472b15cb3dSCy Schubert<code>mincount</code>=<kbd>count</kbd> 4482b15cb3dSCy Schubertoption filters entries representing less than 4492b15cb3dSCy Schubert<kbd>count</kbd> 4502b15cb3dSCy Schubertpackets. 4512b15cb3dSCy SchubertThe 4522b15cb3dSCy Schubert<code>laddr</code>=<kbd>localaddr</kbd> 4532b15cb3dSCy Schubertoption filters entries for packets received on any local address other than 4542b15cb3dSCy Schubert<kbd>localaddr</kbd>. 4552b15cb3dSCy Schubert<code>resany</code>=<kbd>hexmask</kbd> 4562b15cb3dSCy Schubertand 4572b15cb3dSCy Schubert<code>resall</code>=<kbd>hexmask</kbd> 4582b15cb3dSCy Schubertfilter entries containing none or less than all, respectively, of the bits in 4592b15cb3dSCy Schubert<kbd>hexmask</kbd>, 4602b15cb3dSCy Schubertwhich must begin with 4612b15cb3dSCy Schubert<code>0x</code>. 4622b15cb3dSCy SchubertThe 4632b15cb3dSCy Schubert<kbd>sortorder</kbd> 4642b15cb3dSCy Schubertdefaults to 4652b15cb3dSCy Schubert<code>lstint</code> 466*09100258SXin LIand may be 4672b15cb3dSCy Schubert<code>addr</code>, 4682b15cb3dSCy Schubert<code>avgint</code>, 469*09100258SXin LI<code>count</code>, 4702b15cb3dSCy Schubert<code>lstint</code>, 471*09100258SXin LIor any of those preceded by 472*09100258SXin LI- 473*09100258SXin LIto reverse the sort order. 4742b15cb3dSCy SchubertThe output columns are: 4752b15cb3dSCy Schubert <dl> 4762b15cb3dSCy Schubert<dt>Column<dd>Description 477*09100258SXin LI<br><dt><code>lstint</code><dd>Interval in seconds between the receipt of the most recent packet from 478*09100258SXin LIthis address and the completion of the retrieval of the MRU list by 4792b15cb3dSCy Schubert<code>ntpq</code> 4802b15cb3dSCy Schubert<br><dt><code>avgint</code><dd>Average interval in s between packets from this address. 4812b15cb3dSCy Schubert<br><dt><code>rstr</code><dd>Restriction flags associated with this address. 4822b15cb3dSCy SchubertMost are copied unchanged from the matching 4832b15cb3dSCy Schubert<code>restrict</code> 484*09100258SXin LIcommand, however 0x400 (kod) and 0x20 (limited) flags are cleared unless 485*09100258SXin LIthe last packet from this address triggered a rate control response. 4862b15cb3dSCy Schubert<br><dt><code>r</code><dd>Rate control indicator, either 4872b15cb3dSCy Schuberta period, 4882b15cb3dSCy Schubert<code>L</code> 4892b15cb3dSCy Schubertor 4902b15cb3dSCy Schubert<code>K</code> 4912b15cb3dSCy Schubertfor no rate control response, 4922b15cb3dSCy Schubertrate limiting by discarding, or rate limiting with a KoD response, respectively. 4932b15cb3dSCy Schubert<br><dt><code>m</code><dd>Packet mode. 4942b15cb3dSCy Schubert<br><dt><code>v</code><dd>Packet version number. 4952b15cb3dSCy Schubert<br><dt><code>count</code><dd>Packets received from this address. 4962b15cb3dSCy Schubert<br><dt><code>rport</code><dd>Source port of last packet from this address. 497*09100258SXin LI<br><dt><code>remote</code> <code>address</code><dd>host or DNS name, numeric address, or address followed by 4982b15cb3dSCy Schubertclaimed DNS name which could not be verified in parentheses. 4992b15cb3dSCy Schubert</dl> 5002b15cb3dSCy Schubert <br><dt><code>opeers</code> <code>[-4 | -6]</code><dd>Obtain and print the old-style list of all peers and clients showing 501*09100258SXin LI<code>dstadr</code> 502*09100258SXin LI(associated with the given IP version), 5032b15cb3dSCy Schubertrather than the 504*09100258SXin LI<code>refid</code>. 5052b15cb3dSCy Schubert<br><dt><code>passociations</code><dd>Perform the same function as the 5062b15cb3dSCy Schubert<code>associations</code> 5072b15cb3dSCy Schubertcommand, 5082b15cb3dSCy Schubertexcept that it uses previously stored data rather than making a new query. 5092b15cb3dSCy Schubert<br><dt><code>peers</code><dd>Display a list of peers in the form: 5102b15cb3dSCy Schubert <pre class="example"> [tally]remote refid st t when pool reach delay offset jitter 5112b15cb3dSCy Schubert </pre> 5122b15cb3dSCy Schubert <dl> 5132b15cb3dSCy Schubert<dt>Variable<dd>Description 5142b15cb3dSCy Schubert<br><dt><code>[tally]</code><dd>single-character code indicating current value of the 5152b15cb3dSCy Schubert<code>select</code> 5162b15cb3dSCy Schubertfield of the 5172b15cb3dSCy Schubert.Lk decode.html#peer "peer status word" 5182b15cb3dSCy Schubert<br><dt><code>remote</code><dd>host name (or IP number) of peer. 5192b15cb3dSCy SchubertThe value displayed will be truncated to 15 characters unless the 520*09100258SXin LI<code>ntpq</code> 5212b15cb3dSCy Schubert<code>-w</code> 522*09100258SXin LIoption is given, in which case the full value will be displayed 523*09100258SXin LIon the first line, and if too long, 524*09100258SXin LIthe remaining data will be displayed on the next line. 525*09100258SXin LI<br><dt><code>refid</code><dd>source IP address or 5262b15cb3dSCy Schubert.Lk decode.html#kiss "'kiss code" 527*09100258SXin LI<br><dt><code>st</code><dd>stratum: 0 for local reference clocks, 1 for servers with local 528*09100258SXin LIreference clocks, ..., 16 for unsynchronized server clocks 5292b15cb3dSCy Schubert<br><dt><code>t</code><dd><code>u</code>: 5302b15cb3dSCy Schubertunicast or manycast client, 5312b15cb3dSCy Schubert<code>b</code>: 5322b15cb3dSCy Schubertbroadcast or multicast client, 533*09100258SXin LI<code>p</code>: 534*09100258SXin LIpool source, 5352b15cb3dSCy Schubert<code>l</code>: 5362b15cb3dSCy Schubertlocal (reference clock), 5372b15cb3dSCy Schubert<code>s</code>: 5382b15cb3dSCy Schubertsymmetric (peer), 5392b15cb3dSCy Schubert<code>A</code>: 5402b15cb3dSCy Schubertmanycast server, 5412b15cb3dSCy Schubert<code>B</code>: 5422b15cb3dSCy Schubertbroadcast server, 5432b15cb3dSCy Schubert<code>M</code>: 5442b15cb3dSCy Schubertmulticast server 545*09100258SXin LI<br><dt><code>when</code><dd>time in seconds, minutes, hours, or days since the last packet 546*09100258SXin LIwas received, or 547*09100258SXin LI- 548*09100258SXin LIif a packet has never been received 549*09100258SXin LI<br><dt><code>poll</code><dd>poll interval (s) 5502b15cb3dSCy Schubert<br><dt><code>reach</code><dd>reach shift register (octal) 5512b15cb3dSCy Schubert<br><dt><code>delay</code><dd>roundtrip delay 5522b15cb3dSCy Schubert<br><dt><code>offset</code><dd>offset of server relative to this host 553*09100258SXin LI<br><dt><code>jitter</code><dd>offset RMS error estimate. 5542b15cb3dSCy Schubert</dl> 555*09100258SXin LI <br><dt><code>pstats</code> <kbd>associd</kbd><dd>Display the statistics for the peer with the given 556*09100258SXin LI<kbd>associd</kbd>: 557*09100258SXin LIassocid, status, remote host, local address, time last received, 558*09100258SXin LItime until next send, reachability change, packets sent, 559*09100258SXin LIpackets received, bad authentication, bogus origin, duplicate, 560*09100258SXin LIbad dispersion, bad reference time, candidate order. 561*09100258SXin LI<br><dt><code>readlist</code> <code>[</code><kbd>associd</kbd><code>]</code><br><dt><code>rl</code> <code>[</code><kbd>associd</kbd><code>]</code><dd>Display all system or peer variables. 562*09100258SXin LIIf the 563*09100258SXin LI<kbd>associd</kbd> 564*09100258SXin LIis omitted, it is assumed to be zero. 565*09100258SXin LI<br><dt><code>readvar</code> <code>[</code><kbd>associd</kbd> <kbd>name</kbd><code>[=</code><kbd>value</kbd><code>] [, ...]]</code><br><dt><code>rv</code> <code>[</code><kbd>associd</kbd> <kbd>name</kbd><code>[=</code><kbd>value</kbd><code>] [, ...]]</code><dd>Display the specified system or peer variables. 5662b15cb3dSCy SchubertIf 567*09100258SXin LI<kbd>associd</kbd> 5682b15cb3dSCy Schubertis zero, the variables are from the 5692b15cb3dSCy Schubert<a href="#System-Variables">System Variables</a> 5702b15cb3dSCy Schubertname space, otherwise they are from the 5712b15cb3dSCy Schubert<a href="#Peer-Variables">Peer Variables</a> 5722b15cb3dSCy Schubertname space. 5732b15cb3dSCy SchubertThe 574*09100258SXin LI<kbd>associd</kbd> 5752b15cb3dSCy Schubertis required, as the same name can occur in both spaces. 5762b15cb3dSCy SchubertIf no 5772b15cb3dSCy Schubert<kbd>name</kbd> 5782b15cb3dSCy Schubertis included, all operative variables in the name space are displayed. 579*09100258SXin LIIn this case only, if the 580*09100258SXin LI<kbd>associd</kbd> 581*09100258SXin LIis omitted, it is assumed to be zero. 5822b15cb3dSCy SchubertMultiple names are specified with comma separators and without whitespace. 5832b15cb3dSCy SchubertNote that time values are represented in milliseconds 5842b15cb3dSCy Schubertand frequency values in parts-per-million (PPM). 5852b15cb3dSCy SchubertSome NTP timestamps are represented in the format 586*09100258SXin LI<kbd>YYYY</kbd><kbd>MM</kbd> <kbd>DD</kbd> <kbd>TTTT</kbd>, 587*09100258SXin LIwhere 588*09100258SXin LI<kbd>YYYY</kbd> 589*09100258SXin LIis the year, 590*09100258SXin LI<kbd>MM</kbd> 591*09100258SXin LIthe month of year, 592*09100258SXin LI<kbd>DD</kbd> 593*09100258SXin LIthe day of month and 594*09100258SXin LI<kbd>TTTT</kbd> 595*09100258SXin LIthe time of day. 596*09100258SXin LI<br><dt><code>reslist</code><dd>Display the access control (restrict) list for 5972b15cb3dSCy Schubert<code>ntpq</code> 598*09100258SXin LIAuthentication is required. 599*09100258SXin LI<br><dt><code>saveconfig</code> <kbd>filename</kbd><dd>Save the current configuration, 600*09100258SXin LIincluding any runtime modifications made by 6012b15cb3dSCy Schubert<code>:config</code> 6022b15cb3dSCy Schubertor 6032b15cb3dSCy Schubert<code>config-from-file</code>, 604*09100258SXin LIto the NTP server host file 6052b15cb3dSCy Schubert<kbd>filename</kbd>. 6062b15cb3dSCy SchubertThis command will be rejected by the server unless 6072b15cb3dSCy Schubert.Lk miscopt.html#saveconfigdir "saveconfigdir" 6082b15cb3dSCy Schubertappears in the 609*09100258SXin LI<code>ntpd(8)</code> 6102b15cb3dSCy Schubertconfiguration file. 6112b15cb3dSCy Schubert<kbd>filename</kbd> 6122b15cb3dSCy Schubertcan use 613*09100258SXin LI<code>date(1)</code> 614*09100258SXin LIformat specifiers to substitute the current date and time, for 615*09100258SXin LIexample, 616*09100258SXin LI <pre class="example"> <code>saveconfig</code> <span class="file">ntp-%Y%m%d-%H%M%S.conf</span>. 617*09100258SXin LI </pre> 618*09100258SXin LI <p>The filename used is stored in system variable 6192b15cb3dSCy Schubert<code>savedconfig</code>. 6202b15cb3dSCy SchubertAuthentication is required. 621*09100258SXin LI<br><dt><code>sysinfo</code><dd>Display system operational summary: 622*09100258SXin LIassocid, status, system peer, system peer mode, leap indicator, 623*09100258SXin LIstratum, log2 precision, root delay, root dispersion, 624*09100258SXin LIreference id, reference time, system jitter, clock jitter, 625*09100258SXin LIclock wander, broadcast delay, symm. auth. delay. 626*09100258SXin LI<br><dt><code>sysstats</code><dd>Display system uptime and packet counts maintained in the 627*09100258SXin LIprotocol module: 628*09100258SXin LIuptime, sysstats reset, packets received, current version, 629*09100258SXin LIolder version, bad length or format, authentication failed, 630*09100258SXin LIdeclined, restricted, rate limited, KoD responses, 631*09100258SXin LIprocessed for time. 632*09100258SXin LI<br><dt><code>timerstats</code><dd>Display interval timer counters: 633*09100258SXin LItime since reset, timer overruns, calls to transmit. 634*09100258SXin LI<br><dt><code>writelist</code> <kbd>associd</kbd><dd>Set all system or peer variables included in the variable list. 635*09100258SXin LI<br><dt><code>writevar</code> <kbd>associd</kbd> <kbd>name</kbd>=<kbd>value</kbd> <code>[, ...]</code><dd>Set the specified variables in the variable list. 6362b15cb3dSCy SchubertIf the 637*09100258SXin LI<kbd>associd</kbd> 6382b15cb3dSCy Schubertis zero, the variables are from the 6392b15cb3dSCy Schubert<a href="#System-Variables">System Variables</a> 6402b15cb3dSCy Schubertname space, otherwise they are from the 6412b15cb3dSCy Schubert<a href="#Peer-Variables">Peer Variables</a> 6422b15cb3dSCy Schubertname space. 6432b15cb3dSCy SchubertThe 644*09100258SXin LI<kbd>associd</kbd> 6452b15cb3dSCy Schubertis required, as the same name can occur in both spaces. 646*09100258SXin LIAuthentication is required. 6472b15cb3dSCy Schubert</dl> 6482b15cb3dSCy Schubert 6492b15cb3dSCy Schubert<h5 class="subsubsection">Status Words and Kiss Codes</h5> 6502b15cb3dSCy Schubert 6512b15cb3dSCy Schubert<p>The current state of the operating program is shown 6522b15cb3dSCy Schubertin a set of status words 6532b15cb3dSCy Schubertmaintained by the system. 6542b15cb3dSCy SchubertStatus information is also available on a per-association basis. 655*09100258SXin LIThese words are displayed by the 656*09100258SXin LI<code>readlist</code> 6572b15cb3dSCy Schubertand 658*09100258SXin LI<code>associations</code> 6592b15cb3dSCy Schubertcommands both in hexadecimal and in decoded short tip strings. 6602b15cb3dSCy SchubertThe codes, tips and short explanations are documented on the 6612b15cb3dSCy Schubert.Lk decode.html "Event Messages and Status Words" 6622b15cb3dSCy Schubertpage. 6632b15cb3dSCy SchubertThe page also includes a list of system and peer messages, 6642b15cb3dSCy Schubertthe code for the latest of which is included in the status word. 6652b15cb3dSCy Schubert 6662b15cb3dSCy Schubert <p>Information resulting from protocol machine state transitions 6672b15cb3dSCy Schubertis displayed using an informal set of ASCII strings called 6682b15cb3dSCy Schubert.Lk decode.html#kiss "kiss codes" . 6692b15cb3dSCy SchubertThe original purpose was for kiss-o'-death (KoD) packets 6702b15cb3dSCy Schubertsent by the server to advise the client of an unusual condition. 6712b15cb3dSCy SchubertThey are now displayed, when appropriate, 6722b15cb3dSCy Schubertin the reference identifier field in various billboards. 6732b15cb3dSCy Schubert 6742b15cb3dSCy Schubert<h5 class="subsubsection">System Variables</h5> 6752b15cb3dSCy Schubert 6762b15cb3dSCy Schubert<p>The following system variables appear in the 677*09100258SXin LI<code>readlist</code> 6782b15cb3dSCy Schubertbillboard. 6792b15cb3dSCy SchubertNot all variables are displayed in some configurations. 680*09100258SXin LI 6812b15cb3dSCy Schubert <dl> 6822b15cb3dSCy Schubert<dt>Variable<dd>Description 6832b15cb3dSCy Schubert<br><dt><code>status</code><dd>.Lk decode.html#sys "system status word" 6842b15cb3dSCy Schubert<br><dt><code>version</code><dd>NTP software version and build time 6852b15cb3dSCy Schubert<br><dt><code>processor</code><dd>hardware platform and version 6862b15cb3dSCy Schubert<br><dt><code>system</code><dd>operating system and version 6872b15cb3dSCy Schubert<br><dt><code>leap</code><dd>leap warning indicator (0-3) 6882b15cb3dSCy Schubert<br><dt><code>stratum</code><dd>stratum (1-15) 6892b15cb3dSCy Schubert<br><dt><code>precision</code><dd>precision (log2 s) 6902b15cb3dSCy Schubert<br><dt><code>rootdelay</code><dd>total roundtrip delay to the primary reference clock 6912b15cb3dSCy Schubert<br><dt><code>rootdisp</code><dd>total dispersion to the primary reference clock 692*09100258SXin LI<br><dt><code>refid</code><dd>reference id or 6932b15cb3dSCy Schubert.Lk decode.html#kiss "kiss code" 6942b15cb3dSCy Schubert<br><dt><code>reftime</code><dd>reference time 695*09100258SXin LI<br><dt><code>clock</code><dd>date and time of day 696*09100258SXin LI<br><dt><code>peer</code><dd>system peer association id 697*09100258SXin LI<br><dt><code>tc</code><dd>time constant and poll exponent (log2 s) (3-17) 698*09100258SXin LI<br><dt><code>mintc</code><dd>minimum time constant (log2 s) (3-10) 6992b15cb3dSCy Schubert<br><dt><code>offset</code><dd>combined offset of server relative to this host 700*09100258SXin LI<br><dt><code>frequency</code><dd>frequency drift (PPM) relative to hardware clock 7012b15cb3dSCy Schubert<br><dt><code>sys_jitter</code><dd>combined system jitter 7022b15cb3dSCy Schubert<br><dt><code>clk_wander</code><dd>clock frequency wander (PPM) 7032b15cb3dSCy Schubert<br><dt><code>clk_jitter</code><dd>clock jitter 7042b15cb3dSCy Schubert<br><dt><code>tai</code><dd>TAI-UTC offset (s) 7052b15cb3dSCy Schubert<br><dt><code>leapsec</code><dd>NTP seconds when the next leap second is/was inserted 7062b15cb3dSCy Schubert<br><dt><code>expire</code><dd>NTP seconds when the NIST leapseconds file expires 7072b15cb3dSCy Schubert</dl> 7082b15cb3dSCy Schubert The jitter and wander statistics are exponentially-weighted RMS averages. 7092b15cb3dSCy SchubertThe system jitter is defined in the NTPv4 specification; 7102b15cb3dSCy Schubertthe clock jitter statistic is computed by the clock discipline module. 7112b15cb3dSCy Schubert 7122b15cb3dSCy Schubert <p>When the NTPv4 daemon is compiled with the OpenSSL software library, 7132b15cb3dSCy Schubertadditional system variables are displayed, 7142b15cb3dSCy Schubertincluding some or all of the following, 7152b15cb3dSCy Schubertdepending on the particular Autokey dance: 7162b15cb3dSCy Schubert <dl> 7172b15cb3dSCy Schubert<dt>Variable<dd>Description 7182b15cb3dSCy Schubert<br><dt><code>host</code><dd>Autokey host name for this host 7192b15cb3dSCy Schubert<br><dt><code>ident</code><dd>Autokey group name for this host 7202b15cb3dSCy Schubert<br><dt><code>flags</code><dd>host flags (see Autokey specification) 7212b15cb3dSCy Schubert<br><dt><code>digest</code><dd>OpenSSL message digest algorithm 7222b15cb3dSCy Schubert<br><dt><code>signature</code><dd>OpenSSL digest/signature scheme 7232b15cb3dSCy Schubert<br><dt><code>update</code><dd>NTP seconds at last signature update 7242b15cb3dSCy Schubert<br><dt><code>cert</code><dd>certificate subject, issuer and certificate flags 7252b15cb3dSCy Schubert<br><dt><code>until</code><dd>NTP seconds when the certificate expires 7262b15cb3dSCy Schubert</dl> 7272b15cb3dSCy Schubert 7282b15cb3dSCy Schubert<h5 class="subsubsection">Peer Variables</h5> 7292b15cb3dSCy Schubert 7302b15cb3dSCy Schubert<p>The following peer variables appear in the 731*09100258SXin LI<code>readlist</code> 7322b15cb3dSCy Schubertbillboard for each association. 7332b15cb3dSCy SchubertNot all variables are displayed in some configurations. 7342b15cb3dSCy Schubert 7352b15cb3dSCy Schubert <dl> 7362b15cb3dSCy Schubert<dt>Variable<dd>Description 737*09100258SXin LI<br><dt><code>associd</code><dd>association id 7382b15cb3dSCy Schubert<br><dt><code>status</code><dd>.Lk decode.html#peer "peer status word" 7392b15cb3dSCy Schubert<br><dt><code>srcadr</code><dd>source (remote) IP address 7402b15cb3dSCy Schubert<br><dt><code>srcport</code><dd>source (remote) port 7412b15cb3dSCy Schubert<br><dt><code>dstadr</code><dd>destination (local) IP address 7422b15cb3dSCy Schubert<br><dt><code>dstport</code><dd>destination (local) port 7432b15cb3dSCy Schubert<br><dt><code>leap</code><dd>leap indicator (0-3) 7442b15cb3dSCy Schubert<br><dt><code>stratum</code><dd>stratum (0-15) 7452b15cb3dSCy Schubert<br><dt><code>precision</code><dd>precision (log2 s) 7462b15cb3dSCy Schubert<br><dt><code>rootdelay</code><dd>total roundtrip delay to the primary reference clock 7472b15cb3dSCy Schubert<br><dt><code>rootdisp</code><dd>total root dispersion to the primary reference clock 748*09100258SXin LI<br><dt><code>refid</code><dd>reference id or 7492b15cb3dSCy Schubert.Lk decode.html#kiss "kiss code" 7502b15cb3dSCy Schubert<br><dt><code>reftime</code><dd>reference time 751*09100258SXin LI<br><dt><code>rec</code><dd>last packet received time 7522b15cb3dSCy Schubert<br><dt><code>reach</code><dd>reach register (octal) 7532b15cb3dSCy Schubert<br><dt><code>unreach</code><dd>unreach counter 7542b15cb3dSCy Schubert<br><dt><code>hmode</code><dd>host mode (1-6) 7552b15cb3dSCy Schubert<br><dt><code>pmode</code><dd>peer mode (1-5) 7562b15cb3dSCy Schubert<br><dt><code>hpoll</code><dd>host poll exponent (log2 s) (3-17) 7572b15cb3dSCy Schubert<br><dt><code>ppoll</code><dd>peer poll exponent (log2 s) (3-17) 7582b15cb3dSCy Schubert<br><dt><code>headway</code><dd>headway (see 7592b15cb3dSCy Schubert.Lk rate.html "Rate Management and the Kiss-o'-Death Packet" ) 7602b15cb3dSCy Schubert<br><dt><code>flash</code><dd>.Lk decode.html#flash "flash status word" 761*09100258SXin LI<br><dt><code>keyid</code><dd>symmetric key id 7622b15cb3dSCy Schubert<br><dt><code>offset</code><dd>filter offset 7632b15cb3dSCy Schubert<br><dt><code>delay</code><dd>filter delay 7642b15cb3dSCy Schubert<br><dt><code>dispersion</code><dd>filter dispersion 7652b15cb3dSCy Schubert<br><dt><code>jitter</code><dd>filter jitter 7662b15cb3dSCy Schubert<br><dt><code>bias</code><dd>unicast/broadcast bias 7672b15cb3dSCy Schubert<br><dt><code>xleave</code><dd>interleave delay (see 7682b15cb3dSCy Schubert.Lk xleave.html "NTP Interleaved Modes" ) 7692b15cb3dSCy Schubert</dl> 7702b15cb3dSCy Schubert The 7712b15cb3dSCy Schubert<code>bias</code> 7722b15cb3dSCy Schubertvariable is calculated when the first broadcast packet is received 7732b15cb3dSCy Schubertafter the calibration volley. 774*09100258SXin LIIt represents the offset of the broadcast subgraph relative to the 775*09100258SXin LIunicast subgraph. 7762b15cb3dSCy SchubertThe 7772b15cb3dSCy Schubert<code>xleave</code> 7782b15cb3dSCy Schubertvariable appears only for the interleaved symmetric and interleaved modes. 7792b15cb3dSCy SchubertIt represents the internal queuing, buffering and transmission delays 7802b15cb3dSCy Schubertfor the preceding packet. 7812b15cb3dSCy Schubert 7822b15cb3dSCy Schubert <p>When the NTPv4 daemon is compiled with the OpenSSL software library, 7832b15cb3dSCy Schubertadditional peer variables are displayed, including the following: 7842b15cb3dSCy Schubert <dl> 7852b15cb3dSCy Schubert<dt>Variable<dd>Description 7862b15cb3dSCy Schubert<br><dt><code>flags</code><dd>peer flags (see Autokey specification) 7872b15cb3dSCy Schubert<br><dt><code>host</code><dd>Autokey server name 7882b15cb3dSCy Schubert<br><dt><code>flags</code><dd>peer flags (see Autokey specification) 7892b15cb3dSCy Schubert<br><dt><code>signature</code><dd>OpenSSL digest/signature scheme 790*09100258SXin LI<br><dt><code>initsequence</code><dd>initial key id 7912b15cb3dSCy Schubert<br><dt><code>initkey</code><dd>initial key index 7922b15cb3dSCy Schubert<br><dt><code>timestamp</code><dd>Autokey signature timestamp 793*09100258SXin LI<br><dt><code>ident</code><dd>Autokey group name for this association 7942b15cb3dSCy Schubert</dl> 7952b15cb3dSCy Schubert 7962b15cb3dSCy Schubert<h5 class="subsubsection">Clock Variables</h5> 7972b15cb3dSCy Schubert 7982b15cb3dSCy Schubert<p>The following clock variables appear in the 799*09100258SXin LI<code>clocklist</code> 8002b15cb3dSCy Schubertbillboard for each association with a reference clock. 8012b15cb3dSCy SchubertNot all variables are displayed in some configurations. 8022b15cb3dSCy Schubert <dl> 8032b15cb3dSCy Schubert<dt>Variable<dd>Description 804*09100258SXin LI<br><dt><code>associd</code><dd>association id 8052b15cb3dSCy Schubert<br><dt><code>status</code><dd>.Lk decode.html#clock "clock status word" 8062b15cb3dSCy Schubert<br><dt><code>device</code><dd>device description 8072b15cb3dSCy Schubert<br><dt><code>timecode</code><dd>ASCII time code string (specific to device) 8082b15cb3dSCy Schubert<br><dt><code>poll</code><dd>poll messages sent 8092b15cb3dSCy Schubert<br><dt><code>noreply</code><dd>no reply 8102b15cb3dSCy Schubert<br><dt><code>badformat</code><dd>bad format 8112b15cb3dSCy Schubert<br><dt><code>baddata</code><dd>bad date or time 8122b15cb3dSCy Schubert<br><dt><code>fudgetime1</code><dd>fudge time 1 8132b15cb3dSCy Schubert<br><dt><code>fudgetime2</code><dd>fudge time 2 8142b15cb3dSCy Schubert<br><dt><code>stratum</code><dd>driver stratum 815*09100258SXin LI<br><dt><code>refid</code><dd>driver reference id 8162b15cb3dSCy Schubert<br><dt><code>flags</code><dd>driver flags 8172b15cb3dSCy Schubert</dl> 8182b15cb3dSCy Schubert 8192b15cb3dSCy Schubert <p>This section was generated by <strong>AutoGen</strong>, 8202b15cb3dSCy Schubertusing the <code>agtexi-cmd</code> template and the option descriptions for the <code>ntpq</code> program. 8212b15cb3dSCy SchubertThis software is released under the NTP license, <http://ntp.org/license>. 8222b15cb3dSCy Schubert 8232b15cb3dSCy Schubert<ul class="menu"> 8242b15cb3dSCy Schubert<li><a accesskey="1" href="#ntpq-usage">ntpq usage</a>: ntpq help/usage (<span class="option">--help</span>) 8252b15cb3dSCy Schubert<li><a accesskey="2" href="#ntpq-ipv4">ntpq ipv4</a>: ipv4 option (-4) 8262b15cb3dSCy Schubert<li><a accesskey="3" href="#ntpq-ipv6">ntpq ipv6</a>: ipv6 option (-6) 8272b15cb3dSCy Schubert<li><a accesskey="4" href="#ntpq-command">ntpq command</a>: command option (-c) 8282b15cb3dSCy Schubert<li><a accesskey="5" href="#ntpq-interactive">ntpq interactive</a>: interactive option (-i) 8292b15cb3dSCy Schubert<li><a accesskey="6" href="#ntpq-numeric">ntpq numeric</a>: numeric option (-n) 8302b15cb3dSCy Schubert<li><a accesskey="7" href="#ntpq-old_002drv">ntpq old-rv</a>: old-rv option 8312b15cb3dSCy Schubert<li><a accesskey="8" href="#ntpq-peers">ntpq peers</a>: peers option (-p) 8324990d495SXin LI<li><a accesskey="9" href="#ntpq-refid">ntpq refid</a>: refid option (-r) 8334990d495SXin LI<li><a href="#ntpq-wide">ntpq wide</a>: wide option (-w) 8342b15cb3dSCy Schubert<li><a href="#ntpq-config">ntpq config</a>: presetting/configuring ntpq 8352b15cb3dSCy Schubert<li><a href="#ntpq-exit-status">ntpq exit status</a>: exit status 8362b15cb3dSCy Schubert</ul> 8372b15cb3dSCy Schubert 8382b15cb3dSCy Schubert<div class="node"> 8392b15cb3dSCy Schubert<p><hr> 8402b15cb3dSCy Schubert<a name="ntpq-usage"></a>Next: <a rel="next" accesskey="n" href="#ntpq-ipv4">ntpq ipv4</a>, 8412b15cb3dSCy SchubertUp: <a rel="up" accesskey="u" href="#ntpq-Invocation">ntpq Invocation</a> 8422b15cb3dSCy Schubert<br> 8432b15cb3dSCy Schubert</div> 8442b15cb3dSCy Schubert 8452b15cb3dSCy Schubert<h4 class="subsection">ntpq help/usage (<span class="option">--help</span>)</h4> 8462b15cb3dSCy Schubert 8472b15cb3dSCy Schubert<p><a name="index-ntpq-help-3"></a> 8482b15cb3dSCy SchubertThis is the automatically generated usage text for ntpq. 8492b15cb3dSCy Schubert 8502b15cb3dSCy Schubert <p>The text printed is the same whether selected with the <code>help</code> option 8512b15cb3dSCy Schubert(<span class="option">--help</span>) or the <code>more-help</code> option (<span class="option">--more-help</span>). <code>more-help</code> will print 8522b15cb3dSCy Schubertthe usage text by passing it through a pager program. 8532b15cb3dSCy Schubert<code>more-help</code> is disabled on platforms without a working 8542b15cb3dSCy Schubert<code>fork(2)</code> function. The <code>PAGER</code> environment variable is 8552b15cb3dSCy Schubertused to select the program, defaulting to <span class="file">more</span>. Both will exit 8562b15cb3dSCy Schubertwith a status code of 0. 8572b15cb3dSCy Schubert 858*09100258SXin LI<pre class="example">ntpq - standard NTP query program - Ver. 4.2.8p10 8592b15cb3dSCy SchubertUsage: ntpq [ -<flag> [<val>] | --<name>[{=| }<val>] ]... [ host ...] 8602b15cb3dSCy Schubert Flg Arg Option-Name Description 861*09100258SXin LI -4 no ipv4 Force IPv4 name resolution 8622b15cb3dSCy Schubert - prohibits the option 'ipv6' 863*09100258SXin LI -6 no ipv6 Force IPv6 name resolution 8642b15cb3dSCy Schubert - prohibits the option 'ipv4' 8652b15cb3dSCy Schubert -c Str command run a command and exit 8662b15cb3dSCy Schubert - may appear multiple times 8672b15cb3dSCy Schubert -d no debug-level Increase debug verbosity level 8682b15cb3dSCy Schubert - may appear multiple times 8692b15cb3dSCy Schubert -D Num set-debug-level Set the debug verbosity level 8702b15cb3dSCy Schubert - may appear multiple times 8712b15cb3dSCy Schubert -i no interactive Force ntpq to operate in interactive mode 8722b15cb3dSCy Schubert - prohibits these options: 8732b15cb3dSCy Schubert command 8742b15cb3dSCy Schubert peers 8752b15cb3dSCy Schubert -n no numeric numeric host addresses 8762b15cb3dSCy Schubert no old-rv Always output status line with readvar 8772b15cb3dSCy Schubert -p no peers Print a list of the peers 8782b15cb3dSCy Schubert - prohibits the option 'interactive' 8794990d495SXin LI -r KWd refid Set default display type for S2+ refids 8802b15cb3dSCy Schubert -w no wide Display the full 'remote' value 8812b15cb3dSCy Schubert opt version output version information and exit 8822b15cb3dSCy Schubert -? no help display extended usage information and exit 8832b15cb3dSCy Schubert -! no more-help extended usage information passed thru pager 8842b15cb3dSCy Schubert -> opt save-opts save the option state to a config file 8852b15cb3dSCy Schubert -< Str load-opts load options from a config file 8862b15cb3dSCy Schubert - disabled as '--no-load-opts' 8872b15cb3dSCy Schubert - may appear multiple times 8882b15cb3dSCy Schubert 8892b15cb3dSCy SchubertOptions are specified by doubled hyphens and their name or by a single 8902b15cb3dSCy Schuberthyphen and the flag character. 8912b15cb3dSCy Schubert 8922b15cb3dSCy SchubertThe following option preset mechanisms are supported: 8932b15cb3dSCy Schubert - reading file $HOME/.ntprc 8942b15cb3dSCy Schubert - reading file ./.ntprc 8952b15cb3dSCy Schubert - examining environment variables named NTPQ_* 8962b15cb3dSCy Schubert 8974990d495SXin LIThe valid "refid" option keywords are: 8984990d495SXin LI hash ipv4 8994990d495SXin LI or an integer from 0 through 1 9004990d495SXin LI 9012b15cb3dSCy SchubertPlease send bug reports to: <http://bugs.ntp.org, bugs@ntp.org> 9022b15cb3dSCy Schubert</pre> 9032b15cb3dSCy Schubert <div class="node"> 9042b15cb3dSCy Schubert<p><hr> 9052b15cb3dSCy Schubert<a name="ntpq-ipv4"></a>Next: <a rel="next" accesskey="n" href="#ntpq-ipv6">ntpq ipv6</a>, 9062b15cb3dSCy SchubertPrevious: <a rel="previous" accesskey="p" href="#ntpq-usage">ntpq usage</a>, 9072b15cb3dSCy SchubertUp: <a rel="up" accesskey="u" href="#ntpq-Invocation">ntpq Invocation</a> 9082b15cb3dSCy Schubert<br> 9092b15cb3dSCy Schubert</div> 9102b15cb3dSCy Schubert 9112b15cb3dSCy Schubert<h4 class="subsection">ipv4 option (-4)</h4> 9122b15cb3dSCy Schubert 9132b15cb3dSCy Schubert<p><a name="index-ntpq_002dipv4-4"></a> 914*09100258SXin LIThis is the “force ipv4 name resolution” option. 9152b15cb3dSCy Schubert 9162b15cb3dSCy Schubert<p class="noindent">This option has some usage constraints. It: 9172b15cb3dSCy Schubert <ul> 9182b15cb3dSCy Schubert<li>must not appear in combination with any of the following options: 9192b15cb3dSCy Schubertipv6. 9202b15cb3dSCy Schubert</ul> 9212b15cb3dSCy Schubert 922*09100258SXin LI <p>Force resolution of following host names on the command line 9232b15cb3dSCy Schubertto the IPv4 namespace. 9242b15cb3dSCy Schubert<div class="node"> 9252b15cb3dSCy Schubert<p><hr> 9262b15cb3dSCy Schubert<a name="ntpq-ipv6"></a>Next: <a rel="next" accesskey="n" href="#ntpq-command">ntpq command</a>, 9272b15cb3dSCy SchubertPrevious: <a rel="previous" accesskey="p" href="#ntpq-ipv4">ntpq ipv4</a>, 9282b15cb3dSCy SchubertUp: <a rel="up" accesskey="u" href="#ntpq-Invocation">ntpq Invocation</a> 9292b15cb3dSCy Schubert<br> 9302b15cb3dSCy Schubert</div> 9312b15cb3dSCy Schubert 9322b15cb3dSCy Schubert<h4 class="subsection">ipv6 option (-6)</h4> 9332b15cb3dSCy Schubert 9342b15cb3dSCy Schubert<p><a name="index-ntpq_002dipv6-5"></a> 935*09100258SXin LIThis is the “force ipv6 name resolution” option. 9362b15cb3dSCy Schubert 9372b15cb3dSCy Schubert<p class="noindent">This option has some usage constraints. It: 9382b15cb3dSCy Schubert <ul> 9392b15cb3dSCy Schubert<li>must not appear in combination with any of the following options: 9402b15cb3dSCy Schubertipv4. 9412b15cb3dSCy Schubert</ul> 9422b15cb3dSCy Schubert 943*09100258SXin LI <p>Force resolution of following host names on the command line 9442b15cb3dSCy Schubertto the IPv6 namespace. 9452b15cb3dSCy Schubert<div class="node"> 9462b15cb3dSCy Schubert<p><hr> 9472b15cb3dSCy Schubert<a name="ntpq-command"></a>Next: <a rel="next" accesskey="n" href="#ntpq-interactive">ntpq interactive</a>, 9482b15cb3dSCy SchubertPrevious: <a rel="previous" accesskey="p" href="#ntpq-ipv6">ntpq ipv6</a>, 9492b15cb3dSCy SchubertUp: <a rel="up" accesskey="u" href="#ntpq-Invocation">ntpq Invocation</a> 9502b15cb3dSCy Schubert<br> 9512b15cb3dSCy Schubert</div> 9522b15cb3dSCy Schubert 9532b15cb3dSCy Schubert<h4 class="subsection">command option (-c)</h4> 9542b15cb3dSCy Schubert 9552b15cb3dSCy Schubert<p><a name="index-ntpq_002dcommand-6"></a> 9562b15cb3dSCy SchubertThis is the “run a command and exit” option. 9572b15cb3dSCy SchubertThis option takes a string argument <span class="file">cmd</span>. 9582b15cb3dSCy Schubert 9592b15cb3dSCy Schubert<p class="noindent">This option has some usage constraints. It: 9602b15cb3dSCy Schubert <ul> 9612b15cb3dSCy Schubert<li>may appear an unlimited number of times. 9622b15cb3dSCy Schubert</ul> 9632b15cb3dSCy Schubert 9642b15cb3dSCy Schubert <p>The following argument is interpreted as an interactive format command 9652b15cb3dSCy Schubertand is added to the list of commands to be executed on the specified 9662b15cb3dSCy Schuberthost(s). 9672b15cb3dSCy Schubert<div class="node"> 9682b15cb3dSCy Schubert<p><hr> 9692b15cb3dSCy Schubert<a name="ntpq-interactive"></a>Next: <a rel="next" accesskey="n" href="#ntpq-numeric">ntpq numeric</a>, 9702b15cb3dSCy SchubertPrevious: <a rel="previous" accesskey="p" href="#ntpq-command">ntpq command</a>, 9712b15cb3dSCy SchubertUp: <a rel="up" accesskey="u" href="#ntpq-Invocation">ntpq Invocation</a> 9722b15cb3dSCy Schubert<br> 9732b15cb3dSCy Schubert</div> 9742b15cb3dSCy Schubert 9752b15cb3dSCy Schubert<h4 class="subsection">interactive option (-i)</h4> 9762b15cb3dSCy Schubert 9772b15cb3dSCy Schubert<p><a name="index-ntpq_002dinteractive-7"></a> 9782b15cb3dSCy SchubertThis is the “force ntpq to operate in interactive mode” option. 9792b15cb3dSCy Schubert 9802b15cb3dSCy Schubert<p class="noindent">This option has some usage constraints. It: 9812b15cb3dSCy Schubert <ul> 9822b15cb3dSCy Schubert<li>must not appear in combination with any of the following options: 9832b15cb3dSCy Schubertcommand, peers. 9842b15cb3dSCy Schubert</ul> 9852b15cb3dSCy Schubert 9862b15cb3dSCy Schubert <p>Force <code>ntpq</code> to operate in interactive mode. 9872b15cb3dSCy SchubertPrompts will be written to the standard output and 9882b15cb3dSCy Schubertcommands read from the standard input. 9892b15cb3dSCy Schubert<div class="node"> 9902b15cb3dSCy Schubert<p><hr> 9912b15cb3dSCy Schubert<a name="ntpq-numeric"></a>Next: <a rel="next" accesskey="n" href="#ntpq-old_002drv">ntpq old-rv</a>, 9922b15cb3dSCy SchubertPrevious: <a rel="previous" accesskey="p" href="#ntpq-interactive">ntpq interactive</a>, 9932b15cb3dSCy SchubertUp: <a rel="up" accesskey="u" href="#ntpq-Invocation">ntpq Invocation</a> 9942b15cb3dSCy Schubert<br> 9952b15cb3dSCy Schubert</div> 9962b15cb3dSCy Schubert 9972b15cb3dSCy Schubert<h4 class="subsection">numeric option (-n)</h4> 9982b15cb3dSCy Schubert 9992b15cb3dSCy Schubert<p><a name="index-ntpq_002dnumeric-8"></a> 10002b15cb3dSCy SchubertThis is the “numeric host addresses” option. 10012b15cb3dSCy SchubertOutput all host addresses in dotted-quad numeric format rather than 10022b15cb3dSCy Schubertconverting to the canonical host names. 10032b15cb3dSCy Schubert<div class="node"> 10042b15cb3dSCy Schubert<p><hr> 10052b15cb3dSCy Schubert<a name="ntpq-old_002drv"></a>Next: <a rel="next" accesskey="n" href="#ntpq-peers">ntpq peers</a>, 10062b15cb3dSCy SchubertPrevious: <a rel="previous" accesskey="p" href="#ntpq-numeric">ntpq numeric</a>, 10072b15cb3dSCy SchubertUp: <a rel="up" accesskey="u" href="#ntpq-Invocation">ntpq Invocation</a> 10082b15cb3dSCy Schubert<br> 10092b15cb3dSCy Schubert</div> 10102b15cb3dSCy Schubert 10112b15cb3dSCy Schubert<h4 class="subsection">old-rv option</h4> 10122b15cb3dSCy Schubert 10132b15cb3dSCy Schubert<p><a name="index-ntpq_002dold_002drv-9"></a> 10142b15cb3dSCy SchubertThis is the “always output status line with readvar” option. 10152b15cb3dSCy SchubertBy default, <code>ntpq</code> now suppresses the <code>associd=...</code> 10162b15cb3dSCy Schubertline that precedes the output of <code>readvar</code> 10172b15cb3dSCy Schubert(alias <code>rv</code>) when a single variable is requested, such as 10182b15cb3dSCy Schubert<code>ntpq -c "rv 0 offset"</code>. 10192b15cb3dSCy SchubertThis option causes <code>ntpq</code> to include both lines of output 10202b15cb3dSCy Schubertfor a single-variable <code>readvar</code>. 10212b15cb3dSCy SchubertUsing an environment variable to 10222b15cb3dSCy Schubertpreset this option in a script will enable both older and 10232b15cb3dSCy Schubertnewer <code>ntpq</code> to behave identically in this regard. 10242b15cb3dSCy Schubert<div class="node"> 10252b15cb3dSCy Schubert<p><hr> 10264990d495SXin LI<a name="ntpq-peers"></a>Next: <a rel="next" accesskey="n" href="#ntpq-refid">ntpq refid</a>, 10272b15cb3dSCy SchubertPrevious: <a rel="previous" accesskey="p" href="#ntpq-old_002drv">ntpq old-rv</a>, 10282b15cb3dSCy SchubertUp: <a rel="up" accesskey="u" href="#ntpq-Invocation">ntpq Invocation</a> 10292b15cb3dSCy Schubert<br> 10302b15cb3dSCy Schubert</div> 10312b15cb3dSCy Schubert 10322b15cb3dSCy Schubert<h4 class="subsection">peers option (-p)</h4> 10332b15cb3dSCy Schubert 10342b15cb3dSCy Schubert<p><a name="index-ntpq_002dpeers-10"></a> 10352b15cb3dSCy SchubertThis is the “print a list of the peers” option. 10362b15cb3dSCy Schubert 10372b15cb3dSCy Schubert<p class="noindent">This option has some usage constraints. It: 10382b15cb3dSCy Schubert <ul> 10392b15cb3dSCy Schubert<li>must not appear in combination with any of the following options: 10402b15cb3dSCy Schubertinteractive. 10412b15cb3dSCy Schubert</ul> 10422b15cb3dSCy Schubert 10432b15cb3dSCy Schubert <p>Print a list of the peers known to the server as well as a summary 10442b15cb3dSCy Schubertof their state. This is equivalent to the 'peers' interactive command. 10452b15cb3dSCy Schubert<div class="node"> 10462b15cb3dSCy Schubert<p><hr> 10474990d495SXin LI<a name="ntpq-refid"></a>Next: <a rel="next" accesskey="n" href="#ntpq-wide">ntpq wide</a>, 10482b15cb3dSCy SchubertPrevious: <a rel="previous" accesskey="p" href="#ntpq-peers">ntpq peers</a>, 10492b15cb3dSCy SchubertUp: <a rel="up" accesskey="u" href="#ntpq-Invocation">ntpq Invocation</a> 10502b15cb3dSCy Schubert<br> 10512b15cb3dSCy Schubert</div> 10522b15cb3dSCy Schubert 10534990d495SXin LI<h4 class="subsection">refid option (-r)</h4> 10544990d495SXin LI 10554990d495SXin LI<p><a name="index-ntpq_002drefid-11"></a> 10564990d495SXin LIThis is the “set default display type for s2+ refids” option. 10574990d495SXin LIThis option takes a keyword argument. 10584990d495SXin LI 10594990d495SXin LI<p class="noindent">This option has some usage constraints. It: 10604990d495SXin LI <ul> 10614990d495SXin LI<li>This option takes a keyword as its argument. 10624990d495SXin LIThe argument sets an enumeration value that can be tested by comparing the option value macro (OPT_VALUE_REFID). 10634990d495SXin LIThe available keywords are: 10644990d495SXin LI <pre class="example"> hash ipv4 10654990d495SXin LI </pre> 10664990d495SXin LI <p>or their numeric equivalent.</ul> 10674990d495SXin LI 10684990d495SXin LI <p>Set the default display format for S2+ refids. 10694990d495SXin LI<div class="node"> 10704990d495SXin LI<p><hr> 10714990d495SXin LI<a name="ntpq-wide"></a>Next: <a rel="next" accesskey="n" href="#ntpq-config">ntpq config</a>, 10724990d495SXin LIPrevious: <a rel="previous" accesskey="p" href="#ntpq-refid">ntpq refid</a>, 10734990d495SXin LIUp: <a rel="up" accesskey="u" href="#ntpq-Invocation">ntpq Invocation</a> 10744990d495SXin LI<br> 10754990d495SXin LI</div> 10764990d495SXin LI 10772b15cb3dSCy Schubert<h4 class="subsection">wide option (-w)</h4> 10782b15cb3dSCy Schubert 10794990d495SXin LI<p><a name="index-ntpq_002dwide-12"></a> 10802b15cb3dSCy SchubertThis is the “display the full 'remote' value” option. 10812b15cb3dSCy SchubertDisplay the full value of the 'remote' value. If this requires 10822b15cb3dSCy Schubertmore than 15 characters, display the full value, emit a newline, 10832b15cb3dSCy Schubertand continue the data display properly indented on the next line. 10842b15cb3dSCy Schubert 10852b15cb3dSCy Schubert<div class="node"> 10862b15cb3dSCy Schubert<p><hr> 10872b15cb3dSCy Schubert<a name="ntpq-config"></a>Next: <a rel="next" accesskey="n" href="#ntpq-exit-status">ntpq exit status</a>, 10882b15cb3dSCy SchubertPrevious: <a rel="previous" accesskey="p" href="#ntpq-wide">ntpq wide</a>, 10892b15cb3dSCy SchubertUp: <a rel="up" accesskey="u" href="#ntpq-Invocation">ntpq Invocation</a> 10902b15cb3dSCy Schubert<br> 10912b15cb3dSCy Schubert</div> 10922b15cb3dSCy Schubert 10932b15cb3dSCy Schubert<h4 class="subsection">presetting/configuring ntpq</h4> 10942b15cb3dSCy Schubert 10952b15cb3dSCy Schubert<p>Any option that is not marked as <i>not presettable</i> may be preset by 10962b15cb3dSCy Schubertloading values from configuration ("rc" or "ini") files, and values from environment variables named <code>NTPQ</code> and <code>NTPQ_<OPTION_NAME></code>. <code><OPTION_NAME></code> must be one of 10972b15cb3dSCy Schubertthe options listed above in upper case and segmented with underscores. 10982b15cb3dSCy SchubertThe <code>NTPQ</code> variable will be tokenized and parsed like 10992b15cb3dSCy Schubertthe command line. The remaining variables are tested for existence and their 11002b15cb3dSCy Schubertvalues are treated like option arguments. 11012b15cb3dSCy Schubert 11022b15cb3dSCy Schubert<p class="noindent"><code>libopts</code> will search in 2 places for configuration files: 11032b15cb3dSCy Schubert <ul> 11042b15cb3dSCy Schubert<li>$HOME 11052b15cb3dSCy Schubert<li>$PWD 11062b15cb3dSCy Schubert</ul> 11072b15cb3dSCy Schubert The environment variables <code>HOME</code>, and <code>PWD</code> 11082b15cb3dSCy Schubertare expanded and replaced when <span class="file">ntpq</span> runs. 11092b15cb3dSCy SchubertFor any of these that are plain files, they are simply processed. 11102b15cb3dSCy SchubertFor any that are directories, then a file named <span class="file">.ntprc</span> is searched for 11112b15cb3dSCy Schubertwithin that directory and processed. 11122b15cb3dSCy Schubert 11132b15cb3dSCy Schubert <p>Configuration files may be in a wide variety of formats. 11142b15cb3dSCy SchubertThe basic format is an option name followed by a value (argument) on the 11152b15cb3dSCy Schubertsame line. Values may be separated from the option name with a colon, 11162b15cb3dSCy Schubertequal sign or simply white space. Values may be continued across multiple 11172b15cb3dSCy Schubertlines by escaping the newline with a backslash. 11182b15cb3dSCy Schubert 11192b15cb3dSCy Schubert <p>Multiple programs may also share the same initialization file. 11202b15cb3dSCy SchubertCommon options are collected at the top, followed by program specific 11212b15cb3dSCy Schubertsegments. The segments are separated by lines like: 11222b15cb3dSCy Schubert<pre class="example"> [NTPQ] 11232b15cb3dSCy Schubert</pre> 11242b15cb3dSCy Schubert <p class="noindent">or by 11252b15cb3dSCy Schubert<pre class="example"> <?program ntpq> 11262b15cb3dSCy Schubert</pre> 11272b15cb3dSCy Schubert <p class="noindent">Do not mix these styles within one configuration file. 11282b15cb3dSCy Schubert 11292b15cb3dSCy Schubert <p>Compound values and carefully constructed string values may also be 11302b15cb3dSCy Schubertspecified using XML syntax: 11312b15cb3dSCy Schubert<pre class="example"> <option-name> 11322b15cb3dSCy Schubert <sub-opt>...&lt;...&gt;...</sub-opt> 11332b15cb3dSCy Schubert </option-name> 11342b15cb3dSCy Schubert</pre> 11352b15cb3dSCy Schubert <p class="noindent">yielding an <code>option-name.sub-opt</code> string value of 11362b15cb3dSCy Schubert<pre class="example"> "...<...>..." 11372b15cb3dSCy Schubert</pre> 11382b15cb3dSCy Schubert <p><code>AutoOpts</code> does not track suboptions. You simply note that it is a 11392b15cb3dSCy Schuberthierarchicly valued option. <code>AutoOpts</code> does provide a means for searching 11402b15cb3dSCy Schubertthe associated name/value pair list (see: optionFindValue). 11412b15cb3dSCy Schubert 11422b15cb3dSCy Schubert <p>The command line options relating to configuration and/or usage help are: 11432b15cb3dSCy Schubert 11442b15cb3dSCy Schubert<h5 class="subsubheading">version (-)</h5> 11452b15cb3dSCy Schubert 11462b15cb3dSCy Schubert<p>Print the program version to standard out, optionally with licensing 11472b15cb3dSCy Schubertinformation, then exit 0. The optional argument specifies how much licensing 11482b15cb3dSCy Schubertdetail to provide. The default is to print just the version. The licensing infomation may be selected with an option argument. 11492b15cb3dSCy SchubertOnly the first letter of the argument is examined: 11502b15cb3dSCy Schubert 11512b15cb3dSCy Schubert <dl> 11522b15cb3dSCy Schubert<dt><span class="samp">version</span><dd>Only print the version. This is the default. 11532b15cb3dSCy Schubert<br><dt><span class="samp">copyright</span><dd>Name the copyright usage licensing terms. 11542b15cb3dSCy Schubert<br><dt><span class="samp">verbose</span><dd>Print the full copyright usage licensing terms. 11552b15cb3dSCy Schubert</dl> 11562b15cb3dSCy Schubert 11572b15cb3dSCy Schubert<div class="node"> 11582b15cb3dSCy Schubert<p><hr> 11592b15cb3dSCy Schubert<a name="ntpq-exit-status"></a>Previous: <a rel="previous" accesskey="p" href="#ntpq-config">ntpq config</a>, 11602b15cb3dSCy SchubertUp: <a rel="up" accesskey="u" href="#ntpq-Invocation">ntpq Invocation</a> 11612b15cb3dSCy Schubert<br> 11622b15cb3dSCy Schubert</div> 11632b15cb3dSCy Schubert 11642b15cb3dSCy Schubert<h4 class="subsection">ntpq exit status</h4> 11652b15cb3dSCy Schubert 11662b15cb3dSCy Schubert<p>One of the following exit values will be returned: 11672b15cb3dSCy Schubert <dl> 11682b15cb3dSCy Schubert<dt><span class="samp">0 (EXIT_SUCCESS)</span><dd>Successful program execution. 11692b15cb3dSCy Schubert<br><dt><span class="samp">1 (EXIT_FAILURE)</span><dd>The operation failed or the command syntax was not valid. 11702b15cb3dSCy Schubert<br><dt><span class="samp">66 (EX_NOINPUT)</span><dd>A specified configuration file could not be loaded. 11712b15cb3dSCy Schubert<br><dt><span class="samp">70 (EX_SOFTWARE)</span><dd>libopts had an internal operational error. Please report 11722b15cb3dSCy Schubertit to autogen-users@lists.sourceforge.net. Thank you. 11732b15cb3dSCy Schubert</dl> 11742b15cb3dSCy Schubert 11752b15cb3dSCy Schubert<div class="node"> 11762b15cb3dSCy Schubert<p><hr> 11772b15cb3dSCy Schubert<a name="Usage"></a>Next: <a rel="next" accesskey="n" href="#Internal-Commands">Internal Commands</a>, 11782b15cb3dSCy SchubertPrevious: <a rel="previous" accesskey="p" href="#ntpq-Description">ntpq Description</a>, 11792b15cb3dSCy SchubertUp: <a rel="up" accesskey="u" href="#Top">Top</a> 11802b15cb3dSCy Schubert<br> 11812b15cb3dSCy Schubert</div> 11822b15cb3dSCy Schubert 11832b15cb3dSCy Schubert<!-- node-name, next, previous, up --> 11842b15cb3dSCy Schubert<h3 class="section">Usage</h3> 11852b15cb3dSCy Schubert 11862b15cb3dSCy Schubert<p><table summary=""><tr align="left"><th valign="top" width="23%">What </th><th valign="top" width="23%">Default </th><th valign="top" width="5%">Flag </th><th valign="top" width="15%">Option 11872b15cb3dSCy Schubert<br></th></tr><tr align="left"><td valign="top" width="23%">configuration file 11882b15cb3dSCy Schubert</td><td valign="top" width="23%"><code>/etc/ntp.conf</code> 11892b15cb3dSCy Schubert</td><td valign="top" width="5%"><code>-c</code> 11902b15cb3dSCy Schubert</td><td valign="top" width="15%"><code>conffile</code> 11912b15cb3dSCy Schubert<br></td></tr><tr align="left"><td valign="top" width="23%">frequency file 11922b15cb3dSCy Schubert</td><td valign="top" width="23%">none 11932b15cb3dSCy Schubert</td><td valign="top" width="5%"><code>-f</code> 11942b15cb3dSCy Schubert</td><td valign="top" width="15%"><code>driftfile</code> 11952b15cb3dSCy Schubert<br></td></tr><tr align="left"><td valign="top" width="23%">leapseconds file 11962b15cb3dSCy Schubert</td><td valign="top" width="23%">none 11972b15cb3dSCy Schubert</td><td valign="top" width="5%"> 11982b15cb3dSCy Schubert</td><td valign="top" width="15%"><code>leapfile</code> 11992b15cb3dSCy Schubert<br></td></tr><tr align="left"><td valign="top" width="23%">process ID file 12002b15cb3dSCy Schubert</td><td valign="top" width="23%">none 12012b15cb3dSCy Schubert</td><td valign="top" width="5%"><code>-p</code> 12022b15cb3dSCy Schubert</td><td valign="top" width="15%"><code>pidfile</code> 12032b15cb3dSCy Schubert<br></td></tr><tr align="left"><td valign="top" width="23%">log file 12042b15cb3dSCy Schubert</td><td valign="top" width="23%">system log 12052b15cb3dSCy Schubert</td><td valign="top" width="5%"><code>-l</code> 12062b15cb3dSCy Schubert</td><td valign="top" width="15%"><code>logfile</code> 12072b15cb3dSCy Schubert<br></td></tr><tr align="left"><td valign="top" width="23%">include file 12082b15cb3dSCy Schubert</td><td valign="top" width="23%">none 12092b15cb3dSCy Schubert</td><td valign="top" width="5%">none 12102b15cb3dSCy Schubert</td><td valign="top" width="15%"><code>includefile</code> 12112b15cb3dSCy Schubert<br></td></tr><tr align="left"><td valign="top" width="23%">statistics path 12122b15cb3dSCy Schubert</td><td valign="top" width="23%"><code>/var/NTP</code> 12132b15cb3dSCy Schubert</td><td valign="top" width="5%"><code>-s</code> 12142b15cb3dSCy Schubert</td><td valign="top" width="15%"><code>statsdir</code> 12152b15cb3dSCy Schubert<br></td></tr><tr align="left"><td valign="top" width="23%">keys path 12162b15cb3dSCy Schubert</td><td valign="top" width="23%"><code>/usr/local/etc</code> 12172b15cb3dSCy Schubert</td><td valign="top" width="5%"><code>-k</code> 12182b15cb3dSCy Schubert</td><td valign="top" width="15%"><code>keysdir</code> 12192b15cb3dSCy Schubert<br></td></tr></table> 12202b15cb3dSCy Schubert 12212b15cb3dSCy Schubert<div class="node"> 12222b15cb3dSCy Schubert<p><hr> 12232b15cb3dSCy Schubert<a name="Internal-Commands"></a>Next: <a rel="next" accesskey="n" href="#Control-Message-Commands">Control Message Commands</a>, 12242b15cb3dSCy SchubertPrevious: <a rel="previous" accesskey="p" href="#Usage">Usage</a>, 12252b15cb3dSCy SchubertUp: <a rel="up" accesskey="u" href="#Top">Top</a> 12262b15cb3dSCy Schubert<br> 12272b15cb3dSCy Schubert</div> 12282b15cb3dSCy Schubert 12292b15cb3dSCy Schubert<!-- node-name, next, previous, up --> 12302b15cb3dSCy Schubert<h3 class="section">Internal Commands</h3> 12312b15cb3dSCy Schubert 12322b15cb3dSCy Schubert<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 <code>></code>, followed by a file name, to the command line. A number of interactive format commands are executed entirely within the <code>ntpq</code> program itself and do not result in NTP mode-6 requests being sent to a server. These are described following. 12332b15cb3dSCy Schubert 12342b15cb3dSCy Schubert <dl> 12352b15cb3dSCy Schubert<dt><code><a name="help"></a> ? [</code><kbd>command_keyword</kbd><code>]</code><dt><code>help [</code><kbd>command_keyword</kbd><code>]</code><dd>A <code>?</code> by itself will print a list of all the command keywords known to <code>ntpq</code>. A <code>?</code> followed by a command keyword will print function and usage information about the command. 12362b15cb3dSCy Schubert 12372b15cb3dSCy Schubert <br><dt><code><a name="addvars"></a> >addvars </code><kbd>name</kbd><code> [ = </code><kbd>value</kbd><code>] [...]</code><dt><code>rmvars </code><kbd>name</kbd><code> [...]</code><dt><code>clearvars</dt></code><dd>The arguments to these commands consist of a list of items of the form 12382b15cb3dSCy Schubert<kbd>name</kbd><code> = </code><kbd>value</kbd>, where the <code>= </code><kbd>value</kbd> is ignored, 12392b15cb3dSCy Schubertand can be omitted in read requests. 12402b15cb3dSCy Schubert<code>ntpq</code> maintains an internal list in which data to be included 12412b15cb3dSCy Schubertin control messages can be assembled, and sent using the <code>readlist</code> 12422b15cb3dSCy Schubertand <code>writelist</code> commands described below. 12432b15cb3dSCy SchubertThe <code>addvars</code> command allows variables and optional values 12442b15cb3dSCy Schubertto be added to the list. 12452b15cb3dSCy SchubertIf more than one variable is to be added 12462b15cb3dSCy Schubertthe list should be comma-separated and not contain white space. 12472b15cb3dSCy SchubertThe <code>rmvars</code> command can be used to remove individual variables 12482b15cb3dSCy Schubertfrom the list, 12492b15cb3dSCy Schubertwhile the <code>clearlist</code> command removes all variables from the list. 12502b15cb3dSCy Schubert 12512b15cb3dSCy Schubert <br><dt><code><a name="cooked"></a> cooked</code><dd>Display server messages in prettyprint format. 12522b15cb3dSCy Schubert 12532b15cb3dSCy Schubert <br><dt><code><a name="debug"></a> debug more | less | off</code><dd>Turns internal query program debugging on and off. 12542b15cb3dSCy Schubert 12552b15cb3dSCy Schubert <br><dt><code><a name="delay"></a> delay </code><kbd>milliseconds</kbd><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. 12562b15cb3dSCy Schubert 12572b15cb3dSCy Schubert <br><dt><code><a name="host"></a> host </code><kbd>name</kbd><dd>Set the host to which future queries will be sent. 12582b15cb3dSCy SchubertThe name may be either a DNS name or a numeric address. 12592b15cb3dSCy Schubert 12602b15cb3dSCy Schubert <br><dt><code><a name="hostnames"></a> hostnames [yes | no]</code><dd>If <code>yes</code> is specified, host names are printed in information displays. 12612b15cb3dSCy SchubertIf <code>no</code> is specified, numeric addresses are printed instead. 12622b15cb3dSCy SchubertThe default is <code>yes</code>, 12632b15cb3dSCy Schubertunless modified using the command line <code>-n</code> switch. 12642b15cb3dSCy Schubert 12652b15cb3dSCy Schubert <br><dt><code><a name="keyid"></a> keyid </code><kbd>keyid</kbd><dd>This command specifies the key number to be used 12662b15cb3dSCy Schubertto authenticate configuration requests. 12672b15cb3dSCy SchubertThis must correspond to a key ID configured in <code>ntp.conf</code> for this purpose. 12682b15cb3dSCy Schubert 12692b15cb3dSCy Schubert <br><dt><code><a name="keytype"></a> keytype</code><dd>Specify the digest algorithm to use for authenticated requests, 12702b15cb3dSCy Schubertwith default <code>MD5</code>. 12712b15cb3dSCy SchubertIf the OpenSSL library is installed, 12722b15cb3dSCy Schubertdigest can be be any message digest algorithm supported by the library. 1273*09100258SXin LIThe current selections are: <code>AES128CMAC</code>, <code>MD2</code>, <code>MD4</code>, <code>MD5</code>, <code>MDC2</code>, <code>RIPEMD160</code>, <code>SHA</code> and <code>SHA1</code>. 12742b15cb3dSCy Schubert 12752b15cb3dSCy Schubert <br><dt><code><a name="ntpversion"></a> ntpversion 1 | 2 | 3 | 4</code><dd>Sets the NTP version number which <code>ntpq</code> claims in packets. 12762b15cb3dSCy SchubertDefaults to 2. 12772b15cb3dSCy SchubertNote that mode-6 control messages (and modes, for that matter) 12782b15cb3dSCy Schubertdidn't exist in NTP version 1. 12792b15cb3dSCy Schubert 12802b15cb3dSCy Schubert <br><dt><code><a name="passwd"></a> passwd</code><dd>This command prompts for a password to authenticate requests. 12812b15cb3dSCy SchubertThe password must correspond to the key ID configured in <code>ntp.conf</code> for this purpose. 12822b15cb3dSCy Schubert 12832b15cb3dSCy Schubert <br><dt><code><a name="quit"></a> quit</code><dd>Exit <code>ntpq</code>. 12842b15cb3dSCy Schubert 12852b15cb3dSCy Schubert <br><dt><code><a name="raw"></a> raw</code><dd>Display server messages as received and without reformatting. 12862b15cb3dSCy Schubert 12872b15cb3dSCy Schubert <br><dt><code><a name="timeout"></a> timeout </code><kbd>millseconds</kbd><dd>Specify a timeout period for responses to server queries. 12882b15cb3dSCy SchubertThe default is about 5000 milliseconds. 12892b15cb3dSCy SchubertNote that since <code>ntpq</code> retries each query once after a timeout 12902b15cb3dSCy Schubertthe total waiting time for a timeout will be twice the timeout value set. 12912b15cb3dSCy Schubert 12922b15cb3dSCy Schubert </dl> 12932b15cb3dSCy Schubert 12942b15cb3dSCy Schubert<div class="node"> 12952b15cb3dSCy Schubert<p><hr> 12962b15cb3dSCy Schubert<a name="Control-Message-Commands"></a>Next: <a rel="next" accesskey="n" href="#Status-Words-and-Kiss-Codes">Status Words and Kiss Codes</a>, 12972b15cb3dSCy SchubertPrevious: <a rel="previous" accesskey="p" href="#Internal-Commands">Internal Commands</a>, 12982b15cb3dSCy SchubertUp: <a rel="up" accesskey="u" href="#Top">Top</a> 12992b15cb3dSCy Schubert<br> 13002b15cb3dSCy Schubert</div> 13012b15cb3dSCy Schubert 13022b15cb3dSCy Schubert<!-- node-name, next, previous, up --> 13032b15cb3dSCy Schubert<h3 class="section">Control Message Commands</h3> 13042b15cb3dSCy Schubert 13052b15cb3dSCy Schubert<p>Association IDs are used to identify system, peer and clock variables. 13062b15cb3dSCy SchubertSystem variables are assigned an association ID of zero and system name space, 13072b15cb3dSCy Schubertwhile each association is assigned a nonzero association ID and peer namespace. 13082b15cb3dSCy SchubertMost control commands send a single mode-6 message to the server 13092b15cb3dSCy Schubertand expect a single response message. 13102b15cb3dSCy SchubertThe exceptions are the <code>peers</code> command, 13112b15cb3dSCy Schubertwhich sends a series of messages, 13122b15cb3dSCy Schubertand the <code>mreadlist</code> and <code>mreadvar</code> commands, 13132b15cb3dSCy Schubertwhich iterate over a range of associations. 13142b15cb3dSCy Schubert 13152b15cb3dSCy Schubert <p><a name="as"></a> 13162b15cb3dSCy Schubert <dl> 13172b15cb3dSCy Schubert<dt><code>associations</code><dd>Display a list of mobilized associations in the form: 13182b15cb3dSCy Schubert<br> 13192b15cb3dSCy Schubert<code>ind assid status conf reach auth condition last_event cnt</code> 13202b15cb3dSCy Schubert 13212b15cb3dSCy Schubert <p><table summary=""><tr align="left"><th valign="top" width="10%">Variable </th><th valign="top" width="40%">Description 13222b15cb3dSCy Schubert 13232b15cb3dSCy Schubert <p><br></th></tr><tr align="left"><td valign="top" width="10%"><code>ind</code> 13242b15cb3dSCy Schubert</td><td valign="top" width="40%">index on this list 13252b15cb3dSCy Schubert 13262b15cb3dSCy Schubert <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>assid</code> 13272b15cb3dSCy Schubert</td><td valign="top" width="40%">association ID 13282b15cb3dSCy Schubert 13292b15cb3dSCy Schubert <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>status</code> 13302b15cb3dSCy Schubert</td><td valign="top" width="40%"><a href="decode.html#peer">peer status word</a> 13312b15cb3dSCy Schubert 13322b15cb3dSCy Schubert <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>conf</code> 13332b15cb3dSCy Schubert</td><td valign="top" width="40%"><code>yes</code>: persistent, <code>no</code>: ephemeral 13342b15cb3dSCy Schubert 13352b15cb3dSCy Schubert <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>reach</code> 13362b15cb3dSCy Schubert</td><td valign="top" width="40%"><code>yes</code>: reachable, <code>no</code>: unreachable 13372b15cb3dSCy Schubert 13382b15cb3dSCy Schubert <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>auth</code> 13392b15cb3dSCy Schubert</td><td valign="top" width="40%"><code>ok</code>, <code>yes</code>, <code>bad</code> and <code>none</code> 13402b15cb3dSCy Schubert 13412b15cb3dSCy Schubert <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>condition</code> 13422b15cb3dSCy Schubert</td><td valign="top" width="40%">selection status (see the <code>select</code> field of the <a href="decode.html#peer">peer status word</a>) 13432b15cb3dSCy Schubert 13442b15cb3dSCy Schubert <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>last_event</code> 13452b15cb3dSCy Schubert</td><td valign="top" width="40%">event report (see the <code>event</code> field of the <a href="decode.html#peer">peer status word</a>) 13462b15cb3dSCy Schubert 13472b15cb3dSCy Schubert <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>cnt</code> 13482b15cb3dSCy Schubertevent count (see the <code>count</code> field of the <a href="decode.html#peer">peer status word</a>) 13492b15cb3dSCy Schubert 13502b15cb3dSCy Schubert <br></td></tr></table> 13512b15cb3dSCy Schubert 13522b15cb3dSCy Schubert <br><dt><code><a name="cv"></a> clockvar </code><kbd>assocID</kbd><code> [</code><kbd>name</kbd><code> [ = </code><kbd>value</kbd><code> [...]] [...]]</code><dt><code>cv </code><kbd>assocID</kbd><code> [</code><kbd>name</kbd><code> [ = </code><kbd>value</kbd><code> [...] ][...]]</code><dd>Display a list of <a href="#clock">clock variables</a> for those associations supporting a reference clock. 13532b15cb3dSCy Schubert 13542b15cb3dSCy Schubert <br><dt><code><a name="_003aconfig"></a> :config [...]</code><dd>Send the remainder of the command line, including whitespace, to the server 13552b15cb3dSCy Schubertas a run-time configuration command in the same format 13562b15cb3dSCy Schubertas the configuration file. 13572b15cb3dSCy SchubertThis command is experimental until further notice and clarification. 13582b15cb3dSCy SchubertAuthentication is of course required. 13592b15cb3dSCy Schubert 13602b15cb3dSCy Schubert <br><dt><code><a name="config_002dfrom_002dfile"></a> config-from-file </code><kbd>filename</kbd><dd>Send the each line of <kbd>filename</kbd> to the server as 13612b15cb3dSCy Schubertrun-time configuration commands in the same format as the configuration file. 13622b15cb3dSCy SchubertThis command is experimental until further notice and clarification. 13632b15cb3dSCy SchubertAuthentication is required. 13642b15cb3dSCy Schubert 13652b15cb3dSCy Schubert <br><dt><code><a name="ifstats"></a> ifstats</code><dd>Display statistics for each local network address. 13662b15cb3dSCy SchubertAuthentication is required. 13672b15cb3dSCy Schubert 13682b15cb3dSCy Schubert <br><dt><code><a name="iostats"></a> iostats</code><dd>Display network and reference clock I/O statistics. 13692b15cb3dSCy Schubert 13702b15cb3dSCy Schubert <br><dt><code><a name="kerninfo"></a> kerninfo</code><dd>Display kernel loop and PPS statistics. 13712b15cb3dSCy SchubertAs with other ntpq output, times are in milliseconds. 13722b15cb3dSCy SchubertThe precision value displayed is in milliseconds as well, 13732b15cb3dSCy Schubertunlike the precision system variable. 13742b15cb3dSCy Schubert 13752b15cb3dSCy Schubert <br><dt><code><a name="lassoc"></a> lassociations</code><dd>Perform the same function as the associations command, 13762b15cb3dSCy Schubertexcept display mobilized and unmobilized associations. 13772b15cb3dSCy Schubert 13782b15cb3dSCy Schubert <br><dt><code><a name="monstats"></a> monstats</code><dd>Display monitor facility statistics. 13792b15cb3dSCy Schubert 13802b15cb3dSCy Schubert <br><dt><code><a name="mrulist"></a> mrulist [limited | kod | mincount=</code><kbd>count</kbd><code> | laddr=</code><kbd>localaddr</kbd><code> | sort=</code><kbd>sortorder</kbd><code> | resany=</code><kbd>hexmask</kbd><code> | resall=</code><kbd>hexmask</kbd><code>]</code><dd>Obtain and print traffic counts collected and maintained by 13812b15cb3dSCy Schubertthe monitor facility. 13822b15cb3dSCy SchubertWith the exception of <code>sort=</code><kbd>sortorder</kbd>, 13832b15cb3dSCy Schubertthe options filter the list returned by <code>ntpd</code>. 13842b15cb3dSCy SchubertThe <code>limited</code> and <code>kod</code> options return only entries 13852b15cb3dSCy Schubertrepresenting client addresses from which the last packet received 13862b15cb3dSCy Schuberttriggered either discarding or a KoD response. 13872b15cb3dSCy SchubertThe <code>mincount=</code><kbd>count</kbd> option filters entries representing 13882b15cb3dSCy Schubertless than <kbd>count</kbd> packets. 13892b15cb3dSCy SchubertThe <code>laddr=</code><kbd>localaddr</kbd> option filters entries for packets 13902b15cb3dSCy Schubertreceived on any local address other than <kbd>localaddr</kbd>. 13912b15cb3dSCy Schubert<code>resany=</code><kbd>hexmask</kbd> and <code>resall=</code><kbd>hexmask</kbd> 13922b15cb3dSCy Schubertfilter entries containing none or less than all, respectively, 13932b15cb3dSCy Schubertof the bits in <kbd>hexmask</kbd>, which must begin with <code>0x</code>. 13942b15cb3dSCy Schubert<br> 13952b15cb3dSCy SchubertThe <kbd>sortorder</kbd> defaults to <code>lstint</code> and may be any of 13962b15cb3dSCy Schubert<code>addr</code>, <code>count</code>, <code>avgint</code>, <code>lstint</code>, or 13972b15cb3dSCy Schubertany of those preceded by a minus sign (hyphen) to reverse the sort order. 13982b15cb3dSCy SchubertThe output columns are: 13992b15cb3dSCy Schubert 14002b15cb3dSCy Schubert <p><table summary=""><tr align="left"><th valign="top" width="10%">Column </th><th valign="top" width="40%">Description 14012b15cb3dSCy Schubert 14022b15cb3dSCy Schubert <p><br></th></tr><tr align="left"><td valign="top" width="10%"><code>lstint</code> 14032b15cb3dSCy Schubert</td><td valign="top" width="40%"> 14042b15cb3dSCy SchubertInterval in s between the receipt of the most recent packet from this 14052b15cb3dSCy Schubertaddress and the completion of the retrieval of the MRU list by <code>ntpq</code> 14062b15cb3dSCy Schubert 14072b15cb3dSCy Schubert <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>avgint</code> 14082b15cb3dSCy Schubert</td><td valign="top" width="40%"> 14092b15cb3dSCy SchubertAverage interval in s between packets from this address. 14102b15cb3dSCy Schubert 14112b15cb3dSCy Schubert <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>rstr</code> 14122b15cb3dSCy Schubert</td><td valign="top" width="40%"> 14132b15cb3dSCy SchubertRestriction flags associated with this address. 14142b15cb3dSCy SchubertMost are copied unchanged from the matching <code>restrict</code> command, 14152b15cb3dSCy Schuberthowever 0x400 (kod) and 0x20 (limited) flags are cleared unless 14162b15cb3dSCy Schubertthe last packet from this address triggered a rate control response. 14172b15cb3dSCy Schubert 14182b15cb3dSCy Schubert <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>r</code> 14192b15cb3dSCy Schubert</td><td valign="top" width="40%"> 14202b15cb3dSCy SchubertRate control indicator, either a period, <code>L</code> or <code>K</code> for 14212b15cb3dSCy Schubertno rate control response, rate limiting by discarding, or 14222b15cb3dSCy Schubertrate limiting with a KoD response, respectively. 14232b15cb3dSCy Schubert 14242b15cb3dSCy Schubert <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>m</code> 14252b15cb3dSCy Schubert</td><td valign="top" width="40%"> 14262b15cb3dSCy SchubertPacket mode. 14272b15cb3dSCy Schubert<br></td></tr><tr align="left"><td valign="top" width="10%"><code>v</code> 14282b15cb3dSCy Schubert</td><td valign="top" width="40%"> 14292b15cb3dSCy SchubertPacket version number. 14302b15cb3dSCy Schubert 14312b15cb3dSCy Schubert <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>count</code> 14322b15cb3dSCy Schubert</td><td valign="top" width="40%"> 14332b15cb3dSCy SchubertPackets received from this address. 14342b15cb3dSCy Schubert 14352b15cb3dSCy Schubert <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>rport</code> 14362b15cb3dSCy Schubert</td><td valign="top" width="40%"> 14372b15cb3dSCy SchubertSource port of last packet from this address. 14382b15cb3dSCy Schubert 14392b15cb3dSCy Schubert <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>remote address</code> 14402b15cb3dSCy Schubert</td><td valign="top" width="40%"> 14412b15cb3dSCy SchubertDNS name, numeric address, or address followed by claimed DNS name which 14422b15cb3dSCy Schubertcould not be verified in parentheses. 14432b15cb3dSCy Schubert 14442b15cb3dSCy Schubert <br></td></tr></table> 14452b15cb3dSCy Schubert 14462b15cb3dSCy Schubert <br><dt><code><a name="mreadvar"></a> mreadvar </code><kbd>assocID</kbd> <kbd>assocID</kbd><code> [ </code><kbd>variable_name</kbd><code> [ = </code><kbd>value</kbd><code>[ ... ]</code><dt><code><a name="mrv"></a> mrv </code><kbd>assocID</kbd> <kbd>assocID</kbd><code> [ </code><kbd>variable_name</kbd><code> [ = </code><kbd>value</kbd><code>[ ... ]</code><dd>Perform the same function as the <code>readvar</code> command, 14472b15cb3dSCy Schubertexcept for a range of association IDs. 14482b15cb3dSCy SchubertThis range is determined from the association list cached by 14492b15cb3dSCy Schubertthe most recent <code>associations</code> command. 14502b15cb3dSCy Schubert 14512b15cb3dSCy Schubert <br><dt><code><a name="passoc"></a> passociations</code><dd>Perform the same function as the <code>associations command</code>, except that 14522b15cb3dSCy Schubertit uses previously stored data rather than making a new query. 14532b15cb3dSCy Schubert 14542b15cb3dSCy Schubert <br><dt><code><a name="pe"></a> peers</code><dd>Display a list of peers in the form: 14552b15cb3dSCy Schubert<br> 14562b15cb3dSCy Schubert<code>[tally]remote refid st t when pool reach delay offset jitter</code> 14572b15cb3dSCy Schubert 14582b15cb3dSCy Schubert <p><table summary=""><tr align="left"><th valign="top" width="10%">Variable </th><th valign="top" width="20%">Description 14592b15cb3dSCy Schubert<br></th></tr><tr align="left"><td valign="top" width="10%"><code>[tally]</code> 14602b15cb3dSCy Schubert</td><td valign="top" width="20%"> 14612b15cb3dSCy Schubertsingle-character code indicating current value of the <code>select</code> field 14622b15cb3dSCy Schubertof the <a href="decode.html#peer">peer status word</a>. 14632b15cb3dSCy Schubert 14642b15cb3dSCy Schubert <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>remote</code> 14652b15cb3dSCy Schubert</td><td valign="top" width="20%"> 14662b15cb3dSCy Schuberthost name (or IP number) of peer 14672b15cb3dSCy Schubert 14682b15cb3dSCy Schubert <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>refid</code> 14692b15cb3dSCy Schubert</td><td valign="top" width="20%"> 14702b15cb3dSCy Schubertassociation ID or <a href="decode.html#kiss">kiss code</a>. 14712b15cb3dSCy Schubert 14722b15cb3dSCy Schubert <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>st</code> 14732b15cb3dSCy Schubert</td><td valign="top" width="20%"> 14742b15cb3dSCy Schubertstratum 14752b15cb3dSCy Schubert 14762b15cb3dSCy Schubert <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>t</code> 14772b15cb3dSCy Schubert</td><td valign="top" width="20%"> 14782b15cb3dSCy Schubert<code>u</code>: unicast or manycast client, 14792b15cb3dSCy Schubert<code>b</code>: broadcast or multicast client, 14802b15cb3dSCy Schubert<code>l</code>: local (reference clock), 14812b15cb3dSCy Schubert<code>s</code>: symmetric (peer), 14822b15cb3dSCy Schubert<code>A</code>: manycast server, 14832b15cb3dSCy Schubert<code>B</code>: broadcast server, 14842b15cb3dSCy Schubert<code>M</code>: multicast server. 14852b15cb3dSCy Schubert 14862b15cb3dSCy Schubert <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>when</code> 14872b15cb3dSCy Schubert</td><td valign="top" width="20%"> 14882b15cb3dSCy Schubertsec/min/hr since last received packet 14892b15cb3dSCy Schubert 14902b15cb3dSCy Schubert <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>poll</code> 14912b15cb3dSCy Schubert</td><td valign="top" width="20%"> 14922b15cb3dSCy Schubertpoll interval (log(2) s) 14932b15cb3dSCy Schubert 14942b15cb3dSCy Schubert <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>reach</code> 14952b15cb3dSCy Schubert</td><td valign="top" width="20%"> 14962b15cb3dSCy Schubertreach shift register (octal) 14972b15cb3dSCy Schubert 14982b15cb3dSCy Schubert <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>delay</code> 14992b15cb3dSCy Schubert</td><td valign="top" width="20%"> 15002b15cb3dSCy Schubertroundtrip delay 15012b15cb3dSCy Schubert 15022b15cb3dSCy Schubert <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>offset</code> 15032b15cb3dSCy Schubert</td><td valign="top" width="20%"> 15042b15cb3dSCy Schubertoffset of server relative to this host 15052b15cb3dSCy Schubert 15062b15cb3dSCy Schubert <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>jitter</code> 15072b15cb3dSCy Schubert</td><td valign="top" width="20%"> 15082b15cb3dSCy Schubertjitter 15092b15cb3dSCy Schubert 15102b15cb3dSCy Schubert <br></td></tr></table> 15112b15cb3dSCy Schubert 15122b15cb3dSCy Schubert <br><dt><code><a name="rv"></a> readvar </code><kbd>assocID</kbd> <kbd>name</kbd><code> [ = </code><kbd>value</kbd><code> ] [,...]</code><dt><code>rv </code><kbd>assocID</kbd><code> [ </code><kbd>name</kbd><code> ] [,...]</code><dd>Display the specified variables. 15132b15cb3dSCy SchubertIf <kbd>assocID</kbd> is zero, 15142b15cb3dSCy Schubertthe variables are from the <a href="#system">system variables</a> name space, 15152b15cb3dSCy Schubertotherwise they are from the <a href="#peer">peer variables</a> name space. 15162b15cb3dSCy SchubertThe <kbd>assocID</kbd> is required, as the same name can occur in both spaces. 15172b15cb3dSCy SchubertIf no <kbd>name</kbd> is included, 15182b15cb3dSCy Schubertall operative variables in the name space are displayed. 15192b15cb3dSCy SchubertIn this case only, if the <kbd>assocID</kbd> is omitted, it is assumed zero. 15202b15cb3dSCy SchubertMultiple names are specified with comma separators and without whitespace. 15212b15cb3dSCy SchubertNote that time values are represented in milliseconds and 15222b15cb3dSCy Schubertfrequency values in parts-per-million (PPM). 15232b15cb3dSCy SchubertSome NTP timestamps are represented in the format YYYYMMDDTTTT, 15242b15cb3dSCy Schubertwhere YYYY is the year, MM the month of year, DD the day of month and 15252b15cb3dSCy SchubertTTTT the time of day. 15262b15cb3dSCy Schubert 15272b15cb3dSCy Schubert <br><dt><code><a name="saveconfig"></a> saveconfig </code><kbd>filename</kbd><dd>Write the current configuration, including any runtime modifications 15282b15cb3dSCy Schubertgiven with <code>:config</code> or <code>config-from-file</code>, 15292b15cb3dSCy Schubertto the ntpd host's file <kbd>filename</kbd>. 15302b15cb3dSCy SchubertThis command will be rejected by the server unless 15312b15cb3dSCy Schubert<a href="miscopt.html#saveconfigdir">saveconfigdir</a> 15322b15cb3dSCy Schubertappears in the <code>ntpd</code> configuration file. 15332b15cb3dSCy Schubert<kbd>filename</kbd> can use <code>strftime()</code> format specifiers 15342b15cb3dSCy Schubertto substitute the current date and time, for example, 15352b15cb3dSCy Schubert<code>saveconfig ntp-%Y%m%d-%H%M%S.conf</code>. 15362b15cb3dSCy SchubertThe filename used is stored in system variable <code>savedconfig</code>. 15372b15cb3dSCy SchubertAuthentication is required. 15382b15cb3dSCy Schubert 15392b15cb3dSCy Schubert <br><dt><code><a name="writevar"></a> writevar </code><kbd>assocID</kbd> <kbd>name</kbd><code> = </code><kbd>value</kbd><code> [,...]</code><dd>Write the specified variables. 15402b15cb3dSCy SchubertIf the <kbd>assocID</kbd> is zero, the variables are from the 15412b15cb3dSCy Schubert<a href="#system">system variables</a> name space, otherwise they are from the 15422b15cb3dSCy Schubert<a href="#peer">peer variables</a> name space. 15432b15cb3dSCy SchubertThe <kbd>assocID</kbd> is required, 15442b15cb3dSCy Schubertas the same name can occur in both spaces. 15452b15cb3dSCy Schubert 15462b15cb3dSCy Schubert <br><dt><code><a name="sysinfo"></a> sysinfo</code><dd>Display operational summary. 15472b15cb3dSCy Schubert 15482b15cb3dSCy Schubert <br><dt><code><a name="sysstats"></a> sysstats</code><dd>Print statistics counters maintained in the protocol module. 15492b15cb3dSCy Schubert 15502b15cb3dSCy Schubert </dl> 15512b15cb3dSCy Schubert 15522b15cb3dSCy Schubert<div class="node"> 15532b15cb3dSCy Schubert<p><hr> 15542b15cb3dSCy Schubert<a name="Status-Words-and-Kiss-Codes"></a>Next: <a rel="next" accesskey="n" href="#System-Variables">System Variables</a>, 15552b15cb3dSCy SchubertPrevious: <a rel="previous" accesskey="p" href="#Control-Message-Commands">Control Message Commands</a>, 15562b15cb3dSCy SchubertUp: <a rel="up" accesskey="u" href="#Top">Top</a> 15572b15cb3dSCy Schubert<br> 15582b15cb3dSCy Schubert</div> 15592b15cb3dSCy Schubert 15602b15cb3dSCy Schubert<!-- node-name, next, previous, up --> 15612b15cb3dSCy Schubert<h3 class="section">Status Words and Kiss Codes</h3> 15622b15cb3dSCy Schubert 15632b15cb3dSCy Schubert<p>The current state of the operating program is shown 15642b15cb3dSCy Schubertin a set of status words maintained by the system 15652b15cb3dSCy Schubertand each association separately. 15662b15cb3dSCy SchubertThese words are displayed in the <code>rv</code> and <code>as</code> commands 15672b15cb3dSCy Schubertboth in hexadecimal and decoded short tip strings. 15682b15cb3dSCy SchubertThe codes, tips and short explanations are on the 15692b15cb3dSCy Schubert<a href="decode.html">Event Messages and Status Words</a> page. 15702b15cb3dSCy SchubertThe page also includes a list of system and peer messages, 15712b15cb3dSCy Schubertthe code for the latest of which is included in the status word. 15722b15cb3dSCy Schubert 15732b15cb3dSCy Schubert <p>Information resulting from protocol machine state transitions 15742b15cb3dSCy Schubertis displayed using an informal set of ASCII strings called 15752b15cb3dSCy Schubert<a href="decode.html#kiss">kiss codes</a>. 15762b15cb3dSCy SchubertThe original purpose was for kiss-o'-death (KoD) packets sent 15772b15cb3dSCy Schubertby the server to advise the client of an unusual condition. 15782b15cb3dSCy SchubertThey are now displayed, when appropriate, 15792b15cb3dSCy Schubertin the reference identifier field in various billboards. 15802b15cb3dSCy Schubert 15812b15cb3dSCy Schubert<div class="node"> 15822b15cb3dSCy Schubert<p><hr> 15832b15cb3dSCy Schubert<a name="System-Variables"></a>Next: <a rel="next" accesskey="n" href="#Peer-Variables">Peer Variables</a>, 15842b15cb3dSCy SchubertPrevious: <a rel="previous" accesskey="p" href="#Status-Words-and-Kiss-Codes">Status Words and Kiss Codes</a>, 15852b15cb3dSCy SchubertUp: <a rel="up" accesskey="u" href="#Top">Top</a> 15862b15cb3dSCy Schubert<br> 15872b15cb3dSCy Schubert</div> 15882b15cb3dSCy Schubert 15892b15cb3dSCy Schubert<!-- node-name, next, previous, up --> 15902b15cb3dSCy Schubert<h3 class="section">System Variables</h3> 15912b15cb3dSCy Schubert 15922b15cb3dSCy Schubert<p>The following system variables appear in the <code>rv</code> billboard. 15932b15cb3dSCy SchubertNot all variables are displayed in some configurations. 15942b15cb3dSCy Schubert 15952b15cb3dSCy Schubert <p><table summary=""><tr align="left"><th valign="top" width="10%">Variable </th><th valign="top" width="20%">Description 15962b15cb3dSCy Schubert 15972b15cb3dSCy Schubert<p><br></th></tr><tr align="left"><td valign="top" width="10%"><code>status</code> 15982b15cb3dSCy Schubert</td><td valign="top" width="20%"> 15992b15cb3dSCy Schubert<a href="decode.html#sys">system status word</a> 16002b15cb3dSCy Schubert 16012b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>version</code> 16022b15cb3dSCy Schubert</td><td valign="top" width="20%"> 16032b15cb3dSCy SchubertNTP software version and build time 16042b15cb3dSCy Schubert 16052b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>processor</code> 16062b15cb3dSCy Schubert</td><td valign="top" width="20%"> 16072b15cb3dSCy Schuberthardware platform and version 16082b15cb3dSCy Schubert 16092b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>system</code> 16102b15cb3dSCy Schubert</td><td valign="top" width="20%"> 16112b15cb3dSCy Schubertoperating system and version 16122b15cb3dSCy Schubert 16132b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>leap</code> 16142b15cb3dSCy Schubert</td><td valign="top" width="20%"> 16152b15cb3dSCy Schubertleap warning indicator (0-3) 16162b15cb3dSCy Schubert 16172b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>stratum</code> 16182b15cb3dSCy Schubert</td><td valign="top" width="20%"> 16192b15cb3dSCy Schubertstratum (1-15) 16202b15cb3dSCy Schubert 16212b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>precision</code> 16222b15cb3dSCy Schubert</td><td valign="top" width="20%"> 16232b15cb3dSCy Schubertprecision (log(2) s) 16242b15cb3dSCy Schubert 16252b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>rootdelay</code> 16262b15cb3dSCy Schubert</td><td valign="top" width="20%"> 16272b15cb3dSCy Schuberttotal roundtrip delay to the primary reference clock 16282b15cb3dSCy Schubert 16292b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>rootdisp</code> 16302b15cb3dSCy Schubert</td><td valign="top" width="20%"> 16312b15cb3dSCy Schuberttotal dispersion to the primary reference clock 16322b15cb3dSCy Schubert 16332b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>peer</code> 16342b15cb3dSCy Schubert</td><td valign="top" width="20%"> 16352b15cb3dSCy Schubertsystem peer association ID 16362b15cb3dSCy Schubert 16372b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>tc</code> 16382b15cb3dSCy Schuberttime constant and poll exponent (log(2) s) (3-17) 16392b15cb3dSCy Schubert 16402b15cb3dSCy Schubert <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>mintc</code> 16412b15cb3dSCy Schubertminimum time constant (log(2) s) (3-10) 16422b15cb3dSCy Schubert 16432b15cb3dSCy Schubert <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>clock</code> 16442b15cb3dSCy Schubert</td><td valign="top" width="20%"> 16452b15cb3dSCy Schubertdate and time of day 16462b15cb3dSCy Schubert 16472b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>refid</code> 16482b15cb3dSCy Schubertreference ID or <a href="decode.html#kiss">kiss code</a> 16492b15cb3dSCy Schubert 16502b15cb3dSCy Schubert <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>reftime</code> 16512b15cb3dSCy Schubert</td><td valign="top" width="20%"> 16522b15cb3dSCy Schubertreference time 16532b15cb3dSCy Schubert 16542b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>offset</code> 16552b15cb3dSCy Schubert</td><td valign="top" width="20%"> 16562b15cb3dSCy Schubertcombined offset of server relative to this host 16572b15cb3dSCy Schubert 16582b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>sys_jitter</code> 16592b15cb3dSCy Schubert</td><td valign="top" width="20%"> 16602b15cb3dSCy Schubertcombined system jitter 16612b15cb3dSCy Schubert 16622b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>frequency</code> 16632b15cb3dSCy Schubert</td><td valign="top" width="20%"> 16642b15cb3dSCy Schubertfrequency offset (PPM) relative to hardware clock 16652b15cb3dSCy Schubert 16662b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>clk_wander</code> 16672b15cb3dSCy Schubert</td><td valign="top" width="20%"> 16682b15cb3dSCy Schubertclock frequency wander (PPM) 16692b15cb3dSCy Schubert 16702b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>clk_jitter</code> 16712b15cb3dSCy Schubert</td><td valign="top" width="20%"> 16722b15cb3dSCy Schubertclock jitter 16732b15cb3dSCy Schubert 16742b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>tai</code> 16752b15cb3dSCy Schubert</td><td valign="top" width="20%"> 16762b15cb3dSCy SchubertTAI-UTC offset (s) 16772b15cb3dSCy Schubert 16782b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>leapsec</code> 16792b15cb3dSCy Schubert</td><td valign="top" width="20%"> 16802b15cb3dSCy SchubertNTP seconds when the next leap second is/was inserted 16812b15cb3dSCy Schubert 16822b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>expire</code> 16832b15cb3dSCy Schubert</td><td valign="top" width="20%"> 16842b15cb3dSCy SchubertNTP seconds when the NIST leapseconds file expires 16852b15cb3dSCy Schubert 16862b15cb3dSCy Schubert <br></td></tr></table> 16872b15cb3dSCy Schubert 16882b15cb3dSCy Schubert <p>The jitter and wander statistics are exponentially-weighted RMS averages. 16892b15cb3dSCy SchubertThe system jitter is defined in the NTPv4 specification; 16902b15cb3dSCy Schubertthe clock jitter statistic is computed by the clock discipline module. 16912b15cb3dSCy Schubert 16922b15cb3dSCy Schubert <p>When the NTPv4 daemon is compiled with the OpenSSL software library, 16932b15cb3dSCy Schubertadditional system variables are displayed, including some or all of the 16942b15cb3dSCy Schubertfollowing, depending on the particular Autokey dance: 16952b15cb3dSCy Schubert 16962b15cb3dSCy Schubert <p><table summary=""><tr align="left"><th valign="top" width="10%">Variable </th><th valign="top" width="20%">Description 16972b15cb3dSCy Schubert 16982b15cb3dSCy Schubert<p><br></th></tr><tr align="left"><td valign="top" width="10%"><code>host</code> 16992b15cb3dSCy Schubert</td><td valign="top" width="20%"> 17002b15cb3dSCy SchubertAutokey host name for this host 17012b15cb3dSCy Schubert 17022b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>ident</code> 17032b15cb3dSCy Schubert</td><td valign="top" width="20%"> 17042b15cb3dSCy SchubertAutokey group name for this host 17052b15cb3dSCy Schubert 17062b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>flags</code> 17072b15cb3dSCy Schubert</td><td valign="top" width="20%"> 17082b15cb3dSCy Schuberthost flags (see Autokey specification) 17092b15cb3dSCy Schubert 17102b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>digest</code> 17112b15cb3dSCy Schubert</td><td valign="top" width="20%"> 17122b15cb3dSCy SchubertOpenSSL message digest algorithm 17132b15cb3dSCy Schubert 17142b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>signature</code> 17152b15cb3dSCy Schubert</td><td valign="top" width="20%"> 17162b15cb3dSCy SchubertOpenSSL digest/signature scheme 17172b15cb3dSCy Schubert 17182b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>update</code> 17192b15cb3dSCy Schubert</td><td valign="top" width="20%"> 17202b15cb3dSCy SchubertNTP seconds at last signature update 17212b15cb3dSCy Schubert 17222b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>cert</code> 17232b15cb3dSCy Schubert</td><td valign="top" width="20%"> 17242b15cb3dSCy Schubertcertificate subject, issuer and certificate flags 17252b15cb3dSCy Schubert 17262b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>until</code> 17272b15cb3dSCy Schubert</td><td valign="top" width="20%"> 17282b15cb3dSCy SchubertNTP seconds when the certificate expires 17292b15cb3dSCy Schubert 17302b15cb3dSCy Schubert <br></td></tr></table> 17312b15cb3dSCy Schubert 17322b15cb3dSCy Schubert<div class="node"> 17332b15cb3dSCy Schubert<p><hr> 17342b15cb3dSCy Schubert<a name="Peer-Variables"></a>Next: <a rel="next" accesskey="n" href="#Clock-Variables">Clock Variables</a>, 17352b15cb3dSCy SchubertPrevious: <a rel="previous" accesskey="p" href="#System-Variables">System Variables</a>, 17362b15cb3dSCy SchubertUp: <a rel="up" accesskey="u" href="#Top">Top</a> 17372b15cb3dSCy Schubert<br> 17382b15cb3dSCy Schubert</div> 17392b15cb3dSCy Schubert 17402b15cb3dSCy Schubert<!-- node-name, next, previous, up --> 17412b15cb3dSCy Schubert<h3 class="section">Peer Variables</h3> 17422b15cb3dSCy Schubert 17432b15cb3dSCy Schubert<p>The following peer variables appear in the <code>rv</code> billboard 17442b15cb3dSCy Schubertfor each association. 17452b15cb3dSCy SchubertNot all variables are displayed in some configurations. 17462b15cb3dSCy Schubert 17472b15cb3dSCy Schubert <p><table summary=""><tr align="left"><th valign="top" width="10%">Variable </th><th valign="top" width="20%">Description 17482b15cb3dSCy Schubert 17492b15cb3dSCy Schubert<p><br></th></tr><tr align="left"><td valign="top" width="10%"><code>associd</code> 17502b15cb3dSCy Schubert</td><td valign="top" width="20%"> 17512b15cb3dSCy Schubertassociation ID 17522b15cb3dSCy Schubert 17532b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>status</code> 17542b15cb3dSCy Schubert</td><td valign="top" width="20%"> 17552b15cb3dSCy Schubert<a href="decode.html#peer">peer status word</a> 17562b15cb3dSCy Schubert 17572b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>srcadr</code> 17582b15cb3dSCy Schubert<br></td></tr><tr align="left"><td valign="top" width="10%"><code>srcport</code> 17592b15cb3dSCy Schubert</td><td valign="top" width="20%"> 17602b15cb3dSCy Schubertsource (remote) IP address and port 17612b15cb3dSCy Schubert 17622b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>dstadr</code> 17632b15cb3dSCy Schubert<br></td></tr><tr align="left"><td valign="top" width="10%"><code>dstport</code> 17642b15cb3dSCy Schubert</td><td valign="top" width="20%"> 17652b15cb3dSCy Schubertdestination (local) IP address and port 17662b15cb3dSCy Schubert 17672b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>leap</code> 17682b15cb3dSCy Schubert</td><td valign="top" width="20%"> 17692b15cb3dSCy Schubertleap indicator (0-3) 17702b15cb3dSCy Schubert 17712b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>stratum</code> 17722b15cb3dSCy Schubert</td><td valign="top" width="20%"> 17732b15cb3dSCy Schubertstratum (0-15) 17742b15cb3dSCy Schubert 17752b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>precision</code> 17762b15cb3dSCy Schubert</td><td valign="top" width="20%"> 17772b15cb3dSCy Schubertprecision (log(2) s) 17782b15cb3dSCy Schubert 17792b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>rootdelay</code> 17802b15cb3dSCy Schubert</td><td valign="top" width="20%"> 17812b15cb3dSCy Schuberttotal roundtrip delay to the primary reference clock 17822b15cb3dSCy Schubert 17832b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>rootdisp</code> 17842b15cb3dSCy Schubert</td><td valign="top" width="20%">total root dispersion to the primary reference clock 17852b15cb3dSCy Schubert 17862b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>refid</code> 17872b15cb3dSCy Schubert</td><td valign="top" width="20%"> 17882b15cb3dSCy Schubertreference ID or <a href="decode.html#kiss">kiss code</a> 17892b15cb3dSCy Schubert 17902b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>reftime</code> 17912b15cb3dSCy Schubert</td><td valign="top" width="20%"> 17922b15cb3dSCy Schubertreference time 17932b15cb3dSCy Schubert 17942b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>reach</code> 17952b15cb3dSCy Schubert</td><td valign="top" width="20%"> 17962b15cb3dSCy Schubertreach register (octal) 17972b15cb3dSCy Schubert 17982b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>unreach</code> 17992b15cb3dSCy Schubert</td><td valign="top" width="20%"> 18002b15cb3dSCy Schubertunreach counter 18012b15cb3dSCy Schubert 18022b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>hmode</code> 18032b15cb3dSCy Schubert</td><td valign="top" width="20%"> 18042b15cb3dSCy Schuberthost mode (1-6) 18052b15cb3dSCy Schubert 18062b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>pmode</code> 18072b15cb3dSCy Schubert</td><td valign="top" width="20%"> 18082b15cb3dSCy Schubertpeer mode (1-5) 18092b15cb3dSCy Schubert 18102b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>hpoll</code> 18112b15cb3dSCy Schubert</td><td valign="top" width="20%"> 18122b15cb3dSCy Schuberthost poll exponent (log(2) s) (3-17) 18132b15cb3dSCy Schubert<br></td></tr><tr align="left"><td valign="top" width="10%"><code>ppoll</code> 18142b15cb3dSCy Schubert</td><td valign="top" width="20%"> 18152b15cb3dSCy Schubertpeer poll exponent (log(2) s) (3-17) 18162b15cb3dSCy Schubert 18172b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>headway</code> 18182b15cb3dSCy Schubert</td><td valign="top" width="20%"> 18192b15cb3dSCy Schubertheadway (see <a href="rate.html">Rate Management and the Kiss-o'-Death Packet</a>) 18202b15cb3dSCy Schubert 18212b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>flash</code> 18222b15cb3dSCy Schubert</td><td valign="top" width="20%"> 18232b15cb3dSCy Schubert<a href="decode.html#flash">flash status word</a> 18242b15cb3dSCy Schubert 18252b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>offset</code> 18262b15cb3dSCy Schubert</td><td valign="top" width="20%"> 18272b15cb3dSCy Schubertfilter offset 18282b15cb3dSCy Schubert 18292b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>delay</code> 18302b15cb3dSCy Schubert</td><td valign="top" width="20%"> 18312b15cb3dSCy Schubertfilter delay 18322b15cb3dSCy Schubert 18332b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>dispersion</code> 18342b15cb3dSCy Schubert</td><td valign="top" width="20%"> 18352b15cb3dSCy Schubertfilter dispersion 18362b15cb3dSCy Schubert 18372b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>jitter</code> 18382b15cb3dSCy Schubert</td><td valign="top" width="20%"> 18392b15cb3dSCy Schubertfilter jitter 18402b15cb3dSCy Schubert 18412b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>ident</code> 18422b15cb3dSCy Schubert</td><td valign="top" width="20%"> 18432b15cb3dSCy SchubertAutokey group name for this association 18442b15cb3dSCy Schubert 18452b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>bias</code> 18462b15cb3dSCy Schubert</td><td valign="top" width="20%"> 18472b15cb3dSCy Schubertunicast/broadcast bias 18482b15cb3dSCy Schubert 18492b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>xleave</code> 18502b15cb3dSCy Schubert</td><td valign="top" width="20%"> 18512b15cb3dSCy Schubertinterleave delay (see <a href="xleave.html">NTP Interleaved Modes</a>) 18522b15cb3dSCy Schubert 18532b15cb3dSCy Schubert <br></td></tr></table> 18542b15cb3dSCy Schubert 18552b15cb3dSCy Schubert <p>The bias variable is calculated when the first broadcast packet is received 18562b15cb3dSCy Schubertafter the calibration volley. It represents the offset of the broadcast 18572b15cb3dSCy Schubertsubgraph relative to the unicast subgraph. The xleave variable appears 18582b15cb3dSCy Schubertonly the interleaved symmetric and interleaved modes. It represents 18592b15cb3dSCy Schubertthe internal queuing, buffering and transmission delays for the preceding 18602b15cb3dSCy Schubertpacket. 18612b15cb3dSCy Schubert 18622b15cb3dSCy Schubert <p>When the NTPv4 daemon is compiled with the OpenSSL software library, 18632b15cb3dSCy Schubertadditional peer variables are displayed, including the following: 18642b15cb3dSCy Schubert 18652b15cb3dSCy Schubert <p><table summary=""><tr align="left"><th valign="top" width="10%">Variable </th><th valign="top" width="20%">Description 18662b15cb3dSCy Schubert 18672b15cb3dSCy Schubert<p><br></th></tr><tr align="left"><td valign="top" width="10%"><code>flags</code> 18682b15cb3dSCy Schubert</td><td valign="top" width="20%"> 18692b15cb3dSCy Schubertpeer flags (see Autokey specification) 18702b15cb3dSCy Schubert 18712b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>host</code> 18722b15cb3dSCy Schubert</td><td valign="top" width="20%"> 18732b15cb3dSCy SchubertAutokey server name 18742b15cb3dSCy Schubert 18752b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>flags</code> 18762b15cb3dSCy Schubert</td><td valign="top" width="20%"> 18772b15cb3dSCy Schubertpeer flags (see Autokey specification) 18782b15cb3dSCy Schubert 18792b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>signature</code> 18802b15cb3dSCy Schubert</td><td valign="top" width="20%"> 18812b15cb3dSCy SchubertOpenSSL digest/signature scheme 18822b15cb3dSCy Schubert 18832b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>initsequence</code> 18842b15cb3dSCy Schubert</td><td valign="top" width="20%"> 18852b15cb3dSCy Schubertinitial key ID 18862b15cb3dSCy Schubert 18872b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>initkey</code> 18882b15cb3dSCy Schubert</td><td valign="top" width="20%"> 18892b15cb3dSCy Schubertinitial key index 18902b15cb3dSCy Schubert 18912b15cb3dSCy Schubert<p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>timestamp</code> 18922b15cb3dSCy Schubert</td><td valign="top" width="20%"> 18932b15cb3dSCy SchubertAutokey signature timestamp 18942b15cb3dSCy Schubert 18952b15cb3dSCy Schubert <br></td></tr></table> 18962b15cb3dSCy Schubert 18972b15cb3dSCy Schubert<div class="node"> 18982b15cb3dSCy Schubert<p><hr> 18992b15cb3dSCy Schubert<a name="Clock-Variables"></a>Previous: <a rel="previous" accesskey="p" href="#Peer-Variables">Peer Variables</a>, 19002b15cb3dSCy SchubertUp: <a rel="up" accesskey="u" href="#Top">Top</a> 19012b15cb3dSCy Schubert<br> 19022b15cb3dSCy Schubert</div> 19032b15cb3dSCy Schubert 19042b15cb3dSCy Schubert<!-- node-name, next, previous, up --> 19052b15cb3dSCy Schubert<h3 class="section">Clock Variables</h3> 19062b15cb3dSCy Schubert 19072b15cb3dSCy Schubert<p>The following clock variables appear in the <code>cv</code> billboard for each association with a reference clock. Not all variables are displayed in some configurations. 19082b15cb3dSCy Schubert 19092b15cb3dSCy Schubert <p><table summary=""><tr align="left"><th valign="top" width="10%">Variable </th><th valign="top" width="20%">Description 19102b15cb3dSCy Schubert<br></th></tr><tr align="left"><td valign="top" width="10%"><code>associd</code> 19112b15cb3dSCy Schubert</td><td valign="top" width="20%">association ID 19122b15cb3dSCy Schubert<br></td></tr><tr align="left"><td valign="top" width="10%"><code>status</code> 19132b15cb3dSCy Schubert</td><td valign="top" width="20%"><a href="decode.html#clock">clock status word</a> 19142b15cb3dSCy Schubert<br></td></tr><tr align="left"><td valign="top" width="10%"><code>device</code> 19152b15cb3dSCy Schubert</td><td valign="top" width="20%">device description 19162b15cb3dSCy Schubert<br></td></tr><tr align="left"><td valign="top" width="10%"><code>timecode</code> 19172b15cb3dSCy Schubert</td><td valign="top" width="20%">ASCII time code string (specific to device) 19182b15cb3dSCy Schubert<br></td></tr><tr align="left"><td valign="top" width="10%"><code>poll</code> 19192b15cb3dSCy Schubert</td><td valign="top" width="20%">poll messages sent 19202b15cb3dSCy Schubert<br></td></tr><tr align="left"><td valign="top" width="10%"><code>noreply</code> 19212b15cb3dSCy Schubert</td><td valign="top" width="20%">no reply 19222b15cb3dSCy Schubert<br></td></tr><tr align="left"><td valign="top" width="10%"><code>badformat</code> 19232b15cb3dSCy Schubert</td><td valign="top" width="20%">bad format 19242b15cb3dSCy Schubert<br></td></tr><tr align="left"><td valign="top" width="10%"><code>baddata</code> 19252b15cb3dSCy Schubert</td><td valign="top" width="20%">bad date or time 19262b15cb3dSCy Schubert<br></td></tr><tr align="left"><td valign="top" width="10%"><code>fudgetime1</code> 19272b15cb3dSCy Schubert</td><td valign="top" width="20%">fudge time 1 19282b15cb3dSCy Schubert<br></td></tr><tr align="left"><td valign="top" width="10%"><code>fudgetime2</code> 19292b15cb3dSCy Schubert</td><td valign="top" width="20%">fudge time 2 19302b15cb3dSCy Schubert<br></td></tr><tr align="left"><td valign="top" width="10%"><code>stratum</code> 19312b15cb3dSCy Schubert</td><td valign="top" width="20%">driver stratum 19322b15cb3dSCy Schubert<br></td></tr><tr align="left"><td valign="top" width="10%"><code>refid</code> 19332b15cb3dSCy Schubert</td><td valign="top" width="20%">driver reference ID 19342b15cb3dSCy Schubert<br></td></tr><tr align="left"><td valign="top" width="10%"><code>flags</code> 19352b15cb3dSCy Schubert</td><td valign="top" width="20%">driver flags 19362b15cb3dSCy Schubert <br></td></tr></table> 19372b15cb3dSCy Schubert 19382b15cb3dSCy Schubert</body></html> 19392b15cb3dSCy Schubert 1940