The table below lists all of the commands and options of the Tanzu CLI, and provides links to the section in which they are documented.

Command Options Description
tanzu
-h, --help
Common Tanzu Kubernetes Grid Options
tanzu completion
-h, --help
Output shell completion code for the specified shell
tanzu cluster *
--log-file
-v,, --verbose
tanzu cluster available-upgrades get Upgrade Tanzu Kubernetes Clusters
tanzu cluster create
-d, --dry-run Create Tanzu Kubernetes Cluster Manifest Files
-f, --file Deploy Tanzu Kubernetes Clusters
--tkr Deploy Tanzu Kubernetes Clusters with Different Kubernetes Versions
Add a vSphere7 Supervisor Cluster as a Management Cluster
tanzu cluster credentials update
-n, --namespace
--vsphere-password
--vsphere-user
Manage Cluster Secrets
tanzu cluster delete
-n, --namespace
-y, --yes
Delete Tanzu Kubernetes Clusters
tanzu cluster get
--disable-grouping
--disable-no-echo
-n, --namespace --show-all-conditions
Deploy Tanzu Kubernetes Clusters
tanzu cluster kubeconfig get Deploy Tanzu Kubernetes Clusters
Connect to and Examine Tanzu Kubernetes Clusters
--admin
--export-file
-n, --namespace
Connect to and Examine Tanzu Kubernetes Clusters
Upgrade Tanzu Kubernetes Clusters
tanzu cluster list
--include-management-cluster Connect to and Examine Tanzu Kubernetes Clusters
Upgrade Management Clusters
Upgrade Tanzu Kubernetes Clusters
-n, --namespace
-o, --output
Connect to and Examine Tanzu Kubernetes Clusters
tanzu cluster machinehealthcheck Configure Machine Health Checks for Tanzu Kubernetes Clusters
tanzu cluster node-pool set
-f, --file
--namespace
Manage Node Pools of Different VM Types
tanzu cluster node-pool list
-n, --namespace
-o, --output
Manage Node Pools of Different VM Types
tanzu cluster node-pool delete
-n, --name
--namespace
Manage Node Pools of Different VM Types
tanzu cluster scale
-c, --controlplane-machine-count
-n, --namespace
-w, --worker-machine-count
Manage Your Management Clusters
Scale Tanzu Kubernetes Clusters
tanzu cluster upgrade
-n, --namespace
--os-arch
--os-name
--os-version
-t, --timeout
--tkr
-y, --yes
Upgrade Tanzu Kubernetes Clusters
Deploy Tanzu Kubernetes Clusters with Different Kubernetes Versions
tanzu config init
-h, --help
Initializes the configuration with defaults
tanzu config server delete
-y, --yes Delete Management Clusters from Your Tanzu CLI Configuration
tanzu config server list Delete Management Clusters from Your Tanzu CLI Configuration
tanzu config show *
-h, --help
Shows the current configuration
tanzu init Not available in this version of the Tanzu CLI
tanzu kubernetes-release get
tanzu kubernetes-release available-upgrades get
Deploy Tanzu Kubernetes Clusters with Different Kubernetes Versions
Upgrade Tanzu Kubernetes Clusters
Add a vSphere7 Supervisor Cluster as a Management Cluster
tanzu kubernetes-release os get
--region
tanzu login
--apiToken
--context
--endpoint
--kubeconfig
--name
--server
Connect to and Examine Tanzu Kubernetes Clusters
Manage Your Management Clusters
Add a vSphere7 Supervisor Cluster as a Management Cluster
tanzu management-cluster ceip-participation get
tanzu management-cluster ceip-participation set
Opt In or Out of the VMware CEIP
tanzu management-cluster create
-b, --bind
--browser
-u, --ui
Deploy Management Clusters with the Installer Interface
-f, --file
-t, --timeout
-y, --yes
--dry-run
Deploy Management Clusters from a Configuration File
-e, --use-existing-bootstrap-cluster
Use an Existing Bootstrap Cluster to Deploy and Delete Management Clusters
tanzu management-cluster credentials update Manage Cluster Secrets
tanzu management-cluster delete Delete Management Clusters
tanzu management-cluster get Connect to and Examine Tanzu Kubernetes Clusters
Examine the Management Cluster Deployment
Manage Your Management Clusters
Upgrade Management Clusters

tanzu management-cluster import. This command is not used in TKG 1.4. Upgrade Tanzu Kubernetes Grid
tanzu management-cluster kubeconfig get
--admin
--export-file
Examine the Management Cluster Deployment
Configure Identity Management After Management Cluster Deployment
tanzu management-cluster register Register the Management Cluster with Tanzu Mission Control
tanzu management-cluster permissions aws get
tanzu management-cluster permissions aws set
Create a Cluster Configuration File for Amazon EC2
tanzu management-cluster upgrade
--os-arch
--os-name
--os-version
-t, --timeout
-y, --yes
Upgrade Management Clusters
tanzu package Installs and manages packages and package repositories
tanzu pinniped-auth
-h, --help
Pinniped authentication operations
tanzu pinniped-auth login
-h, --help, --ca-bundle strings, --client-id string, --concierge-authenticator-name string, --concierge-authenticator-type, --concierge-ca-bundle-data string, --concierge-authenticator-name string, --concierge-authenticator-type, --concierge-ca-bundle-data string, --concierge-endpoint string, --concierge-namespace string, --enable-concierge, --issuer string, --listen-port uint16, --request-audience string, --scopes strings, --session-cache string, --skip-browser
Log in using an OpenID Connect provider
tanzu plugin clean
tanzu plugin install
tanzu plugin list
Install the Tanzu CLI
tanzu plugin delete *
-h, --help
Deletes a Tanzu plugin
tanzu plugin describe *
-h, --help
Describes a Tanzu plugin
tanzu plugin upgrade *
-h, --help
Upgrades a Tanzu plugin
tanzu update *
-h, --help
Updates the Tanzu CLI
tanzu version Install the Tanzu CLI

* Some tanzu plugin commands such as tanzu plugin repo and tanzu plugin update are not functional in the current release.

Table of Equivalents

The tanzu command-line interface (CLI) works differently from the tkg CLI used in previous versions of Tanzu Kubernetes Grid. Because of these differences, many tkg commands do not have direct tanzu equivalents, and vice-versa. But other commands do have direct or close equivalencies across both CLIs:

TKG CLI command Tanzu CLI command Notes
tkg init tanzu management-cluster create Some tkg flags not replicated in tanzu
tkg init --ui tanzu management-cluster create --ui Some tkg flags not replicated in tanzu
tkg set management-cluster MANAGEMENT_CLUSTER_NAME tanzu login --server SERVER
tkg add management-cluster tanzu login --kubeconfig CONFIG --context OPTIONAL_CONTEXT --name SERVER-NAME
tkg get management-cluster tanzu login The tanzu login command displays the currently configured management clusters
tkg create cluster tanzu cluster create Some tkg flags not replicated in tanzu
tkg config cluster tanzu cluster create --dry-run Some tkg flags not replicated in tanzu
tkg delete cluster tanzu cluster delete
tkg get cluster tanzu cluster list
tkg scale cluster tanzu cluster scale
tkg upgrade cluster tanzu cluster upgrade
tkg get credentials tanzu management-cluster kubeconfig get --admin
tkg get credentials WORKLOAD_CLUSTER_NAME tanzu cluster kubeconfig get WORKLOAD_CLUSTER_NAME --admin
tkg delete machinehealthcheck tanzu cluster machinehealthcheck delete
tkg get machinehealthcheck tanzu cluster machinehealthcheck get
tkg set machinehealthcheck tanzu cluster machinehealthcheck set
tkg get ceip-participation tanzu management-cluster ceip-participation get
tkg set ceip-participation tanzu management-cluster ceip-participation set
tkg delete management-cluster tanzu management-cluster delete
tkg upgrade management-cluster tanzu management-cluster upgrade
tkg version tanzu version
tkg get kubernetesversions tanzu kubernetes-release get

check-circle-line exclamation-circle-line close-line
Scroll to top icon