Skip to main content
REST API reference

Retrieve the IPsec policy configuration for an ONTAP node and policy UUID

PDFs

GET /security/cluster-network/ipsec/policies/{node.uuid}/{uuid}

Introduced In: 9.19

Retrieves the IPsec policy configuration for cluster network security for a given node and policy UUID.

  • 'security cluster-network ipsec policy show'

Parameters

Name Type In Required Description

node.uuid

string

path

True

Node UUID.

uuid

string

path

True

IPsec policy UUID.

  • format: uuid

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

_links

_links

action

string

Action for the IPsec policy.

authentication_method

string

Authentication method for the IPsec policy. Must be PKI for cluster security.

certificate

certificate

Certificate for the IPsec policy.

local_ip

local_ip

Local IP endpoint for the IPsec policy.

name

string

IPsec policy name.

node

node_reference

remote_ip

remote_ip

Remote IP endpoint for the IPsec policy.

uuid

string

Unique identifier for the IPsec policy.
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "action": "string",
  "authentication_method": "string",
  "certificate": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "string",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "local_ip": {
    "address": "192.168.1.1",
    "netmask": 24
  },
  "name": "policy1",
  "node": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "node1",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "remote_ip": {
    "address": "192.168.1.2",
    "netmask": 24
  },
  "uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
}

Error

Status: Default, Error
Name Type Description

error

returned_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

href

certificate

Certificate for the IPsec policy.

Name Type Description

_links

_links

name

string

Certificate name

uuid

string

Certificate UUID

local_ip

Local IP endpoint for the IPsec policy.

Name Type Description

address

string

IPv4 or IPv6 address.

netmask

integer

IPv4 mask length or IPv6 prefix length.

node_reference

Name Type Description

_links

_links

name

string

uuid

string

remote_ip

Remote IP endpoint for the IPsec policy.

Name Type Description

address

string

IPv4 or IPv6 address.

netmask

integer

IPv4 mask length or IPv6 prefix length.

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.