sap.sap_operations.abap_transports_info (1.25.0) — module

Fetch transport requests from SAP ABAP system based on search criteria

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

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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'
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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'

Inputs

    
owner:
    description: 'Transport request owner

      If not provided, current user will be used.

      Use ''*'' to search for all owners.

      '
    required: false
    type: str

client:
    aliases:
    - mandant
    description: 'SAP ABAP system client

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

      '
    required: false
    type: str

category:
    choices:
    - K
    - W
    - '*'
    default: '*'
    description: 'Transport request category

      ''K'' = Workbench

      ''W'' = Customizing

      ''*'' = any category

      '
    required: false
    type: str

target_system:
    default: '*'
    description: Target system
    required: false
    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

attributes_keys:
    default: []
    description: List of attributes keys to read
    elements: str
    required: false
    type: list

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

read_attributes:
    default: false
    description: If true read attributes of transport request
    required: false
    type: bool

transport_status:
    choices:
    - R
    - D
    - '*'
    default: D
    description: 'Transport request status

      ''D'' = Changeable (including ''L'')

      ''R'' = Released (including ''O'')

      ''*'' = all statuses (default)

      '
    required: false
    type: str

read_task_headers:
    default: false
    description: If true read task headers of transport request
    required: false
    type: bool

Outputs

abap_transports_info:
  description: 'List of transport requests with information about them

    '
  elements: dict
  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
  type: list