• Native OpenStack API

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

List IKE policies

Function Description

This interface is used to query IKE policies.

Interface Format

Method

URI

Description

GET

/v2.0/vpn/ikepolicies

Queries IKE 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

ikepolicies

List<Object>

Yes

Specifies a list of IKE policy objects.

description

String

Yes

Specifies the description about the IKE policy.

tenant_id

String

Yes

Specifies the ID of the tenant.

project_id

String

Yes

Specifies the ID of the project.

auth_algorithm

String

No

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

name

String

Yes

Specifies the name of the IKE policy.

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.

pfs

String

No

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

value

Integer

No

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

phase1_negotiation_mode

String

No

Specifies the IKE mode. The default value is main.

units

String

No

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

lifetime

Object

No

Specifies the lifetime of the security association.

id

String

Yes

Specifies the ID of the IKE policy.

ike_version

String

No

Specifies the IKE version. A valid value can be v1 or v2, and the default value is v1.

Request Example

GET /v2.0/vpn/ikepolicies

Response Example

{
 "ikepolicies" : [ {
"name" : "ikepolicy1",
"project_id" : "ccb81365fe36411a9011e90491fe1330",
"tenant_id" : "ccb81365fe36411a9011e90491fe1330",
"auth_algorithm" : "sha1",
"encryption_algorithm" : "aes-256",
"pfs" : "group5",
"phase1_negotiation_mode" : "main",
"lifetime" : {
 "units" : "seconds",
 "value" : 3600
},
"ike_version" : "v1",
"id" : "5522aff7-1b3c-48dd-9c3c-b50f016b73db",
"description" : ""
 } ]
}

Error Code

For details, see section Return Code Processing.