sap.sap_operations.abap_transports_info module – Fetch transport requests from SAP ABAP system based on search criteria

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_transports_info.

New in sap.sap_operations 1.13.0

Synopsis

  • Fetch transport requests from SAP ABAP system based on search criteria

  • Information if fetched from SAP ABAP system using remote enabled RFC CTS_WBO_API_READ_REQUESTS_RFC

  • 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

attributes_keys

list / elements=string

List of attributes keys to read

Default: []

category

string

Transport request category ‘K’ = Workbench ‘W’ = Customizing ‘*’ = any category

Choices:

  • "K"

  • "W"

  • "*" ← (default)

client

aliases: mandant

string

SAP ABAP system client If not provided, current client (mandant) will be used.

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

owner

string

Transport request owner If not provided, current user will be used. Use ‘*’ to search for all owners.

read_attributes

boolean

If true read attributes of transport request

Choices:

  • false ← (default)

  • true

read_task_headers

boolean

If true read task headers of transport request

Choices:

  • false ← (default)

  • true

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

target_system

string

Target system

Default: "*"

transport_status

string

Transport request status ‘D’ = Changeable (including ‘L’) ‘R’ = Released (including ‘O’) ‘*’ = all statuses (default)

Choices:

  • "R"

  • "D" ← (default)

  • "*"

Notes

Note

  • This module is community supported

  • Module interface (parameters, output) expected to be stable but not guaranteed

  • Module planned to be released on Ansible Automation Hub after collecting some feedback

  • There is no guarantee that this module will be officially supported by Red Hat

Examples

- name: Find all my transport requests in current system and client that are in changeable status
  sap.sap_operations.abap_transports_info:
  rfc_connection:
      ashost: application-instance-hostname
      client: '000'
      user: DDIC
      passwd: "SecretPa$$word"
      sysnr: '00'

- name: Find all my transport requests in current system and client that are released
  sap.sap_operations.abap_transports_info:
  transport_status: R
  rfc_connection:
      ashost: application-instance-hostname
      client: '000'
      user: DDIC
      passwd: "SecretPa$$word"
      sysnr: '00'

Return Values

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

Key

Description

abap_transports_info

list / elements=dictionary

List of transport requests with information about them

Returned: success

Sample: {"REQUESTS": [{"REQ_ATTRS": [], "REQ_HEADER": {"AS4DATE": "20230405", "AS4TEXT": "Workbench Request Config. Task Manager", "AS4TIME": "182918", "AS4USER": "DDIC", "CLIENT": "001", "TARSYSTEM": "", "TRFUNCTION": "K", "TRKORR": "NPLK900022", "TRSTATUS": "D"}, "TASK_HEADERS": [{"AS4DATE": "20230405", "AS4TEXT": "Workbench Request Config. Task Manager", "AS4TIME": "182919", "AS4USER": "DDIC", "TRFUNCTION": "X", "TRKORR": "NPLK900023", "TRSTATUS": "D"}]}, {"REQ_ATTRS": [], "REQ_HEADER": {"AS4DATE": "20231214", "AS4TEXT": "test", "AS4TIME": "130602", "AS4USER": "DDIC", "CLIENT": "001", "TARSYSTEM": "", "TRFUNCTION": "W", "TRKORR": "NPLK900062", "TRSTATUS": "D"}, "TASK_HEADERS": [{"AS4DATE": "20231214", "AS4TEXT": "test", "AS4TIME": "130611", "AS4USER": "DDIC", "TRFUNCTION": "Q", "TRKORR": "NPLK900063", "TRSTATUS": "D"}]}]}

Authors

  • Gloria Ciavarrini (@gciavarrini)

  • Kirill Satarin (@kksat)