Connect to Myself - Parameters Mapping
- Connection between two DOT1Q ports
- Connection between a DOT1Q port and a QINQ port
- Connection between two QINQ ports
- Connection between a QINQ port and a DOT1Q port
Connection between two DOT1Q ports
v3 request
curl -X
POST 'http://api.equinix.com/ecx/v3/l2/connections'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
"primaryName": "Conn-1",
"speed": 1000,
"speedUnit": "MB",
"notifications": [
"test@equinix.com"
],
"purchaseOrderNumber": "1-129105284100",
"primaryPortUUID": "a867f685-41b0-1b07-6de0-320a5c00abdd",
"primaryVlanSTag": "1001",
"primaryZSidePortUUID": "20d32a80-0d61-4333-bc03-707b591ae2f4",
"primaryZSideVlanSTag": "1002"
}'
v4 request
curl -X
POST 'https://api.equinix.com/fabric/v4/connections'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
"type": "EVPL_VC",
"name": "Conn-1",
"order": {
"purchaseOrderNumber": "1-129105284100"
},
"bandwidth": 1000,
"aSide": {
"accessPoint": {
"type": "COLO",
"port": {
"uuid": "a867f685-41b0-1b07-6de0-320a5c00abdd"
},
"linkProtocol": {
"type": "DOT1Q",
"vlanTag": 1001
}
}
},
"zSide": {
"accessPoint": {
"type": "COLO",
"port": {
"uuid": "20d32a80-0d61-4333-bc03-707b591ae2f4"
},
"linkProtocol": {
"type": "DOT1Q",
"vlanTag": 1002
}
}
},
"notifications": [
{
"type": "ALL",
"emails": [
"test@equinix.com"
]
}
]
}'
| 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. The v4 API returns the 201 HTTP status code while the v3 API returns a 200 HTTP status code. | |
| 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 object container 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 object container for A-side connection configuration. |
| - | aSide.accessPoint | - | New object container 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 object container for A-side port configuration. |
| primaryPortUUID | aSide.accessPoint.port.uuid | c791f8cb-5904-9040-8ce0-306a5c00a4ee | A-side port identifier. |
| - | aSide.accessPoint.linkProtocol | - | New object container 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 object container for Z-side connection configuration. |
| - | zSide.accessPoint | - | New object container for Z-side connection access point. |
| - | zSide.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. |
| - | zSide.accessPoint.port | - | New object container for Z-side port configuration. |
| primaryZSidePortUUID | zSide.accessPoint.port.uuid | c791f8cb-5d01-d010-8ce0-306a5c00a4ee | Z-side port identifier. |
| - | zSide.accessPoint.linkProtocol | - | New object container for link protocol configuration. |
| - | zSide.accessPoint.linkProtocol.type | DOT1Q | New parameter that explicitly specifies the encapsulation standard. |
| primaryZSideVlanSTag | zSide.accessPoint.linkProtocol.vlanTag | 123 | DOT1Q encapsulation VLAN tag. |
| - | 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 between a DOT1Q port and 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. The v4 API returns the 201 HTTP status code while the v3 API returns a 200 HTTP status code. | |
| 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 object container 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 object container for A-side connection configuration. |
| - | aSide.accessPoint | - | New object container 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 object container for A-side port configuration. |
| primaryPortUUID | aSide.accessPoint.port.uuid | c791f8cb-5904-9040-8ce0-306a5c00a4ee | A-side port identifier. |
| - | aSide.accessPoint.linkProtocol | - | New object container for link protocol configuration. |
| - | aSide.accessPoint.linkProtocol.type | DOT1Q | 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 object container for Z-side connection configuration. |
| - | zSide.accessPoint | - | New object container for Z-side connection access point. |
| - | zSide.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. |
| - | zSide.accessPoint.port | - | New object container for Z-side port configuration. |
| primaryZSidePortUUID | zSide.accessPoint.port.uuid | c791f8cb-5d01-d010-8ce0-306a5c00a4ee | Z-side port identifier. |
| - | zSide.accessPoint.linkProtocol | - | New object container for link protocol configuration. |
| - | zSide.accessPoint.linkProtocol.type | DOT1Q | New parameter that explicitly specifies the encapsulation standard. |
| primaryZSideVlanSTag | zSide.accessPoint.linkProtocol.vlanTag | 123 | DOT1Q encapsulation VLAN tag. |
| - | 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 between two QINQ ports
| 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. The v4 API returns the 201 HTTP status code while the v3 API returns a 200 HTTP status code. | |
| 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 object container 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 object container for A-side connection configuration. |
| - | aSide.accessPoint | - | New object container 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 object container for A-side port configuration. |
| primaryPortUUID | aSide.accessPoint.port.uuid | c791f8cb-5904-9040-8ce0-306a5c00a4ee | A-side port identifier. |
| - | aSide.accessPoint.linkProtocol | - | New object container 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. |
| - | zSide | - | New object container for Z-side connection configuration. |
| - | zSide.accessPoint | - | New object container for Z-side connection access point. |
| - | zSide.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. |
| - | zSide.accessPoint.port | - | New object container for Z-side port configuration. |
| primaryZSidePortUUID | zSide.accessPoint.port.uuid | c791f8cb-5d01-d010-8ce0-306a5c00a4ee | Z-side port identifier. |
| - | zSide.accessPoint.linkProtocol | - | New object container for link protocol configuration. |
| - | zSide.accessPoint.linkProtocol.type | QINQ | New parameter that explicitly specifies the encapsulation standard. |
| primaryZSideVlanSTag | zSide.accessPoint.linkProtocol.vlanSTag | 123 | QINQ protocol, outer virtual local area network (VLAN) service frame tag used to identify packets as they traverse trunk lines. |
| - | 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 between a QINQ port and 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. The v4 API returns the 201 HTTP status code while the v3 API returns a 200 HTTP status code. | |
| 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 object container 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 object container for A-side connection configuration. |
| - | aSide.accessPoint | - | New object container 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 object container for A-side port configuration. |
| primaryPortUUID | aSide.accessPoint.port.uuid | c791f8cb-5904-9040-8ce0-306a5c00a4ee | A-side port identifier. |
| - | aSide.accessPoint.linkProtocol | - | New object container 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 object container for Z-side connection configuration. |
| - | zSide.accessPoint | - | New object container for Z-side connection access point. |
| - | zSide.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. |
| - | zSide.accessPoint.port | - | New object container for Z-side port configuration. |
| primaryZSidePortUUID | zSide.accessPoint.port.uuid | c791f8cb-5d01-d010-8ce0-306a5c00a4ee | Z-side port identifier. |
| - | zSide.accessPoint.linkProtocol | - | New object container for link protocol configuration. |
| - | zSide.accessPoint.linkProtocol.type | DOT1Q | New parameter that explicitly specifies the encapsulation standard. |
| primaryZSideVlanSTag | zSide.accessPoint.linkProtocol.vlanTag | 123 | DOT1Q encapsulation VLAN tag. |
| - | 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. |