Skip to main content

Retrieve an IPsec or IKE security association

Contributors
PDFs

GET /security/ipsec/security-associations/{uuid}

Introduced In: 9.8

Retrieves a specific IPsec or IKE (Internet Key Exchange) security association.

  • security ipsec show-ipsecsa

  • security ipsec show-ikesa

Parameters

Name Type In Required Description

uuid

string

path

True

UUID of IPsec or IKE security association.

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

cipher_suite

string

Cipher suite for the security association.

ike

ike

Objects containing parameters specific to IKE (Internet Key Exchange) security association.

ipsec

ipsec

Objects containing parameters specific to IPsec security association.

lifetime

integer

Lifetime for the security association in seconds.

local_address

string

Local address of the security association.

node

node

Node with the security association.

policy_name

string

Policy name for the security association.

remote_address

string

Remote address of the security association.

scope

string

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

svm

svm

SVM, applies only to SVM-scoped objects.

type

string

Type of security association, it can be IPsec or IKE (Internet Key Exchange).

uuid

string

Unique identifier of the security association.
Example response 
{
  "cipher_suite": "string",
  "ike": {
    "authentication": "string",
    "initiator_security_parameter_index": "string",
    "responder_security_parameter_index": "string",
    "state": "string"
  },
  "ipsec": {
    "action": "string",
    "inbound": {
      "security_parameter_index": "string"
    },
    "outbound": {
      "security_parameter_index": "string"
    },
    "state": "string"
  },
  "local_address": "string",
  "node": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "node1",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "policy_name": "string",
  "remote_address": "string",
  "scope": "string",
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "type": "string",
  "uuid": "string"
}

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

ike

Objects containing parameters specific to IKE (Internet Key Exchange) security association.

Name Type Description

authentication

string

Authentication method for internet key exchange protocol.

initiator_security_parameter_index

string

Initiator's security parameter index for the IKE security association.

is_initiator

boolean

Indicates whether or not IKE has been initiated by this node.

responder_security_parameter_index

string

Responder's security parameter index for the IKE security association.

state

string

State of the IKE connection.

version

integer

Internet key exchange protocol version.

inbound

Status for inbound parameters for the IPsec security association.

Name Type Description

bytes

integer

Number of inbound bytes for the IPsec security association.

packets

integer

Number of inbound packets for the IPsec security association.

security_parameter_index

string

Inbound security parameter index for the IPSec security association.

outbound

Status for outbound parameters for the IPsec security association.

Name Type Description

bytes

integer

Number of outbound bytes for the IPsec security association.

packets

integer

Number of outbound packets for the IPsec security association.

security_parameter_index

string

Outbound security parameter index for the IPSec security association.

ipsec

Objects containing parameters specific to IPsec security association.

Name Type Description

action

string

Action for the IPsec security association.

inbound

inbound

Status for inbound parameters for the IPsec security association.

outbound

outbound

Status for outbound parameters for the IPsec security association.

state

string

State of the IPsec security association.

href

Name Type Description

href

string

_links

Name Type Description

self

href

node

Node with the security association.

Name Type Description

_links

_links

name

string

uuid

string

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.