summaryrefslogtreecommitdiff
path: root/interface-definitions/service_ntp.xml.in
blob: c31b572bd9c3e8a15d1c379fa742802339d4e23e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
<?xml version="1.0"?>
<!-- NTP configuration -->
<interfaceDefinition>
  <node name="service">
    <children>
      <node name="ntp" owner="${vyos_conf_scripts_dir}/service_ntp.py">
        <properties>
          <help>Network Time Protocol (NTP) configuration</help>
          <priority>900</priority>
        </properties>
        <children>
          #include <include/allow-client.xml.i>
          #include <include/generic-interface.xml.i>
          #include <include/listen-address.xml.i>
          #include <include/interface/vrf.xml.i>
          <node name="timestamp">
            <properties>
              <help>Enable timestamping of packets in the NIC hardware</help>
            </properties>
            <children>
              <tagNode name="interface">
                <properties>
                  <help>Interface to enable timestamping on</help>
                  <completionHelp>
                    <script>${vyos_completion_dir}/list_interfaces</script>
                    <list>all</list>
                  </completionHelp>
                  <valueHelp>
                    <format>all</format>
                    <description>Select all interfaces</description>
                  </valueHelp>
                  <valueHelp>
                    <format>txt</format>
                    <description>Interface name</description>
                  </valueHelp>
                  <constraint>
                    #include <include/constraint/interface-name.xml.i>
                    <regex>all</regex>
                  </constraint>
                </properties>
                <children>
                  <leafNode name="receive-filter">
                    <properties>
                      <help>Selects which inbound packets are timestamped by the NIC</help>
                      <completionHelp>
                        <list>all ntp ptp none</list>
                      </completionHelp>
                      <valueHelp>
                        <format>all</format>
                        <description>All packets are timestamped</description>
                      </valueHelp>
                      <valueHelp>
                        <format>ntp</format>
                        <description>Only NTP packets are timestamped</description>
                      </valueHelp>
                      <valueHelp>
                        <format>ptp</format>
                        <description>Only PTP or NTP packets using the PTP transport are timestamped</description>
                      </valueHelp>
                      <valueHelp>
                        <format>none</format>
                        <description>No packet is timestamped</description>
                      </valueHelp>
                      <constraint>
                        <regex>(all|ntp|ptp|none)</regex>
                      </constraint>
                    </properties>
                  </leafNode>
                </children>
              </tagNode>
            </children>
          </node>
          <node name="ptp">
            <properties>
              <help>Enable Precision Time Protocol (PTP) transport</help>
            </properties>
            <children>
              #include <include/port-number.xml.i>
              <leafNode name="port">
                <defaultValue>319</defaultValue>
              </leafNode>
            </children>
          </node>
          <leafNode name="leap-second">
            <properties>
              <help>Leap second behavior</help>
              <completionHelp>
                <list>ignore smear system timezone</list>
              </completionHelp>
              <valueHelp>
                <format>ignore</format>
                <description>No correction is applied to the clock for the leap second</description>
              </valueHelp>
              <valueHelp>
                <format>smear</format>
                <description>Correct served time slowly be slewing instead of stepping</description>
              </valueHelp>
              <valueHelp>
                <format>system</format>
                <description>Kernel steps the system clock forward or backward</description>
              </valueHelp>
              <valueHelp>
                <format>timezone</format>
                <description>Use UTC timezone database to determine when will the next leap second occur</description>
              </valueHelp>
              <constraint>
                <regex>(ignore|smear|system|timezone)</regex>
              </constraint>
            </properties>
            <defaultValue>timezone</defaultValue>
          </leafNode>
          <tagNode name="server">
            <properties>
              <help>Network Time Protocol (NTP) server</help>
              <valueHelp>
                <format>ipv4</format>
                <description>IP address of NTP server</description>
              </valueHelp>
              <valueHelp>
                <format>ipv6</format>
                <description>IPv6 address of NTP server</description>
              </valueHelp>
              <valueHelp>
                <format>hostname</format>
                <description>Fully qualified domain name of NTP server</description>
              </valueHelp>
              <constraint>
                <validator name="ip-address"/>
                <validator name="fqdn"/>
              </constraint>
            </properties>
            <children>
              <leafNode name="noselect">
                <properties>
                  <help>Marks the server as unused</help>
                  <valueless/>
                </properties>
              </leafNode>
              <leafNode name="nts">
                <properties>
                  <help>Enable Network Time Security (NTS) for the server</help>
                  <valueless/>
                </properties>
              </leafNode>
              <leafNode name="pool">
                <properties>
                  <help>Associate with a number of remote servers</help>
                  <valueless/>
                </properties>
              </leafNode>
              <leafNode name="prefer">
                <properties>
                  <help>Marks the server as preferred</help>
                  <valueless/>
                </properties>
              </leafNode>
              <leafNode name="ptp">
                <properties>
                  <help>Use Precision Time Protocol (PTP) transport for the server</help>
                  <valueless/>
                </properties>
              </leafNode>
              <leafNode name="interleave">
                <properties>
                  <help>Use the interleaved mode for the server</help>
                  <valueless/>
                </properties>
              </leafNode>
            </children>
          </tagNode>
        </children>
      </node>
    </children>
  </node>
</interfaceDefinition>