community.sap_libs Ansible Collection

Description

This Ansible Collection provides a set of Ansible Modules designed to automate various operations on SAP systems.

It was migrated from repository ansible-collections/community.sap.

Requirements

Some modules have external dependencies.

SAPCAR binaries are required for:
- sapcar_extract
Python Library pyrfc >= 2.4.0 is required for:
- sap_company
- sap_snote
- sap_task_list_execute
- sap_user
- sap_pyrfc

Important: PyRFC dependency is deprecated

SAP has discontinued development on PyRFC in 2024.
You can find more details in the announcement or in deprecation notice.

The PyRFC library is a critical dependency for several modules in this collection, as it is a Python wrapper for the SAP NW RFC SDK libraries. While both PyRFC and the SAP NW RFC SDK are still available for installation and download at this time, their deprecation means they could be removed without notice.

We will continue to support the modules that depend on PyRFC for as long as both the PyRFC library and the SAP NW RFC SDK remain available. However, the moment either of them becomes unavailable, we will be forced to cease support for these modules, as they will no longer be functional.

We are investigating potential alternatives, but there is no clear path forward at this time. Users should be aware of this risk when using the affected modules.

Installation Instructions

Installation

Install this collection with Ansible Galaxy command:

ansible-galaxy collection install community.sap_libs

Upgrade

Installed Ansible Collection will not be upgraded automatically when Ansible package is upgraded.

To upgrade the collection to the latest available version, run the following command:

ansible-galaxy collection install community.sap_libs --upgrade

You can also install a specific version of the collection, when you encounter issues with latest version. Please report these issues in affected Role repository if that happens. Example of downgrading collection to version 1.4.0:

ansible-galaxy collection install community.sap_libs:==1.4.0

See Installing collections for more details on installation methods.

Ansible Modules

The following Ansible Modules are included in this collection.

Testing

This Ansible Collection was tested across different versions of Ansible and Python.
The automated CI workflow is executing Sanity and Unit tests on following versions.

Supported ansible-core versions:

2.18 with Python 3.11 - 3.13
2.19 with Python 3.11 - 3.13
devel with Python 3.11 - 3.13

End-of-life ansible-core versions are only tested for backwards compatibility.

2.14 with Python 3.9 - 3.11
2.15 with Python 3.9 - 3.11
2.16 with Python 3.10 - 3.12
2.17 with Python 3.10 - 3.12

Support for Python 2 has been dropped in release 1.5.0.

Due to SAP licensing and hardware requirements, integration tests are momentarily not feasible.
The modules are tested manually against SAP systems until we found a solution or have some modules where we are able to execute integration test we decided to disable these tests.

NOTE: All tests combinations were configured following official ansible-core-support-matrix.

Maintainers

You can find more information about maintainers of this Ansible Collection at MAINTAINERS.md.

Contributing

You can find more information about ways you can contribute at sap-linuxlab website.

Support

You can report any issues using Issues section.

Release Notes and Roadmap

The release notes for this collection can be found in the CHANGELOG file.

Further Information

Additional sources

You can find more information at following sources:

License

Apache 2.0