.. _interface_trunk_ip_ospf_ospf_ip:

interface trunk ip ospf ospf-ip
===============================

IP address configuration for Open Shortest Path First for IPv4 (OSPF)


ospf-ip Specification
---------------------

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

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

	 **Object Key(s)**                     *ip-addr*

	 **Collection Name**                   :ref:`1983_ospf-ip_list`

	 **Collection URI**                    /axapi/v3/interface/trunk/{ifnum}/ip/ospf/ospf-ip

	                                       

	 **Element Name**                      ospf-ip

	 **Element URI**                       /axapi/v3/interface/trunk/{ifnum}/ip/ospf/ospf-ip/{ip-addr}

	 **Element Attributes**                ospf-ip_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`1983_ospf-ip_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/trunk/{ifnum}/ip/ospf/ospf-ip



.. raw:: html

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


:ref:`1983_ospf-ip_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/trunk/{ifnum}/ip/ospf/ospf-ip/{ip-addr}



.. raw:: html

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


:ref:`1983_ospf-ip_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/trunk/{ifnum}/ip/ospf/ospf-ip



.. raw:: html

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


:ref:`1983_ospf-ip_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/trunk/{ifnum}/ip/ospf/ospf-ip/{ip-addr}



.. raw:: html

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


:ref:`1983_ospf-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/trunk/{ifnum}/ip/ospf/ospf-ip/{ip-addr}



.. raw:: html

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


:ref:`1983_ospf-ip_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/trunk/{ifnum}/ip/ospf/ospf-ip



.. raw:: html

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


:ref:`1983_ospf-ip_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/trunk/{ifnum}/ip/ospf/ospf-ip/{ip-addr}



.. raw:: html

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


:ref:`1983_ospf-ip_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1983_ospf-ip_list:

ospf-ip-list
------------


    ospf-ip-list is **JSON List** of :ref:`1983_ospf-ip_attributes` 

        ospf-ip-list : [

             { :ref:`1983_ospf-ip_attributes` },

             { :ref:`1983_ospf-ip_attributes` },

             ...

         ]

.. _1983_ospf-ip_attributes:

ospf-ip attributes
------------------

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

.. _1983_message-digest-cfg:

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