Appliance Networking Proxy test
Tests a proxy configuration by testing the connection to the proxy server and test host.
This operation was added in vSphere API 6.7.
Protocol whose proxy is to be tested.
Request body for invoking operation: test
Show optional properties
{
"host": "string",
"config": {
"server": "string",
"port": 0,
"enabled": false
}
}{
"host": "string",
"config": {
"server": "string",
"port": 0,
"username": "string",
"password": "string",
"enabled": false
}
}A hostname, IPv4 or Ipv6 address.
The Appliance Networking Proxy Config schema defines proxy configuration.
This schema was added in vSphere API 6.7.
Status of proxy settings.
"Appliance Networking Proxy TestResult Object"Status of the proxy server indicating whether the proxy server is reachable.
For more information see: Appliance Networking Proxy ServerStatus.
This property was added in vSphere API 6.7.
Message associated with status.
This property was added in vSphere API 6.7.
Generic error.
"Vapi Std Errors Error Object"Stack of one or more localizable messages for human error consumers.
The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.
Each subsequent message in the stack describes the "cause" of the prior message.
Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.
Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.
The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.
Some operations will not set this property when reporting errors.
Discriminator field to help API consumers identify the structure type.
For more information see: Vapi Std Errors Error Type.
This property was added in vSphere API 6.7.2.
Can be missing or null for compatibility with preceding implementations.
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"config:"object","host:"string"}' https://{api_host}/api/appliance/networking/proxy/{protocol}?action=test