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

Command Options Documented In
tkg *
--config Common Tanzu Kubernetes Grid Options
Deploy a Management Cluster to Amazon EC2 with the CLI
Deploy a Management Cluster to Amazon EC2 with the Installer Interface
Deploy a Management Cluster to Microsoft Azure with the CLI
Deploy a Management Cluster to Microsoft Azure with the Installer Interface
Deploy a Management Cluster to vSphere with the CLI
Deploy a Management Cluster to vSphere with the Installer Interface
--kubeconfig
--log_file
--quiet
--v
Common Tanzu Kubernetes Grid Options
tkg add management-cluster Use the Tanzu Kubernetes Grid CLI with a vSphere with Tanzu Supervisor Cluster
Manage Your Management Clusters
tkg config cluster
--controlplane-machine-count
--controlplane-size
--enable-cluster-options autoscaler
--enable-cluster-options oidc
--haproxy-size
--kubernetes-version
--namespace
--plan
--size
--worker-machine-count
--worker-size
Create Tanzu Kubernetes Cluster Configuration Files
tkg config permissions aws
--config
--kubeconfig
--log_file
--quiet
--v
Deploy Management Clusters to Amazon EC2 with the CLI
tkg create cluster
--cni Deploy a Cluster with a Non-Default CNI
--controlplane-machine-count Deploy a Cluster with a Highly Available Control Plane
--controlplane-size Deploy a Cluster with Nodes of Different Sizes
--dry-run Preview the YAML for a Tanzu Kubernetes Cluster
--enable-cluster-options autoscaler Deploy a Cluster with Cluster Autoscaler Enabled
Scale Worker Nodes with Cluster Autoscaler
--enable-cluster-options oidc Deploy an Authentication-Enabled Tanzu Kubernetes Cluster
Create Tanzu Kubernetes Clusters
--kubernetes-version Deploy a Cluster that Runs a Different Version of Kubernetes
--manifest Create Tanzu Kubernetes Cluster Configuration Files
Preview the YAML for a Tanzu Kubernetes Cluster
--namespace Deploy a Cluster in a Specific Namespace
--plan Tanzu Kubernetes Cluster Plans
Deploy a Default Tanzu Kubernetes Cluster
--size Deploy a Cluster with Nodes of Different Sizes
--vsphere-controlplane-endpoint Deploy Tanzu Kubernetes Clusters
--worker-machine-count Deploy a Cluster with Multiple Worker Nodes
--worker-size Deploy a Cluster with Nodes of Different Sizes
tkg delete cluster Delete Tanzu Kubernetes Clusters
tkg delete machinehealthcheck Configure Machine Health Checks for Tanzu Kubernetes Clusters
tkg delete management-cluster Delete Management Clusters
tkg get ceip-participation Opt in or Out of the VMware CEIP
tkg get cluster
--include-management-cluster Connect to and Examine Tanzu Kubernetes Clusters
Upgrade Management Clusters
Upgrade Tanzu Kubernetes Clusters
--namespace
--output
Connect to and Examine Tanzu Kubernetes Clusters
tkg get credentials
--export-file
--namespace
Connect to and Examine Tanzu Kubernetes Clusters
tkg get kubernetesversions Deploy a Cluster that Runs a Different Version of Kubernetes
Upgrade Tanzu Kubernetes Clusters
tkg get machinehealthcheck Configure Machine Health Checks for Tanzu Kubernetes Clusters
tkg get management-cluster Connect to and Examine Tanzu Kubernetes Clusters
Examine the Management Cluster Deployment
Manage Your Management Clusters
Upgrade Management Clusters

  --name
--output
Manage Your Management Clusters
tkg init
--infrastructure aws Deploy a Management Cluster to Amazon EC2 with the CLI
--infrastructure azure Deploy a Management Cluster to Microsoft Azure with the CLI
--deploy-tkg-on-vSphere7
--enable-tkgs-on-vSphere7
--infrastructure vsphere
--vsphere-controlplane-endpoint
Deploy a Management Cluster to vSphere with the CLI
--ceip-participation
--controlplane-size
--name
--plan
--size
--worker-size
Deploy a Management Cluster to vSphere with the CLI
Deploy a Management Cluster to Amazon EC2 with the CLI
Deploy a Management Cluster to Microsoft Azure with the CLI
--ui
--ui --bind
--ui --browser
Deploy a Management Cluster to vSphere with the Installer Interface
Deploy a Management Cluster to Microsoft Azure with the Installer Interface
Deploy a Management Cluster to Amazon EC2 with the Installer Interface
--use-existing-bootstrap-cluster Manage Your Management Clusters
tkg scale cluster
--controlplane-machine-count
--namespace
--worker-machine-count
Manage Your Management Clusters
Scale Tanzu Kubernetes Clusters
tkg set ceip-participation Opt in or Out of the VMware CEIP
tkg set machinehealthcheck Configure Machine Health Checks for Tanzu Kubernetes Clusters
tkg set management-cluster Connect to and Examine Tanzu Kubernetes Clusters
Manage Your Management Clusters
tkg upgrade cluster
--kubernetes-version
--namespace
--timeout
--vpshere-vm-template-name
--yes
Upgrade Tanzu Kubernetes Clusters
tkg upgrade management-cluster
--timeout
--vpshere-vm-template-name
--yes
Upgrade Management Clusters
tkg version Install the Tanzu Kubernetes Grid CLI

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