args

Documentation

Index

• type Arguments
  • func ParseArgs(args []string) (Arguments, string, error)
  • func (arguments *Arguments) ConfigureGlobalSettings() error
  • func (arguments *Arguments) GetBackend() string
  • func (arguments *Arguments) ValidateExcludeExceptArgs() (funcErr error)
• type Projects
  • func (i *Projects) Set(value string) error
  • func (i *Projects) String() string
• type StringSliceArgs
  • func (i *StringSliceArgs) Set(value string) error
  • func (i *StringSliceArgs) String() string

Types

type Arguments

type Arguments struct {
	InsecureTls                     bool
	ExperimentalEnableStepTemplates bool
	Profiling                       bool
	ExcludeTerraformVariables       bool
	ExcludeSpaceCreation            bool
	ConfigFile                      string
	ConfigPath                      string
	Version                         bool
	IgnoreInvalidExcludeExcept      bool
	Url                             string
	ApiKey                          string
	Space                           string
	Destination                     string
	Console                         bool
	ProjectId                       Projects
	ProjectName                     Projects
	RunbookId                       string
	RunbookName                     string
	LookupProjectDependencies       bool
	LookupProjectLinkTenants        bool
	Stateless                       bool
	StatelessAdditionalParams       StringSliceArgs
	StepTemplateName                string
	StepTemplateKey                 string
	StepTemplateDescription         string
	IgnoreCacManagedValues          bool
	ExcludeCaCProjectSettings       bool
	BackendBlock                    string
	DetachProjectTemplates          bool
	DefaultSecretVariableValues     bool
	DummySecretVariableValues       bool
	ProviderVersion                 string
	ExcludeProvider                 bool
	IncludeOctopusOutputVars        bool
	LimitAttributeLength            int
	LimitResourceCount              int
	GenerateImportScripts           bool

	IgnoreProjectChanges         bool
	IgnoreProjectVariableChanges bool
	IgnoreProjectGroupChanges    bool
	IgnoreProjectNameChanges     bool
	LookUpDefaultWorkerPools     bool
	IncludeIds                   bool
	IncludeSpaceInPopulation     bool
	IncludeDefaultChannel        bool

	ExcludeAllProjectVariables       bool
	ExcludeProjectVariables          StringSliceArgs
	ExcludeProjectVariablesExcept    StringSliceArgs
	ExcludeProjectVariablesRegex     StringSliceArgs
	ExcludeVariableEnvironmentScopes StringSliceArgs

	ExcludeAllTenantVariables    bool
	ExcludeTenantVariables       StringSliceArgs
	ExcludeTenantVariablesExcept StringSliceArgs
	ExcludeTenantVariablesRegex  StringSliceArgs

	ExcludeAllSteps    bool
	ExcludeSteps       StringSliceArgs
	ExcludeStepsRegex  StringSliceArgs
	ExcludeStepsExcept StringSliceArgs

	ExcludeAllRunbooks    bool
	ExcludeRunbooks       StringSliceArgs
	ExcludeRunbooksRegex  StringSliceArgs
	ExcludeRunbooksExcept StringSliceArgs

	ExcludeLibraryVariableSets       StringSliceArgs
	ExcludeLibraryVariableSetsRegex  StringSliceArgs
	ExcludeLibraryVariableSetsExcept StringSliceArgs
	ExcludeAllLibraryVariableSets    bool

	ExcludeEnvironments       StringSliceArgs
	ExcludeEnvironmentsRegex  StringSliceArgs
	ExcludeEnvironmentsExcept StringSliceArgs
	ExcludeAllEnvironments    bool

	ExcludeFeeds       StringSliceArgs
	ExcludeFeedsRegex  StringSliceArgs
	ExcludeFeedsExcept StringSliceArgs
	ExcludeAllFeeds    bool

	ExcludeProjectGroups       StringSliceArgs
	ExcludeProjectGroupsRegex  StringSliceArgs
	ExcludeProjectGroupsExcept StringSliceArgs
	ExcludeAllProjectGroups    bool

	ExcludeAccounts       StringSliceArgs
	ExcludeAccountsRegex  StringSliceArgs
	ExcludeAccountsExcept StringSliceArgs
	ExcludeAllAccounts    bool

	ExcludeCertificates       StringSliceArgs
	ExcludeCertificatesRegex  StringSliceArgs
	ExcludeCertificatesExcept StringSliceArgs
	ExcludeAllCertificates    bool

	ExcludeLifecycles       StringSliceArgs
	ExcludeLifecyclesRegex  StringSliceArgs
	ExcludeLifecyclesExcept StringSliceArgs
	ExcludeAllLifecycles    bool

	ExcludeWorkerpools       StringSliceArgs
	ExcludeWorkerpoolsRegex  StringSliceArgs
	ExcludeWorkerpoolsExcept StringSliceArgs
	ExcludeAllWorkerpools    bool

	ExcludeMachinePolicies       StringSliceArgs
	ExcludeMachinePoliciesRegex  StringSliceArgs
	ExcludeMachinePoliciesExcept StringSliceArgs
	ExcludeAllMachinePolicies    bool

	ExcludeTenantTags StringSliceArgs

	ExcludeTenantTagSets       StringSliceArgs
	ExcludeTenantTagSetsRegex  StringSliceArgs
	ExcludeTenantTagSetsExcept StringSliceArgs
	ExcludeAllTenantTagSets    bool

	ExcludeTenants         StringSliceArgs
	ExcludeTenantsRegex    StringSliceArgs
	ExcludeTenantsWithTags StringSliceArgs
	ExcludeTenantsExcept   StringSliceArgs
	ExcludeAllTenants      bool

	ExcludeProjects       StringSliceArgs
	ExcludeProjectsExcept StringSliceArgs
	ExcludeProjectsRegex  StringSliceArgs
	ExcludeAllProjects    bool

	ExcludeAllTargets                bool
	ExcludeTargets                   StringSliceArgs
	ExcludeTargetsRegex              StringSliceArgs
	ExcludeTargetsExcept             StringSliceArgs
	ExcludeTargetsWithNoEnvironments bool

	ExcludeAllGitCredentials bool
}

func ParseArgs

func ParseArgs(args []string) (Arguments, string, error)

func (*Arguments) ConfigureGlobalSettings

func (arguments *Arguments) ConfigureGlobalSettings() error

func (*Arguments) GetBackend

func (arguments *Arguments) GetBackend() string

GetBackend forces the use of a local backend for stateless exports

func (*Arguments) ValidateExcludeExceptArgs

func (arguments *Arguments) ValidateExcludeExceptArgs() (funcErr error)

ValidateExcludeExceptArgs removes any resource named in a Exclude<ResourceType>Except argument that does not exist in the Octopus instance. This is mostly used when external systems attempt to filter the results but may place incorrect values into the Exclude<ResourceType>Except arguments.

type Projects

type Projects []string

func (*Projects) Set

func (i *Projects) Set(value string) error

func (*Projects) String

func (i *Projects) String() string

type StringSliceArgs

type StringSliceArgs []string

func (*StringSliceArgs) Set

func (i *StringSliceArgs) Set(value string) error

func (*StringSliceArgs) String

func (i *StringSliceArgs) String() string