cloudera.cloud.recipe_info module – Gather information about CDP recipes

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

Synopsis

  • Gather information about CDP recipes.

  • A recipe is a script that runs on nodes of Data Hub, Datalake, or FreeIPA nodes.

  • See the Cloudera documentation on recipes for details.

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

string

If a name is provided, that recipe will be described.

If no name provided, all recipes will be listed.

profile

string

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

return_content

aliases: recipe_content, content

boolean

Flag dictating if recipe content is returned

Choices:

  • false ← (default)

  • true

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.

- name: List all recipes
  cloudera.cloud.recipe_info:

- name: Gather information about a named recipe
  cloudera.cloud.recipe_info:
    name: example-recipe

- name: Gather detailed information about a named recipe
  cloudera.cloud.recipe_info:
    name: example-recipe
    return_content: yes
  register: my_recipe

Return Values

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

Key

Description

recipes

list / elements=dictionary

The information about the named recipe or recipes

Returned: on success

creatorCrn

string

The CRN of the creator of the recipe.

Returned: when supported

crn

string

The CRN of the recipe.

Returned: always

description

string

The description of the recipe.

Returned: when supported

recipeContent

string

The content of the recipe.

Returned: when supported

recipeName

string

The name of the recipe.

Returned: always

type

string

The type of recipe.

Supported values are: POST_CLOUDERA_MANAGER_START, PRE_TERMINATION, PRE_SERVICE_DEPLOYMENT, POST_SERVICE_DEPLOYMENT.

Returned: when supported

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)