openBackhaul / ethernetContainer

Technology specific interface definition for an Ethernet Container
Apache License 2.0
1 stars 0 forks source link

Mandatory Attributes #55

Open PrathibaJee opened 1 year ago

PrathibaJee commented 1 year ago

The latest UML2YANG tool will include mandatory substatement to attributes that has "Multiplicity 1 + no default values defined". The following attributes which are formerly optional will be changed to mandatory in the upcoming YANG.

Further , if an attribute is decided to be optional , we shall handle it in the UML modelling by either introducing a default value or by modifying the Multiplicity to 0..1.

S.No Grouping/Datatype Attribute Mandatory Optional
1 object-creation-notification object-id-ref
2 object-deletion-notification object-id-ref
3 attribute-value-changed-notification object-id-ref
4 current-performance granularity-period
5 historical-performance granularity-period
6 period-end-time
7 ethernet-container-configuration scheduler-profile
8 ingress-policing-profile
9 qos-profile
10 header-compression-kind
11 header-compression-kind header-compression-name
12 available-queue-type queue-name
13 wred-behavior-type affected-drop-precedence
14 affected-protocol
15 wred-profile
16 queue-behavior-type queue-name
17 queue-utilization-type queue-name
michbin commented 1 year ago

Making configuration attributes mandatory might force clients to provide these attributes in each configuration request.

openBackhaul commented 1 year ago

Decision during the 5G-xhaul call on 6th of September 2023:

UML2YANG tool will include mandatory substatements to attributes marked as mandatory.

S.No Grouping/Datatype Attribute Mandatory Optional
1 object-creation-notification object-id-ref X
2 object-deletion-notification object-id-ref X
3 attribute-value-changed-notification object-id-ref X
4 current-performance granularity-period X 1)
5 historical-performance granularity-period X 1)
6 period-end-time X 1)
7 ethernet-container-configuration scheduler-profile X
8 ingress-policing-profile X
9 qos-profile X
10 header-compression-kind X 2)
11 header-compression-kind header-compression-name X 1)
12 available-queue-type queue-name X 1)
13 wred-behavior-type affected-drop-precedence X 1)
14 affected-protocol X 1)
15 wred-profile X
16 queue-behavior-type queue-name X 1)
17 queue-utilization-type queue-name X 1)

1) It is a key attribute 2) If header compression would not be supported by hardware an instance of HeaderCompressionKind has to be created with headerCompressionMode == NO_COMPRESSION