Skip to main content

Retrieve IPsec and IKE security associations

Contributors
PDFs

GET /security/ipsec/security-associations

Introduced In: 9.8

Retrieves the IPsec and IKE (Internet Key Exchange) security associations.

  • security ipsec show-ipsecsa

  • security ipsec show-ikesa

Parameters

Name Type In Required Description

cipher_suite

string

query

False

Filter by cipher_suite

uuid

string

query

False

Filter by uuid

ike.version

integer

query

False

Filter by ike.version

ike.is_initiator

boolean

query

False

Filter by ike.is_initiator

ike.state

string

query

False

Filter by ike.state

ike.initiator_security_parameter_index

string

query

False

Filter by ike.initiator_security_parameter_index

ike.responder_security_parameter_index

string

query

False

Filter by ike.responder_security_parameter_index

ike.authentication

string

query

False

Filter by ike.authentication

local_address

string

query

False

Filter by local_address

type

string

query

False

Filter by type

svm.uuid

string

query

False

Filter by svm.uuid

svm.name

string

query

False

Filter by svm.name

lifetime

integer

query

False

Filter by lifetime

policy_name

string

query

False

Filter by policy_name

node.uuid

string

query

False

Filter by node.uuid

node.name

string

query

False

Filter by node.name

scope

string

query

False

Filter by scope

ipsec.outbound.bytes

integer

query

False

Filter by ipsec.outbound.bytes

ipsec.outbound.security_parameter_index

string

query

False

Filter by ipsec.outbound.security_parameter_index

ipsec.outbound.packets

integer

query

False

Filter by ipsec.outbound.packets

ipsec.inbound.security_parameter_index

string

query

False

Filter by ipsec.inbound.security_parameter_index

ipsec.inbound.bytes

integer

query

False

Filter by ipsec.inbound.bytes

ipsec.inbound.packets

integer

query

False

Filter by ipsec.inbound.packets

ipsec.action

string

query

False

Filter by ipsec.action

ipsec.state

string

query

False

Filter by ipsec.state

remote_address

string

query

False

Filter by remote_address

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: 1

  • 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

error

error

num_records

integer

Number of records

records

array[records]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist"
  },
  "num_records": 1,
  "records": [
    {
      "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