Skip to content

module_systems_info.md

Latest commit

 

History

History
162 lines (132 loc) · 4.96 KB

module_systems_info.md

File metadata and controls

162 lines (132 loc) · 4.96 KB
Raw

systems_info Ansible Module

Description

The Ansible Module systems_info queries the SAP Launchpad to retrieve a list of registered systems based on a filter string.

  • It allows for fetching details about systems associated with the authenticated S-User.
  • The OData filter expression allows for precise queries, for example, by installation number, system ID, or product description.

Dependencies

This module requires the following Python modules to be installed on the target node:

  • wheel
  • urllib3
  • requests
  • beautifulsoup4
  • lxml

Execution

Execution Flow

The module follows a straightforward logic flow to retrieve system information.

  1. Authentication:

    • The module authenticates with the provided S-User credentials to establish a valid session with the SAP Launchpad.

  2. System Query:

    • The module makes a GET request to the SAP Systems OData API.
    • It passes the user-provided filter string directly to the API to query for specific systems.

  3. Return Data:

    • The module returns the list of systems that match the filter criteria in the systems key.
    • Each system in the list is a dictionary containing its details.

Example

NOTE: The Python versions in these examples vary by operating system. Always use the version that is compatible with your specific system or managed node.

Get SAP system details using various search filters.

---
- name: Example play for Ansible Module systems_info
  hosts: all
  tasks:
    - name: Get all systems for a specific installation number
      community.sap_launchpad.systems_info:
        suser_id: "Enter SAP S-User ID"
        suser_password: "Enter SAP S-User Password"
        filter: "Insnr eq '1234567890'"
      register: __module_results

    - name: Display system details
      ansible.builtin.debug:
        var: __module_results.systems

    - name: Get a specific system by SID and product description
      community.sap_launchpad.systems_info:
        suser_id: "Enter SAP S-User ID"
        suser_password: "Enter SAP S-User Password"
        filter: "Insnr eq '12345678' and sysid eq 'H01' and ProductDescr eq 'SAP S/4HANA'"
      register: __module_results

Install prerequisites and get SAP system details using existing System Python.
NOTE: Python modules are installed as packages to avoid externally-managed-environment error.

---
- name: Example play for Ansible Module systems_info
  hosts: all
  tasks:
    - name: Install Python and Python package manager pip
      ansible.builtin.package:
        name:
          - python311
          - python311-pip
        state: present

    - name: Install Python module packages
      ansible.builtin.package:
        name:
          - python311-wheel
          - python311-urllib3
          - python311-requests
          - python311-beautifulsoup4
          - python311-lxml
        state: present

    - name: Get all systems for a specific installation number
      community.sap_launchpad.systems_info:
        suser_id: "Enter SAP S-User ID"
        suser_password: "Enter SAP S-User Password"
        filter: "Insnr eq '1234567890'"
      register: __module_results

    - name: Display system details
      ansible.builtin.debug:
        var: __module_results.systems

Install prerequisites and get SAP system details using existing Python Virtual Environment /tmp/python_venv.

---
- name: Example play for Ansible Module systems_info
  hosts: all
  tasks:
    - name: Install Python and Python package manager pip
      ansible.builtin.package:
        name:
          - python311
          - python311-pip
        state: present

    - name: Install Python modules to Python venv
      ansible.builtin.pip:
        name:
          - wheel
          - urllib3
          - requests
          - beautifulsoup4
          - lxml
        virtualenv: "/tmp/python_venv"
        virtualenv_command: "python3.11 -m venv"

    - name: Get all systems for a specific installation number
      community.sap_launchpad.systems_info:
        suser_id: "Enter SAP S-User ID"
        suser_password: "Enter SAP S-User Password"
        filter: "Insnr eq '1234567890'"
      register: __module_results

    - name: Display system details
      ansible.builtin.debug:
        var: __module_results.systems

Output format

systems

  • Type: list of dictionaries

A list of dictionaries, where each dictionary represents an SAP system.
The product version ID may be returned under the 'Version' or 'Prodver' key, depending on the system's age and type.

License

Apache 2.0

Maintainers

Maintainers are shown within /docs/contributors.

Module Variables

suser_id

  • Required: true
  • Type: string

The SAP S-User ID with authorization to get System information.

suser_password

  • Required: true
  • Type: string

The password for the SAP S-User specified in suser_id.

filter

  • Type: string

An OData filter expression to query the systems.