...
Note: this proposal now only contains impacts to introduces new objects in the Resource submodel.
Greyed-out content is not part of the proposal, either because it is already approved (stereotype Preliminary or no stereotype), or because it is for a separate future proposal (stereotype Future).
Red content indicates changes to previously-approved descriptions that are also part of the proposal.
ONAP Information Model Common
7 Root
7.4 RootObjectClasses
7.4.1 Overview
Qualified Name: Common::Root::RootObjectClasses
7.4.1.1 Classes
7.4.1.1.4 Entity class
Qualified Name: Common::Root::RootObjectClasses::Entity
Description:
This is an abstract class that extends the RootEntity class and represents characteristics and behaviors of concepts that pertain to the NFV managed environment.
Proposed description:
Extends the RootEntity class and represents characteristics and behaviors of concepts that pertain to the environment managed by ONAP.
This class is abstract.
Parent class: RootEntity
Applied Stereotypes:
- OpenModelClass
- support: MANDATORY
- Preliminary
7.4.1.1.6 OperationalEntity class
Qualified Name: Common::Root::RootObjectClasses::OperationalEntity
Description:
An OperationalEntity is a deployment in a NFV environment of a DesignEntity.
Proposed description:
An active entity managed by ONAP and described by a DesignEntity.
This class is abstract.
Parent class: Entity
Applied Stereotypes:
- OpenModelClass
- support: MANDATORY
- Preliminary
ONAP Information Model
Resource
This document was generated on 2020-09-21 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..
3 Diagrams
3.1 Overview
Qualified Name: Resource::Diagrams
Description:
3.1.1 Diagrams
Figure 13‑1: Diagram ResourceDescriptor
Figure 13‑2: Diagram ResourceAppModel
Figure 13‑3: Diagram YangCmAppModel
2 Associations
2.1 Overview
Qualified Name: Resource::Associations
2.1.1 Associations
2.1.1.1 ResInstAppDataDescribedByResAppModel association
Qualified Name: Resource::Associations::ResInstAppDataDescribedByResAppModel
...
Attribute Name | Aggreg. | Navig. | Mult. | Type | Description | Stereotypes |
_resourceappmodel | none | Navig. | 1 | ResourceAppModel | The model that describes the schema of the resource data. | Experimental OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY |
_resourceappdata | none | Not navig. | 0..* | ResourceInstanceAppData | OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY |
2.1.1.2 ResourceInstDescribedByResourceDesc association
Qualified Name: Resource::Associations::ResourceInstDescribedByResourceDesc
...
Attribute Name | Aggreg. | Navig. | Mult. | Type | Description | Stereotypes |
_resourcedesc | none | Navig. | 1 | ResourceDesc | Descriptor for this resource. | Future OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY |
_resourceinstance | none | Not navig. | 0..* | ResourceInstance | OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY |
2.1.1.3 ResourceInstanceHasAppData association
Qualified Name: Resource::Associations::ResourceInstanceHasAppData
...
Attribute Name | Aggreg. | Navig. | Mult. | Type | Description | Stereotypes |
_resourceappdata | composite | Navig. | 0..* | ResourceInstanceAppData | Application data associated with this resource. | Experimental OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY |
_resourceinstance | none | Not navig. | 1 | ResourceInstance | OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY |
2.1.1.4 ResourceDescHasResourceAppModel association
Qualified Name: Resource::Associations::ResourceDescHasResourceAppModel
...
Attribute Name | Aggreg. | Navig. | Mult. | Type | Description | Stereotypes |
_resourceappmodel | composite | Navig. | 0..* | ResourceAppModel | Models that further specify the resource descriptor. | Experimental OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY |
_resourcedesc | none | Not navig. | 1 | ResourceDesc | OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY |
3 Diagrams
3.1 Overview
Qualified Name: Resource::Diagrams
Description:
3.1.1 Diagrams
Figure 13‑1: Diagram ResourceDescriptor
Figure 13‑2: Diagram ResourceAppModel
...
4 Interfaces
4.1 Overview
Qualified Name: Resource::Interfaces
5 ObjectClasses
5.1 Overview
Qualified Name: Resource::ObjectClasses
5.1.1 Classes
5.1.1.1 ResourceAppModel class
Qualified Name: Resource::ObjectClasses::ResourceAppModel
...
- Experimental
- OpenModelClass
- support: MANDATORY
5.1.1.2 ResourceDesc class
Qualified Name: Resource::ObjectClasses::ResourceDesc
...
Attribute Name | Type | Mult. | Description | Stereotypes |
_resourceappmodel | ResourceAppModel | 0..* | Models that further specify the resource descriptor. | 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 | Unambiguously distinguishes different object instances. It is the naming attribute of the object. Identifier of this information element. This attribute shall be globally unique. | OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY Preliminary |
5.1.1.3 ResourceInstance class
Qualified Name: Resource::ObjectClasses::ResourceInstance
...
Attribute Name | Type | Mult. | Description | Stereotypes |
_resourcedesc | ResourceDesc | 1 | Descriptor for this resource. | Future OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY |
_resourceappdata | ResourceInstanceAppData | 0..* | Application data associated with this resource. | 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 | Unambiguously distinguishes different object instances. It is the naming attribute of the object. Identifier of this information element. This attribute shall be globally unique. | OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY Preliminary |
5.1.1.4 ResourceInstanceAppData class
Qualified Name: Resource::ObjectClasses::ResourceInstanceAppData
...
Attribute Name | Type | Mult. | Description | Stereotypes |
_resourceappmodel | ResourceAppModel | 1 | The model that describes the schema of the resource data. | 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 | Unambiguously distinguishes different object instances. It is the naming attribute of the object. Identifier of this information element. This attribute shall be globally unique. | OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY Preliminary |
5.1.1.5 YangModelSet class
Qualified Name: Resource::ObjectClasses::YangModelSet
...
Attribute Name | Type | Mult. | Description | Stereotypes |
yangModules | YangModuleIdentifier | 1..* | List of YANG module identifiers that together define the CM interface of a resource. | 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 | Unambiguously distinguishes different object instances. It is the naming attribute of the object. Identifier of this information element. This attribute shall be globally unique. | OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY Preliminary |
6 TypeDefinitions
6.1 Overview
Qualified Name: Resource::TypeDefinitions
6.1.1 Datatypes
6.1.1.1 YangModuleIdentifier datatype
Qualified Name: Resource::TypeDefinitions::YangModuleIdentifier
...