describe-datalake¶
- subtitle
Describes a datalake.
- version
0.9.120
Description¶
Describes a datalake.
Synopsis¶
describe-datalake
--datalake-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton]
Options¶
--datalake-name
(string)
The name or CRN of the datalake.
--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¶
datalake -> (object)
Details about a datalake
crn -> (string)
The CRN of the datalake.
datalakeName -> (string)
The name of the datalake.
status -> (string)
The status of the datalake.
shape -> (string)
Represents the available datalake scales. Defaults to LIGHT_DUTY if not set.
environmentCrn -> (string)
The CRN of the environment.
credentialCrn -> (string)
The CRN of credentials.
cloudPlatform -> (string)
The cloud platform.
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.
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 actual state of the instance.
discoveryFQDN -> (string)
The FQDN of the instance.
instanceStatus -> (string)
The status of the instance.
statusReason -> (string)
The reason for the current status of this instance.
privateIp -> (string)
The private IP of the given instance.
publicIp -> (string)
The public IP of the given 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.
instanceTypeVal -> (string)
The type of the instance.
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.
availabilityZones -> (array)
List of availability zones that this instance group is associated with.
item -> (string)
recipes -> (array)
The recipe names for the Datalake cluster.
item -> (string)
creationDate -> (datetime)
The date when the datalake was created.
clouderaManager -> (object)
Cloudera Manager details.
version -> (string)
Cloudera Manager version.
clouderaManagerRepositoryURL -> (string)
Cloudera Manager repository URL.
clouderaManagerServerURL -> (string)
Cloudera Manager server URL.
productVersions -> (array)
The product versions.
item -> (object)
Product version.
name -> (string)
The name of the product.
version -> (string)
The version of the product.
region -> (string)
The region of the datalake.
statusReason -> (string)
The reason for the status of the datalake.
awsConfiguration -> (object)
AWS configuration.
instanceProfile -> (string)
The instance profile used for the ID Broker instance.
azureConfiguration -> (object)
Azure configuration.
managedIdentity -> (string)
The managed identity used for the ID Broker instance.
gcpConfiguration -> (object)
GCP configuration.
serviceAccountEmail -> (string)
The email id of the service account used for the ID Broker instance.
endpoints -> (object)
Object which holds the exposed endpoints for the given cluster.
endpoints -> (array)
The exposed API 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.
cloudStorageBaseLocation -> (string)
The base location for the cloud storage used for the datalake.
enableRangerRaz -> (boolean)
Whether Ranger RAZ is enabled for the datalake.
tags -> (array)
Datalake tags object containing the tag values defined for the datalake.
item -> (object)
Tag for a datalake resource.
key -> (string)
The key of tag.
value -> (string)
The value of the tag.
Form Factors¶
public