Skip to main content
REST API reference

Retrieve the IPsec policy configurations used for ONTAP cluster network security

PDFs

GET /security/cluster-network/ipsec/policies

Introduced In: 9.19

Retrieves the IPsec policy configurations used for cluster network security.

  • 'security cluster-network ipsec policy show'

Parameters

Name Type In Required Description

action

string

query

False

Filter by action

uuid

string

query

False

Filter by uuid

certificate.uuid

string

query

False

Filter by certificate.uuid

certificate.name

string

query

False

Filter by certificate.name

node.name

string

query

False

Filter by node.name

node.uuid

string

query

False

Filter by node.uuid

local_ip.netmask

integer

query

False

Filter by local_ip.netmask

local_ip.address

string

query

False

Filter by local_ip.address

authentication_method

string

query

False

Filter by authentication_method

name

string

query

False

Filter by name

  • maxLength: 64

  • minLength: 1

remote_ip.address

string

query

False

Filter by remote_ip.address

remote_ip.netmask

integer

query

False

Filter by remote_ip.netmask

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

  • Default value: 1

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

  • Default value: 15

  • Max value: 120

  • Min value: 0

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

_links

num_records

integer

Number of records.

records

array[records]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "_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

next

href

self

href

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

records

Cluster network security IPsec policy configuration (read-only).

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.

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.