Documentation
¶
Overview ¶
Package client provides functionality so that other uses of sansshell can provide their own main.go without having to cargo-cult everything across for common use cases. i.e. adding additional modules that are locally defined.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type RunState ¶ added in v1.0.2
type RunState struct {
// Proxy is an optional proxy server to route requests.
Proxy string
// Targets is a list of remote targets to use when a proxy
// is in use. For non proxy must be 1 entry.
Targets []string
// Outputs must map 1:1 with Targets indicating where to emit
// output from commands. If the list is empty or a single entry
// set to - then stdout/stderr will be used for all outputs.
Outputs []string
// OutputsDir defines a directory to place outputs instead of
// specifying then in Outputs. The files will be names 0.output,
// 1.output and .error respectively for each target.
OutputsDir string
// CredSource is a registered credential source with the mtls package.
CredSource string
// Timeout is the duration to place on the context when making RPC calls.
Timeout time.Duration
// ClientPolicy is an optional OPA policy for determining outbound decisions.
ClientPolicy string
}
RunState encapsulates all of the variable state needed to run a sansssh command.
Click to show internal directories.
Click to hide internal directories.