cloudera.cloud.env_user_sync module – Sync CDP Users and Groups to Environments

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

Synopsis

  • Synchronize users and groups with one or more CDP environments.

  • The module support check_mode.

Requirements

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

  • cdpy

Parameters

Parameter

Comments

cdp_region

aliases: cdp_endpoint_region, endpoint_region

string

Specify the Cloudera Data Platform endpoint region.

Default: "default"

current_user

aliases: user

boolean

Sync the current CDP user as defined by the CDP_PROFILE with all environments.

Mutually exclusive with name.

Choices:

  • false

  • true

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 datalake to achieve the declared state.

Default: 15

name

aliases: environment

list / elements=string

A single Environment or list of Environments that will sync all CDP Users and Groups.

If not present, all Environments will be synced.

Mutually exclusive with current_user.

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 datalake 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)

Examples

# Note: These examples do not set authentication details.

# Sync a CDP Environment
- cloudera.cloud.env_user_sync:
    name: example-environment

# Sync multiple CDP Environments
- cloudera.cloud.env_user_sync:
    name:
      - example-environment
      - another-environment

# Sync the current CDP User
- cloudera.cloud.env_user_sync:
    current_user: yes

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

sync

complex

Returns an object describing of the status of the User and Group sync event.

Returned: success

endTime

string

Sync operation end timestamp (epoch seconds).

Returned: when supported

Sample: "1602080301000"

error

string

Error message for general failure of sync operation.

Returned: when supported

failure

list / elements=dictionary

List of sync operation details for all failed environments.

Returned: when supported

environmentCrn

string

The environment CRN.

Returned: always

message

string

Details on the failure.

Returned: when supported

operationId

string

UUID of the request for this operation.

Returned: always

Sample: "0e9bc67a-b308-4275-935c-b8c764dc13be"

operationType

string

The operation type.

Returned: when supported

Sample: "USER_SYNC"

startTime

string

Sync operation start timestamp (epoch seconds).

Returned: when supported

Sample: "1602080301000"

status

string

Status of this operation.

Returned: when supported

Sample: "['NEVER_RUN', 'REQUESTED', 'REJECTED', 'RUNNING', 'COMPLETED', 'FAILED', 'TIMEDOUT']"

success

list / elements=dictionary

List of sync operation details for all succeeded environments.

Returned: when supported

environmentCrn

string

The environment CRN.

Returned: always

message

string

Details on the success.

Returned: when supported

Authors

  • Webster Mudge (@wmudge)

  • Dan Chaffelson (@chaffelson)