summaryrefslogtreecommitdiff
path: root/interface-definitions/protocols-bfd.xml
blob: 47d5bf97d9d2ded085c5640f6182d10f421c459a (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
<?xml version="1.0"?>
<!-- Bidirectional Forwarding Detection (BFD) configuration -->
<interfaceDefinition>
  <node name="protocols">
    <children>
      <node name="bfd" owner="${vyos_conf_scripts_dir}/protocols_bfd.py">
        <properties>
          <help>Bidirectional Forwarding Detection (BFD)</help>
          <priority>820</priority>
        </properties>
        <children>
          <tagNode name="peer">
            <properties>
              <help>Configures a new BFD peer to listen and talk to</help>
              <valueHelp>
                <format>ipv4</format>
                <description>BFD peer IPv4 address</description>
              </valueHelp>
              <valueHelp>
                <format>ipv6</format>
                <description>BFD peer IPv6 address</description>
              </valueHelp>
            </properties>
            <children>
              <node name="source">
                <properties>
                  <help>Bind listener to specifid interface/address, mandatory for IPv6</help>
                </properties>
                <children>
                  <leafNode name="interface">
                    <properties>
                      <help>Local interface to bind our peer listener to</help>
                      <completionHelp>
                        <script>${vyos_completion_dir}/list_interfaces.py</script>
                      </completionHelp>
                    </properties>
                  </leafNode>
                  <leafNode name="address">
                    <properties>
                      <help>Local address to bind our peer listener to</help>
                      <valueHelp>
                        <format>ipv4</format>
                        <description>Local IPv4 address used to connect to the peer</description>
                      </valueHelp>
                      <valueHelp>
                        <format>ipv6</format>
                        <description>Local IPv6 address used to connect to the peer</description>
                      </valueHelp>
                    </properties>
                  </leafNode>
                </children>
              </node>
              <node name="interval">
                <properties>
                  <help>Configure timer intervals</help>
                </properties>
                <children>
                  <leafNode name="receive">
                    <properties>
                      <help>Minimum interval of receiving control packets</help>
                      <valueHelp>
                        <format>10-60000</format>
                        <description>Interval in milliseconds</description>
                      </valueHelp>
                      <constraint>
                        <validator name="numeric" argument="--range 10-60000"/>
                      </constraint>
                    </properties>
                  </leafNode>
                  <leafNode name="transmit">
                    <properties>
                      <help>Minimum interval of transmitting control packets</help>
                      <valueHelp>
                        <format>10-60000</format>
                        <description>Interval in milliseconds</description>
                      </valueHelp>
                      <constraint>
                        <validator name="numeric" argument="--range 10-60000"/>
                      </constraint>
                    </properties>
                  </leafNode>
                  <leafNode name="multiplier">
                    <properties>
                      <help>Multiplier to determine packet loss</help>
                      <valueHelp>
                        <format>2-255</format>
                        <description>Remote transmission interval will be multiplied by this value</description>
                      </valueHelp>
                      <constraint>
                        <validator name="numeric" argument="--range 2-255"/>
                      </constraint>
                    </properties>
                  </leafNode>
                </children>
              </node>
              <leafNode name="shutdown">
                <properties>
                  <help>Disable this peer</help>
                  <valueless/>
                </properties>
              </leafNode>
              <leafNode name="multihop">
                <properties>
                  <help>Allow this BFD peer to not be directly connected</help>
                  <valueless/>
                </properties>
              </leafNode>
            </children>
          </tagNode>
        </children>
      </node>
    </children>
  </node>
</interfaceDefinition>