summaryrefslogtreecommitdiff
path: root/interface-definitions/protocols_pim.xml.in
blob: 4a20c0d9b3d69934b031f60f76ec0d4c88efde50 (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
<?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) and IGMP</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>
            #include <include/pim/bsm.xml.i>
            #include <include/pim/dr-priority.xml.i>
            #include <include/pim/hello.xml.i>
            #include <include/pim/passive.xml.i>
            #include <include/source-address-ipv4.xml.i>
            <node name="igmp">
              <properties>
                <help>Internet Group Management Protocol (IGMP) options</help>
              </properties>
              <children>
                #include <include/generic-disable-node.xml.i>
                <tagNode name="join">
                  <properties>
                    <help>IGMP join multicast group</help>
                    <valueHelp>
                      <format>ipv4</format>
                      <description>Multicast group address</description>
                    </valueHelp>
                    <constraint>
                      <validator name="ipv4-address"/>
                    </constraint>
                  </properties>
                  <children>
                    #include <include/source-address-ipv4-multi.xml.i>
                  </children>
                </tagNode>
                <leafNode name="query-interval">
                  <properties>
                    <help>IGMP host query interval</help>
                    <valueHelp>
                      <format>u32:1-1800</format>
                      <description>Query interval in seconds</description>
                    </valueHelp>
                    <constraint>
                      <validator name="numeric" argument="--range 1-1800"/>
                    </constraint>
                  </properties>
                </leafNode>
                <leafNode name="query-max-response-time">
                  <properties>
                    <help>IGMP max query response time</help>
                    <valueHelp>
                      <format>u32:10-250</format>
                      <description>Query response value in deci-seconds</description>
                    </valueHelp>
                    <constraint>
                      <validator name="numeric" argument="--range 10-250"/>
                    </constraint>
                  </properties>
                </leafNode>
                <leafNode name="version">
                  <properties>
                    <help>Interface IGMP version</help>
                    <completionHelp>
                      <list>2 3</list>
                    </completionHelp>
                    <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>
            </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-warning">
                <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>
          #include <include/pim/join-prune-interval.xml.i>
          #include <include/pim/keep-alive-timer.xml.i>
          #include <include/pim/packets.xml.i>
          #include <include/pim/register-suppress-time.xml.i>
          <node name="register-accept-list">
            <properties>
              <help>Only accept registers from a specific source prefix list</help>
            </properties>
            <children>
              #include <include/policy/prefix-list.xml.i>
            </children>
          </node>
          <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>
              #include <include/pim/keep-alive-timer.xml.i>
            </children>
          </node>
          <leafNode name="no-v6-secondary">
            <properties>
              <help>Disable IPv6 secondary address in hello packets</help>
              <valueless/>
            </properties>
          </leafNode>
          <node name="spt-switchover">
            <properties>
              <help>Shortest-path tree (SPT) switchover</help>
            </properties>
            <children>
              <node name="infinity-and-beyond">
                <properties>
                  <help>Never switch to SPT Tree</help>
                </properties>
                <children>
                  #include <include/policy/prefix-list.xml.i>
                </children>
              </node>
            </children>
          </node>
          <node name="ssm">
            <properties>
              <help>Source-Specific Multicast</help>
            </properties>
            <children>
              #include <include/policy/prefix-list.xml.i>
            </children>
          </node>
        </children>
      </node>
    </children>
  </node>
</interfaceDefinition>