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

Note

This module is part of the cloudera.cloud collection (version 3.2.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 cloudera.cloud.

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

New in cloudera.cloud 1.0.0

Synopsis

  • Gather information about CDP Public IAM group or groups

Parameters

Parameter

Comments

access_key

string

If provided, the Cloudera on cloud API will use this value as its access key.

If not provided, the API will attempt to use the value from the environment variable CDP_ACCESS_KEY_ID.

Required if private_key is provided.

Mutually exclusive with credentials_path.

credentials_path

string

If provided, the Cloudera on cloud API will use this value as its credentials path.

If not provided, the API will attempt to use the value from the environment variable CDP_CREDENTIALS_PATH.

Default: "~/.cdp/credentials"

debug

aliases: debug_endpoints

boolean

If true, the module will capture the Cloudera on cloud HTTP log and return it in the sdk_out and sdk_out_lines fields.

Choices:

  • false ← (default)

  • true

detailed

boolean

Whether to return detailed group information including members, roles, and resource assignments.

Choices:

  • false

  • true ← (default)

endpoint

aliases: endpoint_url, url

string

The Cloudera on cloud API endpoint to use.

If not provided, the API will attempt to use the value from the environment variable CDP_ENDPOINT_URL.

Mutually exclusive with endpoint_region.

endpoint_region

aliases: cdp_endpoint_region, cdp_region, region

string

Specify the Cloudera on cloud API endpoint region.

See Cloudera Control Plane regions for more information.

If not provided, the API will attempt to use the value from the environment variable CDP_REGION.

default is an alias for the us-west-1 region.

Mutually exclusive with endpoint.

Choices:

  • "default"

  • "us-west-1" ← (default)

  • "eu-1"

  • "ap-1"

endpoint_tls

aliases: verify_endpoint_tls, verify_tls, verify_api_tls

boolean

Verify the TLS certificates for the Cloudera on cloud API endpoint.

Choices:

  • false

  • true ← (default)

http_agent

aliases: agent_header

string

The HTTP user agent to use for Cloudera on cloud API requests.

Default: "cloudera.cloud"

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.

private_key

string

If provided, the Cloudera on cloud API will use this value as its private key.

If not provided, the API will attempt to use the value from the environment variable CDP_PRIVATE_KEY.

Required if access_key is provided.

profile

string

If provided, the Cloudera on cloud API will use this value as its profile.

If not provided, the API will attempt to use the value from the environment variable CDP_PROFILE.

Default: "default"

strict

aliases: strict_errors

boolean

Legacy CDPy SDK error handling.

Choices:

  • false ← (default)

  • true

Examples

# Note: These examples do not set authentication details.

- name: Gather basic information about all Groups
  cloudera.cloud.iam_group_info:
    detailed: false

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

- name: Gather basic information about a named Group
  cloudera.cloud.iam_group_info:
    name: example-01
    detailed: false

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

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

Return Values

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

Key

Description

groups

list / elements=dictionary

Returns a list of group records.

Each record represents a CDP IAM group and its details.

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"

members

list / elements=string

List of member CRNs (users and machine users) which are members of the group.

Returned: when detailed is true

resourceAssignments

list / elements=dictionary

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

Returned: when detailed is true

resourceCrn

string

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

Returned: on success

resourceRoleCrn

string

The CRN of the resource role.

Returned: on success

roles

list / elements=string

List of Role CRNs assigned to the group.

Returned: when detailed is true

syncMembershipOnUserLogin

boolean

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

Returned: when supported

sdk_out

string

Returns the captured API HTTP log.

Returned: when supported

sdk_out_lines

list / elements=string

Returns a list of each line of the captured API HTTP log.

Returned: when supported

Authors

  • Webster Mudge (@wmudge)

  • Dan Chaffelson (@chaffelson)

  • Ronald Suplina (@rsuplina)