Launch SDWAN Device

Step 1: Authenticate

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

Step 2: Get Device Types and Account

2a) Get device types
Call Get Device Types API to find the SD-WAN devices you can launch on the NE platform. You will learn about metros (metroCode) where these devices are available, the available number of cores (core), the software packages (packageCode & version), and all possible licensing and throughput options.

2b) Get account
Check your account number (or acountReferenceId) and status in the metro where you want a virtual device by calling Get Accounts {metro} API. 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, go 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 an SD-WAN device for your customer.

Step 3: Configure a License

For now, bring your own license (BYOL) is the only licensing option available for SD-WAN devices and the process to BYOL is unique to every vendor.

a) To configure a license for a CISCO SD-WAN devices, you must do the following:
1) Generate a bootstrap file on Cisco vManage platform.
2) To create a C8000V-SDWAN, upload the Cisco bootstrap file by calling Upload File. You'll get a fileUuid in the response. You can enter the value in the day0TextFileId field of the create payload to create a virtual C8000V-SDWAN device.

b) To configure a license for a CloudGenix device, you must do the following:
1) Generate a license key (ION key) and license secret (Secret key) on CloudGenix platform.
2) Input the license key (ION key) and secret (Secret key) when calling Equinix create device API to create a CloudGenix SD-WAN device.

c) License is not mandatory for Fortinet devices at the time of device creation. If you have a token, enter it in the licenseToken field. To configure a license file for a Fortinet SD-WAN device, do the following:
1) Generate a license file on the Fortinet portal.
2) Upload the license file on the Equinix portal by calling Post License File. You'll get a fileId that you can use to create a virtual SD-WAN device.

d) To configure a Versa device, please create a vNF device template on Versa director and note the serial number.

e) You do not need a license file to configure an Aruba device on the Network Edge platform.

f) To upload a license for a Juniper SD-WAN, you must do the following:
1) Generate a license file on the Juniper portal.
2) Upload the license file on the Equinix portal by calling Post License File. You'll get a fileId that you can use to create a Juniper SD-WAN device.

Step 4: Vendor-specific Parameters

Each SD-WAN vendor requires its own set of parameters other than the common parameters listed as part of POST API definition in Step 5. Please check the parameters of your vendor and pass the parameters in the vendorConfig{} object when creating a new device in Step 5.

a) Cisco: SD-WAN

b) CloudGenix: PRISMA-SDWAN

c) Versa: VERSA_SDWAN

d) FortiGate : FG-SDWAN *

*FortiGate SD-WAN devices also need a hostname but it is not part of vendorConfig object, just passed as a parameter along with others like deviceTypeCode, accountNumber, etc.

e) VMware : VELOCLOUD-SDWAN

f) Aruba: EDGECONNECT-SDWAN

Step 5: Create SD-WAN Devices

Download Postman Scripts for exact payloads to create devices. Every device has its own payload, depending on the vendor of the device.

If you want to create a redundant SD-WAN device that has two devices, primary and secondary, do the following:
1) Set vendorConfig parameters of the optional secondary object. Click here to know your vendorConfig parameters.

• provide two licenseFileIds for a Cisco SD-WAN in the request body payload
• provide two licenseKeys (ION keys) and license secrets (Secret keys) for a CloudGenix redundant device in the request body payload
• provide two activationKeys for a VMware redundant SD-WAN device.

2) You may have a different ACL template, account number, additionalBandwidth, metroCode, and notifications for your secondary device.
3) If you are a reseller trying to create a redundant device for your customer, make sure both the primary and secondary metros are in the same country. Also, the primary and secondary account numbers must be the same. The reseller's account will get billed, however, this API accepts the customer's account number to create devices for the customer. The above restrictions are necessary as each customer is associated with a reseller's billing account.

A sample curl request to create a virtual Cisco SD-WAN device with NO secondary device.

Note: By creating a virtual device, you accept the Order Terms. Call Get Order Terms to review the details.

A sample curl request to create a redundant Cisco SD-WAN device.

curl -X POST 
https://api.equinix.com/ne/v1/devices?draft=false
-H 'Authorization: Bearer dbFb0zo203fxyRpBrGd6wAX3IGSR' 
-H 'Content-Type: application/json' 
-d '
{
    "deviceTypeCode": "C8000V-SDWAN",
    "projectId": "XXXXX",
    "metroCode": "DC",
    "termLength": "1",
    "licenseMode": "BYOL",
    "packageCode": "DNA",
    "virtualDeviceName": "sroy-cisco-8v-controller",
    "notifications": [
        "test@equinix.com"
    ],
    "version": "17.09.01a",
    "interfaceCount": 10,
    "deviceManagementType": "SELF-CONFIGURED",
    "core": 4,
    "vendorConfig": {
        "systemIpAddress": "1.1.1.1",
        "siteId": "4567",
        "hostname": "SR-01"
    },
    "aclTemplateUuid": "3319e378-be2f-40e4-8e79-13ea2aed7a5f",
    "day0TextFileId": "917f2621-11d4-468f-9a09-af8fd66c0e57",
    "accountNumber": "201091",
    "secondary": {
        "metroCode": "DC",
        "notifications": [
            "test@equinix.com"
        ],
        "virtualDeviceName": "sroy-cisco-8v-controller-secondary",
        "additionalBandwidth": "100",
        "vendorConfig": {
            "systemIpAddress": "1.1.1.1",
            "siteId": "9886",
            "hostname": "SR-02"
        },
        "aclTemplateUuid": "3319e378-be2f-40e4-8e79-13ea2aed7a5f",
        "day0TextFileId": "dec1dee5-eba9-4187-a029-ae76341e8874",
        "accountNumber": "201091"
    },
    "additionalBandwidth": "100"
}
'

Note: "aclTemplateUuid" field is deprecated. Please use "aclDetails" instead.

Sample response for a single device.
202: Request accepted.

{
    "uuid": "74d8c6b6-3153-4271-9f0e-45bdc7094dec"
}

Sample response for a redundant device.
202: Request accepted.

{
    "uuid": "74d8c6b6-3153-4271-9f0e-45bdc7094dec",
    "secondaryUuid": "de5cf79b-3d16-4ccd-841b-3b68ecda2142"
}

Response payload:

When an SD-WAN device is created, the device 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. Once your device is provisioned and the license is applied, you can create connections to cloud service providers.

When an end-user deletes a device using the Delete Virtual Devices API, the device transitions through the following states within the Equinix infrastructure.