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

297 lines
34 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000001807530380"></a><a name="EN-US_TOPIC_0000001807530380"></a>
<h1 class="topictitle1">Updating an IPsec Policy</h1>
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_section45521706"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p55629438">This API is used to update an IPsec policy.</p>
<div class="note" id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_note2483123917020"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p448315391706">If the IPsec policy is updated, the IPsec VPN connection also needs to be updated.</p>
</div></div>
</div>
<div class="section" id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_section7042173"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p9473711901">PUT /v2.0/vpn/ipsecpolicies/{ipsecpolicy_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_table44973181017" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_row15504918204"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.2.3.2.5.1.1"><p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p1550413181805">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_0000001807530380__en-us_topic_0000001540817542_p135113181904">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_0000001807530380__en-us_topic_0000001540817542_p45111018804">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_0000001807530380__en-us_topic_0000001540817542_p125111818109">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_row1151910188014"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p11519418808">ipsecpolicy_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_0000001807530380__en-us_topic_0000001540817542_p051911182003">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_0000001807530380__en-us_topic_0000001540817542_p125198181109">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_0000001807530380__en-us_topic_0000001540817542_p1651921810014">Specifies the IPsec policy ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_section33545144"><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p1319557603"><a href="#EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_table17322790">Table 2</a> describes the request parameters.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_table17322790"></a><a name="en-us_topic_0000001540817542_table17322790"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_table17322790" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_row19920592"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.3.3.2.5.1.1"><p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p2955276">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_0000001807530380__en-us_topic_0000001540817542_p38050837">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_0000001807530380__en-us_topic_0000001540817542_p62218962">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_0000001807530380__en-us_topic_0000001540817542_p6571180">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_row55864401"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p28722627">ipsecpolicy</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p44831437">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_0000001807530380__en-us_topic_0000001540817542_p7467800">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_0000001807530380__en-us_topic_0000001540817542_p912076">Specifies the IPsec policy object.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_row8208684"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p60923663">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_0000001807530380__en-us_topic_0000001540817542_p35869679">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_0000001807530380__en-us_topic_0000001540817542_p19762867">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_0000001807530380__en-us_topic_0000001540817542_p57288388">Provides supplementary information about the IPsec policy.</p>
<p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p15422122125316">The description can contain a maximum of 255 characters.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_row45833444"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p21521490">transform_protocol</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p65519169">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_0000001807530380__en-us_topic_0000001540817542_p5452505">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_0000001807530380__en-us_topic_0000001540817542_p38999745">Specifies the transform protocol used, which can be <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b1680141385920">esp</strong>, <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b581121395910">ah</strong>, or <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b11821413185910">ah-esp</strong>. The default protocol is <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b16369121685913">esp</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_row15453386"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p43764782">auth_algorithm</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p55286454">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_0000001807530380__en-us_topic_0000001540817542_p49017803">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_0000001807530380__en-us_topic_0000001540817542_p11019092">Specifies the authentication hash algorithm, which can be <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b394414248593">md5</strong>, <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b19944192405912">sha1</strong>, <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b15945162495919">sha2-256</strong>, <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b16946132419593">sha2-384</strong>, or <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b4946224195912">sha2-512</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_row32062968"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p46963595">encapsulation_mode</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p45954822">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_0000001807530380__en-us_topic_0000001540817542_p31353106">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_0000001807530380__en-us_topic_0000001540817542_p56573654">Specifies the encapsulation mode. The default mode is <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b13273018590">tunnel</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_row39400845"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p37351897">encryption_algorithm</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p5604850">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_0000001807530380__en-us_topic_0000001540817542_p51339711">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_0000001807530380__en-us_topic_0000001540817542_p64875945">Specifies the encryption algorithm, which can be <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b19165193812595">3des</strong>, <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b916619388599">aes-128</strong>, <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b101674389591">aes-192</strong>, or <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b11168138195917">aes-256</strong>. The default algorithm is <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b18169338185910">aes-128</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_row47012596"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p49923923">pfs</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p17305987">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_0000001807530380__en-us_topic_0000001540817542_p59607724">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_0000001807530380__en-us_topic_0000001540817542_p6588145672511">Specifies the PFS, which can be <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b18869114365918">group1</strong>, <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b58701436599">group2</strong>, <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b1287474355919">group5</strong>, <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b6875343125915">group14</strong>, <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b118761443195915">group15</strong>, <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b2877124315599">group16</strong>, <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b1787814435596">group19</strong>, <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b7878343185920">group20</strong>, <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b5879124310594">group21</strong>, or <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b288020436598">disable</strong>.</p>
<p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p489023122614">The default PFS is <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b18214482599">group5</strong>.</p>
<p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p89224267257"><strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b11794184912592">disable</strong> indicates that PFS is disabled.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_row34595869"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p50801977">value</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p21319498">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_0000001807530380__en-us_topic_0000001540817542_p49157816">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_0000001807530380__en-us_topic_0000001540817542_p22360170">Specifies the lifetime value of the SA, which is <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b2241155511591">3600</strong> by default. The default unit is <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b11242195555913">seconds</strong>.</p>
<p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p32241942155312">Supported range: 60 to 604800</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_row67023809"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p60219412">units</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p45934241">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_0000001807530380__en-us_topic_0000001540817542_p29686030">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_0000001807530380__en-us_topic_0000001540817542_p55758211">Specifies the lifecycle unit, which is <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b1785813111015">seconds</strong> by default.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_row32061857"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p46873590">lifetime</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p38664423">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_0000001807530380__en-us_topic_0000001540817542_p44810590">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_0000001807530380__en-us_topic_0000001540817542_p5779136">Specifies the lifetime object of SA.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_row52012230"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p52241078">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_0000001807530380__en-us_topic_0000001540817542_p3668935">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_0000001807530380__en-us_topic_0000001540817542_p28748320">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_0000001807530380__en-us_topic_0000001540817542_p46912618">Specifies the IPsec policy name.</p>
<p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p1715811745314">The name can contain 1 to 64 characters.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="note" id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_note332171616117"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p class="msonormalcxspfirst" id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p29891358195217">Parameter <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b199881189016">project_id</strong> is not supported.</p>
</div></div>
</div>
<div class="section" id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_section33470841"><h4 class="sectiontitle">Response</h4><p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p58352441615"><a href="#EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_table41825741">Table 3</a> describes the response parameters.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_table41825741"></a><a name="en-us_topic_0000001540817542_table41825741"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_table41825741" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_row35695699"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.4.3.2.4.1.1"><p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p5670474">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_0000001807530380__en-us_topic_0000001540817542_p56655270">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_0000001807530380__en-us_topic_0000001540817542_p66343596">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_row5122214"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p12246180">encryption_algorithm</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p52416527">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_0000001807530380__en-us_topic_0000001540817542_p39015754">Specifies the encryption algorithm, which can be <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b299516244019">3des</strong>, <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b209960242002">aes-128</strong>, <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b2997112416019">aes-192</strong>, or <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b49984241407">aes-256</strong>. The default algorithm is <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b69991624108">aes-128</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_row15597466"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p55435195">pfs</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p61065805">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_0000001807530380__en-us_topic_0000001540817542_p1341342012274">Specifies the PFS, which can be <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b209092028301">group1</strong>, <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b491011281701">group2</strong>, <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b129115285020">group5</strong>, <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b1591115281608">group14</strong>, <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b149121828604">group15</strong>, <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b1391372814018">group16</strong>, <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b19914728806">group19</strong>, <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b139141228607">group20</strong>, <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b12915528905">group21</strong>, or <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b891516288017">disable</strong>.</p>
<p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p74161620162715">The default PFS is <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b89092301016">group5</strong>.</p>
<p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p14417122062713"><strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b17501203213011">disable</strong> indicates that PFS is disabled.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_row48367351"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p25441382">lifetime</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p47486057">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_0000001807530380__en-us_topic_0000001540817542_p36677197">Specifies the lifetime object of SA.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_row61659320"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p28349038">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_0000001807530380__en-us_topic_0000001540817542_p14570748">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_0000001807530380__en-us_topic_0000001540817542_p35661763">Specifies the IPsec policy name.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_row52520413"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p26295076">transform_protocol</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p49526440">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_0000001807530380__en-us_topic_0000001540817542_p1856645">Specifies the transform protocol used, which can be <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b17769643509">esp</strong>, <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b11770144311015">ah</strong>, or <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b167716431805">ah-esp</strong>. The default protocol is <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b12806146303">esp</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_row16709807"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p11317154">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_0000001807530380__en-us_topic_0000001540817542_p44274261">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_0000001807530380__en-us_topic_0000001540817542_p36263964">Specifies the project ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_row57940224"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p62646535">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_0000001807530380__en-us_topic_0000001540817542_p41204595">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_0000001807530380__en-us_topic_0000001540817542_p28849561">Specifies the IPsec policy ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_row58319463"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p26256062">encapsulation_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_0000001807530380__en-us_topic_0000001540817542_p46366269">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_0000001807530380__en-us_topic_0000001540817542_p4615638">Specifies the encapsulation mode. The default mode is <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b960520531903">tunnel</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_row41540743"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p9356983">auth_algorithm</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p19718131">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_0000001807530380__en-us_topic_0000001540817542_p51881906">Specifies the authentication hash algorithm, which can be <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b2583105913015">md5</strong>, <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b158425910012">sha1</strong>, <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b65859591005">sha2-256</strong>, <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b1058615917015">sha2-384</strong>, or <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b125868591302">sha2-512</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_row64283975"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p39619499">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_0000001807530380__en-us_topic_0000001540817542_p55062814">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_0000001807530380__en-us_topic_0000001540817542_p20114008">Provides supplementary information about the IPsec policy.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_row17450296"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p4187856">ipsecpolicy</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p3672032">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_0000001807530380__en-us_topic_0000001540817542_p123786">Specifies the IPsec policy object.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_row5825185"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p2077973">value</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p34098154">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_0000001807530380__en-us_topic_0000001540817542_p44149718">Specifies the lifetime value of the SA, which is <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b19859661019">3600</strong> by default. The default unit is <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b28622068116">seconds</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_row61803142"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p39998624">units</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_p18663102">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_0000001807530380__en-us_topic_0000001540817542_p42047784">Specifies the lifecycle unit, which is <strong id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_b188967103119">seconds</strong> by default.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_section32802119"><h4 class="sectiontitle">Example</h4><ul id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_ul1857414331424"><li id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_li557463313219">Example request<pre class="screen" id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_screen11126208214914">PUT /v2.0/vpn/ipsecpolicies/{ipsecpolicy_id}
{
"ipsecpolicy" : {
"pfs" : "group14"
}
}</pre>
</li></ul>
</div>
<ul id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_ul143011041327"><li id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_li830111415218">Example response<pre class="screen" id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_screen10183752421">{
"ipsecpolicy": {
"name": "ipsecpolicy1",
"transform_protocol": "esp",
"auth_algorithm": "sha1",
"encapsulation_mode": "tunnel",
"encryption_algorithm": "aes-128",
"pfs": "group14",
"tenant_id": "ccb81365fe36411a9011e90491fe1330",
"lifetime": {
"units": "seconds",
"value": 3600
},
"id": "5291b189-fd84-46e5-84bd-78f40c05d69c",
"description": ""
}
}</pre>
</li></ul>
<div class="section" id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_section6578292"><h4 class="sectiontitle">Returned Values</h4><p id="EN-US_TOPIC_0000001807530380__en-us_topic_0000001540817542_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_1035.html">IPsec Policy Management</a></div>
</div>
</div>
View Git Blame Copy Permalink