list-clusters¶

Description¶

List all compute clusters in a CDP Environment

list-clusters is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument.

Synopsis¶

  list-clusters
[--env-name-or-crn <value>]
[--workloads <value>]
[--status <value>]
[--include-deleted | --no-include-deleted]
[--default | --no-default]
[--cluster-shape <value>]
[--max-items <value>]
[--starting-token <value>]
[--page-size <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--env-name-or-crn (string)

Environment name or crn.

--workloads (string)

Workloads for workload filtering.

Form Factors: public

--status (string)

Cluster Status for status filtering.

Form Factors: public

--include-deleted | --no-include-deleted (boolean)

Include deleted clusters in the response.

Form Factors: public

--default | --no-default (boolean)

Only show default clusters.

--cluster-shape (string)

Filter between Externalized and Embedded cluster shapes.

--max-items (integer)

The total number of items to return. If the total number of items available is more than the value specified in max-items then a nextToken will be provided in the output that you can use to resume pagination. This nextToken response element should not be used directly outside of the CDP CLI. This option cannnot be combined with the no-paginate CLI option. If no max-items value is specified, then a default value of 100 is used.

--starting-token (string)

A token to specify where to start paginating. This is the nextToken from a previously truncated response.

--page-size (integer)

The size of each page. Generally this does not need to be set and the default page size used is appropriate.

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

Array of CDP compute clusters.

item -> (object)

List clusters item structure.

envName -> (string)

CDP environment name.

envCloudProvider -> (string)

object representing CDP Environment cloud provider type AWS - CDP Environment installed in AWS AZURE - CDP Environment installed in Azure OPENSHIFT - CDP Environment installed as on-premise instalation using CDP DC services in base cluster

clusterName -> (string)

Compute cluster name.

clusterCrn -> (string)

Compute cluster CRN.

status -> (string)

Compute cluster status.

computePlatform -> (string)

object representing CDP Compute Cluster Platform provider OPENSHIFT - OpenShift Container Platform cluster as compute platform (private cloud only). EKS - EKS cluster as compute platform AKS - AKS cluster as compute platform RKE - Rancher RKE as compute platform (private cloud only).

computePlatformVersion -> (string)

Compute cluster platform version.

Form Factors: private

kubernetesVersion -> (string)

Kubernetes version.

clusterSize -> (integer)

Number of nodes in the cluster.

Form Factors: private

clusterId -> (string)

Compute cluster ID.

envCrn -> (string)

CDP environment CRN.

clusterType -> (string)

Object representing compute cluster types. DedicatedExternal - Value representing an external dedicated compute cluster. Shared - Value representing a shared compute cluster. Dedicated - Value representing an embedded dedicated compute cluster.

creationTime -> (string)

Compute cluster creation time in ISO format.

Form Factors: public

deletionTime -> (string)

Compute cluster deletion time in ISO format.

Form Factors: public

updateTime -> (string)

Compute cluster update time in ISO format.

Form Factors: public

clusterStateVersion -> (integer)

Cluster state version.

Form Factors: public

clusterOwner -> (object)

Compute cluster owner structure.

Form Factors: public

email -> (string)

Owner’s email.

firstName -> (string)

Owner’s firstname.

lastName -> (string)

Owner’s lastname.

userId -> (string)

Owner’s user ID.

accountId -> (string)

Owner’s account ID.

crn -> (string)

Owner’s actor CRN.

region -> (string)

Region.

Form Factors: public

message -> (string)

Message with additional details about the cluster status.

Form Factors: public

account -> (string)

/ CDP account ID.

Form Factors: public

availableUpgrades -> (array)

List of available kubernetes upgrades.

Form Factors: public

item -> (string)

imageCatalog -> (object)

Image catalog response structure.

Form Factors: public

crn -> (string)

The catalog CRN (either CRN or name is required).

name -> (string)

The catalog name (either CRN or name is required).

storage -> (object)

Storage spec response structure.

Form Factors: public

csiEnabled -> (boolean)

Flag to enable CSI (Container Storage Interface). It further sets specific inline cloud formation policies required for CSI.

labels -> (map)

Map of labels associated with this cluster.

key -> (string)

value -> (string)

isDefault -> (boolean)

The cluster which is automatically created for every containerized environment.

Form Factors: public

clusterShape -> (string)

The cluster-shape represents the shape of the cluster, which can be “Embedded” or “Externalized”.

Form Factors: public

nextToken -> (string)

The token to use when requesting the next set of results. If not present, there are no additional results.

Form Factors: public

totalClusters -> (integer)

Total number of clusters.

Form Factors: public

totalPages -> (integer)

Total number of pages.

Form Factors: public

Form Factors¶

public, private