summaryrefslogtreecommitdiff
path: root/interface-definitions/nat66.xml.in
blob: b47f653c6e400d5fcce0824388b3fec0c36346f5 (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="nat66" owner="${vyos_conf_scripts_dir}/nat66.py">
    <properties>
      <help>IPv6-to-IPv6 Network Prefix Translation (NAT66/NPT) Settings</help>
      <priority>500</priority>
    </properties>
    <children>
      <node name="source">
        <properties>
          <help>Prefix mapping of IPv6 source address translation</help>
        </properties>
        <children>
          <tagNode name="rule">
            <properties>
              <help>Source NAT66 rule number</help>
              <valueHelp>
                <format>u32:1-999999</format>
                <description>Number for this rule</description>
              </valueHelp>
              <constraint>
                <validator name="numeric" argument="--range 1-999999"/>
              </constraint>
              <constraintErrorMessage>NAT66 rule number must be between 1 and 999999</constraintErrorMessage>
            </properties>
            <children>
              <leafNode name="description">
                <properties>
                  <help>Rule description</help>
                </properties>
              </leafNode>
              <leafNode name="disable">
                <properties>
                  <help>Disable NAT66 rule</help>
                  <valueless/>
                </properties>
              </leafNode>
              <leafNode name="log">
                <properties>
                  <help>NAT66 rule logging</help>
                  <valueless/>
                </properties>
              </leafNode>
              <leafNode name="outbound-interface">
                <properties>
                  <help>Outbound interface of NAT66 traffic</help>
                  <completionHelp>
                    <script>${vyos_completion_dir}/list_interfaces.py</script>
                  </completionHelp>
                </properties>
              </leafNode>
              <node name="source">
                <properties>
                  <help>IPv6 source prefix options</help>
                </properties>
                <children>
                  <leafNode name="prefix">
                    <properties>
                      <help>IPv6 prefix to be translated</help>
                      <valueHelp>
                        <format>ipv6net</format>
                        <description>IPv6 prefix</description>
                      </valueHelp>
                      <constraint>
                        <validator name="ipv6-prefix"/>
                      </constraint>
                    </properties>
                  </leafNode>
                </children>
              </node>
              <node name="translation">
                <properties>
                  <help>Translated IPv6 address options</help>
                </properties>
                <children>
                  <leafNode name="address">
                    <properties>
                      <help>IPv6 address to translate to</help>
                      <completionHelp>
                        <list>masquerade</list>
                      </completionHelp>
                      <valueHelp>
                        <format>ipv6</format>
                        <description>IPv6 address</description>
                      </valueHelp>
                      <valueHelp>
                        <format>ipv6net</format>
                        <description>IPv6 prefix</description>
                      </valueHelp>
                      <valueHelp>
                        <format>masquerade</format>
                        <description>NAT to the primary address of outbound-interface</description>
                      </valueHelp>
                      <constraint>
                        <validator name="ipv6-address"/>
                        <validator name="ipv6-prefix"/>
                        <regex>(masquerade)</regex>
                      </constraint>
                    </properties>
                  </leafNode>
                </children>
              </node>
            </children>
          </tagNode>
        </children>
      </node>
      <node name="destination">
        <properties>
          <help>Prefix mapping for IPv6 destination address translation</help>
        </properties>
        <children>
          <tagNode name="rule">
            <properties>
              <help>Destination NAT66 rule number</help>
              <valueHelp>
                <format>u32:1-999999</format>
                <description>Number for this rule</description>
              </valueHelp>
              <constraint>
                <validator name="numeric" argument="--range 1-999999"/>
              </constraint>
              <constraintErrorMessage>NAT66 rule number must be between 1 and 999999</constraintErrorMessage>
            </properties>
            <children>
              <leafNode name="description">
                <properties>
                  <help>Rule description</help>
                </properties>
              </leafNode>
              <leafNode name="disable">
                <properties>
                  <help>Disable NAT66 rule</help>
                  <valueless/>
                </properties>
              </leafNode>
              <leafNode name="log">
                <properties>
                  <help>NAT66 rule logging</help>
                  <valueless/>
                </properties>
              </leafNode>
              <leafNode name="inbound-interface">
                <properties>
                  <help>Inbound interface of NAT66 traffic</help>
                  <completionHelp>
                    <list>any</list>
                    <script>${vyos_completion_dir}/list_interfaces.py</script>
                  </completionHelp>
                </properties>
              </leafNode>
              <node name="destination">
                <properties>
                  <help>IPv6 destination prefix options</help>
                </properties>
                <children>
                  <leafNode name="address">
                    <properties>
                      <help>IPv6 address or prefix to be translated</help>
                      <valueHelp>
                        <format>ipv6</format>
                        <description>IPv6 address</description>
                      </valueHelp>
                      <valueHelp>
                        <format>ipv6net</format>
                        <description>IPv6 prefix</description>
                      </valueHelp>
                      <constraint>
                        <validator name="ipv6-address"/>
                        <validator name="ipv6-prefix"/>
                      </constraint>
                    </properties>
                  </leafNode>
                </children>
              </node>
              <node name="translation">
                <properties>
                  <help>Translated IPv6 address options</help>
                </properties>
                <children>
                  <leafNode name="address">
                    <properties>
                      <help>IPv6 address or prefix to translate to</help>
                      <valueHelp>
                        <format>ipv6</format>
                        <description>IPv6 address</description>
                      </valueHelp>
                      <valueHelp>
                        <format>ipv6net</format>
                        <description>IPv6 prefix</description>
                      </valueHelp>
                      <constraint>
                        <validator name="ipv6-address"/>
                        <validator name="ipv6-prefix"/>
                      </constraint>
                    </properties>
                  </leafNode>
                </children>
              </node>
            </children>
          </tagNode>
        </children>
      </node>
    </children>
  </node>
</interfaceDefinition>