Skip to main content
Index

Connect to Oracle

You can create a connection between your Equinix virtual device and Oracle FastConnect. 

 

Click here to watch a video on how to create a virtual device and connect to Oracle FastConnect using Network Edge Portal. 

Layer 2 connection to Oracle

 

What do you need to create a connection? 

 

     1) A provisioned Equinix virtual device (virtualDeviceUUID) with a registered license. In case you have an optional secondary virtual device, you also need the Id of the secondary device.

     2) Authorization key from your provider. In case you have an optional secondary virtual device, you also need the authorization key of the secondary device. The two authorization keys will be the same if they belong to the same account. 

     3) Unique Id of the provider's service profile (profileUUID) and metro (sellerMetroCode) of the provider

 

If you already have all the information and authentication credentials, you can skip ahead to Step 2f and create a connection. Otherwise, go through the steps to retrieve information.

Step 1: Retrieve Oracle OCID

Obtain your Oracle OCID using the Oracle portal.

 

The OCID is a unique key essential for creating an Oracle FastConnect connection. 

 

Refer to https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/fastconnectprovider.htm for instructions on how to signup for Oracle FastConnect.

Step 2: Create Connection

2a) 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, contact your local Equinix Service Desk. 

 

2b) Get virtual devices

Find out your available virtual devices on the NE platform by calling Get virtual devices. Unique Id (UUID) of your device is required to create a connection.

You may choose any available interface on the device for your connection. However, Equinix will choose an interface if you do not specify any.

 

You may skip this step if you already know your available virtual devices.

 

2c) Get metros

Call Get metro API to find out your available metro options (metroCodes) where the NE platform is available.

 

You may skip this step if you already know where you want your device.  

 

2d) Get Service Profile

Identify all seller/service profiles available for a given metro or metros. Refer to Get L2 service profiles under the API Reference section to find profileUUID and sellerMetroCode.

 

You may skip this step if you already know the service profile details.

 

2e) Get ValidateAuthorizationKey

Verify whether a connection can be established between your Oracle OCID service key and the seller profile selected earlier by calling Get validateAuthorizationKey API.

 

You may skip this step if you are certain that your key is authorized for creating connections with the selected service profile.

 

2f) Post Connections

POST /ne/v1/l2/connections

Method POST
URL or End Point /ne/v1/l2/connections
Headers

Authorization, Content-Type

Query Parameters Not applicable
Body Parameters virtualDeviceUUID, primaryName, profileUUID, speed, speedUnit, notifications [...], purchaseOrderNumber, sellerMetroCode, authorizationKey, interfaceId, secondaryvirtualDeviceUUID, secondaryName, secondarySpeed, secondarySpeedUnit, secondaryAuthorizationKey, secondaryInterfaceId

 

The POST connections API creates a Layer 2 Connection between your virtual device and the destination service profile. 

 

If you are unaware of how to obtain an authorization key, refer to Requesting Access and Refresh tokens section under Getting Started.

 

The following screenshots show sample curl requests to create a layer 2 Oracle connection for HA and non-HA virtual devices.

 

Oracle Connection for a non-high availability virtual device

 

curl -X

POST "https://api.equinix.com/ne/v1/l2/connections"

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

-d '{

  "virtualDeviceUUID": "6c2845e5-be63-4261-ba1c-a53a7e4cf5ec",
  "primaryName": "JohnDoeOracle1",
  "profileUUID": "d7f5769b-9618-4d8e-b7dc-9e68ffd0a8b8",
  "speed": 1,
  "speedUnit": "GB",
  "notifications": [
    "JohnDoe@equinix.com"
  ],
  "purchaseOrderNumber": "456299",
  "sellerMetroCode": "DC",

  "authorizationKey": "ocid1.virtualcircuit.oc1.iad.aaaaaaaafzx4jybgymnyfjfwyxl7f4b6emvp3uast2opcf6z7xzp2lqcnpjq",

  "interfaceId": 7
}'

 

Oracle Connection for a high availability virtual device

 

curl -X

POST "https://api.equinix.com/ne/v1/l2/connections"

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

-d '{

  "virtualDeviceUUID": "4c2345e5-be63-4261-ba1c-a53a7e4cf5ec",
  "primaryName": "JohnDoeOracle1",
  "profileUUID": "c7f5469b-9618-4d8e-b7dc-9e643rd0a8b8",
  "speed": 50,
  "speedUnit": "MB",
  "notifications": [
    "JohnDoe@equinix.com"
  ],
  "purchaseOrderNumber": "1111",
  "sellerMetroCode": "DC",

  "authorizationKey": "ocid1.virtualcircuit.oc1.iad.aaaaabcdp2mwua7njveex3vmhchwqwyzzka5zrrhbo4wc7uz46pzlqghkzgq",

  "interfaceId": 7,

  "secondaryVirtualDeviceUUID": "7c2845e5-be83-4561-ba2b-a53a7e4cf5ez",

  "secondaryName": "JohnDoeOracle2",

  "secondarySpeed": 50,

  "secondarySpeedUnit": "MB",

  "secondaryAuthorizationKey": "ocid1.virtualcircuit.oc1.iad.sadffgp2mwua7njveex3vmhchwqwyzzka5zrrhbo4wc7uz46pzlqghkzgq",

  "secondaryInterfaceId": 6

}'

 

The description of the body parameters is as follows:

 

Body Parameter Name Mandatory Type Example values Applicable values Description
virtualDeviceUUID Yes string 4c2345e5-be63-4261-ba1c-a53a7e4cf5ec   Unique ID of the virtual device.
primaryName Yes string JohnDoeOracle1   Name of the primary connection - An alpha-numeric 24 characters string which can include only hyphens and underscores ('-' & '_').
profileUUID Yes string c7f5469b-9618-4d8e-b7dc-9e643rd0a8b8   Unique identifier of the provider's service profile.
speed Yes integer 50   Speed/Bandwidth you would like to allocate to the connection. If you do not know the speed, you can call the validateAuthorizationkey API and query using the ExpressRoute service key to obtain the speed.
speedUnit Yes string MB

"MB"

"GB"

Unit of the speed or bandwidth you would like to allocation to the connection.
notifications Yes array string JohnDoe@equinix.com

 

An array of email ids you would like to notify when there are any updates on your connection. Example Object: ["user@organization.com", "user@eu.company.com"]
purchaseOrderNumber Yes string 0987654321   An optional field to link the purchase order numbers to the connection on Equinix which would get reflected on the invoice.
sellerMetroCode Yes string SV   Provider location where you would like to connect. If the sellerMetroCode is empty, the metro code of the port is set as the default seller metro code. 
authorizationKey Yes string ocid1.virtualcircuit.oc1.iad.aaafsderteyrt   Authorization Key obtained from the provider. Example: Service Key from Azure Express Route, Account ID from AWS, Pairing Key from Google Cloud Platform, OCID from Oracle Cloud Infrastructure.
interfaceId No integer 6   Any available interface on the device.
secondaryVirtualDeviceUUID No string 7c2845e5-be83-4561-ba2b-a53a7e4cf5ez  

The unique ID of the secondary virtual device. 

secondaryName No string JohnDoeOracle2    This field represents the name of the secondary connection. An alpha-numeric 24 character string that can only include hyphens and underscores ('-' & '_').
secondarySpeed No integer 50    Speed/Bandwidth you would like to allocate to the optional secondary connection.
secondarySpeedUnit No string MB

"MB"

"GB"

 Unit of the speed or bandwidth of the optional secondary connection.
secondaryAuthorizationKey No string ocid1.virtualcircuit.oc1.iad.sadffgp2mw   Authorization key obtained from the provider for the optional secondary connection. Example: OCID from Oracle Cloud Infrastructure.
secondaryInterfaceId No integer 6   Any available interface on the secondary device.

 

If you get “Access Denied” error, contact your local Equinix Service Desk.

 

Sample response for a virtual device (non HA).

 

{

    "message": "Connection Saved Successfully",
    "primaryConnectionId": "9349a8-0e07-44d0-944c-88a25d8d28f7",

    "status": "SUCCESS"

}

 

Sample response for a virtual device with an additional secondary device for high availability (HA).

 

{
    "message": "Connection Saved Successfully",
    "primaryConnectionId": "939a8-0e07-44d0-944c-86a25d8d38f7",

    "secondaryConnectionId": "7eadc4b3-a44c-4ce9-bdba-ead6d7789342",

    "status": "SUCCESS"
}

 

The description of the response payload is as follows:

 

Field Name Type Example Description
message string Connection created successfully Indicates the status of the API call.
primaryConnectionId string 939a8-0e07-44d0-944c-86a25d8d38f7 Indicates the primary connection ID  of the connection established.
secondaryConnectionId string 7eadc4b3-a44c-4ce9-bdba-ead6d7789342

Optional secondary connection Id in case you have a secondary device for high availability (HA).

status string SUCCESS A message indicating the status of the transaction. 

 

When a connection is created, the connection transitions through various states within the Equinix and Oracle infrastructure. These states can be monitored using the response attributes of the API Get connections {connId}. The "status" attribute indicates the connection status in Equinix and the "providerStatus" indicates the status in Oracle.

 

Equinix States
status providerStatus Description
PROVISIONING NOT_AVAILABLE Connection request has not been yet sent to Oracle.
PROVISIONED PROVISIONING

Connection awaits for acceptance. Connection establishment in progress.

PROVISIONED PROVISIONED Connection established

 

 

When an end-user deletes a connection using the Delete connections {uuid} API,  the connection transitions through the following states within the Equinix infrastructure. 

 

Equinix States under /ne/v1/l2/connections/{connId}
status providerStatus Description

DEPROVISIONING

DEPROVISIONING

Connection disbandment in progress.

DEPROVISIONED DEPROVISIONED

Connection deleted.