Dedicated Ports¶

To request a Dedicated Port, open the Interconnections page. If any projects in your organization or project already has Fabric Virtual Connections or Dedicated Ports, you will be able to see them on this page.

Click + Request New Interconnection.

For Choose an Interconnection Type, select Dedicated Port.

• Select the location for the new connection from the drop-down. You will want to select the Metro where your Equinix Metal infrastructure already lives, or where you plan on provisioning it.
• Give a name to your connection.
• Choose whether you want a redundant or single connection. If you choose a redundant connection, you get a primary and secondary port to attach Virtual Circuits and VLANs to, giving you some amount of redundancy and high-availability.

Next, there is a toggle to enable Dedicated Tunnel mode. Enabling this mode at provision-time is optional. You can enable and disable Dedicated Tunnel mode on already-provisioned Dedicated Ports.

Review the summary of your request. Click Submit Request to complete your Dedicated Port request and submit it to the Equinix Metal support team.

Once your request is submitted, it moves to the Pending Requests tab. Note that Dedicated Ports are scoped at the Organization level. Any request for a Dedicated Port in a particular project will be visible to the Organization the project belongs to.

To request a connection through the API, send a POST request to the /projects/{project_id}/connections endpoint.

curl -X POST \
-H "Content-Type: application/json" \
-H "X-Auth-Token: <API_TOKEN>" \
"https://api.equinix.com/metal/v1/projects/{project_id}/connections" \
-d '{
    "name": "<string>",
    "description": "<string>",
    "contact_email": "<string>",
    "metro": "<metro_code>",
    "type": "dedicated",
    "redundancy": "redundant"
}'

Request Fields

• "name" (required) - The name of the connection.
• "description" (optional) - User-friendly description of the connection.
• "contact_email" - The preferred email used for communication and notifications about the Interconnection. Required when using a Project API key. Optional and defaults to your user email address when using a User API key.
• "metro" (required) - The metro where the connection lives. Specify the Metro where your Equinix Metal infrastructure already lives, or where you plan on provisioning it.
• "type" (required) - To request a Dedicated Port, set to "dedicated".
• "redundancy" (required) - If you choose a redundant connection, you get a primary and secondary port to attach two VLANs to, giving you some amount of redundancy and high availability. Options are either “primary” or “redundant”.

A full parameter list is in the API Reference.

Once the Dedicated Port is established, it will appear on a Project's Interconnections page. Note that Dedicated Ports are managed at the organization level, so they will appear in any of your organization's Projects.

Clicking on a Dedicated Port brings you to its Overview page, which contains a detail view as well as a summary of the primary port and secondary port configurations. A detailed view of the ports is available by clicking the Primary Port and Secondary Port tabs.

To list all the Interconnections for your Organization, send a GET request to the /organizations/{organization_id}/connections endpoint.

curl -X GET -H 'X-Auth-Token: <API_TOKEN>' \
https://api.equinix.com/metal/v1/organizations/{organization_id}/connections

To get the details of a Dedicated Port, send a GET request to the /connections/{connection_id} endpoint, specifying the UUID in the request path.

curl -X GET -H 'X-Auth-Token: <API_TOKEN>' \
https://api.equinix.com/metal/v1/connections/{connection_id}

You can use this information to manage and update the Dedicated Port by sending a PUT request to the /connections/{connection_id} endpoint. Specify what you want changed in the body of the request. You can modify the name, description, tags and contact email.

If you want to change the redundancy of the VC, updating redundancy to primary will remove a secondary port, while updating to redundant will add a secondary port.

You can enable and disable Dedicated Tunnel mode by updating the mode to either standard or tunnel.

curl -X PUT \
-H "Content-Type: application/json" \
-H "X-Auth-Token: <API_TOKEN>" \
"https://api.equinix.com/metal/v1/connections/{connection_id}" \
-d '{
    "contact_email": "<string>",
    "description": "<string>",
    "name": "<string>",
    "redundancy": "<string>",
    "mode": "<standard>",
    "tags": [
        "<string>"
    ]
}'

You can also get the individual ports' information of your Dedicated Port.

To get a list of a the ports, send a GET request to the /connections/{connection_id}/ports endpoint.

curl -X GET -H 'X-Auth-Token: <API_TOKEN>' \
https://api.equinix.com/metal/v1/connections/{connection_id}/ports

And to get one of the port's details, send a GET request to the /connections/{connection_id}/ports/{id} endpoint.

curl -X GET -H 'X-Auth-Token: <API_TOKEN>' \
https://api.equinix.com/metal/v1/connections/{connection_id}/ports/{id}

From your Dedicated Port's Overview, select the Primary Port tab.

Click +Add Virtual Circuit to create a virtual circuit and attach a VLAN. Select the VLAN to associate with the virtual circuit and give it an NNI VLAN number (an integer between 2 and 4094). Each virtual circuit needs to have a unique NNI VLAN number.

To create a new Virtual Circuit, send a POST request to the /connections/{connection_id}/ports/{port_id}/virtual-circuits endpoint.

curl -X POST \
-H "Content-Type: application/json" \
-H "X-Auth-Token: <API_TOKEN>" \
"https://api.equinix.com/metal/v1/connections/{connection_id}/ports/{port_id}/virtual-circuits" \
-d '{
    "description": "<string>",
    "name": "<string>",
    "nni_vlan": <integer>,
    "vnid": "<string>",
    "tags": [
        "<string>"
    ]
}'

Request Fields

• "name" (required) - The name of the connection.
• "description" (optional) - User-friendly description of the connection.
• "nni_vlan" - (required) - An integer between 2 and 4094.
• "vnid" - (optional) - VLAN ID or UUID of the VLAN to attach to the Virtual Circuit. If omitted, the VC is created and has status "Waiting on Customer VLAN".
• "tags" - (optional) - String or array of strings to use as identifiers for the VC.

The Virtual Circuits on a port are listed on the Primary Port or Secondary Port tabs of the Dedicated Port.

To change the VLAN connected to the Virtual Circuit, click the menu button, which brings up the Manage VLAN pane. Select the new VLAN from the drop-down, and click Update Virtual Circuit.

To get a list of the Virtual Circuits connected to a port, send a GET request to the /connections/{connection_id}/ports/{port_id}/virtual-circuits endpoint.

curl -X GET -H 'X-Auth-Token: <API_TOKEN>' \
https://api.equinix.com/metal/v1/connections/{connection_id}/ports/{port_id}/virtual-circuits

You can update the Virtual Circuit by sending a PUT request to the /virtual-circuits/{id} endpoint. For example, to change the VLAN, specify the new VLAN ID in the body of the request.

curl -X PUT \
-H "Content-Type: application/json" \
-H "X-Auth-Token: <API_TOKEN>" \
"https://api.equinix.com/metal/v1/virtual-circuits/{id}" \
-d '{
    "vnid": "<string>"
}'

After removing all VLANs, select the Virtual Circuit you would like to remove, and from the Actions drop-down, click Delete.

After removing all VLANs, send a DELETE request to the /virtual-circuits/{id} endpoint, specifying the UUID of the Virtual Circuit in the path of the request.

curl -X DELETE -H 'X-Auth-Token: <API_TOKEN>' \
https://api.equinix.com/metal/v1/virtual-circuits/{id}

To set up your Virtual Connections with in Dedicated Tunnel mode, click the toggle next to the Dedicated Tunnel option on the Connection's Overview.

Then on each Port (Primary or Secondary or both), click Create Virtual Circuit. Select the VLAN you want to connect to the Virtual Circuit from the drop-down, and give a name to the Virtual Circuit. Click + Add Virtual Circuit.

You will not be able to enable or disable Dedicated Tunnel mode if you currently have Virtual Circuits attached to the Port. You have to remove any the Virtual Circuits before changing the mode.

In the API, you can enable Dedicated Tunnel on an existing port by sending a PUT to the /connections/{connection_id} endpoint with the mode field set to "tunnel" in the body of the request.

curl -X PUT \
    -H "Content-Type: application/json" \
    -H "X-Auth-Token: <API_TOKEN>" \
    "https://api.equinix.com/metal/v1/connections/{connection_id}" \
    -d '{
        "mode": "tunnel"
    }'

If the mode field is omitted, it defaults to "standard".

You can check the mode of a Connection by sending a GET to the /connections/{connection_id} endpoint.

curl -X GET -H 'X-Auth-Token: <API_TOKEN>' https://api.equinix.com/metal/v1/connections/{connection_id}

To disable Dedicated Tunnel mode, send the PUT to the /connections/{connection_id} endpoint with the mode field set to "standard" in the body of the request.

curl -X PUT \
    -H "Content-Type: application/json" \
    -H "X-Auth-Token: <API_TOKEN>" \
    "https://api.equinix.com/metal/v1/connections/{connection_id}" \
    -d '{
        "mode": "standard"
    }'

You will not be able to enable or disable Dedicated Tunnel mode if you currently have Virtual Circuits attached to the Port. You have to remove any the Virtual Circuits before changing the mode.