Skip to main content

~> Deprecation Notice Equinix Metal will reach end of life on June 30, 2026. All Metal resources will be removed in version 5.0.0 of this provider. Use version 4.x of this provider for continued use through sunset. See https://docs.equinix.com/metal/ for more information.

equinix_metal_vlan (Resource)

Provides a resource to allow users to manage Virtual Networks in their projects.

To learn more about Layer 2 networking in Equinix Metal, refer to

Example Usage

# Create a new VLAN in metro "esv"
resource "equinix_metal_vlan" "vlan1" {
description = "VLAN in New Jersey"
metro = "sv"
project_id = local.project_id
vxlan = 1040
}

Argument Reference

The following arguments are supported:

  • project_id - (Required) ID of parent project.
  • metro - (Optional) Metro in which to create the VLAN
  • facility - (Deprecated) Facility where to create the VLAN. Use metro instead; read the facility to metro migration guide
  • description - (Optional) Description string.
  • vxlan - (Optional) VLAN ID, must be unique in metro.

Attributes Reference

In addition to all arguments above, the following attributes are exported:

  • id - ID of the virtual network.

Import

This resource can be imported using an existing VLAN ID (UUID):

terraform import equinix_metal_vlan {existing_vlan_id}
Was this page helpful?