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>
295 lines
28 KiB
HTML
295 lines
28 KiB
HTML
<a name="en_topic_0093011507"></a><a name="en_topic_0093011507"></a>
|
|
|
|
<h1 class="topictitle1">Updating an IPsec Policy</h1>
|
|
<div id="body36312476"><div class="section" id="en_topic_0093011507__section45521706"><h4 class="sectiontitle"><strong id="en_topic_0093011507__b842352706112523">Function</strong></h4><p id="en_topic_0093011507__p55629438">This interface is used to update an IPsec policy.</p>
|
|
<div class="note" id="en_topic_0093011507__note2483123917020"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="en_topic_0093011507__p448315391706">If the IPsec policy is updated, the IPsec VPN connection also needs to be updated.</p>
|
|
</div></div>
|
|
</div>
|
|
<div class="section" id="en_topic_0093011507__section7042173"><h4 class="sectiontitle">URI</h4><p id="en_topic_0093011507__p9473711901">PUT /v2.0/vpn/ipsecpolicies/{ipsecpolicy_id}</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en_topic_0093011507__table44973181017" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="en_topic_0093011507__row15504918204"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.2.3.2.5.1.1"><p id="en_topic_0093011507__p1550413181805"><strong id="en_topic_0093011507__b842352706172115">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.2.3.2.5.1.2"><p id="en_topic_0093011507__p135113181904">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.2.3.2.5.1.3"><p id="en_topic_0093011507__p45111018804">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45.91540845915409%" id="mcps1.3.2.3.2.5.1.4"><p id="en_topic_0093011507__p125111818109">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en_topic_0093011507__row1151910188014"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.3.2.5.1.1 "><p id="en_topic_0093011507__p11519418808">ipsecpolicy_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.2.3.2.5.1.2 "><p id="en_topic_0093011507__p051911182003">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.2.3.2.5.1.3 "><p id="en_topic_0093011507__p125198181109">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.2.3.2.5.1.4 "><p id="en_topic_0093011507__p1651921810014">Specifies the IPsec policy ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="en_topic_0093011507__section33545144"><h4 class="sectiontitle">Request Message</h4><p id="en_topic_0093011507__p1319557603"><a href="#en_topic_0093011507__table17322790">Table 2</a> describes the request parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="en_topic_0093011507__table17322790"></a><a name="table17322790"></a><table cellpadding="4" cellspacing="0" summary="" id="en_topic_0093011507__table17322790" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="en_topic_0093011507__row19920592"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.3.3.2.5.1.1"><p id="en_topic_0093011507__p2955276">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.3.3.2.5.1.2"><p id="en_topic_0093011507__p38050837">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.3.3.2.5.1.3"><p id="en_topic_0093011507__p62218962">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45.91540845915409%" id="mcps1.3.3.3.2.5.1.4"><p id="en_topic_0093011507__p6571180">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en_topic_0093011507__row55864401"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en_topic_0093011507__p28722627">ipsecpolicy</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="en_topic_0093011507__p44831437">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="en_topic_0093011507__p7467800">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en_topic_0093011507__p912076">Specifies the IPsec policy object.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011507__row8208684"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en_topic_0093011507__p60923663">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="en_topic_0093011507__p35869679">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="en_topic_0093011507__p19762867">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en_topic_0093011507__p57288388">Provides supplementary information about the IPsec policy.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011507__row45833444"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en_topic_0093011507__p21521490">transform_protocol</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="en_topic_0093011507__p65519169">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="en_topic_0093011507__p5452505">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en_topic_0093011507__p38999745">Specifies the transform protocol used. The value can be <strong id="en_topic_0093011507__b842352706184452">esp</strong>, <strong id="en_topic_0093011507__b842352706184456">ah</strong>, or <strong id="en_topic_0093011507__b84235270618456">ah-esp</strong>. The default value is <strong id="en_topic_0093011507__b842352706201018">esp</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011507__row15453386"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en_topic_0093011507__p43764782">auth_algorithm</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="en_topic_0093011507__p55286454">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="en_topic_0093011507__p49017803">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en_topic_0093011507__p11019092">Specifies the authentication hash algorithm. The value can be <strong id="en_topic_0093011507__b842352706165820">md5</strong>, <strong id="en_topic_0093011507__b842352706165823">sha1</strong>, <strong id="en_topic_0093011507__b842352706165833">sha2-256</strong>, <strong id="en_topic_0093011507__b842352706165840">sha2-384</strong>, or <strong id="en_topic_0093011507__b842352706165851">sha2-512</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011507__row32062968"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en_topic_0093011507__p46963595">encapsulation_mode</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="en_topic_0093011507__p45954822">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="en_topic_0093011507__p31353106">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en_topic_0093011507__p56573654">Specifies the encapsulation mode. The default value is <strong id="en_topic_0093011507__b84235270617116">tunnel</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011507__row39400845"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en_topic_0093011507__p37351897">encryption_algorithm</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="en_topic_0093011507__p5604850">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="en_topic_0093011507__p51339711">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en_topic_0093011507__p64875945">Specifies the encryption algorithm. The value can be <strong id="en_topic_0093011507__b8423527061721">3des</strong>, <strong id="en_topic_0093011507__b84235270617211">aes-128</strong>, <strong id="en_topic_0093011507__b84235270617219">aes-192</strong>, or <strong id="en_topic_0093011507__b84235270617227">aes-256</strong>. The default value is <strong id="en_topic_0093011507__b84235270617239">aes-128</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011507__row47012596"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en_topic_0093011507__p49923923">pfs</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="en_topic_0093011507__p17305987">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="en_topic_0093011507__p59607724">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en_topic_0093011507__p6588145672511">Specifies the PFS. The value can be <strong id="en_topic_0093011507__b58067010359">group1</strong>, <strong id="en_topic_0093011507__b108076063516">group2</strong>, <strong id="en_topic_0093011507__b28081007355">group5</strong>, <strong id="en_topic_0093011507__b78081909351">group14</strong>, <strong id="en_topic_0093011507__b108101908350">group15</strong>, <strong id="en_topic_0093011507__b1881080163517">group16</strong>, <strong id="en_topic_0093011507__b118116093514">group19</strong>, <strong id="en_topic_0093011507__b28113043510">group20</strong>, <strong id="en_topic_0093011507__b2081214033510">group21</strong>, or <strong id="en_topic_0093011507__b158135017357">disable</strong>.</p>
|
|
<p id="en_topic_0093011507__p489023122614">The default value is <strong id="en_topic_0093011507__b579329351">group5</strong>.</p>
|
|
<p id="en_topic_0093011507__p89224267257">The value <strong id="en_topic_0093011507__b129306212359">disable</strong> indicates that the PFS function is disabled.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011507__row34595869"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en_topic_0093011507__p50801977">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="en_topic_0093011507__p21319498">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="en_topic_0093011507__p49157816">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en_topic_0093011507__p22360170">Specifies the lifetime value of the SA. The default unit is <strong id="en_topic_0093011507__b842352706101111">seconds</strong>. The default value is <strong id="en_topic_0093011507__b842352706101115">3600</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011507__row67023809"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en_topic_0093011507__p60219412">units</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="en_topic_0093011507__p45934241">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="en_topic_0093011507__p29686030">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en_topic_0093011507__p55758211">Specifies the lifecycle unit. The default value is <strong id="en_topic_0093011507__b842352706101139">seconds</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011507__row32061857"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en_topic_0093011507__p46873590">lifetime</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="en_topic_0093011507__p38664423">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="en_topic_0093011507__p44810590">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en_topic_0093011507__p5779136">Specifies the lifetime object of SA.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011507__row52012230"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en_topic_0093011507__p52241078">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="en_topic_0093011507__p3668935">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="en_topic_0093011507__p28748320">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en_topic_0093011507__p46912618">Specifies the IPsec policy name.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="note" id="en_topic_0093011507__note332171616117"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ol id="en_topic_0093011507__ol1227132714116"><li class="msonormalcxspfirst" id="en_topic_0093011507__li1022712273113">The <strong id="en_topic_0093011507__en-us_topic_0053740027_b84235270620329">project_id</strong> parameter is not supported.</li><li class="msonormalcxspfirst" id="en_topic_0093011507__li1422762716110">The value of <strong id="en_topic_0093011507__b842352706144933">name</strong> can contain 1 to 64 characters.</li><li class="msonormalcxspfirst" id="en_topic_0093011507__li42366271814">The value of <strong id="en_topic_0093011507__b120501305120950">description</strong> can contain a maximum of 255 characters.</li><li class="msonormalcxspfirst" id="en_topic_0093011507__li523617276115">The value of <strong id="en_topic_0093011507__b842352706203245">transform_protocol</strong> can only be <strong id="en_topic_0093011507__b842352706203257">esp</strong>, <strong id="en_topic_0093011507__b84235270620333">ah</strong>, or <strong id="en_topic_0093011507__b842352706203312">ah-esp</strong>.</li><li class="msonormalcxspfirst" id="en_topic_0093011507__li11244142717120">The value of <strong id="en_topic_0093011507__b842352706203329">auth_algorithm</strong> can only be <strong id="en_topic_0093011507__b1891546185">md5</strong>, <strong id="en_topic_0093011507__b1210559997">sha1</strong>, <strong id="en_topic_0093011507__b1223214109">sha2-256</strong>, <strong id="en_topic_0093011507__b2028202727">sha2-384</strong>, or <strong id="en_topic_0093011507__b25082646">sha2-512</strong>.</li><li class="msonormalcxspfirst" id="en_topic_0093011507__li4244227613">The value of <strong id="en_topic_0093011507__b84235270692027">encapsulation_mode</strong> can only be <strong id="en_topic_0093011507__b84235270692043">tunnel</strong>.</li><li class="msonormalcxspfirst" id="en_topic_0093011507__li42449270111">The value of <strong id="en_topic_0093011507__b1320281409">units</strong> can only be in seconds.</li><li class="msonormalcxspfirst" id="en_topic_0093011507__li162518274114">The value of <strong id="en_topic_0093011507__b842352706205920">value</strong> can only be an integer ranging from 60 to 604,800.</li><li class="msonormalcxsplast" id="en_topic_0093011507__li82511127812">The value of <strong id="en_topic_0093011507__b842352706205948">encryption_algorithm</strong> can only be <strong id="en_topic_0093011507__b8423527062102">aes-192</strong>, <strong id="en_topic_0093011507__b8423527062109">aes-256</strong>, <strong id="en_topic_0093011507__b842352706103658">group2</strong>, <strong id="en_topic_0093011507__b84235270621017">group5</strong>, or <strong id="en_topic_0093011507__b84235270621024">group14</strong>.</li></ol>
|
|
</div></div>
|
|
</div>
|
|
<div class="section" id="en_topic_0093011507__section33470841"><h4 class="sectiontitle">Response Message</h4><p id="en_topic_0093011507__p58352441615"><a href="#en_topic_0093011507__table41825741">Table 3</a> describes the response parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="en_topic_0093011507__table41825741"></a><a name="table41825741"></a><table cellpadding="4" cellspacing="0" summary="" id="en_topic_0093011507__table41825741" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="en_topic_0093011507__row35695699"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.4.3.2.4.1.1"><p id="en_topic_0093011507__p5670474">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.67%" id="mcps1.3.4.3.2.4.1.2"><p id="en_topic_0093011507__p56655270">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.57000000000001%" id="mcps1.3.4.3.2.4.1.3"><p id="en_topic_0093011507__p66343596">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en_topic_0093011507__row5122214"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011507__p12246180">encryption_algorithm</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011507__p52416527">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011507__p39015754">Specifies the encryption algorithm. The value can be <strong id="en_topic_0093011507__b458331934">3des</strong>, <strong id="en_topic_0093011507__b1422370126">aes-128</strong>, <strong id="en_topic_0093011507__b723315459">aes-192</strong>, or <strong id="en_topic_0093011507__b958515037">aes-256</strong>. The default value is <strong id="en_topic_0093011507__b775604940">aes-128</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011507__row15597466"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011507__p55435195">pfs</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011507__p61065805">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011507__p1341342012274">Specifies the PFS. The value can be <strong id="en_topic_0093011507__b111621446359">group1</strong>, <strong id="en_topic_0093011507__b6162124183514">group2</strong>, <strong id="en_topic_0093011507__b116217433517">group5</strong>, <strong id="en_topic_0093011507__b1316214412356">group14</strong>, <strong id="en_topic_0093011507__b2164194153510">group15</strong>, <strong id="en_topic_0093011507__b2016414483518">group16</strong>, <strong id="en_topic_0093011507__b11643416358">group19</strong>, <strong id="en_topic_0093011507__b416513423512">group20</strong>, <strong id="en_topic_0093011507__b141651844358">group21</strong>, or <strong id="en_topic_0093011507__b11167134163518">disable</strong>.</p>
|
|
<p id="en_topic_0093011507__p74161620162715">The default value is <strong id="en_topic_0093011507__b71824516355">group5</strong>.</p>
|
|
<p id="en_topic_0093011507__p14417122062713">The value <strong id="en_topic_0093011507__b792615511351">disable</strong> indicates that the PFS function is disabled.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011507__row48367351"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011507__p25441382">lifetime</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011507__p47486057">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011507__p36677197">Specifies the lifetime object of SA.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011507__row61659320"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011507__p28349038">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011507__p14570748">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011507__p35661763">Specifies the IPsec policy name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011507__row52520413"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011507__p26295076">transform_protocol</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011507__p49526440">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011507__p1856645">Specifies the transform protocol used. The value can be <strong id="en_topic_0093011507__b1060973911">esp</strong>, <strong id="en_topic_0093011507__b1850442652">ah</strong>, or <strong id="en_topic_0093011507__b575293144">ah-esp</strong>. The default value is <strong id="en_topic_0093011507__b920655545">esp</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011507__row16709807"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011507__p11317154">tenant_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011507__p44274261">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011507__p36263964">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011507__row57940224"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011507__p62646535">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011507__p41204595">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011507__p28849561">Specifies the IPsec policy ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011507__row58319463"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011507__p26256062">encapsulation_mode</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011507__p46366269">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011507__p4615638">Specifies the encapsulation mode. The default value is <strong id="en_topic_0093011507__b1973039499">tunnel</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011507__row41540743"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011507__p9356983">auth_algorithm</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011507__p19718131">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011507__p51881906">Specifies the authentication hash algorithm. The value can be <strong id="en_topic_0093011507__b386339358">md5</strong>, <strong id="en_topic_0093011507__b167959609">sha1</strong>, <strong id="en_topic_0093011507__b1018329879">sha2-256</strong>, <strong id="en_topic_0093011507__b692830195">sha2-384</strong>, or <strong id="en_topic_0093011507__b1544948481">sha2-512</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011507__row64283975"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011507__p39619499">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011507__p55062814">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011507__p20114008">Provides supplementary information about the IPsec policy.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011507__row17450296"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011507__p4187856">ipsecpolicy</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011507__p3672032">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011507__p123786">Specifies the IPsec policy object.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011507__row5825185"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011507__p2077973">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011507__p34098154">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011507__p44149718">Specifies the lifetime value of the SA. The default unit is <strong id="en_topic_0093011507__b842352706101322">seconds</strong>. The default value is <strong id="en_topic_0093011507__b842352706101327">3600</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011507__row61803142"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011507__p39998624">units</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011507__p18663102">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011507__p42047784">Specifies the lifecycle unit. The default value is <strong id="en_topic_0093011507__b8423527061079">seconds</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="en_topic_0093011507__section32802119"><h4 class="sectiontitle">Example</h4><ul id="en_topic_0093011507__ul1857414331424"><li id="en_topic_0093011507__li557463313219">Example Request</li></ul>
|
|
<pre class="screen" id="en_topic_0093011507__screen11126208214914">PUT /v2.0/vpn/ipsecpolicies/{ipsecpolicy_id}
|
|
{
|
|
"ipsecpolicy" : {
|
|
"pfs" : "group14"
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<ul id="en_topic_0093011507__ul143011041327"><li id="en_topic_0093011507__li830111415218">Example Response<pre class="screen" id="en_topic_0093011507__screen10183752421">{
|
|
"ipsecpolicy": {
|
|
"name": "ipsecpolicy1",
|
|
"transform_protocol": "esp",
|
|
"auth_algorithm": "sha1",
|
|
"encapsulation_mode": "tunnel",
|
|
"encryption_algorithm": "aes-128",
|
|
"pfs": "group14",
|
|
"project_id": "ccb81365fe36411a9011e90491fe1330",
|
|
"tenant_id": "ccb81365fe36411a9011e90491fe1330",
|
|
"lifetime": {
|
|
"units": "seconds",
|
|
"value": 3600
|
|
},
|
|
"id": "5291b189-fd84-46e5-84bd-78f40c05d69c",
|
|
"description": ""
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
<div class="section" id="en_topic_0093011507__section6578292"><h4 class="sectiontitle">Returned Values</h4><p id="en_topic_0093011507__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>
|
|
|