sap.sap_operations.abap_system_info module – Fetch SAP ABAP system information

Note

This module is part of the sap.sap_operations collection.

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install sap.sap_operations. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: sap.sap_operations.abap_system_info.

New in sap.sap_operations 1.2.0

Synopsis

  • Fetch information about SAP ABAP system

  • Information if fetched from SAP ABAP system using following remote enabled RFCs OCS_GET_INSTALLED_SWPRODUCTS OCS_GET_SFW_COMPONENTS TH_GET_VIRT_HOST_DATA DELIVERY_GET_INSTALLED_COMPS SMLG_GET_DEFINED_GROUPS SMLG_GET_DEFINED_SERVERS SMLG_GET_SETUP SLDAG_GET_COMPUTER_INFO

  • Uses NWRFC binary to connect to SAP and call remote enabled RFCs.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter

Comments

http_connection

aliases: abap_system_http

dictionary

Dictionary with HTTP(s) connection parameters and configuration to connect to SAP ABAP system

client

string

SAP ABAP connection client (mandant)

Default: "000"

hostname

string / required

SAP ABAP system hostname (to connect via http/https)

language

string

SAP ABAP connection user language

Choices:

  • "SR"

  • "ZH"

  • "TH"

  • "KO"

  • "RO"

  • "SL"

  • "HR"

  • "MS"

  • "UK"

  • "ET"

  • "AR"

  • "HE"

  • "CS"

  • "DE"

  • "EN" ← (default)

  • "FR"

  • "EL"

  • "HU"

  • "IT"

  • "JA"

  • "DA"

  • "PL"

  • "ZF"

  • "NL"

  • "NO"

  • "PT"

  • "SK"

  • "RU"

  • "ES"

  • "TR"

  • "FI"

  • "SV"

  • "BG"

  • "LT"

  • "LV"

  • "Z1"

  • "AF"

  • "IS"

  • "CA"

  • "SH"

  • "ID"

  • "HI"

  • "KK"

  • "VI"

password

string

SAP ABAP connection user password

This is a no_log parameter - values will not be logged in ansible output

port

integer

SAP ABAP http(https) connection port

Default: 443

security

boolean

Flag to select connection protocol

True - https protocol

False - http protocol

Choices:

  • false

  • true ← (default)

username

string

SAP ABAP connection user

rfc_connection

aliases: abap_system

dictionary

Dictionary with RFC connection parameters and configuration to connect to SAP ABAP system

ashost

string

SAP ABAP application instance hostname

client

string

SAP ABAP connection client (mandant)

Default: "000"

group

string

SAP ABAP application system connection group (when connected to message service)

lang

string

SAP ABAP connection user language

Choices:

  • "SR"

  • "ZH"

  • "TH"

  • "KO"

  • "RO"

  • "SL"

  • "HR"

  • "MS"

  • "UK"

  • "ET"

  • "AR"

  • "HE"

  • "CS"

  • "DE"

  • "EN" ← (default)

  • "FR"

  • "EL"

  • "HU"

  • "IT"

  • "JA"

  • "DA"

  • "PL"

  • "ZF"

  • "NL"

  • "NO"

  • "PT"

  • "SK"

  • "RU"

  • "ES"

  • "TR"

  • "FI"

  • "SV"

  • "BG"

  • "LT"

  • "LV"

  • "Z1"

  • "AF"

  • "IS"

  • "CA"

  • "SH"

  • "ID"

  • "HI"

  • "KK"

  • "VI"

mshost

string

SAP ABAP application message server hostname

msserv

string

SAP ABAP message server service

msserv is needed only, if the service of the message server is not defined as sapms<SYSID> in /etc/services.

passwd

string

SAP ABAP connection user password

This is a no_log parameter - values will not be logged in ansible output

return_import_params

boolean

Importing parameters of RFC call are returned by the RFC call

Usually, you do not need the IMPORT parameters in the result of Connection.call().

If return_import_params is set to False, parameters of type IMPORT are filtered out.

Setting return_import_params to True is only recommended for debugging purposes. This will change return values of all NW RFC modules.

There is no equivalent parameter when connecting via HTTP(s), see http_connection.

Choices:

  • false ← (default)

  • true

rstrip

boolean

ABAP allows two different ways to store strings A fixed length string type C and a dynamic length string type STRING.

Strings of type C are padded with blanks, if the content is shorter than the predefined length.

In order to unify the connectors behavior regarding strings, the rstrip option was introduced.

If set to True, all strings are right-stripped before being returned by an RFC call.

See <http://sap.github.io/PyRFC/client.html>

There is no equivalent parameter when connecting via HTTP(s), see http_connection.

Choices:

  • false

  • true ← (default)

sysid

string

SAP ABAP system id (SID)

sysnr

string

SAP ABAP application system number

trace

string

Trace level for NW RFC SDK (0-3)

Choices:

  • "0" ← (default)

  • "1"

  • "2"

  • "3"

user

string

SAP ABAP connection user

Examples

- name: Collection information about SAP ABAP system
  sap.sap_operations.abap_system_info:
  rfc_connection:
    ashost: application-instance-hostname
    client: '000'
    user: DDIC
    passwd: "SecretPa$$word" # notsecret
    sysnr: '00'

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

abap_system_info

dictionary

ABAP system info

Returned: success

computer_info

dictionary

Computer info

Returned: success

IP_ADDRESS

string

IP address

Returned: success

Sample: "10.0.0.234"

IP_ADDRESSES

list / elements=dictionary

List of IP addresses

Returned: success

Sample: [{"VALUE": "127.0.0.1"}, {"VALUE": "10.0.0.234"}]

VALUE

string

IP address

Returned: success

LOCALHOST

string

Local hostname

Returned: success

Sample: "vhcalnplci"

LOCALHOSTFULL

string

Local FQDN

Returned: success

Sample: "vhcalnplci.dummy.nodomain"

OPSYS

string

operating system

Returned: success

Sample: "Linux"

OPSYS_BITS

string

Operating system bits

Returned: success

Sample: ""

OPSYS_RELEASE

string

Operating system release

Returned: success

Sample: "4.12.14-197.102-default"

PHYS_RAM

string

Physical RAM in MB

Returned: success

Sample: "32161"

host_data

dictionary

Host data

Returned: success

HOSTNAME

string

Hostname

Returned: success

Sample: "vhcalnplci.dummy.nodomain"

PORT

string

Port configured for web services

Returned: success

Sample: "8000"

installed_components

dictionary

Installed components

Returned: success

TT_COMPTAB

list / elements=dictionary

Installed components

Returned: success

Sample: [{"COMPONENT": "SAP_BASIS", "COMP_TYPE": "S", "DESC_TEXT": "SAP Basis Component", "EXTRELEASE": "0002", "LANGU": "E", "RELEASE": "751"}, {"COMPONENT": "SAP_BW", "COMP_TYPE": "W", "DESC_TEXT": "SAP Business Warehouse", "EXTRELEASE": "0002", "LANGU": "E", "RELEASE": "751"}, {"COMPONENT": "SAP_GWFND", "COMP_TYPE": "S", "DESC_TEXT": "SAP Gateway Foundation", "EXTRELEASE": "0000000002", "LANGU": "E", "RELEASE": "751"}]

COMP_TYPE

string

Component type

Returned: success

Sample: "S"

COMPONENT

string

Component code

Returned: success

Sample: "SAP_ABA"

DESC_TEXT

string

Component description

Returned: success

Sample: "Cross-Application Component"

EXTRELEASE

string

Component release SP level

Returned: success

Sample: "0002"

LANGU

string

Language

Returned: success

Sample: "E"

RELEASE

string

Component release

Returned: success

Sample: "751"

installed_components_ocs

dictionary

Installed components

Returned: success

ET_COMPLAYER

list / elements=dictionary

Component layers

Returned: success

Sample: [{"COMP_TYPE": "S", "LAYER_DESC": "NetWeaver Basis Components", "LAYER_LVL": "01", "MODEL_ID": "0000000751"}, {"COMP_TYPE": "X", "LAYER_DESC": "NetWeaver PlugIns", "LAYER_LVL": "02", "MODEL_ID": "0000000751"}, {"COMP_TYPE": "W", "LAYER_DESC": "NetWeaver Add-Ons", "LAYER_LVL": "03", "MODEL_ID": "0000000751"}]

COMP_TYPE

string

Component type

Returned: success

Sample: "['V', 'R', 'P', 'X', 'W']"

LAYER_DESC

string

Layer description

Returned: success

Sample: "Application Platform Components"

LAYER_LVL

string

Layer level

Returned: success

Sample: "04"

MODEL_ID

string

Model ID

Returned: success

Sample: "0000000751"

ET_COMPONENTS

list / elements=dictionary

Installed components

Returned: success

Sample: [{"ACTIVE": "X", "COMPONENT": "SAP_BASIS", "COMP_TYPE": "S", "DESC_TEXT": "SAP Basis Component", "INCMPL_STP": "", "INCMPL_STPLVL": "0000", "MAINT_TYPE": "S", "MASTERCOMP": "", "MASTERREL": "", "PATCHABLE": "X", "RELEASE": "751", "SFW_STATUS": "N", "SP": "SAPK-75102INSAPBASIS", "SPP": "", "SPP_LEVEL": "0000", "SP_LEVEL": "0002", "SUBCOMP_STATUS": ""}, {"ACTIVE": "X", "COMPONENT": "SAP_ABA", "COMP_TYPE": "S", "DESC_TEXT": "Cross-Application Component", "INCMPL_STP": "", "INCMPL_STPLVL": "0000", "MAINT_TYPE": "S", "MASTERCOMP": "", "MASTERREL": "", "PATCHABLE": "X", "RELEASE": "751", "SFW_STATUS": "N", "SP": "SAPK-75102INSAPABA", "SPP": "", "SPP_LEVEL": "0000", "SP_LEVEL": "0002", "SUBCOMP_STATUS": ""}]

ACTIVE

string

Active flag

Returned: success

Sample: "X"

COMP_TYPE

string

Component type

Returned: success

Sample: "S"

COMPONENT

string

Component code

Returned: success

Sample: "SAP_GWFND"

DESC_TEXT

string

Component text description

Returned: success

Sample: "SAP Gateway Foundation"

INCMPL_STP

string

Service pack text description

Returned: success

Sample: ""

INCMPL_STPLVL

string

Service pack level

Returned: success

Sample: "0000"

MAINT_TYPE

string

Maintenance type

Returned: success

Sample: "P"

MASTERCOMP

string

Master component

Returned: success

Sample: ""

MASTERREL

string

Master release

Returned: success

Sample: ""

PATCHABLE

string

Patchable

Returned: success

Sample: "X"

RELEASE

string

Release

Returned: success

Sample: "751"

SFW_STATUS

string

Software status

Returned: success

Sample: "N"

SP

string

Service pack

Returned: success

Sample: "SAPK-75102INSAPGWFND"

SP_LEVEL

string

Software level

Returned: success

Sample: "0002"

SPP

string

Software patch

Returned: success

Sample: ""

SPP_LEVEL

string

Software patch

Returned: success

Sample: "0000"

SUBCOMP_STATUS

string

Subcomponent status

Returned: success

Sample: ""

ET_CPK

list / elements=dictionary

Components table

Returned: success

Sample: []

ET_CVERS_SUB

list / elements=dictionary

Versions table

Returned: success

Sample: []

TT_COMPTAB

list / elements=dictionary

List of components

Returned: success

Sample: [{"COMPONENT": "SAP_BASIS", "COMP_TYPE": "S", "DESC_TEXT": "SAP Basis Component", "EXTRELEASE": "0002", "LANGU": "E", "RELEASE": "751"}, {"COMPONENT": "SAP_ABA", "COMP_TYPE": "S", "DESC_TEXT": "Cross-Application Component", "EXTRELEASE": "0002", "LANGU": "E", "RELEASE": "751"}, {"COMPONENT": "SAP_GWFND", "COMP_TYPE": "S", "DESC_TEXT": "SAP Gateway Foundation", "EXTRELEASE": "0002", "LANGU": "E", "RELEASE": "751"}]

COMP_TYPE

string

Component type

Returned: success

Sample: "S"

COMPONENT

string

Component

Returned: success

Sample: "SAP_UI"

DESC_TEXT

string

Description text

Returned: success

Sample: "User Interface Technology"

EXTRELEASE

string

External release

Returned: success

Sample: "0002"

LANGU

string

Language

Returned: success

Sample: "E"

RELEASE

string

Release

Returned: success

Sample: "751"

smlg_groups

dictionary

SMLG groups

Returned: success

Sample: {"GROUPS": [{"GROUPNAME": "PUBLIC"}]}

smlg_servers

dictionary

SMLG servers

Returned: success

Sample: {"INSTANCES": [{"APPLSERVER": "vhcalnplci_NPL_00"}]}

smlg_setup

dictionary

SMLG setup

Returned: success

Sample: {"ERFC_SETUP": [], "SETUP": [{"APPLSERVER": "vhcalnplci_NPL_00", "CLASSNAME": "PUBLIC", "GROUPTYPE": "", "IPV6": "", "IPV6_ADDRESS": "", "IPV6_ADDRESS_OLD": "", "IP_ADDRESS": "", "IP_ADDRESS_OLD": "", "OP_MODE": "", "RESP_TIME": "000000", "USERS": "0000", "WP_QUOTA": 0}]}

software_components

dictionary

Software components

Returned: success

Sample: {"ET_ACTIVE_BFUNCS": [], "ET_BSET_COMP_MAPPING": [], "ET_SFW_COMPS": []}

swproducts

dictionary

Software products

Returned: success

Sample: {"ET_INCL_SWFEATURES": [{"DESCRIPT": "Application Server ABAP", "ID": "1", "MASTER_ID": "2", "MASTER_PRD": "73555000100900000781", "NAME": "NW AS ABAP INNOVATION PACKAGE", "PROD_ID": "73555000100900000781", "VENDOR": "sap.com", "VERSION": "7.51"}], "ET_SWFEATURES": [{"DESCRIPT": "Application Server ABAP", "ID": "1", "NAME": "NW AS ABAP INNOVATION PACKAGE", "PROD_ID": "73555000100900000781", "VENDOR": "sap.com", "VERSION": "7.51"}, {"DESCRIPT": "Basis Apps", "ID": "2", "NAME": "NW AS ABAP INNOVATION PACKAGE", "PROD_ID": "73555000100900000781", "VENDOR": "sap.com", "VERSION": "7.51"}], "ET_SWPRODUCTS": [{"DESCRIPT": "NW AS ABAP 7.51 INNOVATION PKG", "ID": "73555000100900000781", "NAME": "NW AS ABAP INNOVATION PACKAGE", "VENDOR": "sap.com", "VERSION": "7.51"}], "ET_SWPROD_SPSTACK": [{"ID": "73555000103300002362", "PROD_DESCR": "NW AS ABAP 7.51 INNOVATION PKG", "PROD_ID": "73555000100900000781", "PROD_NAME": "NW AS ABAP INNOVATION PACKAGE", "PROD_VERSION": "7.51", "STACK_CAPTION": "02 (05/2017)", "VENDOR": "sap.com"}], "ET_TECH_USAGES": []}

Authors

  • Gloria Ciavarrini (@gciavarrini)

  • Kirill Satarin (@kksat)