NAME

ntp - the LCFG NTP component

DESCRIPTION

This object constructs all the necessary configuration files and starts the ntp time daemon.

The run method will run ntpdate and set the hardware clock, provided that the run_daemon resource was not set and so no daemon was started. This is useful on laptops, where a network connection may be unavailable or it may be undesirable to bring one up.

RESOURCES

run_daemon

This resource should be set to enable the ntp daemon. It should normally be set to on permanently connected machines and not set on normally disconnected machines (e.g. laptops). If no daemon is started then the component's run method can be used to resynchronise the machine's clock.

servers

A (space-separated) list of NTP servers.

peers

A (space-separated) list of NTP peers.

restrict_default
restrict_policy
restrict_localhost

Access restrictions to apply. restrict_default specifies what the global default is. restrict_policy allows for separate site-specific restrictions to be applied. restrict_localhost specifies what restrictions to apply to other things running on the machine itself. The component itself will inject its own appropriate restrictions for any configured servers and peers.

NOTE: if you don't specify a value for restrict_default and restrict_localhost then those restrictions are turned off. If no value is specified for restrict_policy then no restriction or unrestriction statement is generated in the daemon configuration.

minpoll
maxpoll

These two set the minpoll and maxpoll values for all the configured servers and peers. See the documentation in the ntp distribution for full details. The daemon will operate quite happily without these being set, so if in doubt leave them alone.

contextlabel

This resource does not actually affect the operation of the component, but instead is included in some of its messages. Setting it to some lcfg context-specific value might therefore be useful to the user.

configfile

The name of the daemon's (generated) configuration file.

driftfile

The name of the daemon's drift file.

pidfile

The name of the file into which the daemon should write its pid.

ntpd

The name of the daemon program.

ntpd_flags

Additional command-line flags to pass to the daemon.

ntpdate

The name of the ntpdate program.

tickadj

The name of the tickadj program.

raiseprio

Should the component attempt to raise the daemon's priority, so that other processes interfere less with timekeeping?

logconfig

Should the daemon do any logging? The value of this resource should be a list of valid logconfig keywords. If it's not set then no logging is done. See the standard NTP web documentation for details of what's required here.

statistics
statsdir
filegen_...

Should the daemon collect statistics? statistics says which we should collect, if any. statsdir says where they should go. filegen_thing which says how that particular statistic is to be handled. See the standard NTP web documentation for details of what's required here.

monitor

Should the daemon keep track of protocol requests, to be queried using ntpq's monlist command?

getaddr

A helper program used by the component itself. Do not set this resource unless you know what you're doing.

PLATFORMS

RedHat 7, RedHat 9, Fedora 3, Fedora 5. Previous versions ran on Solaris 2.6.