sap.sap_operations.sapcar role – Role to manage sapcar

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

Entry point __author__ – Author Information

Synopsis

  • Kirill Satarin (@kksat)

Entry point __dependencies__ – Dependencies

Synopsis

  • Role has no dependencies to other roles.

Entry point __license__ – License

Synopsis

  • GPL-3.0-only

Entry point __limitations__ – Limitations

Synopsis

  • Username has to be email of SAP UID with only one Suser assigned. If more than one Suser is assigned to UID download will fail.

Entry point main – Role to manage sapcar

Synopsis

  • Role to manage sapcar binary

Parameters

Parameter

Comments

sapcar_download_destination

path

Path there sapcar binary will be downloaded (in case of sapcar_state=’present’)

Role will ensure that this folder exists

Default: "/tmp/sapcar_download_destination"

sapcar_download_password

string / required

Password of provided username that will be used to download software By default value is from collection variable `sap_operations_download_password`. Collection variable `sap_operations_download_password` default value is set to environment variable SAP_OPERATIONS_DOWNLOAD_PASSWORD

sapcar_download_username

string / required

Username (sap support user, suser) that will be used to download software. By default value is from collection variable `sap_operations_download_username`. Collection variable `sap_operations_download_username` default value is set to environment variable SAP_OPERATIONS_DOWNLOAD_USERNAME

sapcar_exe_path

path

Path to sapcar executable file

Default value is from collection variable sap_operations_sapcar_exe_path

All parent directories to directory where sapcar executable should be located should exists and be writable for ansible user

Role will not create /usr/sap directory and will not set owner and mode for this

Default path is in /usr/sap, role expects that /usr/sap is present and writable for user the role is executed with, otherwise role will fail

As part of the role execution parent directory for sapcar_exe_path will be created

Default: "/usr/sap/sapcar/sapcar"

sapcar_mode

string

Permissions mode that will be used for all folders that are created by the role (sapcar_download_destination and sapcar_exe_path) and sapcar executable destination sapcar_exe_path

Default: "0755"

sapcar_owner

string

Owner that will be used for all folders that are created by the role (sapcar_download_destination and sapcar_exe_path) and sapcar executable destination sapcar_exe_path

By default is set to omit special variable - meaning current ansible_user will be used as owner

sapcar_patch_level

string

Patch level that will be downloaded and installed if sapcar_state=’present’

sap.sap_operations.download role will be used to download sapcar binaries

sap.sap_operations.download role by default will download patch level with latest ReleaseDate, see download role documentation

This makes this role quasi idempotent if sapcar_patch_level is not set explicitly - later version of sapcar might be downloaded and installed if role executed in different times

Should be exact patch level available for current sapcar_version, see documentation for sap.sap_operations.download role, otherwise nothing will be downloaded and installed.

In case there is no such patch level for selected sapcar version, download list will be empty and role will fail

Default: ""

sapcar_state

string

State for sapcar executable

present - role will ensure that executable will downloaded and installed (copied to sapcar_exe_path)

present - will do any changes only if file sapcar_exe_path does not exists

absent - role will ensure that file at sapcar_exe_path is absent, containing directory will not be removed

Choices:

  • "present" ← (default)

  • "absent"

sapcar_version

string

Sapcar version that has to be downloaded and installed

By default will be automatically calculated as highest version available among all sapcar versions from sap.sap_operations.me_aliases filter