source: fortios_router_ospf.py
orphan

fortios_router_ospf -- Configure OSPF in Fortinet's FortiOS and FortiGate.

2.0.0

Synopsis

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify router feature and ospf category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

The below requirements are needed on the host that executes this module.

ansible>=2.14

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility

	Supported Version Ranges
fortios_router_ospf	`v6.0.0 -> latest`

Parameters

access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
enable_log - Enable/Disable logging for task. type: bool required: false default: False
vdom - Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. type: str default: root
member_path - Member attribute path to operate on. type: str
member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
router_ospf - Configure OSPF. type: dict

<a id='label0' href="javascript:ContentClick('label1', 'label0');" onmouseover="ContentPreview('label1');" onmouseout="ContentUnpreview('label1');" title="click to collapse or expand..."> more... </a> <div id="label1" style="display:none"> <table border="1"> <tr> <td></td><td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>router_ospf</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">abr_type</span> - Area border router type. <span class="li-normal">type: str</span> <span class="li-normal">choices: cisco, ibm, shortcut, standard</span> <a id='label2' href="javascript:ContentClick('label3', 'label2');" onmouseover="ContentPreview('label3');" onmouseout="ContentUnpreview('label3');" title="click to collapse or expand..."> more... </a> <div id="label3" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>abr_type</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> <tr> <td>[cisco]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> <tr> <td>[ibm]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> <tr> <td>[shortcut]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> <tr> <td>[standard]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> </table> </div> </li> <li> <span class="li-head">area</span> - OSPF area configuration. <span class="li-normal">type: list</span> <span style="font-family:'Courier New'" class="li-required">member_path: area:id</span> <a id='label4' href="javascript:ContentClick('label5', 'label4');" onmouseover="ContentPreview('label5');" onmouseout="ContentUnpreview('label5');" title="click to collapse or expand..."> more... </a> <div id="label5" style="display:none"> <table border="1"> <tr> <td></td><td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>area</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">authentication</span> - Authentication type. <span class="li-normal">type: str</span> <span class="li-normal">choices: none, text, message-digest, md5</span> <a id='label6' href="javascript:ContentClick('label7', 'label6');" onmouseover="ContentPreview('label7');" onmouseout="ContentUnpreview('label7');" title="click to collapse or expand..."> more... </a> <div id="label7" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>authentication</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> <tr> <td>[none]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> <tr> <td>[text]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> <tr> <td>[message-digest]</td> <td><code class="docutils literal notranslate">v7.0.1 -> latest</code></td> </tr> <tr> <td>[md5]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.0</code></td> </tr> </table> </div> </li> <li> <span class="li-head">comments</span> - Comment. <span class="li-normal">type: str</span> <a id='label8' href="javascript:ContentClick('label9', 'label8');" onmouseover="ContentPreview('label9');" onmouseout="ContentUnpreview('label9');" title="click to collapse or expand..."> more... </a> <div id="label9" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>comments</td> <td><code class="docutils literal notranslate">v7.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">default_cost</span> - Summary default cost of stub or NSSA area. <span class="li-normal">type: int</span> <a id='label10' href="javascript:ContentClick('label11', 'label10');" onmouseover="ContentPreview('label11');" onmouseout="ContentUnpreview('label11');" title="click to collapse or expand..."> more... </a> <div id="label11" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>default_cost</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">filter_list</span> - OSPF area filter-list configuration. <span class="li-normal">type: list</span> <span style="font-family:'Courier New'" class="li-required">member_path: area:id/filter_list:id</span> <a id='label12' href="javascript:ContentClick('label13', 'label12');" onmouseover="ContentPreview('label13');" onmouseout="ContentUnpreview('label13');" title="click to collapse or expand..."> more... </a> <div id="label13" style="display:none"> <table border="1"> <tr> <td></td><td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>filter_list</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">direction</span> - Direction. <span class="li-normal">type: str</span> <span class="li-normal">choices: in, out</span> <a id='label14' href="javascript:ContentClick('label15', 'label14');" onmouseover="ContentPreview('label15');" onmouseout="ContentUnpreview('label15');" title="click to collapse or expand..."> more... </a> <div id="label15" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>direction</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> <tr> <td>[in]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> <tr> <td>[out]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> </table> </div> </li> <li> <span class="li-head">id</span> - Filter list entry ID. see <a href='#notes'>Notes</a>. <span class="li-normal">type: int</span> <span class="li-required">required: true</span> <a id='label16' href="javascript:ContentClick('label17', 'label16');" onmouseover="ContentPreview('label17');" onmouseout="ContentUnpreview('label17');" title="click to collapse or expand..."> more... </a> <div id="label17" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>id</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">list</span> - Access-list or prefix-list name. Source router.access-list.name router.prefix-list.name. <span class="li-normal">type: str</span> <a id='label18' href="javascript:ContentClick('label19', 'label18');" onmouseover="ContentPreview('label19');" onmouseout="ContentUnpreview('label19');" title="click to collapse or expand..."> more... </a> <div id="label19" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>list</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> </ul> <li> <span class="li-head">id</span> - Area entry IP address. <span class="li-normal">type: str</span> <span class="li-required">required: true</span> <a id='label20' href="javascript:ContentClick('label21', 'label20');" onmouseover="ContentPreview('label21');" onmouseout="ContentUnpreview('label21');" title="click to collapse or expand..."> more... </a> <div id="label21" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>id</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">nssa_default_information_originate</span> - Redistribute, advertise, or do not originate Type-7 default route into NSSA area. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, always, disable</span> <a id='label22' href="javascript:ContentClick('label23', 'label22');" onmouseover="ContentPreview('label23');" onmouseout="ContentUnpreview('label23');" title="click to collapse or expand..."> more... </a> <div id="label23" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>nssa_default_information_originate</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> <tr> <td>[always]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> </table> </div> </li> <li> <span class="li-head">nssa_default_information_originate_metric</span> - OSPF default metric. <span class="li-normal">type: int</span> <a id='label24' href="javascript:ContentClick('label25', 'label24');" onmouseover="ContentPreview('label25');" onmouseout="ContentUnpreview('label25');" title="click to collapse or expand..."> more... </a> <div id="label25" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>nssa_default_information_originate_metric</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">nssa_default_information_originate_metric_type</span> - OSPF metric type for default routes. <span class="li-normal">type: str</span> <span class="li-normal">choices: 1, 2</span> <a id='label26' href="javascript:ContentClick('label27', 'label26');" onmouseover="ContentPreview('label27');" onmouseout="ContentUnpreview('label27');" title="click to collapse or expand..."> more... </a> <div id="label27" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>nssa_default_information_originate_metric_type</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> <tr> <td>[1]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> <tr> <td>[2]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> </table> </div> </li> <li> <span class="li-head">nssa_redistribution</span> - Enable/disable redistribute into NSSA area. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label28' href="javascript:ContentClick('label29', 'label28');" onmouseover="ContentPreview('label29');" onmouseout="ContentUnpreview('label29');" title="click to collapse or expand..."> more... </a> <div id="label29" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>nssa_redistribution</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> </table> </div> </li> <li> <span class="li-head">nssa_translator_role</span> - NSSA translator role type. <span class="li-normal">type: str</span> <span class="li-normal">choices: candidate, never, always</span> <a id='label30' href="javascript:ContentClick('label31', 'label30');" onmouseover="ContentPreview('label31');" onmouseout="ContentUnpreview('label31');" title="click to collapse or expand..."> more... </a> <div id="label31" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>nssa_translator_role</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> <tr> <td>[candidate]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> <tr> <td>[never]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> <tr> <td>[always]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> </table> </div> </li> <li> <span class="li-head">range</span> - OSPF area range configuration. <span class="li-normal">type: list</span> <span style="font-family:'Courier New'" class="li-required">member_path: area:id/range:id</span> <a id='label32' href="javascript:ContentClick('label33', 'label32');" onmouseover="ContentPreview('label33');" onmouseout="ContentUnpreview('label33');" title="click to collapse or expand..."> more... </a> <div id="label33" style="display:none"> <table border="1"> <tr> <td></td><td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>range</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">advertise</span> - Enable/disable advertise status. <span class="li-normal">type: str</span> <span class="li-normal">choices: disable, enable</span> <a id='label34' href="javascript:ContentClick('label35', 'label34');" onmouseover="ContentPreview('label35');" onmouseout="ContentUnpreview('label35');" title="click to collapse or expand..."> more... </a> <div id="label35" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>advertise</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> </table> </div> </li> <li> <span class="li-head">id</span> - Range entry ID. see <a href='#notes'>Notes</a>. <span class="li-normal">type: int</span> <span class="li-required">required: true</span> <a id='label36' href="javascript:ContentClick('label37', 'label36');" onmouseover="ContentPreview('label37');" onmouseout="ContentUnpreview('label37');" title="click to collapse or expand..."> more... </a> <div id="label37" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>id</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">prefix</span> - Prefix. <span class="li-normal">type: str</span> <a id='label38' href="javascript:ContentClick('label39', 'label38');" onmouseover="ContentPreview('label39');" onmouseout="ContentUnpreview('label39');" title="click to collapse or expand..."> more... </a> <div id="label39" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>prefix</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">substitute</span> - Substitute prefix. <span class="li-normal">type: str</span> <a id='label40' href="javascript:ContentClick('label41', 'label40');" onmouseover="ContentPreview('label41');" onmouseout="ContentUnpreview('label41');" title="click to collapse or expand..."> more... </a> <div id="label41" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>substitute</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">substitute_status</span> - Enable/disable substitute status. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label42' href="javascript:ContentClick('label43', 'label42');" onmouseover="ContentPreview('label43');" onmouseout="ContentUnpreview('label43');" title="click to collapse or expand..."> more... </a> <div id="label43" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>substitute_status</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> </table> </div> </li> </ul> <li> <span class="li-head">shortcut</span> - Enable/disable shortcut option. <span class="li-normal">type: str</span> <span class="li-normal">choices: disable, enable, default</span> <a id='label44' href="javascript:ContentClick('label45', 'label44');" onmouseover="ContentPreview('label45');" onmouseout="ContentUnpreview('label45');" title="click to collapse or expand..."> more... </a> <div id="label45" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>shortcut</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> <tr> <td>[default]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> </table> </div> </li> <li> <span class="li-head">stub_type</span> - Stub summary setting. <span class="li-normal">type: str</span> <span class="li-normal">choices: no-summary, summary</span> <a id='label46' href="javascript:ContentClick('label47', 'label46');" onmouseover="ContentPreview('label47');" onmouseout="ContentUnpreview('label47');" title="click to collapse or expand..."> more... </a> <div id="label47" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>stub_type</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> <tr> <td>[no-summary]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> <tr> <td>[summary]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> </table> </div> </li> <li> <span class="li-head">type</span> - Area type setting. <span class="li-normal">type: str</span> <span class="li-normal">choices: regular, nssa, stub</span> <a id='label48' href="javascript:ContentClick('label49', 'label48');" onmouseover="ContentPreview('label49');" onmouseout="ContentUnpreview('label49');" title="click to collapse or expand..."> more... </a> <div id="label49" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>type</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> <tr> <td>[regular]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> <tr> <td>[nssa]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> <tr> <td>[stub]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> </table> </div> </li> <li> <span class="li-head">virtual_link</span> - OSPF virtual link configuration. <span class="li-normal">type: list</span> <span style="font-family:'Courier New'" class="li-required">member_path: area:id/virtual_link:name</span> <a id='label50' href="javascript:ContentClick('label51', 'label50');" onmouseover="ContentPreview('label51');" onmouseout="ContentUnpreview('label51');" title="click to collapse or expand..."> more... </a> <div id="label51" style="display:none"> <table border="1"> <tr> <td></td><td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>virtual_link</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">authentication</span> - Authentication type. <span class="li-normal">type: str</span> <span class="li-normal">choices: none, text, message-digest, md5</span> <a id='label52' href="javascript:ContentClick('label53', 'label52');" onmouseover="ContentPreview('label53');" onmouseout="ContentUnpreview('label53');" title="click to collapse or expand..."> more... </a> <div id="label53" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>authentication</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> <tr> <td>[none]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> <tr> <td>[text]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> <tr> <td>[message-digest]</td> <td><code class="docutils literal notranslate">v7.0.1 -> latest</code></td> </tr> <tr> <td>[md5]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.0</code></td> </tr> </table> </div> </li> <li> <span class="li-head">authentication_key</span> - Authentication key. <span class="li-normal">type: str</span> <a id='label54' href="javascript:ContentClick('label55', 'label54');" onmouseover="ContentPreview('label55');" onmouseout="ContentUnpreview('label55');" title="click to collapse or expand..."> more... </a> <div id="label55" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>authentication_key</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">dead_interval</span> - Dead interval. <span class="li-normal">type: int</span> <a id='label56' href="javascript:ContentClick('label57', 'label56');" onmouseover="ContentPreview('label57');" onmouseout="ContentUnpreview('label57');" title="click to collapse or expand..."> more... </a> <div id="label57" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>dead_interval</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">hello_interval</span> - Hello interval. <span class="li-normal">type: int</span> <a id='label58' href="javascript:ContentClick('label59', 'label58');" onmouseover="ContentPreview('label59');" onmouseout="ContentUnpreview('label59');" title="click to collapse or expand..."> more... </a> <div id="label59" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>hello_interval</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">keychain</span> - Message-digest key-chain name. Source router.key-chain.name. <span class="li-normal">type: str</span> <a id='label60' href="javascript:ContentClick('label61', 'label60');" onmouseover="ContentPreview('label61');" onmouseout="ContentUnpreview('label61');" title="click to collapse or expand..."> more... </a> <div id="label61" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>keychain</td> <td><code class="docutils literal notranslate">v7.0.1 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">md5_key</span> - MD5 key. <span class="li-normal">type: str</span> <a id='label62' href="javascript:ContentClick('label63', 'label62');" onmouseover="ContentPreview('label63');" onmouseout="ContentUnpreview('label63');" title="click to collapse or expand..."> more... </a> <div id="label63" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>md5_key</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">md5_keychain</span> - Authentication MD5 key-chain name. Source router.key-chain.name. <span class="li-normal">type: str</span> <a id='label64' href="javascript:ContentClick('label65', 'label64');" onmouseover="ContentPreview('label65');" onmouseout="ContentUnpreview('label65');" title="click to collapse or expand..."> more... </a> <div id="label65" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>md5_keychain</td> <td><code class="docutils literal notranslate">v6.2.0 -> v7.0.0 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">md5_keys</span> - MD5 key. <span class="li-normal">type: list</span> <span style="font-family:'Courier New'" class="li-required">member_path: area:id/virtual_link:name/md5_keys:id</span> <a id='label66' href="javascript:ContentClick('label67', 'label66');" onmouseover="ContentPreview('label67');" onmouseout="ContentUnpreview('label67');" title="click to collapse or expand..."> more... </a> <div id="label67" style="display:none"> <table border="1"> <tr> <td></td><td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>md5_keys</td> <td><code class="docutils literal notranslate">v6.2.0 -> latest </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">id</span> - Key ID (1 - 255). see <a href='#notes'>Notes</a>. <span class="li-normal">type: int</span> <span class="li-required">required: true</span> <a id='label68' href="javascript:ContentClick('label69', 'label68');" onmouseover="ContentPreview('label69');" onmouseout="ContentUnpreview('label69');" title="click to collapse or expand..."> more... </a> <div id="label69" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>id</td> <td><code class="docutils literal notranslate">v6.2.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">key_string</span> - Password for the key. <span class="li-normal">type: str</span> <a id='label70' href="javascript:ContentClick('label71', 'label70');" onmouseover="ContentPreview('label71');" onmouseout="ContentUnpreview('label71');" title="click to collapse or expand..."> more... </a> <div id="label71" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>key_string</td> <td><code class="docutils literal notranslate">v6.2.0 -> latest </code></td> </tr> </table> </div> </li> </ul> <li> <span class="li-head">name</span> - Virtual link entry name. <span class="li-normal">type: str</span> <span class="li-required">required: true</span> <a id='label72' href="javascript:ContentClick('label73', 'label72');" onmouseover="ContentPreview('label73');" onmouseout="ContentUnpreview('label73');" title="click to collapse or expand..."> more... </a> <div id="label73" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>name</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">peer</span> - Peer IP. <span class="li-normal">type: str</span> <a id='label74' href="javascript:ContentClick('label75', 'label74');" onmouseover="ContentPreview('label75');" onmouseout="ContentUnpreview('label75');" title="click to collapse or expand..."> more... </a> <div id="label75" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>peer</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">retransmit_interval</span> - Retransmit interval. <span class="li-normal">type: int</span> <a id='label76' href="javascript:ContentClick('label77', 'label76');" onmouseover="ContentPreview('label77');" onmouseout="ContentUnpreview('label77');" title="click to collapse or expand..."> more... </a> <div id="label77" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>retransmit_interval</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">transmit_delay</span> - Transmit delay. <span class="li-normal">type: int</span> <a id='label78' href="javascript:ContentClick('label79', 'label78');" onmouseover="ContentPreview('label79');" onmouseout="ContentUnpreview('label79');" title="click to collapse or expand..."> more... </a> <div id="label79" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>transmit_delay</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> </ul> </ul> <li> <span class="li-head">auto_cost_ref_bandwidth</span> - Reference bandwidth in terms of megabits per second. <span class="li-normal">type: int</span> <a id='label80' href="javascript:ContentClick('label81', 'label80');" onmouseover="ContentPreview('label81');" onmouseout="ContentUnpreview('label81');" title="click to collapse or expand..."> more... </a> <div id="label81" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>auto_cost_ref_bandwidth</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">bfd</span> - Bidirectional Forwarding Detection (BFD). <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label82' href="javascript:ContentClick('label83', 'label82');" onmouseover="ContentPreview('label83');" onmouseout="ContentUnpreview('label83');" title="click to collapse or expand..."> more... </a> <div id="label83" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>bfd</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> </table> </div> </li> <li> <span class="li-head">database_overflow</span> - Enable/disable database overflow. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label84' href="javascript:ContentClick('label85', 'label84');" onmouseover="ContentPreview('label85');" onmouseout="ContentUnpreview('label85');" title="click to collapse or expand..."> more... </a> <div id="label85" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>database_overflow</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> </table> </div> </li> <li> <span class="li-head">database_overflow_max_lsas</span> - Database overflow maximum LSAs. <span class="li-normal">type: int</span> <a id='label86' href="javascript:ContentClick('label87', 'label86');" onmouseover="ContentPreview('label87');" onmouseout="ContentUnpreview('label87');" title="click to collapse or expand..."> more... </a> <div id="label87" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>database_overflow_max_lsas</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">database_overflow_time_to_recover</span> - Database overflow time to recover (sec). <span class="li-normal">type: int</span> <a id='label88' href="javascript:ContentClick('label89', 'label88');" onmouseover="ContentPreview('label89');" onmouseout="ContentUnpreview('label89');" title="click to collapse or expand..."> more... </a> <div id="label89" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>database_overflow_time_to_recover</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">default_information_metric</span> - Default information metric. <span class="li-normal">type: int</span> <a id='label90' href="javascript:ContentClick('label91', 'label90');" onmouseover="ContentPreview('label91');" onmouseout="ContentUnpreview('label91');" title="click to collapse or expand..."> more... </a> <div id="label91" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>default_information_metric</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">default_information_metric_type</span> - Default information metric type. <span class="li-normal">type: str</span> <span class="li-normal">choices: 1, 2</span> <a id='label92' href="javascript:ContentClick('label93', 'label92');" onmouseover="ContentPreview('label93');" onmouseout="ContentUnpreview('label93');" title="click to collapse or expand..."> more... </a> <div id="label93" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>default_information_metric_type</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> <tr> <td>[1]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> <tr> <td>[2]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> </table> </div> </li> <li> <span class="li-head">default_information_originate</span> - Enable/disable generation of default route. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, always, disable</span> <a id='label94' href="javascript:ContentClick('label95', 'label94');" onmouseover="ContentPreview('label95');" onmouseout="ContentUnpreview('label95');" title="click to collapse or expand..."> more... </a> <div id="label95" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>default_information_originate</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> <tr> <td>[always]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> </table> </div> </li> <li> <span class="li-head">default_information_route_map</span> - Default information route map. Source router.route-map.name. <span class="li-normal">type: str</span> <a id='label96' href="javascript:ContentClick('label97', 'label96');" onmouseover="ContentPreview('label97');" onmouseout="ContentUnpreview('label97');" title="click to collapse or expand..."> more... </a> <div id="label97" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>default_information_route_map</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">default_metric</span> - Default metric of redistribute routes. <span class="li-normal">type: int</span> <a id='label98' href="javascript:ContentClick('label99', 'label98');" onmouseover="ContentPreview('label99');" onmouseout="ContentUnpreview('label99');" title="click to collapse or expand..."> more... </a> <div id="label99" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>default_metric</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">distance</span> - Distance of the route. <span class="li-normal">type: int</span> <a id='label100' href="javascript:ContentClick('label101', 'label100');" onmouseover="ContentPreview('label101');" onmouseout="ContentUnpreview('label101');" title="click to collapse or expand..."> more... </a> <div id="label101" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>distance</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">distance_external</span> - Administrative external distance. <span class="li-normal">type: int</span> <a id='label102' href="javascript:ContentClick('label103', 'label102');" onmouseover="ContentPreview('label103');" onmouseout="ContentUnpreview('label103');" title="click to collapse or expand..."> more... </a> <div id="label103" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>distance_external</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">distance_inter_area</span> - Administrative inter-area distance. <span class="li-normal">type: int</span> <a id='label104' href="javascript:ContentClick('label105', 'label104');" onmouseover="ContentPreview('label105');" onmouseout="ContentUnpreview('label105');" title="click to collapse or expand..."> more... </a> <div id="label105" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>distance_inter_area</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">distance_intra_area</span> - Administrative intra-area distance. <span class="li-normal">type: int</span> <a id='label106' href="javascript:ContentClick('label107', 'label106');" onmouseover="ContentPreview('label107');" onmouseout="ContentUnpreview('label107');" title="click to collapse or expand..."> more... </a> <div id="label107" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>distance_intra_area</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">distribute_list</span> - Distribute list configuration. <span class="li-normal">type: list</span> <span style="font-family:'Courier New'" class="li-required">member_path: distribute_list:id</span> <a id='label108' href="javascript:ContentClick('label109', 'label108');" onmouseover="ContentPreview('label109');" onmouseout="ContentUnpreview('label109');" title="click to collapse or expand..."> more... </a> <div id="label109" style="display:none"> <table border="1"> <tr> <td></td><td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>distribute_list</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">access_list</span> - Access list name. Source router.access-list.name. <span class="li-normal">type: str</span> <a id='label110' href="javascript:ContentClick('label111', 'label110');" onmouseover="ContentPreview('label111');" onmouseout="ContentUnpreview('label111');" title="click to collapse or expand..."> more... </a> <div id="label111" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>access_list</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">id</span> - Distribute list entry ID. see <a href='#notes'>Notes</a>. <span class="li-normal">type: int</span> <span class="li-required">required: true</span> <a id='label112' href="javascript:ContentClick('label113', 'label112');" onmouseover="ContentPreview('label113');" onmouseout="ContentUnpreview('label113');" title="click to collapse or expand..."> more... </a> <div id="label113" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>id</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">protocol</span> - Protocol type. <span class="li-normal">type: str</span> <span class="li-normal">choices: connected, static, rip</span> <a id='label114' href="javascript:ContentClick('label115', 'label114');" onmouseover="ContentPreview('label115');" onmouseout="ContentUnpreview('label115');" title="click to collapse or expand..."> more... </a> <div id="label115" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>protocol</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> <tr> <td>[connected]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> <tr> <td>[static]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> <tr> <td>[rip]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> </table> </div> </li> </ul> <li> <span class="li-head">distribute_list_in</span> - Filter incoming routes. Source router.access-list.name router.prefix-list.name. <span class="li-normal">type: str</span> <a id='label116' href="javascript:ContentClick('label117', 'label116');" onmouseover="ContentPreview('label117');" onmouseout="ContentUnpreview('label117');" title="click to collapse or expand..."> more... </a> <div id="label117" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>distribute_list_in</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">distribute_route_map_in</span> - Filter incoming external routes by route-map. Source router.route-map.name. <span class="li-normal">type: str</span> <a id='label118' href="javascript:ContentClick('label119', 'label118');" onmouseover="ContentPreview('label119');" onmouseout="ContentUnpreview('label119');" title="click to collapse or expand..."> more... </a> <div id="label119" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>distribute_route_map_in</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">log_neighbour_changes</span> - Log of OSPF neighbor changes. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label120' href="javascript:ContentClick('label121', 'label120');" onmouseover="ContentPreview('label121');" onmouseout="ContentUnpreview('label121');" title="click to collapse or expand..."> more... </a> <div id="label121" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>log_neighbour_changes</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> </table> </div> </li> <li> <span class="li-head">neighbor</span> - OSPF neighbor configuration are used when OSPF runs on non-broadcast media. <span class="li-normal">type: list</span> <span style="font-family:'Courier New'" class="li-required">member_path: neighbor:id</span> <a id='label122' href="javascript:ContentClick('label123', 'label122');" onmouseover="ContentPreview('label123');" onmouseout="ContentUnpreview('label123');" title="click to collapse or expand..."> more... </a> <div id="label123" style="display:none"> <table border="1"> <tr> <td></td><td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>neighbor</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">cost</span> - Cost of the interface, value range from 0 to 65535, 0 means auto-cost. <span class="li-normal">type: int</span> <a id='label124' href="javascript:ContentClick('label125', 'label124');" onmouseover="ContentPreview('label125');" onmouseout="ContentUnpreview('label125');" title="click to collapse or expand..."> more... </a> <div id="label125" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>cost</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">id</span> - Neighbor entry ID. see <a href='#notes'>Notes</a>. <span class="li-normal">type: int</span> <span class="li-required">required: true</span> <a id='label126' href="javascript:ContentClick('label127', 'label126');" onmouseover="ContentPreview('label127');" onmouseout="ContentUnpreview('label127');" title="click to collapse or expand..."> more... </a> <div id="label127" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>id</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">ip</span> - Interface IP address of the neighbor. <span class="li-normal">type: str</span> <a id='label128' href="javascript:ContentClick('label129', 'label128');" onmouseover="ContentPreview('label129');" onmouseout="ContentUnpreview('label129');" title="click to collapse or expand..."> more... </a> <div id="label129" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>ip</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">poll_interval</span> - Poll interval time in seconds. <span class="li-normal">type: int</span> <a id='label130' href="javascript:ContentClick('label131', 'label130');" onmouseover="ContentPreview('label131');" onmouseout="ContentUnpreview('label131');" title="click to collapse or expand..."> more... </a> <div id="label131" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>poll_interval</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">priority</span> - Priority. <span class="li-normal">type: int</span> <a id='label132' href="javascript:ContentClick('label133', 'label132');" onmouseover="ContentPreview('label133');" onmouseout="ContentUnpreview('label133');" title="click to collapse or expand..."> more... </a> <div id="label133" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>priority</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> </ul> <li> <span class="li-head">network</span> - OSPF network configuration. <span class="li-normal">type: list</span> <span style="font-family:'Courier New'" class="li-required">member_path: network:id</span> <a id='label134' href="javascript:ContentClick('label135', 'label134');" onmouseover="ContentPreview('label135');" onmouseout="ContentUnpreview('label135');" title="click to collapse or expand..."> more... </a> <div id="label135" style="display:none"> <table border="1"> <tr> <td></td><td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>network</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">area</span> - Attach the network to area. <span class="li-normal">type: str</span> <a id='label136' href="javascript:ContentClick('label137', 'label136');" onmouseover="ContentPreview('label137');" onmouseout="ContentUnpreview('label137');" title="click to collapse or expand..."> more... </a> <div id="label137" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>area</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">comments</span> - Comment. <span class="li-normal">type: str</span> <a id='label138' href="javascript:ContentClick('label139', 'label138');" onmouseover="ContentPreview('label139');" onmouseout="ContentUnpreview('label139');" title="click to collapse or expand..."> more... </a> <div id="label139" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>comments</td> <td><code class="docutils literal notranslate">v7.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">id</span> - Network entry ID. see <a href='#notes'>Notes</a>. <span class="li-normal">type: int</span> <span class="li-required">required: true</span> <a id='label140' href="javascript:ContentClick('label141', 'label140');" onmouseover="ContentPreview('label141');" onmouseout="ContentUnpreview('label141');" title="click to collapse or expand..."> more... </a> <div id="label141" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>id</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">prefix</span> - Prefix. <span class="li-normal">type: str</span> <a id='label142' href="javascript:ContentClick('label143', 'label142');" onmouseover="ContentPreview('label143');" onmouseout="ContentUnpreview('label143');" title="click to collapse or expand..."> more... </a> <div id="label143" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>prefix</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> </ul> <li> <span class="li-head">ospf_interface</span> - OSPF interface configuration. <span class="li-normal">type: list</span> <span style="font-family:'Courier New'" class="li-required">member_path: ospf_interface:name</span> <a id='label144' href="javascript:ContentClick('label145', 'label144');" onmouseover="ContentPreview('label145');" onmouseout="ContentUnpreview('label145');" title="click to collapse or expand..."> more... </a> <div id="label145" style="display:none"> <table border="1"> <tr> <td></td><td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>ospf_interface</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">authentication</span> - Authentication type. <span class="li-normal">type: str</span> <span class="li-normal">choices: none, text, message-digest, md5</span> <a id='label146' href="javascript:ContentClick('label147', 'label146');" onmouseover="ContentPreview('label147');" onmouseout="ContentUnpreview('label147');" title="click to collapse or expand..."> more... </a> <div id="label147" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>authentication</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> <tr> <td>[none]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> <tr> <td>[text]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> <tr> <td>[message-digest]</td> <td><code class="docutils literal notranslate">v7.0.1 -> latest</code></td> </tr> <tr> <td>[md5]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.0</code></td> </tr> </table> </div> </li> <li> <span class="li-head">authentication_key</span> - Authentication key. <span class="li-normal">type: str</span> <a id='label148' href="javascript:ContentClick('label149', 'label148');" onmouseover="ContentPreview('label149');" onmouseout="ContentUnpreview('label149');" title="click to collapse or expand..."> more... </a> <div id="label149" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>authentication_key</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">bfd</span> - Bidirectional Forwarding Detection (BFD). <span class="li-normal">type: str</span> <span class="li-normal">choices: global, enable, disable</span> <a id='label150' href="javascript:ContentClick('label151', 'label150');" onmouseover="ContentPreview('label151');" onmouseout="ContentUnpreview('label151');" title="click to collapse or expand..."> more... </a> <div id="label151" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>bfd</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> <tr> <td>[global]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> </table> </div> </li> <li> <span class="li-head">comments</span> - Comment. <span class="li-normal">type: str</span> <a id='label152' href="javascript:ContentClick('label153', 'label152');" onmouseover="ContentPreview('label153');" onmouseout="ContentUnpreview('label153');" title="click to collapse or expand..."> more... </a> <div id="label153" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>comments</td> <td><code class="docutils literal notranslate">v7.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">cost</span> - Cost of the interface, value range from 0 to 65535, 0 means auto-cost. <span class="li-normal">type: int</span> <a id='label154' href="javascript:ContentClick('label155', 'label154');" onmouseover="ContentPreview('label155');" onmouseout="ContentUnpreview('label155');" title="click to collapse or expand..."> more... </a> <div id="label155" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>cost</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">database_filter_out</span> - Enable/disable control of flooding out LSAs. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label156' href="javascript:ContentClick('label157', 'label156');" onmouseover="ContentPreview('label157');" onmouseout="ContentUnpreview('label157');" title="click to collapse or expand..."> more... </a> <div id="label157" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>database_filter_out</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> </table> </div> </li> <li> <span class="li-head">dead_interval</span> - Dead interval. <span class="li-normal">type: int</span> <a id='label158' href="javascript:ContentClick('label159', 'label158');" onmouseover="ContentPreview('label159');" onmouseout="ContentUnpreview('label159');" title="click to collapse or expand..."> more... </a> <div id="label159" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>dead_interval</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">hello_interval</span> - Hello interval. <span class="li-normal">type: int</span> <a id='label160' href="javascript:ContentClick('label161', 'label160');" onmouseover="ContentPreview('label161');" onmouseout="ContentUnpreview('label161');" title="click to collapse or expand..."> more... </a> <div id="label161" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>hello_interval</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">hello_multiplier</span> - Number of hello packets within dead interval. <span class="li-normal">type: int</span> <a id='label162' href="javascript:ContentClick('label163', 'label162');" onmouseover="ContentPreview('label163');" onmouseout="ContentUnpreview('label163');" title="click to collapse or expand..."> more... </a> <div id="label163" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>hello_multiplier</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">interface</span> - Configuration interface name. Source system.interface.name. <span class="li-normal">type: str</span> <a id='label164' href="javascript:ContentClick('label165', 'label164');" onmouseover="ContentPreview('label165');" onmouseout="ContentUnpreview('label165');" title="click to collapse or expand..."> more... </a> <div id="label165" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>interface</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">ip</span> - IP address. <span class="li-normal">type: str</span> <a id='label166' href="javascript:ContentClick('label167', 'label166');" onmouseover="ContentPreview('label167');" onmouseout="ContentUnpreview('label167');" title="click to collapse or expand..."> more... </a> <div id="label167" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>ip</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">keychain</span> - Message-digest key-chain name. Source router.key-chain.name. <span class="li-normal">type: str</span> <a id='label168' href="javascript:ContentClick('label169', 'label168');" onmouseover="ContentPreview('label169');" onmouseout="ContentUnpreview('label169');" title="click to collapse or expand..."> more... </a> <div id="label169" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>keychain</td> <td><code class="docutils literal notranslate">v7.0.1 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">md5_key</span> - MD5 key. <span class="li-normal">type: str</span> <a id='label170' href="javascript:ContentClick('label171', 'label170');" onmouseover="ContentPreview('label171');" onmouseout="ContentUnpreview('label171');" title="click to collapse or expand..."> more... </a> <div id="label171" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>md5_key</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">md5_keychain</span> - Authentication MD5 key-chain name. Source router.key-chain.name. <span class="li-normal">type: str</span> <a id='label172' href="javascript:ContentClick('label173', 'label172');" onmouseover="ContentPreview('label173');" onmouseout="ContentUnpreview('label173');" title="click to collapse or expand..."> more... </a> <div id="label173" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>md5_keychain</td> <td><code class="docutils literal notranslate">v6.2.0 -> v7.0.0 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">md5_keys</span> - MD5 key. <span class="li-normal">type: list</span> <span style="font-family:'Courier New'" class="li-required">member_path: ospf_interface:name/md5_keys:id</span> <a id='label174' href="javascript:ContentClick('label175', 'label174');" onmouseover="ContentPreview('label175');" onmouseout="ContentUnpreview('label175');" title="click to collapse or expand..."> more... </a> <div id="label175" style="display:none"> <table border="1"> <tr> <td></td><td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>md5_keys</td> <td><code class="docutils literal notranslate">v6.2.0 -> latest </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">id</span> - Key ID (1 - 255). see <a href='#notes'>Notes</a>. <span class="li-normal">type: int</span> <span class="li-required">required: true</span> <a id='label176' href="javascript:ContentClick('label177', 'label176');" onmouseover="ContentPreview('label177');" onmouseout="ContentUnpreview('label177');" title="click to collapse or expand..."> more... </a> <div id="label177" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>id</td> <td><code class="docutils literal notranslate">v6.2.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">key_string</span> - Password for the key. <span class="li-normal">type: str</span> <a id='label178' href="javascript:ContentClick('label179', 'label178');" onmouseover="ContentPreview('label179');" onmouseout="ContentUnpreview('label179');" title="click to collapse or expand..."> more... </a> <div id="label179" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>key_string</td> <td><code class="docutils literal notranslate">v6.2.0 -> latest </code></td> </tr> </table> </div> </li> </ul> <li> <span class="li-head">mtu</span> - MTU for database description packets. <span class="li-normal">type: int</span> <a id='label180' href="javascript:ContentClick('label181', 'label180');" onmouseover="ContentPreview('label181');" onmouseout="ContentUnpreview('label181');" title="click to collapse or expand..."> more... </a> <div id="label181" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>mtu</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">mtu_ignore</span> - Enable/disable ignore MTU. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label182' href="javascript:ContentClick('label183', 'label182');" onmouseover="ContentPreview('label183');" onmouseout="ContentUnpreview('label183');" title="click to collapse or expand..."> more... </a> <div id="label183" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>mtu_ignore</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> </table> </div> </li> <li> <span class="li-head">name</span> - Interface entry name. <span class="li-normal">type: str</span> <span class="li-required">required: true</span> <a id='label184' href="javascript:ContentClick('label185', 'label184');" onmouseover="ContentPreview('label185');" onmouseout="ContentUnpreview('label185');" title="click to collapse or expand..."> more... </a> <div id="label185" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>name</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">network_type</span> - Network type. <span class="li-normal">type: str</span> <span class="li-normal">choices: broadcast, non-broadcast, point-to-point, point-to-multipoint, point-to-multipoint-non-broadcast</span> <a id='label186' href="javascript:ContentClick('label187', 'label186');" onmouseover="ContentPreview('label187');" onmouseout="ContentUnpreview('label187');" title="click to collapse or expand..."> more... </a> <div id="label187" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>network_type</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> <tr> <td>[broadcast]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> <tr> <td>[non-broadcast]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> <tr> <td>[point-to-point]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> <tr> <td>[point-to-multipoint]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> <tr> <td>[point-to-multipoint-non-broadcast]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> </table> </div> </li> <li> <span class="li-head">prefix_length</span> - Prefix length. <span class="li-normal">type: int</span> <a id='label188' href="javascript:ContentClick('label189', 'label188');" onmouseover="ContentPreview('label189');" onmouseout="ContentUnpreview('label189');" title="click to collapse or expand..."> more... </a> <div id="label189" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>prefix_length</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">priority</span> - Priority. <span class="li-normal">type: int</span> <a id='label190' href="javascript:ContentClick('label191', 'label190');" onmouseover="ContentPreview('label191');" onmouseout="ContentUnpreview('label191');" title="click to collapse or expand..."> more... </a> <div id="label191" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>priority</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">resync_timeout</span> - Graceful restart neighbor resynchronization timeout. <span class="li-normal">type: int</span> <a id='label192' href="javascript:ContentClick('label193', 'label192');" onmouseover="ContentPreview('label193');" onmouseout="ContentUnpreview('label193');" title="click to collapse or expand..."> more... </a> <div id="label193" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>resync_timeout</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">retransmit_interval</span> - Retransmit interval. <span class="li-normal">type: int</span> <a id='label194' href="javascript:ContentClick('label195', 'label194');" onmouseover="ContentPreview('label195');" onmouseout="ContentUnpreview('label195');" title="click to collapse or expand..."> more... </a> <div id="label195" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>retransmit_interval</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">status</span> - Enable/disable status. <span class="li-normal">type: str</span> <span class="li-normal">choices: disable, enable</span> <a id='label196' href="javascript:ContentClick('label197', 'label196');" onmouseover="ContentPreview('label197');" onmouseout="ContentUnpreview('label197');" title="click to collapse or expand..."> more... </a> <div id="label197" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>status</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> </table> </div> </li> <li> <span class="li-head">transmit_delay</span> - Transmit delay. <span class="li-normal">type: int</span> <a id='label198' href="javascript:ContentClick('label199', 'label198');" onmouseover="ContentPreview('label199');" onmouseout="ContentUnpreview('label199');" title="click to collapse or expand..."> more... </a> <div id="label199" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>transmit_delay</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> </ul> <li> <span class="li-head">passive_interface</span> - Passive interface configuration. <span class="li-normal">type: list</span> <span style="font-family:'Courier New'" class="li-required">member_path: passive_interface:name</span> <a id='label200' href="javascript:ContentClick('label201', 'label200');" onmouseover="ContentPreview('label201');" onmouseout="ContentUnpreview('label201');" title="click to collapse or expand..."> more... </a> <div id="label201" style="display:none"> <table border="1"> <tr> <td></td><td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>passive_interface</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">name</span> - Passive interface name. Source system.interface.name. <span class="li-normal">type: str</span> <span class="li-required">required: true</span> <a id='label202' href="javascript:ContentClick('label203', 'label202');" onmouseover="ContentPreview('label203');" onmouseout="ContentUnpreview('label203');" title="click to collapse or expand..."> more... </a> <div id="label203" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>name</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> </ul> <li> <span class="li-head">redistribute</span> - Redistribute configuration. <span class="li-normal">type: list</span> <span style="font-family:'Courier New'" class="li-required">member_path: redistribute:name</span> <a id='label204' href="javascript:ContentClick('label205', 'label204');" onmouseover="ContentPreview('label205');" onmouseout="ContentUnpreview('label205');" title="click to collapse or expand..."> more... </a> <div id="label205" style="display:none"> <table border="1"> <tr> <td></td><td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>redistribute</td> <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.2.0 -> v7.2.0 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">metric</span> - Redistribute metric setting. <span class="li-normal">type: int</span> <a id='label206' href="javascript:ContentClick('label207', 'label206');" onmouseover="ContentPreview('label207');" onmouseout="ContentUnpreview('label207');" title="click to collapse or expand..."> more... </a> <div id="label207" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>metric</td> <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.2.0 -> v7.2.0 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">metric_type</span> - Metric type. <span class="li-normal">type: str</span> <span class="li-normal">choices: 1, 2</span> <a id='label208' href="javascript:ContentClick('label209', 'label208');" onmouseover="ContentPreview('label209');" onmouseout="ContentUnpreview('label209');" title="click to collapse or expand..."> more... </a> <div id="label209" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>metric_type</td> <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.2.0 -> v7.2.0 </code></td> </tr> <tr> <td>[1]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> <tr> <td>[2]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> </table> </div> </li> <li> <span class="li-head">name</span> - Redistribute name. <span class="li-normal">type: str</span> <span class="li-required">required: true</span> <a id='label210' href="javascript:ContentClick('label211', 'label210');" onmouseover="ContentPreview('label211');" onmouseout="ContentUnpreview('label211');" title="click to collapse or expand..."> more... </a> <div id="label211" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>name</td> <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.2.0 -> v7.2.0 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">routemap</span> - Route map name. Source router.route-map.name. <span class="li-normal">type: str</span> <a id='label212' href="javascript:ContentClick('label213', 'label212');" onmouseover="ContentPreview('label213');" onmouseout="ContentUnpreview('label213');" title="click to collapse or expand..."> more... </a> <div id="label213" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>routemap</td> <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.2.0 -> v7.2.0 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">status</span> - Status. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label214' href="javascript:ContentClick('label215', 'label214');" onmouseover="ContentPreview('label215');" onmouseout="ContentUnpreview('label215');" title="click to collapse or expand..."> more... </a> <div id="label215" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>status</td> <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.2.0 -> v7.2.0 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> </table> </div> </li> <li> <span class="li-head">tag</span> - Tag value. <span class="li-normal">type: int</span> <a id='label216' href="javascript:ContentClick('label217', 'label216');" onmouseover="ContentPreview('label217');" onmouseout="ContentUnpreview('label217');" title="click to collapse or expand..."> more... </a> <div id="label217" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>tag</td> <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.2.0 -> v7.2.0 </code></td> </tr> </table> </div> </li> </ul> <li> <span class="li-head">restart_mode</span> - OSPF restart mode (graceful or LLS). <span class="li-normal">type: str</span> <span class="li-normal">choices: none, lls, graceful-restart</span> <a id='label218' href="javascript:ContentClick('label219', 'label218');" onmouseover="ContentPreview('label219');" onmouseout="ContentUnpreview('label219');" title="click to collapse or expand..."> more... </a> <div id="label219" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>restart_mode</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> <tr> <td>[none]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> <tr> <td>[lls]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> <tr> <td>[graceful-restart]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> </table> </div> </li> <li> <span class="li-head">restart_on_topology_change</span> - Enable/disable continuing graceful restart upon topology change. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label220' href="javascript:ContentClick('label221', 'label220');" onmouseover="ContentPreview('label221');" onmouseout="ContentUnpreview('label221');" title="click to collapse or expand..."> more... </a> <div id="label221" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>restart_on_topology_change</td> <td><code class="docutils literal notranslate">v7.2.0 -> latest </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> </table> </div> </li> <li> <span class="li-head">restart_period</span> - Graceful restart period. <span class="li-normal">type: int</span> <a id='label222' href="javascript:ContentClick('label223', 'label222');" onmouseover="ContentPreview('label223');" onmouseout="ContentUnpreview('label223');" title="click to collapse or expand..."> more... </a> <div id="label223" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>restart_period</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">rfc1583_compatible</span> - Enable/disable RFC1583 compatibility. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label224' href="javascript:ContentClick('label225', 'label224');" onmouseover="ContentPreview('label225');" onmouseout="ContentUnpreview('label225');" title="click to collapse or expand..."> more... </a> <div id="label225" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>rfc1583_compatible</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> </table> </div> </li> <li> <span class="li-head">router_id</span> - Router ID. <span class="li-normal">type: str</span> <a id='label226' href="javascript:ContentClick('label227', 'label226');" onmouseover="ContentPreview('label227');" onmouseout="ContentUnpreview('label227');" title="click to collapse or expand..."> more... </a> <div id="label227" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>router_id</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">spf_timers</span> - SPF calculation frequency. <span class="li-normal">type: str</span> <a id='label228' href="javascript:ContentClick('label229', 'label228');" onmouseover="ContentPreview('label229');" onmouseout="ContentUnpreview('label229');" title="click to collapse or expand..."> more... </a> <div id="label229" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>spf_timers</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">summary_address</span> - IP address summary configuration. <span class="li-normal">type: list</span> <span style="font-family:'Courier New'" class="li-required">member_path: summary_address:id</span> <a id='label230' href="javascript:ContentClick('label231', 'label230');" onmouseover="ContentPreview('label231');" onmouseout="ContentUnpreview('label231');" title="click to collapse or expand..."> more... </a> <div id="label231" style="display:none"> <table border="1"> <tr> <td></td><td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>summary_address</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">advertise</span> - Enable/disable advertise status. <span class="li-normal">type: str</span> <span class="li-normal">choices: disable, enable</span> <a id='label232' href="javascript:ContentClick('label233', 'label232');" onmouseover="ContentPreview('label233');" onmouseout="ContentUnpreview('label233');" title="click to collapse or expand..."> more... </a> <div id="label233" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>advertise</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest</code></td> </table> </div> </li> <li> <span class="li-head">id</span> - Summary address entry ID. see <a href='#notes'>Notes</a>. <span class="li-normal">type: int</span> <span class="li-required">required: true</span> <a id='label234' href="javascript:ContentClick('label235', 'label234');" onmouseover="ContentPreview('label235');" onmouseout="ContentUnpreview('label235');" title="click to collapse or expand..."> more... </a> <div id="label235" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>id</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">prefix</span> - Prefix. <span class="li-normal">type: str</span> <a id='label236' href="javascript:ContentClick('label237', 'label236');" onmouseover="ContentPreview('label237');" onmouseout="ContentUnpreview('label237');" title="click to collapse or expand..."> more... </a> <div id="label237" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>prefix</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> <li> <span class="li-head">tag</span> - Tag value. <span class="li-normal">type: int</span> <a id='label238' href="javascript:ContentClick('label239', 'label238');" onmouseover="ContentPreview('label239');" onmouseout="ContentUnpreview('label239');" title="click to collapse or expand..."> more... </a> <div id="label239" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>tag</td> <td><code class="docutils literal notranslate">v6.0.0 -> latest </code></td> </tr> </table> </div> </li> </ul> </ul> </ul>

Notes
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
```
- name: Configure OSPF.
  fortinet.fortios.fortios_router_ospf:
      vdom: "{{ vdom }}"
      router_ospf:
          abr_type: "cisco"
          area:
              -
                  authentication: "none"
                  comments: "<your_own_value>"
                  default_cost: "10"
                  filter_list:
                      -
                          direction: "in"
                          id: "10"
                          list: "<your_own_value> (source router.access-list.name router.prefix-list.name)"
                  id: "12"
                  nssa_default_information_originate: "enable"
                  nssa_default_information_originate_metric: "10"
                  nssa_default_information_originate_metric_type: "1"
                  nssa_redistribution: "enable"
                  nssa_translator_role: "candidate"
                  range:
                      -
                          advertise: "disable"
                          id: "20"
                          prefix: "<your_own_value>"
                          substitute: "<your_own_value>"
                          substitute_status: "enable"
                  shortcut: "disable"
                  stub_type: "no-summary"
                  type: "regular"
                  virtual_link:
                      -
                          authentication: "none"
                          authentication_key: "<your_own_value>"
                          dead_interval: "40"
                          hello_interval: "10"
                          keychain: "<your_own_value> (source router.key-chain.name)"
                          md5_key: "<your_own_value>"
                          md5_keychain: "<your_own_value> (source router.key-chain.name)"
                          md5_keys:
                              -
                                  id: "36"
                                  key_string: "<your_own_value>"
                          name: "default_name_38"
                          peer: "<your_own_value>"
                          retransmit_interval: "5"
                          transmit_delay: "1"
          auto_cost_ref_bandwidth: "1000"
          bfd: "enable"
          database_overflow: "enable"
          database_overflow_max_lsas: "10000"
          database_overflow_time_to_recover: "300"
          default_information_metric: "10"
          default_information_metric_type: "1"
          default_information_originate: "enable"
          default_information_route_map: "<your_own_value> (source router.route-map.name)"
          default_metric: "10"
          distance: "110"
          distance_external: "110"
          distance_inter_area: "110"
          distance_intra_area: "110"
          distribute_list:
              -
                  access_list: "<your_own_value> (source router.access-list.name)"
                  id: "58"
                  protocol: "connected"
          distribute_list_in: "<your_own_value> (source router.access-list.name router.prefix-list.name)"
          distribute_route_map_in: "<your_own_value> (source router.route-map.name)"
          log_neighbour_changes: "enable"
          neighbor:
              -
                  cost: "0"
                  id: "65"
                  ip: "<your_own_value>"
                  poll_interval: "10"
                  priority: "1"
          network:
              -
                  area: "<your_own_value>"
                  comments: "<your_own_value>"
                  id: "72"
                  prefix: "<your_own_value>"
          ospf_interface:
              -
                  authentication: "none"
                  authentication_key: "<your_own_value>"
                  bfd: "global"
                  comments: "<your_own_value>"
                  cost: "0"
                  database_filter_out: "enable"
                  dead_interval: "0"
                  hello_interval: "0"
                  hello_multiplier: "0"
                  interface: "<your_own_value> (source system.interface.name)"
                  ip: "<your_own_value>"
                  keychain: "<your_own_value> (source router.key-chain.name)"
                  md5_key: "<your_own_value>"
                  md5_keychain: "<your_own_value> (source router.key-chain.name)"
                  md5_keys:
                      -
                          id: "90"
                          key_string: "<your_own_value>"
                  mtu: "0"
                  mtu_ignore: "enable"
                  name: "default_name_94"
                  network_type: "broadcast"
                  prefix_length: "0"
                  priority: "1"
                  resync_timeout: "40"
                  retransmit_interval: "5"
                  status: "disable"
                  transmit_delay: "1"
          passive_interface:
              -
                  name: "default_name_103 (source system.interface.name)"
          redistribute:
              -
                  metric: "0"
                  metric_type: "1"
                  name: "default_name_107"
                  routemap: "<your_own_value> (source router.route-map.name)"
                  status: "enable"
                  tag: "0"
          restart_mode: "none"
          restart_on_topology_change: "enable"
          restart_period: "120"
          rfc1583_compatible: "enable"
          router_id: "<your_own_value>"
          spf_timers: "<your_own_value>"
          summary_address:
              -
                  advertise: "disable"
                  id: "119"
                  prefix: "<your_own_value>"
                  tag: "0"
```
Return Values

Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3
Status
- This module is not guaranteed to have a backwards compatible interface.
Authors
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
Hint

If you notice any issues in this documentation, you can create a pull request to improve it.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fortios_router_ospf.rst

fortios_router_ospf.rst

fortios_router_ospf -- Configure OSPF in Fortinet's FortiOS and FortiGate.

Synopsis

Requirements

Tips

FortiOS Version Compatibility

Parameters

Notes

Examples

Return Values

Status

Authors

Files

fortios_router_ospf.rst

Latest commit

History

fortios_router_ospf.rst

File metadata and controls

fortios_router_ospf -- Configure OSPF in Fortinet's FortiOS and FortiGate.

Synopsis

Requirements

Tips

FortiOS Version Compatibility

Parameters

Notes

Examples

Return Values

Status

Authors