describe-cluster¶

Description¶

Describes a workload cluster.

Synopsis¶

  describe-cluster
--cluster-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--cluster-name (string)

The name or CRN of the cluster.

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

cluster -> (object)

Information about a cluster.

clusterName -> (string)

The name of the cluster.

crn -> (string)

The CRN of the cluster.

creationDate -> (datetime)

The date when the cluster was created.

status -> (string)

The status of the stack.

clusterStatus -> (string)

The status of the cluster.

nodeCount -> (integer)

The cluster node count.

instanceGroups -> (array)

The instance details.

item -> (object)

The type of the instance group which also contains the actual instance(s)

name -> (string)

The name of the instance group where the given instance is located.

instances -> (array)

List of instances in this instance group.

item -> (object)

Object which holds some details of an instance for the given cluster.

id -> (string)

The ID of the given instance.

state -> (string)

The health state of the instance. UNHEALTHY represents instances with unhealthy services, lost instances, or failed operations.

instanceType -> (string)

The type of the given instance (either GATEWAY, GATEWAY_PRIMARY, or CORE).

privateIp -> (string)

The private IP of the given instance.

publicIp -> (string)

The public IP of the given instance.

fqdn -> (string)

The FQDN of the instance.

status -> (string)

The status of the instance. This includes information like whether the instance is being provisioned, stopped, decommissioning failures etc.

statusReason -> (string)

The reason for the current status of this instance.

sshPort -> (integer)

The SSH port for the instance.

clouderaManagerServer -> (boolean)

Whether the instance has Cloudera Manager deployed or not.

instanceGroup -> (string)

The name of the instance group this instance belongs to.

attachedVolumes -> (array)

List of volumes attached to this instance.

( … recursive … )

availabilityZone -> (string)

The availability zone of the instance.

instanceVmType -> (string)

The VM type of the instance. Supported values depend on the cloud platform.

rackId -> (string)

The rack ID of the instance in Cloudera Manager.

subnetId -> (string)

The subnet ID of the instance.

subnetIds -> (array)

The list of subnet IDs in case of multi-availability zone setup

item -> (string)

availabilityZones -> (array)

List of availability zones that this instance group is associated with.

item -> (string)

workloadType -> (string)

The workload type for the cluster.

cloudPlatform -> (string)

The cloud platform.

imageDetails -> (object)

The details of the image used for cluster instances.

name -> (string)

The name of the image used for cluster instances.

id -> (string)

The ID of the image used for cluster instances. This is internally generated by the cloud provider to uniquely identify the image.

os -> (string)

The OS of the image used for cluster instances.

catalogUrl -> (string)

The image catalog URL.

catalogName -> (string)

The image catalog name.

environmentCrn -> (string)

The CRN of the environment.

environmentName -> (string)

The name of the environment.

credentialCrn -> (string)

The CRN of the credential.

datalakeCrn -> (string)

The CRN of the attached datalake.

clusterTemplateCrn -> (string)

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

statusReason -> (string)

The status reason.

clouderaManager -> (object)

Cloudera Manager details.

version -> (string)

Cloudera Manager version.

platformVersion -> (string)

CDP Platform version.

endpoints -> (object)

Object which holds the exposed endpoints for the given cluster.

endpoints -> (array)

The endpoints.

item -> (object)

Object which holds the exposed endpoint.

serviceName -> (string)

The name of the exposed service

serviceUrl -> (string)

The server url for the given exposed service’s API.

displayName -> (string)

The more consumable name of the exposed service.

knoxService -> (string)

The related knox entry.

mode -> (string)

The SSO mode of the given service.

open -> (boolean)

The access status of the given endpoint. Whether its open or not.

Form Factors¶

public