.. _vrrp_a_common:

vrrp-a common
=============

HA VRRP-A Global Commands


common Specification
--------------------

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

	===================================== ======================================================
	 **Type**                              *Configuration Resource*

	 **Element Name**                      common

	 **Element URI**                       /axapi/v3/vrrp-a/common

	 **Element Attributes**                common_attributes

	 **Partition Visibility**              shared

	 **Statistics Data URI**               /axapi/v3/vrrp-a/common/stats

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



.. raw:: html

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


:ref:`4097_common_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_common_POST.txt
   :literal:




.. raw:: html

   </div></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/common



.. raw:: html

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


:ref:`4097_common_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_common_GET.txt
   :literal:




.. raw:: html

   </div></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/common



.. raw:: html

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


:ref:`4097_common_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/common



.. raw:: html

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


:ref:`4097_common_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_common_PUT.txt
   :literal:




.. raw:: html

   </div></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/common



.. raw:: html

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


:ref:`4097_common_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_common_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _4097_common_attributes:

common attributes
-----------------

    **action**

        **Description** 'enable': enable vrrp-a; 'disable': disable vrrp-a; 

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** disable

    **arp-retry**

        **Description** Number of additional gratuitous ARPs sent out after HA failover (1-255, default is 4)

        **Type:** number

        **Range:** 1-255

        **Default:** 4

    **dead-timer**

        **Description** VRRP-A dead timer in terms of how many hello messages missed, default is 5 (2-255, default is 5)

        **Type:** number

        **Range:** 2-255

        **Default:** 5

    **device-id**

        **Description** Unique ID for each VRRP-A box (Device-id number)

        **Type:** number

    **disable-default-vrid**

        **Description** Disable default vrid

        **Type:** boolean

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

        **Default:** 0

    **forward-l4-packet-on-standby**

        **Description** Enables Layer 2/3 forwarding of Layer 4 traffic on the Standby ACOS device

        **Type:** boolean

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

        **Default:** 0

    **get-ready-time**

        **Description** set get ready time after ax starting up (60-1200, in unit of 100millisec, default is 60)

        **Type:** number

        **Range:** 60-1200

        **Default:** 60

    **hello-interval**

        **Description** VRRP-A Hello Interval (1-255, in unit of 100millisec, default is 2)

        **Type:** number

        **Range:** 1-255

        **Default:** 2

    **hop-limit**

        **Description** VRRP-A packet IPv6 header hop-limit (hop-limit, default is 64)

        **Type:** number

        **Range:** 1-128

        **Default:** 64

    **hostid-append-to-vrid**

        **Description:** hostid-append-to-vrid is a **JSON Block**.  Please see below for :ref:`4097_hostid-append-to-vrid` 

        **Type:** Object

    **inline-mode-cfg**

        **Description:** inline-mode-cfg is a **JSON Block**.  Please see below for :ref:`4097_inline-mode-cfg` 

        **Type:** Object

    **preemption-delay**

        **Description** Delay before changing state from Active to Standby (1-255, in unit of 100millisec, default is 60)

        **Type:** number

        **Range:** 1-255

        **Default:** 60

    **restart-time**

        **Description** Time between restarting ports on standby system after transition

        **Type:** number

        **Range:** 1-100

        **Default:** 20

    **set-id**

        **Description** Set-ID for HA configuration (Set id from 1 to 15)

        **Type:** number

        **Range:** 1-15

    **track-event-delay**

        **Description** Delay before changing state after up/down event (Units of 100 milliseconds (default 30))

        **Type:** number

        **Range:** 1-100

        **Default:** 30

    **ttl**

        **Description** VRRP-A packet IPv4 header TTL (TTL, default is 128)

        **Type:** number

        **Range:** 1-128

        **Default:** 128

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _4097_hostid-append-to-vrid:

hostid-append-to-vrid
^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **hostid-append-to-vrid-default**

        **Description** hostid append to vrid default

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** hostid-append-to-vrid-default and hostid-append-to-vrid-value are mutually exclusive

    **hostid-append-to-vrid-value**

        **Description** hostid append to vrid num

        **Type:** number

        **Range:** 1-31

        **Mutual Exclusion:** hostid-append-to-vrid-value and hostid-append-to-vrid-default are mutually exclusive

.. _4097_inline-mode-cfg:

inline-mode-cfg
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **inline-mode**

        **Description** Enable Layer 2 Inline Hot Standby Mode

        **Type:** boolean

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

        **Default:** 0

    **preferred-port**

        **Description** Preferred ethernet Port

        **Type:** number

        **Format:** interface

        **Mutual Exclusion:** preferred-port and preferred-trunk are mutually exclusive

    **preferred-trunk**

        **Description** Preferred trunk Port

        **Type:** number

        **Range:** 1-4096

        **Mutual Exclusion:** preferred-trunk and preferred-port are mutually exclusive