Skip to main content

Retrieve an IPsec policy

Contributors
PDFs

GET /security/ipsec/policies/{uuid}

Introduced In: 9.8

Retrieves a specific IPsec policy.

  • security ipsec policy show

Parameters

Name Type In Required Description

uuid

string

path

True

IPsec policy UUID

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

action

string

Action for the IPsec policy.

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

scope

string

Set to "svm" for interfaces owned by an SVM. Otherwise, set to "cluster".

secret_key

string

Pre-shared key for IKE negotiation.

svm

svm

SVM, applies only to SVM-scoped objects.

uuid

string

Unique identifier of the IPsec policy.
Example response 
{
  "action": "string",
  "authentication_method": "string",
  "certificate": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "string",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "ipspace": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "Default",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "local_endpoint": {
    "address": "10.10.10.7",
    "family": "string",
    "netmask": "24",
    "port": "23"
  },
  "local_identity": "string",
  "name": "string",
  "protocol": "17",
  "remote_endpoint": {
    "address": "10.10.10.7",
    "family": "string",
    "netmask": "24",
    "port": "23"
  },
  "remote_identity": "string",
  "scope": "string",
  "secret_key": "string",
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "uuid": "1cd8a442-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

ipspace

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

Name Type Description

_links

_links

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

family

string

IPv4 or IPv6

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

family

string

IPv4 or IPv6

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 the netmask length.

port

string

Application port to be covered by the IPsec policy

svm

SVM, applies only to SVM-scoped objects.

Name Type Description

_links

_links

name

string

The name of the SVM. This field cannot be specified in a PATCH method.

uuid

string

The unique identifier of the SVM. This field cannot be specified in a PATCH method.

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.