cloudera.cloud.env_freeipa_hosts lookup – Get information about FreeIPA hosts for selected Environment

Note

This lookup plugin 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.env_freeipa_hosts.

Synopsis

  • Allows you to retrieve information about FreeIPA hosts for a given CDP Public Cloud Environment.

  • If the Environment is not found or is ambigious, the lookup will return an error.

Terms

Parameter

Comments

Terms

string / required

A CDP Public Cloud Environment name

Keyword parameters

This describes keyword parameters of the lookup. These are the values key1=value1, key2=value2 and so on in the following examples: lookup('cloudera.cloud.env_freeipa_hosts', key1=value1, key2=value2, ...) and query('cloudera.cloud.env_freeipa_hosts', key1=value1, key2=value2, ...)

Parameter

Comments

detailed

boolean

Whether to return the full information about FreeIPA hosts for matching Environment

Choices:

  • false ← (default)

  • true

Notes

Note

  • When keyword and positional parameters are used together, positional parameters must be listed before keyword parameters: lookup('cloudera.cloud.env_freeipa_hosts', term1, term2, key1=value1, key2=value2) and query('cloudera.cloud.env_freeipa_hosts', term1, term2, key1=value1, key2=value2)

  • Requires cdpy.

Examples

- name: Retrieve the details for the FreeIPA hosts for a single CDP Public Cloud Environment
  ansible.builtin.debug:
    msg: "{{ lookup('cloudera.cloud.env_freeipa_hosts', environment='example-env-aws') }}"

- name: Retrieve the details as list for the FreeIPA hosts for a single CDP Public Cloud Environment
  ansible.builtin.debug:
    msg: "{{ lookup('cloudera.cloud.env_freeipa_hosts', environment='example-env-aws', wantlist=True) }}"

- name: Retrieve more detailied information for the FreeIPA hosts for a single CDP Public Cloud Environment
  ansible.builtin.debug:
    msg: "{{ lookup('cloudera.cloud.env_freeipa_hosts', environment='example-env-aws', detailed=True) }}"

Return Value

Key

Description

Return value

dictionary

List of FreeIPA hosts information of selected Environment

Returned: success

Authors

  • Ronald Suplina (@rsuplina)

Hint

Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.