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 2.5.1).

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. You need further requirements to be able to use this module, see Requirements for details.

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

Synopsis

  • Gather information about CDP Virtual Warehouses

Requirements

The below requirements are needed on the host that executes this module.

  • cdpy

Parameters

Parameter

Comments

catalog_id

aliases: dbc_id

string

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

Requires cluster_id.

Mutally exclusive with warehouse_id and name.

cdp_region

aliases: cdp_endpoint_region, endpoint_region

string

Specify the Cloudera Data Platform endpoint region.

Default: "default"

cluster_id

string

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

debug

aliases: debug_endpoints

boolean

Capture the CDP SDK debug log.

Choices:

  • false ← (default)

  • true

delay

aliases: polling_delay

integer

The internal polling interval (in seconds) while the module waits for the Virtual Warehouse to achieve the declared state.

Default: 15

name

string

The name of the Virtual Warehouse.

Requires cluster_id.

Mutually exclusive with warehouse_id and catalog_id.

profile

string

If provided, the CDP SDK will use this value as its profile.

timeout

aliases: polling_timeout

integer

The internal polling timeout (in seconds) while the module waits for the Virtual Warehouse to achieve the declared state.

Default: 3600

verify_endpoint_tls

aliases: endpoint_tls

boolean

Verify the TLS certificates for the CDP endpoint.

Choices:

  • false

  • true ← (default)

warehouse_id

aliases: vw_id, id

string

The identifier of the Virtual Warehouse.

Requires cluster_id.

Mutually exclusive with name and catalog_id.

Examples

# Note: These examples do not set authentication details.

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

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

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

# 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 supported

sdk_out_lines

list / elements=string

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

Returned: when supported

virtual_warehouses

list / elements=dictionary

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

Returned: success

creationDate

string

The creation time of the Virtual Warehouse in UTC.

Returned: always

creator

dictionary

Details about the Virtual Warehouse creator.

Returned: always

crn

string

The creator’s Actor CRN.

Returned: always

email

string

Email address (for users).

Returned: when supported

machineUsername

string

Username (for machine users).

Returned: when supported

workloadUsername

string

Username (for users).

Returned: when supported

dbcId

string

The Database Catalog ID associated with the Virtual Warehouse.

Returned: always

id

string

The identifier of the Virtual Warehouse.

Returned: always

name

string

The name of the Virtual Warehouse.

Returned: always

status

string

The status of the Virtual Warehouse.

Returned: always

tags

dictionary

Custom tags applied to the Virtual Warehouse.

Returned: always

vwType

string

The Virtual Warehouse type.

Returned: always

Authors

  • Webster Mudge (@wmudge)

  • Dan Chaffelson (@chaffelson)

  • Saravanan Raju (@raju-saravanan)