mroute: T2364: Implement CLI commands for mroute

3 files changed, 230 insertions, 0 deletions

diff --git a/data/templates/frr-mcast/static_mcast.frr.tmpl b/data/templates/frr-mcast/static_mcast.frr.tmpl
new file mode 100644
index 000000000..86d619ab0
--- /dev/null
+++ b/data/templates/frr-mcast/static_mcast.frr.tmpl
@@ -0,0 +1,20 @@
+!
+{% for route_gr in old_mroute -%}
+{% for nh in old_mroute[route_gr] -%}
+{% if old_mroute[route_gr][nh] -%}
+no ip mroute {{ route_gr }} {{ nh }} {{ old_mroute[route_gr][nh] }}
+{% else -%}
+no ip mroute {{ route_gr }} {{ nh }}
+{% endif -%}
+{% endfor -%}
+{% endfor -%}
+{% for route_gr in mroute -%}
+{% for nh in mroute[route_gr] -%}
+{% if mroute[route_gr][nh] -%}
+ip mroute {{ route_gr }} {{ nh }} {{ mroute[route_gr][nh] }}
+{% else -%}
+ip mroute {{ route_gr }} {{ nh }}
+{% endif -%}
+{% endfor -%}
+{% endfor -%}
+!
diff --git a/interface-definitions/protocols-multicast.xml.in b/interface-definitions/protocols-multicast.xml.in
new file mode 100644
index 000000000..a06f2b287
--- /dev/null
+++ b/interface-definitions/protocols-multicast.xml.in
@@ -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/src/conf_mode/protocols_static_multicast.py b/src/conf_mode/protocols_static_multicast.py
new file mode 100755
index 000000000..411a130ec
--- /dev/null
+++ b/src/conf_mode/protocols_static_multicast.py
@@ -0,0 +1,115 @@
+#!/usr/bin/env python3
+#
+# Copyright (C) 2020 VyOS maintainers and contributors
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 2 or later as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+import os
+
+from ipaddress import IPv4Address
+from sys import exit
+
+from vyos import ConfigError
+from vyos.config import Config
+from vyos.util import call
+from vyos.template import render
+
+
+config_file = r'/tmp/static_mcast.frr'
+
+# Get configuration for static multicast route
+def get_config():
+    conf = Config()
+    mroute = {
+        'old_mroute' : {},
+        'mroute' : {}
+    }
+
+    base_path = "protocols static multicast"
+
+    if not (conf.exists(base_path) or conf.exists_effective(base_path)):
+        return None
+
+    conf.set_level(base_path)
+
+    # Get multicast effective routes
+    for route in conf.list_effective_nodes('route'):
+        mroute['old_mroute'][route] = {}
+        for next_hop in conf.list_effective_nodes('route {0} next-hop'.format(route)):
+            mroute['old_mroute'][route].update({
+                next_hop : conf.return_value('route {0} next-hop {1} distance'.format(route, next_hop))
+            })
+
+    # Get multicast effective interface-routes
+    for route in conf.list_effective_nodes('interface-route'):
+        if not route in  mroute['old_mroute']:
+            mroute['old_mroute'][route] = {}
+        for next_hop in conf.list_effective_nodes('interface-route {0} next-hop-interface'.format(route)):
+            mroute['old_mroute'][route].update({
+                next_hop : conf.return_value('interface-route {0} next-hop-interface {1} distance'.format(route, next_hop))
+            })
+
+    # Get multicast routes
+    for route in conf.list_nodes('route'):
+        mroute['mroute'][route] = {}
+        for next_hop in conf.list_nodes('route {0} next-hop'.format(route)):
+            mroute['mroute'][route].update({
+                next_hop : conf.return_value('route {0} next-hop {1} distance'.format(route, next_hop))
+            })
+
+    # Get multicast interface-routes
+    for route in conf.list_nodes('interface-route'):
+        if not route in  mroute['mroute']:
+            mroute['mroute'][route] = {}
+        for next_hop in conf.list_nodes('interface-route {0} next-hop-interface'.format(route)):
+            mroute['mroute'][route].update({
+                next_hop : conf.return_value('interface-route {0} next-hop-interface {1} distance'.format(route, next_hop))
+            })
+
+    return mroute
+
+def verify(mroute):
+    if mroute is None:
+        return None
+
+    for route in mroute['mroute']:
+        route = route.split('/')
+        if IPv4Address(route[0]) < IPv4Address('224.0.0.0'):
+            raise ConfigError(route + " not a multicast network")
+
+def generate(mroute):
+    if mroute is None:
+        return None
+
+    render(config_file, 'frr-mcast/static_mcast.frr.tmpl', mroute)
+    return None
+
+def apply(mroute):
+    if mroute is None:
+        return None
+
+    if os.path.exists(config_file):
+        call("sudo vtysh -d staticd -f " + config_file)
+        os.remove(config_file)
+
+    return None
+
+if __name__ == '__main__':
+    try:
+        c = get_config()
+        verify(c)
+        generate(c)
+        apply(c)
+    except ConfigError as e:
+        print(e)
+        exit(1)