Update an IPsec configuration
- PDF of this doc site
Collection of separate PDF docs
Creating your file...
PATCH /security/ipsec
Introduced In: 9.8
Updates IPsec configuration via REST APIs.
Related ONTAP commands
-
'security ipsec config modify'
Request Body
Name | Type | Description |
---|---|---|
_links |
||
enabled |
boolean |
Indicates whether or not IPsec is enabled. |
replay_window |
integer |
Replay window size in packets, where 0 indicates that the relay window is disabled. |
Example request
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"replay_window": 0
}
Response
Status: 200, Ok
Error
Status: Default
ONTAP Error Response Codes
Error Code | Description |
---|---|
66256898 |
Internal error. Failed to enable IPsec. |
66256899 |
Internal error. Failed to disable IPsec. |
66257199 |
IPsec is not supported in the current cluster version. |
Also see the table of common errors in the Response body overview section of this documentation.
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 |
self_link
Name | Type | Description |
---|---|---|
self |
ipsec
Manages IPsec configuration via REST APIs.
Name | Type | Description |
---|---|---|
_links |
||
enabled |
boolean |
Indicates whether or not IPsec is enabled. |
replay_window |
integer |
Replay window size in packets, where 0 indicates that the relay window is disabled. |
error_arguments
Name | Type | Description |
---|---|---|
code |
string |
Argument code |
message |
string |
Message argument |
returned_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. |