ssh

Documentation

Overview

Package ssh provides utility functions for interfacing with OpenSSH.

Index

• func CompressionFlag() string
• func ConnectTimeoutFlag(timeout uint64) string
• func SCPCommand(context context.Context, args ...string) (*exec.Cmd, error)
• func SSHCommand(context context.Context, args ...string) (*exec.Cmd, error)
• func ServerAliveFlags(interval, countMax int) []string

Functions

func CompressionFlag

func CompressionFlag() string

CompressionFlag returns a flag that can be passed to scp or ssh to enable compression. Note that while SSH does have a CompressionLevel configuration option, this only applies to SSHv1. SSHv2 defaults to a DEFLATE level of 6, which is what we want anyway.

func ConnectTimeoutFlag

func ConnectTimeoutFlag(timeout uint64) string

ConnectTimeoutFlag returns a flag that can be passed to scp or ssh to limit connection time. The provided timeout is in seconds. The timeout must be greater than 0, otherwise this function will panic.

func SCPCommand

func SCPCommand(context context.Context, args ...string) (*exec.Cmd, error)

SCPCommand prepares (but does not start) an SCP command with the specified arguments and scoped to lifetime of the provided context.

func SSHCommand

func SSHCommand(context context.Context, args ...string) (*exec.Cmd, error)

SSHCommand prepares (but does not start) an SSH command with the specified arguments and scoped to lifetime of the provided context.

func ServerAliveFlags

func ServerAliveFlags(interval, countMax int) []string

ServerAliveFlags returns a set of flags that can be passed to scp or ssh to enable use of server alive messages. The provided interval is in seconds. Both the interval and count must be greater than 0, otherwise this function will panic.