Create a Device Link Group

A device link group can include any virtual device that is provisioned and registered unless the device interfaces are already full. To learn more about device links, see the Network Edge guide. To create a device link group using APIs, you must have the following:

• At least two provisioned virtual devices with registered licenses. You must have the deviceUuids and the metroCodes where the devices are located.

• You need to provide ASNs for the devices if the ASNs have not been set. If a device already has an ASN, retrieve the ASN by calling Get Virtual Device.

• Equinix billing account number. Your account must be in the Active or Pending status. You must provide an account number for every link you create.

• Choose a subnet for the group. You must choose a subnet keeping in mind the number of devices you wish to add to the group. This is not a mandatory field at the time you try to create a linking group; however, you must provide this to have a functional linking group.

• Provide metroLinks information (account number, throughput, metroCode) unless the devices are in the same metro.

Prerequisites

Authenticate - Submit your user credentials, Client ID, and Client Secret for OAuth2 authentication. Refer to API Authentication for instructions on how to call the OAuth API to validate and authenticate your credentials.

Step 2: Get Virtual Devices

To get details of your virtual devices, call Get Virtual Devices. The response will include:

• virtualDeviceUuids
• metroCodes,
• ASNs
• accountNumbers.

Step 3: Create Device Link

	POST /ne/v1/links
Method	POST
URL or End Point	/ne/v1/links
Headers	Authorization, Content-Type
Path Parameters	NA
Body Parameters	groupName, subnet, redundancyType, linkDevices[deviceUuid, asn, interfaceId], metroLinks[ {accountNumber, throughput, throughputUnit, metroCode}]

A sample curl request to create a device link group between two devices in two different metros.

curl -X  
POST "https://api.equinix.com/ne/v1/links"  
-H "content-type: application/json"  
-H "Authorization: Bearer <token>"  
-d '{  
  "groupName": "test-link",  
  "subnet": "10.0.0.0/27",  
    "redundancyType": "SECONDARY",  
  "linkDevices": [  
    {  
      "deviceUuid": "d186dc1a-29e7-4829-bb5e-50fa57aca923",  
      "asn": 65414,  
      "interfaceId": 6  
    },  
    {  
      "deviceUuid": "ea128600-1875-4f7a-80e9-307a5bbeac51",  
      "asn": 100,  
      "interfaceId": 6  
    }  
  ],  
  "metroLinks": [  
    {  
      "accountNumber": "23945678",  
      "metroCode": "SV",  
      "throughput": 1000,  
      "throughputUnit": "Mbps"  
    },  
  
    {  
      "accountNumber": "2395123",  
      "metroCode": "SY",  
      "throughput": 1000,  
      "throughputUnit": "Mbps"  
    }  
  ]  
   
}'

A sample curl request to create a device link between two devices within a metro.

curl -X  
POST "https://api.equinix.com/ne/v1/links"  
-H "content-type: application/json"  
-H "Authorization: Bearer <token>"  
-d '{  
    "groupName": "test-link",  
    "subnet": "10.0.0.0/27",  
    "redundancyType": "SECONDARY",  
    "linkDevices": [  
    {  
        "deviceUuid": "d186dc1a-29e7-4829-bb5e-50fa57aca923",  
        "asn": 65414,  
        "interfaceId": 6  
    },  
    {  
        "deviceUuid": "ea128600-1875-4f7a-80e9-307a5bbeac51",  
        "asn": 100,  
        "interfaceId": 6  
    }  
    ],  
    "metroLinks": []  
      
}'

For a complete list of parameters and options, see the API Reference.

Sample Response

{  
    "uuid": "85ebe7b7-6182-45a1-be51-cb194f2f1e39"  
}

Response payload:

Field	Type	Example Values	Description
uuid	string	b43ba509-a7d9-4334-8dee-dc4f29bf2e77	The unique ID of the device link group.

Device Status

When a device link group is created, it transitions through various states that can be monitored using the status response attribute of the Get Device Link method. Your link group must be provisioned before you can begin to perform other operations like adding or removing devices.

Status	Description
PROVISIONING	The device link group is booting.
FAILED	Link creation failed.
PROVISIONED	The device link group is ready.
DEPROVISIONING	The device link group is being de-provisioned.
DEPROVISIONED	The device link group is de-provisioned.

You can update a link group using Update Device Link.

If you delete a device link group using the Delete Device Link method, the group transitions through the following states:

Status	Description
DEPROVISIONING	Equinix accepted the customer's request to delete a device link group.
DEPROVISIONED	The device link is deleted.