cloudera.services.ssb_environment_info module – Retrieve information about SSB project environments

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

New in cloudera.services 1.0.0

Synopsis

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

  • The module can list all environments in a project 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: environment_id

integer

The unique identifier of the environment to retrieve.

This parameter is mutually exclusive with name.

name

string

The name of the environment 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

project_id

string / required

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

Required for all operations.

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 environments in a project
  cloudera.services.ssb_environment_info:
    project_id: "12345"
  register: all_environments

- name: Get information about a specific environment by name
  cloudera.services.ssb_environment_info:
    project_id: "12345"
    name: "production"
  register: environment_by_name

- name: Get information about a specific environment by id
  cloudera.services.ssb_environment_info:
    project_id: "12345"
    id: 789
  register: environment_by_id

Return Values

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

Key

Description

environments

list / elements=dictionary

List of SSB project environments.

Returned: always

created_at

string

Timestamp when the environment was created.

Returned: when available

id

integer

The unique identifier of the environment.

Returned: when available

last_edited_at

string

Timestamp when the environment was last edited.

Returned: when available

last_editor

string

Username of the last person to edit the environment.

Returned: when available

name

string

The name of the environment.

Returned: always

project

string

The project identifier this environment belongs to.

Returned: when available

secured_props

dictionary

Dictionary of secured properties for the environment.

Returned: always

sensitive

boolean

Whether the property value is sensitive.

Returned: when available

value

string

The value of the property.

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)