IBM Support

MustGather - IBM i Remote System Execution (RSE) REST APIs in ADMIN5

Troubleshooting


Problem

This document will provide information on what data to gather when experiencing issues communicating with the ADMIN5 application server on the IBM i OS and calling the IBM i Remote System Execution (RSE) REST APIs running in the ADMIN5 application server.  The IBM i RSE REST APIs are called by the IBM i Merlin IDE when communicating with the IBM i OS.

Symptom

Issues communicating with HTTPS port 2012 on the IBM i OS

Environment

IBM i
ADMIN5 Application Server

Resolving The Problem

Gather the following data when experiencing issues with the IBM i Remote System Execution (RSE) REST APIs running in the ADMIN5 application server on the iBM i OS.  The ADMIN5 application server and RSE REST APIs are made available via HTTPS port 2012 to the IBM i Merlin IDE application.
 
NOTE:  It is important to gather the TRCCNN TCP/IP and REST API ADMIN5 traces at the same time in order to correlate the data.
TRCCNN TCP/IP Trace
A TCP/IP trace can be gathered between the IBM i and IBM i Merlin IDE application.  The TCP/IP trace will help identify any communication or TLS handshake issues.

1) TRCCNN SET(*ON) TRCTYPE(*IP) TRCTBL(IBM) SIZE(250000) TCPDTA(*TCP (2012) ())
NOTE:  Port 2012 is the HTTPS port for the ADMIN5 application server.
2) Recreate the issue.
3) TRCCNN SET(*OFF) TRCTBL(IBM) OUTPUT(*STMF) TOSTMF('/tmp/TRCCNN.cap' *YES)
Then, gather and upload the /tmp/TRCCNN.cap file.
 
Remote System Execution (RSE) REST API Trace in the ADMIN5 Application Server
1. Open the IBM Web Administration for i console by executing the following URL in your preferred Web browser:

http://<serverName>:2001/HTTPAdmin

2. Select Manage -> Application Servers from the tabs in the top, left-hand corner of the console. Then, select ADMIN5 from the drop-down list next to the Server field.

image-20220615114737-1

3. On the left-hand, vertical menu bar under Server Properties; click on the Logging link.

image-20220615114923-2

4.  Click on the Server Logging tab.
5. Change the Maximum log file size to 30 and the Maximum number of log files to 10.
6. Replace the Trace specification value with the string:

IBMiRSEAPI=all

image-20220615115239-3

7. Click the OK button to save the changes.
8. Restart the ADMIN5 application server instance to enable the tracing. This can be done by clicking on the Stop button button to stop the server and the Start button button to start the server.  You can also use the following CL commands from a 5250 emulator session.

ENDTCPSVR SERVER(*IAS) INSTANCE(ADMIN5)
STRTCPSVR SERVER(*IAS) INSTANCE(ADMIN5)

9.  Recreate the issue.

OPTIONAL - IBM Toolbox for Java Driver Trace

NOTE:  This trace is only required when directed by IBM Support.  This will trace the IBM i Host Server Communications performed by the Remote System Execution API application (IBMiRSEAPI) running in the ADMIN5 application server.

1.  WRKLNK '/QIBM/UserData/OS/ADMININST/admin5/wlp/usr/servers/admin5/jvm.options'
2.  Option 2 to edit the file.
3.  Add the JVM arguments each on a new line.
-Dcom.ibm.as400.access.Trace.category=all
-Dcom.ibm.as400.access.Trace.file=/qibm/userdata/os/admininst/admin5/wlp/usr/servers/admin5/logs/RSEAPI_ToolboxTrace.txt
4.  Press F3 twice to save and exit.
5.  Restart the ADMIN5 application server instance to enable the tracing. This can be done by clicking on the Stop button button to stop the server and the Start button button to start the server.  You can also use the following CL commands from a 5250 emulator session.

ENDTCPSVR SERVER(*IAS) INSTANCE(ADMIN5)
STRTCPSVR SERVER(*IAS) INSTANCE(ADMIN5)

6.  Recreate the issue.

ADMIN Server Collector
Follow the instructions in the URL, MustGather: HTTP 500 Internal Server Error/HTTP 404 Not Found Error with IBM i Administration Server (2001 Port), to gather and upload the ADMIN Server collector data for IBM to review.

Upload Instructions
MustGather: Instructions for Sending Data to IBM i Support

Document Location

Worldwide

[{"Type":"MASTER","Line of Business":{"code":"LOB57","label":"Power"},"Business Unit":{"code":"BU058","label":"IBM Infrastructure w\/TPS"},"Product":{"code":"SWG60","label":"IBM i"},"ARM Category":[{"code":"a8m3p0000000rcWAAQ","label":"IBM i Merlin"}],"ARM Case Number":"","Platform":[{"code":"PF012","label":"IBM i"}],"Version":"7.3.0;7.4.0;7.5.0"}]

Document Information

Modified date:
06 July 2022

UID

ibm16595271

Page Feedback