Skip to content

Commit d5f24b3

Browse files
bewingbewing
committed
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 ...
2 parents 21f675e + 8f8426e commit d5f24b3

File tree

123 files changed

+5605
-833
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

123 files changed

+5605
-833
lines changed

Diff for: ‎LICENSE

+201
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

Diff for: ‎docs/contributing/core.rst

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
.. _contributing-core:
2+
3+
NAPALM Core Developers
4+
======================
5+
6+
NAPALM core developers have the responsibility to maintain the
7+
:ref:`supported-devices`, hereby including:
8+
9+
- Identify and fix bugs
10+
- Add new features and enhancements
11+
- Ensure an uniform API
12+
- Triage Issues
13+
- Review and eventually Pull Requests
14+
- Continuously improve the documentation
15+
- Grant access to volunteers that propose new :ref:`contributing-drivers`
16+
- Provide a set of tools used in the core drivers to test and generate documentation to developers willing to write and maintain extra drivers
17+
18+
Who can be a core developer?
19+
----------------------------
20+
21+
Anyone that is (git) committed to the project, proves skills to maintain a
22+
driver, and continuously identifies and fixes issues, or any applicable of the
23+
above. We are always looking into statistics and considering new members.

Diff for: ‎docs/contributing/drivers.rst

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
.. _contributing-drivers:
2+
3+
Community Drivers
4+
=================
5+
6+
In addition to the core drivers, maintained by the :ref:`contributing-core`,
7+
the community can always provide additional drivers. We welcome any submission,
8+
and new drivers will be hosted under the
9+
`napalm-automation-community <https://github.com/napalm-automation-community>`_ on
10+
GitHub. They can be seen as *plugins* for the base NAPALM framework, which is
11+
why each driver is maintained under its own repository.
12+
13+
Once a new driver is added under the named organisation, the user proposing it
14+
takes the entire responsibility to maintain. That includes:
15+
16+
- Documentation
17+
- Fix bugs
18+
- Triage and manage issues
19+
- Review and merge Pull Requests
20+
- API compatibility with the core drivers
21+
22+
While everything is a best-effort of the volunteer, we highly encourage the
23+
community to avoid submitting drivers they are unable to maintain. We understand
24+
that personal and professional situations can change and we are not asking for
25+
an ever-lasting commitment but there should be some willingness to take some
26+
initial responsibility over it.
27+
28+
The core developers will provide you the tools and the methodologies to
29+
create a new driver, together with the associated documentation.
30+
31+
If there is high demand for a specific driver, and its maintainer proves they
32+
are able to commit to a continuous work on the long run, the driver can
33+
be promoted to be included into the core.

Diff for: ‎docs/contributing/index.rst

+9-1
Original file line numberDiff line numberDiff line change
@@ -49,4 +49,12 @@ Just do it! :)
4949
Proposing a new driver
5050
----------------------
5151

52-
This is a but more complex but completely doable. You can find more information `here <https://github.com/napalm-automation/napalm-skeleton>`_.
52+
This is a more complex process but completely doable. You can find more information `here <https://github.com/napalm-automation/napalm-skeleton>`_.
53+
54+
Please check :ref:`contributing-drivers` to understand the process.
55+
56+
.. toctree::
57+
:maxdepth: 1
58+
59+
core
60+
drivers

Diff for: ‎docs/support/index.rst

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _supported-devices:
2+
13
Supported Devices
24
=================
35

@@ -13,14 +15,14 @@ General support matrix
1315
**Driver Name** eos junos iosxr nxos ios
1416
**Structured data** Yes Yes No Yes No
1517
**Minimum version** 4.15.0F 12.1 5.1.0 6.1 [#g1]_ 12.4(20)T
16-
**Backend library** `pyeapi`_ `junos-eznc`_ `pyIOSXR`_ `pycsco`_ `netmiko`_
18+
**Backend library** `pyeapi`_ `junos-eznc`_ `pyIOSXR`_ `pynxos`_ `netmiko`_
1719
**Caveats** :doc:`eos` :doc:`nxos` :doc:`ios`
1820
===================== ========== ============= ============ ============ ============
1921

2022
.. _pyeapi: https://github.com/arista-eosplus/pyeapi
2123
.. _junos-eznc: https://github.com/Juniper/py-junos-eznc
2224
.. _pyIOSXR: https://github.com/fooelisa/pyiosxr
23-
.. _pycsco: https://github.com/jedelman8/pycsco
25+
.. _pynxos: https://github.com/networktocode/pynxos
2426
.. _netmiko: https://github.com/ktbyers/netmiko
2527

2628
.. [#g1] NX-API support on the Nexus 5k, 6k and 7k families was introduced in version 7.2

Diff for: ‎docs/support/ios.rst

+27-9
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ _____________
88
IOS has no native API to play with, that's the reason why we used the Netmiko library to interact with it.
99
Having Netmiko installed in your working box is a prerequisite.
1010

11-
Check napalm-ios/requirements.txt for Netmiko version requirement
11+
Check napalm-ios/requirements.txt for Netmiko version requirement
1212

1313
Full ios driver support requires configuration rollback on error::
1414

@@ -61,23 +61,23 @@ Cisco IOS adds a tab character into the self-signed certificate. This exists on
6161

6262
crypto pki certificate chain TP-self-signed-1429897839
6363
certificate self-signed 01
64-
3082022B 30820194 A0030201 02020101 300D0609 2A864886 F70D0101 05050030
64+
3082022B 30820194 A0030201 02020101 300D0609 2A864886 F70D0101 05050030
6565
...
6666
...
6767
...
68-
9353BD17 C345E1D7 71AFD125 D23D7940 2DECBE8E 46553314 396ACC63 34839EF7
68+
9353BD17 C345E1D7 71AFD125 D23D7940 2DECBE8E 46553314 396ACC63 34839EF7
6969
3C056A00 7E129168 F0CD3692 F53C62
7070
quit
7171

7272
The quit line reads as follows::
7373

7474
>>> for char in line:
7575
... print("{}: {}".format(repr(char), ord(char)))
76-
...
76+
...
7777
' ': 32 # space
7878
' ': 32 # space
7979
'\t': 9 # tab
80-
'q': 113
80+
'q': 113
8181
'u': 117
8282
'i': 105
8383
't': 116
@@ -104,20 +104,38 @@ IOS requires that the banner use the EXT character (ASCII 3). This looks like a
104104
... f.write("banner motd {}\n".format(ext_char))
105105
... f.write("my banner test\n")
106106
... f.write("{}\n".format(ext_char))
107-
...
107+
...
108108
>>> quit()
109109

110110
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.
111111

112112
In vim insert, you can also type <ctrl>+V, release only the V, then type C
113113

114114

115+
File Operation Prompts
116+
_____
115117

116-
Notes
118+
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.
119+
This can be controlled using the `auto_file_prompt` optional arguement:
120+
121+
* `auto_file_prompt=True` (default): NAPALM will automatically add `file prompt quiet` to the device configuration before performing file operations,
122+
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
123+
this change will not show up in the output of `compare_config()`.
124+
125+
* `auto_file_prompt=False`: Disable the above automated behaviour. The managed device must have `file prompt quiet` in its running-config already,
126+
otherwise a `CommandErrorException` will be raised when file operations are attempted.
127+
128+
SCP File Transfers
117129
_____
118130

119-
* Will automatically enable secure copy ('ip scp server enable') on the network device. This is a configuration change.
131+
The NAPALM-ios driver requires SCP to be enabled on the managed device. SCP
132+
server functionality is disabled in IOS by default, and is configured using
133+
`ip scp server enable`.
134+
135+
If an operation requiring a file transfer is attempted, but the necessary
136+
configuration is not present, a `CommandErrorException` will be raised.
120137

121-
* 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`).
138+
Notes
139+
_____
122140

123141
* The NAPALM-ios driver supports all Netmiko arguments as either standard arguments (hostname, username, password, timeout) or as optional_args (everything else).

0 commit comments

Comments
 (0)