vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/vpn/api-ref/vpn_api_1027.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

510 lines
53 KiB
HTML
Raw Permalink Blame History

<a name="EN-US_TOPIC_0000001807530360"></a><a name="EN-US_TOPIC_0000001807530360"></a>
<h1 class="topictitle1">Updating an IPsec VPN Connection</h1>
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_section55622396"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p28776122">This API is used to update an IPsec VPN connection.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_section30839519"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p2387113112410">PUT /v2.0/vpn/ipsec-site-connections/{connection_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_table9861172982416" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_row19884629102416"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.2.3.2.5.1.1"><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p3884192972412">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.2.3.2.5.1.2"><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p13893112952410">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.2.3.2.5.1.3"><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p49011329112410">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.91540845915409%" id="mcps1.3.2.3.2.5.1.4"><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p1490112914244">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_row139091529142413"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p990917292242">connection_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.2.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p1390982912240">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p12917112917246">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p79171129172411">Specifies the ID of the IPsec VPN connection.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_section14973148"><a name="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_section14973148"></a><a name="en-us_topic_0000001540817550_section14973148"></a><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p175901315142518"><a href="#EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_table38559395">Table 2</a> describes the request parameters.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_table38559395"></a><a name="en-us_topic_0000001540817550_table38559395"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_table38559395" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_row16046317"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.3.3.2.5.1.1"><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p24683273">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_0000001807530360__en-us_topic_0000001540817550_p53188122">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_0000001807530360__en-us_topic_0000001540817550_p13270664">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_0000001807530360__en-us_topic_0000001540817550_p1182010">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_row32355065"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p3514615">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_0000001807530360__en-us_topic_0000001540817550_p16248438">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_0000001807530360__en-us_topic_0000001540817550_p41055134">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_0000001807530360__en-us_topic_0000001540817550_p37131542">Specifies the object of the IPsec VPN connection.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_row65748423"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p24022075">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_0000001807530360__en-us_topic_0000001540817550_p66739923">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_0000001807530360__en-us_topic_0000001540817550_p37224696">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_0000001807530360__en-us_topic_0000001540817550_p62410385">Specifies the pre-shared key.</p>
<p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p163561325183110">The key</p>
<ul id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_ul16491199171414"><li id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_li960712330315">Can contain 6 to 128 characters.</li><li id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_li2880172743116">Can contain only:<ul id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_ul1427714115311"><li id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_li1449149181418">Digits</li><li id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_li11491790147">Uppercase letters</li><li id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_li154913912144">Lowercase letters</li><li id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_li1549119901412">Special characters: ~ ` ! @ # $ % ^ ( ) - _ + = [ ] { } | \ , . / : ;</li></ul>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_row24822557"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p64470080">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_0000001807530360__en-us_topic_0000001540817550_p54693963">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_0000001807530360__en-us_topic_0000001540817550_p1026023">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_0000001807530360__en-us_topic_0000001540817550_p15999035">Specifies whether this VPN can only respond to connections or both respond to and initiate connections.</p>
<p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p1032092115120">The value can be <strong id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_b3755112312235">bi-directional</strong> or <strong id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_b12756192322319">response-only</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_row9773594"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p53463670">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_0000001807530360__en-us_topic_0000001540817550_p35590047">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_0000001807530360__en-us_topic_0000001540817550_p64221564">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_0000001807530360__en-us_topic_0000001540817550_p34564214">Specifies the IPsec policy ID.</p>
<p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p1616121516472"><strong id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_b1271210406468">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_0000001807530360__en-us_topic_0000001540817550_row42642473"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p31488280">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_0000001807530360__en-us_topic_0000001540817550_p413912">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_0000001807530360__en-us_topic_0000001540817550_p33526929">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_0000001807530360__en-us_topic_0000001540817550_p31326698">Specifies the administrative status, which can be <strong id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_b842352706221557">true</strong> or <strong id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_b84235270622160">false</strong>.</p>
<p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p1221021204818">Currently, <strong id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_b141915473464">admin_state_up</strong> can only be <strong id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_b6193478465">true</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_row6422022"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p50421737">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_0000001807530360__en-us_topic_0000001540817550_p57628934">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_0000001807530360__en-us_topic_0000001540817550_p37432067">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_0000001807530360__en-us_topic_0000001540817550_p11345162825810">Deprecated parameter</p>
<p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p287710269583">Specifies valid CIDR blocks of a tenant.</p>
<p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p31844657">The format is <em id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_i1527439194111">&lt;net_address &gt; / &lt; prefix &gt;</em>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_row41778254"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p28595379">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_0000001807530360__en-us_topic_0000001540817550_p34524340">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_0000001807530360__en-us_topic_0000001540817550_p45008187">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_0000001807530360__en-us_topic_0000001540817550_p21784493">Specifies the maximum transmission unit to address fragmentation.</p>
<p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p991913487479"><strong id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_b1275532469">mtu</strong> can only be <strong id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_b188185324620">1500</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_row61842715"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p43203995">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_0000001807530360__en-us_topic_0000001540817550_p9862716">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_0000001807530360__en-us_topic_0000001540817550_p60682533">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_0000001807530360__en-us_topic_0000001540817550_p16338175">Specifies the endpoint group ID (tenant CIDR blocks).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_row12825854"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p32261252">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_0000001807530360__en-us_topic_0000001540817550_p63024590">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_0000001807530360__en-us_topic_0000001540817550_p4718148">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_0000001807530360__en-us_topic_0000001540817550_p46625744">Specifies the endpoint group ID (VPC subnets).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_row48179284"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p10207955">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_0000001807530360__en-us_topic_0000001540817550_p21538022">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_0000001807530360__en-us_topic_0000001540817550_p66858230">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_0000001807530360__en-us_topic_0000001540817550_p46807530">Specifies the remote gateway address.</p>
<p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p1718662818475">The address can contain up to 250 characters.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_row18614589"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p31386755">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_0000001807530360__en-us_topic_0000001540817550_p59299233">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_0000001807530360__en-us_topic_0000001540817550_p38508608">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_0000001807530360__en-us_topic_0000001540817550_p32189576">Specifies the remote gateway ID.</p>
<p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p10469193719478">The ID can contain up to 250 characters.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_row21270730"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p45207585">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_0000001807530360__en-us_topic_0000001540817550_p37935797">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_0000001807530360__en-us_topic_0000001540817550_p52900717">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_0000001807530360__en-us_topic_0000001540817550_p57099698">Specifies the name of the IPsec VPN connection.</p>
<p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p72841124715">The name can contain 1 to 64 characters.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_row16996142011528"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p3183172265217">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_0000001807530360__en-us_topic_0000001540817550_p8184162295212">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_0000001807530360__en-us_topic_0000001540817550_p181845228529">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_0000001807530360__en-us_topic_0000001540817550_p171841222115215">DPD is used to detect whether the peer is alive.</p>
<p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p19184192212529">For details, see <a href="#EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_table15893193375212">Table 3</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_row14401131914127"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_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_0000001807530360__en-us_topic_0000001540817550_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_0000001807530360__en-us_topic_0000001540817550_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_0000001807530360__en-us_topic_0000001540817550_p182881329114417">Specifies the ID of a yearly/monthly order.</p>
<p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p148620530429">This parameter is only available to yearly/monthly VPNs.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_row10268921111216"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_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_0000001807530360__en-us_topic_0000001540817550_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_0000001807530360__en-us_topic_0000001540817550_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_0000001807530360__en-us_topic_0000001540817550_p112881229144412">Specifies the ID of a product that is billed on a yearly/monthly basis.</p>
<p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p7636162915439">This parameter is only available to yearly/monthly VPNs.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_table15893193375212"></a><a name="en-us_topic_0000001540817550_table15893193375212"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_table15893193375212" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_b419116145488">dpd</strong> parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_row208093414526"><th align="left" class="cellrowborder" valign="top" width="29.59%" id="mcps1.3.3.4.2.4.1.1"><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p380193410520">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_0000001807530360__en-us_topic_0000001540817550_p188016346527">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_0000001807530360__en-us_topic_0000001540817550_p108018344526">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_row1080113418520"><td class="cellrowborder" valign="top" width="29.59%" headers="mcps1.3.3.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p2806343526">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_0000001807530360__en-us_topic_0000001540817550_p1280173415520">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_0000001807530360__en-us_topic_0000001540817550_p6809342528">Specifies the DPD action, which can be <strong id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_b26901443141714">clear</strong>, <strong id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_b1369117436175">hold</strong>, <strong id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_b3691144341710">restart</strong>, <strong id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_b669211437176">disabled</strong>, or <strong id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_b1569234391715">restart-by-peer</strong>. The default action is <strong id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_b35011052201717">hold</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_row1801734155213"><td class="cellrowborder" valign="top" width="29.59%" headers="mcps1.3.3.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p8800343526">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_0000001807530360__en-us_topic_0000001540817550_p1281143418522">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_0000001807530360__en-us_topic_0000001540817550_p1981634145210">Specifies the DPD interval in seconds. The default interval is <strong id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_b1030382134820">30</strong> seconds.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_row2081334205219"><td class="cellrowborder" valign="top" width="29.59%" headers="mcps1.3.3.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p2081183415525">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_0000001807530360__en-us_topic_0000001540817550_p1681143465213">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_0000001807530360__en-us_topic_0000001540817550_p68113425216">Specifies the DPD timeout. The default timeout is <strong id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_b1113142494819">120</strong> seconds.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_section540607"><h4 class="sectiontitle">Response</h4><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p131054292514"><a href="#EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_table23987813">Table 4</a> describes the response parameters.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_table23987813"></a><a name="en-us_topic_0000001540817550_table23987813"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_table23987813" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_row32303446"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.4.3.2.4.1.1"><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p66442352">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_0000001807530360__en-us_topic_0000001540817550_p13121422">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_0000001807530360__en-us_topic_0000001540817550_p56089592">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_row46963092"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p45914068">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_0000001807530360__en-us_topic_0000001540817550_p28052000">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_0000001807530360__en-us_topic_0000001540817550_p36672255">Specifies the status of the IPsec VPN connection, which can be <strong id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_b842352706164927">ACTIVE</strong>, <strong id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_b842352706164931">DOWN</strong>, <strong id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_b842352706164935">BUILD</strong>, <strong id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_b842352706164939">ERROR</strong>, <strong id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_b842352706164943">PENDING_CREATE</strong>, <strong id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_b842352706164948">PENDING_UPDATE</strong>, or <strong id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_b84235270616508">PENDING_DELETE</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_row61614844"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p24746480">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_0000001807530360__en-us_topic_0000001540817550_p58307827">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_0000001807530360__en-us_topic_0000001540817550_p37134413">Specifies the pre-shared key.</p>
<p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p8412201083113">The key</p>
<ul id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_ul94121210203114"><li id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_li0412610203110">Can contain 6 to 128 characters.</li><li id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_li44121710123117">Can contain only:<ul id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_ul1412151012315"><li id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_li7412111019314">Digits</li><li id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_li5412111012311">Uppercase letters</li><li id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_li1441201063115">Lowercase letters</li><li id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_li13412121019317">Special characters: ~ ` ! @ # $ % ^ ( ) - _ + = [ ] { } | \ , . / : ;</li></ul>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_row65774263"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p26115080">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_0000001807530360__en-us_topic_0000001540817550_p34946701">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_0000001807530360__en-us_topic_0000001540817550_p41427285">Specifies whether this VPN can only respond to connections or both respond to and initiate connections.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_row37301245"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p1501989">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_0000001807530360__en-us_topic_0000001540817550_p54552261">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_0000001807530360__en-us_topic_0000001540817550_p25816719">Specifies the name of the IPsec VPN connection.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_row31023887"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p29906904">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_0000001807530360__en-us_topic_0000001540817550_p6540158">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_0000001807530360__en-us_topic_0000001540817550_p27413374">Specifies the administrative status, which can be <strong id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_b16701152718352">true</strong> or <strong id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_b77029277358">false</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_row45393782"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p53017722">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_0000001807530360__en-us_topic_0000001540817550_p66577119">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_0000001807530360__en-us_topic_0000001540817550_p887019">Specifies the project ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_row7983171"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p42657133">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_0000001807530360__en-us_topic_0000001540817550_p32675739">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_0000001807530360__en-us_topic_0000001540817550_p39815461">Specifies the IPsec policy ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_row22794832"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p34442073">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_0000001807530360__en-us_topic_0000001540817550_p38344490">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_0000001807530360__en-us_topic_0000001540817550_p54179398">Specifies the authentication mode. The default mode is <strong id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_b13604224124913">psk</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_row17852540"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p36769646">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_0000001807530360__en-us_topic_0000001540817550_p25551373">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_0000001807530360__en-us_topic_0000001540817550_p9451305202">Deprecated parameter</p>
<p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p154517032019">Specifies valid CIDR blocks of a tenant.</p>
<p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p845190102019">The format is <em id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_i35466397417">&lt;net_address &gt; / &lt; prefix &gt;</em>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_row41569778"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p11708839">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_0000001807530360__en-us_topic_0000001540817550_p8891917">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_0000001807530360__en-us_topic_0000001540817550_p22268426">Specifies the maximum transmission unit to address fragmentation.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_row66198114"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p60446980">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_0000001807530360__en-us_topic_0000001540817550_p64367227">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_0000001807530360__en-us_topic_0000001540817550_p64409607">Specifies the endpoint group ID (tenant CIDR blocks).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_row42815556"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p45508046">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_0000001807530360__en-us_topic_0000001540817550_p62273137">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_0000001807530360__en-us_topic_0000001540817550_p15289375">Specifies the IKE policy ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_row3386651"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p5883351">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_0000001807530360__en-us_topic_0000001540817550_p17381814465">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_0000001807530360__en-us_topic_0000001540817550_p18797239">DPD is used to detect whether the peer is alive.</p>
<p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p1439053017135">For details, see <a href="#EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_table544731556">Table 5</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_row65489840"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p3076790">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_0000001807530360__en-us_topic_0000001540817550_p47893437">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_0000001807530360__en-us_topic_0000001540817550_p25141484">Specifies the route advertising mode. The default mode is <strong id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_b148091142144913">static</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_row24946770"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p7422478">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_0000001807530360__en-us_topic_0000001540817550_p64349806">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_0000001807530360__en-us_topic_0000001540817550_p17214779">Specifies the VPN service ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_row20715291"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p217030">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_0000001807530360__en-us_topic_0000001540817550_p17579482">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_0000001807530360__en-us_topic_0000001540817550_p45953370">Specifies the endpoint group ID (VPC subnets).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_row10927149"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p12683857">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_0000001807530360__en-us_topic_0000001540817550_p20759490">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_0000001807530360__en-us_topic_0000001540817550_p39129256">Specifies the remote gateway address.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_row16618991"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p3961063">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_0000001807530360__en-us_topic_0000001540817550_p52410671">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_0000001807530360__en-us_topic_0000001540817550_p594640">Specifies the remote gateway ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_row5351764"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p30839753">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_0000001807530360__en-us_topic_0000001540817550_p14992050">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_0000001807530360__en-us_topic_0000001540817550_p48357378">Specifies the ID of the IPsec VPN connection.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_row32563220"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p20375168">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_0000001807530360__en-us_topic_0000001540817550_p39775908">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_0000001807530360__en-us_topic_0000001540817550_p50474807">Provides supplementary information about the IPsec VPN connection.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_row51620080"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p20476957">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_0000001807530360__en-us_topic_0000001540817550_p48020839">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_0000001807530360__en-us_topic_0000001540817550_p55719536">Specifies the object of the IPsec VPN connection.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_row31713777"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p18679162">project_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_0000001807530360__en-us_topic_0000001540817550_p36617123">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_0000001807530360__en-us_topic_0000001540817550_p62319862">Specifies the project ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_row151816821019"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p830916107106">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_0000001807530360__en-us_topic_0000001540817550_p11309181014103">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_0000001807530360__en-us_topic_0000001540817550_p103095108104">Specifies the ID of a yearly/monthly order.</p>
<p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p5100171654819">This parameter is only available to yearly/monthly VPNs.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_row181812891011"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p23098109105">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_0000001807530360__en-us_topic_0000001540817550_p1130914100108">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_0000001807530360__en-us_topic_0000001540817550_p4309191091012">Specifies the ID of a product that is billed on a yearly/monthly basis.</p>
<p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p18400101834816">This parameter is only available to yearly/monthly VPNs.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_row14182108161020"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p33093105105">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_0000001807530360__en-us_topic_0000001540817550_p1930981014108">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_0000001807530360__en-us_topic_0000001540817550_p2030912108102">Specifies the time when the IPsec connection was created.</p>
<p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_p1190910408310">The time is in <em id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_i152784274555">YYYY-mm-dd HH:MM:SS.ffffff</em> format.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_table544731556"></a><a name="en-us_topic_0000001540817550_table544731556"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_table544731556" frame="border" border="1" rules="all"><caption><b>Table 5 </b><strong id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_b2994153816176">dpd</strong> parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_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_0000001807530360__en-us_topic_0000001540817550_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_0000001807530360__en-us_topic_0000001540817550_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_0000001807530360__en-us_topic_0000001540817550_p1644234556">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_row1944113145510"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_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_0000001807530360__en-us_topic_0000001540817550_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_0000001807530360__en-us_topic_0000001540817550_p445051710586">Specifies the DPD action, which can be <strong id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_b525936777">clear</strong>, <strong id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_b437572192">hold</strong>, <strong id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_b1243524054">restart</strong>, <strong id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_b1218672518">disabled</strong>, or <strong id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_b70791703">restart-by-peer</strong>. The default action is <strong id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_b539889755">hold</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_row114519317553"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_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_0000001807530360__en-us_topic_0000001540817550_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_0000001807530360__en-us_topic_0000001540817550_p15648161541019">Specifies the DPD interval in seconds. The default interval is <strong id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_b128105421719">30</strong> seconds.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_row311418115574"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_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_0000001807530360__en-us_topic_0000001540817550_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_0000001807530360__en-us_topic_0000001540817550_p7802145596">Specifies the DPD timeout. The default timeout is <strong id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_b1308455101719">120</strong> seconds.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_section4865465"><h4 class="sectiontitle">Example</h4><ul id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_ul04891392610"><li id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_li1748191352611">Example request<pre class="screen" id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_screen6445641722448">PUT /v2.0/vpn/ipsec-site-connections/{connection_id}
{
"ipsec_site_connection" : {
"mtu" : 1200,
}
}</pre>
</li></ul>
</div>
<ul id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_ul594553310261"><li id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_li10945113362611">Example response<pre class="screen" id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_screen1377314447266">{
"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"
}
}</pre>
</li></ul>
<div class="section" id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_section6578292"><h4 class="sectiontitle">Returned Values</h4><p id="EN-US_TOPIC_0000001807530360__en-us_topic_0000001540817550_en-us_topic_0053740035_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