New Layer1AggregationProfile

[openBackhaul]

Problem:
To create a Layer 1 aggregation, the LTP::ClientLTP and LTP::ServerLTP attributes must be redirected.
Other changes may be required as part of such a configuration change (e.g. removing VlanLtp from VlanFd and VlanFc).
While dismantling a Layer 1 aggregation, potentially LTP objects have to be created.
Operators should not touch these attributes and particularly shall not create LTPs.
To avoid catastrophic misconfigurations and conflicting configuration artifacts, the processing of Layer 1 aggregation configurations should be supported by RPCs.
While defining the deleteRPC, it turned out to be advantageous, if there would be a logical object that would represent the aggregation group and could be referenced.

[openBackhaul]

Decision during the LF ONMI x-haul call on 28th of May 2025:

• A new Layer1AggregationProfile modelling shall be defined.
  It shall be used for augmenting the Profile class whenever its profileName attribute=="PROFILE_NAME_TYPE_LAYER_1_AGGREGATION_PROFILE".

• It shall comprise the following classes:

  • Layer1AggregationProfileSpec
  • Layer1AggregationProfile_Pac
  • Layer1AggregationProfileConfiguration
  • Layer1AggregationProfileStatus

• The following associations shall connect these classes:

  • A composite association from Layer1AggregationProfileSpec [1] to Layer1AggregationProfile_Pac [1]
  • A composite association from Layer1AggregationProfile_Pac [1] to Layer1AggregationProfileConfiguration [1]
  • A composite association from Layer1AggregationProfile_Pac [1] to Layer1AggregationProfileStatus [1]

• The Layer1AggregationProfileConfiguration class shall hold the following attributes (Please regard that these attributes are read-only. They get modified by RPCs.):

  • aggregationGroupIsOn : Boolean [1] = true which is holding the following comment: "If true, the layer 1 aggregation group is configured to be activated, so it is forwarding traffic to the serving layers."
  • _clientLtp : LTP [1] which is holding the following comment: "UUID of the LTP with LayerProtocol::layerProtocolName==LAYER_PROTOCOL_NAME_TYPE_ETHERNET_CONTAINER_LAYER that is configured to be transported by a group of LTPs with LayerProtocol::layerProtocolName==LAYER_PROTOCOL_NAME_TYPE_HYBRID_MW_STRUCTURE_LAYER or LAYER_PROTOCOL_NAME_TYPE_PURE_ETHERNET_STRUCTURE_LAYER."
  • _serverLtpList : LTP [*] which is holding the following comment: "List of UUIDs of a group of LTPs with LayerProtocol::layerProtocolName==LAYER_PROTOCOL_NAME_TYPE_HYBRID_MW_STRUCTURE_LAYER or LAYER_PROTOCOL_NAME_TYPE_PURE_ETHERNET_STRUCTURE_LAYER that are configured to transport an LTP with LayerProtocol::layerProtocolName==LAYER_PROTOCOL_NAME_TYPE_ETHERNET_CONTAINER_LAYER."

• The Layer1AggregationProfileStatus class shall hold the following attributes:

  • aggregationGroupIsUp : Boolean [1] = false which is holding the following comment: "If true, the layer 1 aggregation group is currently activated and forwarding traffic to the serving layers."
  • _clientLtp : LTP [1] which is holding the following comment: "UUID of the LTP with LayerProtocol::layerProtocolName==LAYER_PROTOCOL_NAME_TYPE_ETHERNET_CONTAINER_LAYER that is transported by a group of LTPs with LayerProtocol::layerProtocolName==LAYER_PROTOCOL_NAME_TYPE_HYBRID_MW_STRUCTURE_LAYER or LAYER_PROTOCOL_NAME_TYPE_PURE_ETHERNET_STRUCTURE_LAYER."
  • _serverLtpList : LTP [*] which is holding the following comment: "List of UUIDs of a group of LTPs with LayerProtocol::layerProtocolName==LAYER_PROTOCOL_NAME_TYPE_HYBRID_MW_STRUCTURE_LAYER or LAYER_PROTOCOL_NAME_TYPE_PURE_ETHERNET_STRUCTURE_LAYER that are transporting an LTP with LayerProtocol::layerProtocolName==LAYER_PROTOCOL_NAME_TYPE_ETHERNET_CONTAINER_LAYER."

• The Layer1AggregationProfile shall also comprise a Layer1AggregationProfileOperations interface.
  This interface shall comprise the following RPCs:

  • createLayer1AggregationProfile() with comment "Creates a Layer1Aggregation with the group of UUIDs of LTPs of layer protocol name HybridMwStructure or PureEthernetStructure and returns the UUID of the resulting Layer1Aggregation Profile. Existing configurations made obsolete by this configuration change are purged in the background. The following error-messages are to be send, if the operation would fail:
    #[onf:Referenced object is invalid.]#, if any of the referenced objects does not exist or is of the wrong type.
    #[onf:Referenced object is not capable.]#, if the interface represented by any of the referenced HybridMwStructure or PureEthernetStructure is not supporting being added to the aggregation group.
    #[onf:Wished change contradicts existing configuration.]#, if the interface represented by any of the referenced HybridMwStructure or PureEthernetStructure is already in use in another aggregation group.
    #[onf:Wished changes are not consistent. ]#, if e.g. the group of referenced HybridMwStructure or PureEthernetStructure is not complete for creating the aggregation group.
    #[onf:Resources not available.]#, if the maximum number of aggregation groups has already been configured.
    #[onf:Configuration value out of range of hardware capabilities.]#, if the device is not supporting switching aggregation groups on/off during instantiation."
  • updateLayer1AggregationProfile() with comment "Updates the configuration of the referenced layer1AggregationProfile with the group of UUIDs of LTPs of layer protocol name HybridMwStructure or PureEthernetStructure and the status of the on/off switch and returns the UUID of the resulting Layer1Aggregation Profile. Existing configurations made obsolete by this configuration change are purged in the background. The following error-messages are to be send, if the operation would fail:
    #[onf:Referenced object is invalid.]#, if any of the referenced objects does not exist or is of the wrong type.
    #[onf:Referenced object is not capable.]#, if the interface represented by any of the referenced HybridMwStructure or PureEthernetStructure is not supporting being added to the aggregation group.
    #[onf:Wished change contradicts existing configuration.]#, if the interface represented by any of the referenced HybridMwStructure or PureEthernetStructure is already in use in another aggregation group.
    #[onf:Wished changes are not consistent. ]#, if e.g. the group of referenced HybridMwStructure or PureEthernetStructure is not complete for creating the aggregation group.
    #[onf:Configuration value out of range of hardware capabilities.]#, if the device is not supporting switching aggregation groups on/off."
  • deleteLayer1AggregationProfile() with comment "Deletes the Layer1Aggregation that is identified in the input and creates all logical objects that are required for representing the initial state of the device again. The following error-message is to be send, if the operation would fail:
    #[onf:Layer1AggregationProfile cannot be deleted.]#, if the referenced object cannot be deleted."
  • provideCapabilitiesOfLayer1Aggregation() with comment "Defines the general capabilities of the layer 1 aggregation implementation on the device."
  • provideCapabilitiesOfLayer1AggregationGroup() with comment "Defines the capabilities that are specific to the referenced layer 1 aggregation group. The following error-message is to be send, if the operation would fail:
    #[onf:Referenced object is invalid.]#, if the referenced objects does not exist or is of the wrong type."

• The createLayer1AggregationProfile operation shall handle the following attributes:

  • in: _servingStructureList : LTP [*] with comment "List of UUIDs of LogicalTerminationPoints with LayerProtocol::layerProtocolName==LAYER_PROTOCOL_NAME_TYPE_HYBRID_MW_STRUCTURE_LAYER or LAYER_PROTOCOL_NAME_TYPE_PURE_ETHERNET_STRUCTURE_LAYER."
  • in: aggregationGroupIsOn : Boolean [1] with comment "If true, the layer 1 aggregation group will be configured to be activated, so it is forwarding traffic to the serving layers."
  • out: _resultingLayer1AggregationProfile : Profile [1] with comment "UUID of the resulting Profile with profileName==PROFILE_NAME_TYPE_LAYER_1_AGGREGATION_PROFILE that has just been created."

• The updateLayer1AggregationProfile operation shall handle the following attributes:

  • in: _layer1AggregationProfile : Profile [1] with comment "UUID of an existing Profile with profileName==PROFILE_NAME_TYPE_LAYER_1_AGGREGATION_PROFILE that shall be re-configured."
  • in: _servingStructureList : LTP [*] with comment "List of UUIDs of LogicalTerminationPoints with LayerProtocol::layerProtocolName==LAYER_PROTOCOL_NAME_TYPE_HYBRID_MW_STRUCTURE_LAYER or LAYER_PROTOCOL_NAME_TYPE_PURE_ETHERNET_STRUCTURE_LAYER."
  • in: aggregationGroupIsOn : Boolean [1] with comment " If true, the layer 1 aggregation group will be configured to be activated, so it is forwarding traffic to the serving layers."
  • out: _resultingLayer1AggregationProfile : Profile [1] with comment "UUID of the Profile with profileName==PROFILE_NAME_TYPE_LAYER_1_AGGREGATION_PROFILE that resulted from the update."

• The deleteLayer1AggregationProfile operation shall handle the following attributes:

  • in: _obsoleteLayer1AggregationProfile : Profile [1] with comment "UUID of the instance of Layer1AggregationProfile (ProfileNameType==PROFILE_NAME_TYPE_LAYER_1_AGGREGATION_PROFILE) that shall be deleted."

• The provideCapabilitiesOfLayer1Aggregation operation shall handle the following attributes:

  • out: minimumNumberOfServers : Integer [1] = -1 with comment "Defines the minimum number of LTPs that need to be referenced in the _servingStructureList input parameter of the createLayer1AggregationProfile operation."
  • out: deactivatingAnAggrationGroupIsAvail : Boolean [1] = false with comment "If true, the device supports temporary disable/enable of a layer 1 aggregation group."
  • out: maximumNumberOfAggregationGroups : Integer [1] = -1 with comment "Maximum number of layer 1 aggregation groups that can be configured on the device."

• The provideCapabilitiesOfLayer1AggregationGroup operation shall handle the following attributes:

  • in: _layer1AggregationProfile : Profile [1] with comment "UUID of the instance of Layer1AggregationProfile (ProfileNameType==PROFILE_NAME_TYPE_LAYER_1_AGGREGATION_PROFILE) for which the capability information shall be provided."
  • out: maximumNumberOfServers : Integer [1] = -1 with comment "Defines the maximum number of LTPs that might be referenced in the _servingStructureList input parameter of the updateLayer1AggregationProfile operation, while updating a referenced layer 1 aggregation group."
  • out: _listOfStructureLtpsThatMightBeAdded : LTP [*] with comment "List of UUIDs of LTPs with LayerProtocol::layerProtocolName==LAYER_PROTOCOL_NAME_TYPE_HYBRID_MW_STRUCTURE_LAYER or LAYER_PROTOCOL_NAME_TYPE_PURE_ETHERNET_STRUCTURE_LAYER that might be added to the group of LTPs that are already transporting the LTP with LayerProtocol::layerProtocolName==LAYER_PROTOCOL_NAME_TYPE_ETHERNET_CONTAINER_LAYER in the referenced layer 1 aggregation group."