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

290 lines
32 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000001807370548"></a><a name="EN-US_TOPIC_0000001807370548"></a>
<h1 class="topictitle1">Creating an IPsec Policy</h1>
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_section51184318"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p15512181">This API is used to create an IPsec policy.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_section58005681"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p883224265214">POST /v2.0/vpn/ipsecpolicies</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_section839735"><h4 class="sectiontitle">Request</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_table45459112" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Request parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_row26085680"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.3.2.2.5.1.1"><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p32565348">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.3.2.2.5.1.2"><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p20547495">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.3.2.2.5.1.3"><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p53734436">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.91540845915409%" id="mcps1.3.3.2.2.5.1.4"><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p57522049">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_row28774374"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p49022972">name</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p11437802">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p54046809">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p15715441">Specifies the IPsec policy name.</p>
<p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p14154310125018">The name can contain 1 to 64 characters.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_row7221243"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p48049826">pfs</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p66830726">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p44579726">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p1020312412913">Specifies the PFS, which can be <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b488215063218">group1</strong>, <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b1895111102329">group2</strong>, <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b2527141953217">group5</strong>, <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b2653172453212">group14</strong>, <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b116523011322">group15</strong>, <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b207979452325">group16</strong>, <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b6866052193219">group19</strong>, <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b69228083313">group20</strong>, <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b48501778336">group21</strong>, or <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b644761513314">disable</strong>.</p>
<p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p32051440298">The default PFS is <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b842352706201018">group5</strong>.</p>
<p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p1206943292"><strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b2626173812332">disable</strong> indicates that PFS is disabled.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_row17930557"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p43089040">auth_algorithm</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p551331">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p44657822">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p60513834">Specifies the authentication hash algorithm, which can be <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b842352706165820">md5</strong>, <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b842352706165823">sha1</strong>, <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b842352706165833">sha2-256</strong>, <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b842352706165840">sha2-384</strong>, or <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b842352706165851">sha2-512</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_row7753598"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p24061669">description</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p2838193">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p28567114">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p32234903">Provides supplementary information about the IPsec policy.</p>
<p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p396183113501">The description can contain up to 255 characters.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_row21678677"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p11142412">encapsulation_mode</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p30120171">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p23814811">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p49951556">Specifies the encapsulation mode, which is <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b1242020162477">tunnel</strong> by default.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_row46910821"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p41680117">encryption_algorithm</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p20646289">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p61736738">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p34619920">Specifies the encryption algorithm, which can be <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b8423527061721">3des</strong>, <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b84235270617211">aes-128</strong>, <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b84235270617219">aes-192</strong>, or <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b84235270617227">aes-256</strong>. The default algorithm is <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b84235270617239">aes-128</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_row43143829"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p4989273">ipsecpolicy</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p1477932">Object</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p52603705">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p33041702">Specifies the IPsec policy object.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_row28939864"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p62427641">lifetime</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p23474126">Object</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p22356031">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p66008118">Specifies the lifetime object of SA.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_row57202150"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p2862558">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p30540622">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p57871327">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p57065912">Specifies the project ID.</p>
<p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p1725510597497">The ID can contain up to 255 characters.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_row43831168"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p60663705">transform_protocol</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p14813071">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p59008073">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p14924591">Specifies the transform protocol used, which can be <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b842352706184452">esp</strong>, <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b842352706184456">ah</strong>, or <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b84235270618456">ah-esp</strong>. The default protocol is <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b286324541">esp</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_row15056516"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p11618302">value</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p1558396">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p59121255">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p24092326">Specifies the lifetime value of the SA. The default unit is <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b84235270610843">seconds</strong>. The default value is <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b84235270610838">3600</strong>.</p>
<p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p122073110515">Supported range: 60 to 604800</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_row15504345"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p47892402">units</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p54079315">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p18348389">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p9824527">Specifies the lifecycle unit. The default unit is <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b84235270610853">seconds</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="note" id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_note10440578538"><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_0000001807370548__en-us_topic_0000001541136758_p1947385714519">Parameter <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b591910159498">project_id</strong> is not supported.</p>
</div></div>
</div>
<div class="section" id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_section7557620"><h4 class="sectiontitle">Response</h4><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p53801524537"><a href="#EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_table57589242">Table 2</a> describes the response parameters.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_table57589242"></a><a name="en-us_topic_0000001541136758_table57589242"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_table57589242" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_row35311297"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.4.3.2.4.1.1"><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p41642789">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_0000001807370548__en-us_topic_0000001541136758_p17622742">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_0000001807370548__en-us_topic_0000001541136758_p61346876">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_row3041091"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p45001781">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_0000001807370548__en-us_topic_0000001541136758_p21265660">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_0000001807370548__en-us_topic_0000001541136758_p4672552">Specifies the authentication hash algorithm, which can be <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b1534877601">md5</strong>, <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b149683402">sha1</strong>, <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b755782077">sha2-256</strong>, <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b1877844456">sha2-384</strong>, or <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b495909657">sha2-512</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_row42052973"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p50847687">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_0000001807370548__en-us_topic_0000001541136758_p25022010">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_0000001807370548__en-us_topic_0000001541136758_p21127816">Provides supplementary information about the IPsec policy.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_row55932620"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p34248408">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_0000001807370548__en-us_topic_0000001541136758_p22657631">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_0000001807370548__en-us_topic_0000001541136758_p10588164">Specifies the encapsulation mode. The default mode is <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b84235270617116">tunnel</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_row28184617"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p1252607">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_0000001807370548__en-us_topic_0000001541136758_p34352342">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_0000001807370548__en-us_topic_0000001541136758_p34153125">Specifies the encryption algorithm, which can be <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b2074210607">3des</strong>, <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b1171263541">aes-128</strong>, <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b456510520">aes-192</strong>, or <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b1114952897">aes-256</strong>. The default algorithm is <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b774224000">aes-128</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_row38942675"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p240095">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_0000001807370548__en-us_topic_0000001541136758_p19447695">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_0000001807370548__en-us_topic_0000001541136758_p22377468">Specifies the IPsec policy ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_row51358334"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p66384370">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_0000001807370548__en-us_topic_0000001541136758_p8424883">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_0000001807370548__en-us_topic_0000001541136758_p45062713">Specifies the IPsec policy object.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_row2911240"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p34483920">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_0000001807370548__en-us_topic_0000001541136758_p41734120">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_0000001807370548__en-us_topic_0000001541136758_p13397545">Specifies the lifetime object of SA.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_row53469045"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p36025402">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_0000001807370548__en-us_topic_0000001541136758_p32376435">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_0000001807370548__en-us_topic_0000001541136758_p22238563">Specifies the IPsec policy name.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_row65929341"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p38676409">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_0000001807370548__en-us_topic_0000001541136758_p45781421">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_0000001807370548__en-us_topic_0000001541136758_p6588145672511">Specifies the PFS, which can be <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b12346651183314">group1</strong>, <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b8348351193317">group2</strong>, <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b135125143320">group5</strong>, <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b1935375117331">group14</strong>, <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b5355145163316">group15</strong>, <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b13356135113317">group16</strong>, <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b193588513336">group19</strong>, <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b1360051163319">group20</strong>, <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b73621551163316">group21</strong>, or <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b43643516332">disable</strong>.</p>
<p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p489023122614">The default PFS is <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b1687911520349">group5</strong>.</p>
<p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p89224267257"><strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b2429144518504">disable</strong> indicates that PFS is disabled.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_row810977"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p65689182">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_0000001807370548__en-us_topic_0000001541136758_p19223544">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_0000001807370548__en-us_topic_0000001541136758_p28119201">Specifies the project ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_row51746218"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p30694147">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_0000001807370548__en-us_topic_0000001541136758_p3197948">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_0000001807370548__en-us_topic_0000001541136758_p43771375">Specifies the transform protocol used, which can be <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b807421632">esp</strong>, <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b1720937957">ah</strong>, or <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b1015562708">ah-esp</strong>. The default protocol is <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b592726125110">esp</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_row51573880"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p16734741">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_0000001807370548__en-us_topic_0000001541136758_p13336762">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_0000001807370548__en-us_topic_0000001541136758_p59650110">Specifies the lifetime value of the SA, which is <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b89812171513">3600</strong> by default. The default unit is <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b16984191710518">seconds</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_row67088950"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_p65495901">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_0000001807370548__en-us_topic_0000001541136758_p3567727">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_0000001807370548__en-us_topic_0000001541136758_p53976698">Specifies the lifecycle unit, which is <strong id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_b19434142712513">seconds</strong> by default.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_section909717"><h4 class="sectiontitle">Example</h4><ul id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_ul1285151755415"><li id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_li528541725412">Example request<pre class="screen" id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_screen36026157171642">POST /v2.0/vpn/ipsecpolicies
{
"ipsecpolicy" : {
"name" : "ipsecpolicy1",
"transform_protocol" : "esp",
"auth_algorithm" : "sha1",
"encapsulation_mode" : "tunnel",
"encryption_algorithm" : "aes-128",
"pfs" : "group5",
"lifetime" : {
"units" : "seconds",
"value" : 7200
}
}
}</pre>
</li></ul>
</div>
<ul id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_ul2039442945414"><li id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_li83941129185413">Example response<pre class="screen" id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_screen18370104412545">{
"ipsecpolicy" : {
"name" : "ipsecpolicy1",
"transform_protocol" : "esp",
"auth_algorithm" : "sha1",
"encapsulation_mode" : "tunnel",
"encryption_algorithm" : "aes-128",
"pfs" : "group5",
"tenant_id" : "ccb81365fe36411a9011e90491fe1330",
"lifetime" : {
"units" : "seconds",
"value" : 7200
},
"id" : "5291b189-fd84-46e5-84bd-78f40c05d69c",
"description" : ""
}
}</pre>
</li></ul>
<div class="section" id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_section6578292"><h4 class="sectiontitle">Returned Values</h4><p id="EN-US_TOPIC_0000001807370548__en-us_topic_0000001541136758_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