/ home / sap / sap.sap_operations / 1.25.0 / module / saplikey_show_info

sap.sap_operations.saplikey_show_info (1.25.0) — module

Get information about SAP license keys with saplikey program.

| "added in version" 1.8.0-galaxy of sap.sap_operations"

Authors: Kirill Satarin (@kksat)

Install collection

Install with ansible-galaxy collection install sap.sap_operations:==1.25.0

Add to requirements.yml

  collections:
    - name: sap.sap_operations
      version: 1.25.0

Description

Get information about SAP license keys with saplikey program.

This module will execute command C(saplikey -show) and parse its output.

Uses saplikey program to get information about SAP license keys and manage them.

saplikey program is a part of SAP kernel

Requirements

saplikey program should be installed on the target host
Module should be executed on the host where SAP system is installed
Module should be executed with <sid>adm user
Module should be executed with interactive shell, for that additional parameters should be used: become: true become_user: <sid>adm become_flags: '-i' Flag '-i' is very important, module execution will fail without it. This is because saplikey program heavily relies on environment variables provided by SAP profile.

Usage examples

Scanned by Steampunk Spotter

- name: Show all sap license keys
  sap.sap_operations.saplikey_show_info:
  become: true
  become_user: <sid>adm
  become_flags: '-i'

Inputs

    
profile:
    default: DEFAULT.PFL
    description: Profile filename as mentioned in SAP documentation for saplikey program.
    required: false
    type: path

Outputs

license_keys:
  description:
  - The list of installed license keys.
  - Please pay attention that all dates are in format YYYYMMDD.
  - Please pay attention that all numeric values are returned as strings.
  elements: dict
  returned: success
  sample:
  - begin_of_validity: '20230111'
    end_of_validity: '20240712'
    hardware_key: D1111111111
    installation_number: 0
    last_successful_check: '20231016'
    software_product: NetWeaver_SYB
    software_product_limit: '2000000000'
    system_id: AAA
    system_number: '000000000000000000'
    type_of_license_key: permanent
    validity: valid
  - begin_of_validity: '20230111'
    end_of_validity: '20240712'
    hardware_key: D1111111111
    installation_number: 0
    last_successful_check: '00000000'
    software_product: Maintenance_SYB
    software_product_limit: '2000000000'
    system_id: AAA
    system_number: '000000000000000000'
    type_of_license_key: permanent
    validity: valid
  type: list
rc:
  description: Return code of the saplikey program execution.
  returned: always
  sample: 0
  type: int
stderr:
  description: The standard error of the saplikey program execution.
  returned: always
  sample: ''
  type: str
stdout:
  description: The standard output of the saplikey program execution.
  returned: always
  sample: 'SAP License Key Administration  -  Copyright (C) 2003 - 2012 SAP AG


    List of installed License Keys:

    ==========================================


    1. License Key:

    ------------------------------------------

    System                : AAA

    Hardware Key          : D1111111111

    Software Product      : NetWeaver_SYB

    Software Product Limit: 2000000000

    Type of License Key   : permanent

    Installation Number   : 0000000000

    System Number         : 000000000000000000

    Begin of Validity     : 20230111

    End   of Validity     : 20240712

    Last successful check : 00000000

    Validity              : valid


    ------------------------------------------

    1 license keys listed.

    '
  type: str