sap.sap_operations.cf_marketplace_info module – Fetches Cloud Foundry marketplace service offerings

Note

This module is part of the sap.sap_operations collection.

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 sap.sap_operations. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: sap.sap_operations.cf_marketplace_info.

New in sap.sap_operations 1.21.0

Synopsis

• This module fetches the list of available service offerings from the Cloud Foundry marketplace.

• It uses the Cloud Foundry CLI to interact with the Cloud Foundry API.

• Cloud Foundry CLI should be installed and available in PATH.

Note

This module has a corresponding action plugin.

Requirements

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

• python >= 3.6

• cf CLI should be installed and available in PATH

Parameters

Parameter	Comments
api_endpoint string	The endpoint URL of the Cloud Foundry API.
password string	The password for authentication with the Cloud Foundry API.
username string	The username for authentication with the Cloud Foundry API. This is SAP BTP user email address

Notes

Note

• This module does not modify any data and is safe to run in check mode.

• This module is community supported

• Module interface (parameters, output) expected to be stable but not guaranteed

• Module planned to be released on Ansible Automation Hub after collecting some feedback

• There is no guarantee that this module will be officially supported by Red Hat

• This is ansible action plugin, not module

• Meaning this plugin will be always executed on ansible controller.

Examples

---
- name: Get Cloud Foundry marketplace services
  sap.sap_operations.cf_marketplace_info:
    username: <SAP BTP user email>
    password: password
    api_endpoint: <SAP BTP API endpoint>

Return Values

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

Key	Description
cf_marketplace_info list / elements=dictionary	List of Cloud Foundry marketplace services Returned: success
available boolean	Indicates if the service is available. Returned: always Sample: true
broker_catalog dictionary	Contains the broker catalog details. Returned: always
features dictionary	Features provided by the service. Returned: always
allow_context_updates boolean	Indicates if context updates are allowed. Returned: always
bindable boolean	Indicates if the service can be bound to applications. Returned: always
bindings_retrievable boolean	Indicates if bindings are retrievable. Returned: always
instances_retrievable boolean	Indicates if instances are retrievable. Returned: always
plan_updateable boolean	Indicates if the plan is updateable. Returned: always
id string	The ID of the service in the broker catalog. Returned: always
metadata dictionary	Metadata associated with the service. Returned: always
displayName string	Display name Returned: always
documentationUrl string	Documentation URL Returned: always
imageUrl string	Image URL Returned: always
longDescription string	Long description Returned: always
serviceInventoryId string	Service inventory ID Returned: always
sm_offering_id string	SM offering ID Returned: always
created_at string	The creation date and time of the service. Returned: always
description string	The description of the service. Returned: always
documentation_url string	URL to the documentation of the service. Returned: always
guid string	The globally unique identifier of the service. Returned: always
links dictionary	Links to related resources. Returned: always
self dictionary	Display name Returned: always
href string	URL Returned: always
service_broker dictionary	Documentation URL Returned: always
href string	URL Returned: always
service_plans dictionary	Image URL Returned: always
href string	URL Returned: always
metadata dictionary	Additional metadata about the service. Returned: always
annotations dictionary	Annotations Returned: always
labels dictionary	Labels Returned: always
name string	The name of the service. Returned: always
relationships dictionary	Relationships to other entities. Returned: always
service_broker dictionary	Service broker Returned: always
data dictionary	Data Returned: always
guid string	GUID Returned: always
requires list / elements=string	Features required by the service. Returned: always
shareable boolean	Indicates if the service instance can be shared across spaces. Returned: always
tags list / elements=string	Tags associated with the service. Returned: always
updated_at string	The last update date and time of the service. Returned: always

Authors

• Kirill Satarin (@kksat)