list-clusters¶

Description¶

Lists workload clusters.

Synopsis¶

  list-clusters
[--environment-name <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--environment-name (string)

The name or CRN of the environment for which the clusters will be listed.

--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¶

clusters -> (array)

The clusters.

item -> (object)

Information about a cluster.

clusterName -> (string)

The name of the cluster.

crn -> (string)

The CRN of the cluster.

status -> (string)

The status of the cluster.

workloadType -> (string)

The type of cluster.

environmentCrn -> (string)

The CRN of the environment.

environmentName -> (string)

The name of the environment.

cloudPlatform -> (string)

The name of the cloud platform.

nodeCount -> (integer)

The cluster node count.

creationDate -> (datetime)

The date when the cluster was created.

datalakeCrn -> (string)

The CRN of the attached datalake.

clusterTemplateCrn -> (string)

The CRN of the cluster template used for the cluster creation.

certificateExpirationState -> (string)

Indicates the certificate status on the cluster.

Form Factors¶

public