- How to Guide
- API Reference
Establish BGP Peering
A BGP session establishes a point-to-point connection between your virtual device and your cloud service provider. To create BGP peers, you must have the following information:
1) A provisioned virtual device with a registered license.
2) A provisioned connection (connectionUUID).
If you have the above information, then you can skip ahead to Step 4 and create BGP peers. Otherwise, follow the steps:
Refer to Network Edge BGP Service for additional information.
Step 1: Authenticate
Submit your user credentials, Client ID, and Client Secret for OAuth2 authentication.
If you are unaware of your user credentials for Network Edge, contact your local Equinix Service Desk.
Step 2: Create/Get virtual devices
a) To create a virtual device, please follow these steps.
You may skip the above step if you have a provisioned device with a registered license.
Step 3: Create/Get connection
a) To connect to your cloud service providers, follow these steps.
You may skip this step if you have a provisioned connection.
Step 4: Create BGP peering
The POST bgp API creates a BGP session to establish a point-to-point connection between your virtual device and cloud service provider.
To obtain an authorization key, refer to Requesting Access and Refresh tokens under the Getting Started section.
A sample curl request to create BGP peering.
-H "Authorization: Bearer CcYxLosIYIIsmCGav5pplU25dLkG"
-H "Content-Type: application/json"
|Body Parameter Name||Mandatory||Type||Example||Possible Values||Description|
|authenticationKey||No||string||pass123||Provide a key value that you can use later to authenticate.|
|connectionUUID||Yes||string||f79eead8-b837-41d3-9095-9b15c2c4996d||UUID of the connection between the virtual device and the cloud service provider.|
|localAsn||Yes||integer||10012||Local ASN (autonomous system number). This is the ASN of your virtual device.|
|localIpAddress||Yes||string||126.96.36.199/30||Local IP Address. This is the IP address of the virtual device in CIDR format.|
|remoteAsn||Yes||integer||10013||Remote ASN (autonomous system number). This is the ASN of the cloud service provider.|
|remoteIpAddress||Yes||string||188.8.131.52||Remote IP address. This is the IP address of the cloud service provider.|
|UUID||string||UUID of the BGP peering.|
|PROVISIONING||BGP peering is provisioning.|
|PROVISIONED||BGP peering is provisioned.|
|FAILED||BGP peering failed.|
Possible BGP states: Idle, Connect, Active, Established, OpenSent, and OpenConfirm.
The BGP states can be only be seen after the BGP is provisioned.
If you get “Access Denied” error, contact your local Equinix Service Desk for Portal access.