list-clusters¶

Description¶

Lists all registered on-premise clusters.

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
[--manager-type <value>]
[--services <value>]
[--operator <value>]
[--cluster-type <value>]
[--cluster-state <value>]
[--max-items <value>]
[--starting-token <value>]
[--page-size <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--manager-type (string)

Manager type of the cluster. AMBARI - Ambari as manager type. CLOUDERA_MANAGER - Cloudera Manager as manager type.

Possible values:

• AMBARI

• CLOUDERA_MANAGER

Form Factors: public, private

--services (array)

Services in the cluster.

Syntax:

"string" "string" ...

--operator (string)

The type of operator. AND - AND operator. OR - OR operator.

Possible values:

• AND

• OR

Form Factors: public, private

--cluster-type (string)

The type of on-premise cluster. CDH - Legacy CDH Cluster. CDPDC - CDPDC Cluster.

Possible values:

• CDH

• CDPDC

Form Factors: public, private

--cluster-state (string)

State of the on-premise cluster. TO_SYNC - Cluster yet to be synced. SYNC_IN_PROGRESS - Cluster sync in-progress. SYNCED - Cluster sync successful. SYNC_ERROR - Cluster sync error.

Possible values:

• TO_SYNC

• SYNC_IN_PROGRESS

• SYNCED

• SYNC_ERROR

Form Factors: public, private

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

nextPageToken -> (string)

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

clusters -> (array)

List of clusters.

item -> (object)

Object containing the cluster information.

Form Factors: public, private

clusterCrn -> (string)

The clusterCrn of the registered cluster.

name -> (string)

The name of the registered cluster.

datacenterName -> (string)

The data center name of the registered cluster.

id -> (integer)

The clusterId of the registered cluster.

ipAddress -> (string)

The IP address of the registered cluster.

clusterType -> (string)

The type of on-premise cluster. CDH - Legacy CDH Cluster. CDPDC - CDPDC Cluster.

Form Factors: public, private

state -> (string)

State of the on-premise cluster. TO_SYNC - Cluster yet to be synced. SYNC_IN_PROGRESS - Cluster sync in-progress. SYNCED - Cluster sync successful. SYNC_ERROR - Cluster sync error.

Form Factors: public, private

description -> (string)

The description of the registered cluster.

lastCreateTime -> (datetime)

The time at which the cluster was registered.

lastUpdatedTime -> (datetime)

The time at which the cluster was updated.

updatedUtc -> (datetime)

The time at which the cluster was updated. Its value is in Coordinated Universal Time.

data -> (object)

Object containing the discovered cluster information.

Form Factors: public, private

name -> (string)

The name of the cluster.

version -> (string)

The version of the cluster.

displayName -> (string)

The display name of the discovered cluster.

url -> (string)

The cluster URL of the discovered cluster.

secured -> (boolean)

Indicates if the cluster is secured or not.

kerberosUser -> (string)

The Kerberos user of the cluster.

kerberosTicketLocation -> (string)

The Kerberos ticket location of the cluster.

clusterDetails -> (object)

Object containing cluster details.

Form Factors: public, private

name -> (string)

Name of the cluster.

displayName -> (string)

Display name of the cluster.

version -> (string)

Cluster version.

fullVersion -> (string)

Full version of the cluster.

clusterUrl -> (string)

URL of the cluster.

hostsUrl -> (string)

The URL to access hosts of this cluster.

entityStatus -> (string)

The single value used by the Cloudera Manager to represent the status of the entity. UNKNOWN - Unknown. NONE - None. STOPPED - Stopped. DOWN - Down. UNKNOWN_HEALTH - Unknown health. DISABLED_HEALTH - Disabled health. CONCERNING_HEALTH - Concerning health. BAD_HEALTH - Bad health. GOOD_HEALTH - Good health. STARTING - Starting. STOPPING - Stopping. HISTORY_NOT_AVAILABLE - History not available.

Form Factors: public, private

uuid -> (string)

Uuid of the cluster.

clouderaManagerClusterType -> (string)

The type of cluster. If unspecified, defaults to either BASE_CLUSTER (if no data contexts are provided) or COMPUTE_CLUSTER (if one or more data contexts are provided). BASE_CLUSTER - CDP Base cluster being managed by Cloudera Manager. COMPUTE_CLUSTER - OnPremises containerized compute cluster being managed by the Cloudera control plane.

Form Factors: public, private

stats -> (string)

The stats of the discovered cluster.

username -> (string)

The user name of the cluster.

password -> (string)

The password of the cluster.

allowUntrusted -> (boolean)

Indicates if the service should make untrusted connections (without verifying TLS) to the cluster.

managerType -> (string)

Manager type of the cluster. AMBARI - Ambari as manager type. CLOUDERA_MANAGER - Cloudera Manager as manager type.

Form Factors: public, private

managerUri -> (string)

The manager URI of the registered cluster.

createdBy -> (string)

The owner of the registered cluster.

newKeyId -> (string)

The key ID of the registered cluster.

location -> (object)

Object containing the location of the data center.

Form Factors: public, private

id -> (integer)

ID of the location.

city -> (string)

City in which the data center is located.

province -> (string)

Province in which the data center is located.

country -> (string)

Country in which the data center is located.

iso2 -> (string)

ISO2 of the location.

latitude -> (string)

Latitude of the location.

longitude -> (string)

Longitude of the location.

properties -> (string)

The properties of the particular cluster as a JSON string.

cmClusterUuid -> (string)

The UUID of the CM Base Cluster.

environmentCrn -> (string)

The CRN of the Private Cloud environment.

pvcCrn -> (string)

CRN of the Private Cloud Control plane.

onPremEnvironmentDetails -> (object)

Object containing the on-premises Environment details.

Form Factors: public, private

cmHost -> (string)

Cloudera Manager Host.

applications -> (map)

A map of applications that provide services for the Service Discovery.

key -> (string)

value -> (object)

Object containing the details of a service discovery application.

Form Factors: public, private

name -> (string)

Name of the application.

services -> (map)

The services provided by the application.

key -> (string)

value -> (object)

Object containing the details of a service discovery service.

Form Factors: public, private

type -> (string)

Type of service.

endpoints -> (array)

List of endpoints that the service presents.

item -> (object)

Object containing the details of endpoint of a Service Discovery Service.

Form Factors: public, private

host -> (string)

Endpoint hostname or IP address.

port -> (integer)

Endpoint port.

uri -> (string)

Connection URI of the endpoint.

config -> (map)

Configuration key values for a service.

key -> (string)

config -> (map)

Configuration key values for an application.

key -> (string)

value -> (string)

cmVersion -> (string)

Cloudera Manager Version.

clouderaRuntimeVersion -> (string)

Cloudera Runtime Version.

onPremDatalakeDetails -> (object)

Object containing on-premises Data Lake details.

Form Factors: public, private

datalakeName -> (string)

Name of the Data Lake.

enableRangerRaz -> (boolean)

Inidicates whether Ranger RAZ is enabled for the Data Lake.

creationTimeEpochMillis -> (integer)

The timestamp in Unix epoch when the Data Lake was created.

cmFqdn -> (string)

The Cloudera Manager FQDN.

cmIp -> (string)

The Cloudera Manager IP.

cmServerId -> (string)

The Cloudera Manager server ID.

status -> (string)

Status of the on-premises Data Lake. AVAILABLE - Data Lake is available. NOT_AVAILABLE - Data Lake is unavailable.

Form Factors: public, private

instances -> (array)

The list of instances within the on premises Data Lake cluster.

item -> (object)

Information for instance within the on premises Data Lake cluster.

Form Factors: public, private

id -> (string)

The ID of the instance.

fqdn -> (string)

The fully qualified domain name of the instance in the cluster.

privateIp -> (string)

The private IP of the instance.

kerberosInfo -> (object)

The kerberos information for on premises Data Lake cluster.

Form Factors: public, private

kdcType -> (string)

The type of Key Distribution Center.

kerberosRealm -> (string)

Kerberos realm.

kdcHost -> (string)

Key Distribution Center host.

kerberized -> (boolean)

Denotes whether kerberized or not.

Form Factors¶

public, private