Instance-specific Configuration Options - Instance-specific Configuration Options

Instance-specific Configuration Options - Instance-specific Configuration Options - UG1602

Enhanced PTP User Guide (UG1602)

Document_ID

UG1602

Release_Date

2024-12-19

Revision

1.2 English

The following table shows the instance-specific configuration options for the NTP sync module. These must be in a section labeled with the instance name.

Table 1. Instance-specific Configuration Options for the NTP Sync Module
Option	Parameters	Description
priority	<number>	Relative priority of sync module instance.¹ Smaller values have higher priority. Default: 128.
sync_threshold	<number>	Threshold in nanoseconds of the offset from the clock source over a 60s period to be considered in sync (converged). Default: 10000000 ns. See also the `local_sync_threshold` option in Table 1.
ntp_poll_interval	<number>	Specifies how often the NTP daemon will be polled, in seconds. Default: 1.
ntp_key	<key-id> <key-value>	NTP authentication key ID and value. This is used to authenticate control requests with the NTP daemon: The key ID is an integer. It must be identified in the NTP configuration file, in the `trustedkey` and `requestkey` lists. The key value is a plain text ASCII string up to 31 characters long (i.e. an “m” key as defined by `ntpd`). It must appear in the /etc/ntp/keys file, identified by the key ID. There should be NO spaces in the authentication string. See NTP Authentication.
If the priority is specified in a generic section, outside of a specific (named) sync instance, the priority will apply to all sync modules of the same type. For example: `sync_module ntp namedntp1 namedntp2 [ntp] // this applies to all ntp type sync module instances priority 128 [namedntp1] // this applies only to this instance - and takes priority over any generic value priority 127 [namedntp2] // this applies only to this instance - and takes priority over any generic value priority 126`