.. _vpn_ipsec_group:

vpn ipsec-group
===============

IPsec tunnel Groupings


ipsec-group Specification
-------------------------

	===================================== ===============================================================
	 **Parameter**                         **Value** 

	===================================== ===============================================================
	 **Type**                              *Collection*

	 **Object Key(s)**                     *name*

	 **Collection Name**                   :ref:`4075_ipsec-group_list`

	 **Collection URI**                    /axapi/v3/vpn/ipsec-group

	                                       

	 **Element Name**                      ipsec-group

	 **Element URI**                       /axapi/v3/vpn/ipsec-group/{name}

	 **Element Attributes**                ipsec-group_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`ipsec-group schema <vpn-ipsec-group/vpn-ipsec-group.txt>`
	===================================== ===============================================================





	**Operations Allowed:**




.. raw:: html

   <script type="text/javascript">
 function showExample(a,b) { document.getElementById(a+'_div').style.display = 'block'; document.getElementById(a+'_cl').style.display = 'block'; document.getElementById(a+'_eg').style.display = 'none';}
   function closeExample(a,b) { document.getElementById(a+'_div').style.display = 'none'; document.getElementById(a+'_cl').style.display = 'none'; document.getElementById(a+'_eg').style.display = 'block';}
 </script>
   <table width='90%' style='margin-left:5%'>



.. raw:: html

   <tr style='border-bottom: thin solid; border-top: thin solid'><th width=15%>Operation</th><th width=10%>Method</th><th>URI</th><th width=15%>Payload</th><th width=10%></th></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Create Object



.. raw:: html

   </td><td valign = 'top'>


POST



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/vpn/ipsec-group



.. raw:: html

   </td><td valign = 'top'>


:ref:`4075_ipsec-group_attributes`



.. raw:: html

   </td><td><button id='post_eg' onClick="showExample('post')">example</button> <button id='post_cl' onClick="closeExample('post')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='post_div' style='display:none'>


.. include:: ../artifacts/vpn_ipsec_group_POST.txt
   :literal:




.. raw:: html

   </div></td></tr>


.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Create List



.. raw:: html

   </td><td valign = 'top'>


POST



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/vpn/ipsec-group



.. raw:: html

   </td><td valign = 'top'>


:ref:`4075_ipsec-group_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Get Object



.. raw:: html

   </td><td valign = 'top'>


GET



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/vpn/ipsec-group/{name}



.. raw:: html

   </td><td valign = 'top'>


:ref:`4075_ipsec-group_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Get List



.. raw:: html

   </td><td valign = 'top'>


GET



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/vpn/ipsec-group



.. raw:: html

   </td><td valign = 'top'>


:ref:`4075_ipsec-group_list`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Modify Object



.. raw:: html

   </td><td valign = 'top'>


POST



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/vpn/ipsec-group/{name}



.. raw:: html

   </td><td valign = 'top'>


:ref:`4075_ipsec-group_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Replace Object



.. raw:: html

   </td><td valign = 'top'>


PUT



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/vpn/ipsec-group/{name}



.. raw:: html

   </td><td valign = 'top'>


:ref:`4075_ipsec-group_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Replace List



.. raw:: html

   </td><td valign = 'top'>


PUT



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/vpn/ipsec-group



.. raw:: html

   </td><td valign = 'top'>


:ref:`4075_ipsec-group_list`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Delete Object



.. raw:: html

   </td><td valign = 'top'>


DELETE



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/vpn/ipsec-group/{name}



.. raw:: html

   </td><td valign = 'top'>


:ref:`4075_ipsec-group_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   </table>

.. _4075_ipsec-group_list:

ipsec-group-list
----------------


    ipsec-group-list is **JSON List** of :ref:`4075_ipsec-group_attributes` 

        ipsec-group-list : [

             { :ref:`4075_ipsec-group_attributes` },

             { :ref:`4075_ipsec-group_attributes` },

             ...

         ]

.. _4075_ipsec-group_attributes:

ipsec-group attributes
----------------------

    **ipsecgroup-cfg**

        **Type:** List

    **name**

        **Description** Group name

        **Type:** string

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

    **user-tag**

        **Description** Customized tag

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _4075_ipsecgroup-cfg:

ipsecgroup-cfg
^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

	=============================== ===================================================

    **ipsec**

        **Description** specify a name to group active/backup tunnels

        **Type:** string

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/vpn/ipsec <vpn_ipsec>`

    **priority**

        **Description** Highest priority value is the active tunnel

        **Type:** number

        **Range:** 1-10