Viewing Cluster Lists

Page last updated:

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

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

   pks login -a PKS-API -u USERNAME -k
   

   Where:
   • PKS-API is the domain name for the PKS API that you entered in Ops Manager > Enterprise PKS > PKS API > API Hostname (FQDN). For example, api.pks.example.com.
   • USERNAME is your user name.
     
     See Logging in to Enterprise PKS for more information about the pks login command.

     Note: If your operator has configured Enterprise PKS 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 PKS CLI. For information about configuring SAML, see Connecting Enterprise PKS to a SAML Identity Provider

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

   pks clusters
   

   For example:

   $ pks 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