Community SAP_LIBS Collection

This repository contains the community.sap_libs Ansible Collection. The collection includes modules and plugins supported by the Ansible SAP community to help SAP landscape management.

This collection is migrated from ansbile-collections/community.sap to sap-linuxlab/community.sap_libs.

SAP Module Collection for Ansible

Code of Conduct

We follow the Ansible Code of Conduct in all our interactions within this project.

If you encounter abusive behavior, please refer to the policy violations section of the Code for information on how to raise a complaint.

Communication

We announce releases and important changes through Ansible's The Bullhorn newsletter. Be sure you are subscribed.

Join us in the #ansible (general use questions and support), #ansible-community (community and collection development questions), and other Matrix/LiberaChat IRC channels.

We take part in the global quarterly Ansible Contributor Summit virtually or in-person. Track The Bullhorn newsletter and join us.

For more information about communication, refer to the Ansible Communication guide.

Contributing to this collection

The content of this collection is made by people like you, a community of individuals collaborating on making the world better through developing automation software.

We are actively accepting new contributors.

Any kind of contribution is very welcome.

You don't know how to start? Refer to our contribution guide!

We use the following guidelines:

• CONTRIBUTING.md
• REVIEW_CHECKLIST.md
• Ansible Community Guide
• Ansible Development Guide
• Ansible Collection Development Guide

Collection maintenance

The current maintainers are listed in the MAINTAINERS file. If you have questions or need help, feel free to mention them in the proposals.

To learn how to maintain / become a maintainer of this collection, refer to the Maintainer guidelines.

Governance

The process of decision making in this collection is based on discussing and finding consensus among participants.

Every voice is important. If you have something on your mind, create an issue or dedicated discussion and let's discuss it!

Tested with Ansible and the following Python versions

Tested Ansible versions:

• 2.13
• 2.14
• 2.15
• 2.16
• devel

Tested Python versions:

• 3.6
• 3.7
• 3.8
• 3.9
• 3.10
• 3.11

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.

The test support for Ansible versions 2.9 - 2.12 is disabled due to eol of these versions. The modules may work with these versions but are not tested.

External requirements

For some modules the below requirements are needed on the host that executes a module.

• pyrfc >= 2.4.0
• SAPCAR
• SAPCONTROL

Supported connections

Included content

• Modules:
  • sap_hdbsql
  • sap_task_list_execute
  • sapcar_extract
  • sap_company
  • sap_snote
  • sap_user
  • sap_system_facts
  • sap_control_exec

Using this collection

Installing the Collection from Ansible Galaxy

Before using this collection, you need to install it with the Ansible Galaxy command-line tool:

ansible-galaxy collection install community.sap_libs

You can also include it in a requirements.yml file and install it with ansible-galaxy collection install -r requirements.yml, using the format:

---
collections:
  - name: community.sap_libs

Note that if you install the collection from Ansible Galaxy, it will not be upgraded automatically when you upgrade the ansible package. 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, for example, if you need to downgrade when something is broken in the latest version (please report an issue in this repository). Use the following syntax to install version 1.0.0:

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

See Ansible Using collections for more details.

Release notes

See the changelog.

Releasing, Versioning and Deprecation

This collection follows Semantic Versioning. More details on versioning can be found in the Ansible docs.

We plan to regularly release new minor or bugfix versions once new features or bugfixes have been implemented.

Releasing the current major version happens from the main branch. We will create a stable-1 branch for 1.x.y versions once we start working on a 2.0.0 release, to allow backporting bugfixes and features from the 2.0.0 branch (main) to stable-1.

For reference have a look at the issue Releasing, Versioning and Deprecation.

Roadmap

Please have a look at the project board.

More information

• Ansible Collection overview
• Ansible User guide
• Ansible Developer guide
• Ansible Collections Checklist
• Ansible Community Code of Conduct
• The Bullhorn (the Ansible Contributor newsletter)
• News for Maintainers

Licensing

Apache License, Version 2.0

See LICENSE to see the full text.