cloudera.services.ssb_table_info module – Retrieve information about SSB project tables

Note

This module is part of the cloudera.services collection (version 1.0.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 git+https://github.com/cloudera-labs/cloudera.services.git.

To use it in a playbook, specify: cloudera.services.ssb_table_info.

New in cloudera.services 1.0.0

Synopsis

  • Retrieve information about one or more Cloudera SSB project tables.

  • The module can list all tables in a project or filter by table name or id.

  • The module supports check_mode.

Parameters

Parameter

Comments

client_cert

path

The path to a client certificate for authenticating to the API endpoint.

client_key

path

The path to a client key for authenticating to the API endpoint.

debug

aliases: debug_endpoints

boolean

A flag to enable debug logging of the module’s execution.

Choices:

  • false ← (default)

  • true

force

boolean

A flag to force a refresh of the API request, ignoring any cached results.

Choices:

  • false ← (default)

  • true

force_basic_auth

boolean

A flag to force basic authentication for API requests.

Choices:

  • false ← (default)

  • true

http_agent

aliases: user_agent

string

The User-Agent string to send with API requests.

Default: "cloudera-services-module"

id

aliases: table_id

integer

The unique identifier of the table to retrieve.

This parameter is mutually exclusive with table_name.

page_size

aliases: default_page_size

integer

The number of items to return per page in a paginated API response.

Default: 100

project_id

string / required

The unique identifier of the project containing the table(s).

Required for all operations.

table_name

string

The name of the table to retrieve.

This parameter is mutually exclusive with id.

timeout

aliases: timeout_seconds

integer

The timeout in seconds for any API requests.

Default: 60

url

aliases: endpoint, endpoint_url

string / required

The base URL of the API endpoint, including the port if necessary.

url_password

string

The password for authenticating to the API endpoint.

url_username

string

The username for authenticating to the API endpoint.

use_gssapi

boolean

A flag to enable or disable GSSAPI authentication for API requests.

Choices:

  • false ← (default)

  • true

use_proxy

boolean

A flag to enable or disable the use of a proxy for API requests.

Choices:

  • false

  • true ← (default)

validate_certs

boolean

A flag to enable or disable SSL certificate validation for API requests.

Choices:

  • false

  • true ← (default)

Examples

- name: List all SSB tables in a project
  cloudera.services.ssb_table_info:
    project_id: "12345"
  register: all_tables

- name: Get information about a specific table by name
  cloudera.services.ssb_table_info:
    project_id: "12345"
    table_name: "my_table"
  register: table_by_name

- name: Get information about a specific table by id
  cloudera.services.ssb_table_info:
    project_id: "12345"
    id: 789
  register: table_by_id

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

tables

list / elements=dictionary

List of SSB project tables.

Returned: always

created_at

string

Timestamp when the table was created.

Returned: when available

id

integer

The unique identifier of the table.

Returned: when available

metadata

dictionary

Dictionary of metadata for the table.

Returned: always

project_id

string

The project identifier this table belongs to.

Returned: when available

table_name

string

The name of the table.

Returned: always

transform_code

string

Optional transformation code for the table.

Returned: when available

transform_code_b64_encoded

boolean

Whether the transform_code is base64 encoded.

Returned: when available

type

string

The type of the table.

Returned: always

Authors

  • Webster Mudge (@wmudge)