.. _vrrp_a_vrid_lead:

vrrp-a vrid-lead
================

Define a vrid-lead


vrid-lead Specification
-----------------------

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

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

	 **Object Key(s)**                     *vrid-lead-str*

	 **Collection Name**                   :ref:`4137_vrid-lead_list`

	 **Collection URI**                    /axapi/v3/vrrp-a/vrid-lead

	                                       

	 **Element Name**                      vrid-lead

	 **Element URI**                       /axapi/v3/vrrp-a/vrid-lead/{vrid-lead-str}

	 **Element Attributes**                vrid-lead_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`vrid-lead schema <vrrp-a-vrid-lead/vrrp-a-vrid-lead.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/vrrp-a/vrid-lead



.. raw:: html

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


:ref:`4137_vrid-lead_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/vrrp_a_vrid_lead_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/vrrp-a/vrid-lead



.. raw:: html

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


:ref:`4137_vrid-lead_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/vrrp-a/vrid-lead/{vrid-lead-str}



.. raw:: html

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


:ref:`4137_vrid-lead_attributes`



.. raw:: html

   </td><td><button id='get_eg' onClick="showExample('get')">example</button> <button id='get_cl' onClick="closeExample('get')" style='display:none'>close</button></td></tr>




.. raw:: html

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


.. include:: ../artifacts/vrrp_a_vrid_lead_GET.txt
   :literal:




.. raw:: html

   </div></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/vrrp-a/vrid-lead



.. raw:: html

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


:ref:`4137_vrid-lead_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/vrrp-a/vrid-lead/{vrid-lead-str}



.. raw:: html

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


:ref:`4137_vrid-lead_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/vrrp-a/vrid-lead/{vrid-lead-str}



.. raw:: html

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


:ref:`4137_vrid-lead_attributes`



.. raw:: html

   </td><td><button id='put_eg' onClick="showExample('put')">example</button> <button id='put_cl' onClick="closeExample('put')" style='display:none'>close</button></td></tr>




.. raw:: html

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


.. include:: ../artifacts/vrrp_a_vrid_lead_PUT.txt
   :literal:




.. raw:: html

   </div></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/vrrp-a/vrid-lead



.. raw:: html

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


:ref:`4137_vrid-lead_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/vrrp-a/vrid-lead/{vrid-lead-str}



.. raw:: html

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


:ref:`4137_vrid-lead_attributes`



.. raw:: html

   </td><td><button id='delete_eg' onClick="showExample('delete')">example</button> <button id='delete_cl' onClick="closeExample('delete')" style='display:none'>close</button></td></tr>




.. raw:: html

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


.. include:: ../artifacts/vrrp_a_vrid_lead_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _4137_vrid-lead_list:

vrid-lead-list
--------------


    vrid-lead-list is **JSON List** of :ref:`4137_vrid-lead_attributes` 

        vrid-lead-list : [

             { :ref:`4137_vrid-lead_attributes` },

             { :ref:`4137_vrid-lead_attributes` },

             ...

         ]

.. _4137_vrid-lead_attributes:

vrid-lead attributes
--------------------

    **partition**

        **Description:** partition is a **JSON Block**.  Please see below for :ref:`4137_partition` 

        **Type:** Object

    **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

    **vrid-lead-str**

        **Description** VRRP-A VRID leader name

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Default:** default-vrid-lead

.. _4137_partition:

partition
^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **name-cfg**

        **Description:** name-cfg is a **JSON Block**.  Please see below for :ref:`4137_partition_name-cfg` 

        **Type:** Object

    **partition**

        **Description** Partition name

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **shared-cfg**

        **Description:** shared-cfg is a **JSON Block**.  Please see below for :ref:`4137_partition_shared-cfg` 

        **Type:** Object

.. _4137_partition_shared-cfg:

partition_shared-cfg
^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **shared**

        **Description** Shared partition

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

        **Mutual Exclusion:** shared and name are mutually exclusive

    **vrid**

        **Description** VRRP-A id

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **vrid-value**

        **Description** Specify ha VRRP-A vrid

        **Type:** number

        **Range:** 0-31

.. _4137_partition_name-cfg:

partition_name-cfg
^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **name**

        **Description** Partition name

        **Type:** string

        **Maximum Length:** 14 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** name and shared are mutually exclusive

        **Reference Object:** :doc:`/axapi/v3/partition <partition>`

    **vrid**

        **Description** VRRP-A id

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **vrid-value**

        **Description** Specify ha VRRP-A vrid

        **Type:** number

        **Range:** 0-7