Merge branch 'sharady-fcoe-designV2'

Author: robhoes

xapi/design/fcoe-nics.md

@@ -2,49 +2,50 @@
 title: FCoE capable NICs
 layout: default
 design_doc: true
-revision: 1
+revision: 2
 status: proposed
 design_review: 120
 ---
 
 It has been possible to identify the NICs of a Host which can support FCoE.
-This property can be listed in PIF object under PIF_metrics.
+This property can be listed in PIF object under capabilities field with key `FCoE`.
 
 Introduction
 ------------
 
 * FCoE supported on a NIC is a hardware property. With the help of dcbtool, we can identify which NIC support FCoE.
-* The new field `fcoe-supported` added to PIF_metrics will have a boolean value.
-* `True` will state NIC supports FCoE. `False` will state NIC does not supports FCoE.
-* `fcoe-supported` field will be ReadOnly, This field cannot be modified by user.
+* The new field capabilites will be `(string -> string) map` in PIF object. For FCoE capability in PIF capabilties will have field set to `"FCoE" -> "Unsupported"`.
+* `Supported` string will state NIC supports FCoE. `Unsupported` string will state NIC does not supports FCoE.
+* Capabilties `(key, value)` field will be ReadOnly, This field cannot be modified by user.
 
-PIF_metrics
+PIF Object
 -------
 
 New field:
-* Field `PIF_metrics.fcoe_supported` of type `bool`.
-* Default value will be false
+* Field `PIF.capabilties` will be type `(string -> string) map`.
+* Default value of PIF capabilties will have field set to `"FCoE" -> "Unsupported"`.
 
 Xapi Changes
 ------
 
-* Set the field `fcoe_supported` to `true` or `false` depending on output of xcp-networkd call `is_fcoe_supported`.
-* Field `fcoe_supported` can be set during `bring_pif_up` and `set_pif_metrics` call.
-* Field `fcoe_supported` will be set everytime when xapi-restart.
+* Set the field capabilities `FCoE` key to `Unsupported` or `Supported` depending on output of xcp-networkd call `is_fcoe_supported`.
+* Field capabilities `FCoE` can be set during `introduce_internal` when the PIF is created.
+* Field capabilties `FCoE` can be updated during `refresh_all` during PIF scan.
+* The above field will be set everytime when xapi-restart.
 
 XCP-Networkd Changes
 ------
 
 New function:
 * Boolean `bool is_fcoe_supported (string)`
   Argument: the device_name for the PIF.
-* This function returns `true` or false depending on dcbtool output for the device provided.
+* This function returns `true` or `false` depending on dcbtool output for the device provided.
 
 Defaults, Installation and Upgrade
 ------------------------
-* Any newly introduced PIF will have its `fcoe_supported` field as false until xcp-networkd call `is_fcoe_supported` sattes FCoE is supported on the NIC.
-* It includes PIFs obtained after a fresh install of Xenserver, as well as PIFs created using `PIF.introduce` or `PIF.scan`.
-* During an upgrade Xapi Restart will call `bring_pif_up` which then populate the `fcoe_supported` field.
+* Any newly introduced PIF will have its capabilties field set to `"FCoE" -> "Unsupported"` until xcp-networkd call `is_fcoe_supported` states FCoE is supported on the NIC.
+* It includes PIFs obtained after a fresh install of Xenserver, as well as PIFs created using `PIF.introduce` then `PIF.scan`.
+* During an upgrade Xapi Restart will call `refresh_all` which then populate the capabilties field set to `"FCoE"` -> `"Unsupported"`
 
 
 Command Line Interface