sap.sap_operations.cf_service_instance_key (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 allows managing service instance keys in Cloud Foundry

It can create or delete service instance keys based on the state provided

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: Create a service instance key
  sap.sap_operations.cf_service_instance_key:
    username: "admin"
    password: "password"
    api_endpoint: "https://api.example.com"
    service_instance_name: "my-service-instance"
    key_name: "my-service-key"
    state: "present"

Scanned by Steampunk Spotter

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

- name: Delete a service instance key
  sap.sap_operations.cf_service_instance_key:
    username: "admin"
    password: "password"
    api_endpoint: "https://api.example.com"
    service_instance_guid: "12345678-1234-1234-1234-123456789012"
    key_name: "my-service-key"
    state: "absent"

Inputs

    
state:
    choices:
    - present
    - absent
    default: present
    description:
    - The desired state of the service instance key.
    required: false
    type: str

key_name:
    aliases:
    - service_instance_key_name
    description:
    - The name of the service instance key to manage.
    required: true
    type: str

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

service_instance_guid:
    description:
    - The GUID of the service instance for which to manage keys.
    required: false
    type: str

service_instance_name:
    description:
    - The name of the service instance for which to manage keys.
    required: false
    type: str

Outputs

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