Layer 2 Only Bonded Mode¶

Equinix Metal™ allows users to change the networking mode of a server from the default Layer 3 Bonded mode to modes that only use Layer 2 networking over VLANs. This means all access to the public Internet is lost, and the host can only be reached by the Serial Over SSH (SOS) console or from other servers attached to the same VLAN.

Layer 2 Bonded mode preserves the bonded setup of two networking ports connected to the two top-of-rack switches, and you are able to attach VLANs to the bonded interface. This protects your networking from failure, maintenance, or other interruptions on one of the switches.

General Overview¶

• Layer 2 Bonded mode preserves the bond, preserving the redundancy and advantages of having traffic flow over both server ports and top-of-rack switches.
• You can then add VLANs to bond0 for your Layer 2 traffic. If you are only adding one VLAN to bond0, traffic can not be tagged.
• If you are adding more than one VLAN to bond0, you will need to create subinterfaces to handle tagged traffic for each VLAN and/or you have to set a Native VLAN to handle untagged traffic.

Converting to Layer 2 Bonded Mode¶

To use Bonded Layer 2 mode, you must first change your networking configuration to Layer 2. From the portal, navigate to the server's Network page, click Convert To Other Network Type and choose Layer 2.

metal port convert --port-id <bond0_id> --layer2 --bonded

metal ports vlan --port-id <bond0_id> --assign <VLAN_id>

curl -X POST \
-H "Content-Type: application/json" \
-H "X-Auth-Token: <API_TOKEN>" \
"https://api.equinix.com/metal/v1/ports/{id}/convert/layer-2" \
-d '{
    "vnid": "<vlan_ID>"
    }'

The 'vnid' is the ID of the VLAN that is sent in the body of the request. The ID an be either the VLAN's UUID as returned by the /projects/{id}/virtual-networks endpoint, or the VLAN ID that is in the console.

Remember: once you have clicked Convert to Layer 2 in the console, or submitted the request to the API, the existing IP Addresses will be removed and the server will no longer be accessible through the Internet. You will still be able to use the SOS console to connect.

Attaching Multiple VLANs¶

Adding multiple VLANs to the bonded interface is supported. This does affect the server configuration as you will have to make sure there is a subinterface that will receive packets destined for each VLAN and/or you set a Native VLAN to handle untagged traffic.

metal port vlan --port-id <bond0_id> --assign <vlan> --assign <vlan>

curl -X POST \
-H "Content-Type: application/json" \
-H "X-Auth-Token: <API_TOKEN> " \
"https://api.equinix.com/metal/v1/ports/{id}/assign" \
-d '{
    "vnid": "c4032b18-5494-451b-a779-a7d3c536bfd7"
    }'

curl -X POST \
-H "Content-Type: application/json" \
-H "X-Auth-Token: <API_TOKEN> " \
"https://api.equinix.com/metal/v1/ports/{id}/vlan-assignments/batches" \
-d '{
    "vlan_assignments": [
        {
            "vlan": "string",
            "state": "assigned"
        },
        {
            "vlan": "string",
            "state": "assigned"
        },
    ]
}'

Configuring Your Servers for Layer 2 Bonded Mode¶

Once you have converted the server to Layer 2 Bonded mode and assigned the VLAN to bond0, you will need to configure the networking on the server's operating system and assign it an IP address on the VLAN.

Note - Since all Equinix Metal assigned IP addresses were removed when you converted this server to Layer 2, you are free to use whatever subnets you need, but you may have to remove any existing networking configuration in the server's operating system to prevent conflicts.

There are two example configurations, the first example is a configuration for assigning a single VLAN, and the second example is for assigning multiple VLANs.

Remember you will need to use the SOS/OOB Console to SSH into your server.

For a Single VLAN on bond0¶

If you have only one VLAN, do not tag the packets, and assign the VLAN IP Address directly to bond0.

You will need to run through the same steps on all the servers that you want to attach to the VLAN, assigning a different IP address to each.

For Multiple VLANs on bond0¶

If you are using multiple VLANs on bond0, IP packets will have the to be tagged, and you will need to setup subinterfaces that will receive packets destined for each VLAN.

Note: If you need support for untagged packets, set the VLAN that handles the untagged traffic as the Native VLAN.

You will need to run through the same steps on all the servers that you want to attach to the VLANs, assigning different IP addresses to each.

Converting Back to Layer 3¶

If you are in Layer 2 Bonded mode and want to go back to Layer 3, you must first remove any attached VLANs.

To detach a VLAN in the console, navigate to the server's Network page. In the Layer 2 section, click Remove next to the VLAN you are detaching from the server. Confirm that you wish to remove it by clicking Yes.

Detaching the VLAN from this server does NOT delete it from your project. The VLAN will continue to exist after detaching it from the server.

Then, to convert back to Layer 3, click Convert To Other Network Type, select Layer 3. Click Convert to Layer 3 to start the process.

Note - Being in Layer Bonded Mode removed the server's public IP addresses. If the server is later converted back to Layer 3, new public IP addresses are assigned and the server is accessible to the public Internet.