exec

Documentation

Index

• func AgentSocket(s string) func(*Options)
• func Cmd(c string) func(*Options)
• func Key(k string) func(*Options)
• func Machines(m []string) func(*Options)
• func Port(p int) func(*Options)
• func Run(options ...func(*Options)) bool
• func UseAgent(u bool) func(*Options)
• func User(u string) func(*Options)
• type Options

Functions

func AgentSocket

func AgentSocket(s string) func(*Options)

AgentSocket Sets the agent socket file Default is the value for env var SSH_AUTH_SOCK

func Cmd

func Cmd(c string) func(*Options)

Cmd Sets the command to be run option

func Key

func Key(k string) func(*Options)

Key Sets the ssh key filename used to authenticate

func Machines

func Machines(m []string) func(*Options)

Machines Sets the list of machines where to run the command

func Port

func Port(p int) func(*Options)

Port Sets the port option

func Run

func Run(options ...func(*Options)) bool

Run Main function that kicks off the run

func UseAgent

func UseAgent(u bool) func(*Options)

UseAgent Sets whether we want to use the ssh agent to authenticate

func User

func User(u string) func(*Options)

User Sets the user option

Types

type Options

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

Options Type that holds all the options for sshrunner