cloudera.cloud.freeipa_info module – Gather information about FreeIPA

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

Synopsis

  • Gather information about FreeIPA

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

string / required

The FreeIPA environment specified will be described

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.

# List FreeIPA information about a named Environment
- cloudera.cloud.freeipa_info:
    name: example-environment

Return Values

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

Key

Description

environments

dictionary

The information about the named Environment or Environments

Returned: on success

environmentCrn

string

CDP CRN value for the Environment.

Returned: always

environmentName

string

Name of the Environment.

Returned: always

Sample: "a-cdp-environment-name"

instances

list / elements=dictionary

Details about the instances.

Returned: always

hostname

string

The hostname of the instance.

Returned: always

Sample: "ipaserver0.a-cdp-environment-name.example.site"

id

string

The identifier of the instance.

Returned: always

Sample: "i-00b58f27be"

issues

list / elements=string

Details of any issues encountered with server.

Returned: always

Sample: []

state

string

The state of the instance.

Returned: always

Sample: "CREATED"

Authors

  • Webster Mudge (@wmudge)

  • Jim Enright (@jenright)