Updating an IPsec VPN Connection¶
Function¶
This API is used to update an IPsec VPN connection.
URI¶
PUT /v2.0/vpn/ipsec-site-connections/{connection_id}
Parameter | Type | Mandatory | Description |
|---|---|---|---|
connection_id | String | Yes | Specifies the ID of the IPsec VPN connection. |
Request¶
Table 2 describes the request parameters.
Parameter | Type | Mandatory | Description |
|---|---|---|---|
ipsec_site_connection | Object | Yes | Specifies the object of the IPsec VPN connection. |
psk | String | No | Specifies the pre-shared key. The key
|
initiator | String | No | Specifies whether this VPN can only respond to connections or both respond to and initiate connections. initiator can only be bi-directional. |
description | String | No | Specifies the IPsec policy ID. description can contain a maximum of 255 characters. This parameter has been used by internal components, and you are not allowed to configure the parameter. |
admin_state_up | Boolean | No | Specifies the administrative status, which can be true or false. Currently, admin_state_up can only be true. |
peer_cidrs | List<String> | No | Deprecated parameter Specifies valid CIDR blocks of a tenant. The format is <net_address > / < prefix >. |
mtu | Integer | No | Specifies the maximum transmission unit to address fragmentation. mtu can only be 1500. |
peer_ep_group_id | String | No | Specifies the endpoint group ID (tenant CIDR blocks). |
local_ep_group_id | String | No | Specifies the endpoint group ID (VPC subnets). |
peer_address | String | No | Specifies the remote gateway address. The address can contain up to 250 characters. |
peer_id | String | No | Specifies the remote gateway ID. The ID can contain up to 250 characters. |
name | String | No | Specifies the name of the IPsec VPN connection. The name can contain 1 to 64 characters. |
dpd | Object | No | DPD is used to detect whether the peer is alive. For details, see Table 3. |
Parameter | Type | Description |
|---|---|---|
action | String | Specifies the DPD action, which can be clear, hold, restart, disabled, or restart-by-peer. The default action is hold. |
interval | Integer | Specifies the DPD interval in seconds. The default interval is 30 seconds. |
timeout | Integer | Specifies the DPD timeout. The default timeout is 120 seconds. |
Response¶
Table 4 describes the response parameters.
Parameter | Type | Description |
|---|---|---|
status | String | Specifies the status of the IPsec VPN connection, which can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE. |
psk | String | Specifies the pre-shared key. The key
|
initiator | String | Specifies whether this VPN can only respond to connections or both respond to and initiate connections. |
name | String | Specifies the name of the IPsec VPN connection. |
admin_state_up | Boolean | Specifies the administrative status, which can be true or false. |
tenant_id | String | Specifies the project ID. |
ipsecpolicy_id | String | Specifies the IPsec policy ID. |
auth_mode | String | Specifies the authentication mode. The default mode is psk. |
peer_cidrs | String | Deprecated parameter Specifies valid CIDR blocks of a tenant. The format is <net_address > / < prefix >. |
mtu | Integer | Specifies the maximum transmission unit to address fragmentation. |
peer_ep_group_id | String | Specifies the endpoint group ID (tenant CIDR blocks). |
ikepolicy_id | String | Specifies the IKE policy ID. |
dpd | Object | DPD is used to detect whether the peer is alive. For details, see Table 5. |
route_mode | String | Specifies the route advertising mode. The default mode is static. |
vpnservice_id | String | Specifies the VPN service ID. |
local_ep_group_id | String | Specifies the endpoint group ID (VPC subnets). |
peer_address | String | Specifies the remote gateway address. |
peer_id | String | Specifies the remote gateway ID. |
id | String | Specifies the ID of the IPsec VPN connection. |
description | String | Provides supplementary information about the IPsec VPN connection. |
ipsec_site_connection | Object | Specifies the object of the IPsec VPN connection. |
order_id | String | Specifies the ID of a yearly/monthly order. |
product_id | String | Specifies the ID of a product that is billed on a yearly/monthly basis. |
created_at | String | Specifies the time when the IPsec connection was created. The time is in YYYY-mm-dd HH:MM:SS.ffffff format. |
Parameter | Type | Description |
|---|---|---|
action | String | Specifies the DPD action, which can be clear, hold, restart, disabled, or restart-by-peer. The default action is hold. |
interval | Integer | Specifies the DPD interval in seconds. The default interval is 30 seconds. |
timeout | Integer | Specifies the DPD timeout. The default timeout is 120 seconds. |
Example¶
Example request
PUT /v2.0/vpn/ipsec-site-connections/{connection_id} { "ipsec_site_connection" : { "mtu" : 1200, } }Example response
{ "ipsec_site_connection": { "status": "DOWN", "psk": "secret", "initiator": "bi-directional", "name": "vpnconnection1", "admin_state_up": true, "tenant_id": "10039663455a446d8ba2cbb058b0f578", "auth_mode": "psk", "peer_cidrs": [], "mtu": 1200, "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.233", "peer_id": "172.24.4.233", "id": "851f280f-5639-4ea3-81aa-e298525ab74b", "description": "New description", "order_id": "", "product_id": "", "created_at": "2020-08-05 12:39:35.921257" } }
Returned Values¶
For details, see Common Returned Values.