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

Update an IPsec policy

PDFs

PATCH /security/ipsec/policies/{uuid}

Introduced In: 9.8

Updates a specific IPsec policy.

  • security ipsec policy modify

Parameters

Name Type In Required Description

uuid

string

path

True

IPsec policy UUID

Request Body

Name Type Description

authentication_method

string

Authentication method for the IPsec policy.

certificate

certificate

Certificate for the IPsec policy.

enabled

boolean

Indicates whether or not the policy is enabled.

ipspace

ipspace

Applies to both SVM and cluster-scoped objects. Either the UUID or name may be supplied on input.

local_endpoint

local_endpoint

Local endpoint for the IPsec policy.

local_identity

string

Local Identity

name

string

IPsec policy name.

protocol

string

Lower layer protocol to be covered by the IPsec policy.

remote_endpoint

remote_endpoint

Remote endpoint for the IPsec policy.

remote_identity

string

Remote Identity

uuid

string

Unique identifier of the IPsec policy.
Example request 
{
  "authentication_method": "string",
  "certificate": {
    "name": "cert1",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "ipspace": {
    "name": "exchange",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "local_endpoint": {
    "address": "10.10.10.7",
    "netmask": "24",
    "port": "23"
  },
  "local_identity": "string",
  "name": "string",
  "protocol": "17",
  "remote_endpoint": {
    "address": "10.10.10.7",
    "netmask": "24",
    "port": "23"
  },
  "remote_identity": "string",
  "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
}

Response

Status: 200, Ok

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

66257097

Internal error. Failed to update the IPsec policy.

66257099

Only one protocol can be specified.

66257100

Only one local port can be specified.

66257101

Only one remote port can be specified.

66257110

Failed to create a policy sequencing value.

66257113

Only one local IP subnet can be specified.

66257114

Only one remote IP subnet can be specified.

66257115

Port ranges containing more than one port are not supported.

66257116

IPsec policy with the specified UUID was not found.

66257120

The subnet selector must be a host address (An IPv4 address with a 32-bit netmask or an IPv6 address with a 128-bit netmask).

66257139

Certificate with the specified UUID was not found.

66257140

Only certificates with a client or server type are supported.

Definitions

See Definitions

href

Name Type Description

href

string

_links

certificate

Certificate for the IPsec policy.

Name Type Description

name

string

Certificate name

uuid

string

Certificate UUID

ipspace

Applies to both SVM and cluster-scoped objects. Either the UUID or name may be supplied on input.

Name Type Description

name

string

IPspace name

uuid

string

IPspace UUID

local_endpoint

Local endpoint for the IPsec policy.

Name Type Description

address

string

IPv4 or IPv6 address

netmask

string

Input as netmask length (16) or IPv4 mask (255.255.0.0). For IPv6, the default value is 64 with a valid range of 1 to 127. Output is always netmask length.

port

string

Application port to be covered by the IPsec policy

remote_endpoint

Remote endpoint for the IPsec policy.

Name Type Description

address

string

IPv4 or IPv6 address

netmask

string

Input as netmask length (16) or IPv4 mask (255.255.0.0). For IPv6, the default value is 64 with a valid range of 1 to 127. Output is always netmask length.

port

string

Application port to be covered by the IPsec policy

svm

Name Type Description

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

ipsec_policy

IPsec policy object.

Name Type Description

authentication_method

string

Authentication method for the IPsec policy.

certificate

certificate

Certificate for the IPsec policy.

enabled

boolean

Indicates whether or not the policy is enabled.

ipspace

ipspace

Applies to both SVM and cluster-scoped objects. Either the UUID or name may be supplied on input.

local_endpoint

local_endpoint

Local endpoint for the IPsec policy.

local_identity

string

Local Identity

name

string

IPsec policy name.

protocol

string

Lower layer protocol to be covered by the IPsec policy.

remote_endpoint

remote_endpoint

Remote endpoint for the IPsec policy.

remote_identity

string

Remote Identity

uuid

string

Unique identifier of the IPsec policy.

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.