avantra.core.server_info module – load server information

Note

This module is part of the avantra.core collection (version 23.0.3).

To install it, use: ansible-galaxy collection install avantra.core.

To use it in a playbook, specify: avantra.core.server_info.

New in avantra.core 23.0.0

Synopsis

  • This module allows to load information about a server from Avantra.

  • The server information can be obtained using the server_name together with a customer_name.

Note

This module has a corresponding action plugin.

Parameters

Parameter

Comments

avantra_api_password

string

The password or API key for the selected Avantra user.

We highly recommend to use Ansible Vaults to protect you sensitive content.

avantra_api_url

string / required

A valid URL pointing to an Avantra UI.

For example https://avantra-ui/xn

avantra_api_user

string

Valid Avantra user principal.

customer_name

string / required

A customer name known by Avantra. Together with server_name it identifies the server.

fail_if_not_found

boolean

Whether the task should fail in case the SAP system can not be found.

Choices:

  • false ← (default)

  • true

server_name

string / required

The name of the server. Together with customer_name it identifies the server.

token

string

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

See Also

See also

Avantra Documentation

The official Avantra documentation.

Examples

Authors

  • Michael Szediwy (@avantra-mis)