Skip to main content
ONTAP REST API reference

Update an IPsec configuration

Contributors
PDFs

PATCH /security/ipsec

Introduced In: 9.8

Updates IPsec configuration via REST APIs.

Optional properties

  • 'enabled' - Enable IPsec.

  • 'replay_window' - Replay window size in packets.

  • 'offload_enabled' - Enable IPsec hardware offload.

  • 'security ipsec config modify'

Request Body

Name Type Description

_links

self_link

enabled

boolean

Indicates whether or not IPsec is enabled.

offload_enabled

boolean

Indicates whether or not IPsec hardware offload 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
}
JSON
Copy

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.

66256913

Offload setting changes are not allowed when IPsec is enabled.

66256915

Anti-replay protection and IPsec offload cannot be operational at the same time.

66257007

Failed to update replay window size.

66257199

IPsec is not supported in the current cluster version.

66257496

IPsec must be enabled to support BGP peer groups with MD5. Disable MD5 first in the BGP peer group.

Also see the table of common errors in the Response body overview section of this documentation.

Name Type Description

error

returned_error
Example error 
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}
JSON
Copy

Definitions

See Definitions

href

Name Type Description

href

string
Name Type Description

self

href

ipsec

Manages IPsec configuration via REST APIs.

Name Type Description

_links

self_link

enabled

boolean

Indicates whether or not IPsec is enabled.

offload_enabled

boolean

Indicates whether or not IPsec hardware offload 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.