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