- play_arrow Disclaimer
- play_arrow Install Junos PyEZ
- play_arrow Connect to and Retrieve Facts From a Device Using Junos PyEZ
- play_arrow Use Junos PyEZ to Manage Device Operations
- Use Junos PyEZ to Execute RPCs on Junos Devices
- Suppress RpcError Exceptions Raised for Warnings in Junos PyEZ Applications
- Use Junos PyEZ to Halt, Reboot, or Shut Down Junos Devices
- Use Junos PyEZ to Install Software on Junos Devices
- Use Junos PyEZ to Perform File System Operations
- Transfer Files Using Junos PyEZ
- Specify the XML Parser for a Junos PyEZ Session
- play_arrow Use Junos PyEZ to Manage the Configuration
- Use Junos PyEZ to Retrieve a Configuration
- Use Junos PyEZ to Compare the Candidate Configuration and a Previously Committed Configuration
- Use Junos PyEZ to Configure Junos Devices
- Use the Junos PyEZ Config Utility to Configure Junos Devices
- Use Junos PyEZ to Commit the Configuration
- Example: Use Junos PyEZ to Load Configuration Data from a File
- Example: Use Junos PyEZ to Roll Back the Configuration
- Use Junos PyEZ to Manage the Rescue Configuration on Junos Devices
- play_arrow Create and Use Junos PyEZ Tables and Views
- Understanding Junos PyEZ Tables and Views
- Predefined Junos PyEZ Operational Tables (Structured Output)
- Load Inline or External Tables and Views in Junos PyEZ Applications
- Define Junos PyEZ Operational Tables for Parsing Structured Output
- Define Views for Junos PyEZ Operational Tables that Parse Structured Output
- Use Junos PyEZ Operational Tables and Views that Parse Structured Output
- Define Junos PyEZ Operational Tables for Parsing Unstructured Output
- Define Views for Junos PyEZ Operational Tables that Parse Unstructured Output
- Use Junos PyEZ Tables with TextFSM Templates
- Use Junos PyEZ Operational Tables and Views that Parse Unstructured Output
- Define Junos PyEZ Configuration Tables
- Define Views for Junos PyEZ Configuration Tables
- Use Junos PyEZ Configuration Tables to Retrieve Configuration Data
- Overview of Using Junos PyEZ Configuration Tables to Define and Configure Structured Resources
- Use Junos PyEZ Configuration Tables to Configure Structured Resources on Junos Devices
- Save and Load Junos PyEZ Table XML to and from Files
- play_arrow Troubleshoot Junos PyEZ
Junos PyEZ Modules Overview
The Junos PyEZ Python library provides modules that you can use to connect to and perform operations on Junos devices.
Junos PyEZ is a microframework for Python that enables you to manage and automate Junos devices.
Junos PyEZ consists of the jnpr.junos package, which contains modules that
handle device connectivity and provide operational and configuration utilities.
Table 1 outlines the primary Junos PyEZ modules that are used to manage Junos devices. For detailed information about each module, see the Junos PyEZ API Reference at http://junos-pyez.readthedocs.org/.
jnpr.junos Modules | Description |
|---|---|
| Defines the |
| Includes predefined operational Tables and Views that can be used to filter unstructured output returned from CLI and vty commands and convert it to JSON. |
| Defines exceptions encountered when accessing, configuring, and managing Junos devices. |
| Contains code pertaining to Tables and Views, including
the |
| A dictionary-like object of read-only facts about the
device. These facts are accessed using the |
| Includes predefined operational Tables and Views that can be used to filter structured (XML) output returned from RPCs. |
| Includes predefined configuration Tables and Views representing specific configuration resources, which can be used to programmatically configure Junos devices. |
| Contains code used by the |
| Includes configuration utilities, file system utilities, shell utilities, software installation utilities, and secure copy utilities. |
In Junos PyEZ, each device is modeled as an instance of the
jnpr.junos.device.Device class. The device module provides
access to Junos devices through a serial console connection, telnet, or SSH and also supports
connecting to the device through a telnet or SSH connection to a console server that is connected
to the device’s CONSOLE port. All connection methods support retrieving device
facts, performing operations, and executing RPCs on demand. Support for serial console
connections and for telnet and SSH connections through a console server enables you to connect to
and initially configure new or zeroized devices that are not yet configured for remote access.
Facts about the device are accessed using the facts attribute of the
Device object instance.
The utils module defines submodules and classes that handle software
installation, file system and copy operations, and configuration management. The
exception module defines exceptions encountered when managing Junos devices.
The command, op, resources, and
factory modules pertain to Tables and Views. The command and
op modules contain predefined operational Tables and Views that can be used to
extract specific information from the output of common operational commands and RPCs on Junos
devices. The resources module contains predefined configuration Tables and Views
that can be used to configure specific resources on Junos devices. The factory
module contains methods that enable you to load your own custom Tables and Views in Junos PyEZ
applications.
