1. Operations
  2. appliance
  3. techpreview
  4. networking
  5. routes

appliance techpreview networking routes: test

Test connection to a list of gateways

Request:

HTTP request

POST https://{server}/rest/appliance/techpreview/networking/routes/test

Request Body Structure:

{
    "gateways": [
        "string",
        "string"
    ]
}
<?xml version="1.0" ?>
<ns0:Test-Input xmlns:ns0="http://vmware.com/appliance/techpreview/networking/routes" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <gateways-array>
    <array-item>string</array-item>
    <array-item>string</array-item>
  </gateways-array>
</ns0:Test-Input>

Request Body Parameters:

Name Type Description
bold = required
gateways string[] list of gateways.

Response:

HTTP Status Code: 200

Representations:

{
    "value": {
        "messages": [
            {
                "message": "string",
                "result": "failure"
            },
            {
                "message": "string",
                "result": "failure"
            }
        ],
        "status": "orange"
    }
}
<?xml version="1.0" ?>
<ns0:Test-Result xmlns:ns0="http://vmware.com/appliance/techpreview/networking/routes" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <value>
    <status>orange</status>
    <messages-array>
      <array-item>
        <message>string</message>
        <result>failure</result>
      </array-item>
      <array-item>
        <message>string</message>
        <result>failure</result>
      </array-item>
    </messages-array>
  </value>
</ns0:Test-Result>

Response Type:

Name Type Description
bold = required
value test_status_info connection status.
value.status string Overall status of tests run.

Health indicator Value is one of:
orange: In case data has more than one test, this indicates not all tests were successful
green: All tests were successful for given data
red: All tests failed for given data
value.messages message[] messages
value.messages[].message string message
value.messages[].result string result of the test

Individual test result Value is one of:
failure: message indicates the test failed.
success: message indicates that the test was successful.

Errors:

HTTP Status Code Type Description
500 error Generic error