.. _interface_loopback_oper:

interface loopback oper
=======================

Operational Status for the object loopback


loopback Specification
----------------------

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

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

	 **Collection Name**                   :ref:`1969_loopback_list`

	 **Collection URI**                    /axapi/v3/interface/loopback/{ifnum}

	                                       

	 **Element Name**                      loopback

	 **Element URI**                       /axapi/v3/interface/loopback/{ifnum}/oper

	 **Element Attributes**                loopback_attributes

	 **Partition Visibility**              None

	 **Schema**                             :download:`loopback schema <interface-loopback-oper/interface-loopback-oper.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}



.. raw:: html

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


:ref:`1969_loopback_attributes`



.. raw:: html

   </td><td></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/interface/loopback/{ifnum}



.. raw:: html

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


:ref:`1969_loopback_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/interface/loopback/{ifnum}/oper



.. raw:: html

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


:ref:`1969_loopback_attributes`



.. raw:: html

   </td><td></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/interface/loopback/{ifnum}



.. raw:: html

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


:ref:`1969_loopback_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/interface/loopback/{ifnum}/oper



.. raw:: html

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


:ref:`1969_loopback_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}/oper



.. raw:: html

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


:ref:`1969_loopback_attributes`



.. raw:: html

   </td><td></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/interface/loopback/{ifnum}



.. raw:: html

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


:ref:`1969_loopback_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/interface/loopback/{ifnum}/oper



.. raw:: html

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


:ref:`1969_loopback_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1969_loopback_list:

loopback-list
-------------


    loopback-list is **JSON List** of :ref:`1969_loopback_attributes` 

        loopback-list : [

             { :ref:`1969_loopback_attributes` },

             { :ref:`1969_loopback_attributes` },

             ...

         ]

.. _1969_loopback_attributes:

loopback attributes
-------------------

    **ifnum**

        **Description** Loopback interface number

        **Type:** number

        **Format:** interface

    **oper**

        **Description:** oper is a **JSON Block**.  Please see below for :ref:`1969_oper` 

        **Type:** Object

.. _1969_oper:

oper
^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **ipv4-address**

        **Description** IP address

        **Type:** string

        **Format:** ipv4-address

    **ipv4-netmask**

        **Description** IP subnet mask

        **Type:** string

        **Format:** ipv4-netmask

    **ipv4_addr_count**

        **Description** 

        **Type:** number

    **ipv4_list**

        **Type:** List

    **ipv6-link-local**

        **Description** 

        **Type:** string

        **Format:** ipv6-address

    **ipv6-link-local-prefix**

        **Description** 

        **Type:** string

    **ipv6-link-local-scope**

        **Description** 

        **Type:** string

    **ipv6-link-local-type**

        **Description** 

        **Type:** string

    **ipv6_addr_count**

        **Description** 

        **Type:** number

    **ipv6_list**

        **Type:** List

    **line_protocol**

        **Description** 

        **Type:** string

    **state**

        **Description** 

        **Type:** string

.. _1969_oper_ipv6_list:

oper_ipv6_list
^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **addr**

        **Description** IP address

        **Type:** string

        **Format:** ipv6-address

    **is_anycast**

        **Description** 

        **Type:** number

    **prefix**

        **Description** IP subnet mask

        **Type:** string

.. _1969_oper_ipv4_list:

oper_ipv4_list
^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **addr**

        **Description** IP address

        **Type:** string

        **Format:** ipv4-address

    **mask**

        **Description** IP subnet mask

        **Type:** string

        **Format:** ipv4-netmask