summaryrefslogtreecommitdiff
path: root/interface-definitions/nat.xml.in
blob: d6bed5b27a0413d62c36983a354205cfd4712cf5 (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
<?xml version="1.0"?>
<interfaceDefinition>
  <node name="nat" owner="${vyos_conf_scripts_dir}/nat.py">
    <properties>
      <help>Network Address Translation (NAT) parameters</help>
      <priority>220</priority>
    </properties>
    <children>
      <node name="destination">
        <properties>
          <help>Destination NAT settings</help>
        </properties>
        <children>
          #include <include/nat-rule.xml.i>
          <tagNode name="rule">
            <children>
              <leafNode name="inbound-interface">
                <properties>
                  <help>Inbound interface of NAT traffic</help>
                  <completionHelp>
                    <script>${vyos_completion_dir}/list_interfaces.py</script>
                  </completionHelp>
                </properties>
              </leafNode>
              <node name="translation">
                <properties>
                  <help>Inside NAT IP (destination NAT only)</help>
                </properties>
                <children>
                  <leafNode name="address">
                    <properties>
                      <help>IP address, subnet, or range</help>
                      <valueHelp>
                        <format>ipv4</format>
                        <description>IPv4 address to match</description>
                      </valueHelp>
                      <valueHelp>
                        <format>ipv4net</format>
                        <description>IPv4 prefix to match</description>
                      </valueHelp>
                      <valueHelp>
                        <format>ipv4range</format>
                        <description>IPv4 address range to match</description>
                      </valueHelp>
                      <constraint>
                        <validator name="ipv4-prefix"/>
                        <validator name="ipv4-address"/>
                        <validator name="ipv4-range"/>
                      </constraint>
                    </properties>
                  </leafNode>
                  #include <include/nat-translation-port.xml.i>
                </children>
              </node>
            </children>
          </tagNode>
        </children>
      </node>
      <node name="nptv6">
        <properties>
          <help>IPv6-to-IPv6 Network Prefix Translation Settings</help>
        </properties>
        <children>
          <tagNode name="rule">
            <properties>
              <help>NPTv6 rule number</help>
              <valueHelp>
                <format>1-999999</format>
                <description>Number for this rule</description>
              </valueHelp>
              <constraint>
                <validator name="numeric" argument="--range 1-999999"/>
              </constraint>
              <constraintErrorMessage>NAT rule number must be between 1 and 999999</constraintErrorMessage>
            </properties>
            <children>
              <leafNode name="description">
                <properties>
                  <help>Rule description</help>
                </properties>
              </leafNode>
              #include <include/generic-disable-node.xml.i>
              #include <include/nat-interface.xml.i>
              <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 prefix options</help>
                </properties>
                <children>
                  <leafNode name="prefix">
                    <properties>
                      <help>IPv6 prefix to translate to</help>
                      <valueHelp>
                        <format>ipv6net</format>
                        <description>IPv6 prefix</description>
                      </valueHelp>
                      <constraint>
                        <validator name="ipv6-prefix"/>
                      </constraint>
                    </properties>
                  </leafNode>
                </children>
              </node>
            </children>
          </tagNode>
        </children>
      </node>
      <node name="source">
        <properties>
          <help>Source NAT settings</help>
        </properties>
        <children>
          #include <include/nat-rule.xml.i>
          <tagNode name="rule">
            <children>
              #include <include/nat-interface.xml.i>
              <node name="translation">
                <properties>
                  <help>Outside NAT IP (source NAT only)</help>
                </properties>
                <children>
                  <leafNode name="address">
                    <properties>
                      <help>IP address, subnet, or range</help>
                      <completionHelp>
                        <list>masquerade</list>
                      </completionHelp>
                      <valueHelp>
                        <format>ipv4</format>
                        <description>IPv4 address to match</description>
                      </valueHelp>
                      <valueHelp>
                        <format>ipv4net</format>
                        <description>IPv4 prefix to match</description>
                      </valueHelp>
                      <valueHelp>
                        <format>ipv4range</format>
                        <description>IPv4 address range to match</description>
                      </valueHelp>
                      <valueHelp>
                        <format>masquerade</format>
                        <description>NAT to the primary address of outbound-interface</description>
                      </valueHelp>
                      <constraint>
                        <validator name="ipv4-prefix"/>
                        <validator name="ipv4-address"/>
                        <validator name="ipv4-range"/>
                        <regex>(masquerade)</regex>
                      </constraint>
                    </properties>
                  </leafNode>
                  #include <include/nat-translation-port.xml.i>
                </children>
              </node>
            </children>
          </tagNode>
        </children>
      </node>
    </children>
  </node>
</interfaceDefinition>