Python Other
Latest commit 9703ece Feb 27, 2017 @ntwrkguru ntwrkguru committed with stacywsmith resolved bind mount issue (#673)
Permalink
Failed to load latest commit information.
docs Enhanced fact gathering (#638) Jan 30, 2017
lib/jnpr Merge pull request #665 from itdependsnetworks/ntc-updates Feb 16, 2017
tests Adding support for NFX/JDM fact gathering. Address Issue #652. (#659) Feb 4, 2017
vagrant Update README.md Mar 26, 2014
.coveragerc Excluded cfg directory from coverage May 29, 2014
.dockerignore Updating Dockerfile and .dockerignore Aug 18, 2016
.gitignore Update .gitignore to ignore desktop.ini, .DS_Store, and .idea files. Sep 14, 2016
.travis.yml importlib is requirment for python 2.6 Aug 24, 2016
COPYRIGHT init Oct 12, 2013
Dockerfile resolved bind mount issue (#673) Feb 27, 2017
INSTALL-FEDORA-CENTOS.md Add CentOS Support to install instructions (#623) Nov 15, 2016
INSTALL-FREEBSD.md Update Installation Notes Mar 26, 2014
INSTALL-OSX.md Added OS X INSTALL and updated README May 7, 2014
INSTALL-UBUNTU-DEBIAN.md added force-yes to avoid prompt Jul 12, 2016
LICENSE added Copyright section Aug 20, 2015
MANIFEST.in added requirements.txt for package distribution Apr 18, 2014
README.md resolved bind mount issue (#673) Feb 27, 2017
README.txt fix for pypi upload Nov 29, 2013
RELEASE-NOTES.md Updating release notes with the changes committed to the dev Oct 26, 2016
development.txt latest coverage module doesnt show missing line number, hence reverti… Jun 10, 2016
docreq.txt Req file for docs Jun 19, 2014
env-setup.sh updates Mar 17, 2014
requirements.txt DeprecationWarning warning for python2.6 Aug 24, 2016
setup.py Update version in setup.py for development of 2.0.2 Oct 26, 2016

README.md

PyPi Version Documentation Status Coverage Status Coverage Status

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

API Documentation hosted by readthedocs

Junos PyEZ wiki page, here.

ABOUT

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

You can also post your query on stackoverflow with pyez tag

For documentation and more usage examples, please visit the Junos PyEZ project page, here.

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

NOTICE

As of release 2.0.0, Junos PyEZ requires ncclient version 0.5.2 or later.

INSTALLATION

PIP

Installation requires Python 2.6 or 2.7 or >=3.4 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@<branch,tag,commit>

Docker

Move to the local directory which contains your script(s) and run the container

docker run -it --rm --name -v $PWD:/scripts pyez juniper/pyez sh

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

cd scripts

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.

from pprint import pprint
from jnpr.junos import Device

dev = Device(host='my_host_or_ipaddr', user='jeremy', password='jeremy123' )
dev.open()

pprint( dev.facts )

dev.close()

Example output for an SRX-210 device:

>>> 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 jnpr-community-netdev@juniper.net for any queries.

Contributors:

Nitin Kumar, Edward Arcuri, Stacy Smith

Former Contributors:

Jeremy Schulman, Rick Sherman