list-partially-registered-clusters¶

Description¶

API to list all the partially registered clusters.

list-partially-registered-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-partially-registered-clusters
[--max-items <value>]
[--starting-token <value>]
[--page-size <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

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

partiallyRegisteredClusterData -> (array)

Details of the partially registered cluster data

item -> (object)

Object holding the partially registered on-premise cluster data

Form Factors: public, private

id -> (integer)

The ID of the partially registered on-premise cluster.

clusterCrn -> (string)

The cluster CRN of the on-premise cluster.

datacenterName -> (string)

The datacenter name of the on-premise cluster.

ipAddress -> (string)

The IP Address of the on-premise cluster (same as Cloudera Manager IP address).

port -> (integer)

The port at which the cloudera manager is accessible.

clusterType -> (string)

The type of the partially registered cluster. It will be either CDPDC or CDH.

isSecure -> (boolean)

Boolean value to determine if the cluster is secure.

clusterConnectivityState -> (string)

State of the cluster connectivity of the partially registered cluster. It will be either FAILED, IN-PROGRESS, READY.

createdBy -> (string)

The CRN of the user who triggered the registration request.

createdAt -> (datetime)

The time at which the registration was triggered.

updatedAt -> (datetime)

The time at which the registration was updated.

registrationStatus -> (string)

Registration Status of the partially registered on-premises cluster.

agentCrn -> (string)

CRN of the jumpgate agent.

pvcCrn -> (string)

CRN of the Private Cloud Control plane.

nextPageToken -> (string)

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

Form Factors¶

public