avantra.core.server_info (24.0.0) — module

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 server from Avantra.

The server information can be obtained using the C(server_name) together with a C(customer_name).

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

server_name:
    description:
    - The name of the server. Together with C(customer_name) it identifies the server.
    required: true
    type: str

customer_name:
    description:
    - A customer name known by Avantra. Together with C(server_name) it identifies the
      server.
    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

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

See also

• Avantra Documentation: The official Avantra documentation. link