| Class: BwpFlow (Bandwidth Profile Flow) The Bandwidth Profile Flow, BwpFlow, object class represents the Bandwidth Profile Flow which includes the bandwidth profile parameter CIR, CIRmax, CBS, EIR, EIRmax, EBS, Coupling Flag, Color Mode, Envelope and Rank, and Token Request Offset. The BwpFlow is used with Service Attributes for CarrierEthernetOperatorUni, CarrierEthernetSubscriberUni, CarrierEthernetVuni, as well as OVC and EVC End Points. Reference MEF 10.4 Section 12 and MEF 26.2 Section 17. |
| Element Name: Committed Information Rate Reference: MEF 26.2 §17.1.2 and MEF 10.4 §12.1.2 JSON Name: cir - Type: object |
| Description: cir represents Committed Information Rate. When added to unused committed bandwidth provided from higher-ranked Bandwidth Profile Flows (depending on the value of couplingFlag for the higher-ranked Bandwidth Profile Flows), limits the average rate in bits per second at which Service Frames for this Bandwidth Profile Flow can be declared Green. |
| Allowed values: Class: InformationRate |
| Usage: Common: Required |
| Element Name: The Maximum Committed Information Rate Reference: MEF 26.2 §17.1.2 and MEF 10.4 §12.1.2 JSON Name: cirMax - Type: object |
| Description: cirMax represents Maximum Committed Information Rate. It limits the average rate in bits per second at which Service Frames for this Bandwidth Profile Flow can be declared Green (regardless of unused committed bandwidth from higher-ranked Bandwidth Profile Flows). |
| Allowed values: Class: InformationRate |
| Usage: Common: Required |
| Element Name: Committed Burst Size Reference: MEF 26.2 §17.1.2 and MEF 10.4 §12.1.2 JSON Name: cbs - Type: object |
| Description: cbs represents 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. |
| Allowed values: Class: DataSize |
| Usage: Common: Required |
| 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). |
| Element Name: Excess Information Rate Reference: MEF 26.2 §17.1.2 and MEF 10.4 §12.1.2 JSON Name: eir - Type: object |
| Description: eir represents Excess Information Rate. When added to unused excess bandwidth from higher-ranked Bandwidth Profile Flows, and to un-used committed bandwidth (depending on the value of couplingFlag for this Bandwidth Profile Flow and couplingFlagForIndexZero for the Envelope), limits the average rate in bits per second at which Service Frames for this Bandwidth Profile Flow can be declared Yellow. |
| Allowed values: Class: InformationRate |
| Usage: Common: Required |
| Element Name: Maximum Excess Information Rate Reference: MEF 26.2 §17.1.2 and MEF 10.4 §12.1.2 JSON Name: eirMax - Type: object |
| Description: eirMax represents Maximum Excess Information Rate. It limits the average rate in bits per second at which Service Frames for this Bandwidth Profile Flow can be declared Yellow (regardless of unused excess bandwidth from higher-ranked Bandwidth Profile Flows or unused committed bandwidth). |
| Allowed values: Class: InformationRate |
| Usage: Common: Required |
| Element Name: Excess Burst Size Reference: MEF 26.2 §17.1.2 and MEF 10.4 §12.1.2 JSON Name: ebs - Type: object |
| Description: ebs represents 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. |
| Allowed values: Class: DataSize |
| Usage: Common: Required |
| 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). |
| Element Name: Coupling Flag Reference: MEF 26.2 §17.1.2 and MEF 10.4 §12.1.2 JSON Name: couplingFlag - Type: boolean |
| Description: The couplingFlag determines whether unused committed bandwidth for this Bandwidth Profile Flow is made available as excess bandwidth for this Bandwidth Profile Flow or as committed bandwidth for the next lower-ranked 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. |
| Allowed values: |
| Usage: Common: Required |
| Validation Notes: This must be 0 (FALSE) if Envelope.couplingFlagForIndexZero is 1 (TRUE) |
| Element Name: Color Mode Reference: MEF 26.2 §17.1.2 and MEF 10.4 §12.1.2 JSON Name: colorMode - Type: enum |
| Description: colorMode indicates whether or not Service Frames for this Bandwidth Profile Flow that are identified as Yellow on input to the Bandwidth Profile Algorithm can be declared Green. |
| Allowed values: Enum: "COLOR_BLIND", "COLOR_AWARE" |
| Usage: Common: Required |
| Element Name: Envelope Name Reference: MEF 26.2 §17.1.2 and MEF 10.4 §12.1.2 JSON Name: envelopeId - Type: string |
| Description: The name of the envelope that this Bandwidth Profile Flow resides in. |
| Allowed values: String: Min Length: 1 Max Length: 45 Pattern (regex): [\x20-\x7F]+ |
| Usage: Common: Required |
| 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 (i.e. OperatorUNI.envelopes, SubscriberUNI.envelopes, or EnniService.envelopes. All Bandwidth Profile Flows in the same envelope **must** satisfy the same criterion listed in R230 of MEF 26.2. |
| Element Name: Envelope Rank Reference: MEF 26.2 §17.1.2 and MEF 10.4 §12.1.2 JSON Name: envelopeRank - Type: integer |
| Description: The rank in the envelope of this Bandwidth Profile Flow |
| Allowed values: Minimum: 1 |
| Usage: Common: Required |
| Element Name: Token Request Offset Field Reference: MEF 26.2 §17.1.2 and MEF 10.4 §12.1.2 JSON Name: tokenRequestOffset - Type: integer |
| Description: tokenRequestOffset adjusts the bandwidth consumed by each Service Frame in the Bandwidth Profile Flow by a fixed number of octets. |
| Allowed values: [Any Integer] |
| Usage: Common: Required |
| Class: Envelope (Envelope) Bandwidth Profiles are organized into Envelopes. Multiple Bandwidth Profiles in an envelope can share bandwidth resources. Each Envelope has a name and a Coupling Flag for Index Zero (CF0) that indicates whether unused green tokens are discarded or converted to yellow tokens. All Bandwidth Profile Flows in the same envelope satisfy the same criterion listed in R230 of MEF 26.2. |
| Element Name: Envelope Name Reference: MEF 10.4 §9.12 and MEF 26.2 §14.19 JSON Name: envelopeID - Type: string |
| Description: The attribute is a string that identifies the Envelope |
| Allowed values: String: Min Length: 1 Max Length: 45 Pattern (regex): [\x20-\x7F]+ |
| Usage: Common: Required |
| Element Name: Envelope CF0 Reference: MEF 10.4 §9.12 and MEF 26.2 §14.19 JSON Name: couplingFlagForIndexZero - Type: boolean |
| Description: This attribute denotes the coupling flag for index zero. FALSE for 0 (overflow Green tokens are discarded) and TRUE for 1 (overflow Green tokens can be used as Yellow tokens). |
| Allowed values: |
| Usage: Common: Required |
| Class: BandwidthProfilePerClassOfServiceName (COS Bandwidth Profile) This Class is used for both the Ingress Bandwidth Profile per Class of Service Name (MEF 26.2 §16.12) and Egress Bandwidth Profile per Egress Equivalence Class Name (MEF 26.2 §16.13) . The value is a list of pairs of the form〈x, y〉 where x is a Class of Service Name that is in the value of the OVC List of Class of Service Names Service Attribute (Section 12.12) for the OVC that associates the OVC End Point for Ingress and an Egress Equvalence Class Name for Egress. And y, if specified, is a reference to a Bandwidth Profile Flow. There is at most one pair in the list for each CoS or EEC Name (Except Discard). |
| Element Name: CoS or EEC Name Reference: MEF 26.2 §16.12 and 16.13 JSON Name: classOfServiceName - Type: string |
| Description: 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 Egress Equivalence Class (EEC) Name. |
| Allowed values: [Any String] |
| Usage: Common: Required |
| Element Name: CoS Bandwidth Profile JSON Name: bwpFlow - Type: List of object |
| Description: The Bandwidth Profile to be applied to all items that are in the specified Class of Service or Egress Equivalence Class. |
| Allowed values: List of [0...1] Class: BwpFlow |
| Usage: Common: Required |