├── .gitignore ├── LICENSE ├── README.md └── pyIOS ├── __init__.py ├── exceptions.py └── iosnetconf.py /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | 5 | # C extensions 6 | *.so 7 | 8 | # Distribution / packaging 9 | .Python 10 | env/ 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | *.egg-info/ 23 | .installed.cfg 24 | *.egg 25 | 26 | # PyInstaller 27 | # Usually these files are written by a python script from a template 28 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 29 | *.manifest 30 | *.spec 31 | 32 | # Installer logs 33 | pip-log.txt 34 | pip-delete-this-directory.txt 35 | 36 | # Unit test / coverage reports 37 | htmlcov/ 38 | .tox/ 39 | .coverage 40 | .coverage.* 41 | .cache 42 | nosetests.xml 43 | coverage.xml 44 | *,cover 45 | 46 | # Translations 47 | *.mo 48 | *.pot 49 | 50 | # Django stuff: 51 | *.log 52 | 53 | # Sphinx documentation 54 | docs/_build/ 55 | 56 | # PyBuilder 57 | target/ 58 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 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. 202 | 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # pyIOS 2 | 3 | A NETCONF API Implementation for Cisco IOS 4 | 5 | To enable NETCONF over SSH on Cisco IOS 6 | ``` 7 | crypto key generate rsa usage-keys modulus 1024 8 | ip ssh version 2 9 | netconf max-sessions 16 10 | netconf lock-time 60 11 | netconf ssh 12 | line vty 0 15 13 | transport input ssh 14 | ``` 15 | 16 | This library is inspired by [pyIOSXR](https://github.com/fooelisa/pyiosxr), [pyEOS](https://github.com/spotify/pyeos), and [NAPALM](https://github.com/spotify/napalm) in general. The purpose of this library is to take advantage of the [NETCONF](http://www.netconfcentral.org/) API that is present in most modern implementations of Cisco IOS and follows a very similar structure to the NAPALM structure. 17 | 18 | NOTE: This code isn't ready for production use. 19 | 20 | * The commit_config function doesn't like writing large chunks of configuration changes. Small, targeted configuration changes appear to work, however. 21 | * I need to test the lock and unlock functionality to lock a device from being configured by a third party at the same time that work is being performed via NETCONF. 22 | * I need to implement discard and rollback functions 23 | * I need to implement an API call in commit_config to write changes to startup. 24 | 25 | 26 | 27 | To utilize this library. You must first import the class. 28 | 29 | ``` 30 | >>> from pyIOS.iosnetconf import IOS 31 | ``` 32 | 33 | Then you define the parameters for the device that you want to connect to. 34 | 35 | ``` 36 | >>> router = IOS(hostname='router1', username='someuser', password='somepassword', timeout=120) 37 | ``` 38 | 39 | Next, establish a connection to the device. The data-plane is established over SSH. The SSH connection calls the NETCONF subsystem. The remote device will immediately send a `````` xml message. We strip the session-id off the `````` and reply back with the same xml message. This effectively establishes the NETCONF session to the remote device. 40 | 41 | ``` 42 | >>> router.open() 43 | ``` 44 | 45 | Once the NETCONF session is established, we're able to make API calls to interact with the device. To get the running configuration of the device, call the load_running_config() function. 46 | 47 | ``` 48 | >>> running = router.load_running_config() 49 | ``` 50 | 51 | Now you can load a candidate configuration into memory locally, with the load_candidate_config(). 52 | 53 | ``` 54 | >>> candidate = router.load_candidate_config(filename='replace.cfg') 55 | ``` 56 | 57 | With a running config and candidate config loaded into memory, you can compare the differences between the configurations. 58 | 59 | ``` 60 | >>> compare = router.compare_config() 61 | >>> print compare 62 | --- 63 | +++ 64 | @@ -349,8 +349,7 @@ 65 | spanning-tree bpdufilter enable 66 | ! 67 | interface GigabitEthernet1/0/1 68 | - no switchport 69 | - ip address 192.168.3.1 255.255.255.0 70 | + switchport 71 | ! 72 | interface GigabitEthernet1/0/2 73 | ! 74 | @@ -445,7 +444,7 @@ 75 | exec-timeout 0 0 76 | transport input ssh 77 | ! 78 | -ntp clock-period 36030421 79 | +ntp clock-period 36029820 80 | ntp server 172.16.0.2 prefer 81 | ntp server 172.16.0.2 source Loopback0 82 | netconf max-sessions 16 83 | ``` 84 | 85 | If you're satisfied with the intended configuration from the candidate, you can commit the changes to the remote device. 86 | 87 | ``` 88 | >>> router.commit_config(filename='replace.cfg') 89 | ``` 90 | 91 | Finally, when you're done, you can close the connection. 92 | 93 | ``` 94 | >>> router.close() 95 | ``` 96 | -------------------------------------------------------------------------------- /pyIOS/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jtdub/pyios/1842b92068e3b0a980d53e0719efd41dbbdaf082/pyIOS/__init__.py -------------------------------------------------------------------------------- /pyIOS/exceptions.py: -------------------------------------------------------------------------------- 1 | class InvalidInputError(Exception): 2 | pass 3 | -------------------------------------------------------------------------------- /pyIOS/iosnetconf.py: -------------------------------------------------------------------------------- 1 | import xml.etree.ElementTree as ET 2 | 3 | import pexpect 4 | import re 5 | import difflib 6 | 7 | from exceptions import InvalidInputError 8 | 9 | 10 | def __execute_netconf__(device, rpc_command, timeout): 11 | rpc = ''' 12 | 13 | {0} 14 | ]]>]]>\n'''.format(rpc_command) 15 | device.sendline(rpc) 16 | device.expect("]]>]]>", timeout=timeout) 17 | 18 | return device.after 19 | 20 | 21 | class IOS(object): 22 | 23 | def __init__(self, hostname, username, password, port=22, timeout=120): 24 | self.hostname = hostname 25 | self.username = username 26 | self.password = password 27 | self.port = port 28 | self.timeout = timeout 29 | 30 | def open(self): 31 | """ 32 | To establish a NETCONF session, we utilize ssh via: 33 | 34 | ssh -s -p {{ port }} {{ username }}@{{ hostname }} netconf 35 | 36 | The -s flag allows us to invoke the netconf subsystem on the remote 37 | system. 38 | 39 | The remote network device will immediately send a 'hello' xml command. 40 | We take the 'hello' xml command, remove the system-id element and 41 | send the 'hello' back to the remote network device. Once this 42 | handshake is complete, the NETCONF session is established and ready 43 | to do work. 44 | """ 45 | 46 | """ Establishing a connection and logging in """ 47 | host = pexpect.spawn('ssh -o ConnectTimeout={} -s -p {} {}@{} netconf' 48 | .format(self.timeout, self.port, self.username, 49 | self.hostname)) 50 | self.host = host 51 | index = host.expect(['\(yes\/no\)\?', '[Pp]assword:', pexpect.EOF], 52 | timeout=self.timeout) 53 | if index == 0: 54 | host.sendline('yes') 55 | index = host.expect(['\(yes\/no\)\?', '[Pp]assword:', pexpect.EOF], 56 | timeout=self.timeout) 57 | if index == 1: 58 | host.sendline(self.password) 59 | elif index == 2: 60 | pass 61 | 62 | """ Receive 'hello' from remote device """ 63 | host.expect(']]>]]>', timeout=self.timeout) 64 | server_hello = host.before 65 | server_hello = server_hello.lstrip() 66 | xml_tree = ET.fromstring(server_hello) 67 | 68 | """ Find and remove 'session-id' from remote hello """ 69 | for session in xml_tree.findall('session-id'): 70 | xml_tree.remove(session) 71 | 72 | """ Send 'hello' back to remote device """ 73 | hello = ET.tostring(xml_tree) 74 | client_hello = '{0}]]>]]>\n'\ 75 | .format(hello) 76 | host.sendline(client_hello) 77 | host.expect(']]>]]>', timeout=self.timeout) 78 | 79 | """ Make the host variable callable by other functions """ 80 | self.host = host 81 | 82 | def close(self): 83 | """ Close the connection to the remote device """ 84 | self.host.close() 85 | 86 | def load_running_config(self, filename=None): 87 | """ Get the live running config from a remote device """ 88 | configuration = '' 89 | 90 | if filename is None: 91 | live = __execute_netconf__(self.host, '', 92 | timeout=self.timeout) 93 | configuration = re.sub('<.+>', '', live) 94 | configuration = re.sub('\r', '', configuration) 95 | else: 96 | with open(filename, 'r') as f: 97 | configuration = f.read() 98 | 99 | self.load_running_config = configuration 100 | 101 | return configuration 102 | 103 | def load_candidate_config(self, filename=None, config=None): 104 | """ Load a candidate config in to memory """ 105 | configuration = '' 106 | 107 | if filename is None: 108 | configuration = config 109 | else: 110 | with open(filename, 'r') as f: 111 | configuration = f.read() 112 | 113 | self.load_candidate_config = configuration 114 | 115 | return configuration 116 | 117 | def compare_config(self, running=None, candidate=None): 118 | """ Compare a running configuration with a candidate configuration """ 119 | 120 | if running is None: 121 | running_config = self.load_running_config 122 | else: 123 | running_config = running 124 | 125 | if candidate is None: 126 | candidate_config = self.load_candidate_config 127 | else: 128 | candidate_config = candidate 129 | 130 | diff = difflib.unified_diff(running_config.splitlines(1)[2:-2], 131 | candidate_config.splitlines(1)[2:-2]) 132 | diff = ''.join([x.replace('\r', '') for x in diff]) 133 | 134 | return diff 135 | 136 | def commit_config(self, filename=None, config=None): 137 | """ Push a configuration to a device """ 138 | configuration = '' 139 | encap_config = '' 140 | 141 | if filename: 142 | with open(filename, 'r') as f: 143 | configuration = f.read() 144 | else: 145 | configuration = config 146 | 147 | for line in configuration.split('\n'): 148 | encap_config += '{0}'.format(line) 149 | 150 | xml_encap = ''' 151 | 152 | 153 | 154 | 155 | 156 | {0} 157 | 158 | 159 | '''.format(encap_config) 160 | 161 | live = __execute_netconf__(self.host, rpc_command=xml_encap, 162 | timeout=self.timeout) 163 | return live 164 | --------------------------------------------------------------------------------