gtema 6b71b4a1fa Initial import of the VPN API document

Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: gtema <artem.goncharov@gmail.com>
Co-committed-by: gtema <artem.goncharov@gmail.com>

2022-12-07 13:22:09 +00:00

14 KiB

Raw Blame History

Querying Details About an IKE Policy

Function

This interface is used to query details about an IKE policy.

URI

GET /v2.0/vpn/ikepolicies/{ikepolicy_id}

**Table 1** Parameter description
Parameter	Type	Mandatory	Description
ikepolicy_id	String	Yes	Specifies the IKE policy ID.

Request Message

None

Response Message

Table 2 describes the response parameters.

**Table 2** Response parameters
Parameter	Type	Description
ikepolicy	Object	Specifies the IKE policy object.
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 number. The value can be v1 or v2. The default value is v1.

Example

Example Request

GET /v2.0/vpn/ikepolicies/{ikepolicy_id}

Example Response

{
  "ikepolicy" : {
    "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.

Parent topic: IKE Policy Management

14 KiB Raw Blame History