tunnel: T3366: rename remote-ip to remote

Streamline the CLI configuration where we try to use remote on other interfaces
like vxlan, geneve.

12 files changed, 69 insertions, 134 deletions

diff --git a/interface-definitions/include/tunnel-local-remote-ip.xml.i b/interface-definitions/include/tunnel-local-remote-ip.xml.i
deleted file mode 100644
index f86e1dd8c..000000000
--- a/interface-definitions/include/tunnel-local-remote-ip.xml.i
+++ /dev/null
@@ -1,19 +0,0 @@
-<!-- included start from tunnel-local-remote-ip.xml.i -->
-#include <include/source-address-ipv4-ipv6.xml.i>
-<leafNode name="remote-ip">
-  <properties>
-    <help>Remote IP address for this tunnel</help>
-    <valueHelp>
-      <format>ipv4</format>
-      <description>Remote IPv4 address for this tunnel</description>
-    </valueHelp>
-    <valueHelp>
-      <format>ipv6</format>
-      <description>Remote IPv6 address for this tunnel</description>
-    </valueHelp>
-    <constraint>
-      <!-- does it need fixing/changing to be more restrictive ? -->
-      <validator name="ip-address"/>
-    </constraint>
-  </properties>
-</leafNode>
diff --git a/interface-definitions/include/tunnel-remote.xml.i b/interface-definitions/include/tunnel-remote.xml.i
new file mode 100644
index 000000000..d5b50d3f6
--- /dev/null
+++ b/interface-definitions/include/tunnel-remote.xml.i
@@ -0,0 +1,18 @@
+<!-- included start from tunnel-remote.xml.i -->
+<leafNode name="remote">
+  <properties>
+    <help>Tunnel remote address</help>
+    <valueHelp>
+      <format>ipv4</format>
+      <description>Tunnel remote IPv4 address</description>
+    </valueHelp>
+    <valueHelp>
+      <format>ipv6</format>
+      <description>Tunnel remote IPv6 address</description>
+    </valueHelp>
+    <constraint>
+      <validator name="ip-address"/>
+    </constraint>
+  </properties>
+</leafNode>
+<!-- included end -->
diff --git a/interface-definitions/interfaces-erspan.xml.in b/interface-definitions/interfaces-erspan.xml.in
index e36a64d3a..2394d3534 100644
--- a/interface-definitions/interfaces-erspan.xml.in
+++ b/interface-definitions/interfaces-erspan.xml.in
@@ -20,7 +20,8 @@
           #include <include/interface-disable.xml.i>
           #include <include/interface-disable-link-detect.xml.i>
           #include <include/interface-mtu-64-8024.xml.i>
-          #include <include/tunnel-local-remote-ip.xml.i>
+          #include <include/source-address-ipv4-ipv6.xml.i>
+          #include <include/tunnel-remote.xml.i>
           <leafNode name="encapsulation">
             <properties>
               <help>Encapsulation of this tunnel interface</help>
diff --git a/interface-definitions/interfaces-geneve.xml.in b/interface-definitions/interfaces-geneve.xml.in
index 1064b2c18..5894f580c 100644
--- a/interface-definitions/interfaces-geneve.xml.in
+++ b/interface-definitions/interfaces-geneve.xml.in
@@ -23,18 +23,7 @@
           #include <include/interface-ipv6-options.xml.i>
           #include <include/interface-mac.xml.i>
           #include <include/interface-mtu-1450-16000.xml.i>
-          <leafNode name="remote">
-            <properties>
-              <help>Remote address of GENEVE tunnel</help>
-              <valueHelp>
-                <format>ipv4</format>
-                <description>Remote address of GENEVE tunnel</description>
-              </valueHelp>
-              <constraint>
-                <validator name="ipv4-address"/>
-              </constraint>
-            </properties>
-          </leafNode>
+          #include <include/tunnel-remote.xml.i>
           #include <include/vni.xml.i>
         </children>
       </tagNode>
diff --git a/interface-definitions/interfaces-tunnel.xml.in b/interface-definitions/interfaces-tunnel.xml.in
index bb23ba933..c2d03c5ea 100644
--- a/interface-definitions/interfaces-tunnel.xml.in
+++ b/interface-definitions/interfaces-tunnel.xml.in
@@ -27,7 +27,8 @@
           </leafNode>
           #include <include/interface-ipv4-options.xml.i>
           #include <include/interface-ipv6-options.xml.i>
-          #include <include/tunnel-local-remote-ip.xml.i>
+          #include <include/source-address-ipv4-ipv6.xml.i>
+          #include <include/tunnel-remote.xml.i>
           <leafNode name="source-interface">
             <properties>
               <help>Physical Interface used for underlaying traffic</help>
diff --git a/interface-definitions/interfaces-vxlan.xml.in b/interface-definitions/interfaces-vxlan.xml.in
index 2afe8685a..efe6218e1 100644
--- a/interface-definitions/interfaces-vxlan.xml.in
+++ b/interface-definitions/interfaces-vxlan.xml.in
@@ -44,22 +44,7 @@
           <leafNode name="mtu">
             <defaultValue>1450</defaultValue>
           </leafNode>
-          <leafNode name="remote">
-            <properties>
-              <help>Remote address of VXLAN tunnel</help>
-              <valueHelp>
-                <format>ipv4</format>
-                <description>Remote IPv4 address of VXLAN tunnel</description>
-              </valueHelp>
-              <valueHelp>
-                <format>ipv6</format>
-                <description>Remote IPv6 address of VXLAN tunnel</description>
-              </valueHelp>
-              <constraint>
-                <validator name="ip-address"/>
-              </constraint>
-            </properties>
-          </leafNode>
+          #include <include/tunnel-remote.xml.i>
           <node name="parameters">
             <properties>
               <help>VXLAN tunnel parameters</help>
diff --git a/python/vyos/configverify.py b/python/vyos/configverify.py
index c901ccbc5..db3e7cc57 100644
--- a/python/vyos/configverify.py
+++ b/python/vyos/configverify.py
@@ -103,8 +103,8 @@ def verify_tunnel(config):
     if 'source_address' not in config and 'dhcp_interface' not in config:
         raise ConfigError('source-address is mandatory for tunnel')
 
-    if 'remote_ip' not in config and config['encapsulation'] != 'gre':
-        raise ConfigError('remote-ip is mandatory for tunnel')
+    if 'remote' not in config and config['encapsulation'] != 'gre':
+        raise ConfigError('remote ip address is mandatory for tunnel')
 
     if {'source_address', 'dhcp_interface'} <= set(config):
         raise ConfigError('Can not use both source-address and dhcp-interface')
@@ -114,15 +114,15 @@ def verify_tunnel(config):
         if 'source_address' in config and not is_ipv6(config['source_address']):
             raise ConfigError(f'{error_ipv6} source-address')
 
-        if 'remote_ip' in config and not is_ipv6(config['remote_ip']):
-            raise ConfigError(f'{error_ipv6} remote-ip')
+        if 'remote' in config and not is_ipv6(config['remote']):
+            raise ConfigError(f'{error_ipv6} remote')
     else:
         error_ipv4 = 'Encapsulation mode requires IPv4'
         if 'source_address' in config and not is_ipv4(config['source_address']):
             raise ConfigError(f'{error_ipv4} source-address')
 
-        if 'remote_ip' in config and not is_ipv4(config['remote_ip']):
-            raise ConfigError(f'{error_ipv4} remote-ip')
+        if 'remote' in config and not is_ipv4(config['remote']):
+            raise ConfigError(f'{error_ipv4} remote address')
 
     if config['encapsulation'] in ['sit', 'gretap']:
         if 'source_interface' in config:
diff --git a/python/vyos/ifconfig/erspan.py b/python/vyos/ifconfig/erspan.py
index e0f72109d..9e24cf6cd 100755
--- a/python/vyos/ifconfig/erspan.py
+++ b/python/vyos/ifconfig/erspan.py
@@ -76,11 +76,11 @@ class ERSpanIf(_ERSpan):
 
     def _create(self):
         ifname = self.config['ifname']
-        local_ip = self.config['local_ip']
-        remote_ip = self.config['remote_ip']
+        source_address = self.config['source_address']
+        remote = self.config['remote']
         key = self.config['parameters']['ip']['key']
         version = self.config['parameters']['version']
-        command = f'ip link add dev {ifname} type erspan local {local_ip} remote {remote_ip} seq key {key} erspan_ver {version}'
+        command = f'ip link add dev {ifname} type erspan local {source_address} remote {remote} seq key {key} erspan_ver {version}'
 
         if int(version) == 1:
             idx=dict_search('parameters.erspan.idx',self.config)
@@ -105,11 +105,11 @@ class ERSpanIf(_ERSpan):
 
     def change_options(self):
         ifname = self.config['ifname']
-        local_ip = self.config['local_ip']
-        remote_ip = self.config['remote_ip']
+        source_address = self.config['source_address']
+        remote = self.config['remote']
         key = self.config['parameters']['ip']['key']
         version = self.config['parameters']['version']
-        command = f'ip link set dev {ifname} type erspan local {local_ip} remote {remote_ip} seq key {key} erspan_ver {version}'
+        command = f'ip link set dev {ifname} type erspan local {source_address} remote {remote} seq key {key} erspan_ver {version}'
 
         if int(version) == 1:
             idx=dict_search('parameters.erspan.idx',self.config)
@@ -139,11 +139,11 @@ class ER6SpanIf(_ERSpan):
 
     def _create(self):
         ifname = self.config['ifname']
-        local_ip = self.config['local_ip']
-        remote_ip = self.config['remote_ip']
+        source_address = self.config['source_address']
+        remote = self.config['remote']
         key = self.config['parameters']['ip']['key']
         version = self.config['parameters']['version']
-        command = f'ip link add dev {ifname} type ip6erspan local {local_ip} remote {remote_ip} seq key {key} erspan_ver {version}'
+        command = f'ip link add dev {ifname} type ip6erspan local {source_address} remote {remote} seq key {key} erspan_ver {version}'
 
         if int(version) == 1:
             idx=dict_search('parameters.erspan.idx',self.config)
@@ -168,11 +168,11 @@ class ER6SpanIf(_ERSpan):
 
     def change_options(self):
         ifname = self.config['ifname']
-        local_ip = self.config['local_ip']
-        remote_ip = self.config['remote_ip']
+        source_address = self.config['source_address']
+        remote = self.config['remote']
         key = self.config['parameters']['ip']['key']
         version = self.config['parameters']['version']
-        command = f'ip link set dev {ifname} type ip6erspan local {local_ip} remote {remote_ip} seq key {key} erspan_ver {version}'
+        command = f'ip link set dev {ifname} type ip6erspan local {source_address} remote {remote} seq key {key} erspan_ver {version}'
 
         if int(version) == 1:
             idx=dict_search('parameters.erspan.idx',self.config)
diff --git a/python/vyos/ifconfig/tunnel.py b/python/vyos/ifconfig/tunnel.py
index 2820e2563..bb940b0cf 100644
--- a/python/vyos/ifconfig/tunnel.py
+++ b/python/vyos/ifconfig/tunnel.py
@@ -53,7 +53,7 @@ class TunnelIf(Interface):
     mapping = {
         'source_address'                  : 'local',
         'source_interface'                : 'dev',
-        'remote_ip'                       : 'remote',
+        'remote'                          : 'remote',
         'parameters.ip.key'               : 'key',
         'parameters.ip.tos'               : 'tos',
         'parameters.ip.ttl'               : 'ttl',
diff --git a/smoketest/scripts/cli/test_interfaces_erspan.py b/smoketest/scripts/cli/test_interfaces_erspan.py
index c180f0a34..d0814f2fb 100755
--- a/smoketest/scripts/cli/test_interfaces_erspan.py
+++ b/smoketest/scripts/cli/test_interfaces_erspan.py
@@ -27,51 +27,6 @@ mtu = 1500
 
 def erspan_conf(interface):
     tmp = cmd(f'ip -d -j link show {interface}')
-    '''
-    [
-        {
-            "ifindex": 17,
-            "link": null,
-            "ifname": "ersp0",
-            "flags": [
-                "BROADCAST",
-                "MULTICAST"
-            ],
-            "mtu": 1450,
-            "qdisc": "noop",
-            "operstate": "DOWN",
-            "linkmode": "DEFAULT",
-            "group": "default",
-            "txqlen": 1000,
-            "link_type": "ether",
-            "address": "22:27:14:7b:0d:79",
-            "broadcast": "ff:ff:ff:ff:ff:ff",
-            "promiscuity": 0,
-            "min_mtu": 68,
-            "max_mtu": 0,
-            "linkinfo": {
-                "info_kind": "erspan",
-                "info_data": {
-                    "remote": "10.2.2.2",
-                    "local": "10.1.1.1",
-                    "ttl": 0,
-                    "pmtudisc": true,
-                    "ikey": "0.0.0.123",
-                    "okey": "0.0.0.123",
-                    "iseq": true,
-                    "oseq": true,
-                    "erspan_index": 0,
-                    "erspan_ver": 1
-                }
-            },
-            "inet6_addr_gen_mode": "eui64",
-            "num_tx_queues": 1,
-            "num_rx_queues": 1,
-            "gso_max_size": 65536,
-            "gso_max_segs": 65535
-        }
-    ]
-    '''
     return json.loads(tmp)[0]
 
 class ERSPanTunnelInterfaceTest(BasicInterfaceTest.BaseTest):
@@ -96,8 +51,8 @@ class ERSPanTunnelInterfaceTest(BasicInterfaceTest.BaseTest):
         key = 123
 
         self.session.set(self._base_path + [interface, 'encapsulation', encapsulation])
-        self.session.set(self._base_path + [interface, 'local-ip', self.local_v4])
-        self.session.set(self._base_path + [interface, 'remote-ip', self.remote_v4])
+        self.session.set(self._base_path + [interface, 'source-address', self.local_v4])
+        self.session.set(self._base_path + [interface, 'remote', self.remote_v4])
         self.session.set(self._base_path + [interface, 'parameters', 'ip' , 'key', str(key)])
 
         self.session.commit()
@@ -107,8 +62,8 @@ class ERSPanTunnelInterfaceTest(BasicInterfaceTest.BaseTest):
         self.assertEqual(encapsulation, conf['linkinfo']['info_kind'])
         self.assertEqual(mtu, conf['mtu'])
 
-        self.assertEqual(self.local_v4, conf['linkinfo']['info_data']['local'])
-        self.assertEqual(self.remote_v4,     conf['linkinfo']['info_data']['remote'])
+        self.assertEqual(self.local_v4,  conf['linkinfo']['info_data']['local'])
+        self.assertEqual(self.remote_v4, conf['linkinfo']['info_data']['remote'])
 
 
     def test_erspan_ipv6(self):
@@ -117,8 +72,8 @@ class ERSPanTunnelInterfaceTest(BasicInterfaceTest.BaseTest):
         key = 123
 
         self.session.set(self._base_path + [interface, 'encapsulation', encapsulation])
-        self.session.set(self._base_path + [interface, 'local-ip', self.local_v6])
-        self.session.set(self._base_path + [interface, 'remote-ip', self.remote_v6])
+        self.session.set(self._base_path + [interface, 'source-address', self.local_v6])
+        self.session.set(self._base_path + [interface, 'remote', self.remote_v6])
         self.session.set(self._base_path + [interface, 'parameters', 'ip' , 'key', str(key)])
 
         self.session.commit()
@@ -128,8 +83,8 @@ class ERSPanTunnelInterfaceTest(BasicInterfaceTest.BaseTest):
         self.assertEqual(encapsulation, conf['linkinfo']['info_kind'])
         self.assertEqual(mtu, conf['mtu'])
 
-        self.assertEqual(self.local_v6, conf['linkinfo']['info_data']['local'])
-        self.assertEqual(self.remote_v6,     conf['linkinfo']['info_data']['remote'])
+        self.assertEqual(self.local_v6,  conf['linkinfo']['info_data']['local'])
+        self.assertEqual(self.remote_v6, conf['linkinfo']['info_data']['remote'])
 
 if __name__ == '__main__':
     unittest.main(verbosity=2)
diff --git a/smoketest/scripts/cli/test_interfaces_tunnel.py b/smoketest/scripts/cli/test_interfaces_tunnel.py
index cf7e7aac9..cc8fbd527 100755
--- a/smoketest/scripts/cli/test_interfaces_tunnel.py
+++ b/smoketest/scripts/cli/test_interfaces_tunnel.py
@@ -71,8 +71,8 @@ class TunnelInterfaceTest(BasicInterfaceTest.BaseTest):
         cls.local_v4 = '192.0.2.1'
         cls.local_v6 = '2001:db8::1'
         cls._options = {
-            'tun10': ['encapsulation ipip', 'remote-ip 192.0.2.10', 'source-address ' + cls.local_v4],
-            'tun20': ['encapsulation gre',  'remote-ip 192.0.2.20', 'source-address ' + cls.local_v4],
+            'tun10': ['encapsulation ipip', 'remote 192.0.2.10', 'source-address ' + cls.local_v4],
+            'tun20': ['encapsulation gre',  'remote 192.0.2.20', 'source-address ' + cls.local_v4],
         }
         cls._interfaces = list(cls._options)
 
@@ -95,17 +95,17 @@ class TunnelInterfaceTest(BasicInterfaceTest.BaseTest):
             self.session.set(self._base_path + [interface, 'address', local_if_addr])
             self.session.set(self._base_path + [interface, 'encapsulation', encapsulation])
             self.session.set(self._base_path + [interface, 'source-address', self.local_v6])
-            self.session.set(self._base_path + [interface, 'remote-ip', remote_ip6])
+            self.session.set(self._base_path + [interface, 'remote', remote_ip6])
 
             # Encapsulation mode requires IPv4 source-address
             with self.assertRaises(ConfigSessionError):
                 self.session.commit()
             self.session.set(self._base_path + [interface, 'source-address', self.local_v4])
 
-            # Encapsulation mode requires IPv4 remote-ip
+            # Encapsulation mode requires IPv4 remote
             with self.assertRaises(ConfigSessionError):
                 self.session.commit()
-            self.session.set(self._base_path + [interface, 'remote-ip', remote_ip4])
+            self.session.set(self._base_path + [interface, 'remote', remote_ip4])
             self.session.set(self._base_path + [interface, 'source-interface', source_if])
 
             # Source interface can not be used with sit and gretap
@@ -142,17 +142,17 @@ class TunnelInterfaceTest(BasicInterfaceTest.BaseTest):
             self.session.set(self._base_path + [interface, 'address', local_if_addr])
             self.session.set(self._base_path + [interface, 'encapsulation', encapsulation])
             self.session.set(self._base_path + [interface, 'source-address', self.local_v4])
-            self.session.set(self._base_path + [interface, 'remote-ip', remote_ip4])
+            self.session.set(self._base_path + [interface, 'remote', remote_ip4])
 
             # Encapsulation mode requires IPv6 source-address
             with self.assertRaises(ConfigSessionError):
                 self.session.commit()
             self.session.set(self._base_path + [interface, 'source-address', self.local_v6])
 
-            # Encapsulation mode requires IPv6 remote-ip
+            # Encapsulation mode requires IPv6 remote
             with self.assertRaises(ConfigSessionError):
                 self.session.commit()
-            self.session.set(self._base_path + [interface, 'remote-ip', remote_ip6])
+            self.session.set(self._base_path + [interface, 'remote', remote_ip6])
 
             # Configure Tunnel Source interface
             self.session.set(self._base_path + [interface, 'source-interface', source_if])
@@ -190,7 +190,7 @@ class TunnelInterfaceTest(BasicInterfaceTest.BaseTest):
         self.session.set(self._base_path + [interface, 'address', local_if_addr])
         self.session.set(self._base_path + [interface, 'encapsulation', 'gre'])
         self.session.set(self._base_path + [interface, 'source-address', self.local_v4])
-        self.session.set(self._base_path + [interface, 'remote-ip', remote_ip4])
+        self.session.set(self._base_path + [interface, 'remote', remote_ip4])
         self.session.set(self._base_path + [interface, 'dhcp-interface', 'eth0'])
 
         # source-address and dhcp-interface can not be used at the same time
@@ -209,7 +209,7 @@ class TunnelInterfaceTest(BasicInterfaceTest.BaseTest):
 
         self.session.set(self._base_path + [interface, 'encapsulation', encapsulation])
         self.session.set(self._base_path + [interface, 'source-address', self.local_v4])
-        self.session.set(self._base_path + [interface, 'remote-ip', remote_ip4])
+        self.session.set(self._base_path + [interface, 'remote', remote_ip4])
 
         self.session.set(self._base_path + [interface, 'parameters', 'ip', 'no-pmtu-discovery'])
         self.session.set(self._base_path + [interface, 'parameters', 'ip', 'key', gre_key])
@@ -235,7 +235,7 @@ class TunnelInterfaceTest(BasicInterfaceTest.BaseTest):
 
         self.session.set(self._base_path + [interface, 'encapsulation', encapsulation])
         self.session.set(self._base_path + [interface, 'source-address', self.local_v4])
-        self.session.set(self._base_path + [interface, 'remote-ip', remote_ip4])
+        self.session.set(self._base_path + [interface, 'remote', remote_ip4])
 
         # Check if commit is ok
         self.session.commit()
@@ -248,9 +248,9 @@ class TunnelInterfaceTest(BasicInterfaceTest.BaseTest):
         self.assertEqual(remote_ip4,    conf['linkinfo']['info_data']['remote'])
         self.assertEqual(0,             conf['linkinfo']['info_data']['ttl'])
 
-        # Change remote-ip (inc host by 2
+        # Change remote ip address (inc host by 2
         new_remote = inc_ip(remote_ip4, 2)
-        self.session.set(self._base_path + [interface, 'remote-ip', new_remote])
+        self.session.set(self._base_path + [interface, 'remote', new_remote])
         # Check if commit is ok
         self.session.commit()
 
diff --git a/src/migration-scripts/interfaces/19-to-20 b/src/migration-scripts/interfaces/19-to-20
index 1727ac4dc..ed2780b92 100755
--- a/src/migration-scripts/interfaces/19-to-20
+++ b/src/migration-scripts/interfaces/19-to-20
@@ -37,6 +37,7 @@ if __name__ == '__main__':
     #
     # Migrate "interface tunnel <tunX> encapsulation gre-bridge" to gretap
     # Migrate "interface tunnel <tunX> local-ip" to source-address
+    # Migrate "interface tunnel <tunX> remote-ip" to remote
     for interface in config.list_nodes(base):
         encap_path = base + [interface, 'encapsulation']
         if config.exists(encap_path):
@@ -48,6 +49,10 @@ if __name__ == '__main__':
         if config.exists(local_ip_path):
             config.rename(local_ip_path, 'source-address')
 
+        remote_ip_path = base + [interface, 'remote-ip']
+        if config.exists(remote_ip_path):
+            config.rename(remote_ip_path, 'remote')
+
     try:
         with open(file_name, 'w') as f:
             f.write(config.to_string())