package
0.18.0
Repository: https://github.com/hashicorp/boundary.git
Documentation: pkg.go.dev

# Packages

No description provided by the author

# Functions

If the first arg isn't a flag, extract it as the alias and return the remaining args.
No description provided by the author
GetOpts - iterate the inbound Options and return a struct.
MakeShutdownCh returns a channel that can be used for shutdown notifications for commands.
MakeSighupCh returns a channel that can be used for SIGHUP reloading.
No description provided by the author
New returns a new instance of a base.Command type.
NewEventFlags will create a new EventFlags based on the ComposedOfEventArgs which should be populated with command flags which have already been "parsed".
NewFlagSet creates a new flag set.
NewFlagSets creates a new flag sets.
New creates a new listener of the given type with the given configuration.
NewServer creates a new Server.
New returns a new instance of a base.Command type that does not intercept the shutdown channel.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
WithAttributeFieldPrefix tells the command what prefix to attach to attribute fields when they are returned as errors.
WithAuthUserTargetAuthorizeSessionGrant indicates that we should add an authorize-session grant to the global authenticated user role.
WithContainerImage tells the command which container image to start a dev database with.
WithDatabaseTemplate allows for using an existing database template for initializing the boundary database.
No description provided by the author
WithEventer allows an optional eventer config.
WithEventer allows an optional event configuration flags which override whatever is in the EventerConfig.
WithEventGating starts the eventer in gated mode.
WithHostPlugin allows specifying a plugin ID and implementation to create at startup.
WithIamOptions provides options to pass through to the IAM package when creating initial resources.
WithImplicitId is used when creating the command if we are implicitly overriding the ID via a top-level read/update/delete command.
WithInterceptedToken provides a string pointer that will have the token assigned to it when performing an authenticate command.
WithNoTokenScope tells the client not to set a scope for the client from a saved token's scope, as this can cause confusing behavior at authentication time.
WithNoTokenValue tells the client not to set a token for the client from a saved token's value, as this can cause confusing behavior at authentication time.
WithSkipAuthMethodCreation tells the command not to instantiate any auth method on first run.
WithSkipDatabaseDestruction tells the command not to destroy the database even on error.
WithSkipDefaultRoleCreation tells the command not to instantiate the default global role.
WithSkipHostResourcesCreation tells the command not to instantiate a host catalog and related resources on first run.
WithSkipLdapAuthMethodCreation tells the command not to instantiate an LDAP auth method on first run, useful in some tests.
WithSkipOidcAuthMethodCreation tells the command not to instantiate an OIDC auth method on first run, useful in some tests.
WithSkipScopeIdFlag tells a command to not create a scope ID flag (usually because it's already been defined).
WithSkipScopesCreation tells the command not to instantiate scopes on first run.
WithSkipTargetCreation tells the command not to instantiate a target on first run.
WithStatusCode allows passing status codes to functions.
WrapAtLength wraps the given text to maxLineLength.
WrapAtLengthWithPadding wraps the given text at the maxLineLength, taking into account any provided left padding.
No description provided by the author
No description provided by the author
No description provided by the author

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
FlagNameAddr is the flag used in the base command to read in the address of the Boundary server.
FlagnameCACert is the flag used in the base command to read in the CA cert.
FlagnameCAPath is the flag used in the base command to read in the CA cert path.
FlagNameClientCert is the flag used in the base command to read in the client cert.
FlagNameClientCert is the flag used in the base command to read in the client key.
FlagNameTLSInsecure is the flag used in the base command to read in the option to ignore TLS certificate verification.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
FlagTLSServerName is the flag used in the base command to read in the TLS server name.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
File name to use for storing workerAuth requests.

# Variables

BuiltinListeners is the list of built-in listener types.
No description provided by the author
MinioEnabled controls if the Minio storage plugin should be initiated or not.
No description provided by the author

# Structs

-- BoolVar and boolValue.
No description provided by the author
CombinationSliceVar uses a wrapped value to allow storing values from different flags in one slice.
CombinedSliceValue holds the raw value (as a string) and the name of the flag that added it.
No description provided by the author
No description provided by the author
-- DurationVar and durationValue.
EventFlags represent the cmd flags supported overriding the configured or default event configuration.
FlagSet is a grouped wrapper around a real flag set and a grouped flag set.
FlagSets is a group of flag sets.
-- Float64Var and float64Value.
No description provided by the author
-- Int64Var and int64Value.
An output formatter for json output of an object.
Options - how Options are represented.
No description provided by the author
No description provided by the author
-- StringMapVar and stringMapValue.
StringSliceMapVar maps a key string to a slice of string values.
StringSliceVar reads in parameters from the same flag into a string array.
-- StringVar and stringValue.
TCPKeepAliveListener sets TCP keep-alive timeouts on accepted connections.
-- Uint16Var and uint16Value.
-- Uint64Var and uint64Value.
-- VarFlag.
No description provided by the author

# Interfaces

FlagBool is an interface which boolean flags implement.
FlagExample is an interface which declares an example value.
FlagVisibility is an interface which declares whether a flag should be hidden from help and completions.

# Type aliases

No description provided by the author
No description provided by the author
Factory is the factory function to create a listener.
Option - how Options are passed as arguments.