summaryrefslogtreecommitdiff
path: root/interface-definitions/nat_cgnat.xml.in
blob: 71f4d67b0029df4695b4efaa1efd197b7689feb2 (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
<?xml version="1.0"?>
<interfaceDefinition>
  <node name="nat">
    <children>
      <node name="cgnat" owner="${vyos_conf_scripts_dir}/nat_cgnat.py">
        <properties>
          <help>Carrier-grade NAT (CGNAT) parameters</help>
          <priority>221</priority>
        </properties>
        <children>
          <leafNode name="log-allocation">
            <properties>
              <help>Log IP address and port allocation</help>
              <valueless/>
            </properties>
          </leafNode>
          <node name="pool">
            <properties>
              <help>External and internal pool parameters</help>
            </properties>
            <children>
              <tagNode name="external">
                <properties>
                  <help>External pool name</help>
                  <valueHelp>
                    <format>txt</format>
                    <description>External pool name</description>
                  </valueHelp>
                  <constraint>
                    #include <include/constraint/alpha-numeric-hyphen-underscore-dot.xml.i>
                  </constraint>
                  <constraintErrorMessage>Name of pool can only contain alpha-numeric letters, hyphen and underscores</constraintErrorMessage>
                </properties>
                <children>
                  <leafNode name="external-port-range">
                    <properties>
                      <help>Port range</help>
                      <valueHelp>
                        <format>range</format>
                        <description>Numbered port range (e.g., 1001-1005)</description>
                      </valueHelp>
                      <constraint>
                        <validator name="port-range"/>
                      </constraint>
                    </properties>
                    <defaultValue>1024-65535</defaultValue>
                  </leafNode>
                  <node name="per-user-limit">
                    <properties>
                      <help>Per user limits for the pool</help>
                    </properties>
                    <children>
                      <leafNode name="port">
                        <properties>
                          <help>Ports per user</help>
                          <valueHelp>
                            <format>u32:1-65535</format>
                            <description>Numeric IP port</description>
                          </valueHelp>
                          <constraint>
                            <validator name="numeric" argument="--range 1-65535"/>
                          </constraint>
                        </properties>
                        <defaultValue>2000</defaultValue>
                      </leafNode>
                    </children>
                  </node>
                  <tagNode name="range">
                    <properties>
                      <help>Range of IP addresses</help>
                      <valueHelp>
                        <format>ipv4net</format>
                        <description>IPv4 prefix</description>
                      </valueHelp>
                      <valueHelp>
                        <format>ipv4range</format>
                        <description>IPv4 address range</description>
                      </valueHelp>
                      <constraint>
                        <validator name="ipv4-prefix"/>
                        <validator name="ipv4-host"/>
                        <validator name="ipv4-range"/>
                      </constraint>
                    </properties>
                    <children>
                      <leafNode name="seq">
                        <properties>
                          <help>Sequence</help>
                          <valueHelp>
                            <format>u32:1-999999</format>
                            <description>Sequence number</description>
                          </valueHelp>
                          <constraint>
                            <validator name="numeric" argument="--range 1-999999"/>
                          </constraint>
                          <constraintErrorMessage>Sequence number must be between 1 and 999999</constraintErrorMessage>
                        </properties>
                      </leafNode>
                    </children>
                  </tagNode>
                </children>
              </tagNode>
              <tagNode name="internal">
                <properties>
                  <help>Internal pool name</help>
                  <valueHelp>
                    <format>txt</format>
                    <description>Internal pool name</description>
                  </valueHelp>
                  <constraint>
                    #include <include/constraint/alpha-numeric-hyphen-underscore-dot.xml.i>
                  </constraint>
                  <constraintErrorMessage>Name of pool can only contain alpha-numeric letters, hyphen and underscores</constraintErrorMessage>
                </properties>
                <children>
                  <leafNode name="range">
                    <properties>
                      <help>Range of IP addresses</help>
                      <valueHelp>
                        <format>ipv4net</format>
                        <description>IPv4 prefix</description>
                      </valueHelp>
                      <valueHelp>
                        <format>ipv4range</format>
                        <description>IPv4 address range</description>
                      </valueHelp>
                      <constraint>
                        <validator name="ipv4-prefix"/>
                        <validator name="ipv4-host"/>
                        <validator name="ipv4-range"/>
                      </constraint>
                      <multi/>
                    </properties>
                  </leafNode>
                </children>
              </tagNode>
            </children>
          </node>
          <tagNode name="rule">
            <properties>
              <help>Rule</help>
              <valueHelp>
                <format>u32:1-999999</format>
                <description>Number for this CGNAT rule</description>
              </valueHelp>
              <constraint>
                <validator name="numeric" argument="--range 1-999999"/>
              </constraint>
              <constraintErrorMessage>Rule number must be between 1 and 999999</constraintErrorMessage>
            </properties>
            <children>
              <node name="source">
                <properties>
                  <help>Source parameters</help>
                </properties>
                <children>
                  <leafNode name="pool">
                    <properties>
                      <help>Source internal pool</help>
                      <completionHelp>
                        <path>nat cgnat pool internal</path>
                      </completionHelp>
                      <valueHelp>
                        <format>txt</format>
                        <description>Source internal pool name</description>
                      </valueHelp>
                      <constraint>
                        #include <include/constraint/alpha-numeric-hyphen-underscore-dot.xml.i>
                      </constraint>
                      <constraintErrorMessage>Name of pool can only contain alpha-numeric letters, hyphen and underscores</constraintErrorMessage>
                    </properties>
                  </leafNode>
                </children>
              </node>
              <node name="translation">
                <properties>
                  <help>Translation parameters</help>
                </properties>
                <children>
                  <leafNode name="pool">
                    <properties>
                      <help>Translation external pool</help>
                      <completionHelp>
                        <path>nat cgnat pool external</path>
                      </completionHelp>
                      <valueHelp>
                        <format>txt</format>
                        <description>Translation external pool name</description>
                      </valueHelp>
                      <constraint>
                        #include <include/constraint/alpha-numeric-hyphen-underscore-dot.xml.i>
                      </constraint>
                      <constraintErrorMessage>Name of pool can only contain alpha-numeric letters, hyphen and underscores</constraintErrorMessage>
                    </properties>
                  </leafNode>
                </children>
              </node>
            </children>
          </tagNode>
        </children>
      </node>
    </children>
  </node>
</interfaceDefinition>