product_search – Searches products from the JBoss Network API.

Note

This module is part of the middleware_automation.common collection.

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

To use it in a playbook, specify: middleware_automation.common.product_search.

Synopsis

• Searches products from the JBoss Network API.

Requirements

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

• requests

Parameters

Parameter	Comments
api_url string	Address of the JBoss Network API. Default: :ansible-option-default:`"https://jbossnetwork.api.redhat.com"`
client_id string	Client ID associated with to download a product from the JBoss Network API. If value not set, will try environment variable REDHAT_PRODUCT_DOWNLOAD_CLIENT_ID
client_secret string	Client Secret associated with to download a product from the JBoss Network API. If value not set, will try environment variable REDHAT_PRODUCT_DOWNLOAD_CLIENT_SECRET
product_category string	Type of the Product Category
product_id string	Product Id for the Redhat customer portal
product_type string	Type of the Product
product_version string	Product Version to be downloaded.
sso_url string	Address of the Red Hat SSO Server. Default: :ansible-option-default:`"https://sso.redhat.com"`
validate_certs boolean	If false, SSL certificates will not be validated. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)

Examples

- name: Search Red Hat Products
  middleware_automation.common.product_search:
    client_id: 123e4567-e89b-12d3-a456-426614174000
    client_secret: 0mpkY0i8IdIRWbk6rLXBlf5Jkqq8i4nW
    product_category: webserver
    product_version: 5.5

Return Values

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

Key	Description
results complex	The objects returned from the API Returned: success
category string	Product category. Returned: success
description string	Description of the product. Returned: success
distribution_status string	Distribution status of the product. Returned: success
download_path string	URL where the product can be downloaded. Returned: success
id integer	id of the product. Returned: success
md5 string	MD5 checksum of the product. Returned: success
name string	Name of the product. Returned: success
sha256 string	MD5 checksum of the product. Returned: success
title string	Title of the product. Returned: success
type string	Type of product. Returned: success
version string	Product version. Returned: success
visibility string	Product visibility. Returned: success

Authors

• Andrew Block (@sabre1041)