vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/vpn/api-ref/vpn_api_1024.html
Hongwei, King Wang 32c06a10a2 vpn_api 
Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: Hongwei, King Wang <king.wanghongwei@huawei.com>
Co-committed-by: Hongwei, King Wang <king.wanghongwei@huawei.com>
2024-08-15 14:18:28 +00:00

532 lines
56 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000001807370532"></a><a name="EN-US_TOPIC_0000001807370532"></a>
<h1 class="topictitle1">Creating an IPsec VPN Connection</h1>
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_section36453319"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p19241481">This API is used to create an IPsec VPN connection.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_ole_link140"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p141203670">POST /v2.0/vpn/ipsec-site-connections</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_section66468500"><a name="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_section66468500"></a><a name="en-us_topic_0000001591841861_section66468500"></a><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p134776551774"><a href="#EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_table64761989">Table 1</a> lists the request parameters for creating an IPsec site connection.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_table64761989"></a><a name="en-us_topic_0000001591841861_table64761989"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_table64761989" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Request parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row3648444"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.3.3.2.5.1.1"><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p27088563">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.3.3.2.5.1.2"><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p46690023">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.3.3.2.5.1.3"><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p23795519">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.91540845915409%" id="mcps1.3.3.3.2.5.1.4"><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p48388900">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row53887795"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p2835298">psk</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p28332581">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p13237733">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p65623433">Specifies the pre-shared key.</p>
<p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p163561325183110">The key</p>
<ul id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_ul16491199171414"><li id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_li960712330315">Can contain 6 to 128 characters.</li><li id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_li2880172743116">Can contain only:<ul id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_ul1427714115311"><li id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_li1449149181418">Digits</li><li id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_li11491790147">Uppercase letters</li><li id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_li154913912144">Lowercase letters</li><li id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_li1549119901412">Special characters: ~ ` ! @ # $ % ^ ( ) - _ + = [ ] { } | \ , . / : ;</li></ul>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row53739988"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p57971786">initiator</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p65203096">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p46959463">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p45620191">Specifies whether this VPN can only respond to connections or both respond to and initiate connections.</p>
<p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p1032092115120">The value can be <strong id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_b78621758203613">bi-directional</strong> or <strong id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_b44275210378">response-only</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row7928537"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p38231776">ipsecpolicy_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p9766180">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p52863116">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p54054017">Specifies the IPsec policy ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row16724107"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p12475454">admin_state_up</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p3878833">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p45750028">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p14764792">Specifies the administrative status, which can be <strong id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_b22423514012">true</strong> or <strong id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_b42516354402">false</strong>.</p>
<p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p16392114811518">Currently, <strong id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_b158581927102211">admin_state_up</strong> can only be <strong id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_b14859327142212">true</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row65774268"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p26115459">mtu</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p34977455">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p14601640">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p41882197">Specifies the maximum transmission unit to address fragmentation.</p>
<p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p1414716195118"><strong id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_b4589474239">mtu</strong> can only be <strong id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_b259147152318">1500</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row41395459"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p64697882">peer_ep_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p6037081">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p19241577">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p15063922">Specifies the endpoint group ID (tenant CIDR blocks).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row1357571"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p42854387">ikepolicy_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p48653295">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p48602848">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p44516654">Specifies the IKE policy ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row65105571"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p39059911">vpnservice_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p9736186">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p50433639">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p58592948">Specifies the VPN service ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row57574486"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p33021783">local_ep_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p57518732">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p28505693">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p27259828">Specifies the endpoint group ID (VPC subnets).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row44011860"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p8190892">peer_address</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p59482492">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p53352557">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p26589862">Specifies the remote gateway address.</p>
<p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p7884681503">The address can contain up to 250 characters.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row37982174"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p56657239">peer_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p25833645">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p12150471">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p44664077">Specifies the remote gateway ID.</p>
<p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p19791101715016">The ID can contain up to 250 characters.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row66432381"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p12313777">name</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p57891910">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p58733156">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p59765170">Specifies the name of the IPsec VPN connection.</p>
<p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p156581741164910">The name can contain 1 to 64 characters.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row1015618"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p15156252">description</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p19696890">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p51944261">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p46735588">Provides supplementary information about the IPsec VPN connection.</p>
<p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p0566190175017"><strong id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_b772133102610">description</strong> can contain a maximum of 255 characters. This parameter has been used by internal components, and you are not allowed to configure the parameter.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row38326873"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p17468990">peer_cidrs</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p5702100">List&lt;String&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p59216962">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p11345162825810">Deprecated parameter</p>
<p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p287710269583">Specifies valid CIDR blocks of a tenant.</p>
<p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p31844657">The format is <em id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_i6659183584216">&lt;net_address &gt; / &lt; prefix &gt;</em>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row18166465"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p62197523">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p4834618">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p56059806">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p44550438">Specifies the project ID.</p>
<p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p15135133534914">The ID can contain up to 255 characters.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row1762152720447"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p328732912446">order_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p1628712944411">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p2287629114417">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p182881329114417">Specifies the ID of a yearly/monthly order.</p>
<p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p148620530429">This parameter is applicable only to yearly/monthly VPNs.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row876218273447"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p142883297443">product_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p228832994414">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p1028819295448">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p112881229144412">Specifies the ID of a product that is billed on a yearly/monthly basis.</p>
<p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p7636162915439">This parameter is only available to yearly/monthly VPNs.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row676313270445"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p52881129144415">dpd</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p62883298446">Object</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p628816292441">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p1428852912449">Dead Peer Detection (DPD) is used to detect whether the peer is alive.</p>
<p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p328852974414">For details, see <a href="#EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_table33850577442">Table 2</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row27631527154414"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p14288202912440">ipsec_site_connection</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p028910294442">Object</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p6289152914419">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p1128992914413">Specifies the object of the IPsec VPN connection.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_table33850577442"></a><a name="en-us_topic_0000001591841861_table33850577442"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_table33850577442" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_b11500125133020">dpd</strong> parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row9452457164410"><th align="left" class="cellrowborder" valign="top" width="29.59%" id="mcps1.3.3.4.2.4.1.1"><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p8452155711445">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.33%" id="mcps1.3.3.4.2.4.1.2"><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p445219572442">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="54.08%" id="mcps1.3.3.4.2.4.1.3"><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p16452857174414">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row74521157134416"><td class="cellrowborder" valign="top" width="29.59%" headers="mcps1.3.3.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p12452165734418">action</p>
</td>
<td class="cellrowborder" valign="top" width="16.33%" headers="mcps1.3.3.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p194521757134413">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.08%" headers="mcps1.3.3.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p1645255744420">Specifies the DPD action, which can be <strong id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_b842352706165431">clear</strong>, <strong id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_b842352706165434">hold</strong>, <strong id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_b842352706165439">restart</strong>, <strong id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_b842352706165443">disabled</strong>, or <strong id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_b842352706165447">restart-by-peer</strong>. The default action is <strong id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_b8979132414118">hold</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row1745295754410"><td class="cellrowborder" valign="top" width="29.59%" headers="mcps1.3.3.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p345212572444">interval</p>
</td>
<td class="cellrowborder" valign="top" width="16.33%" headers="mcps1.3.3.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p2452105710449">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="54.08%" headers="mcps1.3.3.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p74526579442">Specifies the DPD interval in seconds. The default interval is <strong id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_b467042516313">30</strong> seconds.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row74521657204417"><td class="cellrowborder" valign="top" width="29.59%" headers="mcps1.3.3.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p345225715445">timeout</p>
</td>
<td class="cellrowborder" valign="top" width="16.33%" headers="mcps1.3.3.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p1452057164416">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="54.08%" headers="mcps1.3.3.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p245216571442">Specifies the DPD timeout. The default timeout is <strong id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_b19876161713313">120</strong> seconds.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="note" id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_note6919102610114"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_ul7879163010537"><li class="msonormalcxspmiddle" id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_li128791730195315"><strong id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_b140613381319">route_mode</strong> cannot be configured. The default mode is <strong id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_b740773812310">static</strong>.</li><li id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_li16879230115320">To enable two IPsec connections to work in active/standby mode, <strong id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_b164495472311">local_ep_group_id</strong> and <strong id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_b16450047133114">peer_ep_group_id</strong> of the active and standby connections must be the same. If they are different and the <strong id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_b4451134720318">local_ep_group</strong> and <strong id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_b345214718314">peer_ep_group</strong> values are different, the connection cannot work in active/standby mode.</li></ul>
</div></div>
</div>
<div class="section" id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_section61345590"><h4 class="sectiontitle">Response</h4><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p1757891016128"><a href="#EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_table60218927">Table 3</a> describes the response parameters.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_table60218927"></a><a name="en-us_topic_0000001591841861_table60218927"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_table60218927" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row60011123"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.4.3.2.4.1.1"><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p29062812">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.67%" id="mcps1.3.4.3.2.4.1.2"><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p5277541">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.57000000000001%" id="mcps1.3.4.3.2.4.1.3"><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p64881656">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row13781782"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p42582590">dpd</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p26637750">Object</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p18797239">DPD is used to detect whether the peer is alive.</p>
<p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p1439053017135">For details, see <a href="#EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_table544731556">Table 4</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row34957427"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p12979352">psk</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p44694577">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p42495969">Specifies the pre-shared key.</p>
<p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p1459415382916">The key</p>
<ul id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_ul85941236296"><li id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_li1559416317299">Can contain 6 to 128 characters.</li><li id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_li15946318291">Can contain only:<ul id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_ul1859433102920"><li id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_li3594183192913">Digits</li><li id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_li2594139292">Uppercase letters</li><li id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_li759511316296">Lowercase letters</li><li id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_li185951302917">Special characters: ~ ` ! @ # $ % ^ ( ) - _ + = [ ] { } | \ , . / : ;</li></ul>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row46919403"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p42375303">initiator</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p9847515">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p50824398">Specifies whether this VPN can only respond to connections or both respond to and initiate connections.</p>
<p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p8678103902712">The value can be <strong id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_b1327110314371">bi-directional</strong> or <strong id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_b16271235372">response-only</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row54766399"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p6893340">ipsecpolicy_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p21489686">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p65217919">Specifies the IPsec policy ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row50090360"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p30787377">admin_state_up</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p10749578">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p63674173">Specifies the administrative status, which can be <strong id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_b1460154413438">true</strong> or <strong id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_b9613442433">false</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row36196647"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p46247333">mtu</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p55046503">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p47314137">Specifies the maximum transmission unit to address fragmentation.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row23174054"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p65159075">peer_ep_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p43393704">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p30295276">Specifies the endpoint group ID (tenant CIDR blocks).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row4222036"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p6440667">ikepolicy_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p51931981">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p14029336">Specifies the IKE policy ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row59155164"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p26838981">vpnservice_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p26473887">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p17438021">Specifies the VPN service ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row22724462"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p28742116">local_ep_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p46410096">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p23724515">Specifies the endpoint group ID (VPC subnets).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row12194051"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p48194049">peer_address</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p11403863">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p61473837">Specifies the remote gateway address.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row16393628"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p52815467">peer_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p50194423">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p22413667">Specifies the remote gateway ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row396418"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p32109884">name</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p50763831">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p207374">Specifies the name of the IPsec VPN connection.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row1866374"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p16958614">description</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p31470474">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p50916928">Provides supplementary information about the IPsec VPN connection.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row918101"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p7257357">auth_mode</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p50975058">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p43888289">Specifies the authentication mode. The default mode is <strong id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_b10698943163518">psk</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row59450282"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p50743509">id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p16583569">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p21330650">Specifies the ID of the IPsec VPN connection.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row57758128"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p47896825">route_mode</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p54437622">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p11868462">Specifies the route advertising mode. The default mode is <strong id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_b409160175141644">static</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row39707298"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p62174594">status</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p2977371">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p5852437">Specifies the status of the IPsec VPN connection, which can be <strong id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_b842352706164927">ACTIVE</strong>, <strong id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_b842352706164931">DOWN</strong>, <strong id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_b842352706164935">BUILD</strong>, <strong id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_b842352706164939">ERROR</strong>, <strong id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_b842352706164943">PENDING_CREATE</strong>, <strong id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_b842352706164948">PENDING_UPDATE</strong>, or <strong id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_b84235270616508">PENDING_DELETE</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row52671936"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p38568449">peer_cidrs</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p37036703">List</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p20687163817191">Deprecated parameter</p>
<p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p116874387191">Specifies valid CIDR blocks of a tenant.</p>
<p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p14687038101913">The format is <em id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_i19677185293814">&lt;net_address &gt; / &lt; prefix &gt;</em>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row36652435"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p16057296">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p25572589">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p9598184">Specifies the project ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row176301621514"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p4619410115112">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p1863112125111">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p8631142135117">Specifies the time when the IPsec connection was created.</p>
<p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p15396112118284">The time is in <em id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_i1183611124432">YYYY-mm-dd HH:MM:SS.ffffff</em> format.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row16315257155618"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p1698715812564">order_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p99871582567">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p8987195818563">Specifies the ID of a yearly/monthly order.</p>
<p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p16284155054312">This parameter is applicable only to yearly/monthly VPNs.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row231605745614"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p1988125835610">product_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p10988185855619">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p79881158175616">Specifies the ID of a product that is billed on a yearly/monthly basis.</p>
<p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p5675117194410">This parameter is applicable only to yearly/monthly VPNs.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row1188445813492"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p129019095019">ipsec_site_connection</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p29015025012">Object</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p4911606509">Specifies the object of the IPsec VPN connection.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_table544731556"></a><a name="en-us_topic_0000001591841861_table544731556"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_table544731556" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_b1359411521002">dpd</strong> parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row14446313551"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.4.4.2.4.1.1"><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p164413135517">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.67%" id="mcps1.3.4.4.2.4.1.2"><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p1441536557">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.57000000000001%" id="mcps1.3.4.4.2.4.1.3"><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p1644234556">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row1944113145510"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p19141941165713">action</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p1749113119585">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p445051710586">Specifies the DPD action, which can be <strong id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_b1061650058">clear</strong>, <strong id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_b398104703">hold</strong>, <strong id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_b768010870">restart</strong>, <strong id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_b841616330">disabled</strong>, or <strong id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_b698287713">restart-by-peer</strong>. The default action is <strong id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_b1607666631">hold</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row114519317553"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p645113135513">interval</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p1149116185817">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p15648161541019">Specifies the DPD interval in seconds. The default interval is <strong id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_b130325714413">30</strong> seconds.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_row311418115574"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p911551118578">timeout</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p13758830294">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p7802145596">Specifies the DPD timeout. The default timeout is <strong id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_b1767601659">120</strong> seconds.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_section15239399"><h4 class="sectiontitle">Example</h4><ul id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_ul18791144011211"><li id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_li197911409122">Example request<pre class="screen" id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_screen157989247441">POST /v2.0/vpn/ipsec-site-connections
{
"ipsec_site_connection" : {
"psk" : "secret",
"initiator" : "bi-directional",
"ipsecpolicy_id" : "e6e23d0c-9519-4d52-8ea4-5b1f96d857b1",
"admin_state_up" : true,
"mtu" : 1500,
"peer_ep_group_id" : "9ad5a7e0-6dac-41b4-b20d-a7b8645fddf1",
"ikepolicy_id" : "9b00d6b0-6c93-4ca5-9747-b8ade7bb514f",
"vpnservice_id" : "5c561d9d-eaea-45f6-ae3e-08d1a7080828",
"local_ep_group_id" : "3e1815dd-e212-43d0-8f13-b494fa553e68",
"peer_address" : "172.24.4.233",
"peer_id" : "172.24.4.233",
"name" : "vpnconnection1"
}
}</pre>
</li></ul>
</div>
<ul id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_ul187993506128"><li id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_li0799155016120">Example response<pre class="screen" id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_screen71032291313">{
"ipsec_site_connection" : {
"status" : "PENDING_CREATE",
"psk" : "secret",
"initiator" : "bi-directional",
"name" : "vpnconnection1",
"admin_state_up" : true,
"tenant_id" : "10039663455a446d8ba2cbb058b0f578",
"auth_mode" : "psk",
"peer_cidrs" : [ ],
"mtu" : 1500,
"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",
"vpnservice_id": "4754261f-f8c5-4799-a365-78b2e682e38a",
"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" : "",
"order_id": "",
"product_id": "",
"created_at": "2020-08-05 12:39:35.921257"
}
}</pre>
</li></ul>
<div class="section" id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_section26431778"><h4 class="sectiontitle">Returned Values</h4><p id="EN-US_TOPIC_0000001807370532__en-us_topic_0000001591841861_p19515943486">For details, see <a href="vpn_api_1054.html#EN-US_TOPIC_0000001854089293">Common Returned Values</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpn_api_1023.html">IPsec Connection Management</a></div>
</div>
</div>
View Git Blame Copy Permalink