scrapli

Warnings

• breaking Scrapli v2.0.0, currently in Release Candidate, introduces significant architectural changes ('scrapli2'). While the core API aims for consistency between sync/async, users should review the changelog for specific breaking changes in import paths, class structures, or method signatures upon the final v2.0.0 release.
  Fix: Consult the official v2.0.0 documentation and migration guides upon final release. For now, pin to `scrapli<2.0.0` for stability.
• deprecated Support for Python 3.6 was dropped in scrapli core (v2022.01.30) and related libraries like `scrapli_netconf` and `scrapli_community`.
  Fix: Upgrade your Python environment to 3.9 or higher. The current version requires Python >=3.9.
• deprecated In `scrapli_netconf`, `NetconfScrape` and `AsyncNetconfScrape` classes were renamed to `NetconfDriver` and `AsyncNetconfDriver`, respectively, and subsequently removed.
  Fix: Update your imports from `from scrapli_netconf import NetconfScrape` to `from scrapli_netconf.driver import NetconfDriver`.
• gotcha By default, scrapli uses 'system' transport, leveraging the local SSH binary. While this has zero external Python dependencies, it may require `auth_strict_key=False` in device arguments to bypass strict host key checking, especially in lab environments or when `known_hosts` is not managed.
  Fix: Include `auth_strict_key=False` in your device dictionary if you encounter host key verification issues. For production, consider proper `known_hosts` management or specifying an SSH config file.
• gotcha Scrapli's core library supports a limited set of 'NAPALM-like' platforms (Cisco IOS-XE, IOS-XR, NX-OS, Arista EOS, Juniper JunOS). For other network operating systems, you will need `scrapli_community` or to use `GenericDriver`/`NetworkDriver` with custom privilege levels and on-open/on-close functions.
  Fix: For unsupported platforms, install `scrapli-community` (`pip install scrapli-community`) and import drivers from there, or use `from scrapli.driver.generic import GenericDriver` and define custom interaction logic.
• gotcha Using Telnet as a transport requires explicit configuration. The default port is 22 (SSH), even if the Telnet driver is implicitly selected by an older method.
  Fix: When using Telnet, ensure you explicitly set `transport='telnet'` and `port=23` (or your custom Telnet port) in your device arguments.

Install

• pip install scrapli Standard Installation
• pip install scrapli[paramiko,ssh2,asyncssh,textfsm,genie,netconf,community,full] Installation with optional extras

Imports

• Scrapli

  from scrapli import Scrapli

  General factory class for platform-agnostic connections
• IOSXEDriver

  from scrapli.driver.core import IOSXEDriver

  Specific synchronous driver for Cisco IOS-XE devices. Replace 'IOSXEDriver' with the appropriate driver for your platform (e.g., 'NXOSDriver', 'JunosDriver', 'EOSDriver', 'IOSXRDriver').
• AsyncIOSXEDriver

  from scrapli.driver.core import AsyncIOSXEDriver

  Specific asynchronous driver for Cisco IOS-XE devices. Replace 'AsyncIOSXEDriver' with the appropriate driver for your platform.
• NetconfDriver
  wrong:

  from scrapli_netconf import NetconfScrape

  correct:

  from scrapli_netconf.driver import NetconfDriver

  The 'NetconfScrape' class was deprecated and removed in 'scrapli_netconf' v2022.01.30. Use 'NetconfDriver' instead for NETCONF connections.

Quickstart

This quickstart demonstrates a synchronous connection to a Cisco IOS-XE device, sending a 'show version' command and a configuration. It uses the `IOSXEDriver` with a context manager for automatic connection management. Device credentials are retrieved from environment variables for security. Replace `IOSXEDriver` with `AsyncIOSXEDriver` and `conn.send_command` with `await conn.send_command` within an `async def` function if using asynchronous operations.

import os
from scrapli.driver.core import IOSXEDriver
from scrapli.exceptions import ScrapliException

def get_device_info():
    device = {
        "host": os.environ.get("SCRAPLI_HOST", "your_device_ip"),
        "auth_username": os.environ.get("SCRAPLI_USERNAME", "admin"),
        "auth_password": os.environ.get("SCRAPLI_PASSWORD", "password"),
        "auth_strict_key": False, # Often needed for labs or unknown hosts
        "transport": "system", # 'system', 'paramiko', 'ssh2', 'telnet'
        "port": 22 # Default for SSH, 23 for Telnet
    }
    return device

def main_sync():
    device_info = get_device_info()
    try:
        # Using a context manager for automatic open/close
        with IOSXEDriver(**device_info) as conn:
            print(f"Connected to {conn.host} successfully.")
            response = conn.send_command("show version")
            if response.failed:
                print(f"Command failed: {response.result}")
                return
            print("--- Show Version Output ---")
            print(response.result)

            response_config = conn.send_configs(["interface Loopback0", "description Test Loopback"]) 
            if response_config.failed:
                print(f"Config failed: {response_config.result}")
                return
            print("--- Configuration Output ---")
            print(response_config.result)

    except ScrapliException as e:
        print(f"Scrapli error: {e}")
    except Exception as e:
        print(f"An unexpected error occurred: {e}")

if __name__ == "__main__":
    # Example usage: Set environment variables or update `get_device_info` with actual values
    # os.environ['SCRAPLI_HOST'] = '172.18.0.11'
    # os.environ['SCRAPLI_USERNAME'] = 'vrnetlab'
    # os.environ['SCRAPLI_PASSWORD'] = 'VR-netlab9'
    main_sync()