======
OSPFv3
======

.. sidebar:: Contents

  .. contents::
      :depth: 2
      :local:


This chapter covers some aspects related to the :osdx:cfg:`protocols ospfv3` which is a feature that allows users to **manage and monitor** the OSPFv3 protocol.

OSPF (Open Shortest Path First) version 3 for IPv6 protocol is a routing protocol described in RFC 2740.

Configuration
=============

The OSPFv3 protocol can be configured either using :osdx:cfg:`protocols ospfv3` or in an interface using , `interfaces <type> <txt> ipv6 ospfv3`, for example,
:osdx:cfg:`interfaces dummy * ipv6 ospfv3` or :osdx:cfg:`interfaces ethernet * ipv6 ospfv3`.

In OSDx, the OSPFv3 configuration allows various parameters to be set to fine-tune the protocol's behavior.

An explanation of each configurable parameter in :osdx:cfg:`protocols ospfv3` configuration is provided below:

* ``area``: Summarize a group of internal subnets into a single Inter-Area-Prefix LSA. This command can only be used at the area boundary router (ABR).

  * ``export-list``: Networks announced to other areas. 
    
  * ``import-list``: Networks from other areas announced to the specified one.

  * ``range``: It summarizes routes matching prefix (border routers only). This parameter includes ``advertise`` and ``not-advertise``. 

* ``auto-cost``: Calculate OSPFv3 interface cost according to bandwidth.

  * ``reference-bandwidth``: Reference bandwidth method to assign OSPFv3 cost in Mbits/sec.

* ``default-information``: Control distribution of default information.

  * ``originate``: Distribute a default route. This parameter includes ``always``, to always advertise default route; ``metric``, default metric; ``metric-type``, metric type for default routes; 
    and ``route-map``, route map reference.

* ``log-adjacency-changes``: Allows log changes in adjacency state. With the optional argument ``detail``, all adjacency state changes are displayed, without it, only full changes or regressions are 
  shown.

* ``paremeters``: OSPFv3 specific parameters. Includes the argument ``router-id``.

* ``redistribute``: Redistribute information from another routing protocol. This parameter includes the following arguments: ``bgp``, ``connected``, ``kernel``, ``ripng`` and ``static``. These five 
  arguments include ``metric``, the metric for redistributed routes; ``metric-type``, OSPFv3 metric type; and ``route-map``, a route map reference.

* ``route-map``: Filter routes installed in local route map.

An explanation of each configurable parameter of OSPFv3 in an interface configuration is provided below:

* ``area``: Summarize a group of internal subnets into a single Inter-Area-Prefix LSA.

* ``authentication``: OSPFv3 interface authentication. Includes ``md5`` and ``hmac-sha-256``, each of them with their password.

* ``bfd``: Enables Bidirectional Forwarding Detection on an interface. Includes the optional argument ``profile``.

* ``cost``: Specifies an interface cost.

* ``dead-interval``: Interval after which neighbor is dead.

* ``hello-interval``: Interval between hello packets.

* ``ifmtu``: Interface MTU value.

* ``instance-id``: Instance identifier.

* ``mtu-ignore``: Disables Maximum Transmission Unit (MTU) mismatch detection.

* ``network``: Specifies network type: ``broadcast``, or ``point-to-point``.

* ``passive``: Disables forming of adjacency.

* ``priority``: Router priority.

* ``retransmit-interval``: Interval between retransmitting lost link state advertisements.

* ``transmit-delay``: Link state transmit delay in seconds.

Monitoring
==========

To monitor the status and configuration of OSPFv3 protocol, you can use the following commands:

* :osdx:op:`protocols ospfv3 show` to monitor OSPFv3 protocol. 


.. _ospfv3_examples:

Examples
========

:doc:`Here </examples/protocols/ospfv3/index>` you can find examples related to OSPFv3.

Command Summary
===============

.. osdx:cmdtree:: cfg

    protocols ospfv3 
    interfaces bridge * ipv6 ospfv3 
    interfaces bridge * vif * ipv6 ospfv3 
    interfaces dummy * ipv6 ospfv3 
    interfaces ethernet * ipv6 ospfv3 
    interfaces ethernet * vif * ipv6 ospfv3
    interfaces openvpn * ipv6 ospfv3 
    interfaces tunnel * ipv6 ospfv3 
    interfaces vxlan * ipv6 ospfv3 
    interfaces wlan * ipv6 ospfv3

.. osdx:cmdtree:: op

    protocols ospfv3 show