test_endpoint
Connect to an endpoint to test connectivity and configuration (permissions, CDC configuration. etc.).
Required User Role: See Required Enterprise Manager permissions.
Syntax
def test_endpoint(
self,
server,
endpoint,
timeout = 60
)
Parameters
| Parameter | Type | Description |
|---|---|---|
| server | string | The name of the server on which the endpoint is defined. |
|
endpoint |
string |
The name of the endpoint. |
|
timeout |
int |
Time, in seconds, to wait until getting a response. |
Return values
AemTestEndpointResp
| Value | Type | Description |
|---|---|---|
|
status |
AemEndpointState { UNKNOWN = 0, CONNECTED = 1, ERROR = 2 } |
- |
| message | string | Short description of the error. |
|
detailed_message |
string |
Detailed description of the error. |
Errors
All of the general errors as well as the errors listed in the table below.
| Error | Message | Description |
|---|---|---|
|
AEM_TEST_ENDPOINT_CONNECTION_TIMEOUT |
A timeout occurred while testing the connection for endpoint {endpoint} on Replicate server {server}. |
Connection was not established within 60 seconds. |
|
AEM_ENDPOINT_NOT_FOUND |
Replicate endpoint {0} on server {1} could not be found. |
The specified endpoint could not be found. |