Update Xconnect config
Change-Id: I5871406680f215902f232c960a763fb1c87df85f
diff --git a/configuration/xconnect.rst b/configuration/xconnect.rst
index 5bc5fc4..12f39da 100644
--- a/configuration/xconnect.rst
+++ b/configuration/xconnect.rst
@@ -1,13 +1,17 @@
VLAN Cross Connect
==================
-VLAN cross connect creates a L2 bridge between two given ports on the same
-device. Once configured, every packets arriving at one of the port with
-specific VLAN tag will be sent to another port directly. Current
+VLAN cross connect creates a L2 bridge between two given endpoints on the same
+device. Once configured, every packets arriving at one of the endpoints with
+specific VLAN tag will be sent to another endpoint directly. Current
implementation only matches on the outermost VLAN tag. If the packet is double
tagged, the S-tag will be matched and both the S-tag and C-tag will be
persisted.
+.. note::
+ An endpoint could be a physical port number or a logical port load balancer ID.
+ See examples below.
+
VLAN cross connect only works on the same device. If you are looking for
transporting L2 traffic across devices, please refer to :doc:`pseoduwire
<pseudowire>`
@@ -25,12 +29,16 @@
.. code-block:: text
- sr-xconnect-add <deviceId> <vlanId> <port1> <port2>
+ sr-xconnect-add <deviceId> <vlanId> <ep1> <ep2>
- ``deviceId``: device ID, e.g. **of:0000000000000201**
- ``vlanId``: VLAN ID, e.g. **94**
-- ``port1``: One end of the cross connect, e.g. **2**
-- ``port2``: Another end of the cross connect, e.g. **54**
+- ``ep1``: One end point of the cross connect.
+ Use integer to specify physical port number (e.g. **1**).
+ Use ``LB:<key>`` to specify port load balancer key (e.g. **LB:2**)
+- ``ep2``: Another end point of the cross connect.
+ Use integer to specify physical port number (e.g. **3**).
+ Use ``LB:<key>`` to specify port load balancer key (e.g. **LB:4**)
Remove cross connect via CLI
----------------------------
@@ -57,12 +65,12 @@
$ curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{ \
"deviceId": "of:0000000000000201", \
"vlanId": "94", \
- "ports": [ 1, 2 ] \
+ "endpoints": [ 1, 2 ] \
}' 'http://${ONOS-IP}/onos/segmentrouting/xconnect'
- ``deviceId``: device ID, e.g. **of:0000000000000201**
- ``vlanId``: VLAN ID, e.g. **94**
-- ``ports``: endpoints of the cross connect, e.g. **[1, 2]**
+- ``endpoints``: endpoints of the cross connect, e.g. **[1, 2]**
Remove cross connect via REST
-----------------------------