Categorygithub.com/scylladb/go-sshtools
modulepackage
1.0.0
Repository: https://github.com/scylladb/go-sshtools.git
Documentation: pkg.go.dev

# README

Scylla SSH tools

Package sshtools provides a wrapper around SSH client with the following features:

  • Context aware (dial and execution),
  • Keepalive enabled,
  • Can copy files using SCP.

License

Copyright (C) 2017 ScyllaDB

This project is distributed under the Apache 2.0 license. See the LICENSE file for details. It contains software from:

# Packages

No description provided by the author

# Functions

ContextDialer returns DialContextFunc based on dialer to make net connections.
DefaultConfig returns a Config initialized with default values.
No description provided by the author
StartKeepalive starts sending server keepalive messages until done channel is closed.

# Structs

Cmd represents a remote command being prepared or run.
Communicator allows for executing commands on a remote host over SSH, it is not thread safe.
Config specifies SSH configuration.
ExitError is returned by Wait to indicate an error while executing the remote command, or a non-zero exit status.

# Interfaces

Logger is the minimal interface Communicator needs for logging.

# Type aliases

DialContextFunc creates SSH connection to host with a given address.