.. _interface_loopback_ip_rip:

interface loopback ip rip
=========================

RIP


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

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

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

	 **Element Name**                      rip

	 **Element URI**                       /axapi/v3/interface/loopback/{ifnum}/ip/rip

	 **Element Attributes**                rip_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`rip schema <interface-loopback-ip-rip/interface-loopback-ip-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/interface/loopback/{ifnum}/ip/rip



.. raw:: html

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


:ref:`1957_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/interface_loopback_ip_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/interface/loopback/{ifnum}/ip/rip



.. raw:: html

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


:ref:`1957_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/interface_loopback_ip_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/interface/loopback/{ifnum}/ip/rip



.. raw:: html

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


:ref:`1957_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/interface/loopback/{ifnum}/ip/rip



.. raw:: html

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


:ref:`1957_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/interface_loopback_ip_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/interface/loopback/{ifnum}/ip/rip



.. raw:: html

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


:ref:`1957_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/interface_loopback_ip_rip_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _1957_rip_attributes:

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

    **authentication**

        **Description:** authentication is a **JSON Block**.  Please see below for :ref:`1957_authentication` 

        **Type:** Object

    **receive-cfg**

        **Description:** receive-cfg is a **JSON Block**.  Please see below for :ref:`1957_receive-cfg` 

        **Type:** Object

    **receive-packet**

        **Description** Enable receiving packet through the specified interface

        **Type:** boolean

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

        **Default:** 1

    **send-cfg**

        **Description:** send-cfg is a **JSON Block**.  Please see below for :ref:`1957_send-cfg` 

        **Type:** Object

    **send-packet**

        **Description** Enable sending packets through the specified interface

        **Type:** boolean

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

        **Default:** 1

    **split-horizon-cfg**

        **Description:** split-horizon-cfg is a **JSON Block**.  Please see below for :ref:`1957_split-horizon-cfg` 

        **Type:** Object

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1957_receive-cfg:

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

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

    **receive**

        **Description** Advertisement reception

        **Type:** boolean

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

        **Default:** 0

    **version**

        **Description** '1': RIP version 1; '2': RIP version 2; '1-2': RIP version 1 & 2; 

        **Type:** string

        **Supported Values:** 1, 2, 1-2

.. _1957_split-horizon-cfg:

split-horizon-cfg
^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **state**

        **Description** 'poisoned': Perform split horizon with poisoned reverse; 'disable': Disable split horizon; 'enable': Perform split horizon without poisoned reverse; 

        **Type:** string

        **Supported Values:** poisoned, disable, enable

        **Default:** poisoned

.. _1957_authentication:

authentication
^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **key-chain**

        **Description:** key-chain is a **JSON Block**.  Please see below for :ref:`1957_authentication_key-chain` 

        **Type:** Object

    **mode**

        **Description:** mode is a **JSON Block**.  Please see below for :ref:`1957_authentication_mode` 

        **Type:** Object

    **str**

        **Description:** str is a **JSON Block**.  Please see below for :ref:`1957_authentication_str` 

        **Type:** Object

.. _1957_authentication_key-chain:

authentication_key-chain
^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **key-chain**

        **Description** Authentication key-chain (Name of key-chain)

        **Type:** string

        **Format:** string-rlx

.. _1957_authentication_mode:

authentication_mode
^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **mode**

        **Description** 'md5': Keyed message digest; 'text': Clear text authentication; 

        **Type:** string

        **Supported Values:** md5, text

        **Default:** text

.. _1957_authentication_str:

authentication_str
^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **string**

        **Description** The RIP authentication string

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 16 characters

        **Maximum Length:** 1 characters

.. _1957_send-cfg:

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

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

    **send**

        **Description** Advertisement transmission

        **Type:** boolean

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

        **Default:** 0

    **version**

        **Description** '1': RIP version 1; '2': RIP version 2; '1-compatible': RIPv1-compatible; '1-2': RIP version 1 & 2; 

        **Type:** string

        **Supported Values:** 1, 2, 1-compatible, 1-2