ssh_client

README

ssh-client

Simple packaging for golang.org/x/crypto/ssh

Install

go get gitee.com/zhangsq-cn/ssh-client

Usage Example

package main

import (
    "gitee.com/zhangsq-cn/ssh_client"
    "fmt"
)

func main()  {
    client, err := ssh_client.NewSSHClient("IP:port", "username", "password")
    if err != nil {
        panic(err)
    }

    username, err = client.Output("whoami")
    if err != nil {
        panic(err)
    }

    fmt.Println(string(username))
}

Test

$ export TEST_HOST="ip:port"
$ export TEST_USER="username"
$ export TEST_PWD="password"
$ go test -v

Documentation

Index

• type SSHClient
  • func NewSSHClient(host, username, password string) (*SSHClient, error)
  • func (c *SSHClient) Close() error
  • func (c *SSHClient) CombinedOutput(cmd string) ([]byte, error)
  • func (c *SSHClient) Output(cmd string) ([]byte, error)
  • func (c *SSHClient) Run(cmd string) error
  • func (c *SSHClient) Start(cmd string) (*ssh.Session, error)

Types

type SSHClient

type SSHClient struct {
	// contains filtered or unexported fields
}

func NewSSHClient

func NewSSHClient(host, username, password string) (*SSHClient, error)

func (*SSHClient) Close

func (c *SSHClient) Close() error

Close the ssh client

func (*SSHClient) CombinedOutput

func (c *SSHClient) CombinedOutput(cmd string) ([]byte, error)

Start a command and receive all output from the command

func (*SSHClient) Output

func (c *SSHClient) Output(cmd string) ([]byte, error)

Start a command and receive standard output from the command

func (*SSHClient) Run

func (c *SSHClient) Run(cmd string) error

Start a command that does not require output

func (*SSHClient) Start

func (c *SSHClient) Start(cmd string) (*ssh.Session, error)

Start a command that will run continuously, calling Close() method of the session to end the command