[ovs-dev] datapath-windows: Updated documentation related to int/ext port names
diff mbox

Message ID 1441170600-17773-1-git-send-email-svinturis@cloudbasesolutions.com
State Deferred
Headers show

Commit Message

Sorin Vinturis Sept. 23, 2015, 3:40 p.m. UTC
Signed-off-by: Sorin Vinturis <svinturis@cloudbasesolutions.com>
---
This patch is for both master and 2.4 branch.
---
 INSTALL.Windows.md | 52 +++++++++++++++++++++++++++-------------------------
 1 file changed, 27 insertions(+), 25 deletions(-)

Patch
diff mbox

diff --git a/INSTALL.Windows.md b/INSTALL.Windows.md
index 889bb0b..132f76f 100644
--- a/INSTALL.Windows.md
+++ b/INSTALL.Windows.md
@@ -176,9 +176,9 @@  existing switch, make sure to enable the "Allow Management OS" option for VXLAN
 to work (covered later).
 
 The command to create a new switch named 'OVS-Extended-Switch' using a physical
-NIC named 'Ethernet 1' is:
+NIC named 'Ethernet0' is:
     % New-VMSwitch "OVS-Extended-Switch" -AllowManagementOS $true \
-                   -NetAdapterName "Ethernet 1"
+                   -NetAdapterName "Ethernet0"
 
 Note: you can obtain the list of physical NICs on the host using
 'Get-NetAdapter' command.
@@ -263,21 +263,23 @@  ovs-vswitchd by running 'ovs-appctl exit'.)
 
 07> Add the physical NIC and the internal port to br-pif.
 
-In OVS for Hyper-V, we use 'external' as a special name to refer to the
-physical NICs connected to the Hyper-V switch.  An index is added to this
-special name to refer to the particular physical NIC. Eg. 'external.1' refers
-to the first physical NIC on the Hyper-V switch.
+In OVS for Hyper-V, we use the physical NIC alias name to refer to the
+physical NICs connected to the Hyper-V switch, i.e. 'Ethernet0'.
 
 Note: Currently, we assume that the Hyper-V switch on which OVS extension is
 enabled has a single physical NIC connected to it.
 
-Interal port is the virtual adapter created on the Hyper-V switch using the
+Internal port is the virtual adapter created on the Hyper-V switch using the
 'AllowManagementOS' setting.  This has already been setup while creating the
-switch using the instructions above.  In OVS for Hyper-V, we use a 'internal'
-as a special name to refer to that adapter.
+switch using the instructions above.  In OVS for Hyper-V, we use the alias
+name of the virtual NIC to refer to this adapter. The virtual NIC alias name
+for a switch named 'OVS-Extended-Switch' is 'vEthernet (OVS-Extended-Switch)'.
 
-    % ovs-vsctl add-port br-pif external.1
-    % ovs-vsctl add-port br-pif internal
+Note: The alias name of all physical and virtual NICs on the host is displayed
+using the 'Get-NetAdapter' command.
+
+    % ovs-vsctl add-port br-pif "Ethernet0"
+    % ovs-vsctl add-port br-pif "vEthernet (OVS-Extended-Switch)"
 
 * Dumping the ports should show the additional ports that were just added.
   Sample output shows up as follows:
@@ -286,22 +288,22 @@  as a special name to refer to that adapter.
     system@ovs-system:
             lookups: hit:0 missed:0 lost:0
             flows: 0
-            port 4: internal (internal)   <<< 'AllowManagementOS' adapter on
-                                              Hyper-V switch
+            port 4: vEthernet (OVS-Extended-Switch) (internal) <<< 'AllowManagementOS'
+                                                  adapter on Hyper-V switch
             port 2: br-pif (internal)
             port 1: br-int (internal
-            port 3: external.1            <<< Physical NIC
+            port 3: Ethernet0             <<< Physical NIC
 
     % ovs-vsctl show
     a56ec7b5-5b1f-49ec-a795-79f6eb63228b
         Bridge br-pif
-            Port internal
-                Interface internal
             Port br-pif
                 Interface br-pif
                     type: internal
-            Port "external.1"
-                Interface "external.1"
+            Port "Ethernet0"
+                Interface "Ethernet0"
+            Port "vEthernet (OVS-Extended-Switch)"
+                Interface "vEthernet (OVS-Extended-Switch)"
         Bridge br-int
             Port br-int
                 Interface br-int
@@ -342,19 +344,19 @@  with OVS extension enabled.
     system@ovs-system:
             lookups: hit:0 missed:0 lost:0
             flows: 0
-            port 4: internal (internal)
+            port 4: vEthernet (OVS-Extended-Switch) (internal)
             port 5: ovs-port-a
             port 2: br-pif (internal)
             port 1: br-int (internal
-            port 3: external.1
+            port 3: Ethernet0
 
     % ovs-vsctl show
     4cd86499-74df-48bd-a64d-8d115b12a9f2
         Bridge br-pif
-            Port internal
-                Interface internal
-            Port "external.1"
-                Interface "external.1"
+            Port "vEthernet (OVS-Extended-Switch)"
+                Interface "vEthernet (OVS-Extended-Switch)"
+            Port "Ethernet0"
+                Interface "Ethernet0"
             Port br-pif
                 Interface br-pif
                     type: internal
@@ -391,7 +393,7 @@  Steps to add tunnels
 The Windows Open vSwitch implementation support VXLAN and STT tunnels. To add
 tunnels, the following steps serve as examples.
 
-Note that, any patch ports created between br-int and br-pif MUST be beleted
+Note that, any patch ports created between br-int and br-pif MUST be deleted
 prior to adding tunnels.
 
 01> Add the tunnel port between 172.168.201.101 <-> 172.168.201.102