.. _vrrp_a_fail_over_policy_template:

vrrp-a fail-over-policy-template
================================

Define a VRRP-A failover policy template


fail-over-policy-template Specification
---------------------------------------

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

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

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

	 **Collection Name**                   :ref:`4100_fail-over-policy-template_list`

	 **Collection URI**                    /axapi/v3/vrrp-a/fail-over-policy-template

	                                       

	 **Element Name**                      fail-over-policy-template

	 **Element URI**                       /axapi/v3/vrrp-a/fail-over-policy-template/{name}

	 **Element Attributes**                fail-over-policy-template_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`fail-over-policy-template schema <vrrp-a-fail-over-policy-template/vrrp-a-fail-over-policy-template.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/fail-over-policy-template



.. raw:: html

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


:ref:`4100_fail-over-policy-template_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_fail_over_policy_template_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/fail-over-policy-template



.. raw:: html

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


:ref:`4100_fail-over-policy-template_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/fail-over-policy-template/{name}



.. raw:: html

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


:ref:`4100_fail-over-policy-template_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_fail_over_policy_template_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/fail-over-policy-template



.. raw:: html

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


:ref:`4100_fail-over-policy-template_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/fail-over-policy-template/{name}



.. raw:: html

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


:ref:`4100_fail-over-policy-template_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/fail-over-policy-template/{name}



.. raw:: html

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


:ref:`4100_fail-over-policy-template_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_fail_over_policy_template_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/fail-over-policy-template



.. raw:: html

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


:ref:`4100_fail-over-policy-template_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/fail-over-policy-template/{name}



.. raw:: html

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


:ref:`4100_fail-over-policy-template_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_fail_over_policy_template_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _4100_fail-over-policy-template_list:

fail-over-policy-template-list
------------------------------


    fail-over-policy-template-list is **JSON List** of :ref:`4100_fail-over-policy-template_attributes` 

        fail-over-policy-template-list : [

             { :ref:`4100_fail-over-policy-template_attributes` },

             { :ref:`4100_fail-over-policy-template_attributes` },

             ...

         ]

.. _4100_fail-over-policy-template_attributes:

fail-over-policy-template attributes
------------------------------------

    **bgp**

        **Description:** bgp is a **JSON Block**.  Please see below for :ref:`4100_bgp` 

        **Type:** Object

    **gateway**

        **Description:** gateway is a **JSON Block**.  Please see below for :ref:`4100_gateway` 

        **Type:** Object

    **interface**

        **Type:** List

    **name**

        **Description** VRRP-A fail over policy template name

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **route**

        **Description:** route is a **JSON Block**.  Please see below for :ref:`4100_route` 

        **Type:** Object

    **trunk-cfg**

        **Type:** List

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

    **vlan-cfg**

        **Type:** List

.. _4100_vlan-cfg:

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

	 **Block object keys**             

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

    **timeout**

        **Description** 

        **Type:** number

        **Range:** 2-600

    **vlan**

        **Description** VLAN tracking (VLAN id)

        **Type:** number

        **Range:** 1-4094

    **weight**

        **Description** The failover event weight

        **Type:** number

        **Range:** 1-255

.. _4100_route:

route
^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **ip-destination-cfg**

        **Type:** List

    **ipv6-destination-cfg**

        **Type:** List

.. _4100_route_ipv6-destination-cfg:

route_ipv6-destination-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **distance**

        **Description** Route's administrative distance (default: match any)

        **Type:** number

        **Range:** 1-255

    **gatewayv6**

        **Description** Match the route's gateway (next-hop) (default: match any)

        **Type:** string

        **Format:** ipv6-address

    **ipv6-destination**

        **Description** IPv6 Destination Prefix

        **Type:** string

        **Format:** ipv6-address-plen

    **protocol**

        **Description** 'any': Match any routing protocol (default); 'static': Match only static routes (added by user); 'dynamic': Match routes added by dynamic routing protocols (e.g. OSPF); 

        **Type:** string

        **Supported Values:** any, static, dynamic

        **Default:** any

    **weight**

        **Description** The amount the priority will decrease if the route is missing (The amount the priority will decrease if the route is not present)

        **Type:** number

        **Range:** 1-255

.. _4100_route_ip-destination-cfg:

route_ip-destination-cfg
^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **distance**

        **Description** Route's administrative distance(default: match any)

        **Type:** number

        **Range:** 1-255

    **gateway**

        **Description** 

        **Type:** string

        **Format:** ipv4-address

    **ip-destination**

        **Description** Destination prefix

        **Type:** string

        **Format:** ipv4-address

    **mask**

        **Description** Destination prefix mask

        **Type:** string

        **Format:** ipv4-netmask

    **protocol**

        **Description** 'any': Match any routing protocol (default); 'static': Match only static routes (added by user); 'dynamic': Match routes added by dynamic routing protocols (e.g. OSPF); 

        **Type:** string

        **Supported Values:** any, static, dynamic

        **Default:** any

    **weight**

        **Description** The amount the priority will decrease if the route is missing (The amount the priority will decrease if the route is not present)

        **Type:** number

        **Range:** 1-255

.. _4100_bgp:

bgp
^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **bgp-ipv4-address-cfg**

        **Type:** List

    **bgp-ipv6-address-cfg**

        **Type:** List

.. _4100_bgp_bgp-ipv4-address-cfg:

bgp_bgp-ipv4-address-cfg
^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **bgp-ipv4-address**

        **Description** bgp IP Address

        **Type:** string

        **Format:** ipv4-address

    **weight**

        **Description** The failover event weight

        **Type:** number

        **Range:** 1-255

.. _4100_bgp_bgp-ipv6-address-cfg:

bgp_bgp-ipv6-address-cfg
^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **bgp-ipv6-address**

        **Description** IPV6 address

        **Type:** string

        **Format:** ipv6-address

    **weight**

        **Description** The failover event weight

        **Type:** number

        **Range:** 1-255

.. _4100_interface:

interface
^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **ethernet**

        **Description** Ethernet Interface (Ethernet interface number)

        **Type:** number

        **Format:** interface

    **weight**

        **Description** The failover event weight

        **Type:** number

        **Range:** 1-255

.. _4100_gateway:

gateway
^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **gw-ipv4-address-cfg**

        **Type:** List

    **gw-ipv6-address-cfg**

        **Type:** List

.. _4100_gateway_gw-ipv4-address-cfg:

gateway_gw-ipv4-address-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **gw-ipv4-address**

        **Description** IP Address

        **Type:** string

        **Format:** ipv4-address

    **weight**

        **Description** The failover event weight

        **Type:** number

        **Range:** 1-255

.. _4100_gateway_gw-ipv6-address-cfg:

gateway_gw-ipv6-address-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **gw-ipv6-address**

        **Description** IPV6 address

        **Type:** string

        **Format:** ipv6-address

    **weight**

        **Description** The failover event weight

        **Type:** number

        **Range:** 1-255

.. _4100_trunk-cfg:

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

	 **Block object keys**             

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

    **per-port-weight**

        **Description** Per port failover weight

        **Type:** number

        **Range:** 0-255

        **Default:** 0

    **trunk**

        **Description** trunk tracking (trunk id)

        **Type:** number

        **Range:** 1-4096

    **weight**

        **Description** failover event weight

        **Type:** number

        **Range:** 1-255