cloudera.cloud.de_virtual_cluster_info module – Gather information about CDP Data Engineering Virtual Clusters

Note

This module is part of the cloudera.cloud collection (version 3.3.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install cloudera.cloud.

To use it in a playbook, specify: cloudera.cloud.de_virtual_cluster_info.

New in cloudera.cloud 1.5.0

Synopsis

  • Gather information about CDP Data Engineering Virtual Clusters

Parameters

Parameter

Comments

access_key

string

If provided, the Cloudera on cloud API will use this value as its access key.

If not provided, the API will attempt to use the value from the environment variable CDP_ACCESS_KEY_ID.

Required if private_key is provided.

Mutually exclusive with credentials_path.

credentials_path

string

If provided, the Cloudera on cloud API will use this value as its credentials path.

If not provided, the API will attempt to use the value from the environment variable CDP_CREDENTIALS_PATH.

Default: "~/.cdp/credentials"

debug

aliases: debug_endpoints

boolean

If true, the module will capture the Cloudera on cloud HTTP log and return it in the sdk_out and sdk_out_lines fields.

Choices:

  • false ← (default)

  • true

endpoint

aliases: endpoint_url, url

string

The Cloudera on cloud API endpoint to use.

If not provided, the API will attempt to use the value from the environment variable CDP_ENDPOINT_URL.

Mutually exclusive with endpoint_region.

endpoint_region

aliases: cdp_endpoint_region, cdp_region, region

string

Specify the Cloudera on cloud API endpoint region.

See Cloudera Control Plane regions for more information.

If not provided, the API will attempt to use the value from the environment variable CDP_REGION.

default is an alias for the us-west-1 region.

Mutually exclusive with endpoint.

Choices:

  • "default"

  • "us-west-1" ← (default)

  • "eu-1"

  • "ap-1"

endpoint_tls

aliases: verify_endpoint_tls, verify_tls, verify_api_tls

boolean

Verify the TLS certificates for the Cloudera on cloud API endpoint.

Choices:

  • false

  • true ← (default)

environment

aliases: env

string / required

The CDP environment name of the CDE Service containing the Virtual Cluster(s).

http_agent

aliases: agent_header

string

The HTTP user agent to use for Cloudera on cloud API requests.

Default: "cloudera.cloud"

name

string

If a name is provided, that Virtual Cluster will be described (if it exists).

Note that Virtual Cluster names are unique within a given CDE Service.

private_key

string

If provided, the Cloudera on cloud API will use this value as its private key.

If not provided, the API will attempt to use the value from the environment variable CDP_PRIVATE_KEY.

Required if access_key is provided.

profile

string

If provided, the Cloudera on cloud API will use this value as its profile.

If not provided, the API will attempt to use the value from the environment variable CDP_PROFILE.

Default: "default"

service_name

aliases: cluster_name

string / required

The name of the CDE Service containing the Virtual Cluster(s).

strict

aliases: strict_errors

boolean

Legacy CDPy SDK error handling.

Choices:

  • false ← (default)

  • true

Examples

# Note: These examples do not set authentication details.

- name: List basic information about all Virtual Clusters within a CDE Service
  cloudera.cloud.de_virtual_cluster_info:
    environment: my-environment
    service_name: my-cde-service

- name: Gather detailed information about a named Virtual Cluster
  cloudera.cloud.de_virtual_cluster_info:
    environment: my-environment
    service_name: my-cde-service
    name: my-virtual-cluster

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

sdk_out

string

Returns the captured CDP SDK log.

Returned: when supported

sdk_out_lines

list / elements=string

Returns a list of each line of the captured CDP SDK log.

Returned: when supported

virtual_clusters

list / elements=complex

The information about the named Virtual Cluster or Virtual Clusters.

Returned: always

accessControl

dictionary

Access control details for the Virtual Cluster.

Returned: when available

clusterId

string

Cluster ID of the CDE Service that contains the Virtual Cluster.

Returned: always

creatorEmail

string

Email address of the creator of the Virtual Cluster.

Returned: when available

resources

dictionary

Resource details of the Virtual Cluster.

Returned: when available

sparkConfigs

dictionary

Spark configurations applied to all jobs run in the Virtual Cluster.

Returned: when available

sparkVersion

string

Spark version for the Virtual Cluster.

Returned: when available

status

string

Status of the Virtual Cluster.

Returned: always

vcApiUrl

string

URL for the Virtual Cluster APIs.

Returned: when available

vcId

string

Virtual Cluster ID.

Returned: always

vcName

string

Name of the Virtual Cluster.

Returned: always

vcTier

string

Tier of the Virtual Cluster (ALLP or CORE).

Returned: when available

Authors

  • Curtis Howard (@curtishoward)

  • Ronald Suplina (@rsuplina)