• Native OpenStack API

noa
  1. Help Center
  2. Native OpenStack API
  3. API Reference
  4. Neutron
  5. VPNaas
  6. List IPSec connections

List IPSec connections

Function Description

This interface is used to query the list of IPSec connections.

Interface Format

Method

URI

Description

GET

/v2.0/vpn/ipsec-site-connections

Queries the list of IPSec connections.

Restrictions

Attributes project_id, peer_id, dpd, and local_id are not supported.

Request Parameter

Parameter

Type

Mandatory

Description

fields

String

No

Specifies the fields that you want the server to return. If no fields are specified, all attributes allowed by the policy settings are returned.

Response Parameter

Parameter

Type

Mandatory

Description

peer_cidrs

List<String>

No

(Deprecated) Specifies a list of valid tenant CIDRs. The value is in the form of < net_address > or < prefix >.

mtu

Integer

Yes

Specifies the MTU value.

peer_ep_group_id

String

No

Specifies the ID for the endpoint group that contains tenant CIDRs.

ikepolicy_id

String

Yes

Specifies the ID of the IKE policy.

dpd

Object

No

Specifies a directory with DPD protocol controls.

route_mode

String

No

Specifies the route advertising mode. The default value is static.

peer_address

String

Yes

Specifies the peer gateway public IPv4 or IPv6 address.

peer_id

String

Yes

Specifies the peer gateway ID.

id

String

No

Specifies the ID of the IPSec connection.

description

String

Yes

Specifies the description about the IPSec connection.

project_id

String

Yes

Specifies the ID of the project.

interval

Integer

No

Specifies the DPD interval in seconds. The default value is 30.

timeout

Integer

Yes

Specifies the DPD timeout in seconds. The default value is 120.

action

String

Yes

Specifies the action of the DPD. The value can be clear, hold, restart, disabled, or restart-by-peer. The default value is hold.

local_id

String

No

Identifies the ID of the external gateway address of the virtual router.

vpnservice_id

String

Yes

Specifies the ID of the VPN service.

local_ep_group_id

String

No

Specifies the ID for the endpoint group that contains the VPC subnets.

status

String

Yes

Specifies the IPSec connection status. The value can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE.

psk

String

Yes

Specifies the pre-shared key.

initiator

String

No

Specifies whether this VPN can only respond to connections or both respond to and initiate connections.

name

String

Yes

Specifies the name of the IPSec connection.

admin_state_up

Boolean

Yes

Specifies the administrator status. The value can be true or false.

tenant_id

String

Yes

Specifies the ID of the tenant.

ipsecpolicy_id

Integer

Yes

Specifies the ID of the IPSec policy.

auth_mode

String

No

Specifies the authentication mode. The default value is psk.

Request Example

GET /v2.0/vpn/ipsec-site-connections

Response Example

{
 "ipsec_site_connections" : [ {
"status" : "PENDING CREATE",
"psk" : "secret",
"initiator" : "bi-directional",
"name" : "vpnconnection1",
"admin_state_up" : true,
"project_id" : "10039663455a446d8ba2cbb058b0f578",
"tenant_id" : "10039663455a446d8ba2cbb058b0f578",
"auth_mode" : "psk",
"peer_cidrs" : [ ],
"mtu" : 1500,
"peer_ep_group_id" : "9ad5a7e0-6dac-41b4-b20d-a7b8645fddf1",
"ikepolicy_id" : "9b00d6b0-6c93-4ca5-9747-b8ade7bb514f",
"vpnservice_id" : "5c561d9d-eaea-45f6-ae3e-08d1a7080828",
"dpd" : {
 "action" : "hold",
 "interval" : 30,
 "timeout" : 120
},
"route_mode" : "static",
"ipsecpolicy_id" : "e6e23d0c-9519-4d52-8ea4-5b1f96d857b1",
"local_ep_group_id" : "3e1815dd-e212-43d0-8f13-b494fa553e68",
"peer_address" : "172.24.4.226",
"peer_id" : "172.24.4.226",
"id" : "851f280f-5639-4ea3-81aa-e298525ab74b",
"description" : ""
 } ]
}

Error Code

For details, see section Return Code Processing.