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

292 lines
33 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000001854169229"></a><a name="EN-US_TOPIC_0000001854169229"></a>
<h1 class="topictitle1">Updating an IKE Policy</h1>
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_section59206997"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_p17618221">This API is used to update an IKE policy.</p>
<div class="note" id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_note36176352147"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_p762563514145">If the IKE policy is updated, the IPsec VPN connection also needs to be updated.</p>
</div></div>
</div>
<div class="section" id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_section63100926"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_p1480725241316">PUT /v2.0/vpn/ikepolicies/{ikepolicy_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_table492018108144" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_row29285105141"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.2.3.2.5.1.1"><p id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_p3928151019147">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_0000001854169229__en-us_topic_0000001541136770_p69359101144">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_0000001854169229__en-us_topic_0000001541136770_p7935510111417">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_0000001854169229__en-us_topic_0000001541136770_p893571013140">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_row1294311103147"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_p1943141015146">ikepolicy_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_0000001854169229__en-us_topic_0000001541136770_p69514103140">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_0000001854169229__en-us_topic_0000001541136770_p179517108141">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_0000001854169229__en-us_topic_0000001541136770_p1595131020148">Specifies the IKE policy ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_section10901353"><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_p8202104881417"><a href="#EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_table9467673">Table 2</a> describes the request parameters.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_table9467673"></a><a name="en-us_topic_0000001541136770_table9467673"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_table9467673" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_row5698118"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.3.3.2.5.1.1"><p id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_p58894414">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_0000001854169229__en-us_topic_0000001541136770_p5718243">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_0000001854169229__en-us_topic_0000001541136770_p60524524">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_0000001854169229__en-us_topic_0000001541136770_p3539410">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_row61306625"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_p66889567">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_0000001854169229__en-us_topic_0000001541136770_p49345813">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_0000001854169229__en-us_topic_0000001541136770_p37587916">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_0000001854169229__en-us_topic_0000001541136770_p24722347">Specifies the authentication hash algorithm, which can be <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b842352706165820">md5</strong>, <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b842352706165823">sha1</strong>, <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b842352706165833">sha2-256</strong>, <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b842352706165840">sha2-384</strong>, or <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b842352706165851">sha2-512</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_row21174538"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_p37415993">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_0000001854169229__en-us_topic_0000001541136770_p10796581">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_0000001854169229__en-us_topic_0000001541136770_p2107829">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_0000001854169229__en-us_topic_0000001541136770_p36516433">Provides supplementary information about the IKE policy.</p>
<p id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_p929014461798">The description can contain up to 255 characters.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_row60212448"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_p45370106">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_0000001854169229__en-us_topic_0000001541136770_p51099989">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_0000001854169229__en-us_topic_0000001541136770_p45458457">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_0000001854169229__en-us_topic_0000001541136770_p58256364">Specifies the encryption algorithm, which can be <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b12761125216166">3des</strong>, <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b8763175231615">aes-128</strong>, <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b17763145212161">aes-192</strong>, or <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b1676485221612">aes-256</strong>. The default algorithm is <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b167666529160">aes-128</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_row54545236"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_p56088004">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_0000001854169229__en-us_topic_0000001541136770_p46834456">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_0000001854169229__en-us_topic_0000001541136770_p35494585">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_0000001854169229__en-us_topic_0000001541136770_p9370348">Specifies the IKE version, which can be <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b1192671113252">v1</strong> or <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b992818113253">v2</strong>. The default version is <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b9929191115251"> v1</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_row38639871"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_p42821886">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_0000001854169229__en-us_topic_0000001541136770_p46020774">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_0000001854169229__en-us_topic_0000001541136770_p36695198">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_0000001854169229__en-us_topic_0000001541136770_p19521038">Specifies the IKE policy object.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_row41471619"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_p3757979">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_0000001854169229__en-us_topic_0000001541136770_p35960896">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_0000001854169229__en-us_topic_0000001541136770_p27151449">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_0000001854169229__en-us_topic_0000001541136770_p51783759">Specifies the lifetime object of SA.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_row63400648"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_p35178835">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_0000001854169229__en-us_topic_0000001541136770_p30913391">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_0000001854169229__en-us_topic_0000001541136770_p20956739">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_0000001854169229__en-us_topic_0000001541136770_p19774328">Specifies the IKE policy name.</p>
<p id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_p047112561891">The name can contain 1 to 64 characters.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_row43751230"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_p54188775">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_0000001854169229__en-us_topic_0000001541136770_p27214660">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_0000001854169229__en-us_topic_0000001541136770_p56903870">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_0000001854169229__en-us_topic_0000001541136770_p6588145672511">Specifies the PFS, which can be <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b487105563818">group1</strong>, <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b16871175533817">group2</strong>, <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b2087225533812">group5</strong>, <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b1487265533816">group14</strong>, <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b138731355103812">group15</strong>, <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b2873165512382">group16</strong>, <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b1987411559386">group19</strong>, <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b68741955203819">group20</strong>, <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b1187416557383">group21</strong>, or <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b887515514380">disable</strong>.</p>
<p id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_p489023122614">The default PFS is <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b1648444193911">group5</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_row9643552"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_p42930272">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_0000001854169229__en-us_topic_0000001541136770_p54800025">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_0000001854169229__en-us_topic_0000001541136770_p9617010">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_0000001854169229__en-us_topic_0000001541136770_p40780307">Specifies the IKE mode, which is <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b63031243915">main</strong> by default.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_row31478446"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_p66726223">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_0000001854169229__en-us_topic_0000001541136770_p36115021">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_0000001854169229__en-us_topic_0000001541136770_p39635599">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_0000001854169229__en-us_topic_0000001541136770_p56366974">Specifies the lifetime value of the SA, which is <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b9482021193915">3600</strong> by default. The default unit is <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b6496213394">seconds</strong>.</p>
<p id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_p1751212280917">Supported range: 60 to 604800</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_row37540721"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_p20899598">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_0000001854169229__en-us_topic_0000001541136770_p15145867">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_0000001854169229__en-us_topic_0000001541136770_p18855696">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_0000001854169229__en-us_topic_0000001541136770_p50916422">Specifies the lifecycle unit, which is <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b1168010311390">seconds</strong> by default.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_section31003317"><h4 class="sectiontitle">Response</h4><p id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_p921512851511"><a href="#EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_table30589524">Table 3</a> describes the response parameters.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_table30589524"></a><a name="en-us_topic_0000001541136770_table30589524"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_table30589524" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_row17707452"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.4.3.2.4.1.1"><p id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_p25017536">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_0000001854169229__en-us_topic_0000001541136770_p13154536">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_0000001854169229__en-us_topic_0000001541136770_p4915910">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_row62644428"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_p41033878">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_0000001854169229__en-us_topic_0000001541136770_p35409804">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_0000001854169229__en-us_topic_0000001541136770_p59951903">Specifies the authentication hash algorithm, which can be <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b1575157624">md5</strong>, <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b609692471">sha1</strong>, <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b650529105">sha2-256</strong>, <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b71921390">sha2-384</strong>, or <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b1981305675">sha2-512</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_row2696221"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_p17067371">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_0000001854169229__en-us_topic_0000001541136770_p40279785">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_0000001854169229__en-us_topic_0000001541136770_p963478">Provides supplementary information about the IKE policy.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_row8671305"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_p31287108">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_0000001854169229__en-us_topic_0000001541136770_p51227795">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_0000001854169229__en-us_topic_0000001541136770_p24374351">Specifies the encryption algorithm, which can be <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b088565891619">3des</strong>, <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b688719588161">aes-128</strong>, <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b1488705815163">aes-192</strong>, or <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b12888175821616">aes-256</strong>. The default algorithm is <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b198891158111612">aes-128</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_row18042568"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_p52161898">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_0000001854169229__en-us_topic_0000001541136770_p64364196">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_0000001854169229__en-us_topic_0000001541136770_p44522499">Specifies the IKE policy ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_row65158171"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_p43320494">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_0000001854169229__en-us_topic_0000001541136770_p19299134">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_0000001854169229__en-us_topic_0000001541136770_p468917371107">Specifies the IKE version, which can be <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b74665125259">v1</strong> or <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b4466141216254">v2</strong>. The default version is <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b646613122258"> v1</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_row18958859"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_p59272617">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_0000001854169229__en-us_topic_0000001541136770_p36352712">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_0000001854169229__en-us_topic_0000001541136770_p5246632">Specifies the lifetime object of SA.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_row47219689"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_p66698493">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_0000001854169229__en-us_topic_0000001541136770_p33868853">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_0000001854169229__en-us_topic_0000001541136770_p16100147">Specifies the IKE policy name.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_row10683599"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_p60065170">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_0000001854169229__en-us_topic_0000001541136770_p33440573">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_0000001854169229__en-us_topic_0000001541136770_p8545646381">Specifies the PFS, which can be <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b14198121824217">group1</strong>, <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b6199718144218">group2</strong>, <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b3199151811421">group5</strong>, <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b4199151864214">group14</strong>, <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b1319920187429">group15</strong>, <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b18200418134215">group16</strong>, <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b6200118184219">group19</strong>, <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b17201131884211">group20</strong>, <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b1520161884214">group21</strong>, or <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b7201318134218">disable</strong>.</p>
<p id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_p11546104619817">The default PFS is <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b789882220422">group5</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_row21213148"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_p40543448">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_0000001854169229__en-us_topic_0000001541136770_p62793889">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_0000001854169229__en-us_topic_0000001541136770_p9393336">Specifies the IKE mode, which is <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b5193163424212">main</strong> by default.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_row17431163"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_p2638090">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_0000001854169229__en-us_topic_0000001541136770_p12358762">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_0000001854169229__en-us_topic_0000001541136770_p18334396">Specifies the project ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_row55991032"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_p38979707">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_0000001854169229__en-us_topic_0000001541136770_p3239736">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_0000001854169229__en-us_topic_0000001541136770_p49509242">Specifies the IKE policy object.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_row2405037"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_p60590285">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_0000001854169229__en-us_topic_0000001541136770_p8866062">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_0000001854169229__en-us_topic_0000001541136770_p53959953">Specifies the lifetime value of the SA, which is <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b184131841124210">3600</strong> by default. The default unit is <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b13414154164211">seconds</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_row15877536"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_p11012038">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_0000001854169229__en-us_topic_0000001541136770_p19559856">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_0000001854169229__en-us_topic_0000001541136770_p20069106">Specifies the lifetime value of the SA, which is <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b105451959164210">3600</strong> by default. The default unit is <strong id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_b1054616594423">seconds</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_section10594405"><h4 class="sectiontitle">Example</h4><ul id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_ul79501413161"><li id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_li69506191614">Example request<pre class="screen" id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_screen40715627214130">{
"ikepolicy" : {
"encryption_algorithm" : "aes-256"
}
}</pre>
</li></ul>
</div>
<ul id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_ul74173109161"><li id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_li34179103166">Example response<pre class="screen" id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_screen2072432561615">{
"ikepolicy" : {
"name" : "ikepolicy1",
"tenant_id" : "ccb81365fe36411a9011e90491fe1330",
"auth_algorithm" : "sha1",
"encryption_algorithm" : "aes-256",
"pfs" : "group5",
"phase1_negotiation_mode" : "main",
"lifetime" : {
"units" : "seconds",
"value" : 3600
},
"ike_version" : "v1",
"id" : "5522aff7-1b3c-48dd-9c3c-b50f016b73db",
"description" : ""
}
}</pre>
</li></ul>
<div class="section" id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_section6578292"><h4 class="sectiontitle">Returned Values</h4><p id="EN-US_TOPIC_0000001854169229__en-us_topic_0000001541136770_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