summaryrefslogtreecommitdiff
path: root/interface-definitions/dns-dynamic.xml.in
blob: 308dc5de0722b65c93c1e875ecb155ee8ccf7ab0 (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
<?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="address">
                <properties>
                  <help>Obtain IP address to send Dynamic DNS update for</help>
                  <valueHelp>
                    <format>txt</format>
                    <description>Use interface to obtain the IP address</description>
                  </valueHelp>
                  <valueHelp>
                    <format>web</format>
                    <description>Use HTTP(S) web request to obtain the IP address</description>
                  </valueHelp>
                  <completionHelp>
                    <script>${vyos_completion_dir}/list_interfaces</script>
                    <list>web</list>
                  </completionHelp>
                  <constraint>
                    #include <include/constraint/interface-name.xml.i>
                    <regex>web</regex>
                  </constraint>
                </properties>
                <children>
                  <node name="web-options">
                    <properties>
                      <help>Options when using HTTP(S) web request to obtain the IP address</help>
                    </properties>
                    <children>
                      #include <include/url.xml.i>
                      <leafNode name="skip">
                        <properties>
                          <help>Pattern to skip from the HTTP(S) respose</help>
                          <valueHelp>
                            <format>txt</format>
                            <description>Pattern to skip from the HTTP(S) respose to extract the external IP address</description>
                          </valueHelp>
                        </properties>
                      </leafNode>
                    </children>
                  </node>
                  <tagNode name="rfc2136">
                    <properties>
                      <help>RFC2136 nsupdate configuration</help>
                      <valueHelp>
                        <format>txt</format>
                        <description>RFC2136 nsupdate service name</description>
                      </valueHelp>
                    </properties>
                    <children>
                      #include <include/generic-description.xml.i>
                      #include <include/dns/dynamic-service-host-name-server.xml.i>
                      <leafNode name="key">
                        <properties>
                          <help>File containing the TSIG secret key shared with remote DNS server</help>
                          <valueHelp>
                            <format>filename</format>
                            <description>File in /config/auth directory</description>
                          </valueHelp>
                          <constraint>
                            <validator name="file-path" argument="--strict --parent-dir /config/auth"/>
                          </constraint>
                        </properties>
                      </leafNode>
                      #include <include/dns/time-to-live.xml.i>
                      <leafNode name="zone">
                        <properties>
                          <help>Forwarding zone to be updated</help>
                          <valueHelp>
                            <format>txt</format>
                            <description>RFC2136 Zone to be updated</description>
                          </valueHelp>
                          <constraint>
                            <validator name="fqdn"/>
                          </constraint>
                        </properties>
                      </leafNode>
                    </children>
                  </tagNode>
                  <tagNode name="service">
                    <properties>
                      <help>Dynamic DNS configuration</help>
                      <valueHelp>
                        <format>txt</format>
                        <description>Dynamic DNS service name</description>
                      </valueHelp>
                    </properties>
                    <children>
                      #include <include/generic-description.xml.i>
                      #include <include/dns/dynamic-service-host-name-server.xml.i>
                      #include <include/generic-username.xml.i>
                      #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>
                      <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>
                      <leafNode name="ip-version">
                        <properties>
                          <help>IP address version to use</help>
                          <valueHelp>
                            <format>_ipv4</format>
                            <description>Use only IPv4 address</description>
                          </valueHelp>
                          <valueHelp>
                            <format>_ipv6</format>
                            <description>Use only IPv6 address</description>
                          </valueHelp>
                          <valueHelp>
                            <format>both</format>
                            <description>Use both IPv4 and IPv6 address</description>
                          </valueHelp>
                          <completionHelp>
                            <list>ipv4 ipv6 both</list>
                          </completionHelp>
                          <constraint>
                            <regex>(ipv[46]|both)</regex>
                          </constraint>
                          <constraintErrorMessage>IP Version must be literal 'ipv4', 'ipv6' or 'both'</constraintErrorMessage>
                        </properties>
                        <defaultValue>ipv4</defaultValue>
                      </leafNode>
                    </children>
                  </tagNode>
                </children>
              </tagNode>
            </children>
          </node>
        </children>
      </node>
    </children>
  </node>
</interfaceDefinition>