========
Overview
========

Interfaces are points of interaction between different system components and are also used to communicate with external devices.
Regardless of the specific OSDx interface you're using, you will be able to access, use, and configure it in a similar manner.
This provides a consistent user experience and makes learning and using the system easier.

This section contains articles on how to manage and configure available interfaces on an OSDx system.

Common configuration for all interfaces
=======================================

Most OSDx interfaces share common configurations. These are listed below:

  * ``address``: Set the **IP address** for the interface.
  * ``alarm``: Enable or disable an alarm according to the **link state**.
  * ``bridge-group``: Add this interface to a **bridge** group.

    - ``bridge``: Bridge group name.
    - ``isolate``: Isolate port. This port will only be able to communicate with ports that are not marked as isolated.
    - ``stp``: Bridge port for Spanning Tree Protocol configuration.
    - ``allowed-macs``: Allowed Macs list (only for switch ports).
    - ``vlan``: Enable VLAN in the bridge port.

  * ``bond-group``: Add this interface to a **bonding** group. Bonding allows multiple physical network interfaces
    to be combined into a single logical interface, which can enhance network performance and reliability.

  * ``description``: Description of the interface.
  * ``dhcp``: Dynamic Host Configuration Protocol configuration.
  * ``dhcpv6``: Dynamic Host Configuration Protocol IPv6 configuration.
  * ``disable``: Disable interface (set the interface state to *DOWN*).
  * ``flow``: Activate **netflow** on the interface.

    - ``egress``: Active output traffic.
    - ``ingress``: Active input traffic.

  * ``ip``: **IPv4** routing parameters.

    - ``arp``: IPv4 ARP options.
    - ``igmp``: Internet Group Management Protocol (IGMP) parameters.
    - ``pim``: Protocol Independent Multicast (PIM) parameters.
    - ``multicast``: Multicast parameters.
    - ``ospf``: Open Shortest Path First (OSPF) parameters.
    - ``rip``: Routing Information Protocol (RIP) parameters.
    - ``reverse-path-filter``: Source validation via reversed path, as specified in RFC3704.

  * ``ipv6``: **IPv6** routing parameters.
  * ``tcp-mss``: Change tcp-mss value.
  * ``traffic``: **Traffic processing** options.

    - ``zone``: Traffic zone associated with this interface.
    - ``nat``: Network Address Translation (NAT) parameters.
    - ``control``: Traffic control for the interface.
    - ``policy``: Traffic policy rulesets for the interface.

      + ``in``: Input traffic policy ruleset for the interface.
      + ``link``: Link layer traffic policy ruleset for the interface.
      + ``local-in``: Local input traffic policy ruleset for the interface.
      + ``local-out``: Local output traffic policy ruleset for the interface.
      + ``out``: Output traffic policy ruleset for the interface.

  * ``vrf``: Virtual Routing and Forwarding domain name. Can **not** be used together with ``bridge-group`` or ``bond-group``.
  * ``vif``: Virtual Local Area Network (VLAN) **ID**.

    - ``ethertype``: Set VLAN protocol.
    - ``vif-c``: QinQ TAG-C Virtual Local Area Network (VLAN) ID.

  * ``vrrp``: Virtual Router Redundancy Protocol.
  * ``fdb``: Manage the interface's **Forwarding DataBase**.
  * ``disable-offload``: Disable **offload engine** in this interface
  * ``mac``: Media Access Control (MAC) address.
  * ``mtu``: Set the Maximum Transmission Unit (MTU).

Documentation
=======================================

To learn more about the various interfaces available in OSDx, please refer to the articles associated with each interface:

.. toctree::
    :titlesonly:
    :glob:

    */index