client

Documentation

Overview

Package client provides the client interface for 'exec'

Index

• Variables
• func ExecRemoteCommand(ctx context.Context, conn *proxy.Conn, binary string, args ...string) (*pb.ExecResponse, error)
• type ExecResponse
  • func ExecRemoteCommandMany(ctx context.Context, conn *proxy.Conn, binary string, args ...string) ([]ExecResponse, error)

Variables

var DefaultStreaming = false

Default value for using streaming exec. This is exposed so that clients can set a default that works for their environment. StreamingExec was added after Exec, so policies or sansshell nodes may not have been updated to support streaming.

Functions

func ExecRemoteCommand

func ExecRemoteCommand(ctx context.Context, conn *proxy.Conn, binary string, args ...string) (*pb.ExecResponse, error)

ExecRemoteCommand is a helper function for execing a command on a remote host using a proxy.Conn. If the conn is defined for >1 targets this will return an error.

Types

type ExecResponse

type ExecResponse struct {
	*pb.ExecResponse
	Index  int
	Target string
}

func ExecRemoteCommandMany

func ExecRemoteCommandMany(ctx context.Context, conn *proxy.Conn, binary string, args ...string) ([]ExecResponse, error)

ExecRemoteCommand is a helper function for execing a command on one or remote hosts using a proxy.Conn. `binary` refers to the absolute path of the binary file on the remote host.