cloudera.services.ssb_project_info module – Retrieve information about SSB projects

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

New in cloudera.services 1.0.0

Synopsis

  • Retrieve information about one or more Cloudera SSB projects.

  • The module can list all projects or filter by 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: project_id

string

The unique identifier of the project to retrieve.

This parameter is mutually exclusive with name.

name

string

The name of the project to retrieve.

This parameter is mutually exclusive with id.

page_size

aliases: default_page_size

integer

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

Default: 100

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 projects
  cloudera.services.ssb_project_info:
  register: all_projects

- name: Get information about a specific project by name
  cloudera.services.ssb_project_info:
    name: "my-project"
  register: project_by_name

- name: Get information about a specific project by id
  cloudera.services.ssb_project_info:
    id: "12345"
  register: project_by_id

Return Values

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

Key

Description

projects

list / elements=dictionary

List of SSB projects.

Returned: always

active_environment

integer

The ID of the active environment for the project.

Returned: when available

description

string

A description of the project.

Returned: when available

id

integer

The unique identifier of the project.

Returned: when available

mv_prefix

string

The materialized view prefix for the project.

Returned: when available

name

string

The name of the project.

Returned: always

sync_source_config

dictionary

Configuration for the project’s sync source.

Returned: when available

allow_deletions

boolean

Whether to allow deletions from the sync source.

Returned: when available

branch

string

The branch to sync from the repository.

Returned: when available

clone_url

string

The URL to clone the sync source repository.

Returned: always

credential

dictionary

Credentials for accessing the sync source.

Returned: when available

password

string

The password for authentication.

Returned: when available

ssh_passphrase

string

The passphrase for the SSH key.

Returned: when available

ssh_private_key

string

The SSH private key for authentication.

Returned: when available

ssh_public_key

string

The SSH public key for authentication.

Returned: when available

type

string

The type of credential (e.g., password, ssh).

Returned: always

username

string

The username for authentication.

Returned: when available

type

string

The type of sync source.

Returned: always

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

Authors

  • Webster Mudge (@wmudge)