REST API - test

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:

JSON
XML

{
    "config": {
        "password": "secret string",
        "port": 1,
        "protocol": "ftp",
        "server": "string",
        "testhost": "string",
        "username": "string"
    }
}

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

{
    "value": {
        "messages": [
            {
                "message": "string",
                "result": "failure"
            },
            {
                "message": "string",
                "result": "failure"
            }
        ],
        "status": "orange"
    }
}

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