sap.sap_operations.btp_global_account_assignments_info module – Fetches global account assignments information from SAP BTP.

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

New in sap.sap_operations 1.27.0

Synopsis

  • It can filter the results based on whether to include auto-managed plans and/or only entitled services.

  • This action plugin is using SAP BTP API, see <api.sap.com> for more details.

  • This is ansible action plugin, this means it will run on ansible controller, not on managed node.

  • This module fetches global account assignments information from SAP Business Technology Platform (BTP).

  • This plugin does not support running with python 2. It requires python 3.6 or higher.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 3.6

  • requests

  • oauth2_client

Parameters

Parameter

Comments

api_endpoint

string / required

API endpoint to use. For example https://api.cf.eu10.hana.ondemand.com

authorize_service_url

string / required

URL of the authorization service.

client_id

string / required

Client ID to use for authentication.

client_secret

string / required

Client secret to use for authentication.

entitled_services_only

boolean

Whether to fetch information for only those services that the account is entitled to.

Choices:

  • false

  • true ← (default)

include_auto_managed_plans

boolean

Whether to include auto-managed plans in the fetched information.

Choices:

  • false

  • true ← (default)

login

string / required

Login to use for authentication. This is usually an email address.

password

string / required

Password to use for authentication.

token_service_url

string / required

URL of the token service.

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.

See Also

See also

SAP BTP API Accounts service API

SAP BTP API Accounts service API

Administration and operations section for SAP BTP on help.sap.com

Administration and operations section for SAP BTP on help.sap.com

Examples

---
- name: Fetch global account assignments information including auto-managed plans and entitled services only
  sap.sap_operations.btp_global_account_info:
    include_auto_managed_plans: true
    entitled_services_only: true

- name: Fetch global account assignments information excluding auto-managed plans
  sap.sap_operations.btp_global_account_info:
    include_auto_managed_plans: false
    entitled_services_only: true

- name: Fetch global account assignments information for all services, including those not entitled
  sap.sap_operations.btp_global_account_info:
    include_auto_managed_plans: true
    entitled_services_only: false

Authors

  • Kirill Satarin (@kksat)