• Native OpenStack API

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

List IPSec policies

Function Description

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

Interface Format

Method

URI

Description

GET

/v2.0/vpn/ipsecpolicies

Queries the list of IPSec policies.

Restrictions

The project_id attribute is 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

transform_protocol

String

No

Specifies the transmission protocol. A valid value can be esp, ah, or ah-esp. The default value is esp.

tenant_id

String

Yes

Specifies the ID of the tenant.

id

String

Yes

Specifies the ID of the IPSec policy.

encapsulation_mode

String

No

Specifies the encapsulation mode. The default value is tunnel.

pfs

String

No

Specifies the PFS. A valid value can be Group2, Group5, or Group14. The default value is Group5.

lifetime

Object

No

Specifies the lifetime of the security association.

name

String

Yes

Specifies the name of the IPSec policy.

auth_algorithm

String

No

Specifies the authentication hash algorithm. A valid value can be md5, sha1, sha2-256, sha2-384, or sha2-512.

description

String

Yes

Specifies the description about an IPSec policy.

ipsecpolicies

List<Object>

No

Specifies the objects of the IPSec policy list.

project_id

String

Yes

Specifies the ID of the project.

encryption_algorithm

String

No

Specifies the encryption algorithm. A valid value can be 3des, aes-128, aes-192, or aes-256. The default value is aes-128.

value

Integer

No

Specifies the lifetime value in seconds. The default value is 3600.

units

String

No

Specifies the unit for the lifetime of the security association. The default value is seconds.

Request Example

GET /v2.0/vpn/ipsecpolicies

Response Example

{
 "ipsecpolicies" : [ {
"name" : "ipsecpolicy1",
"transform_protocol" : "esp",
"auth_algorithm" : "sha1",
"encapsulation_mode" : "tunnel",
"encryption_algorithm" : "aes-128",
"pfs" : "group14",
"project_id" : "ccb81365fe36411a9011e90491fe1330",
"tenant_id" : "ccb81365fe36411a9011e90491fe1330",
"lifetime" : {
 "units" : "seconds",
 "value" : 3600
},
"id" : "5291b189-fd84-46e5-84bd-78f40c05d69c",
"description" : ""
 } ]
}

Error Code

For details, see section Return Code Processing.