sap.sap_operations.abap_transport_create module – Create transport request in SAP ABAP system

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

New in sap.sap_operations 1.13.0

Synopsis

  • Create transport request in SAP ABAP system

  • Module uses following SAP ABAP system remote enabled RFCs: CTS_API_CREATE_CHANGE_REQUEST CTS_API_READ_CHANGE_REQUEST

  • 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

category

string / required

Transport request category

Choices:

  • "K"

  • "W"

client

string / required

SAP ABAP system client

description

string / required

Transport request description

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 / required

Transport request owner

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

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: Create transport request in SAP ABAP system
  sap.sap_operations.abap_transport_create:
    description: Transport request description
    owner: DDIC
    client: "000"
    category: K
    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_transport_info

dictionary

ABAP transport info for created transport request

Returned: success

Sample: {"CATEGORY": "K", "CLIENT": "000", "DESCRIPTION": "Transport request description", "MESSAGE": "Request NPLK900034 read", "OBJECTS": [], "OWNER": "DDIC", "RETCODE": "000", "STATUS": "D"}

REQUEST

string

ABAP transport request id of created transport request

Returned: success

Sample: "NPLK900034"

RETCODE

string

RFC return code ‘000’ - success, all other codes are errors

Returned: success

Sample: "000"

Authors

  • Gloria Ciavarrini (@gciavarrini)

  • Kirill Satarin (@kksat)