cloudera.services.ssb_user module – Manage the current SSB user’s settings

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

New in cloudera.services 1.0.0

Synopsis

  • Manage settings for the currently authenticated Cloudera SSB user.

  • Set the user’s active project.

  • Change the user’s password.

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

current_password

string

The current password for the user.

Required when changing the password (when new_password is provided).

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"

new_password

string

The new password to set for the user.

When provided, changes the user’s password.

current_password must also be provided.

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

The project ID to set as the user’s active project.

When provided, sets this project as the current active project for the user.

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: Set the user's active project
  cloudera.services.ssb_user:
    project_id: "12345"
  register: user_result

- name: Change the user's password
  cloudera.services.ssb_user:
    current_password: "old-password"
    new_password: "new-secure-password"
  register: password_result

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

user

dictionary

The updated user information.

Returned: always

email

string

The email address of the user.

Returned: when available

first_name

string

The first name of the user.

Returned: when available

granted_authorities

list / elements=string

List of roles and authorities granted to the user.

Returned: when available

id

string

The unique identifier of the user.

Returned: always

is_active

boolean

Whether the user account is active.

Returned: when available

keytab

string

Base64-encoded keytab data for the user.

Returned: when available

keytab_last_modified

string

Timestamp of when the keytab was last modified.

Returned: when available

keytab_principal

string

The Kerberos principal associated with the user’s keytab.

Returned: when available

last_name

string

The last name of the user.

Returned: when available

primary_project_id

string

The ID of the user’s primary project.

Returned: when available

project_id

string

The ID of the user’s currently active project.

Returned: when available

username

string

The username of the user.

Returned: always

Authors

  • Webster Mudge (@wmudge)