list-vcs¶

Description¶

Returns a list of virtual clusters for a given CDE service.

Synopsis¶

  list-vcs
--cluster-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--cluster-id (string)

Cluster id of the service.

--cli-input-json (string)

Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output¶

vcs -> (array)

List of virtual clusters.

item -> (object)

CDE virtual cluster summary.

vcId -> (string)

Virtual Cluster ID.

vcName -> (string)

Name of the CDE Virtual Cluster.

clusterId -> (string)

Cluster ID of the CDE service that contains the virtual cluster.

status -> (string)

Status of the Virtual Cluster.

VcUiUrl -> (string)

Url for the Virtual Cluster UI.

creatorEmail -> (string)

Email Address of the Creator.

creatorName -> (string)

Name of the Creator.

Form Factors¶

public, private