How to run commands on multiple servers at once with vSSH?

Use the Run method with a context and timeout after adding clients via AddClient. The respChan allows iterating over responses from all connected machines, as shown in the basic example for concurrent execution.

vSSH vs Ansible for SSH automation: which should I use?

vSSH is better for custom Go-based automation at extreme scale with fine-grained control, while Ansible suits broader configuration management with built-in modules and YAML playbooks. Choose vSSH for performance-critical, programmatic tasks in Go environments.

How to set up label-based queries in vSSH?

Assign labels to clients with SetLabels during AddClient, then use RunWithLabel with a DSL string like '(POP == LAX) && OS == JUNOS' to target specific subsets, as demonstrated in the sample query.

Does vSSH support SSH key authentication?

Yes, vSSH supports key-based authentication through GetConfigPEM for PEM files, and other methods like GetConfigUserPass for password auth, providing flexibility for different security setups.

How to stream output in real-time with vSSH?

Call GetStream on a response and use ScanStdout in a loop to read output incrementally, enabling live monitoring without waiting for command completion, as illustrated in the stream example.

What happens if a SSH connection fails in vSSH?

Errors are captured in resp.Err(), allowing graceful handling in loops; the library continues processing other connections, ensuring robustness in large-scale operations where individual failures are common.

Open-Awesome

vssh

Apache-2.0Go

A Go library for executing commands over SSH at scale, handling tens of thousands of concurrent connections for network/server automation.

GitHub

992 stars89 forks0 contributors

What is vssh?

vSSH is a Go library that enables executing commands over SSH at scale, capable of handling tens of thousands of concurrent connections. It provides a higher-level API for building automation tools for network devices and servers, solving the problem of managing and orchestrating commands across large fleets of machines efficiently.

Target Audience

DevOps engineers, SREs, and developers building network or server automation tools who need to manage SSH connections at scale, such as for configuration management, monitoring, or batch operations.

Value Proposition

Developers choose vSSH for its ability to handle massive concurrent SSH connections with a simple API, label-based querying for targeted execution, and features like persistent connections and output streaming that optimize performance and control in automation workflows.

Overview

Go Library to Execute Commands Over SSH at Scale

Use Cases

Best For

Automating configuration changes across thousands of network devices
Running batch commands on large server fleets concurrently
Building custom network orchestration tools with SSH
Monitoring infrastructure by executing scripts on multiple machines
Managing cloud instances or data center servers via SSH automation
Performing parallel software deployments or updates over SSH

Not Ideal For

Projects not written in Go, as vSSH is a Go-specific library
Small-scale tasks with only a few SSH connections, where simpler tools like ssh or paramiko suffice
Interactive SSH sessions requiring real-time user input, as vSSH is designed for automation without interactive features
Environments already using integrated configuration management tools like Ansible, which offer broader automation capabilities

Pros & Cons

Pros

Massive Concurrency Handling

Capable of managing tens of thousands of SSH connections simultaneously, enabling efficient parallel execution across large fleets, as highlighted in the GitHub description.

Label-Based Query DSL

Provides a domain-specific language for targeting machines with custom labels, allowing precise command execution based on attributes like POP location or OS type, as shown in the sample query.

Persistent Connection Optimization

Maintains SSH sessions to reduce connection overhead and improve performance, which is crucial for repetitive automation tasks on network devices.

Streaming Output Support

Offers real-time access to command output as a stream, facilitating immediate processing and monitoring, demonstrated in the stream example with ScanStdout.

Cons

Go-Language Lock-In

Exclusively a Go library, making it unsuitable for projects in other programming languages and limiting integration with non-Go ecosystems.

Limited Higher-Level Features

Focuses on core SSH execution but lacks built-in utilities for common automation needs like file transfer or configuration templating, requiring additional code.

Sparse Documentation Beyond Godoc

Relies primarily on auto-generated godoc for documentation, which may not provide comprehensive guides or troubleshooting for complex use cases.

Frequently Asked Questions

Related Projects

fasthttp

Fast HTTP package for Go. Tuned for high performance. Zero memory allocations in hot paths. Up to 10x faster than net/http

Pure Go implementation of the WebRTC API

Cloudflare Tunnel client

Stars14,573

Forks1,329

Last commit2 days ago

kcptun

Reliable UDP Transmission Optimizer based on KCP: Enhancing network efficiency in poor connectivity environments.

Stars14,403

Forks2,631

Last commit2 months ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub