cloudera.cluster.parcel_info module – Gather details about the parcels on the cluster

Note

This module is part of the cloudera.cluster collection (version 4.4.0).

To install it, use: ansible-galaxy collection install cloudera.cluster. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cloudera.cluster.parcel_info.

Synopsis

  • Gathers details about a single parcel or about all parcels on the cluster

Requirements

The below requirements are needed on the host that executes this module.

  • cm-client

Parameters

Parameter

Comments

cluster

aliases: cluster_name

string / required

The name of the cluster

name

aliases: product, parcel

string

The name of the product, e.g. CDH, Impala.

Required if parcel_version is declared.

parcel_version

string

The version of the product, e.g. 1.1.0, 2.3.0.

Required if name is declared.

Examples

- name: Gather details about specific parcel
  cloudera.cluster.parcel_info:
    host: example.cloudera.com
    username: "jane_smith"
    password: "S&peR4Ec*re"
    cluster_name: "OneNodeECS"
    product: "ECS"
    parcel_version: "1.5.1-b626-ecs-1.5.1-b626.p0.42068229"

- name: Gather details about all parcels on the cluster
  cloudera.cluster.parcel_info:
    host: example.cloudera.com
    username: "jane_smith"
    password: "S&peR4Ec*re"
    cluster_name: "OneNodeECS"

Return Values

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

Key

Description

parcels

list / elements=dictionary

Returns details about a specific parcel or all parcels on the cluster

Returned: success

cluster_name

dictionary

The name of the enclosing cluster.

Returned: always

description

string

Description of the parcel.

Returned: when supported

display_name

string

Display name of the parcel.

Returned: when supported

product

string

The name of the product.

Returned: always

stage

string

Current stage of the parcel.

Returned: always

state

dictionary

The state of the parcel.

This shows the progress of state transitions and if there were any errors.

Returned: when supported

version

string

The version of the product.

Returned: always

Authors

  • Ronald Suplina (@rsuplina)

Collection links