summaryrefslogtreecommitdiff
path: root/interface-definitions/dns-dynamic.xml.in
blob: 48c101d73a42f87f57a9812b7da1d7885f923c27 (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
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
<?xml version="1.0"?>
<interfaceDefinition>
  <node name="service">
    <children>
      <node name="dns">
        <properties>
          <help>Domain Name System related services</help>
        </properties>
        <children>
          <node name="dynamic" owner="${vyos_conf_scripts_dir}/dynamic_dns.py">
            <properties>
              <help>Dynamic DNS</help>
            </properties>
            <children>
              <tagNode name="interface">
                <properties>
                  <help>Interface to send Dynamic DNS updates for</help>
                  <completionHelp>
                    <script>${vyos_completion_dir}/list_interfaces</script>
                  </completionHelp>
                  <valueHelp>
                    <format>txt</format>
                    <description>Interface name</description>
                  </valueHelp>
                  <constraint>
                    #include <include/constraint/interface-name.xml.i>
                  </constraint>
                </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</help>
                          <valueHelp>
                            <format>filename</format>
                            <description>File in /config/auth directory</description>
                          </valueHelp>
                        </properties>
                      </leafNode>
                      <leafNode name="record">
                        <properties>
                          <help>Record to be updated</help>
                          <multi/>
                        </properties>
                      </leafNode>
                      <leafNode name="server">
                        <properties>
                          <help>Server to be updated</help>
                        </properties>
                      </leafNode>
                      <leafNode name="ttl">
                        <properties>
                          <help>Time To Live (default: 600)</help>
                          <valueHelp>
                            <format>u32:1-86400</format>
                            <description>DNS forwarding cache size</description>
                          </valueHelp>
                          <constraint>
                            <validator name="numeric" argument="--range 1-86400"/>
                          </constraint>
                        </properties>
                        <defaultValue>600</defaultValue>
                      </leafNode>
                      <leafNode name="zone">
                        <properties>
                          <help>Zone to be updated</help>
                        </properties>
                      </leafNode>
                    </children>
                  </tagNode>
                  <tagNode name="service">
                    <properties>
                      <help>Service being used for Dynamic DNS</help>
                      <completionHelp>
                        <list>afraid changeip cloudflare dnspark dslreports dyndns easydns namecheap noip sitelutions zoneedit</list>
                      </completionHelp>
                      <valueHelp>
                        <format>txt</format>
                        <description>Dynanmic DNS service with a custom name</description>
                      </valueHelp>
                      <valueHelp>
                        <format>afraid</format>
                        <description>afraid.org Services</description>
                      </valueHelp>
                      <valueHelp>
                        <format>changeip</format>
                        <description>changeip.com Services</description>
                      </valueHelp>
                      <valueHelp>
                        <format>cloudflare</format>
                        <description>cloudflare.com Services</description>
                      </valueHelp>
                      <valueHelp>
                        <format>dnspark</format>
                        <description>dnspark.com Services</description>
                      </valueHelp>
                      <valueHelp>
                        <format>dslreports</format>
                        <description>dslreports.com Services</description>
                      </valueHelp>
                      <valueHelp>
                        <format>dyndns</format>
                        <description>dyndns.com Services</description>
                      </valueHelp>
                      <valueHelp>
                        <format>easydns</format>
                        <description>easydns.com Services</description>
                      </valueHelp>
                      <valueHelp>
                        <format>namecheap</format>
                        <description>namecheap.com Services</description>
                      </valueHelp>
                      <valueHelp>
                        <format>noip</format>
                        <description>noip.com Services</description>
                      </valueHelp>
                      <valueHelp>
                        <format>sitelutions</format>
                        <description>sitelutions.com Services</description>
                      </valueHelp>
                      <valueHelp>
                        <format>zoneedit</format>
                        <description>zoneedit.com Services</description>
                      </valueHelp>
                      <constraint>
                        <regex>(custom|afraid|changeip|cloudflare|dnspark|dslreports|dyndns|easydns|namecheap|noip|sitelutions|zoneedit|\w+)</regex>
                      </constraint>
                      <constraintErrorMessage>You can use only predefined list of services or word characters (_, a-z, A-Z, 0-9) as service name</constraintErrorMessage>
                    </properties>
                    <children>
                      <leafNode name="host-name">
                        <properties>
                          <help>Hostname to register with Dynamic DNS service</help>
                          <constraint>
                            #include <include/constraint/host-name.xml.i>
                          </constraint>
                          <constraintErrorMessage>Host-name must be alphanumeric and can contain hyphens</constraintErrorMessage>
                          <multi/>
                        </properties>
                      </leafNode>
                      <leafNode name="login">
                        <properties>
                          <help>Login/Username for Dynamic DNS service</help>
                        </properties>
                      </leafNode>
                      #include <include/generic-password.xml.i>
                      <leafNode name="protocol">
                        <properties>
                          <help>ddclient protocol used for Dynamic DNS service</help>
                          <completionHelp>
                            <script>${vyos_completion_dir}/list_ddclient_protocols.sh</script>
                          </completionHelp>
                          <constraint>
                            <validator name="ddclient-protocol"/>
                          </constraint>
                        </properties>
                      </leafNode>
                      #include <include/server-ipv4-fqdn.xml.i>
                      <leafNode name="zone">
                        <properties>
                          <help>DNS zone to update (not used by all protocols)</help>
                          <valueHelp>
                            <format>txt</format>
                            <description>Name of DNS zone</description>
                          </valueHelp>
                        </properties>
                      </leafNode>
                    </children>
                  </tagNode>
                  <node name="use-web">
                    <properties>
                      <help>Use HTTP(S) web request to obtain external IP address instead of the IP address associated with the interface</help>
                    </properties>
                    <children>
                      <leafNode name="skip">
                        <properties>
                          <help>Pattern to skip from the respose</help>
                          <valueHelp>
                            <format>txt</format>
                            <description>Pattern to skip from the respose of the given URL to extract the external IP address</description>
                          </valueHelp>
                        </properties>
                      </leafNode>
                      #include <include/url.xml.i>
                    </children>
                  </node>
                  <leafNode name="ipv6-enable">
                    <properties>
                      <help>Explicitly use IPv6 address instead of IPv4 address to update the Dynamic DNS IP address</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                </children>
              </tagNode>
            </children>
          </node>
        </children>
      </node>
    </children>
  </node>
</interfaceDefinition>