• Native OpenStack API

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

Updates IPSec connection

Function Description

This interface is used to update connection settings for an IPSec connection.

Interface Format

Method

URI

Description

PUT

/v2.0/vpn/ipsec-site-connections/{connection_id}

Updates connection settings for an IPSec connection.

Restrictions

  • Attributes project_id, peer_id, dpd, and local_id are not supported.
  • Parameter connection_id is mandatory.
  • The name value must contain 1 to 64 characters.
  • The description value can contain a maximum of 255 characters. This parameter is for internal use and cannot be configured.
  • The peer_address value can contain a maximum of 250 characters.
  • The peer_id value can contain a maximum of 250 characters. This parameter cannot be modified.
  • The value of mtu can be only 1500.
  • The value of initiator can be only bi-directional.
  • The value of admin_state_up can be only UP.
  • The psk value cannot contain <> and must contain 6 to 128 characters.

Request Parameter

Parameter

Type

Mandatory

Description

connection_id

String

Yes

Specifies the ID of the IPSec connection.

ipsec_site_connection

Object

Yes

Specifies an IPSec connection object.

psk

String

Yes

Specifies the pre-shared key.

initiator

String

No

Specifies whether this VPN can only respond to connections or both respond to and initiate connections.

description

String

Yes

Specifies the ID of the IPSec policy.

admin_state_up

Boolean

Yes

Specifies the administrator status. The value can be true or false.

interval

Integer

No

Specifies the DPD interval in seconds. The default value is 30.

peer_cidrs

List<String>

No

(Deprecated) Specifies a list of valid tenant CIDRs.

The value is in the form of < net_address > or < prefix >.

mtu

Integer

Yes

Specifies the MTU value.

peer_ep_group_id

String

No

Specifies the ID for the endpoint group that contains tenant CIDRs.

local_ep_group_id

String

No

Specifies the ID for the endpoint group that contains the VPC subnets.

dpd

Object

No

Specifies a directory with DPD protocol controls.

timeout

Integer

Yes

Specifies the DPD timeout in seconds. The default value is 120.

action

String

Yes

Specifies the action of the DPD. The value can be clear, hold, restart, disabled, or restart-by-peer. The default value is hold.

peer_address

String

Yes

Specifies the peer gateway public IPv4 or IPv6 address.

peer_id

String

Yes

Specifies the peer gateway ID.

name

String

No

Specifies the name of the IPSec connection.

local_id

String

No

Identifies the ID of the external gateway address of the virtual router.

Response Parameter

Parameter

Type

Mandatory

Description

status

String

Yes

Specifies the IPSec connection status. The value can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE.

psk

String

Yes

Specifies the pre-shared key.

initiator

String

No

Specifies whether this VPN can only respond to connections or both respond to and initiate connections.

name

String

Yes

Specifies the name of the IPSec connection.

admin_state_up

Boolean

Yes

Specifies the administrator status. The value can be true or false.

tenant_id

String

Yes

Specifies the ID of the tenant.

ipsecpolicy_id

String

Yes

Specifies the ID of the IPSec policy.

auth_mode

String

No

Specifies the authentication mode. The default value is psk.

peer_cidrs

String

No

(Deprecated) Specifies a list of valid tenant CIDRs. The value is in the form of < net_address > or < prefix >.

mtu

String

Yes

Specifies the MTU value.

peer_ep_group_id

String

No

Specifies the ID for the endpoint group that contains tenant CIDRs.

ikepolicy_id

String

Yes

Specifies the ID of the IKE policy.

dpd

String

No

Specifies a directory with DPD protocol controls.

route_mode

String

No

Specifies the route advertising mode. The default value is static.

vpnservice_id

String

Yes

Specifies the ID of the VPN service.

local_ep_group_id

String

No

Specifies the ID for the endpoint group that contains the VPC subnets.

peer_address

String

Yes

Specifies the peer gateway public IPv4 or IPv6 address.

peer_id

String

Yes

Specifies the peer gateway ID.

id

String

No

Specifies the ID of the IPSec connection.

description

String

Yes

Specifies the description about the IPSec connection.

ipsec_site_connection

Object

Yes

Specifies an IPSec connection object.

project_id

String

Yes

Specifies the ID of the project.

interval

Integer

No

Specifies the DPD interval in seconds. The default value is 30.

timeout

Integer

Yes

Specifies the DPD timeout in seconds. The default value is 120.

action

String

Yes

Specifies the action of the DPD. The value can be clear, hold, restart, disabled, or restart-by-peer. The default value is hold.

local_id

String

No

Identifies the ID of the external gateway address of the virtual router.

Request Example

PUT /v2.0/vpn/ipsec-site-connections/{connection_id}
{
 "ipsec_site_connection" : {
"mtu" : "2000"
 }
}

Response Example

None

Error Code

For details, see section Return Code Processing.