Skip to main content
logoTetrate Service ExpressVersion: Latest

tctl config

tctl config

Manages CLI configuration.

Options

  -h, --help   help for config

Options inherited from parent commands

  -c, --config string               Path to the config file to use. Can also be
specified via TCTL_CONFIG env variable. This flag
takes precedence over the env variable.
--debug Print debug messages for all requests and responses
--disable-tctl-version-warn If set, disable the outdated tctl version warning. Can also be
specified via TCTL_DISABLE_VERSION_WARN env variable.
-p, --profile string Use specific profile (default "default")

tctl config clusters

Manages configuration of clusters

Options

  -h, --help   help for clusters

Options inherited from parent commands

  -c, --config string               Path to the config file to use. Can also be
specified via TCTL_CONFIG env variable. This flag
takes precedence over the env variable.
--debug Print debug messages for all requests and responses
--disable-tctl-version-warn If set, disable the outdated tctl version warning. Can also be
specified via TCTL_DISABLE_VERSION_WARN env variable.
-p, --profile string Use specific profile (default "default")

tctl config clusters delete

Delete cluster configurations

tctl config clusters delete <name> [<name> ... <name>] [flags]

Options

  -h, --help   help for delete

Options inherited from parent commands

  -c, --config string               Path to the config file to use. Can also be
specified via TCTL_CONFIG env variable. This flag
takes precedence over the env variable.
--debug Print debug messages for all requests and responses
--disable-tctl-version-warn If set, disable the outdated tctl version warning. Can also be
specified via TCTL_DISABLE_VERSION_WARN env variable.
-p, --profile string Use specific profile (default "default")

tctl config clusters list

List all available clusters

tctl config clusters list [flags]

Options

  -h, --help   help for list

Options inherited from parent commands

  -c, --config string               Path to the config file to use. Can also be
specified via TCTL_CONFIG env variable. This flag
takes precedence over the env variable.
--debug Print debug messages for all requests and responses
--disable-tctl-version-warn If set, disable the outdated tctl version warning. Can also be
specified via TCTL_DISABLE_VERSION_WARN env variable.
-p, --profile string Use specific profile (default "default")

tctl config clusters rename

Rename a cluster configuration

tctl config clusters rename <current-name> <new-name> [flags]

Options

  -h, --help   help for rename

Options inherited from parent commands

  -c, --config string               Path to the config file to use. Can also be
specified via TCTL_CONFIG env variable. This flag
takes precedence over the env variable.
--debug Print debug messages for all requests and responses
--disable-tctl-version-warn If set, disable the outdated tctl version warning. Can also be
specified via TCTL_DISABLE_VERSION_WARN env variable.
-p, --profile string Use specific profile (default "default")

tctl config clusters set

Set a cluster configuration

tctl config clusters set <name> [flags]

Options

      --bridge-address string       Bridge address (for example, tsb.tetrate.io:8443, 192.0.2.1:8443, [2001:db8::1]:8443)
--timeout duration Bridge client timeout (default 30s)
--tls-disabled Don't use TLS when connecting to TSB
--tls-insecure Don't validate TLS server certificates when connecting to TSB
--tls-custom-ca-file string Path to a custom CA bundle to use when validating TLS connections to TSB
--managementplane string Management plane namespace
--controlplane string Control plane namespace
--context string The name of the kubeconfig context
--kubeconfig string Kubernetes configuration directory
--auto Automatically get management plane address from current kube context
--max-grpc-msg-size int Max gRPC message size (default 20971520)
-h, --help help for set

Options inherited from parent commands

  -c, --config string               Path to the config file to use. Can also be
specified via TCTL_CONFIG env variable. This flag
takes precedence over the env variable.
--debug Print debug messages for all requests and responses
--disable-tctl-version-warn If set, disable the outdated tctl version warning. Can also be
specified via TCTL_DISABLE_VERSION_WARN env variable.
-p, --profile string Use specific profile (default "default")

tctl config profiles

Manages configuration profiles

Options

  -h, --help   help for profiles

Options inherited from parent commands

  -c, --config string               Path to the config file to use. Can also be
specified via TCTL_CONFIG env variable. This flag
takes precedence over the env variable.
--debug Print debug messages for all requests and responses
--disable-tctl-version-warn If set, disable the outdated tctl version warning. Can also be
specified via TCTL_DISABLE_VERSION_WARN env variable.
-p, --profile string Use specific profile (default "default")

tctl config profiles delete

Delete configuration profiles

tctl config profiles delete <name> [<name> ... <name>] [flags]

Options

  -h, --help        help for delete
-r, --recursive Delete the linked clusters and users as well

Options inherited from parent commands

  -c, --config string               Path to the config file to use. Can also be
specified via TCTL_CONFIG env variable. This flag
takes precedence over the env variable.
--debug Print debug messages for all requests and responses
--disable-tctl-version-warn If set, disable the outdated tctl version warning. Can also be
specified via TCTL_DISABLE_VERSION_WARN env variable.
-p, --profile string Use specific profile (default "default")

tctl config profiles export

Export the given profiles to a new config file

tctl config profiles export <profiles...> [flags]

Options

      --file string           output file (default "tctl-config-export.yaml")
--include-credentials include credentials in the output file
-h, --help help for export

Options inherited from parent commands

  -c, --config string               Path to the config file to use. Can also be
specified via TCTL_CONFIG env variable. This flag
takes precedence over the env variable.
--debug Print debug messages for all requests and responses
--disable-tctl-version-warn If set, disable the outdated tctl version warning. Can also be
specified via TCTL_DISABLE_VERSION_WARN env variable.
-p, --profile string Use specific profile (default "default")

tctl config profiles get-current

Get the active profile

tctl config profiles get-current [flags]

Options

  -h, --help   help for get-current

Options inherited from parent commands

  -c, --config string               Path to the config file to use. Can also be
specified via TCTL_CONFIG env variable. This flag
takes precedence over the env variable.
--debug Print debug messages for all requests and responses
--disable-tctl-version-warn If set, disable the outdated tctl version warning. Can also be
specified via TCTL_DISABLE_VERSION_WARN env variable.
-p, --profile string Use specific profile (default "default")

tctl config profiles import

Import a configuration profile from a file

tctl config profiles import <file> [flags]

Options

  -h, --help        help for import
--overwrite If specified, will overwrite exisiting configurations conflicting with those being imported

Options inherited from parent commands

  -c, --config string               Path to the config file to use. Can also be
specified via TCTL_CONFIG env variable. This flag
takes precedence over the env variable.
--debug Print debug messages for all requests and responses
--disable-tctl-version-warn If set, disable the outdated tctl version warning. Can also be
specified via TCTL_DISABLE_VERSION_WARN env variable.
-p, --profile string Use specific profile (default "default")

tctl config profiles list

List all configuration profiles

tctl config profiles list [flags]

Options

  -h, --help   help for list

Options inherited from parent commands

  -c, --config string               Path to the config file to use. Can also be
specified via TCTL_CONFIG env variable. This flag
takes precedence over the env variable.
--debug Print debug messages for all requests and responses
--disable-tctl-version-warn If set, disable the outdated tctl version warning. Can also be
specified via TCTL_DISABLE_VERSION_WARN env variable.
-p, --profile string Use specific profile (default "default")

tctl config profiles rename

Rename a configuration profile

tctl config profiles rename <current-name> <new-name> [flags]

Options

  -h, --help   help for rename

Options inherited from parent commands

  -c, --config string               Path to the config file to use. Can also be
specified via TCTL_CONFIG env variable. This flag
takes precedence over the env variable.
--debug Print debug messages for all requests and responses
--disable-tctl-version-warn If set, disable the outdated tctl version warning. Can also be
specified via TCTL_DISABLE_VERSION_WARN env variable.
-p, --profile string Use specific profile (default "default")

tctl config profiles set-current

Update the current profile to use

tctl config profiles set-current <name> [flags]

Options

  -h, --help   help for set-current

Options inherited from parent commands

  -c, --config string               Path to the config file to use. Can also be
specified via TCTL_CONFIG env variable. This flag
takes precedence over the env variable.
--debug Print debug messages for all requests and responses
--disable-tctl-version-warn If set, disable the outdated tctl version warning. Can also be
specified via TCTL_DISABLE_VERSION_WARN env variable.
-p, --profile string Use specific profile (default "default")

tctl config profiles set

Set a configuration profile

tctl config profiles set <name> [flags]

Options

      --username string   Username
--cluster string Cluster
-h, --help help for set

Options inherited from parent commands

  -c, --config string               Path to the config file to use. Can also be
specified via TCTL_CONFIG env variable. This flag
takes precedence over the env variable.
--debug Print debug messages for all requests and responses
--disable-tctl-version-warn If set, disable the outdated tctl version warning. Can also be
specified via TCTL_DISABLE_VERSION_WARN env variable.
-p, --profile string Use specific profile (default "default")

tctl config users

Manages configuration of user credentials

Options

  -h, --help   help for users

Options inherited from parent commands

  -c, --config string               Path to the config file to use. Can also be
specified via TCTL_CONFIG env variable. This flag
takes precedence over the env variable.
--debug Print debug messages for all requests and responses
--disable-tctl-version-warn If set, disable the outdated tctl version warning. Can also be
specified via TCTL_DISABLE_VERSION_WARN env variable.
-p, --profile string Use specific profile (default "default")

tctl config users delete

Delete user configurations

tctl config users delete <name> [<name> ... <name>] [flags]

Options

  -h, --help   help for delete

Options inherited from parent commands

  -c, --config string               Path to the config file to use. Can also be
specified via TCTL_CONFIG env variable. This flag
takes precedence over the env variable.
--debug Print debug messages for all requests and responses
--disable-tctl-version-warn If set, disable the outdated tctl version warning. Can also be
specified via TCTL_DISABLE_VERSION_WARN env variable.
-p, --profile string Use specific profile (default "default")

tctl config users list

List all available user credentials

tctl config users list [flags]

Options

  -h, --help   help for list

Options inherited from parent commands

  -c, --config string               Path to the config file to use. Can also be
specified via TCTL_CONFIG env variable. This flag
takes precedence over the env variable.
--debug Print debug messages for all requests and responses
--disable-tctl-version-warn If set, disable the outdated tctl version warning. Can also be
specified via TCTL_DISABLE_VERSION_WARN env variable.
-p, --profile string Use specific profile (default "default")

tctl config users rename

Rename a user configuration

tctl config users rename <current-name> <new-name> [flags]

Options

  -h, --help   help for rename

Options inherited from parent commands

  -c, --config string               Path to the config file to use. Can also be
specified via TCTL_CONFIG env variable. This flag
takes precedence over the env variable.
--debug Print debug messages for all requests and responses
--disable-tctl-version-warn If set, disable the outdated tctl version warning. Can also be
specified via TCTL_DISABLE_VERSION_WARN env variable.
-p, --profile string Use specific profile (default "default")

tctl config users set

Set a user configuration

tctl config users set <name> [flags]

Options

      --org string             Organization
--tenant string Tenant
--username string Basic auth username
--password string Basic auth password
--token string Access token
--refresh-token string Refresh token
-h, --help help for set

Options inherited from parent commands

  -c, --config string               Path to the config file to use. Can also be
specified via TCTL_CONFIG env variable. This flag
takes precedence over the env variable.
--debug Print debug messages for all requests and responses
--disable-tctl-version-warn If set, disable the outdated tctl version warning. Can also be
specified via TCTL_DISABLE_VERSION_WARN env variable.
-p, --profile string Use specific profile (default "default")

tctl config view

Show all configuration data in yaml format

tctl config view [flags]

Options

  -h, --help   help for view

Options inherited from parent commands

  -c, --config string               Path to the config file to use. Can also be
specified via TCTL_CONFIG env variable. This flag
takes precedence over the env variable.
--debug Print debug messages for all requests and responses
--disable-tctl-version-warn If set, disable the outdated tctl version warning. Can also be
specified via TCTL_DISABLE_VERSION_WARN env variable.
-p, --profile string Use specific profile (default "default")