This API has a deprecated equivalent from v7.0U1.
Set Proxy
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.
Request
URLURL
https://{api_host}/api/appliance/networking/proxy/{protocol}
Path Parameters
Path Parameters
string
protocol
Required
The protocol for which proxy should be set.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
NetworkingProxyConfig of mimetype application/json
Required
Proxy configuration for the specific protocol.
{
"enabled": false,
"port": 0,
"server": "string"
}
boolean
enabled
Required
In the result of the #get and #list operations this field indicates whether proxying is enabled for a particular protocol. In the input to the test and set operations this field specifies whether proxying should be enabled for a particular protocol.
integer
port
Required
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.
string
server
Required
URL of the proxy server
string
password
Optional
Password for proxy server. Only set if proxy requires password.
string
username
Optional
Username for proxy server. Only set if proxy requires username.
Authentication
This operation uses the following authentication methods.
Errors
Errors
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
cURL Command
curl -X PUT -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"enabled":false,"password":"string","port":0,"server":"string","username":"string"}' https://{api_host}/api/appliance/networking/proxy/{protocol}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: put
x-vmw-doc-deprecated-path: /rest/appliance/networking/proxy/{protocol}
x-vmw-doc-operation: set
Availability
Added in 7.0U2
