.. _interface_trunk_ip_ospf_ospf_global:
interface trunk ip ospf ospf-global
===================================
Global setting for Open Shortest Path First for IPv4 (OSPF)
ospf-global Specification
-------------------------
===================================== ====================================================================================
**Parameter** **Value**
===================================== ====================================================================================
**Type** *Configuration Resource*
**Element Name** ospf-global
**Element URI** /axapi/v3/interface/trunk/{ifnum}/ip/ospf/ospf-global
**Element Attributes** ospf-global_attributes
**Partition Visibility** shared
**Schema** :download:`ospf-global schema <interface-trunk-ip-ospf-ospf-global/interface-trunk-ip-ospf-ospf-global.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-global
.. raw:: html
</td><td valign = 'top'>
:ref:`1982_ospf-global_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_trunk_ip_ospf_ospf_global_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/trunk/{ifnum}/ip/ospf/ospf-global
.. raw:: html
</td><td valign = 'top'>
:ref:`1982_ospf-global_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_trunk_ip_ospf_ospf_global_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/trunk/{ifnum}/ip/ospf/ospf-global
.. raw:: html
</td><td valign = 'top'>
:ref:`1982_ospf-global_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-global
.. raw:: html
</td><td valign = 'top'>
:ref:`1982_ospf-global_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_trunk_ip_ospf_ospf_global_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/trunk/{ifnum}/ip/ospf/ospf-global
.. raw:: html
</td><td valign = 'top'>
:ref:`1982_ospf-global_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_trunk_ip_ospf_ospf_global_DELETE.txt
:literal:
.. raw:: html
</div></td></tr>
.. raw:: html
</table>
.. _1982_ospf-global_attributes:
ospf-global attributes
----------------------
**authentication-cfg**
**Description:** authentication-cfg is a **JSON Block**. Please see below for :ref:`1982_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:`1982_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:`1982_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
**network**
**Description:** network is a **JSON Block**. Please see below for :ref:`1982_network`
**Type:** Object
**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
.. _1982_network:
network
^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *object*
=============================== ===================================================
**broadcast**
**Description** Specify OSPF broadcast multi-access network
**Type:** boolean
**Supported Values:** true, false, 1, 0
**Default:** 0
**Mutual Exclusion:** broadcast,non-broadcast, point-to-point, and point-to-multipoint are mutually exclusive
**non-broadcast**
**Description** Specify OSPF NBMA network
**Type:** boolean
**Supported Values:** true, false, 1, 0
**Default:** 0
**Mutual Exclusion:** non-broadcast,broadcast, point-to-point, and point-to-multipoint are mutually exclusive
**p2mp-nbma**
**Description** Specify non-broadcast point-to-multipoint network
**Type:** boolean
**Supported Values:** true, false, 1, 0
**Default:** 0
**point-to-multipoint**
**Description** Specify OSPF point-to-multipoint network
**Type:** boolean
**Supported Values:** true, false, 1, 0
**Default:** 0
**Mutual Exclusion:** point-to-multipoint,broadcast, non-broadcast, and point-to-point are mutually exclusive
**point-to-point**
**Description** Specify OSPF point-to-point network
**Type:** boolean
**Supported Values:** true, false, 1, 0
**Default:** 0
**Mutual Exclusion:** point-to-point,broadcast, non-broadcast, and point-to-multipoint are mutually exclusive
.. _1982_authentication-cfg:
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
.. _1982_database-filter-cfg:
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
.. _1982_bfd-cfg:
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
.. _1982_message-digest-cfg:
message-digest-cfg
^^^^^^^^^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *list*
**Block object keys**
=============================== ===================================================
**md5**
**Description:** md5 is a **JSON Block**. Please see below for :ref:`1982_message-digest-cfg_md5`
**Type:** Object
**message-digest-key**
**Description** Message digest authentication password (key) (Key id)
**Type:** number
**Range:** 1-255
.. _1982_message-digest-cfg_md5:
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