You can use the TestConnectEnsemble method to verify connectivity with a specified database ensemble. By default it uses the ensemble for the cluster the node is associated with. Alternatively you can provide a different ensemble to test connectivity.


This method has the following input parameter:

Name Description Type Default value Required
ensemble A comma-separated list of ensemble node cluster IP addresses for connectivity testing. string None No

Return value

This method has the following return value:

Name Description Type
details Objects returned:
  • nodes: (object) A list of each ensemble node in the test and the results of the tests.
  • duration: (string) The time required to run the test.
  • result: (string) The results of the entire test.
JSON object

Request example

Requests for this method are similar to the following example:

  "method": "TestConnectEnsemble",
  "params": {},
  "id": 1

Response example

This method returns a response similar to the following example:

   "id": 1,
   "result": {
      "details": { 
         "nodes":  { 
            "1:": "Passed",
            "2:": "Passed",
            "3:": "Passed",
            "4:": "Passed",
            "5:": "Passed"
        "duration": "00:00:00:756072",
        "result": "Passed"

New since version