Skip to content

Commit

Permalink
review edits
Browse files Browse the repository at this point in the history
  • Loading branch information
DjP-iX committed Apr 2, 2024
1 parent 3bfaa1f commit 09a753b
Show file tree
Hide file tree
Showing 7 changed files with 38 additions and 38 deletions.
Expand Up @@ -28,30 +28,28 @@ Leave the **DHCP** checkbox clear.
Click **Add** to the right of **Aliases**, near the bottom of the **Add Interface** screen and enter a static IP address for the interface.
{{< /hint>}}

Click **Add** on the **Interfaces** widget to display the **Add Interface** panel.

You must specify the type of interface you want to create.
Select the type of interface from the **Type** dropdown options: **Bridge**, **Link Aggregation** or LAGG, and **VLAN** or virtual LAN.
You cannot edit the interface type after you click **Save**.
You cannot edit the interface type after you click **Save**.

Each interface type displays new fields on the **Add Interface** panel.
Links with more information on adding these specific types of interfaces are at the bottom of this article.

## Editing an Interface
Click on an existing interface in the **Interfaces** widget then click on the **Edit** icon to open the **Edit Interface** screen.
Click on an existing interface in the **Interfaces** widget then click on the **Edit** icon to open the **Edit Interface** screen.
The **Edit Interface** and **Add Interface** settings are identical except for **Type** and **Name**.
You cannot edit these settings after you click **Save**.
**Name** shows on the **Edit Interface** screen but you cannot change the name.
**Name** shows on the **Edit Interface** screen, but you cannot change the name.
**Type** only shows on the **Add Interface** screen.
If you make a mistake with either field you can only delete the interface and create a new one with the desired type.
If you make a mistake with either field you can only delete the interface and create a new one with the desired type.

If you want to change from DHCP to a static IP, you must also add the new default gateway and DNS nameservers that work with the new IP address.
See [Setting Up a Static IP]({{< relref "SettingUpStaticIPs.md" >}}) for more information.

{{< hint type=warning >}}
If you delete the primary network interface you can lose your TrueNAS connection and the ability to communicate with the TrueNAS through the web interface!

You might need command line knowledge or physical access to the TrueNAS system to fix misconfigured network settings.
You might need command line knowledge or physical access to the TrueNAS system to fix misconfigured network settings.
{{< /hint >}}

## Deleting an Interface
Expand All @@ -62,15 +60,15 @@ A delete interface confirmation dialog opens.
Do not delete the primary network interface!

If you delete the primary network interface you lose your TrueNAS connection and the ability to communicate with the TrueNAS through the web interface!
You might need command line knowledge or physical access to the TrueNAS system to fix misconfigured network settings.
You might need command line knowledge or physical access to the TrueNAS system to fix misconfigured network settings.
{{< /hint >}}

## Adding Alias IP Addresses
{{< include file="/static/includes/MultipleInterfacesOnNetwork.md" >}}

To configure alias IPs to provide access to internal portions of the network, go to the **Network** screen:

1. Click on the **Edit** icon for the interface to open the **Edit Interface** screen for the selected interface.
1. Click on the **Edit** icon for the interface to open the **Edit Interface** screen for the selected interface.

{{< trueimage src="/images/SCALE/Network/EditInterfaceNicDeviceSCALE.png" alt="Add Alias" id="Add Alias" >}}

Expand Down
24 changes: 12 additions & 12 deletions content/SCALE/SCALETutorials/Network/Interfaces/SettingUpLAGG.md
Expand Up @@ -7,15 +7,15 @@ tags:
- interfaces
---

In general, a [link aggregation (LAGG)](https://tools.ietf.org/html/rfc7424) is a method of combining (aggregating) multiple network connections in parallel to provide additional bandwidth or redundancy for critical networking situations.
In general, a [link aggregation (LAGG)](https://tools.ietf.org/html/rfc7424) is a method of combining (aggregating) multiple network connections in parallel to provide additional bandwidth or redundancy for critical networking situations.
TrueNAS uses [lagg(4)](https://wiki.debian.org/BridgeNetworkConnections) to manage LAGGs.

{{< include file="/static/includes/BeforeYouBridge.md" >}}

To set up a LAGG, go to **Network**, click **Add** on the **Interfaces** widget to open the **Add Interface** screen, then:

1. Select **Link Aggregation** from the **Type** dropdown list. You cannot change the **Type** field value after you click **Save**.

{{< trueimage src="/images/SCALE/Network/AddInterfacePanel.png" alt="Add Interface" id="Add Interface" >}}

2. Enter a name for the interface using the format **bond*X***, where *X* is a number representing a non-parent interface.
Expand All @@ -26,28 +26,28 @@ To set up a LAGG, go to **Network**, click **Add** on the **Interfaces** widget
4. Select the protocol from the **Link Aggregation Protocol** dropdown. Options are **LACP**, **FAILOVER**, or **LOADBALANCE**. Each option displays additional settings.

{{< trueimage src="/images/SCALE/Network/AddInterfaceLinkAggregationSettings.png" alt="Add Interface Settings" id="Add Interface Settings" >}}

![AddInterfaceLinkAggregationSettings](/images/SCALE/Network/AddInterfaceLinkAggregationSettings.png "Add Interface Settings")

{{< expand "LACP" "v" >}}
**LACP** is the most common protocol for LAGG interfaces based on [IEEE specification 802.3ad](https://www.ieee802.org/3/hssg/public/apr07/frazier_01_0407.pdf).

In LACP mode, the interfaces negotiate with the network switch to form a group of ports that are all active once.
The network switch must support LACP for this option to function.
The network switch must support LACP for this option to function.

a. Select the hash policy from the **Transmit Hash Policy** dropdown list. **LAYER2+3** is the default selection.

b. Select the **LACPDU Rate** Option:
b. Select the **LACPDU Rate** Option:

**SLOW** (default) sets the heartbeat request to every second and the timeout to a three-consecutive heartbeat loss that is three seconds.
**SLOW** (default) sets the heartbeat request to every second and the timeout to a three-consecutive heartbeat loss that is three seconds.

**FAST** sets the timeout rate at one per second even after synchronization. **FAST** allows for rapid detection of faults.
{{< /expand >}}
{{< expand "FAILOVER" "v" >}}
Select **FAILOVER** send traffic through the primary interface of the group. If the primary interface fails, traffic diverts to the next available interface in the LAGG.
Select **FAILOVER** send traffic through the primary interface of the group. If the primary interface fails, traffic diverts to the next available interface in the LAGG.
{{< /expand >}}
{{< expand "LOADBALANCE" "v" >}}
Select **LOADBALANCE** to accept traffic on any port of the LAGG group and balance the outgoing traffic on the active ports in the LAGG group.
Select **LOADBALANCE** to accept traffic on any port of the LAGG group and balance the outgoing traffic on the active ports in the LAGG group.
**LOADBALANCE** is a static setup that does not monitor the link state or negotiate with the switch.

Select the **Transmit Hash Policy** option from the dropdown list. **LAYER2+3** is the default selection.
Expand Down
Expand Up @@ -14,7 +14,8 @@ You must know the DNS name server and default gateway addresses for your IP addr
{{< hint type=warning >}}
**Disruptive Change!**

You can lose your TrueNAS connection if you change the network interface that the web interface uses!
You can lose your TrueNAS connection if you change the network interface that the web interface uses!

Command line knowledge and physical access to the TrueNAS system are often required to fix misconfigured network settings.
{{< /hint >}}

Expand All @@ -33,15 +34,15 @@ Any additional interfaces must be manually configured with one or more static IP
{{< include file="/static/includes/AliasOrStaticIP.md" >}}

## Before You Begin
Have the DNS name server addresses, the default gateway for the new IP address, and any static IP addresses on hand to prevent lost communication with the server while making and testing network changes.
Have the DNS name server addresses, the default gateway for the new IP address, and any static IP addresses on hand to prevent lost communication with the server while making and testing network changes.
You have only 60 seconds to change and test these network settings before they revert back to the current settings, for example back to DHCP assigned if moving from DHCP to a static IP.

Back up your system to preserve your data and system settings.
Back up your system to preserve your data and system settings. Save the system configuration file and a system debug.

As a precaution, grab a screenshot of your current settings in the **Global Configuration** widget.
As a precaution, grab a screenshot of your current settings in the **Global Configuration** widget.

If your network changes result in lost communication with the network and you need to return to the DHCP configuration, you can refer to this information to restore communication with your server.
Lost communication could require you to reconfigure your network settings using the [Console setup menu]({{< relref "ConsoleSetupMenuSCALE.md" >}}).
Lost communication might require reconfiguring your network settings using the [Console Setup menu]({{< relref "ConsoleSetupMenuSCALE.md" >}}).

## Changing to a Static IP Address
To view a demonstration of this procedure see the tutorial video in the [Managing Global Configuration]({{< relref "ManagingGlobalConfig.md" >}}) article.
Expand All @@ -52,7 +53,7 @@ To change an interface from using DHCP to a static IP address:

{{< trueimage src="/images/SCALE/Network/EditInterfaceClearDHCP.png" alt="Clear DHCP Checkbox" id="Clear DHCP Checkbox" >}}

2. Click **Add** to the right of **Aliases** to add IP address fields, then enter the new static IP. Select the CIDR number from the dropdown list.
2. Click **Add** to the right of **Aliases** to add IP address fields, then enter the new static IP. Select the CIDR number from the dropdown list.

{{< trueimage src="/images/SCALE/Network/EditInterfaceAddAlias.png" alt="Add Alias IP Address" id="Add Alias IP Address" >}}

Expand All @@ -64,10 +65,11 @@ To change an interface from using DHCP to a static IP address:

3. Click **Save**.
A dialog opens where you can select to either **Test Changes** or **Revert Changes**.
If you have only one active network interface the system protects your connection to the interface by displaying the **Test Changes** dialog.

You have 60 seconds to test and save the change before the system discards the change and reverts back to the DHCP-configured IP address.

4. Check the name servers and default router information in the **Global Information** widget.
4. Check the name servers and default router information in the **Global Information** widget.
If the current settings are not on the same network, click **Settings** and modify each setting as needed to allow the static IP to communicate over the network.

Add the IP addresses for the DNS name servers in the **Nameserver 1**, **Nameserver 2**, and **Nameserver 3** fields.
Expand All @@ -76,7 +78,7 @@ To change an interface from using DHCP to a static IP address:

For home users, use **8.8.8.8** for a DNS name server address so you can communicate with external networks.

Add the IP address for the default gateway in the appropriate field.
Add the IP address for the default gateway in the appropriate field.
If the static network is IPv4 enter the gateway in **IPv4 Default Gateway**, if the static network is IPv6 use **IPv6 Default Gateway**.

Click **Save**.
Expand All @@ -85,7 +87,7 @@ To change an interface from using DHCP to a static IP address:

{{< trueimage src="/images/SCALE/Network/InterfaceTestStaticIPChange.png" alt="Test Changes" id="Test Changes" >}}

The system attempts to connect to the new static IP address. If successful the **Save Changes** dialog displays.
The system attempts to connect to the new static IP address. If successful the **Save Changes** dialog displays.

{{< trueimage src="/images/SCALE/Network/InterfaceSavetStaticIPChange.png" alt="Save Changes" id="Save Changes" >}}

Expand All @@ -96,7 +98,7 @@ To change an interface from using DHCP to a static IP address:

## Returning to DHCP from Static IP
Only one interface can use DHCP to assign the IP address and that is likely the primary network interface.
If you do not have a existing network interface set to use DHCP you can convert an interface from static IP to DHCP.
If you do not have an existing network interface set to use DHCP you can convert an interface from static IP to DHCP.

To switch/return to using DHCP:

Expand Down
Expand Up @@ -16,8 +16,8 @@ Also that you have preconfigured the VLAN tag in the switched network.

To set up a VLAN interface, go to **Network**, click **Add** on the **Interfaces** widget to open the **Add Interface** screen, then:

1. Select **VLAN** from the **Type** dropdown list. You cannot change the **Type** field value after you click **Save**.
1. Select **VLAN** from the **Type** dropdown list. You cannot change the **Type** field value after you click **Apply**.

{{< trueimage src="/images/SCALE/Network/AddInterfaceVLANType.png" alt="Add VLAN Interface Settings" id="Add VLAN Interface Settings" >}}

2. Enter a name for the interface using the format **vlan*X*** where *X* is a number representing a non-parent interface.
Expand All @@ -31,6 +31,6 @@ To set up a VLAN interface, go to **Network**, click **Add** on the **Interfaces

6. Select the VLAN [Class of Service](https://tools.ietf.org/html/rfc4761#section-4.2.7) from the **Priority Code Point** dropdown list.

7. (Optional) Click **Add** to the right of **Aliases** to show additional IP address fields for each additional IP address to add to this VLAN interface.
7. (Optional) Click **Add** to the right of **Aliases** to show additional IP address fields for each additional IP address to add to this VLAN interface.

8. Click **Save** when finished.
8. Click **Save**.
Binary file modified static/images/SCALE/Network/InterfaceSavetStaticIPChange.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion static/includes/AliasOrStaticIP.md
Expand Up @@ -9,4 +9,4 @@ In the UI, you can add aliases when adding or editing an existing interface usin
To add a static IP. Click **Add** again to add an additional alias.

From the [Console Setup menu]({{< relref "ConsoleSetupMenuSCALE.md" >}}), select option 1 to configure network settings and add alias IP addresses.
{{< /expand >}}
{{< /expand >}}
4 changes: 2 additions & 2 deletions static/includes/BeforeYouBridge.md
Expand Up @@ -3,6 +3,6 @@
Prepare your system for interface changes by stopping and/or removing apps, VM NIC devices, and services that can cause conflicts:

* Stop running apps before proceeding with network interface changes.
* Power off any running virtural machines (VMs) before making interface IP changes. Remove active NIC devices.
* Power off any running virtual machines (VMs) before making interface IP changes. Remove active NIC devices.

If you encounter issues with testing network changes, you might need to stop any services, including Kubernetes and sharing services such as SMB, using the current IP address.
If you encounter issues with testing network changes, you might need to stop any services, including Kubernetes and sharing services such as SMB, using the current IP address.

0 comments on commit 09a753b

Please sign in to comment.