/
Allotted Resource Revised

Allotted Resource Revised

Mar 05, 2020

 

This document was generated on 2020-02-07 by "ONAP Model GenDoc Template" version 4.00

The vCPE Use Case from the Amsterdam release includes a discussion on Allotted Resources. See: Use Case: Residential Broadband vCPE (Approved)

 

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         Diagrams

2.1        Overview

Qualified Name: Vnf::Diagrams

Description:

Describes the associated elements of a VNFD for a certain purpose during VNF lifecycle management.

2.1.1        Diagrams

 

 

 

Figure 2‑1: Diagram Allotted Resource

3         ObjectClasses

3.1        Overview

Qualified Name: Vnf::ObjectClasses

3.1.1        Classes

3.1.1.1         AnfInstance class

Qualified Name: Vnf::ObjectClasses::AnfInstance

Description:

An Allotted Network Function Instance is a network function provided (or allotted) by some service instance.   The allotted network function may be incorporated into the topology of some consuming service like other network functions.

Parent class: NetworkFunctionInstance

Applied Stereotypes:

  • Experimental

  • OpenModelClass

  • support: MANDATORY

Table 3‑1 Attributes for Package ObjectClasses

 

Attribute Name

Type

Mult.

Description

Stereotypes

selfLink

String

1

Link back to more information in the controller

 

 

Experimental

 

OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY

 

 

resourceVersion

String

1

Concurrency value

 

 

Experimental

 

OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY

 

 

orchestrationStatus

String

1

Orchestration status

 

 

Experimental

 

OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY

 

 

operationalStatus

String

1

Indicator for whether the resource is considered operational

 

 

Experimental

 

OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY

 

 

accessProviderId

String

1

Store the id of the access provider of this allotted-resource.

 

 

Experimental

 

OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY

 

 

accessClientId

String

1

Store the id of the access client of this allotted-resource.

 

 

Experimental

 

OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY

 

 

accessTopologyId

String

1

Store the id of the access topology of this allotted-resource.

 

 

Experimental

 

OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY

 

 

accessNodeId

String

1

Store the id of the access node of this allotted-resource.

 

 

Experimental

 

OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY

 

 

accessLtpId

String

1

Store the id of the access ltp of this allotted-resource.

 

 

Experimental

 

OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY

 

 

cvLan

String

1

Store the cvlan of this allotted-resource.

 

 

Experimental

 

OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY

 

 

vpnName

String

1

Store the vpn-name of this allotted-resource.

 

 

Experimental

 

OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY

 

 

tunnelxConnects

String

1

 

Experimental

 

OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY

 

 

relationshipList

String

1

 

Experimental

 

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

 

 

 

 

3.1.1.2         Anfd class

Qualified Name: Vnf::ObjectClasses::Anfd

Description:

An Anfd is the   (Allotted Network Function) is a template which describes an ANF in terms of deploymnet and operational behaviour requiremnets.

Parent class: NetworkFunctionDesc

Applied Stereotypes:

  • Experimental

  • OpenModelClass

  • support: MANDATORY

 

 

 

 

From the Nf Model…

 

 

3.1.1.3         NetworkFunctionDesc class

Qualified Name: Nf::ObjectClasses::NetworkFunctionDesc

Description:

A NetworkFunctionDesc is the descriptor for some functional block within a network infrastructure that has well-defined external interfaces and well-defined functional behaviour.

This class is abstract.

Parent class: ResourceDesc

Applied Stereotypes:

  • Experimental

  • OpenModelClass

  • support: MANDATORY

Table 3‑2 Attributes for Package ObjectClasses

 

Attribute Name

Type

Mult.

Description

Stereotypes

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

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

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

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