VpnConnection
Information about a VPN connection.
A VPN connection can be in one of the following states:
-
pending: The creation process of the connection is in progress.
-
available: The connection is ready to use.
-
deleting: The deletion process of the connection is in progress.
-
deleted: The connetion is deleted and remains in this state for one hour.
The CustomerGatewayConfiguration
element consists in an XML configuration file following this format:
<vpn_connection>
<customer_gateway_id>*CGW IDENTIFIER*</customer_gateway_id>
<vpn_gateway_id>*VGW IDENTIFIER*</vpn_gateway_id>
<vpn_connection_type>ipsec.1</vpn_connection_type>
<ipsec_tunnel>
<customer_gateway>
<tunnel_outside_address>*PUBLIC IP ADDRESS*</tunnel_outside_address>
<tunnel_inside_address>*INTERNAL ADDRESS*</tunnel_inside_address>
<bgp>
<asn>*ASN*</asn>
<hold_time>30</hold_time>
</bgp>
</customer_gateway>
<vpn_gateway>
<tunnel_outside_address>*PUBLIC IP ADDRESS*</tunnel_outside_address>
<tunnel_inside_address>*INTERNAL ADDRESS*</tunnel_inside_address>
<bgp>
<asn>*ASN*</asn>
<hold_time>30</hold_time>
</bgp>
</vpn_gateway>
<ike>
<authentication_protocol>hmac-sha1-96</authentication_protocol>
<encryption_protocol>aes-128-cbc</encryption_protocol>
<lifetime>28880</lifetime>
<perfect_forward_secrecy>group2</perfect_forward_secrecy>
<mode>main</mode>
<pre_shared_key>*AUTHENTICATION KEY*</pre_shared_key>
</ike>
<ipsec>
<protocol>esp</protocol>
<authentication_protocol>sha1</authentication_protocol>
<encryption_protocol>aes-128-cbc</encryption_protocol>
<lifetime>3600</lifetime>
<perfect_forward_secrecy>group2</perfect_forward_secrecy>
<mode>tunnel</mode>
<clear_df_bit>true</clear_df_bit>
<fragmentation_before_encryption>true</fragmentation_before_encryption>
<tcp_mss_adjustment>1387</tcp_mss_adjustment>
<dead_peer_detection>
<interval>30</interval>
<retries>3</retries>
</dead_peer_detection>
</ipsec>
</ipsec_tunnel>
</vpn_connection>
Name | Description | Required | Schema | Default | Example |
---|---|---|---|---|---|
customerGatewayConfiguration |
The configuration to apply to the customer gateway to establish the VPN connection, in XML format. |
false |
string |
||
customerGatewayId |
The ID of the customer gateway used on the customer end of the connection. |
false |
string |
||
options |
One or more options for the VPN connection. |
false |
|||
routes.N |
Information about one or more static routes associated with the VPN connection, if any. |
false |
|||
state |
The state of the VPN connection. |
false |
string |
||
tagSet.N |
One or more tags associated with the VPN connection. |
false |
|||
type |
The type of VPN connection (always |
false |
string |
||
vgwTelemetry.N |
Information about the state of the VPN tunnel (this list contains only one element, as 3DS OUTSCALE supports one tunnel per VPN connection). |
false |
|||
vpnConnectionId |
The ID of the VPN connection. |
false |
string |
||
vpnGatewayId |
The ID of the virtual private gateway used on the 3DS OUTSCALE end of the connection. |
false |
string |