Skip to main content
REST API reference
A newer release of this product is available.

Update IPsec configuration

PDFs

PATCH /security/ipsec

Updates IPsec configuration via REST APIs.

  • 'security ipsec config modify'

Learn more

Parameters

Name Type In Required Description

return_records

boolean

query

False

The default is false. If set to true, the records are returned.

Request Body

Name Type Description

_links

self_link

enabled

boolean

Indicates whether or not IPsec is enabled.
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  }
}

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.
Name Type Description

error

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
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.

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.