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_connection (Data Source)

Use this data source to retrieve a connection resource

~> Equinix Metal connection with with Service Token A-side / Z-side (service_token_type) is not generally available and may not be enabled yet for your organization.

Example Usage

data "equinix_metal_connection" "example" {
connection_id = "4347e805-eb46-4699-9eb9-5c116e6a017d"
}

Argument Reference

The following arguments are supported:

  • connection_id - (Required) ID of the connection resource.

Attributes Reference

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

  • name - Name of the connection resource.
  • metro - Slug of a metro to which the connection belongs.
  • facility - (Deprecated) Slug of a facility to which the connection belongs. Use metro instead; read the facility to metro migration guide
  • contact_email - The preferred email used for communication and notifications about the Equinix Fabric interconnection.
  • redundancy - Connection redundancy, reduntant or primary.
  • type - Connection type, dedicated or shared.
  • project_id - ID of project to which the connection belongs.
  • speed - Connection speed - Values will be in the format 'Mbps' or 'Gpbs', for example '100Mbps`, '50Gbps', etc.
  • description - Description of the connection resource.
  • mode - Mode for connections in IBX facilities with the dedicated type - standard or tunnel.
  • tags - String list of tags.
  • vlans - Attached VLANs. Only available in shared connection. One vlan for Primary/Single connection and two vlans for Redundant connection.
  • service_token_type - Type of service token, a_side or z_side. One available in shared connection.
  • organization_id - ID of the organization where the connection is scoped to.
  • status - Status of the connection resource.
  • service_tokens - List of connection service tokens with attributes
    • id - UUID of the service token required to configure the connection in Equinix Fabric with the equinix_fabric_connection resource or from the Equinix Fabric Portal.
    • expires_at - Expiration date of the service token.
    • max_allowed_speed - Maximum allowed speed for the service token, string like in the speed attribute.
    • type - Token type, a_side or z_side.
    • role - Token role, primary or secondary.
  • ports - List of connection ports - primary (ports[0]) and secondary (ports[1])
    • name - Port name.
    • id - Port UUID.
    • role - Port role - primary or secondary.
    • speed - Port speed in bits per second.
    • status - Port status.
    • link_status - Port link status.
    • virtual_circuit_ids - List of IDs of virtual cicruits attached to this port.
  • token - (Deprecated) Fabric Token required to configure the connection in Equinix Fabric with the equinix_fabric_connection resource or from the Equinix Fabric Portal. If your organization already has connection service tokens enabled, use service_tokens instead.
  • authorization_code - Fabric Authorization Code to configure the Metal-Fabric Integration connection in Equinix Fabric with the equinix_fabric_connection resource or from the Equinix Fabric Portal.
Was this page helpful?