summaryrefslogtreecommitdiff
path: root/interface-definitions/protocols-pim.xml.in
blob: 733279aa4b5f230db85daa10b88e0cafedc1fb2e (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
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
<?xml version="1.0"?>
<!-- Protocol Independent Multicast (PIM) configuration -->
<interfaceDefinition>
  <node name="protocols">
    <children>
      <node name="pim" owner="${vyos_conf_scripts_dir}/protocols_pim.py">
        <properties>
          <help>Protocol Independent Multicast (PIM)</help>
          <priority>400</priority>
        </properties>
        <children>
          <tagNode name="interface">
            <properties>
              <help>PIM interface</help>
              <completionHelp>
                <script>${vyos_completion_dir}/list_interfaces</script>
              </completionHelp>
              <constraint>
                #include <include/constraint/interface-name.xml.i>
              </constraint>
            </properties>
            <children>
              #include <include/bfd/bfd.xml.i>
              <leafNode name="no-bsm">
                <properties>
                  <help>Do not process bootstrap messages</help>
                  <valueless/>
                </properties>
              </leafNode>
              <leafNode name="no-unicast-bsm">
                <properties>
                  <help>Do not process unicast bootstrap messages</help>
                  <valueless/>
                </properties>
              </leafNode>
              <leafNode name="dr-priority">
                <properties>
                  <help>Designated Router Election Priority</help>
                  <valueHelp>
                    <format>u32:1-4294967295</format>
                    <description>Value of the new DR Priority</description>
                  </valueHelp>
                  <constraint>
                    <validator name="numeric" argument="--range 1-4294967295"/>
                  </constraint>
                </properties>
              </leafNode>
              <leafNode name="hello">
                <properties>
                  <help>Hello Interval</help>
                  <valueHelp>
                    <format>u32:1-180</format>
                    <description>Hello Interval in seconds</description>
                  </valueHelp>
                  <constraint>
                    <validator name="numeric" argument="--range 1-180"/>
                  </constraint>
                </properties>
              </leafNode>
              <node name="igmp">
                <properties>
                  <help>Internet Group Management Protocol (IGMP) options</help>
                </properties>
                <children>
                  <leafNode name="version">
                    <properties>
                      <help>Interface IGMP version</help>
                      <valueHelp>
                        <format>2</format>
                        <description>IGMP version 2</description>
                      </valueHelp>
                      <valueHelp>
                        <format>3</format>
                        <description>IGMP version 3</description>
                      </valueHelp>
                      <constraint>
                        <validator name="numeric" argument="--range 2-3"/>
                      </constraint>
                    </properties>
                    <defaultValue>3</defaultValue>
                  </leafNode>
                </children>
              </node>
              <leafNode name="passive">
                <properties>
                  <help>Disable sending and receiving PIM control packets on the interface</help>
                  <valueless/>
                </properties>
              </leafNode>
              #include <include/source-address-ipv4.xml.i>
            </children>
          </tagNode>
          <node name="ecmp">
            <properties>
              <help>Enable PIM ECMP</help>
            </properties>
            <children>
              <leafNode name="rebalance">
                <properties>
                  <help>Enable PIM ECMP Rebalance</help>
                  <valueless/>
                </properties>
              </leafNode>
            </children>
           </node>
           <node name="igmp">
            <properties>
              <help>Internet Group Management Protocol (IGMP) options</help>
            </properties>
            <children>
              <leafNode name="watermark-warn">
                <properties>
                  <help>Configure group limit for watermark warning</help>
                  <valueHelp>
                    <format>u32:1-65535</format>
                    <description>Group count to generate watermark warning</description>
                  </valueHelp>
                  <constraint>
                    <validator name="numeric" argument="--range 1-65535"/>
                  </constraint>
                </properties>
              </leafNode>
            </children>
           </node>
           <leafNode name="join-prune-interval">
            <properties>
              <help>Join Prune Send Interval</help>
              <valueHelp>
                <format>u32:1-65535</format>
                <description>Interval in seconds</description>
              </valueHelp>
              <constraint>
                <validator name="numeric" argument="--range 1-65535"/>
              </constraint>
            </properties>
            <defaultValue>60</defaultValue>
          </leafNode>
          <leafNode name="keep-alive-timer">
            <properties>
              <help>Keep alive Timer</help>
              <valueHelp>
                <format>u32:1-65535</format>
                <description>Keep alive Timer in seconds</description>
              </valueHelp>
              <constraint>
                <validator name="numeric" argument="--range 1-65535"/>
              </constraint>
            </properties>
            <defaultValue>210</defaultValue>
          </leafNode>
          <leafNode name="packets">
            <properties>
              <help>Packets to process at once</help>
              <valueHelp>
                <format>u32:1-255</format>
                <description>Number of packets</description>
              </valueHelp>
              <constraint>
                <validator name="numeric" argument="--range 1-255"/>
              </constraint>
            </properties>
            <defaultValue>3</defaultValue>
          </leafNode>
          <leafNode name="register-accept-list">
            <properties>
              <help>Only accept registers from a specific source prefix list</help>
              <valueHelp>
                <format>txt</format>
                <description>Prefix-list to apply</description>
              </valueHelp>
              <completionHelp>
                <path>policy prefix-list</path>
              </completionHelp>
            </properties>
          </leafNode>
          <leafNode name="register-suppress-time">
            <properties>
              <help>Register Suppress Timer</help>
              <valueHelp>
                <format>u32:1-65535</format>
                <description>In seconds</description>
              </valueHelp>
              <constraint>
                <validator name="numeric" argument="--range 1-65535"/>
              </constraint>
            </properties>
          </leafNode>
          <node name="rp">
            <properties>
              <help>Rendezvous Point</help>
            </properties>
            <children>
              <tagNode name="address">
                <properties>
                  <help>Rendezvous Point address</help>
                  <valueHelp>
                    <format>ipv4</format>
                    <description>Rendezvous Point address</description>
                  </valueHelp>
                  <constraint>
                    <validator name="ipv4-address"/>
                  </constraint>
                </properties>
                <children>
                  <leafNode name="group">
                    <properties>
                      <help>Group Address range</help>
                      <valueHelp>
                        <format>ipv4net</format>
                        <description>Group Address range RFC 3171</description>
                      </valueHelp>
                      <constraint>
                        <validator name="ip-prefix"/>
                      </constraint>
                      <multi/>
                    </properties>
                  </leafNode>
                </children>
              </tagNode>
              <leafNode name="send-v6-secondary">
                <properties>
                  <help>Send v6 secondary addresses</help>
                  <valueless/>
                </properties>
              </leafNode>
              <node name="spt-switchover">
                <properties>
                  <help>Send v6 secondary addresses</help>
                </properties>
                <children>
                  <node name="infinity-and-beyond">
                    <properties>
                      <help>Never switch to SPT Tree</help>
                    </properties>
                    <children>
                      <leafNode name="prefix-list">
                        <properties>
                          <help>Prefix-List to control which groups to switch</help>
                          <valueHelp>
                            <format>txt</format>
                            <description>Prefix-list to apply</description>
                          </valueHelp>
                          <completionHelp>
                            <path>policy prefix-list</path>
                          </completionHelp>
                        </properties>
                      </leafNode>
                    </children>
                  </node>
                </children>
              </node>
              <leafNode name="ssm">
                <properties>
                  <help>Source-Specific Multicast</help>
                  <completionHelp>
                    <path>policy prefix-list</path>
                  </completionHelp>
                  <valueHelp>
                    <format>txt</format>
                    <description>Prefix-list to apply</description>
                  </valueHelp>
                </properties>
              </leafNode>
            </children>
          </node>
        </children>
      </node>
    </children>
  </node>
</interfaceDefinition>