napalm-automation · ktbyers · Apr 30, 2021 · Mar 2, 2020 · Mar 2, 2020 · Mar 2, 2020
diff --git a/docs/development/triage.rst b/docs/development/triage.rst
@@ -26,7 +26,7 @@ Driver labels
 -------------
 
 Each platform supported by NAPALM has associated a label, e.g., ``junos``, ``eos``,
-``ios``, ``iosxr``, ``vyos``, etc. It is mandatory that the maintainer to apply
+``ios``, ``iosxr_netconf``, ``iosxr``, ``vyos``, etc. It is mandatory that the maintainer to apply
 one or more of these labels.
 
 .. _triage-api-change-label:

diff --git a/docs/index.rst b/docs/index.rst
@@ -34,6 +34,8 @@ You can select the driver you need by doing the following:
    >>> from napalm import get_network_driver
    >>> get_network_driver('eos')
    <class napalm.eos.eos.EOSDriver at 0x10ebad6d0>
+   >>> get_network_driver('iosxr_netconf')
+   <class napalm.iosxr_netconf.iosxr_netconf.IOSXRNETCONFDriver at 0x10ad170f0>
    >>> get_network_driver('iosxr')
    <class napalm.iosxr.iosxr.IOSXRDriver at 0x10ec90050>
    >>> get_network_driver('junos')

diff --git a/docs/support/index.rst b/docs/support/index.rst
@@ -8,21 +8,22 @@ General support matrix
 
 
 
-  =====================   ==========  =============   ============ ============  ============ ============
-  _                       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`
-  =====================   ==========  =============   ============ ============  ============ ============
+  =====================   ==========  =============  ====================  ==================  ============  ============  ============
+  _                       EOS         Junos          IOS-XR (NETCONF)      IOS-XR (XML-Agent)  NX-OS         NX-OS SSH     IOS
+  =====================   ==========  =============  ====================  ==================  ============  ============  ============
+  **Driver Name**         eos         junos          iosxr_netconf         iosxr               nxos          nxos_ssh      ios
+  **Structured data**     Yes         Yes            Yes                   No                  Yes           No            No
+  **Minimum version**     4.15.0F     12.1           7.0                   5.1.0               6.1 [#g1]_    12.4(20)T     6.3.2
+  **Backend library**     `pyeapi`_   `junos-eznc`_  `ncclient`_           `pyIOSXR`_          `pynxos`_     `netmiko`_    `netmiko`_
+  **Caveats**             :doc:`eos`                 :doc:`iosxr_netconf`                      :doc:`nxos`   :doc:`nxos`   :doc:`ios`
+  =====================   ==========  =============  ====================  ==================  ============  ============  ============
 
 .. _pyeapi: https://github.com/arista-eosplus/pyeapi
 .. _junos-eznc: https://github.com/Juniper/py-junos-eznc
 .. _pyIOSXR: https://github.com/fooelisa/pyiosxr
 .. _pynxos: https://github.com/networktocode/pynxos
 .. _netmiko: https://github.com/ktbyers/netmiko
+.. _ncclient: https://github.com/ncclient/ncclient
 
 .. [#g1] NX-API support on the Nexus 5k, 6k and 7k families was introduced in version 7.2
 
@@ -32,16 +33,16 @@ General support matrix
 Configuration support matrix
 ----------------------------
 
-=====================   ==========  ==========  ==========  ==============  ==============
-_                       EOS         Junos       IOS-XR      NX-OS           IOS
-=====================   ==========  ==========  ==========  ==============  ==============
-**Config Replace**      Yes         Yes         Yes         Yes             Yes
-**Config Merge**        Yes         Yes         Yes         Yes             Yes
-**Commit Confirm**      Yes         Yes [#c6]_  No          No              No
-**Compare Config**      Yes         Yes         Yes [#c1]_  Yes [#c4]_      Yes
-**Atomic Changes**      Yes         Yes         Yes         Yes/No [#c5]_   Yes/No [#c5]_
-**Rollback**            Yes [#c2]_  Yes         Yes         Yes/No [#c5]_   Yes
-=====================   ==========  ==========  ==========  ==============  ==============
+=====================   ==========  =====   ================  ==================  ==============  ==============
+_                       EOS         Junos   IOS-XR (NETCONF)  IOS-XR (XML-Agent)  NX-OS           IOS
+=====================   ==========  =====   ================  ==================  ==============  ==============
+**Config. replace**     Yes         Yes     Yes               Yes                 Yes             Yes
+**Config. merge**       Yes         Yes     Yes               Yes                 Yes             Yes
+**Commit Confirm**      Yes         Yes     No                No                  No              No
+**Compare config**      Yes         Yes     Yes               Yes [#c1]_          Yes [#c4]_      Yes
+**Atomic Changes**      Yes         Yes     Yes               Yes                 Yes/No [#c5]_   Yes/No [#c5]_
+**Rollback**            Yes [#c2]_  Yes     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.
@@ -67,13 +68,13 @@ Other methods
 .. |yes|   unicode:: U+02705 .. Yes
 .. |no|    unicode:: U+0274C .. No
 
-============================== =====  =====   ======  ======  =====
-_                              EOS    Junos   IOS-XR  NX-OS   IOS
-============================== =====  =====   ======  ======  =====
-**load_template**              |yes|  |yes|   |yes|   |yes|   |yes|
-**ping**                       |yes|  |yes|   |no|    |yes|   |yes|
-**traceroute**                 |yes|  |yes|   |yes|   |yes|   |yes|
-============================== =====  =====   ======  ======  =====
+============================== =====  =====   ===================  ======  ======  =====
+_                              EOS    Junos   IOS-XR (NETCONF)     IOS-XR  NX-OS   IOS
+============================== =====  =====   ===================  ======  ======  =====
+**load_template**              |yes|  |yes|   |yes|                |yes|   |yes|   |yes|
+**ping**                       |yes|  |yes|   |no|                 |no|    |yes|   |yes|
+**traceroute**                 |yes|  |yes|   |yes|                |yes|   |yes|   |yes|
+============================== =====  =====   ===================  ======  ======  =====
 
 Available configuration templates
 ---------------------------------
@@ -94,6 +95,7 @@ Caveats
    eos
    ios
    nxos
+   iosxr_netconf
 
 Optional arguments
 ------------------
@@ -116,7 +118,7 @@ ____________________________________
 * :code:`alt_key_file` (ios, iosxr, nxos_ssh) - SSH host key file to use (if ``alt_host_keys`` is ``True``).
 * :code:`auto_probe` (junos) - A timeout in seconds, for which to probe the device. Probing determines if the device accepts remote connections. If `auto_probe` is set to ``0``, no probing will be done. (default: ``0``).
 * :code:`auto_rollback_on_error` (ios) - Disable automatic rollback (certain versions of IOS support configure replace, but not rollback on error) (default: ``True``).
-* :code:`config_lock` (iosxr, junos) - Lock the config during open() (default: ``False``).
+* :code:`config_lock` (iosxr_netconf, iosxr, junos) - Lock the config during open() (default: ``False``).
 * :code:`lock_disable` (junos) - Disable all configuration locking for management by an external system (default: ``False``).
 * :code:`config_private` (junos) - Configure private, no DB locking (default: ``False``).
 * :code:`canonical_int` (ios) - Convert operational interface's returned name to canonical name (fully expanded name) (default: ``False``).
@@ -126,21 +128,18 @@ ____________________________________
 * :code:`global_delay_factor` (ios, nxos_ssh) - Allow for additional delay in command execution (default: ``1``).
 * :code:`ignore_warning` (junos) - Allows to set `ignore_warning` when loading configuration to avoid exceptions via junos-pyez. (default: ``False``).
 * :code:`keepalive` (iosxr, junos) - SSH keepalive interval, in seconds (default: ``30`` seconds).
-* :code:`key_file` (ios, iosxr, junos, nxos_ssh) - Path to a private key file. (default: ``False``).
-* :code:`port` (eos, ios, iosxr, junos, nxos, nxos_ssh) - Allows you to specify a port other than the default.
+* :code:`key_file` (ios, iosxr_netconf, iosxr, junos, nxos_ssh) - Path to a private key file. (default: ``False``).
+* :code:`port` (eos, ios, iosxr_netconf, iosxr, junos, nxos, nxos_ssh) - Allows you to specify a port other than the default.
 * :code:`secret` (ios, nxos_ssh) - Password required to enter privileged exec (enable) (default: ``''``).
 * :code:`ssh_config_file` (ios, iosxr, junos, nxos_ssh) - File name of OpenSSH configuration file.
 * :code:`ssh_strict` (ios, iosxr, nxos_ssh) - Automatically reject unknown SSH host keys (default: ``False``, which means unknown SSH host keys will be accepted).
 * :code:`ssl_verify` (nxos) - Requests argument, enable the SSL certificates verification. See requests ssl-cert-verification for valide values (default: ``None`` equivalent to ``False``).
 * :code:`transport` (eos, ios, nxos) - Protocol to connect with (see `The transport argument`_ for more information).
 * :code:`use_keys` (ios, iosxr, nxos_ssh) - Paramiko argument, enable searching for discoverable private key files in ``~/.ssh/`` (default: ``False``).
 * :code:`eos_autoComplete` (eos) - Allows to set `autoComplete` when running commands. (default: ``None`` equivalent to ``False``)
-* :code:`eos_fn0039_config` (eos) - Transform old style configuration to the new 
-  style, available beginning with EOS release 4.23.0, as per FN 0039. Beware 
-  that enabling this option will change the configuration you're loading 
-  through NAPALM. Default: ``False`` (won't change your configuration 
-  commands).
-
+* :code:`config_encoding` (iosxr_netconf) - Set encoding to either ``"xml"`` or ``"cli"`` for configuration load methods. (default: ``"cli"``)
+* :code:`eos_fn0039_config` (eos) - Transform old style configuration to the new style, available beginning with EOS release 4.23.0, as per FN 0039. Beware 
+  that enabling this option will change the configuration you're loading through NAPALM. Default: ``False`` (won't change your configuration commands).
   .. versionadded:: 3.0.1
 
 The transport argument

diff --git a/docs/support/iosxr_netconf.rst b/docs/support/iosxr_netconf.rst
@@ -0,0 +1,22 @@
+IOS-XR (NETCONF)
+----------------
+
+
+Minimum IOS-XR OS Version
+~~~~~~~~~~~~~~~~~~~~~~~~~
+Only devices running IOS-XR 7.0 or later are supported by NAPALM and the IOS-XR NETCONF driver.
+
+
+Device management using XML Configuration
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Using ``iosxr_netconf`` and a ``config_encoding="xml"`` for NAPALM configuration operations is entirely experimental. There is a very good chance XML configurations will not work properly and that only small subsections of the configuration will be configurable using merge operations.
+
+
+Device management using CLI Configuration
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+All configuration methods (``load_merge_candidate``, ``load_replace_candidate``, ``get_config``, ``compare_config``) support configuration encoded in XML and CLI (unstructured) format. This can be specified by using the ``config_encoding`` optional_args argument and setting it to either ``cli`` or ``xml`` (``cli`` is the default value).
+
+
+Retrieving device environment
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+In IOS-XR 64-bit devices that support an administration mode, the proper operation of ``get_environment`` requires that the ``iosxr_netconf`` driver session is authenticated against a username defined in that administration mode.
diff --git a/napalm/_SUPPORTED_DRIVERS.py b/napalm/_SUPPORTED_DRIVERS.py
@@ -1 +1,10 @@
-SUPPORTED_DRIVERS = ["base", "eos", "ios", "iosxr", "junos", "nxos", "nxos_ssh"]
+SUPPORTED_DRIVERS = [
+    "base",
+    "eos",
+    "ios",
+    "iosxr",
+    "junos",
+    "nxos",
+    "nxos_ssh",
+    "iosxr_netconf",
+]
diff --git a/napalm/base/constants.py b/napalm/base/constants.py
@@ -83,7 +83,7 @@
     r"^(snmp-server user \S+( \S+)? auth md5) \S+ (priv) \S+ (localizedkey( engineID \S+)?)\s*$": r"\1 <removed> \3 <removed> \4\5",  # noqa
     r"^(username .+ (password|secret) \d) .+$": r"\1 <removed>",
     r"^(enable (password|secret)( level \d+)? \d) .+$": r"\1 <removed>",
-    r"^(\s+(?:password|secret)) (?:\d )?\S+$": r"\1 <removed>",
+    r"^(\s+(?:password|secret)) (?:\d{1,2} )?\S+$": r"\1 <removed>",
     r"^(.*wpa-psk ascii \d) (\S+)$": r"\1 <removed>",
     r"^(.*key 7) (\d.+)$": r"\1 <removed>",
     r"^(tacacs-server (.+ )?key) .+$": r"\1 <removed>",

diff --git a/napalm/base/test/getters.py b/napalm/base/test/getters.py
@@ -512,6 +512,8 @@ def test_get_config(self, test_case):
     @wrap_test_cases
     def test_get_config_filtered(self, test_case):
         """Test get_config method."""
+        if self.device.platform == "iosxr_netconf":
+            pytest.skip("This test is not implemented on {self.device.platform}")
         for config in ["running", "startup", "candidate"]:
             get_config = self.device.get_config(retrieve=config)
 

diff --git a/napalm/iosxr/utilities.py b/napalm/iosxr/utilities.py
@@ -0,0 +1,10 @@
+import re
+
+
+def strip_config_header(config):
+    """Normalize items that should not show up in IOS-XR compare_config."""
+    config = re.sub(r"^Building config.*\n!! IOS.*", "", config, flags=re.M)
+    config = config.strip()
+    config = re.sub(r"^!!.*", "", config)
+    config = re.sub(r"end$", "", config)
+    return config.strip()
diff --git a/napalm/iosxr_netconf/__init__.py b/napalm/iosxr_netconf/__init__.py
@@ -0,0 +1,29 @@
+# -*- coding: utf-8 -*-
+# Copyright 2020 CISCO. All rights reserved.
+#
+# 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.
+
+"""napalm.iosxr_netconf package."""
+
+# Import stdlib
+import pkg_resources
+
+# Import local modules
+from napalm.iosxr_netconf.iosxr_netconf import IOSXRNETCONFDriver  # noqa
+
+__all__ = ("IOSXRNETCONFDriver",)
+
+try:
+    __version__ = pkg_resources.get_distribution("napalm-iosxr-netconf").version
+except pkg_resources.DistributionNotFound:
+    __version__ = "Not installed"