Appliance Networking Proxy set
Configures which proxy server to use for the specified protocol. This operation sets environment variables for using proxy. In order for this configuration to take effect a logout / service restart is required.
This operation was added in vSphere API 6.7.
The protocol for which proxy should be set.
Proxy configuration for the specific protocol.
Show optional properties
{
"server": "string",
"port": 0,
"enabled": false
}{
"server": "string",
"port": 0,
"username": "string",
"password": "string",
"enabled": false
}URL of the proxy server
This property was added in vSphere API 6.7.
Port to connect to the proxy server. In a 'get' call, indicates the port connected to the proxy server. In a 'set' call, specifies the port to connect to the proxy server. A value of -1 indicates the default port.
This property was added in vSphere API 6.7.
Username for proxy server.
This property was added in vSphere API 6.7.
Only set if proxy requires username.
Password for proxy server.
This property was added in vSphere API 6.7.
Only set if proxy requires password.
In the result of the #get and #list operations this property indicates whether proxying is enabled for a particular protocol. In the input to the test and set operations this property specifies whether proxying should be enabled for a particular protocol.
This property was added in vSphere API 6.7.
Success!
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 PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"enabled:"boolean","port:"integer","server:"string"}' https://{api_host}/api/appliance/networking/proxy/{protocol}