/ home / avantra / avantra.core / 24.0.0 / module / sapsystem_info

avantra.core.sapsystem_info (24.0.0) — module

load SAP system information

| "added in version" 23.0.0 of avantra.core"

Authors: Michael Szediwy (@avantra-mis)

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install avantra.core:==24.0.0

Add to requirements.yml

  collections:
    - name: avantra.core
      version: 24.0.0

Description

This module allows to load information about a SAP system from Avantra. The SAP system information can be obtained using the B(Unified SAP SID) together with a customer name.

Usage examples

Scanned by Steampunk Spotter

# Find a SAP system given its unified SAP SID and a customer name
- name: Get SAP system AVA_DBG
  avantra.core.sapsystem_info:
    unified_sap_sid: AVA_DBG
    customer_name: "My Customer"

Scanned by Steampunk Spotter

# Fail if the SAP system can not be found
- name: Get SAP system AVA_DBG
  avantra.core.sapsystem_info:
    unified_sap_sid: AVA_DBG
    customer_name: "My Customer"
    fail_if_not_found: true

Inputs

    
token:
    description: 'The token used to authenticate during the task execution. A token can
      be fetched with the M(avantra.core.login) module. If I(token) is defined I(avantra_api_user)
      and I(avantra_api_password) are not necessary.

      '
    required: false
    type: str

customer_name:
    description:
    - A customer name known by Avantra. Together with C(unified_sap_sid) it identifies
      the SAP system.
    required: true
    type: str

avantra_api_url:
    description:
    - A valid URL pointing to an Avantra UI.
    - For example C(https://avantra-ui/xn)
    required: true
    type: str

unified_sap_sid:
    description:
    - The Unified SAP SID of the SAP system. Together with C(customer_name) it identifies
      the SAP system.
    required: true
    type: str

avantra_api_user:
    description:
    - Valid Avantra user principal.
    required: false
    type: str

fail_if_not_found:
    default: false
    description:
    - Whether the task should fail in case the SAP system can not be found.
    required: false
    type: bool

avantra_api_password:
    description:
    - The password or API key for the selected Avantra user.
    - We highly recommend to use Ansible Vaults to protect you sensitive content.
    required: false
    type: str

Outputs

sap_system:
  description:
  - If the SAP system can be identified the system information is returned.
  returned: present
  type: dict

See also

Avantra Documentation: The official Avantra documentation. link