summaryrefslogtreecommitdiff
path: root/interface-definitions/include/babel/interface.xml.i
blob: 549e4909db41f31c872ba83d4bff5c3d147e309d (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
<!-- include start from babel/interface.xml.i -->
<tagNode name="interface">
  <properties>
    <help>Interface name</help>
    <completionHelp>
      <script>${vyos_completion_dir}/list_interfaces.py</script>
    </completionHelp>
    <valueHelp>
      <format>txt</format>
      <description>Interface name</description>
    </valueHelp>
    <constraint>
      #include <include/constraint/interface-name.xml.in>
    </constraint>
  </properties>
  <children>
    <leafNode name="type">
      <properties>
        <help>Interface type</help>
        <completionHelp>
          <list>auto wired wireless</list>
        </completionHelp>
        <valueHelp>
          <format>auto</format>
          <description>Automatically detect interface type</description>
        </valueHelp>
        <valueHelp>
          <format>wired</format>
          <description>Wired interface</description>
        </valueHelp>
        <valueHelp>
          <format>wireless</format>
          <description>Wireless interface</description>
        </valueHelp>
        <constraint>
          <regex>(auto|wired|wireless)</regex>
        </constraint>
      </properties>
      <defaultValue>auto</defaultValue>
    </leafNode>
    <leafNode name="split-horizon">
      <properties>
        <help>Split horizon parameters</help>
        <completionHelp>
          <list>default enable disable</list>
        </completionHelp>
        <valueHelp>
          <format>default</format>
          <description>Enable on wired interfaces, and disable on wireless interfaces</description>
        </valueHelp>
        <valueHelp>
          <format>enable</format>
          <description>Enable split horizon processing</description>
        </valueHelp>
        <valueHelp>
          <format>disable</format>
          <description>Disable split horizon processing</description>
        </valueHelp>
        <constraint>
          <regex>(default|enable|disable)</regex>
        </constraint>
      </properties>
      <defaultValue>default</defaultValue>
    </leafNode>
    <leafNode name="hello-interval">
      <properties>
        <help>Time between scheduled hellos</help>
        <valueHelp>
          <format>u32:20-655340</format>
          <description>Milliseconds</description>
        </valueHelp>
        <constraint>
          <validator name="numeric" argument="--range 20-655340"/>
        </constraint>
      </properties>
      <defaultValue>4000</defaultValue>
    </leafNode>
    <leafNode name="update-interval">
      <properties>
        <help>Time between scheduled updates</help>
        <valueHelp>
          <format>u32:20-655340</format>
          <description>Milliseconds</description>
        </valueHelp>
        <constraint>
          <validator name="numeric" argument="--range 20-655340"/>
        </constraint>
      </properties>
      <defaultValue>20000</defaultValue>
    </leafNode>
    <leafNode name="rxcost">
      <properties>
        <help>Base receive cost for this interface</help>
        <valueHelp>
          <format>u32:1-65534</format>
          <description>Base receive cost</description>
        </valueHelp>
        <constraint>
          <validator name="numeric" argument="--range 1-65534"/>
        </constraint>
      </properties>
    </leafNode>
    <leafNode name="rtt-decay">
      <properties>
        <help>Decay factor for exponential moving average of RTT samples</help>
        <valueHelp>
          <format>u32:1-256</format>
          <description>Decay factor, in units of 1/256</description>
        </valueHelp>
        <constraint>
          <validator name="numeric" argument="--range 1-256"/>
        </constraint>
      </properties>
      <defaultValue>42</defaultValue>
    </leafNode>
    <leafNode name="rtt-min">
      <properties>
        <help>Minimum RTT</help>
        <valueHelp>
          <format>u32:1-65535</format>
          <description>Milliseconds</description>
        </valueHelp>
        <constraint>
          <validator name="numeric" argument="--range 1-65535"/>
        </constraint>
      </properties>
      <defaultValue>10</defaultValue>
    </leafNode>
    <leafNode name="rtt-max">
      <properties>
        <help>Maximum RTT</help>
        <valueHelp>
          <format>u32:1-65535</format>
          <description>Milliseconds</description>
        </valueHelp>
        <constraint>
          <validator name="numeric" argument="--range 1-65535"/>
        </constraint>
      </properties>
      <defaultValue>120</defaultValue>
    </leafNode>
    <leafNode name="max-rtt-penalty">
      <properties>
        <help>Maximum additional cost due to RTT</help>
        <valueHelp>
          <format>u32:0-65535</format>
          <description>Milliseconds (0 to disable the use of RTT-based cost)</description>
        </valueHelp>
        <constraint>
          <validator name="numeric" argument="--range 0-65535"/>
        </constraint>
      </properties>
      <defaultValue>150</defaultValue>
    </leafNode>
    <leafNode name="enable-timestamps">
      <properties>
        <help>Enable timestamps with each Hello and IHU message in order to compute RTT values</help>
        <valueless/>
      </properties>
    </leafNode>
    <leafNode name="channel">
      <properties>
        <help>Channel number for diversity routing</help>
        <completionHelp>
          <list>interfering non-interfering</list>
        </completionHelp>
        <valueHelp>
          <format>u32:1-254</format>
          <description>Interfaces with a channel number interfere with interfering interfaces and interfaces with the same channel number</description>
        </valueHelp>
        <valueHelp>
          <format>interfering</format>
          <description>Interfering interfaces are assumed to interfere with all other channels except non-interfering channels</description>
        </valueHelp>
        <valueHelp>
          <format>non-interfering</format>
          <description>Non-interfering interfaces only interfere with themselves</description>
        </valueHelp>
        <constraint>
          <validator name="numeric" argument="--range 1-254"/>
          <regex>(interfering|non-interfering)</regex>
        </constraint>
      </properties>
    </leafNode>
  </children>
</tagNode>
<!-- include end -->