cloudera.cloud.env_automated_user_sync_info module – Get the status of the automated CDP Users and Groups synchronization service

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

Synopsis

  • Get the status of the automated synchronization for users and groups for a given Environment.

  • Requires the WORKLOAD_IAM_SYNC entitlement.

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

debug

aliases: debug_endpoints

boolean

Capture the CDP SDK debug log.

Choices:

  • false ← (default)

  • true

name

aliases: environment

string / required

The CDP Environment name or CRN to check.

profile

string

If provided, the CDP SDK will use this value as its profile.

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.

# Get the status of a sync event (non-WORKLOAD_IAM_SYNC)
- cloudera.cloud.env_automated_user_sync_info:
    name: example-env

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 automated User and Group synchronization service.

Returned: success

environmentCrn

string

The environment CRN.

Returned: always

lastSyncStatus

dictionary

Status of the last automated sync operation for the environment.

Returned: always

status

string

The status of the sync.

Returned: always

Sample: "['UNKNOWN', 'SUCCESS', 'FAILED']"

statusMessages

list / elements=string

Additional detail related to the status.

Returned: when supported

timestamp

string

A datetime stamp of when the sync was processed.

Returned: always

syncPendingState

string

The state indicating whether the environment is synced or has a sync pending.

Returned: always

Sample: "['UNKNOWN', 'SYNC_PENDING', 'SYNCED', 'SYNC_HALTED']"

Authors

  • Webster Mudge (@wmudge)