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
Request:
HTTP request
PUT https://{server}/rest/appliance/networking/proxy/{protocol}
Path Parameters
Name | Type | Description |
---|---|---|
Required | ||
protocol | string | The protocol for which proxy should be set. |
Request Body Structure:
{
"config": {
"enabled": true,
"password": "secret string",
"port": 1,
"server": "string",
"username": "string"
}
}
"config": {
"enabled": true,
"password": "secret string",
"port": 1,
"server": "string",
"username": "string"
}
}
Request Body Parameters:
Name | Type | Description |
---|---|---|
bold = required | ||
config | config | Proxy configuration for the specific protocol. |
config.server | string | Hostname or IP address of the proxy server. This attribute was added in vSphere API 6.7 |
config.port | long | 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 attribute was added in vSphere API 6.7 |
config.username | string | Username for proxy server. This attribute was added in vSphere API 6.7 Optional. Only set if proxy requires username. |
config.password | secret | Password for proxy server. This attribute was added in vSphere API 6.7 Optional. Only set if proxy requires password. |
config.enabled | boolean | 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. This attribute was added in vSphere API 6.7 |
Response:
HTTP Status Code: 200
NoneErrors:
HTTP Status Code | Type | Description |
---|---|---|
500 | error | Generic error. |