pim: T1729: Add PIM and IGMPv2/v3 support

3 files changed, 279 insertions, 0 deletions

diff --git a/interface-definitions/protocols-igmp.xml b/interface-definitions/protocols-igmp.xml
new file mode 100755
index 000000000..a9b11e1a3
--- /dev/null
+++ b/interface-definitions/protocols-igmp.xml
@@ -0,0 +1,88 @@
+<?xml version="1.0"?>
+<!-- Internet Group Management Protocol (IGMP) configuration -->
+<interfaceDefinition>
+  <node name="protocols">
+    <children>
+      <node name="igmp" owner="${vyos_conf_scripts_dir}/protocols_igmp.py">
+        <properties>
+          <help>Internet Group Management Protocol (IGMP)</help>
+        </properties>
+        <children>
+          <tagNode name="interface">
+            <properties>
+              <help>IGMP interface</help>
+              <completionHelp>
+                <script>${vyos_completion_dir}/list_interfaces.py</script>
+              </completionHelp>
+            </properties>
+            <children>
+              <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>
+                  <leafNode name="source">
+                    <properties>
+                      <help>Source address</help>
+                      <valueHelp>
+                        <format>ipv4</format>
+                        <description>Source address</description>
+                      </valueHelp>
+                      <constraint>
+                        <validator name="ipv4-address"/>
+                      </constraint>
+                      <multi/>
+                    </properties>
+                  </leafNode>
+                </children>
+              </tagNode>
+              <leafNode name="version">
+                <properties>
+                  <help>IGMP version</help>
+                  <valueHelp>
+                    <format>2-3</format>
+                    <description>IGMP version</description>
+                  </valueHelp>
+                  <constraint>
+                    <validator name="numeric" argument="--range 2-3"/>
+                  </constraint>
+                </properties>
+              </leafNode>
+              <leafNode name="query-interval">
+                <properties>
+                  <help>IGMP host query interval</help>
+                  <valueHelp>
+                    <format>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>10-250</format>
+                    <description>Query response value in deci-seconds</description>
+                  </valueHelp>
+                  <constraint>
+                    <validator name="numeric" argument="--range 10-250"/>
+                  </constraint>
+                </properties>
+              </leafNode>
+            </children>
+          </tagNode>
+        </children>
+      </node>
+    </children>
+  </node>
+</interfaceDefinition>
diff --git a/interface-definitions/protocols-multicast.xml b/interface-definitions/protocols-multicast.xml
new file mode 100755
index 000000000..a06f2b287
--- /dev/null
+++ b/interface-definitions/protocols-multicast.xml
@@ -0,0 +1,95 @@
+<?xml version="1.0"?>
+<!-- Multicast static routing configuration -->
+<interfaceDefinition>
+  <node name="protocols">
+    <children>
+      <node name="static">
+        <children>
+          <node name="multicast" owner="${vyos_conf_scripts_dir}/protocols_static_multicast.py">
+            <properties>
+              <help>Multicast static route</help>
+            </properties>
+            <children>
+              <tagNode name="route">
+                <properties>
+                  <help>Configure static unicast route into MRIB for multicast RPF lookup</help>
+                  <valueHelp>
+                    <format>ipv4net</format>
+                    <description>Network</description>
+                  </valueHelp>
+                  <constraint>
+                    <validator name="ip-prefix"/>
+                  </constraint>
+                </properties>
+                <children>
+                  <tagNode name="next-hop">
+                    <properties>
+                      <help>Nexthop IPv4 address</help>
+                      <valueHelp>
+                        <format>ipv4</format>
+                        <description>Nexthop IPv4 address</description>
+                      </valueHelp>
+                      <constraint>
+                        <validator name="ipv4-address"/>
+                      </constraint>
+                    </properties>
+                    <children>
+                      <leafNode name="distance">
+                        <properties>
+                          <help>Distance value for this route</help>
+                          <valueHelp>
+                            <format>1-255</format>
+                            <description>Distance for this route</description>
+                          </valueHelp>
+                          <constraint>
+                            <validator name="numeric" argument="--range 1-255"/>
+                          </constraint>
+                        </properties>
+                      </leafNode>
+                    </children>
+                  </tagNode>
+                </children>
+              </tagNode>
+              <tagNode name="interface-route">
+                <properties>
+                  <help>Multicast interface based route</help>
+                  <valueHelp>
+                    <format>ipv4net</format>
+                    <description>Network</description>
+                  </valueHelp>
+                  <constraint>
+                    <validator name="ip-prefix"/>
+                  </constraint>
+                </properties>
+                <children>
+                  <tagNode name="next-hop-interface">
+                    <properties>
+                      <help>Next-hop interface</help>
+                      <completionHelp>
+                        <script>${vyos_completion_dir}/list_interfaces.py</script>
+                      </completionHelp>
+                    </properties>
+                    <children>
+                      <leafNode name="distance">
+                        <properties>
+                          <help>Distance value for this route</help>
+                          <valueHelp>
+                            <format>1-255</format>
+                            <description>Distance for this route</description>
+                          </valueHelp>
+                          <constraint>
+                            <validator name="numeric" argument="--range 1-255"/>
+                          </constraint>
+                        </properties>
+                      </leafNode>
+                    </children>
+                  </tagNode>
+                </children>
+              </tagNode>
+            </children>
+          </node>
+        </children>
+      </node>
+    </children>
+  </node>
+</interfaceDefinition>
diff --git a/interface-definitions/protocols-pim.xml b/interface-definitions/protocols-pim.xml
new file mode 100755
index 000000000..6152045a7
--- /dev/null
+++ b/interface-definitions/protocols-pim.xml
@@ -0,0 +1,96 @@
+<?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.py</script>
+              </completionHelp>
+            </properties>
+            <children>
+              <leafNode name="dr-priority">
+                <properties>
+                  <help>Designated Router Election Priority</help>
+                  <valueHelp>
+                    <format>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>1-180</format>
+                    <description>Hello Interval in seconds</description>
+                  </valueHelp>
+                  <constraint>
+                    <validator name="numeric" argument="--range 1-180"/>
+                  </constraint>
+                </properties>
+              </leafNode>
+            </children>
+          </tagNode>
+          <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="keep-alive-timer">
+                <properties>
+                  <help>Keep alive Timer</help>
+                  <valueHelp>
+                    <format>31-60000</format>
+                    <description>Keep alive Timer in seconds</description>
+                  </valueHelp>
+                  <constraint>
+                    <validator name="numeric" argument="--range 31-60000"/>
+                  </constraint>
+                </properties>
+              </leafNode>
+            </children>
+          </node>
+        </children>
+      </node>
+    </children>
+  </node>
+</interfaceDefinition>