Page cover

list

The vcluster list command is used to retrieve a list of all virtual clusters within a project. This command displays essential details such as cluster name, creation date, services, and public status.

Usage

cldkctl vcluster list [flags]

Aliases

list, ls

Steps

  1. Run the following command in the terminal to display all virtual clusters in the project:

cldkctl vcluster list
  1. To limit the number of results per page, use the --limit flag followed by the desired number of entries.

  2. To view results on a specific page, use the --page flag.

  3. To filter clusters based on status, use the --status flag.

  4. Once the command is executed, the terminal displays a list under the Virtual Cluster List section, showing the cluster name, creation time, and public status.

Column
Description

Name

Displays the name of the virtual cluster.

Created At

Shows the timestamp when the virtual cluster was created (in UTC format).

Services

Indicates the list or count of running services associated with the cluster. If none, the value is shown as “-”.

Public Status

Shows the current public status of the cluster.

Flags

This command supports global flags. Refer to the Global Flags section for details

Flag
Description

-h, --help

Help for the vcluster list command.

-l, --limit string

Specify number of results per page (default 10).

-p, --page string

Specify page number (default 1).

--search string

Specify search keywords.

-s, --status string

Specify status.

Last updated