Skip to main content

~> Deprecation Notice Equinix Metal will reach end of life on June 30, 2026. All Metal data sources 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_port (Data Source)

Use this data source to read ports of existing devices. You can read port by either its UUID, or by a device UUID and port name.

Example Usage

Create a device and read it's eth0 port to the datasource.

locals {
project_id = "<UUID_of_your_project>"
}

resource "equinix_metal_device" "test" {
hostname = "tfacc-test-device-port"
plan = "c3.medium.x86"
metro = "sv"
operating_system = "ubuntu_24_04"
billing_cycle = "hourly"
project_id = local.project_id
}

data "equinix_metal_port" "test" {
device_id = equinix_metal_device.test.id
name = "eth0"
}

Argument Reference

The following arguments are supported:

  • port_id - (Optional) ID of the port to read, conflicts with device_id.
  • device_id - (Optional) Device UUID where to lookup the port.
  • name - (Optional) Name of the port to look up, i.e. bond0, eth1.

Attributes Reference

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

  • network_type - One of layer2-bonded, layer2-individual, layer3, hybrid, hybrid-bonded.
  • type - Type is either NetworkBondPort for bond ports or NetworkPort for bondable ethernet ports.
  • mac - MAC address of the port.
  • bond_id - UUID of the bond port.
  • bond_name - Name of the bond port.
  • bonded - Flag indicating whether the port is bonded.
  • disbond_supported - Flag indicating whether the port can be removed from a bond.
  • native_vlan_id - UUID of native VLAN of the port.
  • vlan_ids - UUIDs of attached VLANs.
  • vxlan_ids - VXLAN ids of attached VLANs.
Was this page helpful?