/ home / sap / sap.sap_operations / 1.25.0 / module / saplikey_get_info

sap.sap_operations.saplikey_get_info (1.25.0) — module

Get host hardware key information and other useful information 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 host hardware key information and other useful information with saplikey program.

This module will execute command C(saplikey -get) 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: Get sap hardware key for the host
  sap.sap_operations.saplikey_get_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

rc:
  description: Return code of the saplikey program execution.
  returned: always
  sample: 0
  type: int
saplikey_get_info:
  contains:
    hardware_key:
      description: The hardware key of the host.
      returned: success
      sample: D1111111111
      type: str
    installation_number:
      description: The installation number of the host.
      returned: success
      sample: 0
      type: str
    release:
      description: The release of the host.
      returned: success
      sample: 749
      type: str
    software_products:
      description: The software products of the host.
      returned: success
      sample: NetWeaver_SYB
      type: str
    system_id:
      description: The system ID of the host.
      returned: success
      sample: AAA
      type: str
    system_number:
      description: The system number of the host.
      returned: success
      sample: 0
      type: str
  description: The parsed output of the saplikey program execution.
  returned: success
  type: dict
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.
  elements: str
  returned: always
  sample:
  - SAP License Key Administration  -  Copyright (C) 2003 - 2012 SAP AG
  - System ID. . . .: AAA
  - Hardware Key . .: D1111111111        (of this computer)
  - Installation No.: 0
  - System No. . . .: 0
  - Release. . . . .: 749
  - Software products: NetWeaver_SYB
  type: list