vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/vpn/api-ref/en_topic_0093011495.html
gtema 6b71b4a1fa Initial import of the VPN API document 
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: gtema <artem.goncharov@gmail.com>
Co-committed-by: gtema <artem.goncharov@gmail.com>
2022-12-07 13:22:09 +00:00

429 lines
35 KiB
HTML
Raw Blame History

<a name="en_topic_0093011495"></a><a name="en_topic_0093011495"></a>
<h1 class="topictitle1">Updating an IPsec VPN Connection</h1>
<div id="body7811801"><div class="section" id="en_topic_0093011495__section55622396"><h4 class="sectiontitle"><strong id="en_topic_0093011495__b842352706112523">Function</strong></h4><p id="en_topic_0093011495__p28776122">This interface is used to update an IPsec VPN connection.</p>
</div>
<div class="section" id="en_topic_0093011495__section30839519"><h4 class="sectiontitle">URI</h4><p id="en_topic_0093011495__p2387113112410">PUT /v2.0/vpn/ipsec-site-connections/{connection_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en_topic_0093011495__table9861172982416" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="en_topic_0093011495__row19884629102416"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.2.3.2.5.1.1"><p id="en_topic_0093011495__p3884192972412"><strong id="en_topic_0093011495__b842352706172115">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.2.3.2.5.1.2"><p id="en_topic_0093011495__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_topic_0093011495__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_topic_0093011495__p1490112914244">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en_topic_0093011495__row139091529142413"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.3.2.5.1.1 "><p id="en_topic_0093011495__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_topic_0093011495__p1390982912240">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.2.3.2.5.1.3 "><p id="en_topic_0093011495__p12917112917246">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.2.3.2.5.1.4 "><p id="en_topic_0093011495__p79171129172411">Specifies the IPsec VPN connection ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="en_topic_0093011495__section14973148"><h4 class="sectiontitle">Request Message</h4><p id="en_topic_0093011495__p175901315142518"><a href="#en_topic_0093011495__table38559395">Table 2</a> describes the request parameters.</p>
<div class="tablenoborder"><a name="en_topic_0093011495__table38559395"></a><a name="table38559395"></a><table cellpadding="4" cellspacing="0" summary="" id="en_topic_0093011495__table38559395" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="en_topic_0093011495__row16046317"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.3.3.2.5.1.1"><p id="en_topic_0093011495__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_topic_0093011495__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_topic_0093011495__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_topic_0093011495__p1182010">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en_topic_0093011495__row32355065"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en_topic_0093011495__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_topic_0093011495__p16248438">Object</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="en_topic_0093011495__p41055134">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en_topic_0093011495__p37131542">Specifies the IPsec VPN connection object.</p>
</td>
</tr>
<tr id="en_topic_0093011495__row65748423"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en_topic_0093011495__p24022075">psk</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="en_topic_0093011495__p66739923">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="en_topic_0093011495__p37224696">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en_topic_0093011495__p62410385">Specifies the pre-shared key.</p>
</td>
</tr>
<tr id="en_topic_0093011495__row24822557"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en_topic_0093011495__p64470080">initiator</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="en_topic_0093011495__p54693963">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="en_topic_0093011495__p1026023">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en_topic_0093011495__p15999035">Specifies whether this VPN can only respond to connections or both respond to and initiate connections.</p>
</td>
</tr>
<tr id="en_topic_0093011495__row9773594"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en_topic_0093011495__p53463670">description</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="en_topic_0093011495__p35590047">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="en_topic_0093011495__p64221564">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en_topic_0093011495__p34564214">Specifies the IPsec policy ID.</p>
</td>
</tr>
<tr id="en_topic_0093011495__row42642473"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en_topic_0093011495__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_topic_0093011495__p413912">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="en_topic_0093011495__p33526929">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en_topic_0093011495__p31326698">Specifies the administrative status. The value can be <strong id="en_topic_0093011495__b842352706221557">true</strong> or <strong id="en_topic_0093011495__b84235270622160">false</strong>.</p>
</td>
</tr>
<tr id="en_topic_0093011495__row13504826"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en_topic_0093011495__p20149094">interval</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="en_topic_0093011495__p21463943">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="en_topic_0093011495__p60857861">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en_topic_0093011495__p30539719">Specifies the DPD interval in seconds. The default value is <strong id="en_topic_0093011495__b460615530142328">30</strong>.</p>
</td>
</tr>
<tr id="en_topic_0093011495__row6422022"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en_topic_0093011495__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_topic_0093011495__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_topic_0093011495__p37432067">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en_topic_0093011495__p12098568">(Deprecated) Specifies the tenant's CIDR blocks. The value is in the form of <em id="en_topic_0093011495__i842352697222235">&lt;net_address &gt; / &lt; prefix &gt;</em>.</p>
</td>
</tr>
<tr id="en_topic_0093011495__row41778254"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en_topic_0093011495__p28595379">mtu</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="en_topic_0093011495__p34524340">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="en_topic_0093011495__p45008187">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en_topic_0093011495__p21784493">Specifies the maximum transmission unit to address fragmentation.</p>
</td>
</tr>
<tr id="en_topic_0093011495__row61842715"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en_topic_0093011495__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_topic_0093011495__p9862716">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="en_topic_0093011495__p60682533">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en_topic_0093011495__p16338175">Specifies the endpoint group ID (tenant CIDR blocks).</p>
</td>
</tr>
<tr id="en_topic_0093011495__row12825854"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en_topic_0093011495__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_topic_0093011495__p63024590">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="en_topic_0093011495__p4718148">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en_topic_0093011495__p46625744">Specifies the endpoint group ID (VPC subnets).</p>
</td>
</tr>
<tr id="en_topic_0093011495__row16978512"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en_topic_0093011495__p33082261">dpd</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="en_topic_0093011495__p62417507">Object</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="en_topic_0093011495__p22653281">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en_topic_0093011495__p22976439">Specifies the DPD protocol control.</p>
</td>
</tr>
<tr id="en_topic_0093011495__row5461363"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en_topic_0093011495__p39717249">timeout</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="en_topic_0093011495__p62980604">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="en_topic_0093011495__p1155275">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en_topic_0093011495__p26468439">Specifies the DPD timeout. The default value is 120 seconds.</p>
</td>
</tr>
<tr id="en_topic_0093011495__row36889359"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en_topic_0093011495__p35248064">action</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="en_topic_0093011495__p36520930">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="en_topic_0093011495__p5405340">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en_topic_0093011495__p35179415">Specifies the DPD action. The value can be <strong id="en_topic_0093011495__b842352706165431">clear</strong>, <strong id="en_topic_0093011495__b842352706165434">hold</strong>, <strong id="en_topic_0093011495__b842352706165439">restart</strong>, <strong id="en_topic_0093011495__b842352706165443">disabled</strong>, or <strong id="en_topic_0093011495__b842352706165447">restart-by-peer</strong>. The default value is <strong id="en_topic_0093011495__b842352706201018">hold</strong>.</p>
</td>
</tr>
<tr id="en_topic_0093011495__row48179284"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en_topic_0093011495__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_topic_0093011495__p21538022">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="en_topic_0093011495__p66858230">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en_topic_0093011495__p46807530">Specifies the remote gateway address.</p>
</td>
</tr>
<tr id="en_topic_0093011495__row18614589"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en_topic_0093011495__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_topic_0093011495__p59299233">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="en_topic_0093011495__p38508608">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en_topic_0093011495__p32189576">Specifies the remote gateway ID.</p>
</td>
</tr>
<tr id="en_topic_0093011495__row21270730"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en_topic_0093011495__p45207585">name</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="en_topic_0093011495__p37935797">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="en_topic_0093011495__p52900717">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en_topic_0093011495__p57099698">Specifies the IPsec VPN connection name.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="note" id="en_topic_0093011495__note13671105432412"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ol id="en_topic_0093011495__ol192135572410"><li class="msonormalcxspfirst" id="en_topic_0093011495__li692125572417">The <strong id="en_topic_0093011495__b84235270685257">project_id</strong>, <strong id="en_topic_0093011495__b8423527068531">peer_id</strong>, <strong id="en_topic_0093011495__b8423527068537">dpd</strong>, and <strong id="en_topic_0093011495__b84235270685314">local_id</strong> parameters are not supported.</li><li class="msonormalcxspmiddle" id="en_topic_0093011495__li17921165517249">The <strong id="en_topic_0093011495__b84235270692755">connection_id</strong> parameter must be specified.</li><li class="msonormalcxspmiddle" id="en_topic_0093011495__li1092875515244">The value of <strong id="en_topic_0093011495__b842352706144933">name</strong> can contain 1 to 64 characters.</li><li class="msonormalcxspmiddle" id="en_topic_0093011495__li11936185517246">The value of <strong id="en_topic_0093011495__b84235270685724">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.</li><li class="msonormalcxspmiddle" id="en_topic_0093011495__li2936145512249">The value of <strong id="en_topic_0093011495__b120501305120950">peer_address</strong> can contain a maximum of 250 characters.</li><li class="msonormalcxspmiddle" id="en_topic_0093011495__li10944185519245">The value of <strong id="en_topic_0093011495__b31088999520100">peer_id</strong> can contain a maximum of 250 characters and is unconfigurable.</li><li class="msonormalcxspmiddle" id="en_topic_0093011495__li7952145517241">The value of <strong id="en_topic_0093011495__b84235270691942">mtu</strong> can only be <strong id="en_topic_0093011495__b84235270691950">1500</strong>.</li><li class="msonormalcxspmiddle" id="en_topic_0093011495__li129523553240">The value of <strong id="en_topic_0093011495__b8423527069203">initiator</strong> can only be <strong id="en_topic_0093011495__b84235270692013">bi-directional</strong>.</li><li class="msonormalcxspmiddle" id="en_topic_0093011495__li129601055192412">The value of <strong id="en_topic_0093011495__b842352706203227">admin_state_up</strong> can only be <strong id="en_topic_0093011495__b842352706203236">true</strong>.</li><li class="msonormalcxsplast" id="en_topic_0093011495__li1396010553248">A PSK can contain 6 to 128 characters. Spaces and question marks (?) are not allowed in a PSK. The PSK cannot contain only asterisks (*).</li></ol>
</div></div>
</div>
<div class="section" id="en_topic_0093011495__section540607"><h4 class="sectiontitle">Response Message</h4><p id="en_topic_0093011495__p131054292514"><a href="#en_topic_0093011495__table23987813">Table 3</a> describes the response parameters.</p>
<div class="tablenoborder"><a name="en_topic_0093011495__table23987813"></a><a name="table23987813"></a><table cellpadding="4" cellspacing="0" summary="" id="en_topic_0093011495__table23987813" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="en_topic_0093011495__row32303446"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.4.3.2.4.1.1"><p id="en_topic_0093011495__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_topic_0093011495__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_topic_0093011495__p56089592">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en_topic_0093011495__row46963092"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011495__p45914068">status</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011495__p28052000">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011495__p36672255">Specifies the IPsec VPN connection status. The value can be <strong id="en_topic_0093011495__b842352706164927">ACTIVE</strong>, <strong id="en_topic_0093011495__b842352706164931">DOWN</strong>, <strong id="en_topic_0093011495__b842352706164935">BUILD</strong>, <strong id="en_topic_0093011495__b842352706164939">ERROR</strong>, <strong id="en_topic_0093011495__b842352706164943">PENDING_CREATE</strong>, <strong id="en_topic_0093011495__b842352706164948">PENDING_UPDATE</strong>, or <strong id="en_topic_0093011495__b84235270616508">PENDING_DELETE</strong>.</p>
</td>
</tr>
<tr id="en_topic_0093011495__row61614844"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011495__p24746480">psk</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011495__p58307827">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011495__p37134413">Specifies the pre-shared key.</p>
</td>
</tr>
<tr id="en_topic_0093011495__row65774263"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011495__p26115080">initiator</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011495__p34946701">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011495__p41427285">Specifies whether this VPN can only respond to connections or both respond to and initiate connections.</p>
</td>
</tr>
<tr id="en_topic_0093011495__row37301245"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011495__p1501989">name</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011495__p54552261">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011495__p25816719">Specifies the IPsec VPN connection name.</p>
</td>
</tr>
<tr id="en_topic_0093011495__row31023887"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011495__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_topic_0093011495__p6540158">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011495__p27413374">Specifies the administrative status. The value can be <strong id="en_topic_0093011495__b842352706154840">true</strong> or <strong id="en_topic_0093011495__b842352706154844">false</strong>.</p>
</td>
</tr>
<tr id="en_topic_0093011495__row45393782"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011495__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_topic_0093011495__p66577119">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011495__p887019">Specifies the project ID.</p>
</td>
</tr>
<tr id="en_topic_0093011495__row7983171"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011495__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_topic_0093011495__p32675739">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011495__p39815461">Specifies the IPsec policy ID.</p>
</td>
</tr>
<tr id="en_topic_0093011495__row22794832"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011495__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_topic_0093011495__p38344490">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011495__p54179398">Specifies the authentication mode. The default value is <strong id="en_topic_0093011495__b84235270616111">psk</strong>.</p>
</td>
</tr>
<tr id="en_topic_0093011495__row17852540"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011495__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_topic_0093011495__p25551373">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011495__p4618864">(Deprecated) Specifies the tenant's CIDR blocks. The value is in the form of <em id="en_topic_0093011495__i1708920422">&lt;net_address &gt; / &lt; prefix &gt;</em>.</p>
</td>
</tr>
<tr id="en_topic_0093011495__row41569778"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011495__p11708839">mtu</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011495__p8891917">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011495__p22268426">Specifies the maximum transmission unit to address fragmentation.</p>
</td>
</tr>
<tr id="en_topic_0093011495__row66198114"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011495__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_topic_0093011495__p64367227">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011495__p64409607">Specifies the endpoint group ID (tenant CIDR blocks).</p>
</td>
</tr>
<tr id="en_topic_0093011495__row42815556"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011495__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_topic_0093011495__p62273137">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011495__p15289375">Specifies the IKE policy ID.</p>
</td>
</tr>
<tr id="en_topic_0093011495__row3386651"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011495__p5883351">dpd</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011495__p17381814465">Object</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011495__p52015891">Specifies the DPD protocol control.</p>
</td>
</tr>
<tr id="en_topic_0093011495__row65489840"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011495__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_topic_0093011495__p47893437">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011495__p25141484">Specifies the route advertising mode. The default value is <strong id="en_topic_0093011495__b409160175141644">static</strong>.</p>
</td>
</tr>
<tr id="en_topic_0093011495__row24946770"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011495__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_topic_0093011495__p64349806">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011495__p17214779">Specifies the VPN service ID.</p>
</td>
</tr>
<tr id="en_topic_0093011495__row20715291"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011495__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_topic_0093011495__p17579482">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011495__p45953370">Specifies the endpoint group ID (VPC subnets).</p>
</td>
</tr>
<tr id="en_topic_0093011495__row10927149"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011495__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_topic_0093011495__p20759490">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011495__p39129256">Specifies the remote gateway address.</p>
</td>
</tr>
<tr id="en_topic_0093011495__row16618991"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011495__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_topic_0093011495__p52410671">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011495__p594640">Specifies the remote gateway ID.</p>
</td>
</tr>
<tr id="en_topic_0093011495__row5351764"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011495__p30839753">id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011495__p14992050">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011495__p48357378">Specifies the IPsec VPN connection ID.</p>
</td>
</tr>
<tr id="en_topic_0093011495__row32563220"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011495__p20375168">description</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011495__p39775908">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011495__p50474807">Provides supplementary information about the IPsec VPN connection.</p>
</td>
</tr>
<tr id="en_topic_0093011495__row51620080"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011495__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_topic_0093011495__p48020839">Object</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011495__p55719536">Specifies the IPsec VPN connection object.</p>
</td>
</tr>
<tr id="en_topic_0093011495__row31713777"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011495__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_topic_0093011495__p36617123">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011495__p62319862">Specifies the project ID.</p>
</td>
</tr>
<tr id="en_topic_0093011495__row24007848"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011495__p65587574">interval</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011495__p10993288">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011495__p52047770">Specifies the DPD interval in seconds. The default value is <strong id="en_topic_0093011495__b540152244">30</strong>.</p>
</td>
</tr>
<tr id="en_topic_0093011495__row65776751"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011495__p26316604">timeout</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011495__p51270161">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011495__p33904373">Specifies the DPD timeout. The default value is 120 seconds.</p>
</td>
</tr>
<tr id="en_topic_0093011495__row36703909"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011495___GoBack">action</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011495__p27748670">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011495__p59789225">Specifies the DPD action. The value can be <strong id="en_topic_0093011495__b650049411">clear</strong>, <strong id="en_topic_0093011495__b1377281285">hold</strong>, <strong id="en_topic_0093011495__b226805162">restart</strong>, <strong id="en_topic_0093011495__b1092009837">disabled</strong>, or <strong id="en_topic_0093011495__b1560212833">restart-by-peer</strong>. The default value is <strong id="en_topic_0093011495__b798414169">hold</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="en_topic_0093011495__section4865465"><h4 class="sectiontitle">Example</h4><ul id="en_topic_0093011495__ul04891392610"><li id="en_topic_0093011495__li1748191352611">Example Request<pre class="screen" id="en_topic_0093011495__screen6445641722448">PUT /v2.0/vpn/ipsec-site-connections/{connection_id}
{
"ipsec_site_connection" : {
"mtu" : 1200,
}
}</pre>
</li></ul>
</div>
<ul id="en_topic_0093011495__ul594553310261"><li id="en_topic_0093011495__li10945113362611">Example Response<pre class="screen" id="en_topic_0093011495__screen1377314447266">{
"ipsec_site_connection": {
"status": "DOWN",
"psk": "secret",
"initiator": "bi-directional",
"name": "vpnconnection1",
"admin_state_up": true,
"project_id": "10039663455a446d8ba2cbb058b0f578",
"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"
}
}</pre>
</li></ul>
<div class="section" id="en_topic_0093011495__section6578292"><h4 class="sectiontitle">Returned Values</h4><p id="en_topic_0093011495__en-us_topic_0053740035_p19515943486">For details, see section <a href="en_topic_0093011522.html">Common Returned Values</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en_topic_0093011491.html">IPsec Connection Management</a></div>
</div>
</div>
View Git Blame Copy Permalink