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

appliance techpreview networking proxy: test

Test a Proxy configuration by testing the connection to the proxy server and test host.

Request:

HTTP request

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

Request Body Structure:

{
    "config": {
        "password": "secret string",
        "port": 1,
        "protocol": "ftp",
        "server": "string",
        "testhost": "string",
        "username": "string"
    }
}
<?xml version="1.0" ?>
<ns0:Test-Input xmlns:ns0="http://vmware.com/appliance/techpreview/networking/proxy" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <config>
    <port>1</port>
    <username>string</username>
    <protocol>ftp</protocol>
    <server>string</server>
    <testhost>string</testhost>
    <password>secret string</password>
  </config>
</ns0:Test-Input>

Request Body Parameters:

Name Type Description
bold = required
config proxy_config_test Proxy configuration to test.
config.protocol string protocol being configured.

Defines different proxy protocols Value is one of:
ftp: proxy configuration for ftp.
http: proxy configuration for http.
https: proxy configuration for https.
config.server string hostname or ip of proxy server
config.port long port to connect to the proxy server on. A value of -1 indicates that the default port is being used.
config.username string username for proxy server.
config.password secret password for proxy server.
config.testhost string Verify that a hostname (www.vmware.com) or IPv4 or Ipv6 address of the testhost is accessible through proxy.

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/proxy" 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 Status of proxy settings.
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