summaryrefslogtreecommitdiff
path: root/interface-definitions/vpp_interface_bonding.xml.in
blob: 78166e30613ce44f77d589a936ee0f436bc0374d (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
<?xml version="1.0"?>
<interfaceDefinition>
  <node name='interfaces'>
    <children>
      <node name='vpp'>
        <properties>
          <help>Network interfaces</help>
          <priority>300</priority>
        </properties>
        <children>
          <tagNode name="bonding" owner="${vyos_conf_scripts_dir}/vpp_interfaces_bonding.py">
            <properties>
              <priority>324</priority>
              <help>Bonding Interface/Link Aggregation</help>
              <constraint>
                <regex>vppbond[0-9]+</regex>
              </constraint>
              <constraintErrorMessage>Bonding interface must be named vppbondN</constraintErrorMessage>
              <valueHelp>
                <format>vppbondN</format>
                <description>Bonding interface name</description>
              </valueHelp>
            </properties>
            <children>
              #include <include/generic-description.xml.i>
              #include <include/interface/disable.xml.i>
              <leafNode name="hash-policy">
                <properties>
                  <help>Bonding transmit hash policy</help>
                  <completionHelp>
                    <list>layer2 layer2+3 layer3+4</list>
                  </completionHelp>
                  <valueHelp>
                    <format>layer2</format>
                    <description>use MAC addresses to generate the hash</description>
                  </valueHelp>
                  <valueHelp>
                    <format>layer2+3</format>
                    <description>combine MAC address and IP address to make hash</description>
                  </valueHelp>
                  <valueHelp>
                    <format>layer3+4</format>
                    <description>combine IP address and port to make hash</description>
                  </valueHelp>
                  <constraint>
                    <regex>(layer2\+3|layer3\+4|layer2)</regex>
                  </constraint>
                  <constraintErrorMessage>hash-policy must be layer2 layer2+3 layer3+4</constraintErrorMessage>
                </properties>
                <defaultValue>layer2</defaultValue>
              </leafNode>
              #include <include/interface/mac.xml.i>
              <leafNode name="mode">
                <properties>
                  <help>Bonding mode</help>
                  <completionHelp>
                    <list>802.3ad active-backup broadcast round-robin xor-hash</list>
                  </completionHelp>
                  <valueHelp>
                    <format>802.3ad</format>
                    <description>IEEE 802.3ad Dynamic link aggregation</description>
                  </valueHelp>
                  <valueHelp>
                    <format>active-backup</format>
                    <description>Fault tolerant: only one slave in the bond is active</description>
                  </valueHelp>
                  <valueHelp>
                    <format>broadcast</format>
                    <description>Fault tolerant: transmits everything on all slave interfaces</description>
                  </valueHelp>
                  <valueHelp>
                    <format>round-robin</format>
                    <description>Load balance: transmit packets in sequential order</description>
                  </valueHelp>
                  <valueHelp>
                    <format>xor-hash</format>
                    <description>Distribute based on MAC address</description>
                  </valueHelp>
                  <constraint>
                    <regex>(802.3ad|active-backup|broadcast|round-robin|xor-hash)</regex>
                  </constraint>
                  <constraintErrorMessage>mode must be 802.3ad, active-backup, broadcast, round-robin, or xor-hash</constraintErrorMessage>
                </properties>
                <defaultValue>802.3ad</defaultValue>
              </leafNode>
              <node name="member">
                <properties>
                  <help>Bonding member interfaces</help>
                </properties>
                <children>
                  <leafNode name="interface">
                    <properties>
                      <help>Member interface name</help>
                      <completionHelp>
                        <script>${vyos_completion_dir}/list_interfaces --bondable</script>
                      </completionHelp>
                      <valueHelp>
                        <format>txt</format>
                        <description>Interface name</description>
                      </valueHelp>
                      <constraint>
                        #include <include/constraint/interface-name.xml.i>
                      </constraint>
                      <multi/>
                    </properties>
                  </leafNode>
                </children>
              </node>
              #include <include/interface/address-ipv4-ipv6.xml.i>
              #include <include/interface/mtu-68-16000.xml.i>
              <leafNode name="mtu">
                <defaultValue>1500</defaultValue>
              </leafNode>
              #include <include/vpp/vif.xml.i>
            </children>
          </tagNode>
        </children>
      </node>
    </children>
  </node>
</interfaceDefinition>