=======
Routes
=======

Routes specify public IP subnets handled by the customer's firewall. For
example, if the customer needed public IP addresses for up to 14 hosts
behind their firewall, you might provide a /30 connected IP for
connectivity between the bonder and the customer's router and then add a
route to send a /28 subnet to customer's router.

For example, you could configure a connected IP 203.1.113.1/30 and give
203.1.113.2 to the customer's firewall. Then you could create a route
203.1.113.16/28 that sends that subnet to the customer's firewall via
its 203.1.113.2. address.

Adding, editing, & deleting routes
------------------------------------------------------------------------------------------------------------------------

Routes are displayed in a table on the bond details page.

To add a route, click the |node-object-add| button to the upper-left of the routes table. This will open the "add route" modal.

To edit a route, click the |node-object-edit| button on the route action toolbar. This will open the "edit route" modal.

To delete a route, click the |node-object-delete| button on the route action toolbar. This will ask for confirmation, and is permanent.

Configuring Routes
------------------------------------------------------------------------------------------------------------------------

Network
^^^^^^^^

The network address to route. Routes can be either public or private.
Public routes must be within a network allocated to the bond's space.
Private routes do not need an allocation.

Gateway
^^^^^^^^^^^^^^^^^^^^

The IP address of the customer's router. It must be in the network of
one of the bond's connected IPs.

Interface
^^^^^^^^^^^^

The `interface <../interfaces.html>`__ on the bonder where the customer's network is connected.

Defaults to 'Auto' which attempts to pick the correct interface based on the gateway IP and existing connected IP networks.

Enabled
^^^^^^^^

When checked, loads the route on the bonder and aggregator.

Include in private WAN
^^^^^^^^^^^^^^^^^^^^^^^

When the private WAN (PWAN) option of the bond's space is enabled, this
option controls whether or not traffic from this route is included in
the PWAN routing. If enabled, traffic is sent to and received from the
PWAN space. If disabled, traffic is not sent to the PWAN space, but is
routed directly to the partner's core network as if the bond's space did
not use PWAN.

This option has no effect when the bond is in a space with PWAN
disabled.

Disabled by default.

.. note::
    The default setting for this option has changed from enabled to disabled as of version 6.4.

Aggregator routing
^^^^^^^^^^^^^^^^^^^

This option allows the aggregator's routing mode to be overridden. The
options are:

-  Automatic (default): When the network is public, a route is created
   from the aggregator to the bonder. When it is private, no route is
   created.
-  Always: A route for the network is created on the aggregator, even if
   the network is private.
-  Never: A route for the network is *never* created, even if the
   network is public.

.. |node-object-add| image:: /attachments/bonds/node-object-add.png
.. |node-object-edit| image:: /attachments/bonds/node-object-edit.png
.. |node-object-delete| image:: /attachments/bonds/node-object-delete.png
