interface-definitions/dynamic-dns.xml


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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227

<?xml version="1.0"?>
<!-- Dynamic DNS configuration -->
<interfaceDefinition>
  <node name="service">
    <children>
      <node name="dns">
        <children>
          <node name="dynamic" owner="${vyos_conf_scripts_dir}/dynamic_dns.py">
            <properties>
              <help>Dynamic DNS</help>
              <priority>919</priority>
            </properties>
            <children>
              <tagNode name="interface">
                <properties>
                  <help>Interface to send DDNS updates for [REQUIRED]</help>
                  <completionHelp>
                    <script>${vyos_completion_dir}/list_interfaces.py</script>
                  </completionHelp>
                </properties>
                <children>
                  <tagNode name="rfc2136">
                    <properties>
                      <help>RFC2136 Update name</help>
                    </properties>
                    <children>
                      <leafNode name="key">
                        <properties>
                          <help>File containing the secret key shared with remote DNS server [REQUIRED]</help>
                          <valueHelp>
                            <format>file</format>
                            <description>File in /config/auth directory</description>
                          </valueHelp>
                        </properties>
                      </leafNode>
                      <leafNode name="record">
                        <properties>
                          <help>Record to be updated [REQUIRED]</help>
                          <multi/>
                        </properties>
                      </leafNode>
                      <leafNode name="server">
                        <properties>
                          <help>Server to be updated [REQUIRED]</help>
                        </properties>
                      </leafNode>
                      <leafNode name="ttl">
                        <properties>
                          <help>Time To Live (default: 600)</help>
                          <valueHelp>
                            <format>1-86400</format>
                            <description>DNS forwarding cache size</description>
                          </valueHelp>
                          <constraint>
                            <validator name="numeric" argument="--range 1-86400"/>
                          </constraint>
                        </properties>
                      </leafNode>
                      <leafNode name="zone">
                        <properties>
                          <help>Zone to be updated [REQUIRED]</help>
                        </properties>
                      </leafNode>
                    </children>
                  </tagNode>
                  <tagNode name="service">
                    <properties>
                      <help>Service being used for Dynamic DNS [REQUIRED]</help>
                      <completionHelp>
                        <list>custom afraid changeip cloudflare dnspark dslreports dyndns easydns namecheap noip sitelutions zoneedit</list>
                      </completionHelp>
                      <valueHelp>
                        <format>custom</format>
                        <description>Custom or predefined service</description>
                      </valueHelp>
                      <valueHelp>
                        <format>afraid</format>
                        <description></description>
                      </valueHelp>
                      <valueHelp>
                        <format>changeip</format>
                        <description></description>
                      </valueHelp>
                      <valueHelp>
                        <format>cloudflare</format>
                        <description></description>
                      </valueHelp>
                      <valueHelp>
                        <format>dnspark</format>
                        <description></description>
                      </valueHelp>
                      <valueHelp>
                        <format>dslreports</format>
                        <description></description>
                      </valueHelp>
                      <valueHelp>
                        <format>dyndns</format>
                        <description></description>
                      </valueHelp>
                      <valueHelp>
                        <format>easydns</format>
                        <description></description>
                      </valueHelp>
                      <valueHelp>
                        <format>namecheap</format>
                        <description></description>
                      </valueHelp>
                      <valueHelp>
                        <format>noip</format>
                        <description></description>
                      </valueHelp>
                      <valueHelp>
                        <format>sitelutions</format>
                        <description></description>
                      </valueHelp>
                      <valueHelp>
                        <format>zoneedit</format>
                        <description></description>
                      </valueHelp>
                    </properties>
                    <children>
                      <leafNode name="host-name">
                        <properties>
                          <help>Hostname registered with DDNS service [REQUIRED]</help>
                          <multi/>
                        </properties>
                      </leafNode>
                      <leafNode name="login">
                        <properties>
                          <help>Login for DDNS service [REQUIRED]</help>
                        </properties>
                      </leafNode>
                      <leafNode name="password">
                        <properties>
                          <help>Password for DDNS service [REQUIRED]</help>
                        </properties>
                      </leafNode>
                      <leafNode name="protocol">
                        <properties>
                          <help>ddclient protocol used for DDNS service [REQUIRED FOR CUSTOM]</help>
                          <valueHelp>
                            <format>protocol</format>
                            <description>ddclient protocol</description>
                          </valueHelp>
                          <valueHelp>
                            <format>changeip</format>
                            <description></description>
                          </valueHelp>
                          <valueHelp>
                            <format>cloudflare</format>
                            <description></description>
                          </valueHelp>
                          <valueHelp>
                            <format>dnspark</format>
                            <description></description>
                          </valueHelp>
                          <valueHelp>
                            <format>dslreports1</format>
                            <description></description>
                          </valueHelp>
                          <valueHelp>
                            <format>dyndns2</format>
                            <description></description>
                          </valueHelp>
                          <valueHelp>
                            <format>easydns</format>
                            <description></description>
                          </valueHelp>
                          <valueHelp>
                            <format>namecheap</format>
                            <description></description>
                          </valueHelp>
                          <valueHelp>
                            <format>noip</format>
                            <description></description>
                          </valueHelp>
                          <valueHelp>
                            <format>sitelutions</format>
                            <description></description>
                          </valueHelp>
                          <valueHelp>
                            <format>zoneedit1</format>
                            <description></description>
                          </valueHelp>
                        </properties>
                      </leafNode>
                      <leafNode name="server">
                        <properties>
                          <help>Server to send DDNS update to [REQUIRED FOR CUSTOM]</help>
                          <valueHelp>
                            <format>IPv4</format>
                            <description>IP address of DDNS server</description>
                          </valueHelp>
                          <valueHelp>
                            <format>FQDN</format>
                            <description>Hostname of DDNS server</description>
                          </valueHelp>
                        </properties>
                      </leafNode>
                    </children>
                  </tagNode>
                  <node name="use-web">
                    <properties>
                      <help>Web check used for obtaining the external IP address</help>
                    </properties>
                    <children>
                      <leafNode name="skip">
                        <properties>
                          <help>Skip everything before this on the given URL</help>
                         </properties>
                      </leafNode>
                      <leafNode name="url">
                        <properties>
                          <help>URL to obtain the current external IP address</help>
                         </properties>
                      </leafNode>
                    </children>
                  </node>
                </children>
              </tagNode>
            </children>
          </node>
        </children>
      </node>
    </children>
  </node>
</interfaceDefinition>