Connect to IBM Cloud Direct Link 2.0 - Parameters Mapping
- Connection to IBM Cloud Direct Link 2.0 from a DOT1Q port
- Connection to IBM Cloud Direct Link 2.0 from a QINQ port
Connection to IBM Cloud Direct Link 2.0 from a DOT1Q port
| v3 API request | v4 API request | Description | |
| POST /ecx/v3/l2/connections | POST /fabric/v4/connections | Request: v4 API introduces a more nested structure and new parameters to accomodate for new use case scenarios involving new entities. Response: v4 API reqest response includes the entire connection object, while the v3 API request returns only a request status message. | |
| v3 parameter | v4 parameter | Example | Description |
| - | type | EVPL_VC | New parameter defining connection type, introduced to support new use cases. EVPL_VC - Ethernet virtual private line connection type used for tagged layer 2 connections. |
| primaryName | name | Connection | Connection name. |
| - | order | - | New container object for order details. |
| purchaseOrderNumber | order.purchaseOrderNumber | 1-129105284100 | Subscriber's purchase order identifier. |
| speed | bandwidth | 1000 | Connection bandwidth. |
| speedUnit | - | - | In the v4 API the connection bandwidth is expressed in Mbps. |
| - | aSide | - | New container object for A-side connection configuration. |
| - | aSide.accessPoint | - | New container object for A-side connection access point. |
| - | aSide.accessPoint.type | COLO | New parameter defining access point type, introduced to support new access points such as Network Edge virtual devices or Fabric Cloud Router instances. COLO - Colocation space in an IBX data center. |
| - | aSide.accessPoint.port | - | New container object for A-side port configuration. |
| primaryPortUUID | aSide.accessPoint.port.uuid | c791f8cb-5904-9040-8ce0-306a5c00a4ee | A-side port identifier. |
| - | aSide.accessPoint.linkProtocol | - | New container object for link protocol configuration. |
| - | aSide.accessPoint.linkProtocol.type | DOT1Q | New parameter that explicitly specifies the encapsulation standard. |
| primaryVlanSTag | aSide.accessPoint.linkProtocol.vlanTag | 124 | DOT1Q encapsulation VLAN tag. |
| - | zSide | - | New container object for Z-side connection configuration. |
| - | zSide.accessPoint | - | New container object for Z-side connection access point. |
| - | zSide.accessPoint.type | SP | New parameter defining access point type, introduced to support new access points such as Network Edge virtual devices or Fabric Cloud Router instances. SP - Service profile. |
| - | zSide.accessPoint.profile | - | New container object for Z-side service profile configuration. |
| profileUUID | zSide.accessPoint.profile.uuid | c791f8cb-5d01-d010-8ce0-306a5c00a4ee | Z-side profile identifier. |
| - | zSide.accessPoint.location | - | New container object for endpoint location configuration. |
| sellerMetroCode | zSide.accessPoint.location.metroCode | SV | Metropolitan area identifier. |
| sellerRegion | zSide.accessPoint.sellerRegion | us-west-1 | Access point seller region. |
| authorizationKey | zSide.accessPoint.authenticationKey | xx-xxx | Access point authentication key. |
| additionalInfo | additionalInfo | - | An array of key-value pairs defining additional connection parameters. |
| additionalInfo.name | additionalInfo.key | ASN | Additional parameter definition. |
| additionalInfo.value | additionalInfo.value | 12345 | Value of the additional parameter. |
| - | notifications | - | New object for email notifications configuration. |
| - | notifications.type | ALL | New parameter enabling differentiation of notifications. |
| notifications | notifications.emails | ["john@equinix.com", "jenkins@equinix.com"] | List of up to 12 recipients. |
Connection to IBM Cloud Direct Link 2.0 from a QINQ port
| v3 API request | v4 API request | Description | |
| POST /ecx/v3/l2/connections | POST /fabric/v4/connections | Request: v4 API introduces a more nested structure and new parameters to accomodate for new use case scenarios involving new entities. Response: v4 API reqest response includes the entire connection object, while the v3 API request returns only a request status message. | |
| v3 parameter | v4 parameter | Example | Description |
| - | type | EVPL_VC | New parameter defining connection type, introduced to support new use cases. EVPL_VC - Ethernet virtual private line connection type used for tagged layer 2 connections. |
| primaryName | name | Connection | Connection name. |
| - | order | - | New container object for order details. |
| purchaseOrderNumber | order.purchaseOrderNumber | 1-129105284100 | Subscriber's purchase order identifier. |
| speed | bandwidth | 1000 | Connection bandwidth. |
| speedUnit | - | - | In the v4 API the connection bandwidth is expressed in Mbps. |
| - | aSide | - | New container object for A-side connection configuration. |
| - | aSide.accessPoint | - | New container object for A-side connection access point. |
| - | aSide.accessPoint.type | COLO | New parameter defining access point type, introduced to support new access points such as Network Edge virtual devices or Fabric Cloud Router instances. COLO - Colocation space in an IBX data center. |
| - | aSide.accessPoint.port | - | New container object for A-side port configuration. |
| primaryPortUUID | aSide.accessPoint.port.uuid | c791f8cb-5904-9040-8ce0-306a5c00a4ee | A-side port identifier. |
| - | aSide.accessPoint.linkProtocol | - | New container object for link protocol configuration. |
| - | aSide.accessPoint.linkProtocol.type | QINQ | New parameter that explicitly specifies the encapsulation standard. |
| primaryVlanSTag | aSide.accessPoint.linkProtocol.vlanSTag | 124 | QINQ protocol, outer virtual local area network (VLAN) service frame tag used to identify packets as they traverse trunk lines. |
| primaryVlanCTag | aSide.accessPoint.linkProtocol.vlanCTag | 125 | QINQ protocol, inner virtual local area network (VLAN) customer frame tag used to identify packets as they traverse trunk lines. |
| - | zSide | - | New container object for Z-side connection configuration. |
| - | zSide.accessPoint | - | New container object for Z-side connection access point. |
| - | zSide.accessPoint.type | SP | New parameter defining access point type, introduced to support new access points such as Network Edge virtual devices or Fabric Cloud Router instances. SP - Service profile. |
| - | zSide.accessPoint.profile | - | New container object for Z-side service profile configuration. |
| profileUUID | zSide.accessPoint.profile.uuid | c791f8cb-5d01-d010-8ce0-306a5c00a4ee | Z-side profile identifier. |
| - | zSide.accessPoint.location | - | New container object for endpoint location configuration. |
| sellerMetroCode | zSide.accessPoint.location.metroCode | SV | Metropolitan area identifier. |
| sellerRegion | zSide.accessPoint.sellerRegion | us-west-1 | Access point seller region. |
| authorizationKey | zSide.accessPoint.authenticationKey | xx-xxx | Access point authentication key. |
| additionalInfo | additionalInfo | - | An array of key-value pairs defining additional connection parameters. |
| additionalInfo.name | additionalInfo.key | ASN | Additional parameter definition. |
| additionalInfo.value | additionalInfo.value | 12345 | Value of the additional parameter. |
| - | notifications | - | New object for email notifications configuration. |
| - | notifications.type | ALL | New parameter enabling differentiation of notifications. |
| notifications | notifications.emails | ["john@equinix.com", "jenkins@equinix.com"] | List of up to 12 recipients. |