Merge branch 'develop'

* develop: (128 commits) bump version (#613) Add napalm logo (previously removed probably during reunification) Interface is always enabled, unless explicitly specified in config Fix get_environnements available memory (#605) [docs] pynxos instead of pycsco for NXOS QFX10008 apparently still uses the same old RPC (as EX9208) Fix for napalm-automation/napalm-iosxr#104. IOSXRv returns empty list for oper.PlatformInventory.RackTable.Rack.Attributes.BasicInfo, causing a fatal IndexError for the variable 'platform_attr_tree' in the 'get_facts' function. In fact, IOSXRv walkdata oper.PlatformInventory returns no data at all. As a result, only an interface_list will be returned and the remaining default facts values from the function will be used. This condition does NOT occur on physical IOSXR hosts. Therefore, original indexing needs to be preserved while the error condition is handled for IOSXRv hosts. Biatch Screw you too Who said rebasing is not fun fix missing file in power supply mocked data Readd the state / status key. The rebase hell continues Lost this commit somehow in this cherry-pick hell Pass password when using ssh key suppress FutureWarning (#218) fix removal of cluster key (#219) fix pep8 errors implement find operation in cli fix multihop ttl to its default value remove cluster from the neighbor output ...
napalm-automation · Jan 8, 2018 · d5f24b3 · d5f24b3
2 parents 21f675e + 8f8426e
commit d5f24b3
Show file tree

Hide file tree

Showing 123 changed files with 5,605 additions and 833 deletions.
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.
diff --git a/docs/contributing/core.rst b/docs/contributing/core.rst
@@ -0,0 +1,23 @@
+.. _contributing-core:
+
+NAPALM Core Developers
+======================
+
+NAPALM core developers have the responsibility to maintain the
+:ref:`supported-devices`, hereby including:
+
+- Identify and fix bugs
+- Add new features and enhancements
+- Ensure an uniform API
+- Triage Issues
+- Review and eventually Pull Requests
+- Continuously improve the documentation
+- Grant access to volunteers that propose new :ref:`contributing-drivers`
+- Provide a set of tools used in the core drivers to test and generate documentation to developers willing to write and maintain extra drivers
+
+Who can be a core developer?
+----------------------------
+
+Anyone that is (git) committed to the project, proves skills to maintain a
+driver, and continuously identifies and fixes issues, or any applicable of the
+above. We are always looking into statistics and considering new members.
diff --git a/docs/contributing/drivers.rst b/docs/contributing/drivers.rst
@@ -0,0 +1,33 @@
+.. _contributing-drivers:
+
+Community Drivers
+=================
+
+In addition to the core drivers, maintained by the :ref:`contributing-core`,
+the community can always provide additional drivers. We welcome any submission,
+and new drivers will be hosted under the
+`napalm-automation-community <https://github.com/napalm-automation-community>`_ on
+GitHub. They can be seen as *plugins* for the base NAPALM framework, which is
+why each driver is maintained under its own repository.
+
+Once a new driver is added under the named organisation, the user proposing it
+takes the entire responsibility to maintain. That includes:
+
+- Documentation
+- Fix bugs
+- Triage and manage issues
+- Review and merge Pull Requests
+- API compatibility with the core drivers
+
+While everything is a best-effort of the volunteer, we highly encourage the
+community to avoid submitting drivers they are unable to maintain. We understand
+that personal and professional situations can change and we are not asking for
+an ever-lasting commitment but there should be some willingness to take some
+initial responsibility over it.
+
+The core developers will provide you the tools and the methodologies to
+create a new driver, together with the associated documentation.
+
+If there is high demand for a specific driver, and its maintainer proves they
+are able to commit to a continuous work on the long run, the driver can
+be promoted to be included into the core.
diff --git a/docs/contributing/index.rst b/docs/contributing/index.rst
@@ -49,4 +49,12 @@ Just do it! :)
 Proposing a new driver
 ----------------------
 
-This is a but more complex but completely doable. You can find more information `here <https://github.com/napalm-automation/napalm-skeleton>`_.
+This is a more complex process but completely doable. You can find more information `here <https://github.com/napalm-automation/napalm-skeleton>`_.
+
+Please check :ref:`contributing-drivers` to understand the process.
+
+.. toctree::
+   :maxdepth: 1
+
+   core
+   drivers
diff --git a/docs/support/index.rst b/docs/support/index.rst
@@ -1,3 +1,5 @@
+.. _supported-devices:
+
 Supported Devices
 =================
 
@@ -13,14 +15,14 @@ General support matrix
   **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`_   `pycsco`_     `netmiko`_
+  **Backend library**     `pyeapi`_   `junos-eznc`_   `pyIOSXR`_   `pynxos`_     `netmiko`_
   **Caveats**             :doc:`eos`                               :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
-.. _pycsco: https://github.com/jedelman8/pycsco
+.. _pynxos: https://github.com/networktocode/pynxos
 .. _netmiko: https://github.com/ktbyers/netmiko
 
 .. [#g1] NX-API support on the Nexus 5k, 6k and 7k families was introduced in version 7.2

diff --git a/docs/support/ios.rst b/docs/support/ios.rst
@@ -8,7 +8,7 @@ _____________
 IOS has no native API to play with, that's the reason why we used the Netmiko library to interact with it.
 Having Netmiko installed in your working box is a prerequisite.
 
-Check napalm-ios/requirements.txt for Netmiko version requirement   
+Check napalm-ios/requirements.txt for Netmiko version requirement
 
 Full ios driver support requires configuration rollback on error::
 
@@ -61,23 +61,23 @@ Cisco IOS adds a tab character into the self-signed certificate. This exists on
 
     crypto pki certificate chain TP-self-signed-1429897839
      certificate self-signed 01
-      3082022B 30820194 A0030201 02020101 300D0609 2A864886 F70D0101 05050030 
+      3082022B 30820194 A0030201 02020101 300D0609 2A864886 F70D0101 05050030
       ...
       ...
       ...
-      9353BD17 C345E1D7 71AFD125 D23D7940 2DECBE8E 46553314 396ACC63 34839EF7 
+      9353BD17 C345E1D7 71AFD125 D23D7940 2DECBE8E 46553314 396ACC63 34839EF7
       3C056A00 7E129168 F0CD3692 F53C62
       	quit
 
 The quit line reads as follows::
 
     >>> for char in line:
     ...   print("{}: {}".format(repr(char), ord(char)))
-    ... 
+    ...
     ' ': 32     # space
     ' ': 32     # space
     '\t': 9     # tab
-    'q': 113    
+    'q': 113
     'u': 117
     'i': 105
     't': 116
@@ -104,20 +104,38 @@ IOS requires that the banner use the EXT character (ASCII 3). This looks like a
     ...   f.write("banner motd {}\n".format(ext_char))
     ...   f.write("my banner test\n")
     ...   f.write("{}\n".format(ext_char))
-    ... 
+    ...
     >>> quit()
 
 Configure replace operations will reject a file with a banner unless it uses the ASCII character. Note, this likely also implies you cannot just copy-and-paste what you see on the screen.
 
 In vim insert, you can also type <ctrl>+V, release only the V, then type C
 
 
+File Operation Prompts
+_____
 
-Notes
+By default IOS will prompt for confirmation on file operations. These prompts need to be disabled before the NAPALM-ios driver performs any such operation on the device.
+This can be controlled using the `auto_file_prompt` optional arguement:
+
+* `auto_file_prompt=True` (default): NAPALM will automatically add `file prompt quiet` to the device configuration before performing file operations,
+  and un-configure it again afterwards. If the device already had the command in its configuration then it will be silently removed as a result, and
+  this change will not show up in the output of `compare_config()`.
+
+* `auto_file_prompt=False`: Disable the above automated behaviour. The managed device must have `file prompt quiet` in its running-config already,
+  otherwise a `CommandErrorException` will be raised when file operations are attempted.
+
+SCP File Transfers
 _____
 
-* Will automatically enable secure copy ('ip scp server enable') on the network device. This is a configuration change.
+The NAPALM-ios driver requires SCP to be enabled on the managed device. SCP
+server functionality is disabled in IOS by default, and is configured using
+`ip scp server enable`.
+
+If an operation requiring a file transfer is attempted, but the necessary
+configuration is not present, a `CommandErrorException` will be raised.
 
-* During various operations, NAPALM ios driver will turn off the prompting for confirmations (`file prompt quiet`). It should re-enable prompting before exiting the device (`no file prompt quiet`).
+Notes
+_____
 
 * The NAPALM-ios driver supports all Netmiko arguments as either standard arguments (hostname, username, password, timeout) or as optional_args (everything else).