sap.sap_operations.cf_service_instance module – Manage 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_instance.

New in sap.sap_operations 1.22.0

Synopsis

• This plugin allows managing service instances in a Cloud Foundry environment.

• It can create, delete service instances.

• Plugin is idempotent it will not create service instance with the same name it is already exists.

• Plugin will not change service instance parameters or metadata if service instance already exists (this functionality is planned)

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.
metadata dictionary	A dictionary containing metadata for the service instance.
name string / required	The name of the service instance.
parameters dictionary	A dictionary containing configuration parameters for the service instance.
password string	The password for authentication with the Cloud Foundry API.
service string / required	The name of the service offering.
service_plan string	The name of the service plan for the service instance.
space string / required	The name of the space in which to manage the service instance.
state string	The desired state of the service instance. Choices: "present" ← (default) "absent"
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: Create a service instance
  sap.sap_operations.cf_service_instance:
    name: my_service_instance
    service: my_service
    state: present
    space: my_space
    service_plan: my_service_plan
    parameters:
      param1: value1
      param2: value2
    metadata:
      label1: value1
      label2: value2

- name: Delete a service instance
  sap.sap_operations.cf_service_instance:
    name: my_service_instance
    service: my_service
    state: absent
    space: my_space

Authors

• Kirill Satarin (@kksat)