Viewing Cluster Lists

Note: As of v1.8, Enterprise PKS has been renamed to VMware Tanzu Kubernetes Grid Integrated Edition. Some screenshots in this documentation do not yet reflect the change.

Page last updated:

Follow the steps below to view the list of deployed Kubernetes cluster with the TKGI CLI.

  1. On the command line, run the following command to log in:

    tkgi login -a TKGI-API -u USERNAME -k
    
    Where:

    • TKGI-API is the domain name for the TKGI API that you entered in Ops Manager > Tanzu Kubernetes Grid Integrated Edition > TKGI API > API Hostname (FQDN). For example, api.tkgi.example.com.
    • USERNAME is your user name.

      See Logging in to Tanzu Kubernetes Grid Integrated Edition for more information about the tkgi login command.

      Note: If your operator has configured Tanzu Kubernetes Grid Integrated Edition to use a SAML identity provider, you must include an additional SSO flag to use the above command. For information about the SSO flags, see the section for the above command in TKGI CLI. For information about configuring SAML, see Connecting Tanzu Kubernetes Grid Integrated Edition to a SAML Identity Provider

  2. Run the following command to view the list of deployed clusters, including cluster names and status:

    tkgi clusters
    

    For example:

    $ tkgi clusters
    
    Name                Plan Name             UUID                                  Status     Action
    cluster-one         small                 881543kd-64fg-7826-hea6-3h7g1o04kh0e  succeeded  CREATE
    cluster-two         small                 951547dl-67kg-9631-bju8-7h9s3o98br0q  succeeded  CREATE
    

Please send any feedback you have to pks-feedback@pivotal.io.