The Network Menu¶
In this page you find:
The network menu can be used to tweak the networking configuration by adding specific hosts and routes, configuring uplinks, and adding VLANs and bonding devices.
The sub-menu on the left-hand side of the screen contains these items, each of which groups several configuration options:
Hosts–define hosts for local domain name resolution.
Routing–set up static routes and policy routing.
Zones and Interfaces–edit the uplinks or create VLANs.
Uplinks– manage additional uplinks.
Hosts¶
On top of the page appears the table of Custom hosts, i.e., user-defined, which is right above the table showing the Hosts for system services. The former table contains host entries defined by the administrators, while the latter shows hosts that are automatically added by the Connect Switchboard when some services, like e.g., the HTTP or SMTP proxy, are enabled, since they are required to operate correctly.
The two tables share the same structure and content: Each entry contains an IP address, the associated hostname, and the domain name, if specified. The only difference is that the Hosts for system services table does not contain any Actions: Because these entries are needed by the system, they can not be edited, therefore the three available actions are available only in the first table.
Custom hosts
A new entry in the file can be added by clicking on the Add new host button right above the table.
Hint
New entries will be added to the /etc/hosts
file, so
do not edit that file manually, because changes to that file will
be overwritten whenever new hosts are added from the GUI or the
networking service is restarted.
A simple form will replace the table, in which to enter the following options:
- IP address
The IP address of the remote host.
- Hostname
The hostname associated to the IP address.
- Domain name
An optional domain name. If not supplied, the default domain name of the Connect Switchboard will be used.
Hint
The domain name is displayed in the Hosts for system services table below and can be retrieved from the CLI by using the hostname -d command.
- Remark
An optional description of the host.
- Enabled
Tick the checkbox to enable the host. If not enabled, it can not be used.
Note
Unlike in standard Linux systems, in the /etc/hosts
file (see below), each IP address corresponds to one hostname and
vice-versa. To associate more hostnames to the same IP address,
repeat the procedure by inserting the same IP address but a
different name.
The choice can be confirmed by clicking on the Add button, then a click on the Apply button in the green callout will reload the daemon with the new host.
Hosts for system services
At the bottom of the page, a table shows also those host that are automatically created by system services, which must be defined for a service to work correctly and can not be modified manually.
Hosts management, dnsmasq and /etc/hosts
.
The dnsmasq application is used in small networks as DNS server for local hosts and as a DNS forwarder and caching server for worldwide DNS servers. The Connect Switchboard uses dnsmasq to be able to correctly resolve and answer DNS requests coming from the GREEN, ORANGE, and BLUE zones. It is sometimes desirable (e.g., for testing purposes on a remote website) to override some entries in dnsmasq, or to add some local server to dnsmasq’s cache, for local clients to be able to connect to it.
Both custom and system hosts listed in this page are stored in the
/etc/hosts
file at every restart of the daemon. Host added
to that files directly via CLI will not persist after a reboot of
the Connect Switchboard or a restart of dnsmasq.
The /etc/hosts
file contains the so-called static lookup
table, in the form:
IP1 hostname1 [hostname2]
IP2 hostname3 [hostname4] [hostname5]
Here, IP1 and IP2 are unique (numerical) IP addresses and
hostname1, hostname2, hostname3, hostname4, and hostname5
are custom names given to those IPs. Names within square brackets
are optional: In other words, each IP address can be associated
with one or more names of known hosts. Custom host entries can be
added to the file, that will then be resolved for all the clients
connecting through the Connect Switchboard. On a typical Connect Switchboard, the
/etc/hosts
file contains at least the following entries:
127.0.0.1 localhost.localhost localhost
172.20.0.21 myappliance.localdomain myappliance
Here, 127.0.0.1 is the IP address of the loopback device, called localhost, which is a mandatory entry for the correct working of any Linux system; while 172.20.0.21 is the IP address of the GREEN interface.
Routing¶
Besides the default routing table, that can be seen in Menubar ‣ Status ‣ Network status, the routing on the Connect Switchboard can be improved with custom routing rules. This page displays a unique table that contains all the custom rules added.
Note
When defining policy routing rules, the order of the rules is important. Rules in the table are evaluated from top to bottom and as soon as a rule is matched, traffic is routed according to that rule. No further evaluation is made on the remaining rules.
Whenever a change is carried out on the routing table, it is required that the changes be saved and the service be restarted.
Current routing rules
When clicking on the Add new route button, the rule editor will open, in which the setup of the rule is guided by several drop-down menus.
Routing rule editor
The following options are available:
Source
- Type
The first drop-down menu allows to choose the source of the traffic. More entries, one per line, are accepted, but all must belong to the same type, either: A zone or interface, OpenVPN or L2TP users, IPs or networks, or MAC addresses. To apply the rule to all sources, select <ANY>.
Depending on the choice, additional options appear below in form of drop-down menus or textboxes, allowing to supply the necessary values.
Destination
- Type
The second drop-down menu permits the choice of the destination of the traffic, in form of a list of IP or networks, OpenVPN or L2TP users. Again, by selecting <ANY> the rule will match every destination.
Service/Port
- Service
The service that the rule should match.
Hint
User defined permits to specify a custom protocol and the ports to block, an option that proves useful when running services on ports different from the standard ones.
- Protocol
The type of traffic that is interested by the rule: TCP, UDP, TCP+UDP, ESP, GRE, and ICMP. TCP and UDP are the most used, GRE is used by tunnels, ESP by IPsec, and ICMP by the ping and traceroute commands.
- Destination port
The destination port for the rule.
Note
There exist dozens predefined services that can be chosen from the drop-down menus and should suffice to cover the most use cases. An user defined combination of port and protocol should be used only if a service is not running on a standard port (e.g., the SSH server listens to port 2345 or the web server runs on port 7981) or if a service, not included in the list, is using a particular port.
Route Via
Decide how the traffic should be routed for this rule. The following options are available:
- Static gateway
An IP Address through which the traffic matching the rule will be sent.
Hint
Use this option to set up a static route. See below an explanation of static routing.
- Uplink
The uplink that should be used for this rule. There is the option, when the uplink becomes unavailable, that the routing be carried over to the backup link corresponding to the selected uplink. This option is enabled when the checkbox next to the drop-down menu is ticked.
- OpenVPN user
An OpenVPN user, chosen from those available in the drop-down menu.
- L2TP user
An L2TP user, chosen from those available in the drop-down menu.
- OpenVPN client (gw2gw)
The traffic matching the rule will be sent through a VPN tunnel acting as an OpenVPN client connecting to an OpenVPN server.
- Type Of Service
The type of service (TOS) can be chosen here. Four values can be chosen, depending on what is the most important characteristic of the traffic interested by that rule: default, lowdelay, reliability, or throughput.
- Remark
A remark or comment to explain the purpose of this rule.
- Position
The position in which to insert the rule (relative position in the list of rules).
- Enabled
Tick this checkbox to enable the rule (default). If unchecked, the rule is created but not active: A rule can be enabled later.
- Log all accepted packets
This checkbox must be ticked to log all the packets affected by this rule.
Warning
The activation of this option may cause the size of the log files to dramatically improve.
A click on the Add Rule button will save the rule, to activate it and reload all the routing entries, click on the Apply button in the green callout.
Static routing rules.
Policy routing rules and static routing rules appeared in distinct pages in previous version on Endian product and unified with the 6.0. The main difference between static and policy routing is that the former routes all the traffic from a source network or to a destination network through a (static) gateway, while the latter provides more choices to define sources and destinations of traffic, and type of gateway. Moreover, additional option allow to select the service that creates the traffic and the TOS.
While in version 6.0 there is no static routing anymore, to define a static policy routing rules, select in the ROUTE VIA section the option Static gateway and provide the IP address of the gateway.
See also
There is a tutorial to set up basic policy routes available here.
Zones and Interfaces¶
In this page it is possible to configure network interfaces and set up VLANs and bonding devices, each organised in a table.
Zones
This table contains the three zones available on the Connect Switchboard and their configuration: IP subnet, NIC assigned to each of them. Unconfigured zones are marked as Disabled.
When clicking on the edit icon in the Actions column, the zone editor opens and it will be possible to edit the settings, by changing the following options.
Zone Editor
- Enabled | Disabled
Click on the switch to change the status of the zone.
Note
This switch is not available for the green zone, because that zone is a mandatory requirement for the Connect Switchboard to work properly.
- IP/CIDR addresses
Add in the textbox new IP and subnets assigned to the zone, in CIDR format.
- Select interfaces
Choose from the drop-down menu which interfaces will serve the zone.
Hint
To remove an interface, click on the x next to the selected interface.
When done, click on Update zone to save the new configuration, then on Apply to enable it.
VLANs
The idea behind offering VLAN support in Connect Switchboard is to allow arbitrary associations of VLAN IDs to the zones and to provide an additional level of separation (and therefore another level of security) between the zones. The existing VLANS are shown in the table, if any had already been created.
A new VLAN can be defined by clicking on the Add new VLAN button above the VLAN list.
Add new VLAN
In the VLAN editor, a few click suffice to create a VLAN on an interface, by configuring the options:
- Interface
The physical interface to which the VLAN is connected to. Only the available interfaces can be chosen from the drop-down menu. The menu also shows the status of the link of the interface.
Warning
It is not possible to define a VLAN that serves one zone (e.g., a VLAN on BLUE) on an interface that already serves another zone (e.g., eth1 serving GREEN). When trying to do so, the form closes and a red callout appears, informing that the VLAN can not be created.
- VLAN ID
The VLAN ID, which must be an integer number between 0 and 4095.
- Zone
The zone to which the VLAN is associated with. Only the zones that have been defined in the network configuration wizard can be selected. The option “NONE” can be chosen, if that interface is used as a High Availability management port.
Note
It will not be possible to define a VLAN on interfaces that are already assigned to a zone, VLAN, or uplink.
Whenever a virtual LAN is created, a new interface is created and
named as ethX.y
where X
is the number of the
interface and y
is the VLAN ID. This interface is then
assigned to the chosen zone and will show up as a regular interface in
the various sections that report network information, like
Menubar ‣ Status ‣ Network Configuration or in
the Dashboard, where it can be selected to be drawn in the graph.
Bonding devices
Network bonding is a technique that allows to combine two or more network interfaces in a single bond and act as a single connection, with the main advantage to increase the throughput and the data flow.
New bonding devices can be added by clicking on the Add new bonding button.
Bonding device editor
The following options are available to configure a new bonding device.
- Name
Choose from the drop-down menu the name of the bonding device.
- Select interface
Select at least two interfaces that will be part of the new bond among those available
Note
Interfaces that are already in use–in VLANs, as uplink, or serving a zone–can not be part of bonding device and are therefore are not available.
Uplinks¶
By default, the uplink editor shows the available uplinks that have been created, with the following information for each: The unique ID, a Description, the Type, the Backup uplink–if defined, or the None label–and the available Actions.
Note
The main uplink can not be deleted.
Uplinks
Additional uplinks can be defined by clicking on the Add new uplink button on the table’s top right corner. In the panel that will open, the available option will depend on the type of uplink chosen. If the Uplink type is Ethernet DHCP or Ethernet Static, most of the option are the same found in the Configuration Wizard and are described in sections Internet Connection and following, while the additional options are described here. Moreover, it is also possible to configure a Mobile broadband or Wi-Fi uplink types.
Add new uplink
Note
The box is called Edit uplink when an existent uplink is being modified.
- Uplink type
Select from the drop-down menu which is the uplink to configure. Many types are the same as those seen in the Internet Connection section of the Configuration Wizard.
Mobile Broadband (3G/4G)
Wi-Fi
Ethernet
PPPoE
The RED interface is using a mobile 3G or 4G modem to establish the connection. The modem can either come shipped with the appliance as an internal modem or be connected to a USB port.
Note
To configure this uplink type, the SIM card must be plugged in before the Connect Switchboard is turned on.
- Modem
Select from the drop-down menu the type of modem to be used for the uplink.
- Technology
Choose from the drop-down menu the technology used by the modem.
- IMEI
The IMEI code associated with the modem. This is an informative field.
- Status
The status of the modem.
Hint
If no modem is plugged in in the Connect Switchboard, the message Failed (Sim Missing) will appear.
- Country
Select from the drop-down menu the country where the SIM card was bought.
- Provider
Select from the drop-down menu the provider of the mobile connection.
Hint
This menu is populated after the choice of the Country.
- Access Point
Select from the drop-down menu the type of access point to be used.
Hint
This menu is populated after the choice of the Provider.
Manual setup
In this panel it is possible to configure the authentication for the mobile broadband connection, by filling in the following options.
- APN
The Access Point Name, i.e., the name used to connect to the mobile provider.
- Username
The username used to authenticate.
- Password
The password used to authenticate.
- Authentication
Choose from the drop-down menu which type of authentication is required.
- Primary DNS (Optional)
The primary DNS used for this connection.
- Secondary DNS (Optional)
The secondary DNS of this connection, used if the first one fails.
The uplink connects to a Wireless Network.
Right after the choice of the Wi-Fi uplink, a number of buttons will populate the page, each containing the name of a wireless connection that hass been detected by the Connect Switchboard and its security level (i.e., WPA2, OPEN or if it is a HIDDEN network. To select and configure a wireless network, click on it. The list of networks will be replaced by a couple of options to configure the selected network.
- Back to network selection
Click on this link to go back to the list of networks.
- Password
Write in the textfield the password needed to access the network.
Stations
This informative box shows several information about the access point to which the Connect Switchboard is connected.
Static IP
Configure a static IP address if needed.
- IP Address
The static IP address assigned to the Connect Switchboard.
- Subnet
The subnet of the assigned IP.
- Add more
Click on this button to add another static IP address.
- Gateway
The gateway used by the Connect Switchboard, needed to access external networks.
- Primary DNS
Write in the textfield the IP address of the primay DNS server
- Secondary DNS
Optionally write in the textfield the IP address of the secondary DNS server, used when the primary is not available.
Below the list of networks, two other buttons appear:
- Add hidden network
If the desired network is hidden, it does not appear on the list. By clicking on this button it is possible to configure it, by providing the SSID name and the Security.
- Rescan
Click on this button to update the list of networks.
The options for this uplink type can be found in the configuration wizard:
Internet Connection: DHCP when the Connect Switchboard receives the IP address from a DHCP server
Internet Connection: Static to configure a fixed IP address
Configure the PPPoE connection. Click on one of the available ETH ports to assign it to the uplink, then fill in the other option, if necessary.
- Username
The username needed to authenticate.
- Password
The password that corresponds to the username.
- Authentication
Select from the drop down menu whether to use PAP, CHAP, or both methods should be used to authenticate.
Hint
If unsure whether to select PAP or CHAP authentication, keep the default option.
Manual DNS
This panel allows to specify custom DNS servers, that override those sent by the upstream DHCP server.
- Primary DNS
Write in the textfield the IP address of the primay DNS server
- Secondary DNS
Optionally write in the textfield the IP address of the secondary DNS server, used when the primary is not available.
Advanced settings
These settings are usually not necessary and need to be filled in only if the ISP supplies them.
- Concentrator name
The concentrator name.
- Service name
The service name.
- MAC Address
A custom MAC address, different from the uplink’s physical one.
- MTU
The MTU size, if different from the default value of 1500 bits.
- Description
A description of the uplink.
Depending on the uplink type chosen, an additional box may appear, to set custom DNS.
Custom DNS settings
- Primary DNS
Write in the textfield the IP address of the primay DNS server
- Secondary DNS
Optionally write in the textfield the IP address of the secondary DNS server, used when the primary is not available.
- Uplink is enabled
Tick this checkbox to enable the uplink.
- Activate uplink on boot
This checkbox specifies whether an uplink should be enabled at boot time or not. This option proves useful for backup uplinks which are managed but do not need to be started during the boot procedure.
- Uplink is automatically managed by system
Tick this checkbox for the uplink to be managed. See the Uplink Information Plugin under Menubar ‣ System ‣ Dashboard for a discussion about managed and manual modes.
- Disable signature updates if uplink is online
Tick this checkbox to disable the download of newer signatures whenever this uplink is enabled. This can prove useful for mobile or satellite connection with high data rates.
Note
Disabling signature download might result in security issues, since newer threats might not be recognised.
Advanced Settings
In the advanced settings panel, a few other options can be customised:
- Use custom MAC address
Tick the checkbox if the MAC address of the network interface associated to the uplink must be customised.
Note
this option is not available for Mobile Broadband (3G/4G) uplinks.
- Reconnection timeout
The time interval (in seconds) after which an uplink tries to reconnect if it fails. This value depends on the provider’s settings. If unsure, leave this field empty.
- MTU
A custom value for the MTU size. See here for a discussion about the reasons to modify the default value.
Backup settings
- If this uplink fails activate
If enabled, an alternative connection can be chosen from a drop-down menu, which will be activated when this uplink fails.
- Check if these hosts are reachable
Tick this option to enter a list of IP or host names that will be ping-ed when the uplink fails, to check whether it has reconnected.
- Add more
Click on this button to add more hosts to be checked.
Hint
One of those hosts could be the provider’s DNS server or gateway.
Once the new uplink connection has been configured, click on Add uplink to complete the procedure and save the settings.