ntpdc.man.in revision 316722
1275970Scy.de1 NOP 2275970Scy. it 1 an-trap 3275970Scy. if \\n[.$] \,\\$*\/ 4275970Scy.. 5275970Scy.ie t \ 6275970Scy.ds B-Font [CB] 7275970Scy.ds I-Font [CI] 8275970Scy.ds R-Font [CR] 9275970Scy.el \ 10275970Scy.ds B-Font B 11275970Scy.ds I-Font I 12275970Scy.ds R-Font R 13316722Sdelphij.TH ntpdc @NTPDC_MS@ "21 Mar 2017" "4.2.8p10" "User Commands" 14275970Scy.\" 15316722Sdelphij.\" EDIT THIS FILE WITH CAUTION (/tmp/.ag-T2aicv/ag-q4aGav) 16275970Scy.\" 17316722Sdelphij.\" It has been AutoGen-ed March 21, 2017 at 10:44:50 AM by AutoGen 5.18.5 18275970Scy.\" From the definitions ntpdc-opts.def 19275970Scy.\" and the template file agman-cmd.tpl 20275970Scy.SH NAME 21275970Scy\f\*[B-Font]ntpdc\fP 22275970Scy\- vendor-specific NTPD control program 23275970Scy.SH SYNOPSIS 24275970Scy\f\*[B-Font]ntpdc\fP 25275970Scy.\" Mixture of short (flag) options and long options 26275970Scy[\f\*[B-Font]\-flags\f[]] 27275970Scy[\f\*[B-Font]\-flag\f[] [\f\*[I-Font]value\f[]]] 28275970Scy[\f\*[B-Font]\-\-option-name\f[][[=| ]\f\*[I-Font]value\f[]]] 29275970Scy[ host ...] 30275970Scy.sp \n(Ppu 31275970Scy.ne 2 32275970Scy 33275970Scy.SH DESCRIPTION 34275970Scy\f\*[B-Font]ntpdc\fP 35275970Scyis deprecated. 36275970ScyPlease use 37285169Scy\fCntpq\f[]\fR(@NTPQ_MS@)\f[] instead \- it can do everything 38275970Scy\f\*[B-Font]ntpdc\fP 39275970Scyused to do, and it does so using a much more sane interface. 40275970Scy.sp \n(Ppu 41275970Scy.ne 2 42275970Scy 43275970Scy\f\*[B-Font]ntpdc\fP 44275970Scyis a utility program used to query 45285169Scy\fCntpd\f[]\fR(@NTPD_MS@)\f[] 46275970Scyabout its 47275970Scycurrent state and to request changes in that state. 48275970ScyIt uses NTP mode 7 control message formats described in the source code. 49275970ScyThe program may 50275970Scybe run either in interactive mode or controlled using command line 51275970Scyarguments. 52275970ScyExtensive state and statistics information is available 53275970Scythrough the 54275970Scy\f\*[B-Font]ntpdc\fP 55275970Scyinterface. 56275970ScyIn addition, nearly all the 57275970Scyconfiguration options which can be specified at startup using 58275970Scyntpd's configuration file may also be specified at run time using 59275970Scy\f\*[B-Font]ntpdc\fP. 60275970Scy.SH "OPTIONS" 61275970Scy.TP 62275970Scy.NOP \f\*[B-Font]\-4\f[], \f\*[B-Font]\-\-ipv4\f[] 63275970ScyForce IPv4 DNS name resolution. 64275970ScyThis option must not appear in combination with any of the following options: 65275970Scyipv6. 66275970Scy.sp 67275970ScyForce DNS resolution of following host names on the command line 68275970Scyto the IPv4 namespace. 69275970Scy.TP 70275970Scy.NOP \f\*[B-Font]\-6\f[], \f\*[B-Font]\-\-ipv6\f[] 71275970ScyForce IPv6 DNS name resolution. 72275970ScyThis option must not appear in combination with any of the following options: 73275970Scyipv4. 74275970Scy.sp 75275970ScyForce DNS resolution of following host names on the command line 76275970Scyto the IPv6 namespace. 77275970Scy.TP 78275970Scy.NOP \f\*[B-Font]\-c\f[] \f\*[I-Font]cmd\f[], \f\*[B-Font]\-\-command\f[]=\f\*[I-Font]cmd\f[] 79275970Scyrun a command and exit. 80275970ScyThis option may appear an unlimited number of times. 81275970Scy.sp 82275970ScyThe following argument is interpreted as an interactive format command 83275970Scyand is added to the list of commands to be executed on the specified 84275970Scyhost(s). 85275970Scy.TP 86275970Scy.NOP \f\*[B-Font]\-d\f[], \f\*[B-Font]\-\-debug\-level\f[] 87275970ScyIncrease debug verbosity level. 88275970ScyThis option may appear an unlimited number of times. 89275970Scy.sp 90275970Scy.TP 91275970Scy.NOP \f\*[B-Font]\-D\f[] \f\*[I-Font]number\f[], \f\*[B-Font]\-\-set\-debug\-level\f[]=\f\*[I-Font]number\f[] 92275970ScySet the debug verbosity level. 93275970ScyThis option may appear an unlimited number of times. 94275970ScyThis option takes an integer number as its argument. 95275970Scy.sp 96275970Scy.TP 97275970Scy.NOP \f\*[B-Font]\-i\f[], \f\*[B-Font]\-\-interactive\f[] 98275970ScyForce ntpq to operate in interactive mode. 99275970ScyThis option must not appear in combination with any of the following options: 100275970Scycommand, listpeers, peers, showpeers. 101275970Scy.sp 102275970ScyForce ntpq to operate in interactive mode. Prompts will be written 103275970Scyto the standard output and commands read from the standard input. 104275970Scy.TP 105275970Scy.NOP \f\*[B-Font]\-l\f[], \f\*[B-Font]\-\-listpeers\f[] 106275970ScyPrint a list of the peers. 107275970ScyThis option must not appear in combination with any of the following options: 108275970Scycommand. 109275970Scy.sp 110275970ScyPrint a list of the peers known to the server as well as a summary of 111275970Scytheir state. This is equivalent to the 'listpeers' interactive command. 112275970Scy.TP 113275970Scy.NOP \f\*[B-Font]\-n\f[], \f\*[B-Font]\-\-numeric\f[] 114275970Scynumeric host addresses. 115275970Scy.sp 116275970ScyOutput all host addresses in dotted-quad numeric format rather than 117275970Scyconverting to the canonical host names. 118275970Scy.TP 119275970Scy.NOP \f\*[B-Font]\-p\f[], \f\*[B-Font]\-\-peers\f[] 120275970ScyPrint a list of the peers. 121275970ScyThis option must not appear in combination with any of the following options: 122275970Scycommand. 123275970Scy.sp 124275970ScyPrint a list of the peers known to the server as well as a summary 125275970Scyof their state. This is equivalent to the 'peers' interactive command. 126275970Scy.TP 127275970Scy.NOP \f\*[B-Font]\-s\f[], \f\*[B-Font]\-\-showpeers\f[] 128275970ScyShow a list of the peers. 129275970ScyThis option must not appear in combination with any of the following options: 130275970Scycommand. 131275970Scy.sp 132275970ScyPrint a list of the peers known to the server as well as a summary 133275970Scyof their state. This is equivalent to the 'dmpeers' interactive command. 134275970Scy.TP 135275970Scy.NOP \f\*[B-Font]\-\&?\f[], \f\*[B-Font]\-\-help\f[] 136275970ScyDisplay usage information and exit. 137275970Scy.TP 138275970Scy.NOP \f\*[B-Font]\-\&!\f[], \f\*[B-Font]\-\-more-help\f[] 139275970ScyPass the extended usage information through a pager. 140275970Scy.TP 141275970Scy.NOP \f\*[B-Font]\->\f[] [\f\*[I-Font]cfgfile\f[]], \f\*[B-Font]\-\-save-opts\f[] [=\f\*[I-Font]cfgfile\f[]] 142275970ScySave the option state to \fIcfgfile\fP. The default is the \fIlast\fP 143275970Scyconfiguration file listed in the \fBOPTION PRESETS\fP section, below. 144275970ScyThe command will exit after updating the config file. 145275970Scy.TP 146275970Scy.NOP \f\*[B-Font]\-<\f[] \f\*[I-Font]cfgfile\f[], \f\*[B-Font]\-\-load-opts\f[]=\f\*[I-Font]cfgfile\f[], \f\*[B-Font]\-\-no-load-opts\f[] 147275970ScyLoad options from \fIcfgfile\fP. 148275970ScyThe \fIno-load-opts\fP form will disable the loading 149275970Scyof earlier config/rc/ini files. \fI\-\-no-load-opts\fP is handled early, 150275970Scyout of order. 151275970Scy.TP 152275970Scy.NOP \f\*[B-Font]\-\-version\f[] [{\f\*[I-Font]v|c|n\f[]}] 153275970ScyOutput version of program and exit. The default mode is `v', a simple 154275970Scyversion. The `c' mode will print copyright information and `n' will 155275970Scyprint the full copyright notice. 156275970Scy.PP 157275970Scy.SH "OPTION PRESETS" 158275970ScyAny option that is not marked as \fInot presettable\fP may be preset 159275970Scyby loading values from configuration ("RC" or ".INI") file(s) and values from 160275970Scyenvironment variables named: 161275970Scy.nf 162275970Scy \fBNTPDC_<option-name>\fP or \fBNTPDC\fP 163275970Scy.fi 164275970Scy.ad 165275970ScyThe environmental presets take precedence (are processed later than) 166275970Scythe configuration files. 167275970ScyThe \fIhomerc\fP files are "\fI$HOME\fP", and "\fI.\fP". 168275970ScyIf any of these are directories, then the file \fI.ntprc\fP 169275970Scyis searched for within those directories. 170275970Scy.SH USAGE 171275970ScyIf one or more request options are included on the command line 172275970Scywhen 173275970Scy\f\*[B-Font]ntpdc\fP 174275970Scyis executed, each of the requests will be sent 175275970Scyto the NTP servers running on each of the hosts given as command 176275970Scyline arguments, or on localhost by default. 177275970ScyIf no request options 178275970Scyare given, 179275970Scy\f\*[B-Font]ntpdc\fP 180275970Scywill attempt to read commands from the 181275970Scystandard input and execute these on the NTP server running on the 182275970Scyfirst host given on the command line, again defaulting to localhost 183275970Scywhen no other host is specified. 184275970ScyThe 185275970Scy\f\*[B-Font]ntpdc\fP 186275970Scyutility will prompt for 187275970Scycommands if the standard input is a terminal device. 188275970Scy.sp \n(Ppu 189275970Scy.ne 2 190275970Scy 191275970ScyThe 192275970Scy\f\*[B-Font]ntpdc\fP 193275970Scyutility uses NTP mode 7 packets to communicate with the 194275970ScyNTP server, and hence can be used to query any compatible server on 195275970Scythe network which permits it. 196275970ScyNote that since NTP is a UDP protocol 197275970Scythis communication will be somewhat unreliable, especially over 198275970Scylarge distances in terms of network topology. 199275970ScyThe 200275970Scy\f\*[B-Font]ntpdc\fP 201275970Scyutility makes 202275970Scyno attempt to retransmit requests, and will time requests out if 203275970Scythe remote host is not heard from within a suitable timeout 204275970Scytime. 205275970Scy.sp \n(Ppu 206275970Scy.ne 2 207275970Scy 208275970ScyThe operation of 209275970Scy\f\*[B-Font]ntpdc\fP 210275970Scyare specific to the particular 211275970Scyimplementation of the 212285169Scy\fCntpd\f[]\fR(@NTPD_MS@)\f[] 213275970Scydaemon and can be expected to 214275970Scywork only with this and maybe some previous versions of the daemon. 215275970ScyRequests from a remote 216275970Scy\f\*[B-Font]ntpdc\fP 217275970Scyutility which affect the 218275970Scystate of the local server must be authenticated, which requires 219275970Scyboth the remote program and local server share a common key and key 220275970Scyidentifier. 221275970Scy.sp \n(Ppu 222275970Scy.ne 2 223275970Scy 224275970ScyNote that in contexts where a host name is expected, a 225275970Scy\f\*[B-Font]\-4\f[] 226275970Scyqualifier preceding the host name forces DNS resolution to the IPv4 namespace, 227275970Scywhile a 228275970Scy\f\*[B-Font]\-6\f[] 229275970Scyqualifier forces DNS resolution to the IPv6 namespace. 230275970ScySpecifying a command line option other than 231275970Scy\f\*[B-Font]\-i\f[] 232275970Scyor 233275970Scy\f\*[B-Font]\-n\f[] 234275970Scywill cause the specified query (queries) to be sent to 235275970Scythe indicated host(s) immediately. 236275970ScyOtherwise, 237275970Scy\f\*[B-Font]ntpdc\fP 238275970Scywill 239275970Scyattempt to read interactive format commands from the standard 240275970Scyinput. 241275970Scy.SS "Interactive Commands" 242275970ScyInteractive format commands consist of a keyword followed by zero 243275970Scyto four arguments. 244275970ScyOnly enough characters of the full keyword to 245275970Scyuniquely identify the command need be typed. 246275970ScyThe output of a 247275970Scycommand is normally sent to the standard output, but optionally the 248275970Scyoutput of individual commands may be sent to a file by appending a 249275970Scy\[oq]\&>\[cq], 250275970Scyfollowed by a file name, to the command line. 251275970Scy.sp \n(Ppu 252275970Scy.ne 2 253275970Scy 254275970ScyA number of interactive format commands are executed entirely 255275970Scywithin the 256275970Scy\f\*[B-Font]ntpdc\fP 257275970Scyutility itself and do not result in NTP 258275970Scymode 7 requests being sent to a server. 259275970ScyThese are described 260275970Scyfollowing. 261275970Scy.TP 7 262275970Scy.NOP \f\*[B-Font]\&?\f[] \f\*[I-Font]command_keyword\f[] 263275970Scy.TP 7 264275970Scy.NOP \f\*[B-Font]help\f[] \f\*[I-Font]command_keyword\f[] 265275970ScyA 266275970Scy\[oq]\f\*[B-Font]\&?\f[]\[cq] 267275970Scywill print a list of all the command 268275970Scykeywords known to this incarnation of 269275970Scy\f\*[B-Font]ntpdc\fP. 270275970ScyA 271275970Scy\[oq]\f\*[B-Font]\&?\f[]\[cq] 272275970Scyfollowed by a command keyword will print function and usage 273275970Scyinformation about the command. 274275970ScyThis command is probably a better 275275970Scysource of information about 276285169Scy\fCntpq\f[]\fR(@NTPQ_MS@)\f[] 277275970Scythan this manual 278275970Scypage. 279275970Scy.TP 7 280275970Scy.NOP \f\*[B-Font]delay\f[] \f\*[I-Font]milliseconds\f[] 281275970ScySpecify a time interval to be added to timestamps included in 282275970Scyrequests which require authentication. 283275970ScyThis is used to enable 284275970Scy(unreliable) server reconfiguration over long delay network paths 285275970Scyor between machines whose clocks are unsynchronized. 286275970ScyActually the 287275970Scyserver does not now require timestamps in authenticated requests, 288275970Scyso this command may be obsolete. 289275970Scy.TP 7 290275970Scy.NOP \f\*[B-Font]host\f[] \f\*[I-Font]hostname\f[] 291275970ScySet the host to which future queries will be sent. 292275970ScyHostname may 293275970Scybe either a host name or a numeric address. 294275970Scy.TP 7 295275970Scy.NOP \f\*[B-Font]hostnames\f[] [\f\*[B-Font]yes\f[] | \f\*[B-Font]no\f[]] 296275970ScyIf 297275970Scy\f\*[B-Font]yes\f[] 298275970Scyis specified, host names are printed in 299275970Scyinformation displays. 300275970ScyIf 301275970Scy\f\*[B-Font]no\f[] 302275970Scyis specified, numeric 303275970Scyaddresses are printed instead. 304275970ScyThe default is 305275970Scy\f\*[B-Font]yes\f[], 306275970Scyunless 307275970Scymodified using the command line 308275970Scy\f\*[B-Font]\-n\f[] 309275970Scyswitch. 310275970Scy.TP 7 311275970Scy.NOP \f\*[B-Font]keyid\f[] \f\*[I-Font]keyid\f[] 312275970ScyThis command allows the specification of a key number to be 313275970Scyused to authenticate configuration requests. 314275970ScyThis must correspond 315275970Scyto a key number the server has been configured to use for this 316275970Scypurpose. 317275970Scy.TP 7 318275970Scy.NOP \f\*[B-Font]quit\f[] 319275970ScyExit 320275970Scy\f\*[B-Font]ntpdc\fP. 321275970Scy.TP 7 322275970Scy.NOP \f\*[B-Font]passwd\f[] 323275970ScyThis command prompts you to type in a password (which will not 324275970Scybe echoed) which will be used to authenticate configuration 325275970Scyrequests. 326275970ScyThe password must correspond to the key configured for 327275970Scyuse by the NTP server for this purpose if such requests are to be 328275970Scysuccessful. 329275970Scy.TP 7 330275970Scy.NOP \f\*[B-Font]timeout\f[] \f\*[I-Font]milliseconds\f[] 331275970ScySpecify a timeout period for responses to server queries. 332275970ScyThe 333275970Scydefault is about 8000 milliseconds. 334275970ScyNote that since 335275970Scy\f\*[B-Font]ntpdc\fP 336275970Scyretries each query once after a timeout, the total waiting time for 337275970Scya timeout will be twice the timeout value set. 338275970Scy.PP 339275970Scy.SS "Control Message Commands" 340275970ScyQuery commands result in NTP mode 7 packets containing requests for 341275970Scyinformation being sent to the server. 342275970ScyThese are read-only commands 343275970Scyin that they make no modification of the server configuration 344275970Scystate. 345275970Scy.TP 7 346275970Scy.NOP \f\*[B-Font]listpeers\f[] 347275970ScyObtains and prints a brief list of the peers for which the 348275970Scyserver is maintaining state. 349275970ScyThese should include all configured 350275970Scypeer associations as well as those peers whose stratum is such that 351275970Scythey are considered by the server to be possible future 352275970Scysynchronization candidates. 353275970Scy.TP 7 354275970Scy.NOP \f\*[B-Font]peers\f[] 355275970ScyObtains a list of peers for which the server is maintaining 356275970Scystate, along with a summary of that state. 357275970ScySummary information 358275970Scyincludes the address of the remote peer, the local interface 359275970Scyaddress (0.0.0.0 if a local address has yet to be determined), the 360275970Scystratum of the remote peer (a stratum of 16 indicates the remote 361275970Scypeer is unsynchronized), the polling interval, in seconds, the 362275970Scyreachability register, in octal, and the current estimated delay, 363275970Scyoffset and dispersion of the peer, all in seconds. 364275970Scy.sp \n(Ppu 365275970Scy.ne 2 366275970Scy 367275970ScyThe character in the left margin indicates the mode this peer 368275970Scyentry is operating in. 369275970ScyA 370275970Scy\[oq]\&+\[cq] 371275970Scydenotes symmetric active, a 372275970Scy\[oq]\&-\[cq] 373275970Scyindicates symmetric passive, a 374275970Scy\[oq]\&=\[cq] 375275970Scymeans the 376275970Scyremote server is being polled in client mode, a 377275970Scy\[oq]\&^\[cq] 378275970Scyindicates that the server is broadcasting to this address, a 379275970Scy\[oq]\&~\[cq] 380275970Scydenotes that the remote peer is sending broadcasts and a 381275970Scy\[oq]\&~\[cq] 382275970Scydenotes that the remote peer is sending broadcasts and a 383275970Scy\[oq]\&*\[cq] 384275970Scymarks the peer the server is currently synchronizing 385275970Scyto. 386275970Scy.sp \n(Ppu 387275970Scy.ne 2 388275970Scy 389275970ScyThe contents of the host field may be one of four forms. 390275970ScyIt may 391275970Scybe a host name, an IP address, a reference clock implementation 392275970Scyname with its parameter or 393285169Scy\fBREFCLK\f[]\fR()\f[] 394275970ScyOn 395275970Scy\f\*[B-Font]hostnames\f[] 396275970Scy\f\*[B-Font]no\f[] 397275970Scyonly IP-addresses 398275970Scywill be displayed. 399275970Scy.TP 7 400275970Scy.NOP \f\*[B-Font]dmpeers\f[] 401275970ScyA slightly different peer summary list. 402275970ScyIdentical to the output 403275970Scyof the 404275970Scy\f\*[B-Font]peers\f[] 405275970Scycommand, except for the character in the 406275970Scyleftmost column. 407275970ScyCharacters only appear beside peers which were 408275970Scyincluded in the final stage of the clock selection algorithm. 409275970ScyA 410275970Scy\[oq]\&.\[cq] 411275970Scyindicates that this peer was cast off in the falseticker 412275970Scydetection, while a 413275970Scy\[oq]\&+\[cq] 414275970Scyindicates that the peer made it 415275970Scythrough. 416275970ScyA 417275970Scy\[oq]\&*\[cq] 418275970Scydenotes the peer the server is currently 419275970Scysynchronizing with. 420275970Scy.TP 7 421275970Scy.NOP \f\*[B-Font]showpeer\f[] \f\*[I-Font]peer_address\f[] [\f\*[I-Font]...\f[]] 422275970ScyShows a detailed display of the current peer variables for one 423275970Scyor more peers. 424275970ScyMost of these values are described in the NTP 425275970ScyVersion 2 specification. 426275970Scy.TP 7 427275970Scy.NOP \f\*[B-Font]pstats\f[] \f\*[I-Font]peer_address\f[] [\f\*[I-Font]...\f[]] 428275970ScyShow per-peer statistic counters associated with the specified 429275970Scypeer(s). 430275970Scy.TP 7 431275970Scy.NOP \f\*[B-Font]clockstat\f[] \f\*[I-Font]clock_peer_address\f[] [\f\*[I-Font]...\f[]] 432275970ScyObtain and print information concerning a peer clock. 433275970ScyThe 434275970Scyvalues obtained provide information on the setting of fudge factors 435275970Scyand other clock performance information. 436275970Scy.TP 7 437275970Scy.NOP \f\*[B-Font]kerninfo\f[] 438275970ScyObtain and print kernel phase-lock loop operating parameters. 439275970ScyThis information is available only if the kernel has been specially 440275970Scymodified for a precision timekeeping function. 441275970Scy.TP 7 442275970Scy.NOP \f\*[B-Font]loopinfo\f[] [\f\*[B-Font]oneline\f[] | \f\*[B-Font]multiline\f[]] 443275970ScyPrint the values of selected loop filter variables. 444275970ScyThe loop 445275970Scyfilter is the part of NTP which deals with adjusting the local 446275970Scysystem clock. 447275970ScyThe 448275970Scy\[oq]offset\[cq] 449275970Scyis the last offset given to the 450275970Scyloop filter by the packet processing code. 451275970ScyThe 452275970Scy\[oq]frequency\[cq] 453275970Scyis the frequency error of the local clock in parts-per-million 454275970Scy(ppm). 455275970ScyThe 456275970Scy\[oq]time_const\[cq] 457275970Scycontrols the stiffness of the 458275970Scyphase-lock loop and thus the speed at which it can adapt to 459275970Scyoscillator drift. 460275970ScyThe 461275970Scy\[oq]watchdog timer\[cq] 462275970Scyvalue is the number 463275970Scyof seconds which have elapsed since the last sample offset was 464275970Scygiven to the loop filter. 465275970ScyThe 466275970Scy\f\*[B-Font]oneline\f[] 467275970Scyand 468275970Scy\f\*[B-Font]multiline\f[] 469275970Scyoptions specify the format in which this 470275970Scyinformation is to be printed, with 471275970Scy\f\*[B-Font]multiline\f[] 472275970Scyas the 473275970Scydefault. 474275970Scy.TP 7 475275970Scy.NOP \f\*[B-Font]sysinfo\f[] 476275970ScyPrint a variety of system state variables, i.e., state related 477275970Scyto the local server. 478275970ScyAll except the last four lines are described 479275970Scyin the NTP Version 3 specification, RFC-1305. 480275970Scy.sp \n(Ppu 481275970Scy.ne 2 482275970Scy 483275970ScyThe 484275970Scy\[oq]system flags\[cq] 485275970Scyshow various system flags, some of 486275970Scywhich can be set and cleared by the 487275970Scy\f\*[B-Font]enable\f[] 488275970Scyand 489275970Scy\f\*[B-Font]disable\f[] 490275970Scyconfiguration commands, respectively. 491275970ScyThese are 492275970Scythe 493275970Scy\f\*[B-Font]auth\f[], 494275970Scy\f\*[B-Font]bclient\f[], 495275970Scy\f\*[B-Font]monitor\f[], 496275970Scy\f\*[B-Font]pll\f[], 497275970Scy\f\*[B-Font]pps\f[] 498275970Scyand 499275970Scy\f\*[B-Font]stats\f[] 500275970Scyflags. 501275970ScySee the 502285169Scy\fCntpd\f[]\fR(@NTPD_MS@)\f[] 503275970Scydocumentation for the meaning of these flags. 504275970ScyThere 505275970Scyare two additional flags which are read only, the 506275970Scy\f\*[B-Font]kernel_pll\f[] 507275970Scyand 508275970Scy\f\*[B-Font]kernel_pps\f[]. 509275970ScyThese flags indicate 510275970Scythe synchronization status when the precision time kernel 511275970Scymodifications are in use. 512275970ScyThe 513275970Scy\[oq]kernel_pll\[cq] 514275970Scyindicates that 515275970Scythe local clock is being disciplined by the kernel, while the 516275970Scy\[oq]kernel_pps\[cq] 517275970Scyindicates the kernel discipline is provided by the PPS 518275970Scysignal. 519275970Scy.sp \n(Ppu 520275970Scy.ne 2 521275970Scy 522275970ScyThe 523275970Scy\[oq]stability\[cq] 524275970Scyis the residual frequency error remaining 525275970Scyafter the system frequency correction is applied and is intended for 526275970Scymaintenance and debugging. 527275970ScyIn most architectures, this value will 528275970Scyinitially decrease from as high as 500 ppm to a nominal value in 529275970Scythe range .01 to 0.1 ppm. 530275970ScyIf it remains high for some time after 531275970Scystarting the daemon, something may be wrong with the local clock, 532275970Scyor the value of the kernel variable 533275970Scy\fIkern.clockrate.tick\f[] 534275970Scymay be 535275970Scyincorrect. 536275970Scy.sp \n(Ppu 537275970Scy.ne 2 538275970Scy 539275970ScyThe 540275970Scy\[oq]broadcastdelay\[cq] 541275970Scyshows the default broadcast delay, 542275970Scyas set by the 543275970Scy\f\*[B-Font]broadcastdelay\f[] 544275970Scyconfiguration command. 545275970Scy.sp \n(Ppu 546275970Scy.ne 2 547275970Scy 548275970ScyThe 549275970Scy\[oq]authdelay\[cq] 550275970Scyshows the default authentication delay, 551275970Scyas set by the 552275970Scy\f\*[B-Font]authdelay\f[] 553275970Scyconfiguration command. 554275970Scy.TP 7 555275970Scy.NOP \f\*[B-Font]sysstats\f[] 556275970ScyPrint statistics counters maintained in the protocol 557275970Scymodule. 558275970Scy.TP 7 559275970Scy.NOP \f\*[B-Font]memstats\f[] 560275970ScyPrint statistics counters related to memory allocation 561275970Scycode. 562275970Scy.TP 7 563275970Scy.NOP \f\*[B-Font]iostats\f[] 564275970ScyPrint statistics counters maintained in the input-output 565275970Scymodule. 566275970Scy.TP 7 567275970Scy.NOP \f\*[B-Font]timerstats\f[] 568275970ScyPrint statistics counters maintained in the timer/event queue 569275970Scysupport code. 570275970Scy.TP 7 571275970Scy.NOP \f\*[B-Font]reslist\f[] 572275970ScyObtain and print the server's restriction list. 573275970ScyThis list is 574275970Scy(usually) printed in sorted order and may help to understand how 575275970Scythe restrictions are applied. 576275970Scy.TP 7 577275970Scy.NOP \f\*[B-Font]monlist\f[] [\f\*[I-Font]version\f[]] 578275970ScyObtain and print traffic counts collected and maintained by the 579275970Scymonitor facility. 580275970ScyThe version number should not normally need to be 581275970Scyspecified. 582275970Scy.TP 7 583275970Scy.NOP \f\*[B-Font]clkbug\f[] \f\*[I-Font]clock_peer_address\f[] [\f\*[I-Font]...\f[]] 584275970ScyObtain debugging information for a reference clock driver. 585275970ScyThis 586275970Scyinformation is provided only by some clock drivers and is mostly 587275970Scyundecodable without a copy of the driver source in hand. 588275970Scy.PP 589275970Scy.SS "Runtime Configuration Requests" 590275970ScyAll requests which cause state changes in the server are 591275970Scyauthenticated by the server using a configured NTP key (the 592275970Scyfacility can also be disabled by the server by not configuring a 593275970Scykey). 594275970ScyThe key number and the corresponding key must also be made 595275970Scyknown to 596275970Scy\f\*[B-Font]ntpdc\fP. 597275970ScyThis can be done using the 598275970Scy\f\*[B-Font]keyid\f[] 599275970Scyand 600275970Scy\f\*[B-Font]passwd\f[] 601275970Scycommands, the latter of which will prompt at the terminal for a 602275970Scypassword to use as the encryption key. 603275970ScyYou will also be prompted 604275970Scyautomatically for both the key number and password the first time a 605275970Scycommand which would result in an authenticated request to the 606275970Scyserver is given. 607275970ScyAuthentication not only provides verification that 608275970Scythe requester has permission to make such changes, but also gives 609275970Scyan extra degree of protection again transmission errors. 610275970Scy.sp \n(Ppu 611275970Scy.ne 2 612275970Scy 613275970ScyAuthenticated requests always include a timestamp in the packet 614275970Scydata, which is included in the computation of the authentication 615275970Scycode. 616275970ScyThis timestamp is compared by the server to its receive time 617275970Scystamp. 618275970ScyIf they differ by more than a small amount the request is 619275970Scyrejected. 620275970ScyThis is done for two reasons. 621275970ScyFirst, it makes simple 622275970Scyreplay attacks on the server, by someone who might be able to 623275970Scyoverhear traffic on your LAN, much more difficult. 624275970ScySecond, it makes 625275970Scyit more difficult to request configuration changes to your server 626275970Scyfrom topologically remote hosts. 627275970ScyWhile the reconfiguration facility 628275970Scywill work well with a server on the local host, and may work 629275970Scyadequately between time-synchronized hosts on the same LAN, it will 630275970Scywork very poorly for more distant hosts. 631275970ScyAs such, if reasonable 632275970Scypasswords are chosen, care is taken in the distribution and 633275970Scyprotection of keys and appropriate source address restrictions are 634275970Scyapplied, the run time reconfiguration facility should provide an 635275970Scyadequate level of security. 636275970Scy.sp \n(Ppu 637275970Scy.ne 2 638275970Scy 639275970ScyThe following commands all make authenticated requests. 640275970Scy.TP 7 641275970Scy.NOP \f\*[B-Font]addpeer\f[] \f\*[I-Font]peer_address\f[] [\f\*[I-Font]keyid\f[]] [\f\*[I-Font]version\f[]] [\f\*[B-Font]prefer\f[]] 642275970ScyAdd a configured peer association at the given address and 643275970Scyoperating in symmetric active mode. 644275970ScyNote that an existing 645275970Scyassociation with the same peer may be deleted when this command is 646275970Scyexecuted, or may simply be converted to conform to the new 647275970Scyconfiguration, as appropriate. 648275970ScyIf the optional 649275970Scy\f\*[I-Font]keyid\f[] 650275970Scyis a 651275970Scynonzero integer, all outgoing packets to the remote server will 652275970Scyhave an authentication field attached encrypted with this key. 653275970ScyIf 654275970Scythe value is 0 (or not given) no authentication will be done. 655275970ScyThe 656275970Scy\f\*[I-Font]version\f[] 657275970Scycan be 1, 2 or 3 and defaults to 3. 658275970ScyThe 659275970Scy\f\*[B-Font]prefer\f[] 660275970Scykeyword indicates a preferred peer (and thus will 661275970Scybe used primarily for clock synchronisation if possible). 662275970ScyThe 663275970Scypreferred peer also determines the validity of the PPS signal \- if 664275970Scythe preferred peer is suitable for synchronisation so is the PPS 665275970Scysignal. 666275970Scy.TP 7 667275970Scy.NOP \f\*[B-Font]addserver\f[] \f\*[I-Font]peer_address\f[] [\f\*[I-Font]keyid\f[]] [\f\*[I-Font]version\f[]] [\f\*[B-Font]prefer\f[]] 668275970ScyIdentical to the addpeer command, except that the operating 669275970Scymode is client. 670275970Scy.TP 7 671275970Scy.NOP \f\*[B-Font]broadcast\f[] \f\*[I-Font]peer_address\f[] [\f\*[I-Font]keyid\f[]] [\f\*[I-Font]version\f[]] [\f\*[B-Font]prefer\f[]] 672275970ScyIdentical to the addpeer command, except that the operating 673275970Scymode is broadcast. 674275970ScyIn this case a valid key identifier and key are 675275970Scyrequired. 676275970ScyThe 677275970Scy\f\*[I-Font]peer_address\f[] 678275970Scyparameter can be the broadcast 679275970Scyaddress of the local network or a multicast group address assigned 680275970Scyto NTP. 681275970ScyIf a multicast address, a multicast-capable kernel is 682275970Scyrequired. 683275970Scy.TP 7 684275970Scy.NOP \f\*[B-Font]unconfig\f[] \f\*[I-Font]peer_address\f[] [\f\*[I-Font]...\f[]] 685275970ScyThis command causes the configured bit to be removed from the 686275970Scyspecified peer(s). 687275970ScyIn many cases this will cause the peer 688275970Scyassociation to be deleted. 689275970ScyWhen appropriate, however, the 690275970Scyassociation may persist in an unconfigured mode if the remote peer 691275970Scyis willing to continue on in this fashion. 692275970Scy.TP 7 693275970Scy.NOP \f\*[B-Font]fudge\f[] \f\*[I-Font]peer_address\f[] [\f\*[B-Font]time1\f[]] [\f\*[B-Font]time2\f[]] [\f\*[I-Font]stratum\f[]] [\f\*[I-Font]refid\f[]] 694275970ScyThis command provides a way to set certain data for a reference 695275970Scyclock. 696275970ScySee the source listing for further information. 697275970Scy.TP 7 698275970Scy.NOP \f\*[B-Font]enable\f[] [\f\*[B-Font]auth\f[] | \f\*[B-Font]bclient\f[] | \f\*[B-Font]calibrate\f[] | \f\*[B-Font]kernel\f[] | \f\*[B-Font]monitor\f[] | \f\*[B-Font]ntp\f[] | \f\*[B-Font]pps\f[] | \f\*[B-Font]stats\f[]] 699275970Scy.TP 7 700275970Scy.NOP \f\*[B-Font]disable\f[] [\f\*[B-Font]auth\f[] | \f\*[B-Font]bclient\f[] | \f\*[B-Font]calibrate\f[] | \f\*[B-Font]kernel\f[] | \f\*[B-Font]monitor\f[] | \f\*[B-Font]ntp\f[] | \f\*[B-Font]pps\f[] | \f\*[B-Font]stats\f[]] 701275970ScyThese commands operate in the same way as the 702275970Scy\f\*[B-Font]enable\f[] 703275970Scyand 704275970Scy\f\*[B-Font]disable\f[] 705275970Scyconfiguration file commands of 706285169Scy\fCntpd\f[]\fR(@NTPD_MS@)\f[]. 707275970Scy.RS 708275970Scy.TP 7 709275970Scy.NOP \f\*[B-Font]auth\f[] 710275970ScyEnables the server to synchronize with unconfigured peers only 711275970Scyif the peer has been correctly authenticated using either public key 712275970Scyor private key cryptography. 713275970ScyThe default for this flag is enable. 714275970Scy.TP 7 715275970Scy.NOP \f\*[B-Font]bclient\f[] 716275970ScyEnables the server to listen for a message from a broadcast or 717275970Scymulticast server, as in the multicastclient command with 718275970Scydefault address. 719275970ScyThe default for this flag is disable. 720275970Scy.TP 7 721275970Scy.NOP \f\*[B-Font]calibrate\f[] 722275970ScyEnables the calibrate feature for reference clocks. 723275970ScyThe default for this flag is disable. 724275970Scy.TP 7 725275970Scy.NOP \f\*[B-Font]kernel\f[] 726275970ScyEnables the kernel time discipline, if available. 727275970ScyThe default for this flag is enable if support is available, otherwise disable. 728275970Scy.TP 7 729275970Scy.NOP \f\*[B-Font]monitor\f[] 730275970ScyEnables the monitoring facility. 731275970ScySee the documentation here about the 732275970Scy\f\*[B-Font]monlist\f[] 733275970Scycommand or further information. 734275970ScyThe default for this flag is enable. 735275970Scy.TP 7 736275970Scy.NOP \f\*[B-Font]ntp\f[] 737275970ScyEnables time and frequency discipline. 738275970ScyIn effect, this switch opens and closes the feedback loop, 739275970Scywhich is useful for testing. 740275970ScyThe default for this flag is enable. 741275970Scy.TP 7 742275970Scy.NOP \f\*[B-Font]pps\f[] 743275970ScyEnables the pulse-per-second (PPS) signal when frequency 744275970Scyand time is disciplined by the precision time kernel modifications. 745275970ScySee the 746275970Scy"A Kernel Model for Precision Timekeeping" 747275970Scy(available as part of the HTML documentation 748275970Scyprovided in 749275970Scy\fI/usr/share/doc/ntp\f[]) 750275970Scypage for further information. 751275970ScyThe default for this flag is disable. 752275970Scy.TP 7 753275970Scy.NOP \f\*[B-Font]stats\f[] 754275970ScyEnables the statistics facility. 755275970ScySee the 756275970Scy\fIMonitoring\f[] \fIOptions\f[] 757275970Scysection of 758285169Scy\fCntp.conf\f[]\fR(5)\f[] 759275970Scyfor further information. 760275970ScyThe default for this flag is disable. 761275970Scy.RE 762275970Scy.TP 7 763275970Scy.NOP \f\*[B-Font]restrict\f[] \f\*[I-Font]address\f[] \f\*[I-Font]mask\f[] \f\*[I-Font]flag\f[] [\f\*[I-Font]...\f[]] 764275970ScyThis command operates in the same way as the 765275970Scy\f\*[B-Font]restrict\f[] 766275970Scyconfiguration file commands of 767285169Scy\fCntpd\f[]\fR(@NTPD_MS@)\f[]. 768275970Scy.TP 7 769275970Scy.NOP \f\*[B-Font]unrestrict\f[] \f\*[I-Font]address\f[] \f\*[I-Font]mask\f[] \f\*[I-Font]flag\f[] [\f\*[I-Font]...\f[]] 770275970ScyUnrestrict the matching entry from the restrict list. 771275970Scy.TP 7 772275970Scy.NOP \f\*[B-Font]delrestrict\f[] \f\*[I-Font]address\f[] \f\*[I-Font]mask\f[] [\f\*[B-Font]ntpport\f[]] 773275970ScyDelete the matching entry from the restrict list. 774275970Scy.TP 7 775275970Scy.NOP \f\*[B-Font]readkeys\f[] 776275970ScyCauses the current set of authentication keys to be purged and 777275970Scya new set to be obtained by rereading the keys file (which must 778275970Scyhave been specified in the 779285169Scy\fCntpd\f[]\fR(@NTPD_MS@)\f[] 780275970Scyconfiguration file). 781275970ScyThis 782275970Scyallows encryption keys to be changed without restarting the 783275970Scyserver. 784275970Scy.TP 7 785275970Scy.NOP \f\*[B-Font]trustedkey\f[] \f\*[I-Font]keyid\f[] [\f\*[I-Font]...\f[]] 786275970Scy.TP 7 787275970Scy.NOP \f\*[B-Font]untrustedkey\f[] \f\*[I-Font]keyid\f[] [\f\*[I-Font]...\f[]] 788275970ScyThese commands operate in the same way as the 789275970Scy\f\*[B-Font]trustedkey\f[] 790275970Scyand 791275970Scy\f\*[B-Font]untrustedkey\f[] 792275970Scyconfiguration file 793275970Scycommands of 794285169Scy\fCntpd\f[]\fR(@NTPD_MS@)\f[]. 795275970Scy.TP 7 796275970Scy.NOP \f\*[B-Font]authinfo\f[] 797275970ScyReturns information concerning the authentication module, 798275970Scyincluding known keys and counts of encryptions and decryptions 799275970Scywhich have been done. 800275970Scy.TP 7 801275970Scy.NOP \f\*[B-Font]traps\f[] 802275970ScyDisplay the traps set in the server. 803275970ScySee the source listing for 804275970Scyfurther information. 805275970Scy.TP 7 806275970Scy.NOP \f\*[B-Font]addtrap\f[] \f\*[I-Font]address\f[] [\f\*[I-Font]port\f[]] [\f\*[I-Font]interface\f[]] 807275970ScySet a trap for asynchronous messages. 808275970ScySee the source listing 809275970Scyfor further information. 810275970Scy.TP 7 811275970Scy.NOP \f\*[B-Font]clrtrap\f[] \f\*[I-Font]address\f[] [\f\*[I-Font]port\f[]] [\f\*[I-Font]interface\f[]] 812275970ScyClear a trap for asynchronous messages. 813275970ScySee the source listing 814275970Scyfor further information. 815275970Scy.TP 7 816275970Scy.NOP \f\*[B-Font]reset\f[] 817275970ScyClear the statistics counters in various modules of the server. 818275970ScySee the source listing for further information. 819275970Scy.PP 820275970Scy.SH "ENVIRONMENT" 821275970ScySee \fBOPTION PRESETS\fP for configuration environment variables. 822275970Scy.SH "FILES" 823275970ScySee \fBOPTION PRESETS\fP for configuration files. 824275970Scy.SH "EXIT STATUS" 825275970ScyOne of the following exit values will be returned: 826275970Scy.TP 827275970Scy.NOP 0 " (EXIT_SUCCESS)" 828275970ScySuccessful program execution. 829275970Scy.TP 830275970Scy.NOP 1 " (EXIT_FAILURE)" 831275970ScyThe operation failed or the command syntax was not valid. 832275970Scy.TP 833275970Scy.NOP 66 " (EX_NOINPUT)" 834275970ScyA specified configuration file could not be loaded. 835275970Scy.TP 836275970Scy.NOP 70 " (EX_SOFTWARE)" 837275970Scylibopts had an internal operational error. Please report 838275970Scyit to autogen-users@lists.sourceforge.net. Thank you. 839275970Scy.PP 840275970Scy.SH "SEE ALSO" 841285169Scy\fCntp.conf\f[]\fR(5)\f[], 842285169Scy\fCntpd\f[]\fR(@NTPD_MS@)\f[] 843275970ScyDavid L. Mills, 844275970Scy\fINetwork Time Protocol (Version 3)\fR, 845275970ScyRFC1305 846275970Scy.PP 847275970Scy 848275970Scy.SH AUTHORS 849275970ScyThe formatting directives in this document came from FreeBSD. 850275970Scy.SH "COPYRIGHT" 851316722SdelphijCopyright (C) 1992-2017 The University of Delaware and Network Time Foundation all rights reserved. 852275970ScyThis program is released under the terms of the NTP license, <http://ntp.org/license>. 853275970Scy.SH BUGS 854275970ScyThe 855275970Scy\f\*[B-Font]ntpdc\fP 856275970Scyutility is a crude hack. 857275970ScyMuch of the information it shows is 858275970Scydeadly boring and could only be loved by its implementer. 859275970ScyThe 860275970Scyprogram was designed so that new (and temporary) features were easy 861275970Scyto hack in, at great expense to the program's ease of use. 862275970ScyDespite 863275970Scythis, the program is occasionally useful. 864275970Scy.sp \n(Ppu 865275970Scy.ne 2 866275970Scy 867275970ScyPlease report bugs to http://bugs.ntp.org . 868275970Scy.sp \n(Ppu 869275970Scy.ne 2 870275970Scy 871275970ScyPlease send bug reports to: http://bugs.ntp.org, bugs@ntp.org 872275970Scy.SH "NOTES" 873275970ScyThis manual page was \fIAutoGen\fP-erated from the \fBntpdc\fP 874275970Scyoption definitions. 875