Updates the proxy server, port, username, and password parameters
- PDF of this doc site
Collection of separate PDF docs
Creating your file...
-
the server and the port combination specified using the "server" and "port" fields is validated during this operation the validation will fail in the following scenarios:
-
the http proxy service is not configured on the server
-
the http proxy service is not running on the specified port
-
the server is unreachable # related ontap commands
-
vserver http-proxy modify
PATCH /network/http-proxy/{uuid}
Introduced In: 9.7
Updates the proxy server, port, username, and password parameters. Important notes:
-
IPv6 must be enabled if IPv6 family addresses are specified in the "server" field.
-
The server and the port combination specified using the "server" and "port" fields is validated during this operation. The validation will fail in the following scenarios:
-
The HTTP proxy service is not configured on the server.
-
The HTTP proxy service is not running on the specified port.
-
The server is unreachable.
-
Related ONTAP commands
-
vserver http-proxy modify
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
uuid |
string |
path |
True |
HTTP proxy UUID |
Request Body
Name | Type | Description |
---|---|---|
_links |
||
ipspace |
Applies to both SVM and cluster-scoped objects. Either the UUID or name is supplied on input. |
|
port |
integer |
The port number on which the HTTP proxy service is configured on the proxy server. |
scope |
string |
Set to “svm” for proxy owned by an SVM. Otherwise, set to "cluster". |
server |
string |
The fully qualified domain name (FQDN) or IP address of the proxy server. |
svm |
||
uuid |
string |
The UUID that uniquely identifies the HTTP proxy. |
Example request
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"ipspace": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "exchange",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"port": "3128",
"scope": "string",
"server": "string",
"svm": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
},
"uuid": "string"
}
Response
Status: 200, Ok
Error
Status: Default
ONTAP Error Response Codes
Error Code | Description |
---|---|
26214473 |
The HTTP proxy configuration is not valid. |
23724130 |
Cannot use an IPv6 name server address because there are no IPv6 interfaces. |
Name | Type | Description |
---|---|---|
error |
Example error
{
"error": {
"arguments": [
{
"code": "string",
"message": "string"
}
],
"code": "4",
"message": "entry doesn't exist",
"target": "uuid"
}
}
Definitions
See Definitions
href
Name | Type | Description |
---|---|---|
href |
string |
_links
Name | Type | Description |
---|---|---|
self |
ipspace
Applies to both SVM and cluster-scoped objects. Either the UUID or name is supplied on input.
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
IPspace name |
uuid |
string |
IPspace UUID |
svm
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
The name of the SVM. |
uuid |
string |
The unique identifier of the SVM. |
network_http_proxy
Name | Type | Description |
---|---|---|
_links |
||
ipspace |
Applies to both SVM and cluster-scoped objects. Either the UUID or name is supplied on input. |
|
port |
integer |
The port number on which the HTTP proxy service is configured on the proxy server. |
scope |
string |
Set to “svm” for proxy owned by an SVM. Otherwise, set to "cluster". |
server |
string |
The fully qualified domain name (FQDN) or IP address of the proxy server. |
svm |
||
uuid |
string |
The UUID that uniquely identifies the HTTP proxy. |
error_arguments
Name | Type | Description |
---|---|---|
code |
string |
Argument code |
message |
string |
Message argument |
error
Name | Type | Description |
---|---|---|
arguments |
array[error_arguments] |
Message arguments |
code |
string |
Error code |
message |
string |
Error message |
target |
string |
The target parameter that caused the error. |