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

289 lines
32 KiB
HTML
Raw Permalink Blame History

<a name="EN-US_TOPIC_0000001854089273"></a><a name="EN-US_TOPIC_0000001854089273"></a>
<h1 class="topictitle1">Creating an IKE Policy</h1>
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_section1108643"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_p35425694">This API is used to create an IKE policy.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_section9977790"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_p695810616616">POST /v2.0/vpn/ikepolicies</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_section2894687"><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_p10780424169"><a href="#EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_table59280891">Table 1</a> describes the request parameters.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_table59280891"></a><a name="en-us_topic_0000001541136754_table59280891"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_table59280891" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Request parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_row23389273"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.3.3.2.5.1.1"><p id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_p15482964">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_0000001854089273__en-us_topic_0000001541136754_p46160547">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_0000001854089273__en-us_topic_0000001541136754_p48016815">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_0000001854089273__en-us_topic_0000001541136754_p64156767">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_row29315611"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_p25754316">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_0000001854089273__en-us_topic_0000001541136754_p5724890">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_0000001854089273__en-us_topic_0000001541136754_p61062956">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_0000001854089273__en-us_topic_0000001541136754_p47152427">Specifies the IKE policy name.</p>
<p id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_p9948162245419">The name can contain 1 to 64 characters.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_row21718662"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_p14381235">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_0000001854089273__en-us_topic_0000001541136754_p24029376">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_0000001854089273__en-us_topic_0000001541136754_p222421">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_0000001854089273__en-us_topic_0000001541136754_p18016155">Specifies the authentication hash algorithm, which can be <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b842352706165820">md5</strong>, <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b842352706165823">sha1</strong>, <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b842352706165833">sha2-256</strong>, <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b842352706165840">sha2-384</strong>, or <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b842352706165851">sha2-512</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_row27927672"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_p47548937">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_0000001854089273__en-us_topic_0000001541136754_p26258720">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_0000001854089273__en-us_topic_0000001541136754_p46581538">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_0000001854089273__en-us_topic_0000001541136754_p15008249">Provides supplementary information about the IKE policy.</p>
<p id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_p13302203895416">The description can contain up to 255 characters.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_row856520"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_p2269305">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_0000001854089273__en-us_topic_0000001541136754_p49596018">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_0000001854089273__en-us_topic_0000001541136754_p57854556">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_0000001854089273__en-us_topic_0000001541136754_p55707487">Specifies the encryption algorithm, which can be <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b8423527061721">3des</strong>, <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b84235270617211">aes-128</strong>, <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b84235270617219">aes-192</strong>, or <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b84235270617227">aes-256</strong>. The default value is <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b84235270617239">aes-128</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_row31605337"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_p9895475">ike_version</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_p63335993">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_0000001854089273__en-us_topic_0000001541136754_p29941845">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_0000001854089273__en-us_topic_0000001541136754_p9370348">Specifies the IKE version, which can be <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b8937529134">v1</strong> or <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b2663632833">v2</strong>. The default version is <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b17856174841"> v1</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_row17224274"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_p52988976">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_0000001854089273__en-us_topic_0000001541136754_p64248638">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_0000001854089273__en-us_topic_0000001541136754_p36757156">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_0000001854089273__en-us_topic_0000001541136754_p24539659">Specifies the lifetime object of SA.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_row19530342"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_p38453873">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_0000001854089273__en-us_topic_0000001541136754_p27755984">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_0000001854089273__en-us_topic_0000001541136754_p33642220">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_0000001854089273__en-us_topic_0000001541136754_p6588145672511">Specifies the PFS, which can be <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b85524134353">group1</strong>, <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b65521130351">group2</strong>, <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b6553713133512">group5</strong>, <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b1355351353518">group14</strong>, <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b16553111311357">group15</strong>, <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b6553613103510">group16</strong>, <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b11553181314358">group19</strong>, <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b05551313173510">group20</strong>, <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b55551313163511">group21</strong>, or <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b5555113143514">disable</strong>.</p>
<p id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_p489023122614">The default PFS is <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b769615123514">group5</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_row30443021"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_p49965631">phase1_negotiation_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_0000001854089273__en-us_topic_0000001541136754_p20684297">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_0000001854089273__en-us_topic_0000001541136754_p64815380">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_0000001854089273__en-us_topic_0000001541136754_p15554440">Specifies the IKE mode, which is <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b842352706213613">main</strong> by default.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_row5772232"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_p64897643">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_p22217739">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_0000001854089273__en-us_topic_0000001541136754_p54806415">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_0000001854089273__en-us_topic_0000001541136754_p10134624">Specifies the project ID.</p>
<p id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_p3597015185413">The ID can contain up to 255 characters.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_row24102752"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_p6165902">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_0000001854089273__en-us_topic_0000001541136754_p29676093">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_0000001854089273__en-us_topic_0000001541136754_p54953365">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_0000001854089273__en-us_topic_0000001541136754_p22037565">Specifies the lifetime value of the SA, which is <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b11252141981913">3600</strong> by default. The default unit is <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b84235270610146">seconds</strong>.</p>
<p id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_p17794139185516">Supported range: 60 to 604800</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_row64120358"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_p26366538">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_0000001854089273__en-us_topic_0000001541136754_p55314834">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_0000001854089273__en-us_topic_0000001541136754_p51316583">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_0000001854089273__en-us_topic_0000001541136754_p63002544">Specifies the lifecycle unit, which is <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b84235270610658">seconds</strong> by default.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_row5607849"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_p51582645">ikepolicy</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_p17444750">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_0000001854089273__en-us_topic_0000001541136754_p3738651">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_0000001854089273__en-us_topic_0000001541136754_p34395333">Specifies the IKE policy object.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="note" id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_note5178145819618"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_p1174203710349">Parameter <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b1445210119459">project_id</strong> is not supported.</p>
</div></div>
</div>
<div class="section" id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_section26052191"><h4 class="sectiontitle">Response</h4><p id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_p4862630378"><a href="#EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_table34558579">Table 2</a> describes the response parameters.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_table34558579"></a><a name="en-us_topic_0000001541136754_table34558579"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_table34558579" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_row60007281"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.4.3.2.4.1.1"><p id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_p28751554">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_0000001854089273__en-us_topic_0000001541136754_p47174532">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_0000001854089273__en-us_topic_0000001541136754_p6025849">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_row18331773"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754__Hlk477540336">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_0000001854089273__en-us_topic_0000001541136754_p15678685">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_0000001854089273__en-us_topic_0000001541136754_p57075007">Specifies the authentication hash algorithm, which can be <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b147475342">md5</strong>, <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b250203564">sha1</strong>, <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b519103845">sha2-256</strong>, <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b1550655514">sha2-384</strong>, or <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b430773523">sha2-512</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_row43913021"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_p184914">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_0000001854089273__en-us_topic_0000001541136754_p14978051">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_0000001854089273__en-us_topic_0000001541136754_p23621468">Provides supplementary information about the IKE policy.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_row11266626"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_p40181490">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_0000001854089273__en-us_topic_0000001541136754_p33475267">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_0000001854089273__en-us_topic_0000001541136754_p51027174">Specifies the encryption algorithm, which can be <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b562818481059">3des</strong>, <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b1462915481552">aes-128</strong>, <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b156303487517">aes-192</strong>, or <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b17631194819515">aes-256</strong>. The default algorithm is <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b1663215489517">aes-128</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_row56591389"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_p20499795">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_0000001854089273__en-us_topic_0000001541136754_p49870669">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_0000001854089273__en-us_topic_0000001541136754_p45749167">Specifies the lifetime object of SA.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_row9089319"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_p65146268">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_0000001854089273__en-us_topic_0000001541136754_p42356378">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_0000001854089273__en-us_topic_0000001541136754_p2391374">Specifies the IKE policy name.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_row21522370"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_p65590400">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_0000001854089273__en-us_topic_0000001541136754_p11222187">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_0000001854089273__en-us_topic_0000001541136754_p1581194113275">Specifies the PFS, which can be <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b21116168356">group1</strong>, <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b411215162358">group2</strong>, <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b1711221633514">group5</strong>, <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b1911411673510">group14</strong>, <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b51148165354">group15</strong>, <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b1111511166357">group16</strong>, <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b7115141623520">group19</strong>, <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b131165162352">group20</strong>, <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b511614167351">group21</strong>, or <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b10116141643514">disable</strong>.</p>
<p id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_p38111841102710">The default PFS is <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b16151121715354">group5</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_row26008214"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_p26290551">phase1_negotiation_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_0000001854089273__en-us_topic_0000001541136754_p49159881">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_0000001854089273__en-us_topic_0000001541136754_p12781022">Specifies the IKE mode, which is <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b241208422">main</strong> by default.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_row47920339"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_p56342274">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_0000001854089273__en-us_topic_0000001541136754_p321477">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_0000001854089273__en-us_topic_0000001541136754_p28839721">Specifies the project ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_row58230900"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_p19082474">ikepolicy</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_p2176568">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_0000001854089273__en-us_topic_0000001541136754_p53389951">Specifies the IKE policy object.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_row24598620"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_p46331171">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_0000001854089273__en-us_topic_0000001541136754_p61837391">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_0000001854089273__en-us_topic_0000001541136754_p42045429">Specifies the lifetime value of the SA, which is <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b1831212813518">3600</strong> by default. The default unit is <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b19313138183513">seconds</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_row42864547"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_p49476282">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_0000001854089273__en-us_topic_0000001541136754_p48155897">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_0000001854089273__en-us_topic_0000001541136754_p2313746">Specifies the lifecycle unit, which is <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b255542133519">seconds</strong> by default.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_row20823715"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_p8999315">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_0000001854089273__en-us_topic_0000001541136754_p57855887">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_0000001854089273__en-us_topic_0000001541136754_p24745166">Specifies the IKE policy ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_row21379907"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_p54050919">ike_version</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_p16048282">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_0000001854089273__en-us_topic_0000001541136754_p1272218511303">Specifies the IKE version, which can be <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b169282712418">v1</strong> or <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b192917719415">v2</strong>. The default version is <strong id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_b1929573418"> v1</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_section33143133"><h4 class="sectiontitle">Example</h4><ul id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_ul19391205811714"><li id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_li11391195816712">Example request<pre class="screen" id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_screen63961269175526">POST /v2.0/vpn/ikepolicies
{
"ikepolicy" : {
"phase1_negotiation_mode" : "main",
"auth_algorithm" : "sha1",
"encryption_algorithm" : "aes-128",
"pfs" : "group5",
"lifetime" : {
"units" : "seconds",
"value" : 7200
},
"ike_version" : "v1",
"name" : "ikepolicy1"
}
}</pre>
</li></ul>
</div>
<ul id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_ul18649131017819"><li id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_li1564916106817">Example response<pre class="screen" id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_screen126791519781">{
"ikepolicy" : {
"name" : "ikepolicy1",
"tenant_id" : "ccb81365fe36411a9011e90491fe1330",
"auth_algorithm" : "sha1",
"encryption_algorithm" : "aes-128",
"pfs" : "group5",
"phase1_negotiation_mode" : "main",
"lifetime" : {
"units" : "seconds",
"value" : 7200
},
"ike_version" : "v1",
"id" : "5522aff7-1b3c-48dd-9c3c-b50f016b73db",
"description" : ""
}
}</pre>
</li></ul>
<div class="section" id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_section6578292"><h4 class="sectiontitle">Returned Values</h4><p id="EN-US_TOPIC_0000001854089273__en-us_topic_0000001541136754_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_1041.html">IKE Policy Management</a></div>
</div>
</div>
View Git Blame Copy Permalink