ONAP Information Model - Pnf (example)

Owned by Jacqueline Beaulac [Ericsson]
Apr 27, 2020
5 min read

This document was generated on 2020-04-27 by "ONAP Model GenDoc Template" version 4.00



 

 

1         Introduction



This document contains the Word presentation of the model generated from the ONAP Eclipse Papyrus UML Information model  using gendoc.  This format is provided to assist the reader that does not use UML or has no access to UML tools.



2         Associations

2.1         Overview

Qualified Name: Pnf::Associations

2.1.1        Associations

2.1.1.1         PnfExposesExtCp association

Qualified Name: Pnf::Associations::PnfExposesExtCp





Table 12‑1 Member ends for Association PnfExposesExtCp

 

Attribute Name

Aggreg.

Navig.

Mult.

Type

Description

Stereotypes

_pnfExtCp

composite

Navig.

1..*

PnfExtCp







External CP of the PNF.





OpenModelAttribute

·       partOfObjectKey:  0

·       uniqueSet:

·       isInvariant:  false

·       unsigned:  false

·       counter: NA

·       support: MANDATORY





_pnf

none

Not navig.  

1

PnfInstance











OpenModelAttribute

·       partOfObjectKey:  0

·       uniqueSet:

·       isInvariant:  false

·       unsigned:  false

·       counter: NA

·       support: MANDATORY







2.1.1.2         PnfdHasPnfExtCpd association

Qualified Name: Pnf::Associations::PnfdHasPnfExtCpd





Table 12‑1 Member ends for Association PnfdHasPnfExtCpd

 

Attribute Name

Aggreg.

Navig.

Mult.

Type

Description

Stereotypes

_pnfExtCpd

composite

Navig.

1..*

PnfExtCpd







Specifies the characteristics of one or more connection points where to connect the PNF to a VL.





OpenModelAttribute

·       partOfObjectKey:  0

·       uniqueSet:

·       isInvariant:  false

·       unsigned:  false

·       counter: NA

·       support: MANDATORY





_pnfd

none

Not navig.  

1

Pnfd











OpenModelAttribute

·       partOfObjectKey:  0

·       uniqueSet:

·       isInvariant:  false

·       unsigned:  false

·       counter: NA

·       support: MANDATORY







3         Diagrams

3.1         Overview

Qualified Name: Pnf::Diagrams

3.1.1        Diagrams

Figure 13‑1: Diagram PnfdModel

4         ObjectClasses

4.1         Overview

Qualified Name: Pnf::ObjectClasses

4.1.1        Classes

4.1.1.1         PnfExtCp class

Qualified Name: Pnf::ObjectClasses::PnfExtCp

Description:

External CP of the PNF.

Parent class: Cp

Applied Stereotypes:

  • Future

  • OpenModelClass

  • support: MANDATORY

Table 7‑1 Attributes for Package ObjectClasses

 

Attribute Name

Type

Mult.

Description

Stereotypes

cpd



1

Cpd used to deploy this PNF CP.





OpenModelAttribute

·       partOfObjectKey:  0

·       uniqueSet:

·       isInvariant:  false

·       unsigned:  false

·       counter: NA

·       support: MANDATORY





cpId

Identifier

1

Identifier of the connection point instance.





OpenModelAttribute

·       partOfObjectKey:  0

·       uniqueSet:

·       isInvariant:  false

·       unsigned:  false

·       counter: NA

·       support: MANDATORY





cpName

String

1

Name of the Cp instance.





OpenModelAttribute

·       partOfObjectKey:  0

·       uniqueSet:

·       isInvariant:  false

·       unsigned:  false

·       counter: NA

·       support: MANDATORY





cpNameAlt

String

1

alternative name of the Cp instance.





OpenModelAttribute

·       partOfObjectKey:  0

·       uniqueSet:

·       isInvariant:  false

·       unsigned:  false

·       counter: NA

·       support: MANDATORY





cpType

String

1

Generic description of the type of Cp





OpenModelAttribute

·       partOfObjectKey:  0

·       uniqueSet:

·       isInvariant:  false

·       unsigned:  false

·       counter: NA

·       support: MANDATORY





cpRole

String

1

Role in the network this Cp will be providing





OpenModelAttribute

·       partOfObjectKey:  0

·       uniqueSet:

·       isInvariant:  false

·       unsigned:  false

·       counter: NA

·       support: MANDATORY





cpFunction

String

1

English description of the function this specific Cp will be providing





OpenModelAttribute

·       partOfObjectKey:  0

·       uniqueSet:

·       isInvariant:  false

·       unsigned:  false

·       counter: NA

·       support: MANDATORY





cpDescription

String

1

Cp description





OpenModelAttribute

·       partOfObjectKey:  0

·       uniqueSet:

·       isInvariant:  false

·       unsigned:  false

·       counter: NA

·       support: MANDATORY





cpBandwidth

String

1

Cp assigned (actual) bandwidth

Cp (max? assigned?) bandwidth





OpenModelAttribute

·       partOfObjectKey:  0

·       uniqueSet:

·       isInvariant:  false

·       unsigned:  false

·       counter: NA

·       support: MANDATORY





provStatus

String

1

provisioning status, used as a trigger for operational monitoring of this resource by service assurance systems  valid value example: PROVISIONED, PREPROVISIONED, CAPPED





OpenModelAttribute

·       partOfObjectKey:  0

·       uniqueSet:

·       isInvariant:  false

·       unsigned:  false

·       counter: NA

·       support: MANDATORY





adminsStatus

String

1

Administrative status of the connection point.





OpenModelAttribute

·       partOfObjectKey:  0

·       uniqueSet:

·       isInvariant:  false

·       unsigned:  false

·       counter: NA

·       support: MANDATORY





protocol

String

1

Protocol used by the Cp





OpenModelAttribute

·       partOfObjectKey:  0

·       uniqueSet:

·       isInvariant:  false

·       unsigned:  false

·       counter: NA

·       support: MANDATORY





trunkMode

Boolean

1

Indicator whether the Cp is in trunk mode





OpenModelAttribute

·       partOfObjectKey:  0

·       uniqueSet:

·       isInvariant:  false

·       unsigned:  false

·       counter: NA

·       support: MANDATORY





addressType

String

1

Type of address: MAC address or IP address





OpenModelAttribute

·       partOfObjectKey:  0

·       uniqueSet:

·       isInvariant:  false

·       unsigned:  false

·       counter: NA

·       support: MANDATORY





L2addressData

L2AddressData

0..1

Only present when addressType is MAC address





OpenModelAttribute

·       partOfObjectKey:  0

·       uniqueSet:

·       isInvariant:  false

·       unsigned:  false

·       counter: NA

·       support: MANDATORY





L3addressData

L3AddressData

0..1

Only present when addressType is IP address





OpenModelAttribute

·       partOfObjectKey:  0

·       uniqueSet:

·       isInvariant:  false

·       unsigned:  false

·       counter: NA

·       support: MANDATORY









4.1.1.2         PnfExtCpd  class

Qualified Name: Pnf::ObjectClasses::PnfExtCpd

Description:

A PnfExtCpd is a type of Cpd and describes the characteristics of an external interface, a.k.a external CP, where to connect the PNF to a VL.

 

Parent class: ExtCpd

Applied Stereotypes:

  • OpenModelClass

  • support: MANDATORY

  • Preliminary



4.1.1.3         PnfInstance class

Qualified Name: Pnf::ObjectClasses::PnfInstance

Description:

An implementation of a NF via a tightly coupled software and hardware system.

Parent class: NetworkFunctionInstance

Applied Stereotypes:

  • Future

  • OpenModelClass

  • support: MANDATORY

Table 7‑1 Attributes for Package ObjectClasses

 

Attribute Name

Type

Mult.

Description

Stereotypes

_pnfExtCp

PnfExtCp

1..*

External CP of the PNF.





OpenModelAttribute

·       partOfObjectKey:  0

·       uniqueSet:

·       isInvariant:  false

·       unsigned:  false

·       counter: NA

·       support: MANDATORY





type

String

1

Description of the type of network function





Experimental



OpenModelAttribute

·       partOfObjectKey:  0

·       uniqueSet:

·       isInvariant:  false

·       unsigned:  false

·       counter: NA

·       support: MANDATORY





role

String

1

Role the network function will be providing.





Experimental



OpenModelAttribute

·       partOfObjectKey:  0

·       uniqueSet:

·       isInvariant:  false

·       unsigned:  false

·       counter: NA

·       support: MANDATORY





name

String

0..1

Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object).





OpenModelAttribute

·       partOfObjectKey:  0

·       uniqueSet:

·       isInvariant:  false

·       unsigned:  false

·       counter: NA

·       support: MANDATORY



Preliminary





description

String

0..1

Defines a textual free-form description of the object.





OpenModelAttribute

·       partOfObjectKey:  0

·       uniqueSet:

·       isInvariant:  false

·       unsigned:  false

·       counter: NA

·       support: MANDATORY



Preliminary





id

Identifier

1

Identifier of this information element.   This attribute shall be globally unique.

Unambiguously distinguishes different object instances. It is the naming attribute of the object.





OpenModelAttribute

·       partOfObjectKey:  0

·       uniqueSet:

·       isInvariant:  false

·       unsigned:  false

·       counter: NA

·       support: MANDATORY



Preliminary









4.1.1.4         PnfProfile class

Qualified Name: Pnf::ObjectClasses::PnfProfile

Description:

The PnfProfile class describes additional data for a given PNF instance used in a DF.

Applied Stereotypes:

  • Future

  • OpenModelClass

  • support: MANDATORY

Table 7‑1 Attributes for Package ObjectClasses

 

Attribute Name

Type

Mult.

Description

Stereotypes

pnfProfileId

Identifier

1

Identifier of this PnfProfile class. It uniquely identifies a PnfProfile.





OpenModelAttribute

·       partOfObjectKey:  0

·       uniqueSet:

·       isInvariant:  false

·       unsigned:  false

·       counter: NA

·       support: MANDATORY





pnfVirtualLinkConnectivity

NsVirtualLinkConnectivity

1..*

Defines the connection information of the PNF, it contains connection relationship between a PNF connection point and a NS virtual Link.






OpenModelAttribute

·       partOfObjectKey:  0

·       uniqueSet:

·       isInvariant:  false

·       unsigned:  false

·       counter: NA

·       support: MANDATORY









4.1.1.5         Pnfd class

Qualified Name: Pnf::ObjectClasses::Pnfd

Description:

The Pnfd class is a deployment template enabling on-boarding PNFs and referencing them from an NSD. It focuses on connectivity aspects only.

Parent class: NetworkFunctionDesc

Applied Stereotypes:

  • OpenModelClass

  • support: MANDATORY

  • Preliminary

Table 7‑1 Attributes for Package ObjectClasses

 

Attribute Name

Type

Mult.

Description

Stereotypes

pnfdId

Identifier

1

Identifier of this Pnfd class. It uniquely identifies the PNFD.





OpenModelAttribute

·       partOfObjectKey:  0

·       uniqueSet:

·       isInvariant:  false

·       unsigned:  false

·       counter: NA

·       support: MANDATORY



Preliminary





provider

String

1

Identifies the provider of the PNFD.
NOTE:   The provider of the PNFD might be different from the provider of the PNF.





OpenModelAttribute

·       partOfObjectKey:  0

·       uniqueSet:

·       isInvariant:  false

·       unsigned:  false

·       counter: NA

·       support: MANDATORY



Preliminary





version

Version

1

Identifies the version of the PNFD





OpenModelAttribute

·       partOfObjectKey:  0

·       uniqueSet:

·       isInvariant:  false

·       unsigned:  false

·       counter: NA

·       support: MANDATORY



Preliminary





security

SecurityParameters

0..1

Provides a signature to prevent tampering.





OpenModelAttribute

·       partOfObjectKey:  0

·       uniqueSet:

·       isInvariant:  false

·       unsigned:  false

·       counter: NA

·       support: MANDATORY



Preliminary





functionDescription

String

1

Describes the PNF function.





OpenModelAttribute

·       partOfObjectKey:  0

·       uniqueSet:

·       isInvariant:  false

·       unsigned:  false

·       counter: NA

·       support: MANDATORY



Preliminary





pnfdInvariantId

Identifier

1

Identifies a PNFD in a version independent manner. This attribute is invariant across versions of PNFD.





OpenModelAttribute

·       partOfObjectKey:  0

·       uniqueSet:

·       isInvariant:  true

·       unsigned:  false

·       counter: NA

·       support: MANDATORY



Preliminary





name

String

1

Provides the human readable name of the PNFD.





OpenModelAttribute

·       partOfObjectKey:  0

·       uniqueSet:

·       isInvariant:  false

·       unsigned:  false

·       counter: NA

·       support: MANDATORY



Preliminary





_pnfExtCpd

PnfExtCpd

1..*

Specifies the characteristics of one or more connection points where to connect the PNF to a VL.





OpenModelAttribute

·       partOfObjectKey:  0

·       uniqueSet:

·       isInvariant:  false

·       unsigned:  false

·       counter: NA

·       support: MANDATORY





isSharable

Boolean

1

Indicates whether the NetworkFunction can be shared.





Experimental



OpenModelAttribute

·       partOfObjectKey:  0

·       uniqueSet:

·       isInvariant:  false

·       unsigned:  false

·       counter: NA

·       support: MANDATORY





validFor

TimePeriod

0..1

The period during which the design entity is valid.





OpenModelAttribute

·       partOfObjectKey:  0

·       uniqueSet:

·       isInvariant:  false

·       unsigned:  false

·       counter: NA

·       support: MANDATORY



Preliminary





status

String

1

The condition of the specification, such s active, inactive, or planned.





OpenModelAttribute

·       partOfObjectKey:  0

·       uniqueSet:

·       isInvariant:  false

·       unsigned:  false

·       counter: NA

·       support: MANDATORY



Preliminary





name

String

1

Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object).





OpenModelAttribute

·       partOfObjectKey:  0

·       uniqueSet:

·       isInvariant:  false

·       unsigned:  false

·       counter: NA

·       support: MANDATORY



Preliminary





description

String

1

Defines a textual free-form description of the object.





OpenModelAttribute

·       partOfObjectKey:  0

·       uniqueSet:

·       isInvariant:  false

·       unsigned:  false

·       counter: NA

·       support: MANDATORY



Preliminary





id

Identifier

1

Identifier of this information element.   This attribute shall be globally unique.

Unambiguously distinguishes different object instances. It is the naming attribute of the object.





OpenModelAttribute

·       partOfObjectKey:  0

·       uniqueSet:

·       isInvariant:  false

·       unsigned:  false

·       counter: NA

·       support: MANDATORY



Preliminary









5         TypeDefinitions

5.1         Overview

Qualified Name: Pnf::TypeDefinitions

5.1.1        Datatypes

5.1.1.1         SwVersion datatype

Qualified Name: Pnf::TypeDefinitions::SwVersion

Description:

The software versions associated with the pnfd

Applied Stereotypes:

  • Future

Table 7‑1 Attributes for Data Type SwVersion

 

Attribute Name

Type

Mult.

Description

Stereotypes

active

String

1

The active software





OpenModelAttribute

·       isInvariant: false

·       valueRange:  no range constraint

·       support:  MANDATORY





passive

String

0..*

The passive software





OpenModelAttribute

·       isInvariant: false

·       valueRange:  no range constraint

·       support:  MANDATORY





recovery

String

0..*

The recovery software





OpenModelAttribute

·       isInvariant: false

·       valueRange:  no range constraint

·       support:  MANDATORY