cloudera.exe.supported module – Retrieve Cloudera Support Matrix information

Note

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

To use it in a playbook, specify: cloudera.exe.supported.

New in cloudera.exe 3.0.0

Synopsis

  • Retrieve product compatibility and support information from the Cloudera Support Matrix API.

  • Supports filtering by Cloudera Runtime, Manager or Data Service product versions.

  • Returns comprehensive support matrix data including compatibility information across different Cloudera products.

Parameters

Parameter

Comments

cloudera_data_services

string

Filter by specific CDP Private Cloud Data Services version.

Mutually exclusive with the cloudera_manager and cloudera_runtime parameters.

cloudera_manager

string

Filter by specific Cloudera Manager version.

Mutually exclusive with the cloudera_runtime and cloudera_data_services parameters.

cloudera_runtime

string

Filter by specific CDP Private Cloud Base (Cloudera Runtime) version.

Mutually exclusive with the cloudera_manager and cloudera_data_services parameters.

raw_filters

list / elements=string

Additional raw filters to add to the support matrix URL.

Each filter will be appended to the URL, delimited by colons (;).

Default: []

timeout

integer

HTTP request timeout in seconds.

Default: 30

Notes

Note

Examples

- name: Get all support matrix information
  cloudera.exe.supported:
  register: full_matrix

- name: Get support matrix for Cloudera Manager version
  cloudera.exe.supported:
    cloudera_manager: "7.13.1"
  register: cm_support

- name: Get support matrix for Cloudera Runtime version
  cloudera.exe.supported:
    cloudera_runtime: "7.1.9 SP1"
  register: base_support

- name: Get support matrix for Cloudera Data Services version
  cloudera.exe.supported:
    cloudera_data_services: "1.5.4"
  register: ds_support

- name: Get support matrix for Cloudera Manager version and OS
  cloudera.exe.supported:
    cloudera_manager: "7.13.1"
    raw_filters:
      - OPERATING_SYSTEMS=RHEL-9.2
  register: ds_support

Return Values

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

Key

Description

filters

dictionary

Summary of filters that were applied to the API request

Returned: always

_product full name_

string

Full name and version of the supplied product

Returned: when filter applied

support_matrix_data

dictionary

Complete support matrix information from Cloudera

Returned: always

browsers

list / elements=dictionary

Browser support information

Returned: when supported

databases

list / elements=dictionary

Database compatibility information

Returned: when supported

Sample: [{"description": "PostgreSQL-13", "family": "PostgreSQL", "id": 801, "version": "13"}]

description

string

Description of the database

Returned: always

family

string

Database family identifier

Returned: always

id

integer

Support matrix ID for the entry

Returned: always

version

string

Version of the database

Returned: always

jdks

list / elements=dictionary

JDK compatibility information

Returned: when supported

Sample: [{"description": "OpenJDK-JDK11", "family": "OpenJDK", "id": 797, "version": "JDK11"}]

description

string

Description of the JDK

Returned: always

family

string

JDK family identifier

Returned: always

id

integer

Support matrix ID for the entry

Returned: always

version

string

Version of the JDK

Returned: always

kubernetes

list / elements=string

Kubernetes platform compatibility

Returned: always

operating_systems

list / elements=dictionary

Operating system compatibility

Returned: when supported

Sample: [{"description": "Rocky Linux-9.4", "family": "Rocky Linux", "group": "9", "id": 1087, "version": "9.4"}]

description

string

Description of the OS

Returned: always

family

string

OS family identifier

Returned: always

group

string

Group identifier

Returned: always

id

integer

Support matrix ID for the entry

Returned: always

version

string

Version of the OS

Returned: always

processor

list / elements=dictionary

Processor architecture compatibility

Returned: when supported

description

string

Description of the architecture

Returned: always

family

string

Architecture family identifier

Returned: always

id

integer

Support matrix ID for the entry

Returned: always

name

integer

Name of the architecture

Returned: always

version

string

Version of the architecture

Returned: always

products

list / elements=dictionary

Cloudera product information

Returned: when supported

Sample: [{"description": "Cloudera Manager-7.13.1", "group": "7.13", "id": 1325, "productName": "Cloudera Manager", "version": "7.13.1"}]

description

string

Description of the product

Returned: always

group

string

Group identifier

Returned: always

id

integer

Support matrix ID for the entry

Returned: always

org

string

Support matrix organization

Returned: always

product_name

string

Full product name

Returned: always

release_date

string

Release date of the product (DD-MM-YYY)

Returned: when supported

version

string

Version of the product

Returned: always

Authors

  • Jim Enright (@jimright)