sap.sap_operations.cf_marketplace_info (1.25.0) — module

Install collection

Install with ansible-galaxy collection install sap.sap_operations:==1.25.0

Add to requirements.yml

  collections:
    - name: sap.sap_operations
      version: 1.25.0

Description

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.

Requirements

• python >= 3.6
• cf CLI should be installed and available in PATH

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Inputs

    
password:
    description:
    - The password for authentication with the Cloud Foundry API.
    required: false
    type: str

username:
    description:
    - The username for authentication with the Cloud Foundry API.
    - This is SAP BTP user email address
    required: false
    type: str

api_endpoint:
    description:
    - The endpoint URL of the Cloud Foundry API.
    required: false
    type: str

Outputs

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