MEF 106 and MEF 125 Standard

Author: MichalLaczynskiAmartus

productSchema/carrierEthernet/common/carrierEthernetBandwidthProfile.yaml renamed to productSchema/carrierEthernet/carrierEthernetCommon/carrierEthernetBandwidthProfile.yaml

@@ -2,8 +2,8 @@
 "$schema": http://json-schema.org/draft-07/schema#
 title:
 MEF LSO Sonata - Carrier Ethernet Bandwidth Profile
-# MEF Forum - Date: 20220601 Edit-level: 343
-# File: carrierEthernet/common/carrierEthernetBandwidthProfile.yaml
+# MEF Forum - Date: 20220908 Edit-level: 388
+# File: carrierEthernet/carrierEthernetCommon/carrierEthernetBandwidthProfile.yaml
 #
 # ---------------------
 # Disclaimer
@@ -88,8 +88,11 @@ definitions:
 Committed Burst Size. Limits by how much, and for how long, the
 amount of traffic declared Green for this Bandwidth Profile Flow
 in the short term can exceed the committed bandwidth made available
-to this Bandwidth Profile Flow over the long term, in bytes.
- # See additional validation notes in the Schema Guide
+to this Bandwidth Profile Flow over the long term, in bytes. ***
+Validation Notes: If cir and/or cirmax are greater than 0, cbs
+must be greater than 0. MEF 23.2 recommends that cbs should be
+at least twice the Maximum Frame size (although in practice it
+is usually quite a bit more than that).
  $ref: "carrierEthernetUtilityClasses.yaml#/definitions/DataSize"
 eir:
 description: >-
@@ -116,8 +119,11 @@ definitions:
 Excess Burst Size. It limits by how much, and for how long, the
 amount of traffic declared Yellow for this Bandwidth Profile Flow
 in the short term can exceed the excess bandwidth made available
-to this Bandwidth Profile Flow over the long term.
- # See additional validation notes in the Schema Guide
+to this Bandwidth Profile Flow over the long term. *** Validation
+Notes: If eir and/or eirmax are greater than 0, ebs must be greater
+than 0. Similar to cbs, ebs should be at least twice the Maximum
+Frame size (although in practice it is usually quite a bit more
+than that).
  $ref: "carrierEthernetUtilityClasses.yaml#/definitions/DataSize"
 couplingFlag:
 description: >-
@@ -128,7 +134,8 @@ definitions:
 Bandwidth Profile Flow. 0/FALSE means overflow green tokens are
 used as green tokens in the next lowest BWP Flow in the Envelope.
 1/TRUE means they are used as yellow tokens for this BWP Flow.
- # See additional validation notes in the Schema Guide
+*** Validation Notes: This must be 0 (FALSE) if Envelope.couplingFlagForIndexZero
+is 1 (TRUE)
  type: boolean
 colorMode:
 description: >-
@@ -143,8 +150,16 @@ definitions:
 envelopeId:
 description: >-
 MEF 26.2 sec. 17.1.2 and MEF 10.4 sec. 12.1.2 - The name of
-the envelope that this Bandwidth Profile Flow resides in.
- # See additional validation notes in the Schema Guide
+the envelope that this Bandwidth Profile Flow resides in. *** Validation
+Notes: This must match an Envelope ID in exactly one of the Envelopes
+at the External Interface where this Bandwidth Profile Flow is
+applied: For Operator Ethernet Services: OperatorUNI.envelopes,
+EnniService.envelopes, AccessElineOvcEpCommon.ovcEndPointEnvelopes.
+For Subscriber Ethernet Services: SubscriberUNI.envelopes,
+CarrierEthernetEvcEpNotEpl.evcEndPointEnvelopes. All Bandwidth
+Profile Flows in the same envelope must satisfy the same criterion
+listed in R230 of MEF 26.2 for Operator Ethernet Services and R165
+of MEF 10.4 for Subscriber Ethernet Services.
  type: string
 minLength: 1
 maxLength: 45
@@ -210,11 +225,14 @@ definitions:
 description: >-
 MEF 26.2 sec. 16.12 and 16.13 - For Ingress, this is the Name
 of the Class of Service that this bandwidth profile flow is applied
-to. This should be an item from ovc.listOfClassOfServiceNames.
-For Egress, this is the Class of Service for EVCs and the Egress
-Equivalence Class (EEC) Name for OVCs. If the specific Class of
-Service/ Egress Equivalence Class is not used/configured that the
-End Point, the Bandwidth Profile can be an empty list.
+to. For Operator Ethernet Services this should be an item from
+ovc.listOfClassOfServiceNames and for Subscriber Ethernet Services
+this should be an item from evc.listOfClassOfServiceNames.
+For Egress, for Operator Ethernet Services this is the OVC Egress
+Equivalence Class (EEC) Name and for Subscriber Ethernet Services
+this is the EVC Class of Service. If the specific Egress Equivalence
+Class/Class of Service is not used/configured at the End Point,
+then the Bandwidth Profile can be an empty list.
  type: string
 bwpFlow:
 description: >-

productSchema/carrierEthernet/common/carrierEthernetClassOfService.yaml renamed to productSchema/carrierEthernet/carrierEthernetCommon/carrierEthernetClassOfService.yaml

@@ -2,8 +2,8 @@
 "$schema": http://json-schema.org/draft-07/schema#
 title:
 MEF LSO Sonata - Carrier Ethernet Class of Service
-# MEF Forum - Date: 20220601 Edit-level: 343
-# File: carrierEthernet/common/carrierEthernetClassOfService.yaml
+# MEF Forum - Date: 20220908 Edit-level: 388
+# File: carrierEthernet/carrierEthernetCommon/carrierEthernetClassOfService.yaml
 #
 # ---------------------
 # Disclaimer
@@ -52,20 +52,21 @@ title:
 # ---------------------
 #
 definitions:
-CosFromEp:
+CosNameFromEp:
 type: object
 description: >-
-Ingress CoS is specified as {F,M,P}. This is when F=OVC_EP
-or EVC_EP as appropriate.
+Ingress CoS Name is derived from {F,M,P} where F=OVC_EP or
+EVC_EP as appropriate.
  properties:
 mapType:
 description: The field that indicates F = EVC/OVC EP.
 type: string
 enum:
 - "ENDPOINT"
 map_M:
-description: The single CoS Name at this EVC/OVC EP
-# See additional validation notes in the Schema Guide
+description: >-
+The single CoS Name at this EVC/OVC EP *** Validation Notes:
+The value must be in the listOfClassOfServiceNames for the EVC/OVC.
  type: string
 l2cp_P:
 description: This specifies the CoS Name for L2CPs carried over the EVC/OVC.
@@ -74,10 +75,10 @@ definitions:
 uniqueItems: TRUE
 items:
 $ref: "#/definitions/CosL2cp"
-CosFromCtagPcp:
+CosNameFromCtagPcp:
 type: object
 description: >-
-Ingress CoS is specified as {F,M,P}. This is when F=C_TAG_PCP.
+Ingress CoS Name is derived from {F,M,P} where F=C_TAG_PCP.
 This maps each of the 8 PCP values in the C-tag to a Class of Service
 Name. It also maps UNTAGGED frames to a Class of Service Name.
  properties:
@@ -125,51 +126,15 @@ definitions:
 pcpCosName:
 description: >-
 A CoS Name from the EVC/OVC List of Class of Service Names
-Service Attribute.
- # See additional validation notes in the Schema Guide
-type: string
-CosFromStagPcp:
-type: object
-description: >-
-Ingress CoS is specified as {F,M,P}. This is when F=S_TAG_PCP.
-This maps each of the 8 PCP values in the S-tag to a Class of Service
-Name.
- properties:
-mapType:
-description: The Field that indicates F = S_TAG_PCP.
-type: string
-enum:
-- "S_TAG_PCP"
-map_M:
-description: A list of 8 PCP values and their associated CoS Names
-type: array
-minItems: 8
-maxItems: 8
-uniqueItems: TRUE
-items:
-$ref: "#/definitions/CosEnniPcpMapEntry"
-l2cp_P:
-description: This specifies the CoS Name for L2CPs carried over the OVC.
-# See additional validation notes in the Schema Guide
-type: array
-minItems: 0
-uniqueItems: TRUE
-items:
-$ref: "#/definitions/CosL2cp"
-CosEnniPcpMapEntry:
-type: object
-description: 2-tuple {PCP, CoSName} that maps a PCP to a CoS Name or DISCARD.
-properties:
-pcpVal:
-$ref: "carrierEthernetTypes.yaml#/definitions/PcpValue"
-pcpCosName:
+Service Attribute. *** Validation Notes: The CoS Name must be in
+listOfClassOfServiceNames for the EVC/OVC.
  type: string
-CosFromDscp:
+CosNameFromDscp:
 type: object
 description: >-
-Ingress CoS is specified as {F,M,P}. This is when F=DSCP. This
-maps groups of DSCP values (independently for ipV4 and ipV6) to
-a Class of Service. It also provides a Class of Service mapping
+Ingress CoS Name is derived from {F,M,P} where F=DSCP. This
+maps groups of DSCP values (independently for IPv4 and IPv6) to
+a Class of Service Name. It also provides a Class of Service mapping
 for DSCP values that are not specified and for frames that do not
 contain IP Packets.
  properties:
@@ -200,8 +165,9 @@ definitions:
 dscpValueCoSList:
 description: >-
 This is a list of DSCP to CoS Map Entries: {ipv4DSCPs, ipv6DSCPs,
-CoSName}
- # See additional validation notes in the Schema Guide
+CoSName} *** Validation Notes: The ipV4 DSCP values in the different
+entries in the list must not overlap. The ipV6 DSCP values in the
+different entries in the list must not overlap.
  type: array
 minItems: 0
 uniqueItems: TRUE

productSchema/carrierEthernet/common/carrierEthernetColorIdentifier.yaml renamed to productSchema/carrierEthernet/carrierEthernetCommon/carrierEthernetColorIdentifier.yaml

@@ -2,8 +2,8 @@
 "$schema": http://json-schema.org/draft-07/schema#
 title:
 MEF LSO Sonata - Carrier Ethernet Color Identifier
-# MEF Forum - Date: 20220601 Edit-level: 343
-# File: carrierEthernet/common/carrierEthernetColorIdentifier.yaml
+# MEF Forum - Date: 20220908 Edit-level: 388
+# File: carrierEthernet/carrierEthernetCommon/carrierEthernetColorIdentifier.yaml
 #
 # ---------------------
 # Disclaimer
@@ -87,9 +87,9 @@ definitions:
 type: object
 properties:
 pcpValue:
-$ref: "carrierEthernetTypes.yaml#/definitions/PcpValue"
+$ref: "carrierEthernetEnums.yaml#/definitions/PcpValue"
 pcpColor:
-$ref: "carrierEthernetTypes.yaml#/definitions/FrameColor"
+$ref: "carrierEthernetEnums.yaml#/definitions/FrameColor"
 ColorFromDscp:
 type: object
 description: >-
@@ -123,9 +123,9 @@ definitions:
 minimum: 0
 maximum: 63
 ipv4Color:
-$ref: "carrierEthernetTypes.yaml#/definitions/FrameColor"
+$ref: "carrierEthernetEnums.yaml#/definitions/FrameColor"
 ipv6Color:
-$ref: "carrierEthernetTypes.yaml#/definitions/FrameColor"
+$ref: "carrierEthernetEnums.yaml#/definitions/FrameColor"
 ColorFromEp:
 type: object
 description: >-
@@ -138,5 +138,5 @@ definitions:
 enum:
 - "ENDPOINT"
 epColor:
-$ref: "carrierEthernetTypes.yaml#/definitions/FrameColor"
+$ref: "carrierEthernetEnums.yaml#/definitions/FrameColor"
 

productSchema/carrierEthernet/common/carrierEthernetTypes.yaml renamed to productSchema/carrierEthernet/carrierEthernetCommon/carrierEthernetEnums.yaml

@@ -1,9 +1,9 @@
 ---
 "$schema": http://json-schema.org/draft-07/schema#
 title:
-MEF LSO Sonata - Carrier Ethernet Types
-# MEF Forum - Date: 20220601 Edit-level: 343
-# File: carrierEthernet/common/carrierEthernetTypes.yaml
+MEF LSO Sonata - Carrier Ethernet Enums
+# MEF Forum - Date: 20220908 Edit-level: 388
+# File: carrierEthernet/carrierEthernetCommon/carrierEthernetEnums.yaml
 #
 # ---------------------
 # Disclaimer
@@ -142,4 +142,30 @@ definitions:
 - "WEEK"
 - "MONTH"
 - "YEAR"
+InformationRateUnits:
+description: Enum of information rates (such as MBPS)
+type: string
+enum:
+- "BPS"
+- "KBPS"
+- "MBPS"
+- "GBPS"
+- "TBPS"
+- "PBPS"
+- "EBPS"
+- "ZBPS"
+- "YBPS"
+DataSizeUnits:
+description: Data size in multiples of bytes (e.g., BYTES or MBYTES)
+type: string
+enum:
+- "BYTES"
+- "KBYTES"
+- "MBYTES"
+- "GBYTES"
+- "TBYTES"
+- "PBYTES"
+- "EBYTES"
+- "ZBYTES"
+- "YBYTES"
 

productSchema/carrierEthernet/common/carrierEthernetExternalInterfaces.yaml renamed to productSchema/carrierEthernet/carrierEthernetCommon/carrierEthernetExternalInterfaces.yaml

@@ -2,8 +2,8 @@
 "$schema": http://json-schema.org/draft-07/schema#
 title:
 MEF LSO Sonata - Carrier Ethernet External Interfaces
-# MEF Forum - Date: 20220601 Edit-level: 343
-# File: carrierEthernet/common/carrierEthernetExternalInterfaces.yaml
+# MEF Forum - Date: 20220908 Edit-level: 388
+# File: carrierEthernet/carrierEthernetCommon/carrierEthernetExternalInterfaces.yaml
 #
 # ---------------------
 # Disclaimer
@@ -54,19 +54,12 @@ title:
 definitions:
 UniPhysicalLink:
 description: >-
-This class describes the Physical Link attributes at a UNI.
-It is a 6-tuple ⟨id, phy, frequency sync enable, PTP enable, connector,
-gender⟩.
+This class is the composition of the generic physical link
+attributes CarrierEthernetPhysicalLink and the UNISpecificAttributes.
  allOf:
+# This specifies the physical link id and PHY type
 - $ref: "#/definitions/CarrierEthernetPhysicalLink"
 - $ref: "#/definitions/UniSpecificAttributes"
-EnniPhysicalLink:
-description: >-
-This class describes the Physical Link attributes at an ENNI.
-It consists of the Carrier Ethernet Physical Links (id and physical
-link type) with no elements.
- allOf:
-- $ref: "#/definitions/CarrierEthernetPhysicalLink"
 CarrierEthernetPhysicalLink:
 type: object
 description: >-
@@ -198,24 +191,26 @@ definitions:
 - "400GBASE_SR4_2"
 - "400GBASE_SR8"
 - "OTHER"
-autoNegotiation:
-description: >-
-IEEE Std 802.3-2018 Clause 28 and 37 - Indicates whether 802.3
-autonegotiation is enabled on the UNI link.
- $ref: "carrierEthernetTypes.yaml#/definitions/EnabledDisabled"
 UniSpecificAttributes:
 type: object
+description: >-
+This is a 5-tuple that specifies UNI specific link attributes
+(in addition to the general physical link attributes). The components
+of the 5-tuple are: (1) whether Synchronous Ethernet is enabled
+or disabled, (2) whether PTP is used on the link, (3) UNI connector
+type, (4) the UNI connector gender, and (5) whether autonegotiation
+is used on the link.
  properties:
 synchronousEthernet:
 description: >-
 Indicates if synchronous Ethernet is used on the physical link
 and has the value either Enabled or Disabled.
- $ref: "carrierEthernetTypes.yaml#/definitions/EnabledDisabled"
+ $ref: "carrierEthernetEnums.yaml#/definitions/EnabledDisabled"
 precisionTiming:
 description: >-
 Indicates if the Precision Time Protocol is used on the physical
 link and has the value either Enabled or Disabled
- $ref: "carrierEthernetTypes.yaml#/definitions/EnabledDisabled"
+ $ref: "carrierEthernetEnums.yaml#/definitions/EnabledDisabled"
 uniConnectorType:
 description: >-
 This indicates the type of connector that is presented to the
@@ -234,23 +229,9 @@ definitions:
 enum:
 - "SOCKET"
 - "PLUG"
-VirtualFrameMap:
-type: object
-description: >-
-A map for virtual frame mapping. The absence of this attribute
-corresponds to a Service Attribute value of Not Applicable. Reference
-MEF 10.4 Section 9.3 Subscriber UNI Virtual Frame Map Service Attribute.
- properties:
-vfMap:
+autoNegotiation:
 description: >-
-MEF 10.4 sec. 9.2 and sec. 9,3 - When the value of the Subscriber
-UNI Instantiation Service Attribute = Virtual, there must exist
-a map that maps the set of Virtual Frames that cross the UNI to
-a sequence of pairs of the form〈s,t where s is a standard Ethernet
-frame per Clause 3 of IEEE Std 802.3 – 2015 [5] and t is the arrival
-time at the UNI for all bits in s. Since MEF 10.4 does not specify
-the contents or format of this map, it is currently defined as
-an arbitrary length string.
- type: string
-minLength: 0
+IEEE Std 802.3-2018 Clause 28 and 37 - Indicates whether 802.3
+autonegotiation is enabled on the UNI link.
+ $ref: "carrierEthernetEnums.yaml#/definitions/EnabledDisabled"