This Ansible Collection provides a set of Ansible Modules designed to automate various low-level activities on SAP systems.
It was originally migrated from repository ansible-collections/community.sap.
| Component | Control Node | Managed Node |
|---|---|---|
| Operating System | Any OS | See compatible OS versions |
| Python | 3.11 or higher | 3.9 or higher |
| Ansible-Core | 2.18 or higher | N/A |
Additional notes:
- Version Compatibility: For a detailed mapping of supported Python versions and Ansible-Core lifecycle, refer to the official Ansible-Core Support Matrix.
- Control Node Permissions: Ensure the user executing the playbooks has the necessary SSH keys and sudo privileges configured for the target environment.
- Managed Node Registration: Operating system needs to have access to required package repositories either directly or via subscription registration.
- Red Hat Enterprise Linux for SAP Solutions: 8.x, 9.x, 10.x
- SUSE Linux Enterprise Server for SAP applications: 15 SP5, 15 SP6, 15 SP7, 16
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.
Python Library pyrfc >= 2.4.0 is required for modules:
sap_companysap_snotesap_task_list_executesap_usersap_pyrfc
Install this collection with Ansible Galaxy command:
ansible-galaxy collection install community.sap_libsInstalled 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 --upgradeYou 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.
The following Ansible Modules are included in this collection.
- sap_hdbsql
- sap_task_list_execute
- sapcar_extract
- sap_company
- sap_snote
- sap_user
- sap_system_facts
- sap_control_exec
- sap_pyrfc
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.
2.18with Python3.11 - 3.132.19with Python3.11 - 3.132.20with Python3.12 - 3.142.21with Python3.12 - 3.14develwith Python3.12 - 3.14
NOTE: Compatibility with 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.
You can find more information about maintainers of this Ansible Collection at MAINTAINERS.md.
We welcome contributions to this collection. For a list of all contributors and information on how you can get involved, please see our CONTRIBUTORS document.
You can report any issues using Issues section.
The release notes for this collection can be found in the CHANGELOG file.
You can find more information at following sources: