.. _router_rip:

router rip
==========

Routing Information Protocol (RIP)


rip Specification
-----------------

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

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

	 **Element Name**                      rip

	 **Element URI**                       /axapi/v3/router/rip

	 **Element Attributes**                rip_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`rip schema <router-rip/router-rip.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/router/rip



.. raw:: html

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


:ref:`2542_rip_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/router_rip_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/router/rip



.. raw:: html

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


:ref:`2542_rip_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/router_rip_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/router/rip



.. raw:: html

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


:ref:`2542_rip_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/router/rip



.. raw:: html

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


:ref:`2542_rip_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/router_rip_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/router/rip



.. raw:: html

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


:ref:`2542_rip_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/router_rip_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _2542_rip_attributes:

rip attributes
--------------

    **cisco-metric-behavior**

        **Description** 'enable': Enables updating metric consistent with Cisco; 'disable': Disables updating metric consistent with Cisco;  (Enable/Disable updating metric consistent with Cisco)

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** disable

    **default-information**

        **Description** 'originate': originate;  (Distribute default route)

        **Type:** string

        **Supported Values:** originate

    **default-metric**

        **Description** Set a metric of redistribute routes (Default metric)

        **Type:** number

        **Range:** 1-16

        **Default:** 1

    **distance-list-cfg**

        **Type:** List

    **distribute-list**

        **Description:** distribute-list is a **JSON Block**.  Please see below for :ref:`2542_distribute-list` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/router/rip/distribute-list <router_rip_distribute_list>`

    **neighbor**

        **Type:** List

    **network-addresses**

        **Type:** List

    **network-interface-list-cfg**

        **Type:** List

    **offset-list**

        **Description:** offset-list is a **JSON Block**.  Please see below for :ref:`2542_offset-list` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/router/rip/offset-list <router_rip_offset_list>`

    **passive-interface-list**

        **Type:** List

    **recv-buffer-size**

        **Description** Set the RIP UDP receive buffer size (the RIP UDP receive buffer size value)

        **Type:** number

        **Range:** 8192-2147483647

    **redistribute**

        **Description:** redistribute is a **JSON Block**.  Please see below for :ref:`2542_redistribute` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/router/rip/redistribute <router_rip_redistribute>`

    **rip-maximum-prefix-cfg**

        **Description:** rip-maximum-prefix-cfg is a **JSON Block**.  Please see below for :ref:`2542_rip-maximum-prefix-cfg` 

        **Type:** Object

    **route-cfg**

        **Type:** List

    **timers**

        **Description:** timers is a **JSON Block**.  Please see below for :ref:`2542_timers` 

        **Type:** Object

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **version**

        **Description** Set routing protocol version (RIP version)

        **Type:** number

        **Range:** 1-2

        **Default:** 2

.. _2542_rip-maximum-prefix-cfg:

rip-maximum-prefix-cfg
^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **maximum-prefix**

        **Description** Set the maximum number of RIP routes

        **Type:** number

        **Range:** 1-2048

    **maximum-prefix-thres**

        **Description** Percentage of maximum routes to generate a warning (Default 75%)

        **Type:** number

        **Range:** 1-100

        **Default:** 75

.. _2542_route-cfg:

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

	 **Block object keys**             

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

    **route**

        **Description** Static route advertisement (debugging purpose) (IP prefix network/length)

        **Type:** string

        **Format:** ipv4-cidr

.. _2542_passive-interface-list:

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

	 **Block object keys**             

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

    **ethernet**

        **Description** Ethernet interface (Port number)

        **Type:** number

        **Format:** interface

    **loopback**

        **Description** Loopback interface (Port number)

        **Type:** number

        **Format:** interface

    **trunk**

        **Description** Trunk interface (Trunk interface number)

        **Type:** number

        **Format:** interface

    **tunnel**

        **Description** Tunnel interface (Tunnel interface number)

        **Type:** number

        **Format:** interface

    **ve**

        **Description** Virtual ethernet interface (Virtual ethernet interface number)

        **Type:** number

        **Format:** interface

.. _2542_redistribute:

redistribute
^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **redist-list**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **vip-list**

        **Type:** List

.. _2542_redistribute_vip-list:

redistribute_vip-list
^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **vip-metric**

        **Description** Metric for redistributed routes (metric value)

        **Type:** number

        **Range:** 0-16

    **vip-route-map**

        **Description** Route map reference (Pointer to route-map entries)

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **vip-type**

        **Description** 'only-flagged': Selected Virtual IP (VIP); 'only-not-flagged': Only not flagged; 

        **Type:** string

        **Supported Values:** only-flagged, only-not-flagged

.. _2542_redistribute_redist-list:

redistribute_redist-list
^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **metric**

        **Description** Metric for redistributed routes (metric value)

        **Type:** number

        **Range:** 0-16

    **route-map**

        **Description** Route map reference (Pointer to route-map entries)

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **type**

        **Description** 'bgp': Border Gateway Protocol (BGP); 'connected': Connected; 'floating-ip': Floating IP; 'ip-nat-list': IP NAT list; 'ip-nat': IP NAT; 'isis': ISO IS-IS; 'lw4o6': LW4O6 Prefix; 'nat-map': NAT MAP Prefix; 'static-nat': Static NAT; 'ospf': Open Shortest Path First (OSPF); 'static': Static routes; 

        **Type:** string

        **Supported Values:** bgp, connected, floating-ip, ip-nat-list, ip-nat, isis, lw4o6, nat-map, static-nat, ospf, static

.. _2542_network-interface-list-cfg:

network-interface-list-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **ethernet**

        **Description** Ethernet interface (Port number)

        **Type:** number

        **Format:** interface

    **loopback**

        **Description** Loopback interface (Port number)

        **Type:** number

        **Format:** interface

    **trunk**

        **Description** Trunk interface (Trunk interface number)

        **Type:** number

        **Format:** interface

    **tunnel**

        **Description** Tunnel interface (Tunnel interface number)

        **Type:** number

        **Format:** interface

    **ve**

        **Description** Virtual ethernet interface (Virtual ethernet interface number)

        **Type:** number

        **Format:** interface

.. _2542_timers:

timers
^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **timers-cfg**

        **Description:** timers-cfg is a **JSON Block**.  Please see below for :ref:`2542_timers_timers-cfg` 

        **Type:** Object

.. _2542_timers_timers-cfg:

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

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

    **basic**

        **Description** Basic routing protocol update timers (Routing table update timer value in second. Default is 30)

        **Type:** number

        **Range:** 5-2147483647

    **val-2**

        **Description** Routing information timeout timer. Default is 180

        **Type:** number

        **Range:** 5-2147483647

    **val-3**

        **Description** Garbage collection timer. Default is 120

        **Type:** number

        **Range:** 5-2147483647

.. _2542_neighbor:

neighbor
^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **value**

        **Description** Neighbor address

        **Type:** string

        **Format:** ipv4-address

.. _2542_offset-list:

offset-list
^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **acl-cfg**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2542_offset-list_acl-cfg:

offset-list_acl-cfg
^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **acl**

        **Description** Access-list name

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **ethernet**

        **Description** Ethernet interface (Port number)

        **Type:** number

        **Format:** interface

    **loopback**

        **Description** Loopback interface (Port number)

        **Type:** number

        **Format:** interface

    **metric**

        **Description** Metric value

        **Type:** number

        **Range:** 0-16

    **offset-list-direction**

        **Description** 'in': Filter incoming updates; 'out': Filter outgoing updates; 

        **Type:** string

        **Supported Values:** in, out

    **trunk**

        **Description** Trunk interface (Trunk interface number)

        **Type:** number

        **Format:** interface

    **tunnel**

        **Description** Tunnel interface (Tunnel interface number)

        **Type:** number

        **Format:** interface

    **ve**

        **Description** Virtual ethernet interface (Virtual ethernet interface number)

        **Type:** number

        **Format:** interface

.. _2542_distribute-list:

distribute-list
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **acl-cfg**

        **Type:** List

    **prefix**

        **Description:** prefix is a **JSON Block**.  Please see below for :ref:`2542_distribute-list_prefix` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/router/rip/distribute-list/prefix <router_rip_distribute_list_prefix>`

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2542_distribute-list_acl-cfg:

distribute-list_acl-cfg
^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **acl**

        **Description** Access-list name

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **acl-direction**

        **Description** 'in': Filter incoming routing updates; 'out': Filter outgoing routing updates; 

        **Type:** string

        **Supported Values:** in, out

    **ethernet**

        **Description** Ethernet interface (Port number)

        **Type:** number

        **Format:** interface

    **loopback**

        **Description** Loopback interface (Port number)

        **Type:** number

        **Format:** interface

    **trunk**

        **Description** Trunk interface (Trunk interface number)

        **Type:** number

        **Format:** interface

    **tunnel**

        **Description** Tunnel interface (Tunnel interface number)

        **Type:** number

        **Format:** interface

    **ve**

        **Description** Virtual ethernet interface (Virtual ethernet interface number)

        **Type:** number

        **Format:** interface

.. _2542_distribute-list_prefix:

distribute-list_prefix
^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **prefix-cfg**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2542_distribute-list_prefix_prefix-cfg:

distribute-list_prefix_prefix-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **ethernet**

        **Description** Ethernet interface (Port number)

        **Type:** number

        **Format:** interface

    **loopback**

        **Description** Loopback interface (Port number)

        **Type:** number

        **Format:** interface

    **prefix-list**

        **Description** Filter prefixes in routing updates (Name of a prefix list)

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **prefix-list-direction**

        **Description** 'in': Filter incoming routing updates; 'out': Filter outgoing routing updates; 

        **Type:** string

        **Supported Values:** in, out

    **trunk**

        **Description** Trunk interface (Trunk interface number)

        **Type:** number

        **Format:** interface

    **tunnel**

        **Description** Tunnel interface (Tunnel interface number)

        **Type:** number

        **Format:** interface

    **ve**

        **Description** Virtual ethernet interface (Virtual ethernet interface number)

        **Type:** number

        **Format:** interface

.. _2542_distance-list-cfg:

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

	 **Block object keys**             

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

    **distance**

        **Description** Administrative distance (Distance value)

        **Type:** number

        **Range:** 1-255

        **Default:** 120

    **distance-acl**

        **Description** Access list name

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **distance-ipv4-mask**

        **Description** IP source prefix

        **Type:** string

        **Format:** ipv4-cidr

.. _2542_network-addresses:

network-addresses
^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **network-ipv4-mask**

        **Description** IP prefix network/length, e.g., 35.0.0.0/8

        **Type:** string

        **Format:** ipv4-cidr