sap.sap_operations.sapjvm role – Manage SAP JVM (download / install / uninstall)

Note

This role 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.

To use it in a playbook, specify: sap.sap_operations.sapjvm.

Entry point __author__ – Author Information

Synopsis

  • Kirill Satarin (@kksat)

Entry point __dependencies__ – Dependencies

Synopsis

  • Role has no dependencies to other roles.

Entry point __examples__ – Example Playbooks

Synopsis

    • name: Test SAP JVM portable installation

  • hosts: all

  • gather_facts: false

  • tasks:

    • name: Make sure that portable SAP JVM present

  • ansible.builtin.include_role:

  • name: sap.sap_operations.sapjvm

  • vars:

  • sapjvm_version: 8.1.097

  • sapjvm_portable: true

Entry point __license__ – License

Synopsis

  • GPL-3.0-only

Entry point __limitations__ – Limitations

Synopsis

  • Only supported on linux and darwin (macos) systems

  • root access required if rpm version is installed, sudo package has to be installed

  • packages required zip, tar (to unpack downloaded archives)

Entry point main – Manage SAP JVM (download / install / uninstall)

Synopsis

  • Manage SAP JVM

  • Role will download SAP JVM binary from tools.hana.ondemand.com

  • Role can install both rpm and portable versions of SAP JVM, see role documentation

  • Portable version is installed via copy of downloaded archive content, removed via removing installation directory

  • RPM version installation requires root access

  • Role will use ansible_facts to determine current host os system and architecture to download correct SAP JVM binary

  • By using this role and downloading SAP software from tools.hana.ondemand.com you accept SAP developer license agreement

  • One can find more details on tools.hana.ondemand.com

Parameters

Parameter

Comments

sapjvm_architecture

string

Architecture that for what SAP JVM will be installed

By default will be determined from ansible_facts

Choices:

  • "x64" ← (default)

  • "ppc64le"

  • "aarch64"

sapjvm_download_destination

path

Folder where SAP JVM binary will be downloaded

Default: "/tmp/sapjvm"

sapjvm_download_filename

string

Filename of downloaded SAP JVM binaries,

By default Filename is {% raw %}sapjvm-{{ sapjvm_version }}-{{ sapjvm_system }}-{{ sapjvm_architecture }}.{{ sapjvm_archive_extension }}{% endraw %}

See definition of variables in defaults/main.yml and vars/main.yml

sapjvm_download_filepath

path

Complete path to file where SAP JVM binary will be downloaded

by default is {% raw %}{{ sapjvm_download_destination }}/{{ sapjvm_download_filename }}{% endraw %}, see other variables

If this is set it will overwrite sapjvm_download_destination and sapjvm_download_filename variable values

sapjvm_download_timeout_seconds

integer

Timeout set for download SAP JVM task

Default: 3600

sapjvm_eula

string

Confirms that you are agree to SAP developer license

Default: "eula_3_2_agreed=tools.hana.ondemand.com/developer-license-3_2.txt"

sapjvm_portable

boolean

If portable version of SAP JVM has to be downloaded and installed / removed

Choices:

  • false ← (default)

  • true

sapjvm_portable_install_destination

path

Folder where SAP JVM binary will be installed, only relevant for portable installations

Default: "/opt/"

sapjvm_portable_uninstall_destination

path

Folder that will be deleted, if SAP JVM portable version is uninstalled

Default: "/opt/sapjvm_8"

sapjvm_state

string

SAP JVM state

Choices:

  • "present" ← (default)

  • "absent"

sapjvm_system

path

SAP JVM is supported on linux, macos, windows. By default role will determine system using ansible_facts.

This variable to overwrite system determined by ansible_facts

Choices:

  • "linux" ← (default)

  • "darwin"

sapjvm_unpack_destination

path

Folder where SAP JVM binary will be unpacked

Default: "/tmp/sapjvm_unpacked"

sapjvm_version

string / required

Version of SAP JVM to download and install

This version must exists on tools.hana.ondemand.com, it does not role will fail