Versions Compared

Old Version 2

changes.mady.by.user Kevin Scaggs

Saved on

compared with

New Version Current

changes.mady.by.user Tracy Van Brakle

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

A couple quick notes:

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

...

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

...

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

...

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

...

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

...

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

...

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

...

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

...

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

...

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

...

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

...

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

...

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

...

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

...

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

...

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

...

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

...

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

...

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

...

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

...

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

...