Skip to main content
Index

Launch Cluster Device

Create a cluster

To create a cluster device, you must have the following information:

 

1) Which virtual device type (deviceTypeCode) you want, the number of cores (core) and the software type (packageCode and version) you need, and the location where you want your virtual device (metroCode). As of now, we only offer the Juniper device type (VSRX) and bring your own license option (BYOL). You may choose any zone in the metro of your choice if the metro offers zones.

 

2) Equinix account number. Your account must be in the Active or Pending status. 

 

3) License option (licenseMode). As of now, we only offer BYOL license option.

 

If you have all the necessary information, skip ahead to Step 4and create a virtual device. Otherwise, follow the steps:

 

To save a device draft, you must provide deviceTypeCode, accountNumber/accountReferenceId, and metroCode.

 

Refer to Creating a Juniper vSRX Cluster for more details. 

Step 1: Authenticate

Submit your user credentials, Client ID, and Client Secret for OAuth2 authentication.

 

Refer to Generating a Client ID and Client Secret key under Getting Started section for instructions on how to create client ID and client secret and refer to Requesting Access and Refresh tokens for instructions on how to call Oauth API to validate and authenticate your credentials.

 

If you are unaware of your user credentials for Network Edge, contact your local Equinix Service Desk. 

Step 2: Get Device Types and Account

2a) Get device types

 

Call Get device types API to find out which virtual device (e.g., router or firewall) you want to launch on the NE platform (deviceTypeCode). You will learn about the metro regions where virtual devices are available (metroCode), the vendors of devices, the available number of cores (core) and software packages (packageCode and version), and all possible licensing options. You may choose to have the default or the maximum interface count for your device. As of now, we only offer Juniper (VSRX) device type and bring your own license (BYOL) option.

If the metro of your choice has zones, you may specify any available zone (zoneCode). To check out all the available zones, call Get Metro.

 

2b) Get account

 

Call Get account API to check your account number (or acountReferenceId) and status in the metro where you want a virtual device. For billing reasons, you must have an account in the metro where you want a virtual device, either in the Active or Pending state. To learn how to create an account, refer to Billing Account Management.

 

If you are a reseller trying to create a device for your customer, you must ensure that the customer's and your (reseller's) accounts are both in the Active or Pending status. Your account will get billed, however, you must send the customer's account number to the POST API to create a device for your customer.

 

Step 3: Licensing Options

As of now, we only offer BYOL licensing option. You do not need to upload any license file or token to create a cluster device on the Network Edge platform. 

Step 4: Create Cluster Device

POST /ne/v1/device

 Method  POST
 URL or End Point  /ne/v1/device
 Headers  Authorization token, Content-Type
 Query Parameters  draft, draftUUID
 Body Parameters

 additionalBandwidth, deviceTypeCode, hostNamePrefix, metroCode, 

 notifications[...], packageCode, version, termLength, licenseMode, licenseFileId,

 virtualDeviceName, orderingContact, aclTemplateUuid, accountNumber, accountReferenceId, 

 purchaseOrderNumber, interfaceCount, deviceManagementType, core, zoneCode, userPublicKey { username, keyName}, clusterDetails {clusterName, hostNames[]}

 

A sample curl request to create a cluster:

 

curl -X

POST "https://api.equinix.com/ne/v1/device?draft=false"
-H "content-type: application/json"
-H "Authorization: Bearer jnSoUKaJHpzMnU0toROpUHmqnwEP"
-d '

{
    "metroCode": "SV",
    "deviceTypeCode": "VSRX",
    "termLength": "1",
    "clusterDetails": {
        "clusterName": "clustersroy3",
        "hostNames": [
            "sr4",
            "sr5"
        ]
    },
    "licenseMode": "BYOL",
    "packageCode": "STD",
    "virtualDeviceName": "clustersroy3",
    "notifications": [
        "test@equinix.com"
    ],
    "hostNamePrefix": "sr4",
    "aclTemplateUuid": "c72df2e3-a911-4109-bf9e-0376003c5a9a",
    "accountNumber": "201148",
    "version": "18.4R3-S2",
    "interfaceCount": 8,
    "deviceManagementType": "SELF-CONFIGURED",
    "core": 5,
    "userPublicKey": {
        "username": "UserNameMM",
        "keyName": "newKeyName1"
    },
    "additionalBandwidth": "200"
}

'

 

The description of the query parameters is as follows:

 

Query Parameter Name Mandatory Type Example Possible Values Description
draft No boolean False True, False Default=false. To save a draft, set draft=true. You must provide deviceTypeCode, accountNumber/accountReferenceId, and metroCode to save a draft. sshUsers will not be saved for drafts. Also, this API will not do access-control list validation when you save a draft. 
draftUUID No string ec68e425-f973-452e-a866-76be5844d0ba   To create a device from a draft you saved earlier, provide the unique Id of the draft (draftUUID). 

 

The description of the body parameters is as follows:

 

Body Parameter Name Mandatory Type Example Possible Values Description
deviceTypeCode Yes string CSR1000V

 

Virtual device type (device type code).
accountNumber No string 10478397

 

Account number. Either an account number or an account referenceId is required to create a virtual device. Note to resellers creating a device for a customer: Your (reseller's) account will get billed, however, you must send the customer's account number to this API to create a device for your customer.
accountReferenceId No string 791281   Account reference Id. This is a temporary ID that can be used to create a device when your account is still pending, not active. Either an account number or an account referenceId is required to create a virtual device. 
hostNamePrefix Yes string mySR   Hostname prefix. This gets included as part of an FQDN that ensures the device is reachable from approved sources if desired. Only a-z, A-Z, 0-9, and hyphen(-) are allowed. It should start with a letter and end with a letter or a digit. Also, it should be a minimum of 2 and a maximum of 10 characters long. 
virtualDeviceName Yes string CiscoSTROY   The virtual device name for identification. This should be a minimum of 3 and a maximum of 50 characters long. 
orderingContact No string subuser01   Username of a reseller's customer. This field is mandatory in case a reseller is ordering a device for one of its customers. This contact will receive order and cancellation notifications. 
licenseMode Yes string BYOL BYOL License type. At this time, BYOL is the only available option for cluster devices.
licenseFileId No string a4605fe7-1033-42c9-8473-8b8c8d7b0f09   License file Id. You may provide a licenseFileId to bring your own license (BYOL). First, upload a license file using POST License File Before Creating Device (BYOL) API. You will get a licenseFileId in the response. 
metroCode Yes string SV   Metro code. You may provide two different metros for your HA device. However, both metros must be in the same country if you are a reseller trying to create a device for your customer. This restriction is necessary as a customer is associated with a reseller's billing account.
notifications Yes array test1@example.com   Email addresses for device life-cycle notification. We need a minimum of 1 and no more than 5 email addresses. You may have a different notification list for your HA device that has a secondary device for high availability. 
packageCode Yes string STD   Software package code. 
version Yes string 14.4R3-S2   Version.
termLength No integer 24   Billing term length in months.
aclTemplateUuid No string 39289456-a63e-47d4-927c-5161cfb77500   The template Id of a device ACL template created using POST Device ACL Template
purchaseOrderNumber No string 3456789   Purchase order number. Optional field that customers can use to track this device creation to their own purchase order number. 
additionalBandwidth No integer 100   Additional bandwidth. You may have a different additional bandwidth for your secondary device in case you have an HA device. 
deviceManagementType Yes string SELF-CONFIGURED   Cluster devices are self-configured.
core Yes integer 4   The number of cores.
interfaceCount No integer 24   Whether you want the default number or the maximum number of interfaces available on the device.
userPublicKey Yes object

 "userPublicKey": {

        "username": "sroy",

        "keyName": "keyName"

    }

  An object containing the username and keyName. 
userPublicKey.username Yes string sroy   Username.
userPublicKey.keyName Yes string keyName   Key name. 
clusterDetails Yes object     An object that has the clusterName and the two hostNames.
clusterName Yes string clusterSROY123   The name of the cluster.
hostNames Yes array ["SR1", "SR2"]   Two hostnames.
zoneCode No string Zone1   If your metro has zones, you may specify the zone in which you want your cluster device. Please check the clusterSupported flag before you select any zone. 

 

 

Sample response:

 

{
    "uuid": "34b7838c-ec82-4166-ac19-efa03b4e34fe",
    "deviceIds": {
        "node0": "34b7838c-ec82-4166-ac19-efa03b4e34fe",
        "node1": "f27f1475-3c7f-447f-b0db-e3bb3af3de16"
    },
    "clusterId": "27eea9aa-327b-431b-bf62-3cee4d880f2e"
}

 

The description of the response payload is as follows:

 

Field Type Example Values Description
uuid string b43ba509-a7d9-4334-8dee-dc4f29bf2e77 The unique Id of the node0 cluster device.
node0 string b43ba509-a7d9-4334-8dee-dc4f29bf2e77 The unique Id of the node0 cluster device.
node1 string f27f1475-3c7f-447f-b0db-e3bb3af3de16 The unique Id of the node1 cluster device.
clusterId string 27eea9aa-327b-431b-bf62-3cee4d880f2e The unique Id of the cluster device.

 

 

When a cluster is created, the self-configured cluster transitions through various states within the Equinix infrastructure. These states can be monitored using the "status" response attribute of the Get virtual device {UUID} API. Your cluster must be provisioned and your license must be registered before you can use this virtual device to connect to cloud service providers. 

 

Virtual device "status"  Description
INITIALIZING Equinix is in the process of reserving resources and creating the cluster device.
PROVISIONING The device is booting.
WAITING_FOR_REPLICA_CLUSTER_NODES Other nodes are going through the provisioning process. 
CLUSTER_SETUP_IN_PROGRESS The cluster setup is in progress. 
FAILED The cluster creation failed.
PROVISIONED The cluster is provisioned.

 

Cluster Status Diagram

 

When end-users delete a cluster using the DELETE virtual device API,  the cluster transitions through the following states within the Equinix infrastructure. 

 

Virtual device "status" under /ne/v1/device/{uuid} Description
DEPROVISIONING Equinix accepted the customer's request to delete a virtual device. 
DEPROVISIONED The device is de-provisioned/deleted. 

Sample Payloads

Parameter Name Juniper
deviceTypeCode VSRX
hostNamePrefix myHost123
licenseMode BYOL
notifications test@equinix.com
metroCode DC
aclTemplateUuid c72df2e3-a911-4109-bf9e-0376003c5a9a
packageCode STD
version

18.4R3-S2

virtualDeviceName sroyClusterDevice
orderingContact subuser01
accountNumber 1234567
addtionalBandwidth 100
purchaseOrderNumber 888888
deviceManagementType SELF-CONFIGURED
core 5
interfaceCount 8
userPublicKey.username test
userPublicKey.keyName keyName
clusterName myCluster
hostNames "HN1", "HN2"