constants

package
v6.10.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 8, 2026 License: Apache-2.0 Imports: 0 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	FlagLimit            = "limit"
	FlagLimitShort       = "l"
	FlagOffset           = "offset"
	FlagOrderBy          = "order-by"
	FlagDepth            = "depth"
	FlagDepthShort       = "D"
	FlagFilterEquivalent = "filter"
	FlagFilters          = "filters"
	FlagFiltersShort     = "F"
)

query params

View Source 
const (
	FlagProviderID              = "provider-id"
	FlagAutocertificateID       = "autocertificate-id"
	FlagSubjectAlternativeNames = "subject-alternative-names"
	FlagKeyAlgorithm            = "key-algorithm"
	FlagKeySecret               = "key-secret"
	FlagKeyId                   = "key-id"
	FlagServer                  = "server"
	FlagEmail                   = "email"
	FlagCommonName              = "common-name"

	FlagDatacenterId             = "datacenter-id"
	FlagSnapshotId               = "snapshot-id"
	FlagIdShort                  = "i"
	FlagName                     = "name"
	FlagNameShort                = "n"
	FlagPaths                    = "paths"
	FlagMethods                  = "methods"
	FlagWebSocket                = "websocket"
	FlagLoadBalancer             = "loadbalancer"
	FlagScheme                   = "scheme"
	FlagTemplate                 = "template"
	FlagTemplateId               = "template-id"
	FlagInstances                = "instances"
	FlagInstancesShortPsql       = "I"
	FlagReplicas                 = "replicas"
	FlagReplicasetID             = "replica-set-id"
	FlagShards                   = "shards"
	FlagPersistenceMode          = "persistence-mode"
	FlagEvictionPolicy           = "eviction-policy"
	FlagBackupLocation           = "backup-location"
	FlagBackupLocationShortPsql  = "B"
	FlagMaintenanceTime          = "maintenance-time"
	FlagMaintenanceTimeShortPsql = "T"
	FlagMaintenanceDay           = "maintenance-day"
	FlagMaintenanceDayShortPsql  = "d"
	FlagLocation                 = "location"
	FlagLocationShort            = "l"
	FlagQuery                    = "query"
	DeprecatedFlagMaxResults     = "max-results"
	FlagLogs                     = "logs"
	FlagMetrics                  = "metrics"

	FlagStartTime             = "start-time"
	FlagStartTimeShort        = "s"
	FlagEndTime               = "end-time"
	FlagEndTimeShort          = "e"
	FlagSince                 = "since"
	FlagSinceShort            = "S"
	FlagUntil                 = "until"
	FlagUntilShort            = "U"
	FlagDirection             = "direction"
	FlagSyncMode              = "sync"
	FlagSyncModeShort         = "S"
	FlagSyncModeV2            = "sync-mode"
	FlagRecoveryTime          = "recovery-time"
	FlagRecoveryTimeShortPsql = "R"

	FlagDbUsername          = "db-username"
	FlagDbUsernameShortPsql = "U"
	FlagDbPassword          = "db-password"
	FlagDbPasswordShortPsql = "P"

	FlagNameCustomDomainsName = "custom-domains-name"
	FlagCustomCertificateId   = "custom-domains-certificate-id"
	// DescAuthenticationOrder explains auth order. Embed this in any auth-related commands
	DescAuthenticationOrder = `` /* 572-byte string literal not displayed */

	FlagCidr             = "cidr"
	FlagCidrShortPsql    = "C"
	FlagIp               = "ip"
	FlagIps              = "ips"
	FlagLanId            = "lan-id"
	FlagLanIdShortPsql   = "L"
	FlagEdition          = "edition"
	FlagVersionId        = "version-id"
	FlagBackupLocationId = "backup-location-id"

	FlagPipelineID       = "pipeline-id"
	FlagGatewayID        = "gateway-id"
	FlagGatewayRouteID   = "route-id"
	FlagCustomDomainsId  = "custom-domains-id"
	FlagUpstreamId       = "upstream-id"
	FlagTunnelID         = "tunnel-id"
	FlagPeerID           = "peer-id"
	FlagGatewayIP        = "gateway-ip"
	FlagGatewayShort     = "g"
	FlagInterfaceIP      = "interface-ip"
	FlagConnectionIP     = "connection-ip"
	FlagRemoveConnection = "remove-connection"
	FlagPrivateKey       = "private-key"
	FlagPrivateKeyPath   = "private-key-path"

	FlagCertId        = "certificate-id"
	FlagCertName      = "certificate-name"
	FlagCert          = "certificate"
	FlagCertPath      = "certificate-path"
	FlagCertChain     = "certificate-chain"
	FlagCertChainPath = "certificate-chain-path"

	FlagPublicKey  = "public-key"
	FlagHost       = "host"
	FlagPort       = "port"
	FlagWeight     = "weight"
	FlagAuthMethod = "auth-method"
	FlagPSKKey     = "psk-key"

	FlagContract         = "contract"
	FlagCurrent          = "current"
	FlagCurrentShortAuth = "C"
	FlagExpired          = "expired"
	FlagExpiredShortAuth = "E"
	FlagPrivileges       = "privileges"
	FlagPrivilegesShort  = "p" // although used once, don't deprecate it, as there are multiple local "p" shorthands in use

	FlagIKEDiffieHellmanGroup  = "ike-diffie-hellman-group"
	FlagIKEEncryptionAlgorithm = "ike-encryption-algorithm"
	FlagIKEIntegrityAlgorithm  = "ike-integrity-algorithm"
	FlagIKELifetime            = "ike-lifetime"

	FlagESPDiffieHellmanGroup  = "esp-diffie-hellman-group"
	FlagESPIntegrityAlgorithm  = "esp-integrity-algorithm"
	FlagESPEncryptionAlgorithm = "esp-encryption-algorithm"
	FlagESPLifetime            = "esp-lifetime"

	FlagCloudNetworkCIDRs = "cloud-network-cidrs"
	FlagPeerNetworkCIDRs  = "peer-network-cidrs"

	FlagPromoteVolume         = "promote-volume"
	FlagCores                 = "cores"
	FlagRam                   = "ram"
	FlagAvailabilityZone      = "availability-zone"
	FlagAvailabilityZoneShort = "z"
	FlagCpuFamily             = "cpu-family"
	FlagStorageType           = "storage-type"
	FlagStorageSize           = "storage-size"
	FlagServerType            = "server-type"

	FlagClusterId         = "cluster-id"
	FlagUserId            = "user-id"
	FlagNodepoolId        = "nodepool-id"
	FlagBackupId          = "backup-id"
	FlagBackupIdShortPsql = "b"
	FlagNodeCount         = "node-count"
	FlagNodeSubnet        = "node-subnet"
	FlagLabels            = "labels"
	FlagLabelsShort       = "L"
	FlagAnnotations       = "annotations"
	FlagAnnotationsShort  = "A"
	FlagVersion           = "version"
	FlagVersionShortPsql  = "V"
	FlagSize              = "size"

	FlagZone          = "zone"
	FlagZoneShort     = "z"
	FlagRecord        = "record"
	FlagRecordShort   = "r"
	FlagState         = "state"
	FlagDescription   = "description"
	FlagEnabled       = "enabled"
	FlagContent       = "content"
	FlagTtl           = "ttl"
	FlagPriority      = "priority"
	FlagType          = "type"
	FlagPrimaryIPs    = "primary-ips"
	FlagZoneFile      = "zone-file"
	FlagSecondaryZone = "secondary-zone"

	FlagCloudInit                       = "cloud-init"
	FlagLoggingPipelineId               = "pipeline-id"
	FlagLoggingPipelineLogTag           = "log-tag"
	FlagLoggingPipelineLogSource        = "log-source"
	FlagLoggingPipelineLogProtocol      = "log-protocol"
	FlagLoggingPipelineLogLabels        = "log-labels"
	FlagLoggingPipelineLogType          = "log-type"
	FlagLoggingPipelineLogRetentionTime = "log-retention-time"

	FlagCDNDistributionFilterDomain        = "domain"
	FlagCDNDistributionFilterState         = "state"
	FlagCDNDistributionID                  = "distribution-id"
	FlagCDNDistributionDomain              = "domain"
	FlagCDNDistributionCertificateID       = "certificate-id"
	FlagCDNDistributionRoutingRules        = "routing-rules"
	FlagCDNDistributionRoutingRulesExample = "routing-rules-example"

	FlagFilterName    = "name"
	FlagFilterState   = "state"
	FlagCertificateId = "certificate-id"

	FlagKafkaBrokerAddresses   = "broker-addresses"
	FlagKafkaPartitions        = "partitions"
	FlagKafkaReplicationFactor = "replication-factor"
	FlagKafkaRetentionTime     = "retention-time"
	FlagKafkaSegmentBytes      = "segment-bytes"
	FlagKafkaTopicId           = "topic-id"

	FlagGroupId  = "group-id"
	FlagServerId = "server-id"
	FlagActionId = "action-id"

	FlagRegistryId       = "registry-id"
	FlagRegistryIdShort  = "r"
	FlagArtifactId       = "artifact-id"
	FlagVulnerabilityId  = "vulnerability-id"
	FlagRegistryVulnScan = "vulnerability-scanning"

	FlagDatabase         = "database"
	FlagOwner            = "owner"
	FlagConnectionPooler = "connection-pooler"
	FlagLogsEnabled      = "logs-enabled"
	FlagMetricsEnabled   = "metrics-enabled"

	FlagNICMultiQueue            = "nic-multi-queue"
	FlagNICMultiQueueDescription = "Enable NIC Multi Queue to improve NIC throughput; changing this setting restarts the server. Not supported for CUBEs"
)

flags

View Source 
const (
	DescMaxResults         = "The maximum number of elements to return"
	DescZone               = "The name or ID of the DNS zone"
	DescCluster            = "The unique ID of the Cluster"
	DescGateway            = "The ID of the gateway"
	DescMonitoringPipeline = "The ID of the monitoring pipeline"
	DescRoute              = "The ID of the route"
	DescUpstream           = "The ID of the upstream"
	DescToken              = "The contents of a Token"
	DescTokenId            = "The unique Key ID of a Token"
)

Flag descriptions. Prefixed with "Desc" for easy find and replace

View Source 
const (
	ArgOutput       = "output"
	ArgOutputShort  = "o"
	ArgQuiet        = "quiet"
	ArgQuietShort   = "q"
	ArgVerbose      = "verbose"
	ArgVerboseShort = "v"

	ArgAllAddedAsHidden   = "this-flag-is-hidden-for-shorthand-A-backwards-compatibility"
	ArgAll                = "all"
	ArgAllShort           = "a"
	ArgAllShortDeprecated = "A"
	ArgForce              = "force"
	ArgForceShort         = "f"
	ArgWait               = "wait"
	ArgWaitForRequest     = "wait-for-request"
	ArgWaitForState       = "wait-for-state"
	ArgWaitForDelete      = "wait-for-deletion"
	ArgTimeout            = "timeout"
	ArgTimeoutShort       = "t"
	ArgCols               = "cols"
	ArgUpdates            = "updates"
	ArgUser               = "user"
	ArgPassword           = "password"
	ArgHashPassword       = "hash-password"
	ArgPasswordShort      = "p"
	ArgNoHeaders          = "no-headers"
)

legacy flags. TODO: Arg should be renamed to Flag.

View Source 
const (
	DefaultConfigFileName = "config.yaml"
	DefaultOutputFormat   = "text"
	DefaultWait           = false
	DefaultTimeoutSeconds = int(600)
	DefaultParentIndex    = int(1)
	DefaultClusterTimeout = int(1200)
)

Defaults

View Source 
const (
	DefaultApiURL               = "https://api.ionos.com"
	DNSApiRegionalURL           = "https://dns.%s.ionos.com"
	LoggingApiRegionalURL       = "https://logging.%s.ionos.com"
	CDNApiRegionalURL           = "https://cdn.%s.ionos.com"
	CertApiRegionalURL          = "https://certificate-manager.%s.ionos.com"
	MariaDBApiRegionalURL       = "https://mariadb.%s.ionos.com"
	InMemoryDBApiRegionalURL    = "https://in-memory-db.%s.ionos.com"
	VPNApiRegionalURL           = "https://vpn.%s.ionos.com"
	KafkaApiRegionalURL         = "https://kafka.%s.ionos.com"
	MonitoringApiRegionalURL    = "https://monitoring.%s.ionos.com"
	PostgresApiRegionalURL      = "https://postgresql.%s.ionos.com"
	ObjectStorageApiRegionalURL = "https://s3.%s.ionoscloud.com"
)
View Source 
const (
	MessageRequestInfo = "Request ID: %v Execution Time: %v"
	MessageRequestTime = "Request Execution Time: %v"
	MessageDeletingAll = "Status: Deleting %v with ID: %v..."
)

Some legacy messages, which might need looking into

View Source 
const (
	ErrDeleteAll     = "error occurred removing %v with ID: %v. error: %w"
	ErrWaitDeleteAll = "error occurred waiting on removing %v with ID: %v. error: %w" // TODO: cleanup constant. reduce duplication
)
View Source 
const (
	FlagJsonProperties        = "json-properties"
	FlagJsonPropertiesExample = "json-properties-example"

	ArgConfig         = "config"
	ArgConfigShort    = "c"
	ArgServerUrl      = "api-url"
	ArgServerUrlShort = "u"
	ArgToken          = "token"
	FlagTokenId       = "token-id"
	ArgTokenShort     = ""

	EnvUsername  = "IONOS_USERNAME"
	EnvPassword  = "IONOS_PASSWORD"
	EnvToken     = "IONOS_TOKEN"
	EnvServerUrl = "IONOS_API_URL"

	CfgToken     = "userdata.token"
	CfgServerUrl = "userdata.api-url"
	CfgUsername  = "userdata.name"
	CfgPassword  = "userdata.password"

	CLIHttpUserAgent = "cli-user-agent"

	FlagProvenance      = "provenance"
	FlagProvenanceShort = "p"
	FlagSkipVerify      = "skip-verify"
)

Config

View Source 
const (
	FlagTargetDir       = "target-dir"
	FlagSkipCompression = "skip-compression"
)

Manpages

View Source 
const (
	DatacenterId              = "Datacenter ID: %v"
	ApplicationLoadBalancerId = "Application Load Balancer ID: %v"
	TargetGroupId             = "Target Group ID: %v"
	ClusterId                 = "Cluster ID: %v"
	ForwardingRuleId          = "Forwarding Rule ID: %v"
)

Resource info

View Source 
const (
	FlagS3Region = "region"
)

object storage flags

Variables

View Source 
var (
	MonitoringLocations    = []string{"de/fra", "de/txl", "es/vit", "gb/bhx", "gb/lhr", "fr/par", "us/mci"}
	DNSLocations           = []string{"de/fra"}
	LoggingLocations       = []string{"de/txl", "de/fra", "gb/lhr", "fr/par", "es/vit", "us/mci", "gb/bhx"}
	CDNLocations           = []string{"de/fra"}
	CertLocations          = []string{"de/fra"}
	MariaDBLocations       = []string{"de/txl", "de/fra", "es/vit", "fr/par", "gb/lhr", "us/ewr", "us/las", "us/mci"}
	InMemoryDBLocations    = []string{"de/fra", "de/txl", "es/vit", "gb/txl", "gb/lhr", "gb/bhx", "us/ewr", "us/las", "us/mci", "fr/par"}
	VPNLocations           = []string{"de/fra", "de/txl", "es/vit", "fr/par", "gb/lhr", "gb/bhx", "us/ewr", "us/las", "us/mci"}
	KafkaLocations         = []string{"de/fra", "de/txl", "es/vit", "gb/lhr", "gb/bhx", "us/ewr", "us/las", "us/mci", "fr/par"}
	PostgresLocations      = []string{"de/txl", "de/fra", "es/vit", "fr/par", "gb/lhr", "gb/bhx", "us/las", "us/mci", "us/ewr"}
	ObjectStorageLocations = []string{"eu-central-3", "eu-central-4", "us-central-1"}
)
View Source 
var (
	EnumLicenceType      = []string{"LINUX", "RHEL", "WINDOWS", "WINDOWS2016", "WINDOWS2019", "WINDOWS2022", "WINDOWS2025", "UNKNOWN", "OTHER"}
	EnumApplicationType  = []string{"MSSQL-2019-Web", "MSSQL-2019-Standard", "MSSQL-2019-Enterprise", "MSSQL-2022-Web", "MSSQL-2022-Standard", "MSSQL-2022-Enterprise", "UNKNOWN"}
	EnumLogProtocols     = []string{"http", "tcp"}
	EnumLogSources       = []string{"docker", "systemd", "generic", "kubernetes"}
	EnumLogRetentionTime = []string{"7", "14", "30"}
)

enum values

Functions

This section is empty.

Types

This section is empty.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.