Skip to content

Commit

Permalink
Merge pull request #4038 from zowe/refactor-troubleshoot-cgw
Browse files Browse the repository at this point in the history
remove central gateway reference from the docs for v3
  • Loading branch information
Shobhajayanna authored Dec 20, 2024
2 parents 08f3dc4 + 4dfc29b commit d3ea8dc
Show file tree
Hide file tree
Showing 6 changed files with 89 additions and 107 deletions.
32 changes: 10 additions & 22 deletions docs/troubleshoot/troubleshoot-apiml-error-codes.md
Original file line number Diff line number Diff line change
Expand Up @@ -531,43 +531,43 @@ The following error message codes may appear on logs or API responses. Use the f

### ZWEAT500E

Failed to parse the client certificate forwarded from the central Gateway. Error message %s. The client certificate was %s
Failed to parse the client certificate forwarded from the Gateway. Hostname is %s. Error message is %s. The client certificate was %s

**Reason:**

The string sent by the central Gateway was not recognized as a valid DER-encoded certificate in the Base64 printable form.
The string sent by the Gateway was not recognized as a valid DER-encoded certificate in the Base64 printable form.

**Action:**

Ensure that forwarding of the client certificate is also enabled in the central Gateway. Check for any error messages from the central Gateway.
Ensure that forwarding of the client certificate is also enabled in the Gateway. Check for any error messages from the Gateway.

### ZWEAT501E

Failed to get trusted certificates from the central Gateway. Unexpected response from %s endpoint. Status code: %s. Response body: %s
Failed to get trusted certificates from the Gateway. Unexpected response from %s endpoint. Status code: %s. Response body: %s

**Reason:**

The response status code is different from the expected 200 OK.

**Action:**

Ensure that the parameter apiml.security.x509.certificatesUrls is correctly configured with the complete URL to the central Gateway certificates endpoint. Test the URL manually.
Ensure that the parameter apiml.security.x509.certificatesUrls is correctly configured with the complete URL to the Gateway certificates endpoint. Test the URL manually.

### ZWEAT502E

Invalid URL specified to get trusted certificates from the central Gateway. Error message: %s
Invalid URL specified to get trusted certificates from the Gateway. URL is %s. Error message: %s

**Reason:**

The parameter apiml.security.x509.certificatesUrls is not correctly configured with the complete URL to the central Gateway certificates endpoint.
The parameter apiml.security.x509.certificatesUrls is not correctly configured with the complete URL to the Gateway certificates endpoint.

**Action:**

Ensure that the parameter apiml.security.x509.certificatesUrls is correctly configured.

### ZWEAT503E

An error occurred during retrieval of trusted certificates from the central Gateway. Error message: %s
An error occurred during retrieval of trusted certificates from the Gateway. Certificate endpoint is %s. Error message: %s

**Reason:**

Expand All @@ -579,28 +579,16 @@ The following error message codes may appear on logs or API responses. Use the f

### ZWEAT504E

Failed to parse the trusted certificates provided by the central Gateway. Error message %s
Failed to parse the trusted certificates provided by the Gateway. Certificate endpoint is %s. Error message %s

**Reason:**

The string sent by the central Gateway was not recognized as valid DER-encoded certificates in the Base64 printable form.
The string sent by the Gateway was not recognized as valid DER-encoded certificates in the Base64 printable form.

**Action:**

Check that the URL configured in apiml.security.x509.certificatesUrls responds with valid DER-encoded certificates in the Base64 printable form.

### ZWEAT505E

Incoming request certificate is not one of the trusted certificates provided by the central Gateway.

**Reason:**

The Gateway performs an additional check of request certificates when the central Gateway forwards the incoming client certificate to the domain Gateway. This check may fail when the certificatesUrl parameter does not point to the proper central Gateway certificates endpoint.

**Action:**

Check that the URL configured in apiml.security.x509.certificatesUrls points to the central Gateway and it responds with valid DER-encoded certificates in the Base64 printable form.

### ZWEAT601E

z/OSMF service name not found. Set parameter apiml.security.auth.zosmf.serviceId to your service ID.
Expand Down
Loading

0 comments on commit d3ea8dc

Please sign in to comment.