sap.sap_operations.abap_transport_import (1.25.0) — module

Import transport request

| "added in version" 1.13.0 of sap.sap_operations"

Authors: Gloria Ciavarrini (@gciavarrini), 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

Import transport request

Module uses SAP ABAP system remote enabled RFC CTS_API_IMPORT_CHANGE_REQUEST

Tested only on single system, transport to other systems is not supported

Transport system (trx STMS) must be configured in SAP ABAP system for this module to function properly

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


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Import transport request
  sap.sap_operations.abap_transport_import:
    transport_request_ids:
      - NPLK900002
    client: "000"
    system: NPL
    rfc_connection:
      ashost: application-instance-hostname
      client: "000"
      user: DDIC
      passwd: "SecretPa$$word"
      sysnr: "00"

Inputs

    
client:
    description: SAP ABAP system client
    required: true
    type: str

system:
    description: SAP ABAP system name
    required: true
    type: str

rfc_connection:
    aliases:
    - abap_system
    description:
    - Dictionary with RFC connection parameters and configuration to connect to SAP ABAP
      system
    required: false
    suboptions:
      ashost:
        description: SAP ABAP application instance hostname
        required: false
        type: str
      client:
        default: '000'
        description: SAP ABAP connection client (mandant)
        required: false
        type: str
      group:
        description: SAP ABAP application system connection group (when connected to message
          service)
        required: false
        type: str
      lang:
        choices:
        - SR
        - ZH
        - TH
        - KO
        - RO
        - SL
        - HR
        - MS
        - UK
        - ET
        - AR
        - HE
        - CS
        - DE
        - EN
        - 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
        default: EN
        description: SAP ABAP connection user language
        required: false
        type: str
      mshost:
        description: SAP ABAP application message server hostname
        required: false
        type: str
      msserv:
        description:
        - 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.
        required: false
        type: str
      passwd:
        description:
        - SAP ABAP connection user password
        - This is a no_log parameter - values will not be logged in ansible output
        required: false
        type: str
      return_import_params:
        default: false
        description:
        - 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 I(return_import_params) is set to C(False), parameters of type IMPORT are
          filtered out.
        - 'Setting I(return_import_params) to C(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 I(http_connection).
        type: bool
      rstrip:
        default: true
        description:
        - '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 I(http_connection).
        type: bool
      sysid:
        description: SAP ABAP system id (SID)
        required: false
        type: str
      sysnr:
        description: SAP ABAP application system number
        required: false
        type: str
      trace:
        choices:
        - '0'
        - '1'
        - '2'
        - '3'
        default: '0'
        description:
        - Trace level for NW RFC SDK (0-3)
        required: false
        type: str
      user:
        description: SAP ABAP connection user
        required: false
        type: str
    type: dict

http_connection:
    aliases:
    - abap_system_http
    description:
    - Dictionary with HTTP(s) connection parameters and configuration to connect to SAP
      ABAP system
    required: false
    suboptions:
      client:
        default: '000'
        description: SAP ABAP connection client (mandant)
        required: false
        type: str
      hostname:
        description:
        - SAP ABAP system hostname (to connect via http/https)
        required: true
        type: str
      language:
        choices:
        - SR
        - ZH
        - TH
        - KO
        - RO
        - SL
        - HR
        - MS
        - UK
        - ET
        - AR
        - HE
        - CS
        - DE
        - EN
        - 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
        default: EN
        description: SAP ABAP connection user language
        required: false
        type: str
      password:
        description:
        - SAP ABAP connection user password
        - This is a no_log parameter - values will not be logged in ansible output
        required: false
        type: str
      port:
        default: 443
        description: SAP ABAP http(https) connection port
        required: false
        type: int
      security:
        default: true
        description:
        - Flag to select connection protocol
        - C(True) - https protocol
        - C(False) - http protocol
        required: false
        type: bool
      username:
        description: SAP ABAP connection user
        required: false
        type: str
    type: dict

transport_request_ids:
    description: List of transport request IDs
    elements: str
    required: true
    type: list

Outputs

MESSAGE:
  description: Error Message (if any)
  returned: success
  sample: Request NPLK900002 imported
  type: str
REQUESTS:
  description: List of transport requests with import status
  elements: dict
  returned: success
  sample:
  - REQUEST: NPLK900002
    RETCODE: '000'
  - REQUEST: NPLK900003
    RETCODE: '000'
  type: list
RETCODE:
  description: 'Max return code of all transport requests that were imported

    ''000'' - success, all other codes are errors

    '
  returned: success
  sample: '000'
  type: str