Querying IKE Policies

Function

This interface is used to query IKE policies.

URI

GET /v2.0/vpn/ikepolicies

Request Message

Table 1 describes the request parameters.

Table 1 Request parameters

Parameter

Type

Mandatory

Description

fields

String

No

Controls which parameters are returned. If this parameter is not specified, all parameters will be returned.

Note

The project_id parameter is not supported.

Response Message

Table 2 describes the response parameters.

Table 2 Response parameters

Parameter

Type

Description

ikepolicies

List<Object>

Specifies the IKE policy list.

description

String

Provides supplementary information about the IKE policy.

tenant_id

String

Specifies the project ID.

auth_algorithm

String

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

name

String

Specifies the IKE policy name.

encryption_algorithm

String

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

pfs

String

Specifies the PFS. The value can be group1, group2, group5, group14, group15, group16, group19, group20, group21, or disable.

The default value is group5.

value

Integer

Specifies the lifetime value of the SA. The default unit is seconds. The default value is 3600.

phase1_negotiation_mode

String

Specifies the IKE mode The default value is main.

units

String

Specifies the lifecycle unit. The default value is seconds.

lifetime

Object

Specifies the lifetime object of SA.

id

String

Specifies the IKE policy ID.

ike_version

String

Specifies the IKE version. The value can be v1 or v2. The default value is v1.

Example

  • Example Request

    GET /v2.0/vpn/ikepolicies
    
  • Example Response

    {
      "ikepolicies" : [ {
        "name" : "ikepolicy1",
        "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" : ""
      } ]
    }
    

Returned Values

For details, see section Common Returned Values.