updates as per kirk recommendations

napalm-automation · Nov 17, 2017 · 24c5b39 · 24c5b39
1 parent a5fac96
commit 24c5b39
Show file tree

Hide file tree

Showing 5 changed files with 106 additions and 110 deletions.
diff --git a/napalm/base/base.py b/napalm/base/base.py
@@ -1586,8 +1586,8 @@ def compliance_report(self, validation_file=None, validation_source=None):
 
     def canonical_int(self, interface):
         """Expose the helper function within this class."""
-        if self.set_canonical_interface is True:
-            return napalm.base.helpers.canonical_interface(interface, True, short=False,
+        if self.use_canonical_interface is True:
+            return napalm.base.helpers.canonical_interface(interface, change=True, short=False,
                                                            update_long_to_short=None)
         else:
             return interface
diff --git a/napalm/base/canonical_map.py b/napalm/base/canonical_map.py
@@ -0,0 +1,101 @@
+from __future__ import print_function
+from __future__ import unicode_literals
+
+
+base_interfaces = {
+  "ATM": "ATM",
+  "AT": "ATM",
+  "EOBC": "EOBC",
+  "EO": "EOBC",
+  "Ethernet": "Ethernet",
+  "Eth": "Ethernet",
+  "Et": "Ethernet",
+  "FastEthernet": "FastEthernet",
+  "FastEth": "FastEthernet",
+  "FastE": "FastEthernet",
+  "Fast": "FastEthernet",
+  "Fas": "FastEthernet",
+  "FE": "FastEthernet",
+  "Fa": "FastEthernet",
+  "Fddi": "Fddi",
+  "FD": "Fddi",
+  "FortyGigabitEthernet": "FortyGigabitEthernet",
+  "FortyGigEthernet": "FortyGigabitEthernet",
+  "FortyGigEth": "FortyGigabitEthernet",
+  "FortyGigE": "FortyGigabitEthernet",
+  "FortyGig": "FortyGigabitEthernet",
+  "FGE": "FortyGigabitEthernet",
+  "FO": "FortyGigabitEthernet",
+  "Fo": "FortyGigabitEthernet",
+  "GigabitEthernet": "GigabitEthernet",
+  "GigEthernet": "GigabitEthernet",
+  "GigEth": "GigabitEthernet",
+  "GigE": "GigabitEthernet",
+  "Gig": "GigabitEthernet",
+  "GE": "GigabitEthernet",
+  "Gi": "GigabitEthernet",
+  "HundredGigabitEthernet": "HundredGigabitEthernet",
+  "HundredGigEthernet": "HundredGigabitEthernet",
+  "HundredGigEth": "HundredGigabitEthernet",
+  "HundredGigE": "HundredGigabitEthernet",
+  "HundredGig": "HundredGigabitEthernet",
+  "Hu": "HundredGigabitEthernet",
+  "Loopback": "Loopback",
+  "Lo": "Loopback",
+  "Management": "Management",
+  "Mgmt": "Management",
+  "Ma": "Management",
+  "Management_short": "Ma",
+  "MFR": "MFR",
+  "Multilink": "Multilink",
+  "Mu": "Multilink",
+  "PortChannel": "PortChannel",
+  "Port-Channel": "PortChannel",
+  "Po": "PortChannel",
+  "POS": "POS",
+  "PO": "POS",
+  "Serial": "Serial",
+  "Se": "Serial",
+  "S": "Serial",
+  "TenGigabitEthernet": "TenGigabitEthernet",
+  "TenGigEthernet": "TenGigabitEthernet",
+  "TenGigEth": "TenGigabitEthernet",
+  "TenGig": "TenGigabitEthernet",
+  "TeGig": "TenGigabitEthernet",
+  "Ten": "TenGigabitEthernet",
+  "T": "TenGigabitEthernet",
+  "Te": "TenGigabitEthernet",
+  "Tunnel": "Tunnel",
+  "Tun": "Tunnel",
+  "Tu": "Tunnel",
+  "Virtual-Access": "Virtual-Access",
+  "Vi": "Virtual-Access",
+  "Virtual-Template": "Virtual-Template",
+  "Vt": "Virtual-Template",
+  "VLAN": "VLAN",
+  "V": "VLAN",
+  "Vl": "VLAN"
+}
+
+reverse_mapping = {
+  "ATM": "At",
+  "EOBC": "EO",
+  "Ethernet": "Et",
+  "FastEthernet": "Fa",
+  "Fddi": "FD",
+  "FortyGigabitEthernet": "Fo",
+  "GigabitEthernet": "Gi",
+  "HundredGigabitEthernet": "Hu",
+  "Loopback": "Lo",
+  "Management": "Ma",
+  "MFR": "MFR",
+  "Multilink": "Mu",
+  "PortChannel": "Po",
+  "POS": "PO",
+  "Serial": "Se",
+  "TenGigabitEthernet": "Te",
+  "Tunnel": "Tu",
+  "Virtual-Access": "Vi",
+  "Virtual-Template": "Vt",
+  "VLAN": "Vl"
+}
diff --git a/napalm/base/helpers.py b/napalm/base/helpers.py
@@ -19,7 +19,7 @@
 import napalm.base.exceptions
 from napalm.base.utils.jinja_filters import CustomJinjaFilters
 from napalm.base.utils import py23_compat
-from napalm.base.interface_map import interface_map
+from napalm.base.canonical_map import base_interfaces, reverse_mapping
 
 
 # ----------------------------------------------------------------------------------------------------------------------
@@ -258,7 +258,7 @@ def as_number(as_number_val):
         return int(as_number_str)
 
 
-def canonical_interface(interface, change, short=False, update_long_to_short=None):
+def canonical_interface(interface, change=False, short=False, update_long_to_short=None):
     '''
     Function to retun interface canonical name
     This puposely does not use regex, or first X characters, to ensure
@@ -278,9 +278,6 @@ def split_on_match(split_interface):
 
     interface_type, interface_number = split_on_match(interface)
 
-    base_interfaces = interface_map['base_interfaces']
-    reverse_mapping = interface_map['reverse_mapping']
-
     if isinstance(update_long_to_short, dict):
         base_interfaces.update(update_long_to_short)
     # check in dict for mapping

diff --git a/napalm/base/interface_map.py b/napalm/base/interface_map.py
diff --git a/napalm/ios/ios.py b/napalm/ios/ios.py
@@ -128,7 +128,7 @@ def __init__(self, hostname, username, password, timeout=60, optional_args=None)
 
         self.profile = ["ios"]
 
-        self.set_canonical_interface = optional_args.get('canonical_int', False)
+        self.use_canonical_interface = optional_args.get('canonical_int', False)
 
     def open(self):
         """Open a connection to the device."""