cloudera.cloud.dw_virtual_warehouse_info module – Gather information about CDP Data Warehouse Virtual Warehouses

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.dw_virtual_warehouse_info.

New in cloudera.cloud 1.5.0

Synopsis

  • Gather information about CDP Data Warehouse (CDW) Virtual Warehouses in a cluster.

  • Optionally filter by Virtual Warehouse id, name, or parent Database Catalog.

  • The module supports check_mode.

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.

catalog_id

aliases: dbc_id

string

The identifier of the parent Database Catalog attached to the Virtual Warehouse(s).

Mutually exclusive with warehouse_id and name.

cluster_id

string / required

The identifier of the parent Data Warehouse Cluster of the Virtual Warehouse(s).

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)

http_agent

aliases: agent_header

string

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

Default: "cloudera.cloud"

name

string

The name of the Virtual Warehouse.

Mutually exclusive with warehouse_id and catalog_id.

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"

strict

aliases: strict_errors

boolean

Legacy CDPy SDK error handling.

Choices:

  • false ← (default)

  • true

warehouse_id

aliases: vw_id, id

string

The identifier of the Virtual Warehouse.

Mutually exclusive with name and catalog_id.

Attributes

Attribute

Support

Description

check_mode

Support: full

Can run in check_mode and return changed status prediction without modifying target, if not supported the action will be skipped.

diff_mode

Support: N/A

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode

platform

Platforms: all

Target OS/families that can be operated against

Examples

# Note: These examples do not set authentication details.

- name: List all Virtual Warehouses in a Cluster
  cloudera.cloud.dw_virtual_warehouse_info:
    cluster_id: example-cluster-id

- name: List all Virtual Warehouses associated with a Database Catalog
  cloudera.cloud.dw_virtual_warehouse_info:
    cluster_id: example-cluster-id
    catalog_id: example-data-catalog-id

- name: Describe a Virtual Warehouse by ID
  cloudera.cloud.dw_virtual_warehouse_info:
    cluster_id: example-cluster-id
    warehouse_id: example-virtual-warehouse-id

- name: Describe a Virtual Warehouse by name
  cloudera.cloud.dw_virtual_warehouse_info:
    cluster_id: example-cluster-id
    name: example-virtual-warehouse

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 debug is true

sdk_out_lines

list / elements=string

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

Returned: when debug is true

virtual_warehouses

list / elements=dictionary

The details about the CDP Data Warehouse Virtual Warehouse(s).

Returned: always

associatedConnectors

dictionary

The connectors associated with the Virtual Warehouse, keyed by connector id.

Returned: when available

configId

string

The identifier of the Virtual Warehouse configuration.

Returned: when available

creationDate

string

The creation time of the Virtual Warehouse in UTC.

Returned: when available

creator

dictionary

Details about the Virtual Warehouse creator.

Returned: when available

dbcId

string

The Database Catalog ID associated with the Virtual Warehouse.

Returned: when available

id

string

The identifier of the Virtual Warehouse.

Returned: when available

instanceType

string

The underlying compute instance type.

Returned: when available

name

string

The name of the Virtual Warehouse.

Returned: when available

nodeCount

integer

The node count (compute cluster size) of the Virtual Warehouse.

Returned: when available

status

string

The status of the Virtual Warehouse.

Returned: when available

tags

list / elements=dictionary

Custom tags applied to the Virtual Warehouse.

Returned: when available

vwType

string

The Virtual Warehouse type.

Returned: when available

Authors

  • Webster Mudge (@wmudge)