Connect to Oracle

End users can create connections to Oracle FastConnect using either a Dot1q port or a QinQ port.

 

The following video shows how to connect to Oracle FastConnect using Equinix Fabric APIs.
Click here to download the postman scripts shown in this demo.

Layer 2 Connection to Oracle FastConnect

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 Client ID and Client Secret under the Getting Access Token section for instructions on how to create client ID and client secret and refer to Requesting Access and Refresh tokens section for instructions on how to call Oauth API to validate and authenticate your credentials.

 

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

2b) Get the Port
Retrieve your allocated Equinix Fabric port information.

 

Refer to GET Port under the API Reference section for instructions on how to retrieve port details. You may skip this step if you already know your port information.

2c) Get Metros
Find all metros where Equinix Fabric is available to check if a connection can be established between the port selected earlier and your desired destination metro.

 

Use this API to identify the metro codes of your source (A-side) and destination (Z-side) for your connection.

 

Refer to GET Metros under the API Reference section for instructions on how to get the metro code. You may skip this step if you already know this information.

2d) Get Service Profile
Identify all service profiles available for a given metro or metros, and select the profile to which you wish to connect.

 

Refer to GET Services under the API Reference section for instructions on how to retrieve service profiles in Equinix Fabric. You may skip this step if you already know the service profile details.

2e) Get ValidateAuthorizationKey
Verify whether your Oracle OCID can be used to create a connection to the seller profile selected earlier.

 

Refer to GET validateAuthorizationKey under the API Reference section for instructions on how to validate your authorization key. 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 /ecx/v3/l2/connections
Method	POST
URL or Endpoint	/ecx/v3/l2/connections
Headers	Authorization, Content-Type
Query Parameters	Not applicable
Body Parameters	primaryName, primaryPortUUID, primaryVlanSTag, primaryVlanCTag, profileUUID, authorizationKey, speed, speedUnit, notifications [...], purchaseOrderNumber, sellerRegion, sellerMetroCode

The POST connections API creates a layer 2 connection between your port and the destination service profile. The authorization token and content-type are the only headers that are passed to this API and a response is received based on the values passed.

 

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

The following screenshots show a sample curl request to create a layer 2 Oracle connection using a Dot1q and QinQ port and a sample JSON response for this API.

 

Should you want to estimate the price of this connection, use the API GET Prices.

Oracle FastConnect connection using a Dot1q port

curl -X
POST "https://api.equinix.com/ecx/v3/l2/connections"
-H "content-type: application/json"
-H "authorization: Bearer qwErtY8zyW1abcdefGHI"
-d '{
  "primaryName": "JohnDoeOracleDot1q",
  "profileUUID": "d7f5769b-9618-4d8e-b7dc-9e68ffd0a8b8",
  "speed": 1,
  "speedUnit": "GB",
  "notifications": [
    "JohnDoe@example.com"
  ],
  "purchaseOrderNumber": "456299",
  "primaryPortUUID": "9f891d3b-973c-73c0-bae0-30ac1885197a",
  "primaryVlanSTag": "786",
  "sellerRegion": "us-ashburn-1",
  "sellerMetroCode": "DC",
  "authorizationKey":
    "ocid1.virtualcircuit.oc1.iad.aaaaaaaafzx4jybgymnyfjfwyxl7f4b6emvp3uast2opcf6z7xzp2lqcnpjq"
}'

Oracle FastConnect connection using a QinQ port

curl -X
POST "https://api.equinix.com/ecx/v3/l2/connections"
-H "content-type: application/json"
-H "authorization: Bearer qwErtY8zyW1abcdefGHI"
-d '{
  "primaryName": "JohnDoeOracleQinQ",
  "profileUUID": "c7f5469b-9618-4d8e-b7dc-9e643rd0a8b8",
  "speed": 1,
  "speedUnit": "GB",
  "notifications": [
    "JohnDoe@example.com"
  ],
  "purchaseOrderNumber": "1111",
  "primaryPortUUID": "7f891e3b-974f-74f0-bae0-30ec1885143a",
  "primaryVlanSTag": "3273",
  "primaryVlanCTag": "1111",
  "sellerRegion": "us-ashburn-1",
  "sellerMetroCode": "DC",
  "authorizationKey":
      "ocid1.virtualcircuit.oc1.iad.aaaaabcdp2mwua7njveex3vmhchwqwyzzka5zrrhbo4wc7uz46pzlqghkzgq"
}'

The description of the body parameters is as follows:

Body Parameter Name	Mandatory	Type	Example values	Applicable values	Description
primaryName	Yes	string	JohnDoeOracleDot1q		User-defined name of the primary connection. Supply an alpha-numeric string, which can include hyphens and underscores ('-' & '_') as special characters (no other special characters are allowed). Max Length: 24 characters
primaryPortUUID	Yes	string	99991d3b-9750-7500-bae0-30ac1885197a		Unique Equinix-assigned ID of the buyer's primary port from where the connection originates.
primaryVlanSTag	Yes	integer	774		S-Tag/Outer-Tag of the primary connection. Range: 2 - 4094
primaryVlanCTag	Yes	string	775		C-Tag/Inner-Tag of the primary connection on the Z side. Range: 2 - 4094
profileUUID	Yes	string	999552b-39b0-49ea-a232005088dc9c86		Unique Equinix-assigned ID of the provider's service profile.
authorizationKey	Yes	string	ocid1.virtualcircuit.oc1.iad.aaafsderteyrty23556		OCID obtained from Oracle Cloud Infrastructure.
speed	No	integer	50		Speed/bandwidth to be allocated to the connection. If you do not know the speed, you can call the validateAuthorizationkey API and query using the OCID to obtain the speed.
speedUnit	No	string	MB		Unit of the speed/bandwidth to be allocated to the connection. Values: Either MB or GB.
notifications	Yes	array string	JohnDoe@example.com		A list of email addresses that are notified when there are any updates on this connection. Example: ["user@example.com", "user2@example.com"]
purchaseOrderNumber	Yes	string	0987654321		This optional field links the purchase order to the connection on Equinix. This link is reflected on the invoice.
sellerRegion	Yes	string	us-ashburn-1		The region in which the seller port resides.
sellerMetroCode	Yes	string	SV		The metro code that denotes the connection’s destination (Z side).  If sellerMetroCode is empty, the value defaults to the metro code of the port.

 

The following table indicates the tagging criteria to be followed when a buyer/customer (A-side) wants to connect to Oracle (Z-side). Ensure to add the correct S tag or C tag based on your port type.

Port Type (A-side)	S-tag required	C-tag required	Port Type ( Z-side)
Dot1q port	Yes	No	Dot1q port
QinQ port	Yes	Yes	Dot1q port

 

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

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

The description of the response payload is as follows:

Field Name	Type	Example values	Description
message	string	Connection Saved Successfully	Indicates the status of the API call.
primaryConnectionID	string	567a8-0e07-44d0-944c-88a25d8d28f7	Indicates the primary connection ID.

 

Once the POST Connections API is successfully called, you may check the status of the connection using the API GET Connections{uuid}.
Should you want to upgrade the speed/bandwidth of this connection, you can use the API PATCH Connections{uuid}.

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{uuid}. The "status" attribute indicates the connection status in Equinix and the "providerStatus" indicates the status in Oracle.

Equinix States under /ecx/v3/l2/connections/{connId}
"status" attribute values	"providerStatus" attribute values	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 API DELETE Connections{uuid} the connection transitions through the following states within the Equinix infrastructure.

Equinix States under /ecx/v3/l2/connections/{connId}
"status" attribute values	"providerStatus" attribute values	Description
DEPROVISIONING	DEPROVISIONING	Connection disbandment in progress.
DEPROVISIONED	DEPROVISIONED	Connection deleted.