Draft A1 Information Model

Draft A1 Information Model

A couple quick notes:

  • Model based on mmddccyy (WG2 spec)

  • 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 11: Diagram A1 Datatypes

 

 

 

Figure 12: Diagram Policy

 

 

 

Figure 13: Diagram A1P Interface

 

 

 

Figure 14: Diagram Policy List

 

 

 

Figure 15: Diagram Policy Statement

 

 

Figure 16: Diagram Policy Notification

 

 

 

Figure 17: Diagram Policy Error

 

 

 

 

 

Figure 18: 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 11 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 12 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 13 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 14 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 15 Attributes for Package ObjectClasses

 

Attribute Name