Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Current »

A couple quick notes:

  • Model based on 2019.09.24-ORAN.WG2-A1AP_v00.01.01
  • Classes in an earlier version of the above spec are marked as OBSOLETE.



1         A1

1.1        Overview

Qualified Name: ORAN::A1


1.2        Diagrams

1.2.1        Overview

Qualified Name: ORAN::A1::Diagrams

Description:

1.2.1.1         Diagrams



Figure 1‑1: Diagram A1 Datatypes




Figure 1‑2: Diagram Policy




Figure 1‑3: Diagram A1P Interface




Figure 1‑4: Diagram Policy List




Figure 1‑5: Diagram Policy Statement



Figure 1‑6: Diagram Policy Notification




Figure 1‑7: Diagram Policy Error






Figure 1‑8: Diagram Policy Update

1.3        Interfaces

1.3.1        Overview

Qualified Name: ORAN::A1::Interfaces

1.3.1.1         Interfaces

1.3.1.1.1        A1-P interface

Qualified Name: ORAN::A1::Interfaces::A1-P

Description:

Declarative policy that is identified by its PolicyID and contains a scope identifier and one or more policy statements.

Applied Stereotypes:

  • OpenModelInterface
  • support: MANDATORY
  • Reference
  • reference: 08.14-oRAN.WG2-A1AP_v00.00.01

Table 1‑1 Operations for Interface A1-P

 

Operation Name

Parameters

Description

Stereotypes

CreatePolicy

policy

-  type: Policy

-  direction: inout

policyError

-  type: PolicyError

-  direction: out

responseCode

-  type: Integer

-  direction: return

-  Note: Return code on the CreatePolicy operation with the following values:
201- Created
204 - No content
4xx - An error case.


Create a policy for a single UE or for multiple UEs.



OpenModelOperation

·         isOperationIdempotent:  false

·         isAtomic:  false

·         support: MANDATORY



QueryPolicy

policyId

-  type: String

-  direction: in

policy

-  type: Policy

-  direction: out

policyList

-  type: PolicyList

-  direction: out

policyError

-  type: PolicyError

-  direction: out

returnCode

-  type: Integer

-  direction: return

-  Note: Return code with the following values
200 - Ok
4xx - Error


The operation to read a policy ofr a single UE or a group of UEs.



OpenModelOperation

·         isOperationIdempotent:  false

·         isAtomic:  false

·         support: MANDATORY



QueryPolicyList

policyList

-  type: PolicyList

-  direction: out

returnCode

-  type: Integer

-  direction: return

-  Note: valid return values include:

200 - OK



OpenModelOperation

·         isOperationIdempotent:  false

·         isAtomic:  false

·         support: MANDATORY



UpdatePolicyComplete

policyId

-  type: String

-  direction: in

policy

-  type: Policy

-  direction: inout

policyError

-  type: PolicyError

-  direction: out

responseCode

-  type: Integer

-  direction: return

-  Note: Response codes area s follows:
- 201 - Created
- 204 - No content
- 4xx  - Error


The operation to completely update a policy for a single UE or a group of UEs.



OpenModelOperation

·         isOperationIdempotent:  false

·         isAtomic:  false

·         support: MANDATORY



UpdatePolicyPartial

policyId

-  type: String

-  direction: in

policy

-  type: PolicyUpdate

-  direction: in

policyError

-  type: PolicyError

-  direction: out

responseCode

-  type: Integer

-  direction: return

-  Note: responseCode values include:
201 - Created
204 - No content
4xx - error


The operation to partially update a policy for a single UE or a group of UEs.



OpenModelOperation

·         isOperationIdempotent:  false

·         isAtomic:  false

·         support: MANDATORY



DeletePolicy

policyId

-  type: String

-  direction: in

-  Note: Policy to be deleted.

policyError

-  type: PolicyError

-  direction: out

responseCode

-  type: Integer

-  direction: return

-  Note: response codes are as follows:
204 - No Content
4xx - Error


The operation to delete a policy for a single UE or a group of UEs.



OpenModelOperation

·         isOperationIdempotent:  false

·         isAtomic:  false

·         support: MANDATORY



NotifyPolicy

policyNotify

-  type: PolicyNotify

-  direction: in

responseCode

-  type: Integer

-  direction: return

-  Note: response codes are as follows:
204 - No Content
4xx - Error


The A1-P Producer uses the policy feedback operation to notify the A1-P Consumer about changes in the policy enforcement status for an A1 policy.



OpenModelOperation

·         isOperationIdempotent:  false

·         isAtomic:  false

·         support: MANDATORY





1.4        ObjectClasses

1.4.1        Overview

Qualified Name: ORAN::A1::ObjectClasses

1.4.1.1         Classes

1.4.1.1.1        CarrierPreferenceConnection class

Qualified Name: ORAN::A1::ObjectClasses::CarrierPreferenceConnection

Description:

to select the carrier to use in a different way than what would be through default behavior

Applied Stereotypes:

  • Obsolete
  • OpenModelClass
  • support: MANDATORY

Table 1‑2 Attributes for Package ObjectClasses

 

Attribute Name

Type

Mult.

Description

Stereotypes

cellCarrierId

String

1

the identity of a carrier in a cell for which policy is applicable



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



cellCarrierRelationId

String

1

the identifier of a cell relation (Neighbour Cell Relattion [36.300])



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



preference

PreferenceType

1

the preference of carrier usage [shall/prefer/avoid/forbid].



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



primary

PrimaryType

1

indicates if the carrier is used as primary connection [Yes, No, null]



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY





1.4.1.1.2        CarrierPreferenceTraffic class

Qualified Name: ORAN::A1::ObjectClasses::CarrierPreferenceTraffic

Description:

to schedule traffic on available carriers in a different way than what would be through default behavior

Applied Stereotypes:

  • Obsolete
  • OpenModelClass
  • support: MANDATORY

Table 1‑3 Attributes for Package ObjectClasses

 

Attribute Name

Type

Mult.

Description

Stereotypes

cellCarrierId

String

1

the identity of a carrier in a cell for which policy is applicable []



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



cellCarrierRelationId

String

1

the identifier of a cell relation (Neighbour Cell Relattion [36.300])



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



preference

PreferenceType

1

the preference of carrier usage [shall/prefer/avoid/forbid].



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY





1.4.1.1.3        EnergyEfficiencyMode class

Qualified Name: ORAN::A1::ObjectClasses::EnergyEfficiencyMode

Description:

to optimize operation for energy efficiency

An energy efficiency policy is to apply either for a specific cell, or for the whole system (all cells). In a cell it can apply to a specific carrier or to all carriers.

Applied Stereotypes:

  • Obsolete
  • OpenModelClass
  • support: MANDATORY

Table 1‑4 Attributes for Package ObjectClasses

 

Attribute Name

Type

Mult.

Description

Stereotypes

cellCarrierId

String

0..1

the identity of a carrier in a cell for which policy is applicable



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



effiencyMode

OptimizationType

1

the preference for efficiency [full capacity/energy efficient



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY





1.4.1.1.4        Policy class

Qualified Name: ORAN::A1::ObjectClasses::Policy

Description:

Representation of an A1 policy in  used as payload in policy procedures.

Applied Stereotypes:

  • Experimental
  • OpenModelClass
  • support: MANDATORY
  • Reference
  • reference: 09.24-ORAN.WG2-A1AP_v00.01.01

Table 1‑5 Attributes for Package ObjectClasses

 

Attribute Name

Type

Mult.

Description

Stereotypes

policyId

String

1

policy identifier assigned by the A1-P Producer when a policy is created

Identifier of an A1 policy that is used in policy operations and included in policy objects.



Experimental


OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



scope

ScopeIdentifier

0..1

scope identifier



Experimental


OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY





1.4.1.1.5        PolicyError class

Qualified Name: ORAN::A1::ObjectClasses::PolicyError

Description:

A policy error object is used when details related to an error needs to be provided in addition to the normal HTTP status codes.

Applied Stereotypes:

  • Experimental
  • OpenModelClass
  • support: MANDATORY
  • Reference
  • reference: based on IETF RFC 7807

Table 1‑6 Attributes for Package ObjectClasses

 

Attribute Name

Type

Mult.

Description

Stereotypes

problemDetails

ProblemDetailsType

1..*

In case a policy request is not accepted, additional information can be provided.



Experimental


OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



_policy

Policy

1

Policy that this error is associated with.



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY





1.4.1.1.6        PolicyList class

Qualified Name: ORAN::A1::ObjectClasses::PolicyList

Description:

The policy list object is a representation of the collection of policies

Applied Stereotypes:

  • Experimental
  • OpenModelClass
  • support: MANDATORY

Table 1‑7 Attributes for Package ObjectClasses

 

Attribute Name

Type

Mult.

Description

Stereotypes

enforceStatus

EnforcementStatusType

1..*


Experimental


OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



_policy

Policy

1..*

List of policies specified by the PolicyList



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY





1.4.1.1.7        PolicyNotify class

Qualified Name: ORAN::A1::ObjectClasses::PolicyNotify

Description:

The policy notification object is the A1 policy feedback message

Applied Stereotypes:

  • Experimental
  • OpenModelClass
  • support: MANDATORY
  • Reference
  • reference: is based on IETF RFC 8259

Table 1‑8 Attributes for Package ObjectClasses

 

Attribute Name

Type

Mult.

Description

Stereotypes

enforceUpdate

EnforceUpdate

1

statement indicating reason for not enforcing policy



Experimental


OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



_policy

Policy

1

The policy that this notification is for.



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY





1.4.1.1.8        PolicyObjective class

Qualified Name: ORAN::A1::ObjectClasses::PolicyObjective

Parent class: PolicyStatement

Applied Stereotypes:

  • Experimental
  • OpenModelClass
  • support: MANDATORY


1.4.1.1.9        PolicyResource class

Qualified Name: ORAN::A1::ObjectClasses::PolicyResource

Parent class: PolicyStatement

Applied Stereotypes:

  • Experimental
  • OpenModelClass
  • support: MANDATORY


1.4.1.1.10    PolicyStatement class

Qualified Name: ORAN::A1::ObjectClasses::PolicyStatement

Description:

Expression of a directive in an A1 policy that is related to policy objectives and/or policy resources and are to be applied to/for the entities identified by the scope identifier.

Applied Stereotypes:

  • Experimental
  • OpenModelClass
  • support: MANDATORY


1.4.1.1.11    PolicyUpdate class

Qualified Name: ORAN::A1::ObjectClasses::PolicyUpdate

Description:

A policy update object is used when a policy is to be partially updated. (If policy is to be completely updated, a normal policy object is used.)

The policy update object is the representation of a partial update to an A1 policy.

Applied Stereotypes:

  • Experimental
  • OpenModelClass
  • support: MANDATORY
  • Reference
  • reference: based on JIETF RFC 6902

Table 1‑9 Attributes for Package ObjectClasses

 

Attribute Name

Type

Mult.

Description

Stereotypes

op

OperatorType

1..*


Experimental


OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



_path

PolicyStatement

1..*


OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY





1.4.1.1.12    QoETarget class

Qualified Name: ORAN::A1::ObjectClasses::QoETarget

Description:

Attributes related to the QoE

Parent class: PolicyObjective

Applied Stereotypes:

  • Experimental
  • OpenModelClass
  • support: MANDATORY

Table 1‑10 Attributes for Package ObjectClasses

 

Attribute Name

Type

Mult.

Description

Stereotypes

qoeScore

Number

0..1

mean opinion score value between 1 and 5,
it can be either e.g. video MOS  or a customized MOS



Experimental


OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



iinitialBuffering

Number

0..1

refers to the time in seconds between the initiation of video playback by the user and the actual start of the playback



Experimental


OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



reBuffFreq

Number

0..1

it can be calculated by taking the number of stalling events (excluding the initial buffering) and dividing by the length of media or by a customized time window



Experimental


OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



stallRatio

Number

0..1

ratio of the sum of duration of the stalling events to the total media length or by a customized time window.



Experimental


OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY





1.4.1.1.13    QoSTarget class

Qualified Name: ORAN::A1::ObjectClasses::QoSTarget

Description:

Attributes related to the QoS

Parent class: PolicyObjective

Applied Stereotypes:

  • Experimental
  • OpenModelClass
  • support: MANDATORY

Table 1‑11 Attributes for Package ObjectClasses

 

Attribute Name

Type

Mult.

Description

Stereotypes

gfbr

Number

0..1

Guaranteed Flow Bit Rate



Experimental


OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



mfbr

Number

0..1

Maximum Flow Bit Rate



Experimental


OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



prorityLevel

Number

0..1

Priority Level



Experimental


OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



pdb

Number

0..1

Packet Delay Budget



Experimental


OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY





1.4.1.1.14    Qos5QiMod class

Qualified Name: ORAN::A1::ObjectClasses::Qos5QiMod

Description:

Part of QoS profile for change of QoS characteristic(s) of a standard 5QI value

Parent class: QosProfile

Applied Stereotypes:

  • Obsolete
  • OpenModelClass
  • support: MANDATORY

Table 1‑12 Attributes for Package ObjectClasses

 

Attribute Name

Type

Mult.

Description

Stereotypes

resourceType

Boolean

0..1

Resource Type, see [23.501]



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



priorityLevel

Number

0..1

Priority Level, see [23.501]



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



pdb

Number

0..1

Packet Delay Budget, see [23.501]



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



per

Number

0..1

Packet Error Rate, see [23.501]



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



averageWindow

Number

0..1

Averaging Window, see [23.501]



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



mdbv

Number

0..1

Maximum Data Burst Volume, see [23.501]



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



5qi

Number

1

5G QoS Identifier, see [23.501]



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



arp

Arp

0..*

Allocation and Retention Priority, see [23.501]



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY





1.4.1.1.15    Qos5qi class

Qualified Name: ORAN::A1::ObjectClasses::Qos5qi

Description:

Part of QoS profile containing all QoS charateristics a for non-standard 5QI value

NOTE: Including this statement in a policy is conditionally mandatory for a policy object where the 5QI parameter in the qos_profile statement has a non-standard value.

Parent class: QosProfile

Applied Stereotypes:

  • Obsolete
  • OpenModelClass
  • support: MANDATORY

Table 1‑13 Attributes for Package ObjectClasses

 

Attribute Name

Type

Mult.

Description

Stereotypes

resourceType

Boolean

1

Resource Type, see [23.501]



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



priorityLevel

Number

1

Priority Level, see [23.501]



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



pdb

Number

1

Packet Delay Budget, see [23.501]



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



per

Number

1

Packet Error Rate, see [23.501]



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



averageWindow

Number

1

Averaging Window, see [23.501]



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



mdbv

Number

1

Maximum Data Burst Volume, see [23.501]



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



5qi

Number

1

5G QoS Identifier, see [23.501]



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



arp

Arp

0..*

Allocation and Retention Priority, see [23.501]



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY





1.4.1.1.16    QosGbr class

Qualified Name: ORAN::A1::ObjectClasses::QosGbr

Description:

Part of QoS profile specific to GBR profiles

Parent class: QosProfile

Applied Stereotypes:

  • Obsolete
  • OpenModelClass
  • support: MANDATORY

Table 1‑14 Attributes for Package ObjectClasses

 

Attribute Name

Type

Mult.

Description

Stereotypes

gfbr

Number

1

Guaranteed Flow Bit Rate, see [23.501]



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



mfbr

Number

1

Maximum Flow Bit Rate, see [23.501]



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



notCtrl

Boolean

1

Notification control, see [23.501]



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



mplrUl

Number

1

Maximum Packet Loss Rate – Up Link, see [23.501]



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



mplrDl

Number

1

Maximum Packet Loss Rate – Down Link, see [23.501]



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



5qi

Number

1

5G QoS Identifier, see [23.501]



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



arp

Arp

0..*

Allocation and Retention Priority, see [23.501]



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY





1.4.1.1.17    QosNonGbr class

Qualified Name: ORAN::A1::ObjectClasses::QosNonGbr

Description:

Part of QoS profile specific to non-GBR profiles

Parent class: QosProfile

Applied Stereotypes:

  • Obsolete
  • OpenModelClass
  • support: MANDATORY

Table 1‑15 Attributes for Package ObjectClasses

 

Attribute Name

Type

Mult.

Description

Stereotypes

rqa

Boolean

1

Reflective QoS Attribute, see [23.501]



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



5qi

Number

1

5G QoS Identifier, see [23.501]



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



arp

Arp

0..*

Allocation and Retention Priority, see [23.501]



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY





1.4.1.1.18    QosProfile class

Qualified Name: ORAN::A1::ObjectClasses::QosProfile

Description:

Common part of all QoS profiles

Applied Stereotypes:

  • Obsolete
  • OpenModelClass
  • support: MANDATORY

Table 1‑16 Attributes for Package ObjectClasses

 

Attribute Name

Type

Mult.

Description

Stereotypes

5qi

Number

1

5G QoS Identifier, see [23.501]



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



arp

Arp

0..*

Allocation and Retention Priority, see [23.501]



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY





1.4.1.1.19    TrafficSteeringPreference class

Qualified Name: ORAN::A1::ObjectClasses::TrafficSteeringPreference

Parent class: PolicyResource

Applied Stereotypes:

  • Experimental
  • OpenModelClass
  • support: MANDATORY

Table 1‑17 Attributes for Package ObjectClasses

 

Attribute Name

Type

Mult.

Description

Stereotypes

cellIdList

String

1..*

list of CellIDs



Experimental


OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



preference

PreferenceType

1

the preference of cell usage [shall/prefer/avoid/forbid].



Experimental


OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



primary

Boolean

0..1

indicates applicability to the selection of primary cell



Experimental


OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY





1.5        TypeDefinitions

1.5.1        Overview

Qualified Name: ORAN::A1::TypeDefinitions

1.5.1.1         Datatypes

1.5.1.1.1        EnforceUpdate datatype

Qualified Name: ORAN::A1::TypeDefinitions::EnforceUpdate

Applied Stereotypes:

  • Experimental

Table 1‑18 Attributes for Data Type EnforceUpdate

 

Attribute Name

Type

Mult.

Description

Stereotypes

enforceStatus

EnforcementStatusType

1


OpenModelAttribute

·         isInvariant: false

·         valueRange:  no range constraint

·         support:  MANDATORY


Experimental



enforceReason

EnforcementReasonType

0..1


OpenModelAttribute

·         isInvariant: false

·         valueRange:  no range constraint

·         support:  MANDATORY


Experimental




1.5.1.1.2        ProblemDetailsType datatype

Qualified Name: ORAN::A1::TypeDefinitions::ProblemDetailsType

Description:

In case a policy request is not accepted, additional information can be provided.

Applied Stereotypes:

  • Experimental

Table 1‑19 Attributes for Data Type ProblemDetailsType

 

Attribute Name

Type

Mult.

Description

Stereotypes

type

String

0..1

A URI reference according to IETF RFC 3986 [6] that identifies the problem type.



OpenModelAttribute

·         isInvariant: false

·         valueRange:  no range constraint

·         support:  MANDATORY


Experimental



title

String

0..1

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.



OpenModelAttribute

·         isInvariant: false

·         valueRange:  no range constraint

·         support:  MANDATORY


Experimental



status

Number

0..1

The HTTP status code for this occurrence of the problem.



OpenModelAttribute

·         isInvariant: false

·         valueRange:  no range constraint

·         support:  MANDATORY


Experimental



detail

String

0..1

A human-readable explanation specific to this occurrence of the problem.



OpenModelAttribute

·         isInvariant: false

·         valueRange:  no range constraint

·         support:  MANDATORY


Experimental



instance

String

0..1

A URI reference that identifies the specific occurrence of the problem.



OpenModelAttribute

·         isInvariant: false

·         valueRange:  no range constraint

·         support:  MANDATORY


Experimental



policyErrorCode

PolicyErrorType

0..1

A machine-readable application error cause specific to this occurrence of the problem
This IE should be present and provide application-related error information, if available.



OpenModelAttribute

·         isInvariant: false

·         valueRange:  no range constraint

·         support:  MANDATORY


Experimental



invalidParams

String

0..*

description of invalid parameters causing a request to be rejected



OpenModelAttribute

·         isInvariant: false

·         valueRange:  no range constraint

·         support:  MANDATORY


Experimental




1.5.1.1.3        ScopeIdentifier datatype

Qualified Name: ORAN::A1::TypeDefinitions::ScopeIdentifier

Description:

Defines the structured data type and attributes to be used as scope identifier.

Identifier of what the statements in the policy applies to (UE, group of UEs, slice, QoS flow, network resource or combinations thereof).

Applied Stereotypes:

  • Experimental

Table 1‑20 Attributes for Data Type ScopeIdentifier

 

Attribute Name

Type

Mult.

Description

Stereotypes

ueId

String

0..1

UE identifier based on RAN UE Id

identifies a single UE



OpenModelAttribute

·         isInvariant: false

·         valueRange:  no range constraint

·         support:  MANDATORY


Experimental



groupId

String

0..1

identifies a group of UEs

identifer of a pre-defined group of UEs



OpenModelAttribute

·         isInvariant: false

·         valueRange:  no range constraint

·         support:  MANDATORY


Experimental



sliceId

String

0..1

network slice identifier

identifies a slice



OpenModelAttribute

·         isInvariant: false

·         valueRange:  no range constraint

·         support:  MANDATORY


Experimental



qosId

String

0..1

identifies a QoS Flow

QoS identifier



OpenModelAttribute

·         isInvariant: false

·         valueRange:  no range constraint

·         support:  MANDATORY


Experimental



cellId

String

0..1

identifies a cell

network resource identifier related to cells



OpenModelAttribute

·         isInvariant: false

·         valueRange:  no range constraint

·         support:  MANDATORY


Experimental




1.5.1.2         Enumerations

1.5.1.2.1        EnforcementReasonType enumeration

Qualified Name: ORAN::A1::TypeDefinitions::EnforcementReasonType

Description:

The enumeration enforcement_reason_type represents the reason why notification is sent (e.g. why enforcement status has changed).

Applied Stereotypes:

  • Experimental

Contains Enumeration Literals:

  • 100
    • One or more fields in policy object cannot be interpreted
    • Policy object syntax error
  • 200
    • Scope identifier is no longer valid
    • Scope identifier is invalid
  • 300
    • Policy statement(s) can no longer be enforced for the scope identifier
    • Policy statement not applicable for the associated scope
  • 800
    • Generic default reason
    • Default
1.5.1.2.2        EnforcementStatusType enumeration

Qualified Name: ORAN::A1::TypeDefinitions::EnforcementStatusType

Description:

The enumeration enforcement_status_type represents if a policy is enforced or not

Applied Stereotypes:

  • Experimental

Contains Enumeration Literals:

  • YES
    • equals that the policy is enforced
  • NO
    • equals that the policy is NOT enforced
1.5.1.2.3        OperatorType enumeration

Qualified Name: ORAN::A1::TypeDefinitions::OperatorType

Applied Stereotypes:

  • Experimental

Contains Enumeration Literals:

  • ADD
  • REPLACE
  • REMOVE
1.5.1.2.4        PolicyErrorType enumeration

Qualified Name: ORAN::A1::TypeDefinitions::PolicyErrorType

Applied Stereotypes:

  • Experimental

Contains Enumeration Literals:

  • CONF_POLICY_ID
    • Policy instance with requested ID already exists
    • In case a create policy request could not be accepted due to existing policy instance with same policy id
  • BAD_REQ_MISSING_PARAM
    • Bad request due to missing attributes in policy object header (e.g. missing policy ID or scope ID)
    • In case a create policy request could not be accepted due to malformed syntax (missing policy ID or scope ID)
1.5.1.2.5        PreferenceType enumeration

Qualified Name: ORAN::A1::TypeDefinitions::PreferenceType

Description:

The enumeration preference_type represents the preference of a specific network resource (e.g. cell usage).

Applied Stereotypes:

  • Experimental

Contains Enumeration Literals:

  • SHALL
    • equals to select the resource
    • select the carrier regardless if connection retainability might be at risk
  • PREFER
    • favor the selection of the carrier even if it is not with the best radio quality if the connection retainability is not at risk.
    • equals to favor the selection of the resource
  • AVOID
    • equals to avoid selecting the resource
    • avoid selecting the carrier unless the connection retainability is at risk
  • FORBID
    • not select the carrier under any conditions

 equals to not select the r

  • No labels