Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/Juniper/py-junos-eznc

Python library for Junos automation
https://github.com/Juniper/py-junos-eznc

junos-automation junos-eznc junos-pyez netconf pyez python

Last synced: 2 months ago
JSON representation

Python library for Junos automation

Lists

README 

        
[![PyPi Version](https://img.shields.io/pypi/v/junos-eznc.svg)](https://pypi.python.org/pypi/junos-eznc/)

[![Documentation Status](https://readthedocs.org/projects/junos-pyez/badge/?version=stable)](http://junos-pyez.readthedocs.io)

[![Coverage Status](https://img.shields.io/coveralls/Juniper/py-junos-eznc.svg)](https://coveralls.io/r/Juniper/py-junos-eznc)

[![UnitTest Status](https://travis-ci.org/Juniper/py-junos-eznc.svg?branch=master)](https://travis-ci.org/Juniper/py-junos-eznc)

[![](https://images.microbadger.com/badges/image/juniper/pyez.svg)](https://microbadger.com/images/juniper/pyez)



The repo is under active development.  If you take a clone, you are getting the latest, and perhaps not entirely stable code.  



# DOCUMENTATION



Official Documentation with examples, [here](http://www.juniper.net/techpubs/en_US/release-independent/junos-pyez/information-products/pathway-pages/index.html)



API Documentation hosted by [readthedocs](http://junos-pyez.readthedocs.org)



_Junos PyEZ_ wiki page, [here](http://forums.juniper.net/t5/Automation/Where-can-I-learn-more-about-Junos-PyEZ/ta-p/280496).



# ABOUT



![PyEZ logo](static/PyEZ.png?raw=true "PyEZ logo")



_Junos PyEZ_ is a Python library to remotely manage/automate Junos devices.  The user is ***NOT*** required: (a) to be a "Software Programmer™", (b) have sophisticated knowledge of Junos, or (b) have a complex understanding of the Junos XML API.  



This library was built for two types of users:



## For "Non-Programmers" - Python as a Power Shell



This means that "non-programmers", for example the _Network Engineer_, can use the native Python shell on their management server (laptop, tablet, phone, etc.) as their point-of-control for remotely managing Junos devices. The Python shell is an interactive environment that provides the necessary means to perform common automation tasks, such as conditional testing, for-loops, macros, and templates.  These building blocks are similar enough to other "shell" environments, like Bash, to enable the non-programmer to use the Python shell as a power-tool, rather than a programming language.  From the Python shell a user can manage Junos devices using native hash tables, arrays, etc. rather than device-specific Junos XML or resorting to 'screen scraping' the actual Junos CLI.



## For "Programmers" - Open and Extensible



There is a growing interest and need to automate the network infrastructure into larger IT systems.  To do so, traditional software programmers, DevOps, "hackers", etc. need an abstraction library of code to further those activities.  _Junos PyEZ_ is designed for extensibility so that the programmer can quickly and easily add new widgets to the library in support of their specific project requirements.  There is no need to "wait on the vendor" to provide new functionality.   _Junos PyEZ_ is not specifically tied to any version of Junos or any Junos product family.



# SUPPORT



For questions and general support, please visit our [Google Group](https://groups.google.com/forum/#!forum/junos-python-ez)



You can also post your query on stackoverflow with __pyez__ [tag](http://stackoverflow.com/questions/tagged/pyez)



For documentation and more usage examples, please visit the _Junos PyEZ_ project page, [here](http://forums.juniper.net/t5/Automation/Where-can-I-learn-more-about-Junos-PyEZ/ta-p/280496).



Issues and bugs can be opened in the repository.



# FEATURES



_Junos PyEZ_ is designed to provide the same capabilities as a user would have on the Junos CLI, but in an environment built for automation tasks.  These capabilities include, but are not limited to:



* Remote connectivity and management of Junos devices via NETCONF

* Provide "facts" about the device such as software-version, serial-number, etc.

* Retrieve "operational" or "run-state" information as Tables/Views

* Retrieve configuration information as Tables/Views

* Make configuration changes in unstructured and structured ways

* Provide common utilities for tasks such as secure copy of files and software updates



# NOTICES



- As of release 2.0.0, _Junos PyEZ_ requires [ncclient](https://pypi.python.org/pypi/ncclient) version 0.5.2 or later.

- When using the `ssh_private_key_file` argument of the Device constructor on MacOS Mojave and higher, ensure that the SSH keys are in the RSA format, and not the newer OPENSSH format.

  - New key: `ssh-keygen -p -m PEM -f ~/.ssh/id_rsa`

  - Convert an existing OPENSSH key: ``ssh-keygen -p -m PEM -f ~/.ssh/private_key`

  - Check if a given key is RSA or OPENSSH format: `head -n1 ~/.ssh/private_key`

    - RSA: `-----BEGIN RSA PRIVATE KEY-----`

    - OPENSSH: `-----BEGIN OPENSSH PRIVATE KEY-----` 



# INSTALLATION



## PIP



Installation requires Python >=3.8 and associated `pip` tool



    pip install junos-eznc



Installing from Git is also supported (OS must have git installed).



	To install the latest MASTER code

	pip install git+https://github.com/Juniper/py-junos-eznc.git

	-or-

	To install a specific version, branch, tag, etc.

	pip install git+https://github.com/Juniper/py-junos-eznc.git@



## Docker



### Interactive Docker Usage



Move to the local directory which contains your script(s) and run the container. Running the container in this manner will put you into an interactive Bash session.



`docker run -it [ --rm ] [ --name pyez ] -v $PWD:/scripts juniper/pyez`



Your local scripts will be mounted to /scripts in the container.



### Microservice Usage



This image can also be used as a Python "executable" with the required Python PyEZ libraries pre-installed. To use the image in this way, mount the volume which contains the Python script and pass the script name as an argument to `docker run`. Optionally, you may also pass in a `requirements.txt` file to install additional python packages via `pip`. To add OS packages (Alpine Linux), provide a file with a list of packages --one per line-- and either reference it as an env var (`$APK`) or mount it to the container `/extras/apk.txt`. To add additional Python packages (via pip), provide a `requirements.txt` file and pass it in as an env var (`$REQ`) or mount it to the container at `/extras/requirements.txt`.



`Usage: `docker run -it [ --rm ] -v some/dir:/scripts juniper/pyez [ myscript.py ]`



Example:



```bash

$ docker run -it --rm -v $PWD:/scripts juniper/pyez tmp.py

tmp.py

{'2RE': False, 'HOME': '/var/home/lab', 'RE0': {'mastership_state': 'master', 'status': 'OK', 'model': 'RE-SRX210H-POE', 'last_reboot_reason': '0x1:power cycle/failure', 'up_time': '36 days, 11 hours, 49 minutes, 59 seconds'}, 'RE1': None, 'RE_hw_mi': False, 'current_re': ['master', 'node', 'fwdd', 'member', 'pfem', 'backup', 're0', 'fpc0.pic0'], 'domain': None, 'fqdn': 'fw1.localdomain', 'hostname': 'fw1.localdomain', 'hostname_info': {'re0': 'fw1.localdomain'}, 'ifd_style': 'CLASSIC', 'junos_info': {'re0': {'text': '12.1X44-D40.2', 'object': junos.version_info(major=(12, 1), type=X, minor=(44, 'D', 40), build=2)}}, 'master': 'RE0', 'model': 'SRX210H-POE', 'model_info': {'re0': 'SRX210H-POE'}, 'personality': 'SRX_BRANCH', 're_info': {'default': {'0': {'mastership_state': 'master', 'status': 'OK', 'model': 'RE-SRX210H-POE', 'last_reboot_reason': '0x1:power cycle/failure'}, 'default': {'mastership_state': 'master', 'status': 'OK', 'model': 'RE-SRX210H-POE', 'last_reboot_reason': '0x1:power cycle/failure'}}}, 're_master': {'default': '0'}, 'serialnumber': 'AE3009AA0101', 'srx_cluster': False, 'srx_cluster_id': None, 'srx_cluster_redundancy_group': None, 'switch_style': 'VLAN', 'vc_capable': False, 'vc_fabric': None, 'vc_master': None, 'vc_mode': None, 'version': '12.1X44-D40.2', 'version_RE0': '12.1X44-D40.2', 'version_RE1': None, 'version_info': junos.version_info(major=(12, 1), type=X, minor=(44, 'D', 40), build=2), 'virtual': False}

done

```



See [DOCKER-EXAMPLES.md](https://github.com/Juniper/py-junos-eznc/blob/master/DOCKER-EXAMPLES.md) for some example usage.



## Upgrade



Upgrading has the same requirements as installation and has the same format with the addition of -UPGRADE



	pip install -U junos-eznc



## HELLO, WORLD



The following is a quick "hello, world" example to ensure that the software was installed correctly.  This code will simply connect to a device and display the known facts of the device, like serial-number, model, etc.



````python

from pprint import pprint

from jnpr.junos import Device



with Device(host='my_host_or_ipaddr', user='jeremy', password='jeremy123' ) as dev:

    pprint( dev.facts )

````

Example output for an SRX-210 device:

````python

>>> pprint(dev.facts)

{'2RE': False,

 'RE0': {'last_reboot_reason': '0x20:power-button soft power off',

         'model': 'RE-SRX210H',

         'status': 'OK',

         'up_time': '10 minutes, 3 seconds'},

 'domain': 'workflowsherpas.com'         

 'fqdn': 'srx210.workflowsherpas.com',

 'hostname': 'srx210',

 'ifd_style': 'CLASSIC',

 'model': 'SRX210H',

 'personality': 'SRX_BRANCH',

 'serialnumber': 'AD2909AA0096',

 'switch_style': 'VLAN',

 'version': '12.1X44-D10.4',

 'version_info': junos.versino_info(major=(12, 1), type=X, minor=(44, 'D', 10), build=4)}

````



# LICENSE



Apache 2.0



# CONTRIBUTORS



Juniper Networks is actively contributing to and maintaining this repo. Please contact [email protected] for any queries.



*Contributors:*



[Nitin Kumar](https://github.com/vnitinv), [Stacy Smith](https://github.com/stacywsmith), [Stephen Steiner](https://github.com/ntwrkguru)



* v2.4.1: [Nitin Kumar](https://github.com/vnitinv)

* v2.4.0: [Nitin Kumar](https://github.com/vnitinv)

* v2.3.0: [Nitin Kumar](https://github.com/vnitinv), [Raja Shekar Mekala](https://github.com/rsmekala), [Dinesh Babu](https://github.com/dineshbaburam91), [Chris Jenn](https://github.com/ipmonk), [Shigechika](https://github.com/shigechika)

* v2.2.1: [Nitin Kumar](https://github.com/vnitinv), [Raja Shekar Mekala](https://github.com/rsmekala), [Dinesh Babu](https://github.com/dineshbaburam91), [Marcel Wiget](https://github.com/mwiget), [John Tishey](https://github.com/jtishey), [Alex Carp](https://github.com/carpalex), [Cory Councilman](https://github.com/dragonballbw3) 

* v2.2.0: [Nitin Kumar](https://github.com/vnitinv), [Raja Shekar Mekala](https://github.com/rsmekala), [Marek](https://github.com/mzbroch), [Marcel Wiget](https://github.com/mwiget)

* v2.1.9: [Dinesh Babu](https://github.com/dineshbaburam91), [Nitin Kumar](https://github.com/vnitinv), [Jacob Neil Taylor](https://github.com/jacobneiltaylor), [Raja Shekar Mekala](https://github.com/rsmekala)

* v2.1.8: [Dinesh Babu](https://github.com/dineshbaburam91), [Stephen Steiner](https://github.com/ntwrkguru)

* v2.1.7: [Stacy Smith](https://github.com/stacywsmith)

* v2.0.0: [Ganesh Nalawade](https://github.com/ganeshrn), [Jainpriyal](https://github.com/Jainpriyal)



*Former Contributors:*



[Jeremy Schulman](https://github.com/jeremyschulman), [Rick Sherman](https://github.com/shermdog), [Edward Arcuri](https://github.com/sdndude)