JN0-223 Python/PyEZ

Python/PyEZ Detailed Explanation

This topic explains how Python and the PyEZ library can be used for network automation with Junos devices.

Role of Python

Python is widely recognized as the primary programming language for network automation because of its simplicity, readability, and powerful libraries. Juniper Networks provides the PyEZ library, specifically designed to automate interactions with Junos devices.

• Why Use Python for Network Automation?

  • Ease of Use: Python has a simple syntax that makes it beginner-friendly.
  • Extensive Libraries: Libraries like PyEZ, Paramiko, and Netmiko simplify device interaction.
  • Cross-Platform Compatibility: Python works across different operating systems and integrates well with APIs and automation tools.

• What is PyEZ?

  • PyEZ is a Python library provided by Juniper Networks.
  • It simplifies common tasks like device connection, configuration management, and state retrieval.
  • PyEZ abstracts complex network protocols (like NETCONF) into easy-to-use Python methods.

PyEZ Components

The PyEZ library is modular, with different components for specific tasks. Here are the three most commonly used components:

1. Device Class

The Device class is the foundation of PyEZ. It establishes a connection to a Junos device and allows interaction with it.

• Steps to Connect to a Device:

  1. Import the Device class from PyEZ.
  2. Create an instance of Device with the device’s IP, username, and password.
  3. Open the connection.
  4. Access device information (like hostname, model, or software version).
  5. Close the connection when done.

• Example Code:

  from jnpr.junos import Device
  
  # Define device connection details
  dev = Device(host='192.168.1.1', user='admin', passwd='password')
  
  # Open a connection to the device
  dev.open()
  
  # Print device facts (basic information like hostname, version, etc.)
  print(dev.facts)
  
  # Close the connection
  dev.close()
  

• Output Example:

  {'hostname': 'router1', 'model': 'MX240', 'version': '20.2R3'}
  

• Benefits:

  • Simplifies the process of connecting to Junos devices.
  • Provides built-in methods to retrieve device information.

2. Configuration Management

The Config class in PyEZ allows you to:

• Load configurations (in various formats like set, xml, or json).

• Commit changes to the device.

• Roll back configurations if necessary.

• Steps for Configuration Management:

  1. Import the Config utility from PyEZ.
  2. Open a configuration session with the device.
  3. Load new configurations.
  4. Commit the changes.

• Example Code:

  from jnpr.junos.utils.config import Config
  from jnpr.junos import Device
  
  # Connect to the device
  dev = Device(host='192.168.1.1', user='admin', passwd='password')
  dev.open()
  
  # Open a configuration session
  with Config(dev) as cu:
      # Load a configuration in 'set' format
      cu.load('set system host-name my-device', format='set')
  
      # Commit the changes
      cu.commit()
  
  # Close the connection
  dev.close()
  

• Explanation:

  • The script changes the hostname of the device to my-device.
  • The with statement ensures the configuration session is properly closed after the operation.

• Benefits:

  • Easy to push configurations to devices.
  • Supports error checking and rollbacks.

3. Operational Commands

The Command class lets you execute operational (non-configuration) commands on Junos devices. These are typically "show" commands used to retrieve device status, logs, or statistics.

• Steps for Running Commands:

  1. Import the Command utility from PyEZ.
  2. Connect to the device.
  3. Execute a command and retrieve the output.

• Example Code:

  from jnpr.junos.utils.command import Command
  from jnpr.junos import Device
  
  # Connect to the device
  dev = Device(host='192.168.1.1', user='admin', passwd='password')
  dev.open()
  
  # Execute a 'show version' command
  output = Command(dev).execute('show version')
  
  # Print the command output
  print(output)
  
  # Close the connection
  dev.close()
  

• Output Example:

  Hostname: router1
  Model: MX240
  Junos: 20.2R3
  

• Benefits:

  • Simplifies retrieving operational data.
  • Outputs data in a structured format (easy to process programmatically).

Real-world Applications

Here are practical scenarios where Python and PyEZ can be used in network automation:

1. Automating Configuration Backups

• Use PyEZ to connect to devices and retrieve their running configuration.
• Save the configurations to a file or database for backup purposes.

Example:

from jnpr.junos import Device

# Connect to the device
dev = Device(host='192.168.1.1', user='admin', passwd='password')
dev.open()

# Retrieve configuration
config = dev.rpc.get_config()

# Save the configuration to a file
with open('backup.xml', 'w') as backup_file:
    backup_file.write(config.xml)

# Close the connection
dev.close()

2. Periodically Retrieving Device States

• Schedule scripts to run at regular intervals and retrieve operational data like interface status, CPU usage, or system uptime.

Example:

from jnpr.junos import Device

def check_interface_status(device_ip, user, password):
    # Connect to the device
    dev = Device(host=device_ip, user=user, passwd=password)
    dev.open()

    # Get interface information
    interfaces = dev.rpc.get_interface_information()
    print(interfaces)

    # Close the connection
    dev.close()

# Periodically check the interface status
check_interface_status('192.168.1.1', 'admin', 'password')

Summary

PyEZ provides a straightforward and Pythonic way to automate Junos device operations. Its modular components make tasks like device connection, configuration management, and state retrieval simple and efficient. By using PyEZ, you can:

• Streamline routine network management tasks.
• Ensure consistency and reduce human error.
• Easily scale automation workflows for large networks.