.. _interface_loopback_ip:

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

Global IP configuration subcommands


ip Specification
----------------

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

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

	 **Element Name**                      ip

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

	 **Element Attributes**                ip_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`1960_ip_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_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



.. raw:: html

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


:ref:`1960_ip_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_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



.. raw:: html

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


:ref:`1960_ip_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



.. raw:: html

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


:ref:`1960_ip_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_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



.. raw:: html

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


:ref:`1960_ip_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_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _1960_ip_attributes:

ip attributes
-------------

    **address-list**

        **Type:** List

    **ospf**

        **Description:** ospf is a **JSON Block**.  Please see below for :ref:`1960_ospf` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/interface/loopback/{ifnum}/ip/ospf <interface_loopback>`

    **rip**

        **Description:** rip is a **JSON Block**.  Please see below for :ref:`1960_rip` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/interface/loopback/{ifnum}/ip/rip <interface_loopback>`

    **router**

        **Description:** router is a **JSON Block**.  Please see below for :ref:`1960_router` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/interface/loopback/{ifnum}/ip/router <interface_loopback>`

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1960_address-list:

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

	 **Block object keys**             

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

    **ipv4-address**

        **Description** IP address

        **Type:** string

        **Format:** ipv4-address

    **ipv4-netmask**

        **Description** IP subnet mask

        **Type:** string

        **Format:** ipv4-netmask

.. _1960_ospf:

ospf
^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **ospf-global**

        **Description:** ospf-global is a **JSON Block**.  Please see below for :ref:`1960_ospf_ospf-global` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/interface/loopback/{ifnum}/ip/ospf/ospf-global <interface_loopback>`

    **ospf-ip-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/interface/loopback/{ifnum}/ip/ospf/ospf-ip/{ip-addr} <interface_loopback>`

.. _1960_ospf_ospf-ip-list:

ospf_ospf-ip-list
^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **authentication**

        **Description** Enable authentication

        **Type:** boolean

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

        **Default:** 0

    **authentication-key**

        **Description** Authentication password (key) (The OSPF password (key))

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 8 characters

        **Maximum Length:** 1 characters

    **cost**

        **Description** Interface cost

        **Type:** number

        **Range:** 1-65535

    **database-filter**

        **Description** 'all': Filter all LSA; 

        **Type:** string

        **Supported Values:** all

    **dead-interval**

        **Description** Interval after which a neighbor is declared dead (Seconds)

        **Type:** number

        **Range:** 1-65535

        **Default:** 40

    **hello-interval**

        **Description** Time between HELLO packets (Seconds)

        **Type:** number

        **Range:** 1-65535

        **Default:** 10

    **ip-addr**

        **Description** Address of interface

        **Type:** string

        **Format:** ipv4-address

    **message-digest-cfg**

        **Type:** List

    **mtu-ignore**

        **Description** Ignores the MTU in DBD packets

        **Type:** boolean

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

        **Default:** 0

    **out**

        **Description** Outgoing LSA

        **Type:** boolean

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

        **Default:** 0

    **priority**

        **Description** Router priority

        **Type:** number

        **Range:** 0-255

        **Default:** 1

    **retransmit-interval**

        **Description** Time between retransmitting lost link state advertisements (Seconds)

        **Type:** number

        **Range:** 1-65535

        **Default:** 5

    **transmit-delay**

        **Description** Link state transmit delay (Seconds)

        **Type:** number

        **Range:** 1-65535

        **Default:** 1

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **value**

        **Description** 'message-digest': Use message-digest authentication; 'null': Use no authentication; 

        **Type:** string

        **Supported Values:** message-digest, null

.. _1960_ospf_ospf-ip-list_message-digest-cfg:

ospf_ospf-ip-list_message-digest-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **encrypted**

        **Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)

    **md5-value**

        **Description** The OSPF password (1-16)

        **Type:** string

        **Format:** password

        **Maximum Length:** 16 characters

        **Maximum Length:** 1 characters

    **message-digest-key**

        **Description** Message digest authentication password (key) (Key id)

        **Type:** number

        **Range:** 1-255

.. _1960_ospf_ospf-global:

ospf_ospf-global
^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **authentication-cfg**

        **Description:** authentication-cfg is a **JSON Block**.  Please see below for :ref:`1960_ospf_ospf-global_authentication-cfg` 

        **Type:** Object

    **authentication-key**

        **Description** Authentication password (key) (The OSPF password (key))

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 8 characters

        **Maximum Length:** 1 characters

    **bfd-cfg**

        **Description:** bfd-cfg is a **JSON Block**.  Please see below for :ref:`1960_ospf_ospf-global_bfd-cfg` 

        **Type:** Object

    **cost**

        **Description** Interface cost

        **Type:** number

        **Range:** 1-65535

    **database-filter-cfg**

        **Description:** database-filter-cfg is a **JSON Block**.  Please see below for :ref:`1960_ospf_ospf-global_database-filter-cfg` 

        **Type:** Object

    **dead-interval**

        **Description** Interval after which a neighbor is declared dead (Seconds)

        **Type:** number

        **Range:** 1-65535

        **Default:** 40

    **disable**

        **Description** 'all': All functionality; 

        **Type:** string

        **Supported Values:** all

    **hello-interval**

        **Description** Time between HELLO packets (Seconds)

        **Type:** number

        **Range:** 1-65535

        **Default:** 10

    **message-digest-cfg**

        **Type:** List

    **mtu**

        **Description** OSPF interface MTU (MTU size)

        **Type:** number

        **Range:** 576-65535

    **mtu-ignore**

        **Description** Ignores the MTU in DBD packets

        **Type:** boolean

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

        **Default:** 0

    **priority**

        **Description** Router priority

        **Type:** number

        **Range:** 0-255

        **Default:** 1

    **retransmit-interval**

        **Description** Time between retransmitting lost link state advertisements (Seconds)

        **Type:** number

        **Range:** 1-65535

        **Default:** 5

    **transmit-delay**

        **Description** Link state transmit delay (Seconds)

        **Type:** number

        **Range:** 1-65535

        **Default:** 1

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1960_ospf_ospf-global_authentication-cfg:

ospf_ospf-global_authentication-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **authentication**

        **Description** Enable authentication

        **Type:** boolean

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

        **Default:** 0

    **value**

        **Description** 'message-digest': Use message-digest authentication; 'null': Use no authentication; 

        **Type:** string

        **Supported Values:** message-digest, null

.. _1960_ospf_ospf-global_database-filter-cfg:

ospf_ospf-global_database-filter-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **database-filter**

        **Description** 'all': Filter all LSA; 

        **Type:** string

        **Supported Values:** all

    **out**

        **Description** Outgoing LSA

        **Type:** boolean

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

        **Default:** 0

.. _1960_ospf_ospf-global_bfd-cfg:

ospf_ospf-global_bfd-cfg
^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **bfd**

        **Description** Bidirectional Forwarding Detection (BFD)

        **Type:** boolean

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

        **Default:** 0

    **disable**

        **Description** Disable BFD

        **Type:** boolean

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

        **Default:** 0

.. _1960_ospf_ospf-global_message-digest-cfg:

ospf_ospf-global_message-digest-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **md5**

        **Description:** md5 is a **JSON Block**.  Please see below for :ref:`1960_ospf_ospf-global_message-digest-cfg_md5` 

        **Type:** Object

    **message-digest-key**

        **Description** Message digest authentication password (key) (Key id)

        **Type:** number

        **Range:** 1-255

.. _1960_ospf_ospf-global_message-digest-cfg_md5:

ospf_ospf-global_message-digest-cfg_md5
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **encrypted**

        **Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)

    **md5-value**

        **Description** The OSPF password (1-16)

        **Type:** string

        **Format:** password

        **Maximum Length:** 16 characters

        **Maximum Length:** 1 characters

.. _1960_rip:

rip
^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **authentication**

        **Description:** authentication is a **JSON Block**.  Please see below for :ref:`1960_rip_authentication` 

        **Type:** Object

    **receive-cfg**

        **Description:** receive-cfg is a **JSON Block**.  Please see below for :ref:`1960_rip_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:`1960_rip_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:`1960_rip_split-horizon-cfg` 

        **Type:** Object

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1960_rip_receive-cfg:

rip_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

.. _1960_rip_split-horizon-cfg:

rip_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

.. _1960_rip_authentication:

rip_authentication
^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **key-chain**

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

        **Type:** Object

    **mode**

        **Description:** mode is a **JSON Block**.  Please see below for :ref:`1960_rip_authentication_mode` 

        **Type:** Object

    **str**

        **Description:** str is a **JSON Block**.  Please see below for :ref:`1960_rip_authentication_str` 

        **Type:** Object

.. _1960_rip_authentication_key-chain:

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

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

    **key-chain**

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

        **Type:** string

        **Format:** string-rlx

.. _1960_rip_authentication_mode:

rip_authentication_mode
^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **mode**

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

        **Type:** string

        **Supported Values:** md5, text

        **Default:** text

.. _1960_rip_authentication_str:

rip_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

.. _1960_rip_send-cfg:

rip_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

.. _1960_router:

router
^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **isis**

        **Description:** isis is a **JSON Block**.  Please see below for :ref:`1960_router_isis` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/interface/loopback/{ifnum}/ip/router/isis <interface_loopback>`

.. _1960_router_isis:

router_isis
^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **tag**

        **Description** ISO routing area tag

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters