cloudera.cloud.iam_group_info module – Gather information about CDP Public IAM groups

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.

To use it in a playbook, specify: cloudera.cloud.iam_group_info.

Synopsis

  • Gather information about CDP Public IAM group or groups

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: group_name

list / elements=string

A list of group names or CRNs or a single group name/CRN.

If no group name or CRN is provided, all groups are returned.

If any parameter group names are not found, no groups are returned.

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.

# Gather information about all Groups
- cloudera.cloud.iam_group_info:

# Gather information about a named Group
- cloudera.cloud.iam_group_info:
    name: example-01

# Gather information about several named Groups
- cloudera.cloud.iam_group_info:
    name:
      - example-01
      - example-02
      - example-03

Return Values

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

Key

Description

groups

list / elements=dictionary

The information about the named Group or Groups

Returned: always

creationDate

string

The date when this group record was created.

Returned: on success

Sample: "2020-07-06T12:24:05.531000+00:00"

crn

string

The CRN of the group.

Returned: on success

groupName

string

The group name.

Returned: on success

Sample: "example-01"

resource_roles

list / elements=dictionary

List of Resource-to-Role assignments, by CRN, that are associated with the group.

Returned: on success

resourceCrn

string

The CRN of the resource granted the rights of the role.

Returned: on success

resourceRoleCrn

string

The CRN of the CDP Role.

Returned: on success

roles

list / elements=string

List of Role CRNs assigned to the group.

Returned: on success

syncMembershipOnUserLogin

boolean

Flag indicating whether group membership is synced when a user logs in. The default is to sync group membership.

Returned: when supported

users

list / elements=string

List of User CRNs which are members of the group.

Returned: on success

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)

  • Dan Chaffelson (@chaffelson)