sap.sap_operations.cf_service_instance_keys_info module – Fetch information about Cloud Foundry service instance keys

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

New in sap.sap_operations 1.24.0

Synopsis

• Fetch information about Cloud Foundry service instance keys

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.
service_instance_guid string	The GUID of the Cloud Foundry service instance to fetch keys for. Either this or the service_instance_name parameter is required.
service_instance_name string	The name of the Cloud Foundry service instance to fetch keys for. Either this or the service_instance_guid parameter is required.
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 instance keys
  sap.sap_operations.cf_service_instance_keys_info:
    username: user@email.domain
    password: secret
    api_endpoint: <cloud foundry api endpoint>
    service_instance_guid: <service instance guid>

- name: Fetch information about service instance keys
  sap.sap_operations.cf_service_instance_keys_info:
    username: user@email.domain
    password: secret
    api_endpoint: <cloud foundry api endpoint>
    service_instance_name: <service instance name>

Return Values

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

Key	Description
cf_service_instance_keys_info list / elements=dictionary	A list of service keys with their details. Returned: success
entity dictionary	The entity details of the service key. Returned: success
credentials dictionary	The credentials and related URLs for the service. Returned: success
endpoints dictionary	Various service URLs. Returned: success
account_context_service_url string	URL for the account context service. Returned: success
accounts_service_url string	URL for the accounts service. Returned: success
cloud_automation_url string	URL for the cloud automation service. Returned: success
entitlements_service_url string	URL for the entitlements service. Returned: success
events_service_url string	URL for the events service. Returned: success
external_provider_registry_url string	URL for the external provider registry service. Returned: success
metadata_service_url string	URL for the metadata service. Returned: success
order_processing_url string	URL for the order processing service. Returned: success
provisioning_service_url string	URL for the provisioning service. Returned: success
saas_registry_service_url string	URL for the SaaS registry service. Returned: success
grant_type string	The grant type for authentication. Returned: success
sap.cloud.service string	SAP cloud service identifier. Returned: success
uaa dictionary	Details about the UAA (User Account and Authentication). Returned: success
apiurl string	API URL for the UAA service. Returned: success
clientid string	Client ID for authentication. Returned: success
clientsecret string	Client secret for authentication. Returned: success
identityzone string	Identity zone for the UAA service. Returned: success
url string	URL for the UAA service. Returned: success
verificationkey string	Public verification key. Returned: success
name string	The name of the service key. Returned: success
service_instance_guid string	GUID of the service instance. Returned: success
service_instance_url string	URL of the service instance. Returned: success
service_key_parameters_url string	URL for the service key parameters. Returned: success
metadata dictionary	Metadata related to the service key. Returned: success
created_at string	Creation timestamp of the service key. Returned: success
guid string	GUID of the service key. Returned: success
updated_at string	Last update timestamp of the service key. Returned: success
url string	URL of the service key. Returned: success

Authors

• Kirill Satarin (@kksat)