forked from docs/doc-exports
gtema
6b71b4a1fa
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>
231 lines
18 KiB
HTML
231 lines
18 KiB
HTML
<a name="en_topic_0093011501"></a><a name="en_topic_0093011501"></a>
|
|
|
|
<h1 class="topictitle1">Updating a VPN Service</h1>
|
|
<div id="body11297860"><div class="section" id="en_topic_0093011501__section25709437"><h4 class="sectiontitle"><strong id="en_topic_0093011501__b842352706112523">Function</strong></h4><p id="en_topic_0093011501__p42711464">This interface is used to update a VPN service.</p>
|
|
</div>
|
|
<div class="section" id="en_topic_0093011501__section30058349"><h4 class="sectiontitle">URI</h4><p id="en_topic_0093011501__p1634503313456">PUT /v2.0/vpn/vpnservices/{service_id}</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en_topic_0093011501__table184162115335" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="en_topic_0093011501__row984914219336"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.2.3.2.5.1.1"><p id="en_topic_0093011501__p8849921163313"><strong id="en_topic_0093011501__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_0093011501__p384918214339">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_0093011501__p208493212330">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_0093011501__p1185732118339">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en_topic_0093011501__row10857162110332"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.3.2.5.1.1 "><p id="en_topic_0093011501__p17857142117336">service_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.2.3.2.5.1.2 "><p id="en_topic_0093011501__p18857152173311">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.2.3.2.5.1.3 "><p id="en_topic_0093011501__p385772133310">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.2.3.2.5.1.4 "><p id="en_topic_0093011501__p28642214334">Specifies the VPN service ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="en_topic_0093011501__section18807190"><h4 class="sectiontitle">Request Message</h4><p id="en_topic_0093011501__p167013504615"><a href="#en_topic_0093011501__table24429894">Table 2</a> describes the request parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="en_topic_0093011501__table24429894"></a><a name="table24429894"></a><table cellpadding="4" cellspacing="0" summary="" id="en_topic_0093011501__table24429894" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="en_topic_0093011501__row26383427"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.3.3.2.5.1.1"><p id="en_topic_0093011501__p56682808">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_0093011501__p27904713">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_0093011501__p45689312">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_0093011501__p9846754">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en_topic_0093011501__row9359903"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en_topic_0093011501__p19954658">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="en_topic_0093011501__p5714573">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="en_topic_0093011501__p60227273">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en_topic_0093011501__p46570941">Provides supplementary information about the VPN service.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011501__row16485292"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en_topic_0093011501__p60240296">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="en_topic_0093011501__p47625841">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="en_topic_0093011501__p32487918">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en_topic_0093011501__p14275720">Specifies the VPN service name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011501__row61372619"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en_topic_0093011501__p5126234">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_0093011501__p12571834">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="en_topic_0093011501__p11685651">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en_topic_0093011501__p7013644">Specifies the administrative status. The value can be <strong id="en_topic_0093011501__b842352706221557">true</strong> or <strong id="en_topic_0093011501__b84235270622160">false</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011501__row62741064"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en_topic_0093011501__p48861387">vpnservice</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="en_topic_0093011501__p65458312">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="en_topic_0093011501__p523045">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en_topic_0093011501__p42366666">Specifies the VPN service object.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="note" id="en_topic_0093011501__note11272103475"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ol id="en_topic_0093011501__ol1661617554714"><li id="en_topic_0093011501__li2061675204716">The <strong id="en_topic_0093011501__en-us_topic_0053740027_b84235270620329">project_id</strong> parameter is not supported.</li><li id="en_topic_0093011501__li126241857471">The value of <strong id="en_topic_0093011501__b842352706144933">name</strong> can contain 1 to 64 characters.</li><li id="en_topic_0093011501__li4624155184718">The value of <strong id="en_topic_0093011501__b120501305120950">description</strong> can contain a maximum of 255 characters.</li><li id="en_topic_0093011501__li062415144719">The value of <strong id="en_topic_0093011501__b842352706203227">admin_state_up</strong> can only be <strong id="en_topic_0093011501__b842352706203236">true</strong>.</li><li id="en_topic_0093011501__li1163210594713">The <strong id="en_topic_0093011501__b842352706111927">subnet_id</strong> parameter is unconfigurable.</li></ol>
|
|
</div></div>
|
|
</div>
|
|
<div class="section" id="en_topic_0093011501__section35046986"><h4 class="sectiontitle">Response Message</h4><p id="en_topic_0093011501__p9782172794717"><a href="#en_topic_0093011501__table9147936">Table 3</a> describes the response parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="en_topic_0093011501__table9147936"></a><a name="table9147936"></a><table cellpadding="4" cellspacing="0" summary="" id="en_topic_0093011501__table9147936" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="en_topic_0093011501__row55945983"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.4.3.2.5.1.1"><p id="en_topic_0093011501__p35330790">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.4.3.2.5.1.2"><p id="en_topic_0093011501__p43221770">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.4.3.2.5.1.3"><p id="en_topic_0093011501__p11302482">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45.91540845915409%" id="mcps1.3.4.3.2.5.1.4"><p id="en_topic_0093011501__p43085863">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en_topic_0093011501__row294000"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.4.3.2.5.1.1 "><p id="en_topic_0093011501__p23814038">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.2 "><p id="en_topic_0093011501__p49888896">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.3 "><p id="en_topic_0093011501__p14468758">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.4.3.2.5.1.4 "><p id="en_topic_0093011501__p31118786">Specifies the VPN service ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011501__row11633618"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.4.3.2.5.1.1 "><p id="en_topic_0093011501__p2799031">router_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.2 "><p id="en_topic_0093011501__p25394981">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.3 "><p id="en_topic_0093011501__p43727555">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.4.3.2.5.1.4 "><p id="en_topic_0093011501__p52271033">Specifies the router ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011501__row677253"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.4.3.2.5.1.1 "><p id="en_topic_0093011501__p54857523">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.2 "><p id="en_topic_0093011501__p14274382">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.3 "><p id="en_topic_0093011501__p15374269">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.4.3.2.5.1.4 "><p id="en_topic_0093011501__p37356265">Specifies the VPN service status. The value can be <strong id="en_topic_0093011501__b842352706212822">ACTIVE</strong>, <strong id="en_topic_0093011501__b842352706212827">DOWN</strong>, <strong id="en_topic_0093011501__b842352706212832">BUILD</strong>, <strong id="en_topic_0093011501__b842352706212835">ERROR</strong>, <strong id="en_topic_0093011501__b842352706212840">PENDING_UPDATE</strong>, or <strong id="en_topic_0093011501__b842352706212850">PENDING_DELETE</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011501__row662065"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.4.3.2.5.1.1 "><p id="en_topic_0093011501__p53627266">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.2 "><p id="en_topic_0093011501__p48841284">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.3 "><p id="en_topic_0093011501__p63829918">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.4.3.2.5.1.4 "><p id="en_topic_0093011501__p2840889">Specifies the VPN service name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011501__row25568006"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.4.3.2.5.1.1 "><p id="en_topic_0093011501__p57742629">external_v6_ip</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.2 "><p id="en_topic_0093011501__p46641368">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.3 "><p id="en_topic_0093011501__p19854472">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.4.3.2.5.1.4 "><p id="en_topic_0093011501__p64708380">Specifies the IPv6 address of the VPN service external gateway.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011501__row45504511"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.4.3.2.5.1.1 "><p id="en_topic_0093011501__p61986789">admin_state_up</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.2 "><p id="en_topic_0093011501__p54874019">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.3 "><p id="en_topic_0093011501__p15610594">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.4.3.2.5.1.4 "><p id="en_topic_0093011501__p56498634">Specifies the administrative status. The value can be <strong id="en_topic_0093011501__b842352706221557_2">true</strong> or <strong id="en_topic_0093011501__b84235270622160_2">false</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011501__row38725660"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.4.3.2.5.1.1 "><p id="en_topic_0093011501__p49770771">subnet_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.2 "><p id="en_topic_0093011501__p4900679">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.3 "><p id="en_topic_0093011501__p61410719">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.4.3.2.5.1.4 "><p id="en_topic_0093011501__p8212356">Specifies the subnet ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011501__row6802342"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.4.3.2.5.1.1 "><p id="en_topic_0093011501__p14118857">tenant_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.2 "><p id="en_topic_0093011501__p2776748">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.3 "><p id="en_topic_0093011501__p23590007">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.4.3.2.5.1.4 "><p id="en_topic_0093011501__p31742419">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011501__row17246319"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.4.3.2.5.1.1 "><p id="en_topic_0093011501__p54774566">external_v4_ip</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.2 "><p id="en_topic_0093011501__p7554882">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.3 "><p id="en_topic_0093011501__p7965739">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.4.3.2.5.1.4 "><p id="en_topic_0093011501__p41245128">Specifies the IPv4 address of the VPN service external gateway.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011501__row35661838"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.4.3.2.5.1.1 "><p id="en_topic_0093011501__p2927765">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.2 "><p id="en_topic_0093011501__p35822404">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.3 "><p id="en_topic_0093011501__p15933636">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.4.3.2.5.1.4 "><p id="en_topic_0093011501__p15556157">Provides supplementary information about the VPN service.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011501__row5787686"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.4.3.2.5.1.1 "><p id="en_topic_0093011501__p66149382">vpnservice</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.2 "><p id="en_topic_0093011501__p56499698">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.3 "><p id="en_topic_0093011501__p13072851">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.4.3.2.5.1.4 "><p id="en_topic_0093011501__p52268049">Specifies the VPN service object.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="en_topic_0093011501__section46987420"><h4 class="sectiontitle">Example</h4><ul id="en_topic_0093011501__ul43765519471"><li id="en_topic_0093011501__li1437675104711">Example Request<pre class="screen" id="en_topic_0093011501__screen48030134215957">PUT /v2.0/vpn/vpnservices/{service_id}
|
|
{
|
|
"vpnservice" : {
|
|
"description" : "Updated description"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="en_topic_0093011501__ul61961541480"><li id="en_topic_0093011501__li119620414486">Example Response<pre class="screen" id="en_topic_0093011501__screen12299121514811">{
|
|
"vpnservice": {
|
|
"router_id": "881b7b30-4efb-407e-a162-5630a7af3595",
|
|
"status": "ACTIVE",
|
|
"name": "myvpn",
|
|
"admin_state_up": true,
|
|
"subnet_id": null,
|
|
"project_id": "26de9cd6cae94c8cb9f79d660d628e1f",
|
|
"tenant_id": "26de9cd6cae94c8cb9f79d660d628e1f",
|
|
"id": "41bfef97-af4e-4f6b-a5d3-4678859d2485",
|
|
"description": "Updated description",
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
<div class="section" id="en_topic_0093011501__section6578292"><h4 class="sectiontitle">Returned Values</h4><p id="en_topic_0093011501__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_0093011497.html">VPN Service Management</a></div>
|
|
</div>
|
|
</div>
|
|
|