Merge branch 'develop'

Author: ktbyers

.gitignore

@@ -63,7 +63,8 @@ test/unit/test_devices.py
 
 report.json
 tags
+.pytest_cache/
 
 docs/integrations/ansible/modules/napalm_*/
 docs/integrations/ansible/modules/source/*.json
-docs/napalm_ansible_repo/
+docs/napalm_ansible_repo/

README.md

@@ -60,6 +60,11 @@ SaltStack
 
 Beginning with release code named `Carbon` (2016.11), [NAPALM is fully integrated](https://mirceaulinic.net/2016-11-30-salt-carbon-released/) in SaltStack - no additional modules required. For setup recommendations, please see [napalm-salt](https://github.com/napalm-automation/napalm-salt). For documentation and usage examples, you can check the modules documentation, starting from the [release notes](https://docs.saltstack.com/en/develop/topics/releases/2016.11.0.html#network-automation-napalm) and [this blog post](https://mirceaulinic.net/2016-11-17-network-orchestration-with-salt-and-napalm/).
 
+StackStorm
+----------
+
+NAPALM is usable from StackStorm using the [NAPALM integration pack](https://github.com/StackStorm-Exchange/stackstorm-napalm). See that repository for instructions on installing and configuring the pack to work with StackStorm. General StackStorm documentation can be found at [https://docs.stackstorm.com/](https://docs.stackstorm.com/), and StackStorm can be easily spun up for testing using [Vagrant](https://github.com/StackStorm/st2vagrant) or [Docker](https://github.com/StackStorm/st2-docker).
+
 
 Contact
 =======
@@ -105,6 +110,7 @@ Blog Posts
 * [NAPALM, Ansible, and Cisco IOS](https://pynet.twb-tech.com/blog/automation/napalm-ios.html) by Kirk Byers
 * [Adding Cisco IOS support to NAPALM (Network Automation and Programmability Abstraction Layer with Multivendor support)](https://projectme10.wordpress.com/2015/12/07/adding-cisco-ios-support-to-napalm-network-automation-and-programmability-abstraction-layer-with-multivendor-support/) by Gabriele Gerbino
 * [Network orchestration with Salt and NAPALM](https://mirceaulinic.net/2016-11-17-network-orchestration-with-salt-and-napalm/) by Mircea Ulinic
+* [Network Configuration Consistency with StackStorm and NAPALM](https://stackstorm.com/2017/04/11/ensuring-network-configuration-consistency-stackstorm-napalm/) by Matt Oswalt
 
 Presentations
 -------------

docs/support/index.rst

@@ -8,16 +8,15 @@ General support matrix
 
 
 
-  =====================   ==========  =============   ============ ============  ============
-  _                       EOS         JunOS           IOS-XR       NXOS          IOS
-  =====================   ==========  =============   ============ ============  ============
-  **Module Name**         napalm-eos  napalm-junos    napalm-iosxr napalm-nxos   napalm-ios
-  **Driver Name**         eos         junos           iosxr        nxos          ios
-  **Structured data**     Yes         Yes             No           Yes           No
-  **Minimum version**     4.15.0F     12.1            5.1.0        6.1 [#g1]_    12.4(20)T
-  **Backend library**     `pyeapi`_   `junos-eznc`_   `pyIOSXR`_   `pynxos`_     `netmiko`_
-  **Caveats**             :doc:`eos`                               :doc:`nxos`   :doc:`ios`
-  =====================   ==========  =============   ============ ============  ============
+  =====================   ==========  =============   ============ ============  ============ ============
+  _                       EOS         Junos           IOS-XR       NX-OS         NX-OS SSH    IOS
+  =====================   ==========  =============   ============ ============  ============ ============
+  **Driver Name**         eos         junos           iosxr        nxos          nxos_ssh     ios
+  **Structured data**     Yes         Yes             No           Yes           No           No
+  **Minimum version**     4.15.0F     12.1            5.1.0        6.1 [#g1]_                 12.4(20)T
+  **Backend library**     `pyeapi`_   `junos-eznc`_   `pyIOSXR`_   `pynxos`_     `netmiko`_   `netmiko`_
+  **Caveats**             :doc:`eos`                               :doc:`nxos`   :doc:`nxos`  :doc:`ios`
+  =====================   ==========  =============   ============ ============  ============ ============
 
 .. _pyeapi: https://github.com/arista-eosplus/pyeapi
 .. _junos-eznc: https://github.com/Juniper/py-junos-eznc
@@ -34,18 +33,18 @@ Configuration support matrix
 ----------------------------
 
 =====================   ==========  =====   ==========  ==============  ==============
-_                       EOS         JunOS   IOS-XR      NXOS            IOS
+_                       EOS         Junos   IOS-XR      NX-OS           IOS
 =====================   ==========  =====   ==========  ==============  ==============
 **Config. replace**     Yes         Yes     Yes         Yes             Yes
 **Config. merge**       Yes         Yes     Yes         Yes             Yes
 **Compare config**      Yes         Yes     Yes [#c1]_  Yes [#c4]_      Yes
-**Atomic Changes**      Yes         Yes     Yes         Yes/No [#c5]_   Yes
+**Atomic Changes**      Yes         Yes     Yes         Yes/No [#c5]_   Yes/No [#c5]_
 **Rollback**            Yes [#c2]_  Yes     Yes         Yes/No [#c5]_   Yes
 =====================   ==========  =====   ==========  ==============  ==============
 
 .. [#c1] Hand-crafted by the API as the device doesn't support the feature.
 .. [#c2] Not supported but emulated. Check caveats.
-.. [#c4] For merges, the diff is simply the merge config itself. See caveats.
+.. [#c4] For merges, the diff is very simplistic. See caveats.
 .. [#c5] No for merges. See caveats.
 
 .. warning:: Before building a workflow to deploy configuration it is important you understand what the table above means;
@@ -67,10 +66,10 @@ Other methods
 .. |no|    unicode:: U+0274C .. No
 
 ============================== =====  =====   ======  ======  =====
-_                               EOS   JunOS   IOS-XR  NXOS    IOS
+_                              EOS    Junos   IOS-XR  NX-OS   IOS
 ============================== =====  =====   ======  ======  =====
 **load_template**              |yes|  |yes|   |yes|   |yes|   |yes|
-**ping**                       |yes|  |yes|   |no|    |no|    |yes|
+**ping**                       |yes|  |yes|   |no|    |yes|   |yes|
 **traceroute**                 |yes|  |yes|   |yes|   |yes|   |yes|
 ============================== =====  =====   ======  ======  =====
 

docs/tutorials/lab.rst

@@ -35,9 +35,9 @@ Create a file named ``Vagrantfile`` (no file extension) in your working director
 
 The above content is also available on `GitHub <https://raw.githubusercontent.com/napalm-automation/napalm/master/docs/tutorials/Vagrantfile>`_.
 
-This Vagrantfile creates a base box and a vEOS box when you call "vagrant up"::
+This Vagrantfile creates a base box and a vEOS box when you call ``vagrant up``::
 
-    $ vagrant up
+    $ vagrant up --provider virtualbox
     ... [output omitted] ...
 
     $ vagrant status

docs/tutorials/wrapup.rst

@@ -9,7 +9,7 @@ You've now tried the main pieces of NAPALM:
 Shutting down
 -------------
 
-Shut down the Vagrant virtual boxes.  You can recreate them later using ``vagrant up`` if needed.
+Shut down the Vagrant virtual boxes.  You can recreate them later using ``vagrant up`` if needed.::
 
     $ vagrant destroy -f
 

docs/validate/index.rst

@@ -36,7 +36,7 @@ then write the desired state using the same format the getter would retrieve it.
             '%usage': '<15.0'
 
     - get_bgp_neighbors:
-        default:
+        global:
           router_id: 192.0.2.2
           peers:
             _mode: strict

napalm/base/__init__.py

@@ -35,7 +35,7 @@
 ]
 
 
-def get_network_driver(module_name, prepend=True):
+def get_network_driver(name, prepend=True):
     """
     Searches for a class derived form the base NAPALM class NetworkDriver in a specific library.
     The library name must repect the following pattern: napalm_[DEVICE_OS].
@@ -48,7 +48,7 @@ def get_network_driver(module_name, prepend=True):
     .. _`Read the Docs`: \
     http://napalm.readthedocs.io/
 
-    :param module_name:         the name of the device operating system or the name of the library.
+    :param name:         the name of the device operating system or the name of the library.
     :return:                    the first class derived from NetworkDriver, found in the library.
     :raise ModuleImportError:   when the library is not installed or a derived class from \
     NetworkDriver was not found.
@@ -67,16 +67,16 @@ def get_network_driver(module_name, prepend=True):
         napalm.base.exceptions.ModuleImportError: Cannot import "napalm_wrong". Is the library \
         installed?
     """
-    if module_name == "mock":
+    if name == "mock":
         return MockDriver
 
-    if not (isinstance(module_name, py23_compat.string_types) and len(module_name) > 0):
+    if not (isinstance(name, py23_compat.string_types) and len(name) > 0):
         raise ModuleImportError('Please provide a valid driver name.')
 
     # Only lowercase allowed
-    module_name = module_name.lower()
+    name = name.lower()
     # Try to not raise error when users requests IOS-XR for e.g.
-    module_install_name = module_name.replace('-', '')
+    module_install_name = name.replace('-', '')
     community_install_name = "napalm_{name}".format(name=module_install_name)
     custom_install_name = "custom_napalm.{name}".format(name=module_install_name)
     # Can also request using napalm_[SOMETHING]
@@ -87,12 +87,22 @@ def get_network_driver(module_name, prepend=True):
         try:
             module = importlib.import_module(module_name)
             break
-        except ImportError:
-            pass
+        except ImportError as e:
+            try:
+                # gotta love py23 differences
+                message = e.message
+            except AttributeError:
+                message = e.msg
+            if "No module named" in message:
+                # py2 doesn't have ModuleNotFoundError exception
+                failed_module = message.split()[-1]
+                if failed_module.replace("'", "") in module_name:
+                    continue
+            raise e
     else:
         raise ModuleImportError(
             'Cannot import "{install_name}". Is the library installed?'.format(
-                install_name=module_install_name
+                install_name=name
             )
         )
 

napalm/base/canonical_map.py

@@ -5,6 +5,9 @@
 base_interfaces = {
   "ATM": "ATM",
   "AT": "ATM",
+  "B": "Bdi",
+  "Bd": "Bdi",
+  "Bdi": "Bdi",
   "EOBC": "EOBC",
   "EO": "EOBC",
   "Ethernet": "Ethernet",
@@ -50,9 +53,13 @@
   "MFR": "MFR",
   "Multilink": "Multilink",
   "Mu": "Multilink",
-  "PortChannel": "PortChannel",
-  "Port-Channel": "PortChannel",
-  "Po": "PortChannel",
+  "n": "nve",
+  "nv": "nve",
+  "nve": "nve",
+  "PortChannel": "Port-channel",
+  "Port-channel": "Port-channel",
+  "Port-Channel": "Port-channel",
+  "Po": "Port-channel",
   "POS": "POS",
   "PO": "POS",
   "Serial": "Serial",
@@ -91,7 +98,7 @@
   "Management": "Ma",
   "MFR": "MFR",
   "Multilink": "Mu",
-  "PortChannel": "Po",
+  "Port-channel": "Po",
   "POS": "PO",
   "Serial": "Se",
   "TenGigabitEthernet": "Te",

napalm/base/exceptions.py

@@ -17,11 +17,18 @@
 from __future__ import unicode_literals
 
 
-class ModuleImportError(Exception):
+class NapalmException(Exception):
+    '''
+    Base Exception Class.
+    '''
+    pass
+
+
+class ModuleImportError(NapalmException):
     pass
 
 
-class ConnectionException(Exception):
+class ConnectionException(NapalmException):
     '''
     Unable to connect to the network device.
     '''
@@ -59,59 +66,59 @@ class ConnectionClosedException(ConnectionException):
     pass
 
 
-class ReplaceConfigException(Exception):
+class ReplaceConfigException(NapalmException):
     pass
 
 
-class MergeConfigException(Exception):
+class MergeConfigException(NapalmException):
     pass
 
 
-class CommitError(Exception):
+class CommitError(NapalmException):
     '''
     Raised when unable to commit the candidate config
     into the running config.
     '''
     pass
 
 
-class LockError(Exception):
+class LockError(NapalmException):
     '''
     Unable to lock the candidate config.
     '''
     pass
 
 
-class UnlockError(Exception):
+class UnlockError(NapalmException):
     '''
     Unable to unlock the candidate config.
     '''
     pass
 
 
-class SessionLockedException(Exception):
+class SessionLockedException(NapalmException):
     pass
 
 
-class CommandTimeoutException(Exception):
+class CommandTimeoutException(NapalmException):
     pass
 
 
-class CommandErrorException(Exception):
+class CommandErrorException(NapalmException):
     pass
 
 
-class DriverTemplateNotImplemented(Exception):
+class DriverTemplateNotImplemented(NapalmException):
     pass
 
 
-class TemplateNotImplemented(Exception):
+class TemplateNotImplemented(NapalmException):
     pass
 
 
-class TemplateRenderException(Exception):
+class TemplateRenderException(NapalmException):
     pass
 
 
-class ValidationException(Exception):
+class ValidationException(NapalmException):
     pass

napalm/base/netmiko_helpers.py

@@ -0,0 +1,47 @@
+# The contents of this file are licensed under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with the
+# License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+from __future__ import unicode_literals
+import inspect
+from netmiko import BaseConnection
+
+
+def netmiko_args(optional_args):
+    """Check for Netmiko arguments that were passed in as NAPALM optional arguments.
+
+    Return a dictionary of these optional args  that will be passed into the Netmiko
+    ConnectHandler call.
+    """
+    netmiko_args, _, _, netmiko_defaults = inspect.getargspec(BaseConnection.__init__)
+
+    check_self = netmiko_args.pop(0)
+    if check_self != 'self':
+        raise ValueError("Error processing Netmiko arguments")
+
+    netmiko_argument_map = dict(zip(netmiko_args, netmiko_defaults))
+
+    # Netmiko arguments that are integrated into NAPALM already
+    netmiko_filter = ['ip', 'host', 'username', 'password', 'device_type', 'timeout']
+
+    # Filter out all of the arguments that are integrated into NAPALM
+    for k in netmiko_filter:
+        netmiko_argument_map.pop(k)
+
+    # Check if any of these arguments were passed in as NAPALM optional_args
+    netmiko_optional_args = {}
+    for k, v in netmiko_argument_map.items():
+        try:
+            netmiko_optional_args[k] = optional_args[k]
+        except KeyError:
+            pass
+
+    # Return these arguments for use with establishing Netmiko SSH connection
+    return netmiko_optional_args