netapult-ssh 0.0.2

Plugin for Netapult to support command execution over SSH

🐚 Netapult: SSH Plugin

---

💼 Purpose | 🏁 Usage

---

Purpose

This plugin provides the SSH protocol for Netapult, enabling scalable network automation and orchestration for network-connected devices.

Usage

This package registers a ssh protocol handler for Netapult, usable from Netapult's dispatcher.

import time

import netapult

with netapult.dispatch(
    "generic", # Use the generic client
    "ssh", # Use our SSH protocol
    protocol_options={
        "host": "your-host-here",
        "username": "your-username-here",
        "password": "your-password-here",
    },
) as client:
    # Allow time for the terminal to initialize
    time.sleep(3)

    # Acquire the banner
    banner: str = client.read(text=True)
    prompt_found, result = client.run_command("echo Hello World\n", text=True)

    print("Banner:", banner)
    print("Result:", result)