sap.sap_operations.abap_transport_info (1.25.0) — module

Fetch information about transport request from SAP ABAP system

| "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

Fetch information about transport request from SAP ABAP system

Information if fetched from SAP ABAP system using remote enabled RFC CTS_API_READ_CHANGE_REQUEST

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: Collection information about SAP ABAP system
  sap.sap_operations.abap_transport_info:
  transport_request_id: NPLK900002
  rfc_connection:
      ashost: application-instance-hostname
      client: '000'
      user: DDIC
      passwd: "SecretPa$$word"
      sysnr: '00'

Inputs

    
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_id:
    description: Transport request ID
    required: true
    type: str

Outputs

abap_transport_info:
  description: ABAP transport info
  returned: success
  sample:
    CATEGORY: K
    CLIENT: '000'
    DESCRIPTION: SAP_NOTE_IMPL
    MESSAGE: Request NPLK900002 read
    OBJECTS:
    - NAME: NPLK900003 20170221 093250 SNOTE
      OBJECT: RELE
      TABKEY: ''
      TABU_NAME: ''
      VIEW_NAME: ''
    - NAME: SHDB_GET_INDEXES
      OBJECT: FUNC
      TABKEY: ''
      TABU_NAME: ''
      VIEW_NAME: ''
    - NAME: SUMO_RESOLVE_E071_OBJ
      OBJECT: FUNC
      TABKEY: ''
      TABU_NAME: ''
      VIEW_NAME: ''
    - NAME: SDB1FHDB
      OBJECT: REPS
      TABKEY: ''
      TABU_NAME: ''
      VIEW_NAME: ''
    - NAME: 002075125841        0000045863
      OBJECT: CINS
      TABKEY: ''
      TABU_NAME: ''
      VIEW_NAME: ''
    - NAME: 002075125841        0000095848
      OBJECT: CINS
      TABKEY: ''
      TABU_NAME: ''
      VIEW_NAME: ''
    - NAME: 002075125841        0000095849
      OBJECT: CINS
      TABKEY: ''
      TABU_NAME: ''
      VIEW_NAME: ''
    - NAME: 002075125841        0000095850
      OBJECT: CINS
      TABKEY: ''
      TABU_NAME: ''
      VIEW_NAME: ''
    - NAME: 002075125841        0000095901
      OBJECT: CINS
      TABKEY: ''
      TABU_NAME: ''
      VIEW_NAME: ''
    - NAME: 002075125841        0000095902
      OBJECT: CINS
      TABKEY: ''
      TABU_NAME: ''
      VIEW_NAME: ''
    - NAME: '0002344014'
      OBJECT: NOTE
      TABKEY: ''
      TABU_NAME: ''
      VIEW_NAME: ''
    - NAME: 0002401259
      OBJECT: NOTE
      TABKEY: ''
      TABU_NAME: ''
      VIEW_NAME: ''
    OWNER: SNOTE
    RETCODE: '000'
    STATUS: R
  type: dict
abap_transport_info2:
  description: ABAP transport info
  returned: transport_request_id not found
  sample:
    CATEGORY: ''
    CLIENT: ''
    DESCRIPTION: ''
    MESSAGE: Task/request does_not_exist does not exist in system NPL
    OBJECTS: []
    OWNER: ''
    RETCODE: '003'
    STATUS: ''
  type: dict