|
|
|
|
|
|
|
|
HP-UX Reference Volume 2 of 5 > n
ntpq(1M) |
|
NAMEntpq — standard Network Time Protocol query program DESCRIPTIONntpq is used to query NTP servers about current state and to request changes in that state. The program may be run either in interactive mode or controlled using command line arguments. Requests to read and write arbitrary variables can be assembled, with raw and pretty-printed output options being available. ntpq can also obtain and print a list of peers in a common format by sending multiple queries to the server. If one or more request options is included on the command line when ntpq is executed, each of the requests will be sent to the NTP servers running on each of the hosts given as command line arguments, or on localhost by default. ntpq will run in the interactive mode if no request options are given. It will attempt to read interactive format commands from the standard input and execute these commands on the NTP server running on the first host given on the command line, again defaulting to localhost when no other host is specified. ntpq will prompt for commands if the standard input is a terminal device. ntpq uses NTP mode 6 packets to communicate with the NTP server, and hence can be used to query any compatible server on the network which permits it. Note that since NTP is a UDP protocol this communication will be somewhat unreliable, especially over large distances in terms of network topology. ntpq makes one attempt to retransmit requests, and will time requests out if the remote host is not heard from within a suitable timeout time. Command line options are described following.
INTERACTIVE INTERNAL COMMANDSInteractive 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 > followed by a file name, to the command line. A number of interactive format commands are executed entirely within the ntpq program itself and do not result in NTP mode 6 requests being sent to a server. These are described following. ? [ command_keyword ] A ? by itself will print a list of all the command keywords known to this incarnation of ntpq. A ? followed by a command keyword will print function and usage information about the command. timeout millseconds Specify a timeout period for responses to server queries. The default is about 5000 milliseconds. Note that since ntpq retries each query once after a timeout, the total waiting time for a timeout will be twice the timeout value set. host hostname Set the host to which future queries will be sent. Hostname may be either a host name or a numeric address. keyid # This command allows the specification of a key number to be used to authenticate configuration requests. This must correspond to a key number the server has been configured to use for this purpose. passwd This command prompts you to type in a password (which will not be echoed) which will be used to authenticate configuration requests. The password must correspond to the key configured for use by the NTP server for this purpose if such requests are to be successful. hostnames yes|no If yes is specified, host names are printed in information displays. If no is given, numeric addresses are printed instead. The default is yes unless modified using the command line -n switch. raw Causes all output from query commands to be printed as received from the remote server. The only formatting/interpretation done on the data is to transform nonascii data into a printable (but barely understandable) form. cooked Causes output from query commands to be cooked. Variables which are recognized by the server will have their values reformatted for human consumption. ntpversion 1|2|3 Sets the NTP version number which ntpq claims in packets. Defaults to 3. Note that mode 6 control messages (and modes, for that matter) didn't exist in NTP version 1. There appear to be no servers left which demand version 1. version Display the version of ntpq. keytype m|d set the authentication type to md5 [ m ] or des [ d ]. authenticate yes|no Normally ntpq does not authenticate requests unless they are write requests. The command authenticate yes causes ntpq to send authentication with all requests it makes. debug more|less|no Turns internal query program debugging on and off. quit Exit ntpq. CONTROL MESSAGE COMMANDSEach peer known to an NTP server has a 16 bit integer association identifier assigned to it. NTP control messages which carry peer variables must identify the peer to which the values correspond by including its association ID. An association ID of 0 is special, and indicates the variables are system variables, whose names are drawn from a separate name space. Control message commands result in one or more NTP mode 6 messages being sent to the server, and cause the data returned to be printed in some format. Most commands currently implemented send a single message and expect a single response. The current exceptions are the peers command, which will send a preprogrammed series of messages to obtain the data it needs, and the mreadlist and mreadvar commands, which will iterate over a range of associations. associations Obtains and prints a list of association identifiers and peer statuses for in-spec peers of the server being queried. The list is printed in columns. The first of these is an index numbering the associations from 1 for internal use; the second is the actual association identifier returned by the server; and the third is the status word for the peer. This is followed by a number of columns containing data decoded from the status word. Note that the data returned by the associations command is cached internally in ntpq. The index can be use when dealing with servers that use association identifiers which are hard for humans to type. The form &index may be used for any subsequent commands that require an association identifier as an argument. lassocations Obtains and prints a list of association identifiers and peer statuses for all associations for which the server is maintaining state. This command differs from the associations command only for servers which retain state for out-of-spec client associations (i.e. fuzzballs). Such associations are normally omitted from the display when the associations command is used, but are included in the output of lassociations passociations Prints association data concerning in-spec peers from the internally cached list of associations. This command performs identically to the associations except that it displays the internally stored data rather than making a new query. lpassociations Print data for all associations, including out-of-spec client associations, from the internally cached list of associations. This command differs from passociations only when dealing with fuzzballs. pstatus assocID Sends a read status request to the server for the given association. The status value, the names, and values of the peer variables returned will be printed. readvar [ assocID ] [ <variable_name>[,...] ] Requests that the values of the specified variables be returned by the server by sending a read variables request. If the association ID is omitted or is 0 the variables are system variables; otherwise they are peer variables and the values returned will be those of the corresponding peer. Omitting the variable list will send a request with no data which should induce the server to return a default display. rv [ assocID ] [ <variable_name>[,...] ] An easy-to-type short form for the readvar command. writevar assocID <variable_name>=<value>[,...] Like the readvar request, except the specified variables are written instead of read. readlist [ assocID ] Requests that the values of the variables in the internal variable list be returned by the server. If the association ID is omitted or is 0, the variables are assumed to be system variables; otherwise they are treated as peer variables. If the internal variable list is empty a request is sent without data, which should induce the remote server to return a default display. rl [ assocID ] An easy-to-type short form of the readlist command. mreadvar assocID assocID [ <variable_name>[,...] ] Like the readvar command except the query is done for each of a range of (nonzero) association IDs. This range is determined from the association list cached by the most recent associations command. mrv assocID assocID [ <variable_name>[,...] ] An easy-to-type short form of the mreadvar command. mreadlist assocID assocID Like the readlist command except the query is done for each of a range of (nonzero) association IDs. This range is determined from the association list cached by the most recent associations command. mrl assocID assocID An easy-to-type short form of the mreadlist command. clocklist [ assocID ] Requests for the server's clock variables to be sent. Servers which have a radio clock or other external synchronization will respond positively to this. If the association identifier is omitted or is 0, the request is for the variables of the system clock and will generally get a positive response from all servers with a clock. If the server treats clocks as pseudo-peers, and hence can possibly have more than one clock connected at once, referencing the appropriate peer association ID will show the variables of a particular clock. clockvar [ assocID ] [ <variable_name>[,...] ] Requests that a list of the server's clock variables be sent. Servers which have a radio clock or other external synchronization will respond positively to this. If the association identifier is omitted or is 0, the request is for the variables of the system clock and will generally get a positive response from all servers with a clock. If the server treats clocks as pseudo-peers, and hence can possibly have more than one clock connected at once, referencing the appropriate peer association ID will show the variables of a particular clock. Omitting the variable list will cause the server to return a default variable display. cv [ assocID ] [ <variable_name>[,...] ] An easy-to-type short form of the clockvar command. peers Obtains a list of in-spec peers of the server, along with a summary of each peer's state. Summary information includes the address of the remote peer, the reference ID (0.0.0.0 if the reference ID is unknown), the stratum of the remote peer, the polling interval, in seconds, the reachability register, in octal, and the current estimated delay, offset and dispersion of the peer, all in seconds. In addition, the character in the left margin indicates the fate of this peer in the clock selection algorithm. Characters only appear beside peers which were included in the final stage of the clock selection algorithm. A . indicates that this peer was cast off in the falseticker detection, while a + indicates that the peer made it through. A * denotes the peer with which the server is currently synchronizing. Note that since the peers command depends on the ability to parse the values in the responses it gets, it may fail to work from time to time with servers that poorly control the data formats. The contents of the host field may be one of four forms. It may be a host name, an IP address, a reference clock implementation name with its parameter, or REFCLK( <implementation number>, <parameter>). On hostnames no, only IP-addresses will be displayed. lpeers Like peers, except a summary is printed of all associations for which the server is maintaining state. This can produce a much longer list of peers from fuzzball servers. opeers An old form of the peers command with the reference ID replaced by the local interface address. lopeers An old form of the lpeers command with the reference ID replaced by the local interface address. |
||||||||||||||||||||||||||||||||||||
|
||
|
|
|
|||||||||||||
|
|||||||||||||
