sap.sap_operations.cf_service_instances_info module – Fetch information about Cloud Foundry service instances

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

New in sap.sap_operations 1.22.0

Synopsis

  • Fetch information about Cloud Foundry service instances

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 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: Fetch information about service instances
  sap.sap_operations.cf_service_instances_info:
    username: user@email.domain
    password: secret
    api_endpoint: <cloud foundry api endpoint>

Authors

  • Kirill Satarin (@kksat)