forked from docs/doc-exports
gtema
6b71b4a1fa
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: gtema <artem.goncharov@gmail.com> Co-committed-by: gtema <artem.goncharov@gmail.com>
287 lines
27 KiB
HTML
287 lines
27 KiB
HTML
<a name="en_topic_0093011504"></a><a name="en_topic_0093011504"></a>
|
|
|
|
<h1 class="topictitle1">Creating an IPsec Policy</h1>
|
|
<div id="body30846174"><div class="section" id="en_topic_0093011504__section51184318"><h4 class="sectiontitle"><strong id="en_topic_0093011504__b842352706112523">Function</strong></h4><p id="en_topic_0093011504__p15512181">This interface is used to create an IPsec policy.</p>
|
|
</div>
|
|
<div class="section" id="en_topic_0093011504__section58005681"><h4 class="sectiontitle">URI</h4><p id="en_topic_0093011504__p883224265214">POST /v2.0/vpn/ipsecpolicies</p>
|
|
</div>
|
|
<div class="section" id="en_topic_0093011504__section839735"><h4 class="sectiontitle">Request Message</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en_topic_0093011504__table45459112" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Request parameters</caption><thead align="left"><tr id="en_topic_0093011504__row26085680"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.3.2.2.5.1.1"><p id="en_topic_0093011504__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_topic_0093011504__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_topic_0093011504__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_topic_0093011504__p57522049">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en_topic_0093011504__row28774374"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.2.5.1.1 "><p id="en_topic_0093011504__p49022972">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.5.1.2 "><p id="en_topic_0093011504__p11437802">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.5.1.3 "><p id="en_topic_0093011504__p54046809">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.2.5.1.4 "><p id="en_topic_0093011504__p15715441">Specifies the IPsec policy name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011504__row7221243"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.2.5.1.1 "><p id="en_topic_0093011504__p48049826">pfs</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.5.1.2 "><p id="en_topic_0093011504__p66830726">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.5.1.3 "><p id="en_topic_0093011504__p44579726">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.2.5.1.4 "><p id="en_topic_0093011504__p1020312412913">Specifies the PFS. The value can be <strong id="en_topic_0093011504__b488215063218">group1</strong>, <strong id="en_topic_0093011504__b1895111102329">group2</strong>, <strong id="en_topic_0093011504__b2527141953217">group5</strong>, <strong id="en_topic_0093011504__b2653172453212">group14</strong>, <strong id="en_topic_0093011504__b116523011322">group15</strong>, <strong id="en_topic_0093011504__b207979452325">group16</strong>, <strong id="en_topic_0093011504__b6866052193219">group19</strong>, <strong id="en_topic_0093011504__b69228083313">group20</strong>, <strong id="en_topic_0093011504__b48501778336">group21</strong>, or <strong id="en_topic_0093011504__b644761513314">disable</strong>.</p>
|
|
<p id="en_topic_0093011504__p32051440298">The default value is <strong id="en_topic_0093011504__b842352706201018">group5</strong>.</p>
|
|
<p id="en_topic_0093011504__p1206943292">The value <strong id="en_topic_0093011504__b2626173812332">disable</strong> indicates that the PFS function is disabled.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011504__row17930557"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.2.5.1.1 "><p id="en_topic_0093011504__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_topic_0093011504__p551331">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.5.1.3 "><p id="en_topic_0093011504__p44657822">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.2.5.1.4 "><p id="en_topic_0093011504__p60513834">Specifies the authentication hash algorithm. The value can be <strong id="en_topic_0093011504__b842352706165820">md5</strong>, <strong id="en_topic_0093011504__b842352706165823">sha1</strong>, <strong id="en_topic_0093011504__b842352706165833">sha2-256</strong>, <strong id="en_topic_0093011504__b842352706165840">sha2-384</strong>, or <strong id="en_topic_0093011504__b842352706165851">sha2-512</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011504__row7753598"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.2.5.1.1 "><p id="en_topic_0093011504__p24061669">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.5.1.2 "><p id="en_topic_0093011504__p2838193">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.5.1.3 "><p id="en_topic_0093011504__p28567114">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.2.5.1.4 "><p id="en_topic_0093011504__p32234903">Provides supplementary information about the IPsec policy.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011504__row21678677"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.2.5.1.1 "><p id="en_topic_0093011504__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_topic_0093011504__p30120171">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.5.1.3 "><p id="en_topic_0093011504__p23814811">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.2.5.1.4 "><p id="en_topic_0093011504__p49951556">Specifies the encapsulation mode. The default value is <strong id="en_topic_0093011504__b84235270617116">tunnel</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011504__row46910821"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.2.5.1.1 "><p id="en_topic_0093011504__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_topic_0093011504__p20646289">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.5.1.3 "><p id="en_topic_0093011504__p61736738">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.2.5.1.4 "><p id="en_topic_0093011504__p34619920">Specifies the encryption algorithm. The value can be <strong id="en_topic_0093011504__b8423527061721">3des</strong>, <strong id="en_topic_0093011504__b84235270617211">aes-128</strong>, <strong id="en_topic_0093011504__b84235270617219">aes-192</strong>, or <strong id="en_topic_0093011504__b84235270617227">aes-256</strong>. The default value is <strong id="en_topic_0093011504__b84235270617239">aes-128</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011504__row43143829"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.2.5.1.1 "><p id="en_topic_0093011504__p4989273">ipsecpolicy</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.5.1.2 "><p id="en_topic_0093011504__p1477932">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.5.1.3 "><p id="en_topic_0093011504__p52603705">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.2.5.1.4 "><p id="en_topic_0093011504__p33041702">Specifies the IPsec policy object.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011504__row28939864"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.2.5.1.1 "><p id="en_topic_0093011504__p62427641">lifetime</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.5.1.2 "><p id="en_topic_0093011504__p23474126">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.5.1.3 "><p id="en_topic_0093011504__p22356031">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.2.5.1.4 "><p id="en_topic_0093011504__p66008118">Specifies the lifetime object of SA.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011504__row57202150"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.2.5.1.1 "><p id="en_topic_0093011504__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_topic_0093011504__p30540622">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.5.1.3 "><p id="en_topic_0093011504__p57871327">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.2.5.1.4 "><p id="en_topic_0093011504__p57065912">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011504__row43831168"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.2.5.1.1 "><p id="en_topic_0093011504__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_topic_0093011504__p14813071">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.5.1.3 "><p id="en_topic_0093011504__p59008073">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.2.5.1.4 "><p id="en_topic_0093011504__p14924591">Specifies the transform protocol used. The value can be <strong id="en_topic_0093011504__b842352706184452">esp</strong>, <strong id="en_topic_0093011504__b842352706184456">ah</strong>, or <strong id="en_topic_0093011504__b84235270618456">ah-esp</strong>. The default value is <strong id="en_topic_0093011504__b1070371618">esp</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011504__row15056516"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.2.5.1.1 "><p id="en_topic_0093011504__p11618302">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.5.1.2 "><p id="en_topic_0093011504__p1558396">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.5.1.3 "><p id="en_topic_0093011504__p59121255">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.2.5.1.4 "><p id="en_topic_0093011504__p24092326">Specifies the lifetime value of the SA. The default unit is <strong id="en_topic_0093011504__b84235270610843">seconds</strong>. The default value is <strong id="en_topic_0093011504__b84235270610838">3600</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011504__row15504345"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.2.5.1.1 "><p id="en_topic_0093011504__p47892402">units</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.5.1.2 "><p id="en_topic_0093011504__p54079315">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.5.1.3 "><p id="en_topic_0093011504__p18348389">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.2.5.1.4 "><p id="en_topic_0093011504__p9824527">Specifies the lifecycle unit. The default value is <strong id="en_topic_0093011504__b84235270610853">seconds</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="note" id="en_topic_0093011504__note10440578538"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ol id="en_topic_0093011504__ol1624910148535"><li class="msonormalcxspfirst" id="en_topic_0093011504__li1624951410535">The <strong id="en_topic_0093011504__en-us_topic_0053740027_b84235270620329">project_id</strong> parameter is not supported.</li><li class="msonormalcxspmiddle" id="en_topic_0093011504__li624911415538">The value of <strong id="en_topic_0093011504__b120501305120950">tenant_id</strong> can contain a maximum of 255 characters.</li><li class="msonormalcxspmiddle" id="en_topic_0093011504__li3249131475310">The value of <strong id="en_topic_0093011504__b842352706144933">name</strong> can contain 1 to 64 characters.</li><li class="msonormalcxspmiddle" id="en_topic_0093011504__li192571814155313">The value of <strong id="en_topic_0093011504__b944735126">description</strong> can contain a maximum of 255 characters.</li><li class="msonormalcxspmiddle" id="en_topic_0093011504__li1525731445317">The value of <strong id="en_topic_0093011504__b842352706203245">transform_protocol</strong> can only be <strong id="en_topic_0093011504__b842352706203257">esp</strong>, <strong id="en_topic_0093011504__b84235270620333">ah</strong>, or <strong id="en_topic_0093011504__b842352706203312">ah-esp</strong>.</li><li class="msonormalcxspmiddle" id="en_topic_0093011504__li926411455310">The value of <strong id="en_topic_0093011504__b842352706203329">auth_algorithm</strong> can only be <strong id="en_topic_0093011504__b2029919606">md5</strong>, <strong id="en_topic_0093011504__b1979217359">sha1</strong>, <strong id="en_topic_0093011504__b517968217">sha2-256</strong>, <strong id="en_topic_0093011504__b1058863814">sha2-384</strong>, or <strong id="en_topic_0093011504__b726132371">sha2-512</strong>.</li><li class="msonormalcxspmiddle" id="en_topic_0093011504__li62641714125317">The value of <strong id="en_topic_0093011504__b84235270692027">encapsulation_mode</strong> can only be <strong id="en_topic_0093011504__b84235270692043">tunnel</strong>.</li><li class="msonormalcxspmiddle" id="en_topic_0093011504__li52649149534">The value of <strong id="en_topic_0093011504__b2129031640">units</strong> can only be in seconds.</li><li class="msonormalcxspmiddle" id="en_topic_0093011504__li1027215147535">The value of <strong id="en_topic_0093011504__b842352706205920">value</strong> can only be an integer ranging from 60 to 604,800.</li><li class="msonormalcxsplast" id="en_topic_0093011504__li17272181419537">The value of <strong id="en_topic_0093011504__b842352706205948">encryption_algorithm</strong> can only be <strong id="en_topic_0093011504__b8423527062102">aes-192</strong>, <strong id="en_topic_0093011504__b8423527062109">aes-256</strong>, <strong id="en_topic_0093011504__b842352706103726">group2</strong>, <strong id="en_topic_0093011504__b84235270621017">group5</strong>, or <strong id="en_topic_0093011504__b84235270621024">group14</strong>.</li></ol>
|
|
</div></div>
|
|
</div>
|
|
<div class="section" id="en_topic_0093011504__section7557620"><h4 class="sectiontitle">Response Message</h4><p id="en_topic_0093011504__p53801524537"><a href="#en_topic_0093011504__table57589242">Table 2</a> describes the response parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="en_topic_0093011504__table57589242"></a><a name="table57589242"></a><table cellpadding="4" cellspacing="0" summary="" id="en_topic_0093011504__table57589242" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="en_topic_0093011504__row35311297"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.4.3.2.4.1.1"><p id="en_topic_0093011504__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_topic_0093011504__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_topic_0093011504__p61346876">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en_topic_0093011504__row3041091"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011504__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_topic_0093011504__p21265660">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011504__p4672552">Specifies the authentication hash algorithm. The value can be <strong id="en_topic_0093011504__b156386238">md5</strong>, <strong id="en_topic_0093011504__b1612457743">sha1</strong>, <strong id="en_topic_0093011504__b913520395">sha2-256</strong>, <strong id="en_topic_0093011504__b849778651">sha2-384</strong>, or <strong id="en_topic_0093011504__b823164186">sha2-512</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011504__row42052973"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011504__p50847687">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011504__p25022010">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011504__p21127816">Provides supplementary information about the IPsec policy.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011504__row55932620"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011504__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_topic_0093011504__p22657631">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011504__p10588164">Specifies the encapsulation mode. The default value is <strong id="en_topic_0093011504__b1697058608">tunnel</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011504__row28184617"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011504__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_topic_0093011504__p34352342">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011504__p34153125">Specifies the encryption algorithm. The value can be <strong id="en_topic_0093011504__b1223398365">3des</strong>, <strong id="en_topic_0093011504__b1629299840">aes-128</strong>, <strong id="en_topic_0093011504__b1192961710">aes-192</strong>, or <strong id="en_topic_0093011504__b538777431">aes-256</strong>. The default value is <strong id="en_topic_0093011504__b734798645">aes-128</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011504__row38942675"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011504__p240095">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011504__p19447695">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011504__p22377468">Specifies the IPsec policy ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011504__row51358334"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011504__p66384370">ipsecpolicy</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011504__p8424883">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011504__p45062713">Specifies the IPsec policy object.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011504__row2911240"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011504__p34483920">lifetime</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011504__p41734120">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011504__p13397545">Specifies the lifetime object of SA.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011504__row53469045"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011504__p36025402">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011504__p32376435">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011504__p22238563">Specifies the IPsec policy name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011504__row65929341"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011504__p38676409">pfs</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011504__p45781421">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011504__p6588145672511">Specifies the PFS. The value can be <strong id="en_topic_0093011504__b12346651183314">group1</strong>, <strong id="en_topic_0093011504__b8348351193317">group2</strong>, <strong id="en_topic_0093011504__b135125143320">group5</strong>, <strong id="en_topic_0093011504__b1935375117331">group14</strong>, <strong id="en_topic_0093011504__b5355145163316">group15</strong>, <strong id="en_topic_0093011504__b13356135113317">group16</strong>, <strong id="en_topic_0093011504__b193588513336">group19</strong>, <strong id="en_topic_0093011504__b1360051163319">group20</strong>, <strong id="en_topic_0093011504__b73621551163316">group21</strong>, or <strong id="en_topic_0093011504__b43643516332">disable</strong>.</p>
|
|
<p id="en_topic_0093011504__p489023122614">The default value is <strong id="en_topic_0093011504__b1687911520349">group5</strong>.</p>
|
|
<p id="en_topic_0093011504__p89224267257">The value <strong id="en_topic_0093011504__b1758510613343">disable</strong> indicates that the PFS function is disabled.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011504__row810977"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011504__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_topic_0093011504__p19223544">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011504__p28119201">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011504__row51746218"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011504__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_topic_0093011504__p3197948">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011504__p43771375">Specifies the transform protocol used. The value can be <strong id="en_topic_0093011504__b495038905">esp</strong>, <strong id="en_topic_0093011504__b669159008">ah</strong>, or <strong id="en_topic_0093011504__b1802917355">ah-esp</strong>. The default value is <strong id="en_topic_0093011504__b1966648559">esp</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011504__row51573880"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011504__p16734741">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011504__p13336762">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011504__p59650110">Specifies the lifetime value of the SA. The default unit is <strong id="en_topic_0093011504__b842352706101248">seconds</strong>. The default value is <strong id="en_topic_0093011504__b842352706101252">3600</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011504__row67088950"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011504__p65495901">units</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011504__p3567727">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011504__p53976698">Specifies the lifecycle unit. The default value is <strong id="en_topic_0093011504__b84235270610132">seconds</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="en_topic_0093011504__section909717"><h4 class="sectiontitle">Example</h4><ul id="en_topic_0093011504__ul1285151755415"><li id="en_topic_0093011504__li528541725412">Request Example<pre class="screen" id="en_topic_0093011504__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_topic_0093011504__ul2039442945414"><li id="en_topic_0093011504__li83941129185413">Example Response<pre class="screen" id="en_topic_0093011504__screen18370104412545">{
|
|
"ipsecpolicy" : {
|
|
"name" : "ipsecpolicy1",
|
|
"transform_protocol" : "esp",
|
|
"auth_algorithm" : "sha1",
|
|
"encapsulation_mode" : "tunnel",
|
|
"encryption_algorithm" : "aes-128",
|
|
"pfs" : "group5",
|
|
"project_id" : "ccb81365fe36411a9011e90491fe1330",
|
|
"tenant_id" : "ccb81365fe36411a9011e90491fe1330",
|
|
"lifetime" : {
|
|
"units" : "seconds",
|
|
"value" : 7200
|
|
},
|
|
"id" : "5291b189-fd84-46e5-84bd-78f40c05d69c",
|
|
"description" : ""
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
<div class="section" id="en_topic_0093011504__section6578292"><h4 class="sectiontitle">Returned Values</h4><p id="en_topic_0093011504__en-us_topic_0053740035_p19515943486">For details, see section <a href="en_topic_0093011522.html">Common Returned Values</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="en_topic_0093011503.html">IPsec Policy Management</a></div>
|
|
</div>
|
|
</div>
|
|
|