Model Specifications
ONAP is expected to be a general model driven platform to support design, deployment and management of various services, across traditional access, transport and core network domains. ONAP has leveraged the experience of community members, standard organizations and other open source projects to produce models which enable the model driven approach and improve the interoperability of ONAP.
The models documented in the current release are listed below:
ONAP Modeling Specifications
ONAP Information Model Specifications
Root Model
Overview
Qualified Name: Common::Root
Description:
A set of common business entities that collectively serve as the foundation of the ONAP Information Model. This set of root classess enable the entities in different domains of the Information Model to be associated with each other, providing greater overall coherence.
Class Definition
DesignEntity class
Qualified Name: Common::Root::RootObjectClasses::DesignEntity
Description:
A template which describes an OperationalEntity in terms of deployment and operational behavior requirements.
This class is abstract.
Parent class: Entity
Applied Stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Table Attributes for class DesignEntity
Attribute Name |
Type |
Mult. |
Description |
Stereotypes |
|---|---|---|---|---|
validFor |
TimePeriod |
1 |
The period during which the design entity is valid. |
OpenModelAttribute
Preliminary |
status |
String |
1 |
The condition of the specification, such s active, inactive, or planned. |
OpenModelAttribute
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
Preliminary |
description |
String |
1 |
Defines a textual free-form description of the object. |
OpenModelAttribute
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
Preliminary |
Domain class
Qualified Name: Common::Root::RootObjectClasses::Domain
Description:
Defines a collection of entities that share a common purpose. In addition, each constituent Entity in an Domain is both uniquely addressable and uniquely identifiable within that Domain
Parent class: RootEntity
Applied Stereotypes:
Experimental
OpenModelClass
support: MANDATORY
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.
This class is abstract.
Parent class: RootEntity
Applied Stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
ManagedEntity class
Qualified Name: Common::Root::RootObjectClasses::ManagedEntity
Description:
A ManagedEntity is used to specify that an Entity is manageable by electronic means.
Applied Stereotypes:
Experimental
OpenModelClass
support: MANDATORY
Table Attributes for class ManagedEntity
Attribute Name |
Type |
Mult. |
Description |
Stereotypes |
|---|---|---|---|---|
managementMethodCurrent |
Integer |
1 |
This is an enumerated integer that defines the particular type of management method that is currently being used. Permitted Values: 0: Unknown 1: None 2: CLI 3: SNMP 4: TL1 5: CMIP 6: Proprietary |
OpenModelAttribute
|
managementMethodSupported |
Integer |
1..* |
This is an array of integers that define the different management methods that are supported by this object. Permitted Values: 0: Unknown 1: None 2: CLI 3: SNMP 4: TL1 5: CMIP 6: Proprietary |
OpenModelAttribute
|
OperationalEntity class
Qualified Name: Common::Root::RootObjectClasses::OperationalEntity
Description:
An OperationalEntity is a deployment in a NFV environment of a DesignEntity.
This class is abstract.
Parent class: Entity
Applied Stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
RootEntity class
Qualified Name: Common::Root::RootObjectClasses::RootEntity
Description:
This is the top of the ONAP class hierarchy. The purpose of the RootEntity is to define a set of attributes that are common to all entities that derive from it. These properties enable us to name, describe, and identify all objects in the environment.
This class is abstract.
Applied Stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Table Attributes for class RootEntity
Attribute Name |
Type |
Mult. |
Description |
Stereotypes |
|---|---|---|---|---|
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
Preliminary |
description |
String |
0..1 |
Defines a textual free-form description of the object. |
OpenModelAttribute
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
Preliminary |
Enumeration definition
CompositeOperator enumeration
Qualified Name: Common::Root::RootTypeDefinitons::CompositeOperator
Description:
The operator being applied to to some group of selectoin critiera.
Applied Stereotypes:
Preliminary
Contains Enumeration Literals:
AND
OR
XOR
Operator enumeration
Qualified Name: Common::Root::RootTypeDefinitons::Operator
Description:
The operator being applied to some atomic selection critera.
Applied Stereotypes:
Preliminary
Contains Enumeration Literals:
MORETHAN
LESSTHAN
EQUAL
Priority enumeration
Qualified Name: Common::TypeDefinitions::Priority
Description:
priority - processing priority.
Applied Stereotypes:
Preliminary
Contains Enumeration Literals:
HIGH
MEDIUM
NORMAL
LOW
RuleScope enumeration
Qualified Name: Common::TypeDefinitions::RuleScope
Description:
Defines the scope of the rule.
Applied Stereotypes:
Preliminary
Contains Enumeration Literals:
NFVI_POP
ZONE
ZONE_GROUP
NFVI_NODE
RuleType enumeration
Qualified Name: Common::TypeDefinitions::RuleType
Description:
Specifies the type of rule.
Applied Stereotypes:
Preliminary
Contains Enumeration Literals:
AFFINITY
ANTI_AFFINITY
Datatype definition
ConfigurableProperties datatype
Qualified Name: Common::Root::RootTypeDefinitons:: ConfigurableProperties
Description:
Dynamic, configurable properites of some entity.
Applied Stereotypes:
Experimental
Table Attributes for Data Type ConfigurableProperties
Attribute Name |
Type |
Mult. |
Description |
Stereotypes |
|---|---|---|---|---|
properties |
KeyValuePair |
0..* |
The specific configurable properties of some entity. |
Experimental OpenModelAttribute
|
DateTime primitive type
Qualified Name: Common::TypeDefinitions::DateTime
Description:
DateTime - RFC 2822 standard date/time format.
RFC 2822 format
day-of-week, dd MM yyyy HH’:’mm’:’ss ‘GMT’
e.g. Tue, 21 Jun 2016 14:05:20 GMT
File primitive type
Qualified Name: Common::TypeDefinitions::File
Description:
A primitive Type
Applied Stereotypes:
Experimental
Identifier datatype
Qualified Name: Common::TypeDefinitions::Identifier
Applied Stereotypes:
Preliminary
Key datatype
Qualified Name: Common::TypeDefinitions::Key
Description:
key - the key datatype is a tuple which provides the name of a key along with its value and relative order.
Applied Stereotypes:
Preliminary
Table Attributes for Data Type Key
Attribute Name |
Type |
Mult. |
Description |
Stereotypes |
|---|---|---|---|---|
keyName |
String |
1 |
keyName - Name of the key. |
OpenModelAttribute
|
keyOrder |
Integer |
0..1 |
keyOrder - Relative sequence or order of the key (with respect to other keys). |
OpenModelAttribute
|
keyValue |
String |
0..1 |
keyValue - Value of the key. |
OpenModelAttribute
|
KeyValuePair datatype
Qualified Name: Common::TypeDefinitions::KeyValuePair
Applied Stereotypes:
Preliminary
Table Attributes for Data Type KeyValuePair
Attribute Name |
Type |
Mult. |
Description |
Stereotypes |
|---|---|---|---|---|
key |
String |
1 |
OpenModelAttribute
|
|
value |
String |
1 |
OpenModelAttribute
|
Number primitive type
Qualified Name: Common::TypeDefinitions::Number
Description:
This primitive type is a superset of the standard UML numbering primitives, e.g. Integer and Real.
Applied Stereotypes:
Preliminary
Object primitive type
Qualified Name: Common::TypeDefinitions::Object
Description:
object - objects are model elements that represent instances of a class or of classes
Applied Stereotypes:
Preliminary
Rule primitive type
Qualified Name: Common::TypeDefinitions::Rule
Description:
Primitive type describing a rule.
Applied Stereotypes:
Preliminary
SecurityParameters datatype
Qualified Name: Common::TypeDefinitions::SecurityParameters
Description:
The SecurityParameters contains the signature of a NSD, VLD, PNFD or VNFFGD instance together with information required to validate the signature.
Applied Stereotypes:
Preliminary
Table Attributes for Data Type SecurityParameters
Attribute Name |
Type |
Mult. |
Description |
Stereotypes |
|---|---|---|---|---|
signature |
String |
1 |
Provides the signature of the signed part of the descriptor. |
OpenModelAttribute
|
algorithm |
String |
1 |
Identifies the algorithm used to compute the signature. |
OpenModelAttribute
|
certificate |
0..1 |
Provides a certificate or a reference to a certificate to validate the signature. NOTE: Cardinality of 0 corresponds to the case where the certificate is provided by means outside the NSD |
OpenModelAttribute
|
TimePeriod datatype
Qualified Name: Common::TypeDefinitions::TimePeriod
Description:
A base / value business entity used to represent a period of time, between two timepoints
Applied Stereotypes:
Preliminary
Table Attributes for Data Type TimePeriod
Attribute Name |
Type |
Mult. |
Description |
Stereotypes |
|---|---|---|---|---|
startDateTime |
DateTime |
1 |
An instant of time, starting at the TimePeriod Notes: If null, then represents to the beginning of time |
OpenModelAttribute
|
endDateTime |
DateTime |
1 |
An instant of time, ending at the TimePeriod: Notes: If null, then represents to the end of time |
OpenModelAttribute
|
UnixEpoch primitive type
Qualified Name: Common::TypeDefinitions::UnixEpoch
Description:
the latest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds
Uri primitive type
Qualified Name: Common::TypeDefinitions::Uri
Description:
type string;
The uri type represents a Uniform Resource Identifier (URI) as defined by STD 66.
Objects using the uri type MUST be in US-ASCII encoding, and MUST be normalized as described by RFC 3986 Sections 6.2.1, 6.2.2.1, and 6.2.2.2. All unnecessary percent-encoding is removed, and all case-insensitive characters are set to lowercase except for hexadecimal digits, which are normalized to uppercase as described in Section 6.2.2.1.
The purpose of this normalization is to help provide unique URIs. Note that this normalization is not sufficient to provide uniqueness. Two URIs that are textually distinct after this normalization may still be equivalent.
Objects using the uri type may restrict the schemes that they permit. For example, ‘data:’ and ‘urn:’ schemes might not be appropriate.
A zero-length URI is not a valid URI. This can be used to express ‘URI absent’ where required.
In the value set and its semantics, this type is equivalent to the Uri SMIv2 textual convention defined in RFC 5017.
reference
RFC 3986: Uniform Resource Identifier (URI): Generic Syntax
RFC 3305: Report from the Joint W3C/IETF URI Planning Interest Group: Uniform Resource Identifiers (URIs), URLs, and Uniform Resource Names (URNs): Clarifications and Recommendations
RFC 5017: MIB Textual Conventions for Uniform Resource Identifiers (URIs);
Applied Stereotypes:
Preliminary
Uuid primitive type
Qualified Name: Common::TypeDefinitions::Uuid
Description:
type string {
pattern
‘[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}’; }
A Universally Unique IDentifier in the string representation defined in RFC 4122. The canonical representation uses lowercase characters.
The following is an example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6;
reference
RFC 4122: A Universally Unique IDentifier (UUID) URN Namespace;
Applied Stereotypes:
Preliminary
Version primitive type
Qualified Name: Common::TypeDefinitions::Version
Description:
This primitive type defines the version of an element.
Applied Stereotypes:
Preliminary
ONAP Vnfd Model
Diagrams
Vnfd View
Vnfd Topology View
Vnfd Deployment Flavor
VNF Datatypes
Classes
ChecksumData
The ChecksumData information element supports providing information about the result of performing a checksum operation over some arbitrary data.
Applied stereotypes:
Reference
reference: IFA011 v3.3.1
Experimental
OpenModelClass
support: MANDATORY
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
algorithm |
String |
1 |
OpenModelAttribute
Experimental |
Species the algorithm used to obtain the checksum value. |
Vnf::ObjectClasses::ChecksumData::algorithm |
hash |
String |
1 |
OpenModelAttribute
Experimental |
Contains the result of applying the algorithm indicated by the algorithm attribute to the data to which this ChecksumData refers. |
Vnf::ObjectClasses::ChecksumData::hash |
InstantiationLevel
The InstantiationLevel class describes a given level of resources to be instantiated within a DF in term of the number of VNFC instances to be created from each VDU. All the VDUs referenced in the level shall be part of the corresponding DF and their number shall be within the range (min/max) for this DF.
Applied stereotypes:
Preliminary
Reference
reference: IFA011 v3.3.1
OpenModelClass
support: MANDATORY
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
levelId |
Identifier |
1 |
OpenModelAttribute
Preliminary |
Uniquely identifies a level with the DF. |
Vnf::ObjectClasses::InstantiationLevel::levelId |
description |
String |
1 |
OpenModelAttribute
Preliminary |
Human readable description of the level. |
Vnf::ObjectClasses::InstantiationLevel::description |
scaleInfo |
ScaleInfo |
0..* |
OpenModelAttribute
Preliminary |
Represents for each aspect the scale level that corresponds to this instantiation level. scaleInfo shall be present if the VNF supports scaling. |
Vnf::ObjectClasses::InstantiationLevel::scaleInfo |
_vduLevel |
VduLevel |
1..* |
OpenModelAttribute
Preliminary |
Indicates the number of instance of this VDU to deploy for this level. |
Vnf::ObjectClasses::InstantiationLevel::_vduLevel |
virtualLinkBitRateLevel |
VirtualLinkBitRateLevel |
0..* |
OpenModelAttribute
Preliminary |
Specifies bitrate requirements applicable to virtual links created from particular virtual link descriptors for this level. NOTE: If not present, it is assumed that the bitrate requirements can be derived from those specified in the VduCpd instances applicable to the internal VL. If present in both the InstantiationLevel and the VduCpd instances applicable to the internal VL, the highest value takes precedence. |
Vnf::ObjectClasses::InstantiationLevel::virtualLinkBitRateLevel |
LogicalNodeRequirements
This information element describes compute, memory and I/O requirements that are to be associated with the logical node of infrastructure. The logical node requirements are a sub-component of the VDU level requirements. As an example for illustration purposes, a logical node correlates to the concept of a NUMA cell in libvirt terminology.
Applied stereotypes:
Preliminary
Reference
reference: IFA011 v3.3.1
OpenModelClass
support: MANDATORY
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
id |
Identifier |
1 |
OpenModelAttribute
Preliminary |
Identifies this set of logical node requirements. |
Vnf::ObjectClasses::LogicalNodeRequirements::id |
logicalNodeRequirementDetail |
KeyValuePair |
1..* |
OpenModelAttribute
Preliminary |
The logical node-level compute, memory and I/O requirements. An array of key-value pairs that articulate the deployment requirements. This could include the number of CPU cores on this logical node, a memory configuration specific to a logical node (e.g. such as available in the Linux kernel via the libnuma library) or a requirement related to the association of an I/O device with the logical node. |
Vnf::ObjectClasses::LogicalNodeRequirements::logicalNodeRequirementDetail |
MciopProfile
A Managed Container Infrastructure Object Package (MCIOP) is a hierarchical aggregate of information objects for OS container management and orchestration. Multiple MCIOPs can be included in a VNF Package. The MciopProfile information element provides properties of the MCIOP which are used during deployment of containerized workloads based on a MCIOP, associated to a VNF deployment flavour.
Applied stereotypes:
Reference
reference: IFA011 v4.1.1
Experimental
OpenModelClass
support: MANDATORY
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
mciopId |
Identifier |
1 |
OpenModelAttribute
|
Identifies the MCIOP in the VNF package. |
Vnf::ObjectClasses::MciopProfile::mciopId |
deploymentOrder |
Integer |
0..1 |
OpenModelAttribute
|
Indicates the order in which this MCIOP shall be deployed in relation to other MCIOPs. A lower value specifies an earlier deployment. |
Vnf::ObjectClasses::MciopProfile::deploymentOrder |
affinityOrAntiAffinityGroupId |
Identifier |
0..* |
OpenModelAttribute
|
References the affinity or anti-affinity group(s) the MCIOP belongs to. |
Vnf::ObjectClasses::MciopProfile::affinityOrAntiAffinityGroupId |
associatedVdu |
Identifier |
0..* |
OpenModelAttribute
|
List of VDUs which are associated to this MCIOP and which are deployed using this MCIOP. |
Vnf::ObjectClasses::MciopProfile::associatedVdu |
OsContainerDesc
The OsContainerDesc information element describes the members properties of a set of co-located container compute resources when these are realizing a VDU.
Applied stereotypes:
Reference
reference: IFA011 v4.1.1
Experimental
OpenModelClass
support: MANDATORY
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
osContainerDescId |
Identifier |
1 |
OpenModelAttribute
|
Unique identifier of this OsContainerDesc in the VNFD. |
Vnf::ObjectClasses::OsContainerDesc::osContainerDescId |
requestedCpuResources |
Integer |
1 |
OpenModelAttribute
|
Number of CPU resources requested for the container (e.g. in milli-CPU-s) |
Vnf::ObjectClasses::OsContainerDesc::requestedCpuResources |
requestedMemoryResources |
Number |
1 |
OpenModelAttribute
|
Amount of memory resources requested for the container (e.g. in MB). |
Vnf::ObjectClasses::OsContainerDesc::requestedMemoryResources |
requestedEphemeralStorageResources |
Number |
1 |
OpenModelAttribute
|
Size of ephemeral storage resources requested for the container (e.g. in GB). |
Vnf::ObjectClasses::OsContainerDesc::requestedEphemeralStorageResources |
extendedResourceRequests |
KeyValuePair |
1 |
OpenModelAttribute
|
An array of key-value pairs of extended resources required by the container. |
Vnf::ObjectClasses::OsContainerDesc::extendedResourceRequests |
cpuResourceLimit |
Integer |
1 |
OpenModelAttribute
|
Number of CPU resources the container can maximally use (e.g. in milli-CPU). |
Vnf::ObjectClasses::OsContainerDesc::cpuResourceLimit |
memoryResourceLimit |
Number |
1 |
OpenModelAttribute
|
Amount of memory resources the container can maximum use (e.g. in MB). |
Vnf::ObjectClasses::OsContainerDesc::memoryResourceLimit |
ephemeralStorageResourceLimit |
Number |
1 |
OpenModelAttribute
|
Size of ephemeral storage resources the container can maximum use (e.g. in GB). |
Vnf::ObjectClasses::OsContainerDesc::ephemeralStorageResourceLimit |
swimageDesc |
SwImageDesc |
1 |
OpenModelAttribute
|
Describes the software image realizing this OS container. |
Vnf::ObjectClasses::OsContainerDesc::swimageDesc |
bootData |
String |
1 |
OpenModelAttribute
|
Contains a string or a URL to a file contained in the VNF package used to customize a container resource at boot time. The bootData may contain variable parts that are replaced by deployment specific values before being sent. |
Vnf::ObjectClasses::OsContainerDesc::bootData |
virtualStorageDesc |
VirtualStorageDesc |
0..* |
OpenModelAttribute
|
Links to virtualStorageDesc-s of the Vdu. The storages represented by the linked VirtualStorageDesc-s are attached to the OS Container as volumes. Shall be present in case the OS container requires storage resources. |
Vnf::ObjectClasses::OsContainerDesc::virtualStorageDesc |
monitoringParameters |
MonitoringParameter |
1..* |
OpenModelAttribute
|
Specifies the virtualised resource related performance metrics on the OsContainerDesc level to be tracked by the VNFM |
Vnf::ObjectClasses::OsContainerDesc::monitoringParameters |
ScalingAspect
The ScalingAspect class describes the details of an aspect used for horizontal scaling.
Applied stereotypes:
Reference
reference: IFA011 v3.3.1
Experimental
OpenModelClass
support: MANDATORY
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
id |
String |
1 |
OpenModelAttribute
Experimental |
Unique identifier of this aspect in the VNFD. |
Vnf::ObjectClasses::ScalingAspect::id |
name |
String |
1 |
OpenModelAttribute
Experimental |
Human readable name of the aspect. |
Vnf::ObjectClasses::ScalingAspect::name |
description |
String |
1 |
OpenModelAttribute
Experimental |
Human readable description of the aspect. |
Vnf::ObjectClasses::ScalingAspect::description |
SecurityGroupRule
Security group rule specifies the matching criteria for the ingress and/or egress traffic to/from the visited connection points. If an ingress traffic is accepted, the corresponding egress response shall be allowed, regardless of the security group rules on the egress direction. If an egress traffic is allowed, the corresponding ingress response shall be accepted, regardless of the security group rules on the ingress direction. The design of security group rule follows a permissive model where all security group rules applied to a CP are dealt with in an “OR” logic fashion, i.e. the traffic is allowed if it matches any security group rule applied to this CP.
Applied stereotypes:
Preliminary
Reference
reference: IFA011 V3.3.1
OpenModelClass
support: MANDATORY
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
securityGroupRuleId |
Identifier |
1 |
OpenModelAttribute
Preliminary |
Identifier of the security group rule. |
Vnf::ObjectClasses::SecurityGroupRule::securityGroupRuleId |
description |
String |
0..1 |
OpenModelAttribute
Preliminary |
Human readable description of the security group rule |
Vnf::ObjectClasses::SecurityGroupRule::description |
direction |
Direction |
0..1 |
OpenModelAttribute
Preliminary |
The direction in which the security group rule is applied. |
Vnf::ObjectClasses::SecurityGroupRule::direction |
etherType |
IpVersion |
0..1 |
OpenModelAttribute
Preliminary |
Indicates the protocol carried over the Ethernet layer. |
Vnf::ObjectClasses::SecurityGroupRule::etherType |
protocol |
String |
0..1 |
OpenModelAttribute
Preliminary |
Indicates the protocol carried over the IP layer. Permitted values: any protocol defined in the IANA protocol registry, e.g. TCP, UDP, ICMP, etc. See https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml Note: IFA011 defines this as an enum, but as the list is not complete, made this a string. |
Vnf::ObjectClasses::SecurityGroupRule::protocol |
portRangeMin |
Integer |
0..1 |
OpenModelAttribute
Preliminary |
Indicates minimum port number in the range that is matched by the security group rule. If a value is provided at design-time, this value may be overridden at run-time based on other deployment requirements or constraints. |
Vnf::ObjectClasses::SecurityGroupRule::portRangeMin |
portRangeMax |
Integer |
0..1 |
OpenModelAttribute
Preliminary |
Indicates maximum port number in the range that is matched by the security group rule. If a value is provided at design-time, this value may be overridden at run-time based on other deployment requirements or constraints. |
Vnf::ObjectClasses::SecurityGroupRule::portRangeMax |
SwImage
A software image
Applied stereotypes:
Preliminary
Reference
reference: IFA011 v3.3.1
OpenModelClass
support: MANDATORY
SwImageDesc
The SwImageDesc information element describes requested additional capability for a particular VDU. Such a capability may be for acceleration or specific tasks. Storage not necessarily related to the compute, may be Network Attached Storage (NAS)
Applied stereotypes:
Preliminary
Reference
reference: IFA011 v3.3.1
OpenModelClass
support: MANDATORY
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
id |
Identifier |
1 |
OpenModelAttribute
Preliminary |
The identifier of this software image. |
Vnf::ObjectClasses::SwImageDesc::id |
name |
String |
1 |
OpenModelAttribute
Preliminary |
The name of this software image. |
Vnf::ObjectClasses::SwImageDesc::name |
version |
Version |
1 |
OpenModelAttribute
Preliminary |
The version of this software image. |
Vnf::ObjectClasses::SwImageDesc::version |
provider |
String |
0..1 |
OpenModelAttribute
Experimental |
The provider of this software image. If not present the provider of the software image is assumed to be same as the VNF provider. |
Vnf::ObjectClasses::SwImageDesc::provider |
containerFormat |
String |
1 |
OpenModelAttribute
Preliminary |
The container format describes the container file format in which software image is provided. |
Vnf::ObjectClasses::SwImageDesc::containerFormat |
diskFormat |
String |
1 |
OpenModelAttribute
Preliminary |
The disk format of a software image is the format of the underlying disk image. |
Vnf::ObjectClasses::SwImageDesc::diskFormat |
minRam |
Number |
0..1 |
OpenModelAttribute
Preliminary |
The minimal RAM requirement for this software image. The value of the “size” attribute of VirtualMemoryData of the Vdu referencing this SwImageDesc shall not be smaller than the value of minRam. |
Vnf::ObjectClasses::SwImageDesc::minRam |
minDisk |
Number |
1 |
OpenModelAttribute
Preliminary |
The minimal disk size requirement for this software image. The value of the “size of storage” attribute of the VirtualStorageDesc referencing this SwImageDesc shall not be smaller than the value of minDisk. |
Vnf::ObjectClasses::SwImageDesc::minDisk |
size |
Number |
1 |
OpenModelAttribute
Preliminary |
The size of the software image. |
Vnf::ObjectClasses::SwImageDesc::size |
operatingSystem |
String |
0..1 |
OpenModelAttribute
Preliminary |
Identifies the operating system used in the software image. This attribute may also identify if a 32 bit or 64 bit software image is used. |
Vnf::ObjectClasses::SwImageDesc::operatingSystem |
supportedVirtualisationEnvironment |
String |
0..* |
OpenModelAttribute
Preliminary |
Identifies the virtualisation environments (e.g. hypervisor) compatible with this software image. |
Vnf::ObjectClasses::SwImageDesc::supportedVirtualisationEnvironment |
_swImage |
SwImage |
1 |
OpenModelAttribute
Preliminary PassedByReference |
This is a reference to the actual software image. The reference can be relative to the root of the VNF Package or can be a URL |
Vnf::ObjectClasses::SwImageDesc::_swImage |
checksumdata |
ChecksumData |
1 |
OpenModelAttribute
Experimental |
Vnf::ObjectClasses::SwImageDesc::checksumdata |
Vdu
The Virtualisation Deployment Unit (VDU) is a construct supporting the description of the deployment and operational behavior of a VNFC. A VNFC instance created based on the VDU maps to a single instance of atomic deployable unit, represented by a single VM for hypervisor-based virtualisation, or represented by one or a set of OS containers for OS virtualisation . A VNFC will only be in one VNFDesc. If a vendor wants to use the VNFC in mupliple VNFDesc (their product) they can do so, but it will be ‘repeated’.
Applied stereotypes:
Preliminary
Reference
reference: IFA011 v4.1.1
OpenModelClass
support: MANDATORY
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
id |
Identifier |
1 |
OpenModelAttribute
Preliminary |
Unique identifier of this Vdu in VNFD. |
Vnf::ObjectClasses::Vdu::id |
name |
String |
1 |
OpenModelAttribute
Preliminary |
Human readable name of the Vdu. |
Vnf::ObjectClasses::Vdu::name |
description |
String |
1 |
OpenModelAttribute
Preliminary |
Human readable description of the Vdu. |
Vnf::ObjectClasses::Vdu::description |
bootOrder |
KeyValuePair |
0..* |
OpenModelAttribute
Preliminary |
Boot order of valid boot devices. “key/name” indicates the the boot index “value” references a descriptor from which a valid boot device is created e.g. VirtualStorageDesc from which a VirtualStorage instance is created. NOTE: If no boot order is defined the default boot order defined in the VIM or NFVI shall be used. |
Vnf::ObjectClasses::Vdu::bootOrder |
nfviConstraint |
KeyValuePair |
0..* |
OpenModelAttribute
Preliminary |
Describes constraints on the NFVI for the VNFC instance(s) created from this Vdu. For example, aspects of a secure hosting environment for the VNFC instance that involve additional entities or processes. “key/name” includes “AvailabilityZone”, “HostAggregates”. NOTE: These are constraints other than stipulating that a VNFC instance has access to a certain resource, as a prerequisite to instantiation. The attributes virtualComputeDesc and virtualStorageDesc define the resources required for instantiation of the VNFC instance. |
Vnf::ObjectClasses::Vdu::nfviConstraint |
monitoringParameter |
MonitoringParameter |
0..* |
OpenModelAttribute
Preliminary |
Defines the virtualised resources monitoring parameters on VDU level. |
Vnf::ObjectClasses::Vdu::monitoringParameter |
injectFiles |
String |
0..* |
OpenModelAttribute
Preliminary |
Describes the information (e.g. URL) about the scripts, config drive metadata, etc. which can be used during Vdu booting process. |
Vnf::ObjectClasses::Vdu::injectFiles |
configurableProperties |
VnfcConfigurableProperties |
0..1 |
OpenModelAttribute
Experimental |
Describes the configurable properties of all VNFC instances based on this VDU. |
Vnf::ObjectClasses::Vdu::configurableProperties |
bootData |
String |
0..1 |
OpenModelAttribute
Experimental |
Contains a string or a URL to a file contained in the VNF package used to customize a virtualised compute resource at boot time. The bootData may contain variable parts that are replaced by deployment specific values before being sent to the VIM. NOTE: The parameters of each variable part shall be declared in the VnfLcmOperationsConfiguration information element as “volatile” parameters available to the bootData template during the respective VNF lifecycle management operation execution and/or in the extension attribute of the VnfInfoModifiableAttributes information element as “persistent” parameters available to the bootData template during the lifetime of the VNF instance. For VNF lifecycle management operations resulting in multiple VNFC instantiations, the VNFM supports the means to provide the appropriate parameters to appropriate VNFC instances Experimental |
Vnf::ObjectClasses::Vdu::bootData |
intCpd |
VduCpd |
1 |
OpenModelAttribute
Preliminary |
Describes network connectivity between a VNFC instance (based on this Vdu) and an internal Virtual Link (VL). |
Vnf::ObjectClasses::Vdu::intCpd |
virtualComputeDesc |
VirtualComputeDesc |
1..* |
OpenModelAttribute
Preliminary PassedByReference |
Describes CPU, Memory and acceleration requirements of the Virtualisation Container realising this Vdu. |
Vnf::ObjectClasses::Vdu::virtualComputeDesc |
osContainerdesc |
OsContainerDesc |
0..* |
OpenModelAttribute
Reference
PassedByReference Experimental |
Describes CPU, memory requirements and limits, and software images of the OS Containers realizing this Vdu corresponding to OS Containers sharing the same host and same network namespace. Each unique identifier is referenced only once within one VDU. |
Vnf::ObjectClasses::Vdu::osContainerdesc |
virtualStorageDesc |
VirtualStorageDesc |
0..* |
OpenModelAttribute
Preliminary PassedByReference |
Describes storage requirements for a VirtualStorage instance attached to the virtualisation container created from virtualComputeDesc defined for this Vdu. |
Vnf::ObjectClasses::Vdu::virtualStorageDesc |
swImageDesc |
SwImageDesc |
0..1 |
OpenModelAttribute
Preliminary PassedByReference |
Describes the software image which is directly loaded on the virtualisation container realising this Vdu. NOTE: More software images can be attached to the virtualisation container using VirtualStorage resources. |
Vnf::ObjectClasses::Vdu::swImageDesc |
VduCpd
A VduCpd information element is a type of Cpd and describes network connectivity between a VNFC instance (based on this VDU) and an internal VL.
Parent class: Cpd
Applied stereotypes:
Preliminary
Reference
reference: IFA011 v3.3.1
OpenModelClass
support: MANDATORY
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
bitrateRequirement |
Number |
0..1 |
OpenModelAttribute
Preliminary |
Bitrate requirement on this CP. |
Vnf::ObjectClasses::VduCpd ::bitrateRequirement |
vnicName |
String |
0..1 |
OpenModelAttribute
Preliminary |
Describes the name of the vNIC this CP attaches to, e.g. eth0. It will be configured during the Vdu booting process. |
Vnf::ObjectClasses::VduCpd ::vnicName |
vnicOrder |
String |
0..1 |
OpenModelAttribute
Preliminary |
Describes the order to create the vNIC within the scope of this Vdu. |
Vnf::ObjectClasses::VduCpd ::vnicOrder |
vnicType |
VnicType |
0..1 |
OpenModelAttribute
Preliminary |
Describes the type of the virtual network interface realizing the CPs instantiated from this CPD. This is used to determine which mechanism driver(s) to be used to bind the port. VALUES: ? NORMAL ? MACVTAP ? DIRECT ? BAREMETAL ? VIRTIO-FORWARDER ? DIRECT-PHYSICAL ? SMART-NIC Additional values of the attribute for VDUs realized by one or set of OS containers: ? BRIDGE ? IPVLAN ? LOOPBACK ? MACVLAN ? PTP ? VLAN ? HOST-DEVICE |
Vnf::ObjectClasses::VduCpd ::vnicType |
_virtualNetworkInterfaceRequirements |
VirtualNetworkInterfaceRequirements |
0..* |
OpenModelAttribute
Preliminary |
Specifies requirements on a virtual network interface realising the CPs instantiated from this CPD. |
Vnf::ObjectClasses::VduCpd ::_virtualNetworkInterfaceRequirements |
sriovAntiAffinityGroup |
Identifier |
0..1 |
OpenModelAttribute
Future |
Define the port anti-affinity group ID for each SR-IOV type vNIC. Multiple vNICs in the same anti-affinity group must belong to the same virtual network, and the number of vNICs in the same anti-affinity group cannot exceed two. |
Vnf::ObjectClasses::VduCpd ::sriovAntiAffinityGroup |
securityGroups |
String |
0..* |
OpenModelAttribute
Future |
VNFD needs to specify the security group name {security_groups} for each vNic. |
Vnf::ObjectClasses::VduCpd ::securityGroups |
portSecurityEnabled |
Boolean |
0..1 |
OpenModelAttribute
Future |
VNFD needs to specify whether to enable security group for the vNic. |
Vnf::ObjectClasses::VduCpd ::portSecurityEnabled |
qos |
QoS |
0..1 |
OpenModelAttribute
Future |
Describe the Qos requirements of the VduCpd. |
Vnf::ObjectClasses::VduCpd ::qos |
_intVirtualLinkDesc |
VnfVirtualLinkDesc |
0..1 |
OpenModelAttribute
PassedByReference Experimental |
Reference(s) of the Virtual Link Descriptor to which this Connection Point Descriptor(s) connects. |
Vnf::ObjectClasses::VduCpd ::_intVirtualLinkDesc |
allowedAddressData |
AddressData |
0..* |
OpenModelAttribute
Preliminary |
For specifying floating IP(s) to be shared among Cpds, which are reserved for vnfReservedCpd described in the VNFD. |
Vnf::ObjectClasses::VduCpd ::allowedAddressData |
cpdId |
Identifier |
1 |
OpenModelAttribute
Preliminary |
Identifier of this Cpd information element. |
Common::Network::NetworkObjectClasses::Cpd ::cpdId |
cpdRole |
String |
0..1 |
OpenModelAttribute
Preliminary |
Identifies the role of the port in the context of the traffic flow patterns in the VNF or parent NS. For example a VNF with a tree flow pattern within the VNF will have legal cpRoles of ROOT and LEAF. |
Common::Network::NetworkObjectClasses::Cpd ::cpdRole |
description |
String |
0..1 |
OpenModelAttribute
Preliminary |
Provides human-readable information on the purpose of the CP (e.g. CP for control plane traffic). |
Common::Network::NetworkObjectClasses::Cpd ::description |
cpProtocol |
CpProtocolData |
0..* |
OpenModelAttribute
Experimental |
Identifies the protocol layering information the CP uses for connectivity purposes and associated information. There shall be one cpProtocol for each layer protocol as indicated by the attribute layerProtocol. Editor’s note: the attribute “layerProtocol” still needs further discussion and not included in this table. |
Common::Network::NetworkObjectClasses::Cpd ::cpProtocol |
trunkMode |
Boolean |
0..1 |
OpenModelAttribute
Experimental |
Information about whether the CP instantiated from this CPD is in Trunk mode (802.1Q or other). |
Common::Network::NetworkObjectClasses::Cpd ::trunkMode |
layerProtocol |
LayerProtocol |
1..* |
OpenModelAttribute
Experimental |
Identifies which protocol the CP uses for connectivity purposes (Ethernet, MPLS, ODU2, IPV4, IPV6, Pseudo-Wire, etc.). |
Common::Network::NetworkObjectClasses::Cpd ::layerProtocol |
securityGroupRuleId |
Identifier |
0..* |
OpenModelAttribute
Experimental |
Reference of the security group rules bound to this CPD. |
Common::Network::NetworkObjectClasses::Cpd ::securityGroupRuleId |
VduLevel
The VduLevel information element indicates for a given VDU in a given level the number of instances to deploy.
Applied stereotypes:
Preliminary
Reference
reference: IFA011 v3.3.1
OpenModelClass
support: MANDATORY
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
numberOfInstances |
Integer |
1 |
OpenModelAttribute
Preliminary |
Number of instances of VNFC based on this VDU to deploy for an instantiation level or for a scaling delta. |
Vnf::ObjectClasses::VduLevel::numberOfInstances |
_vduId |
Vdu |
1 |
OpenModelAttribute
PassedByReference Experimental |
Uniquely identifies a VDU. |
Vnf::ObjectClasses::VduLevel::_vduId |
VduProfile
The VduProfile describes additional instantiation data for a given VDU used in a DF.
Applied stereotypes:
Preliminary
Reference
reference: IFA011 v3.3.1
OpenModelClass
support: MANDATORY
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
minNumberOfInstances |
Integer |
1 |
OpenModelAttribute
Preliminary |
Minimum number of instances of the VNFC based on this VDU that is permitted to exist for this flavour. Shall be zero or greater. |
Vnf::ObjectClasses::VduProfile::minNumberOfInstances |
maxNumberOfInstances |
Integer |
1 |
OpenModelAttribute
Preliminary |
Maximum number of instances of the VNFC based on this VDU that is permitted to exist for this flavour. Shall be zero or greater. |
Vnf::ObjectClasses::VduProfile::maxNumberOfInstances |
localAffinityOrAntiAffinityRule |
LocalAffinityOrAntiAffinityRule |
0..* |
OpenModelAttribute
Preliminary |
Specifies affinity or anti-affinity rules applicable between the virtualization containers (e.g. virtual machines) to be created based on this VDU. When the cardinality is greater than 1, both affinity rule(s) and anti-affinity rule(s) with different scopes (e.g. “Affinity with the scope resource zone and anti-affinity with the scope NFVI node”) are applicable to the virtualization containers (e.g. virtual machines) to be created based on this VDU. When the cardinality is greater than 1, both affinity rule(s) and anti-affinity rule(s) with different scopes (e.g. “Affinity with the scope resource zone and anti-affinity with the scope NFVI node”) are applicable to the virtualization containers (e.g. virtual machines) to be created based on this VDU. |
Vnf::ObjectClasses::VduProfile::localAffinityOrAntiAffinityRule |
affinityOrAntiAffinityGroupId |
Identifier |
0..* |
OpenModelAttribute
Preliminary |
Identifier(s) of the affinity or anti-affinity group(s) the VDU belongs to. NOTE: Each identifier references an affinity or anti-affinity group which expresses affinity or anti-affinity relationships between the virtualisation container(s) (e.g. virtual machine(s)) to be created using this VDU and the virtualisation container(s) (e.g. virtual machine(s)) to be created using other VDU(s) in the same group. |
Vnf::ObjectClasses::VduProfile::affinityOrAntiAffinityGroupId |
watchdog |
String |
0..1 |
OpenModelAttribute
Preliminary |
Watchdog action to be triggered by the VIM for the VNF in case the heart beat fails, e.g. reset or hard shutdown, etc. |
Vnf::ObjectClasses::VduProfile::watchdog |
vmBootUpTimeOut |
Integer |
0..1 |
OpenModelAttribute
Preliminary |
Timeout value for the VNFM to wait before the successful booting up of the VDU. |
Vnf::ObjectClasses::VduProfile::vmBootUpTimeOut |
securityGroups |
String |
0..* |
OpenModelAttribute
Future |
VNFD needs to specify the security group name {security_groups} for each VDU. |
Vnf::ObjectClasses::VduProfile::securityGroups |
flavorExtraSpecs |
KeyValuePair |
0..* |
OpenModelAttribute
Future |
Additional expansion requirements for Infrastructure layer, e.g. HA property (Host Aggregate ). |
Vnf::ObjectClasses::VduProfile::flavorExtraSpecs |
_vduId |
Vdu |
1 |
OpenModelAttribute
Preliminary PassedByReference |
Vnf::ObjectClasses::VduProfile::_vduId |
VirtualComputeDesc
The VirtualComputeDesc information element supports the specification of requirements related to virtual compute resources.
Applied stereotypes:
Preliminary
Reference
reference: IFA011 v3.3.1
OpenModelClass
support: MANDATORY
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
virtualComputeDescId |
Identifier |
1 |
OpenModelAttribute
Preliminary |
Unique identifier of this VirtualComputeDesc in the VNFD |
Vnf::ObjectClasses::VirtualComputeDesc ::virtualComputeDescId |
requestAdditionalCapabilities |
RequestedAdditionalCapabilityData |
0..* |
OpenModelAttribute
Deprecated |
Specifies requirements for additional capabilities. These may be for a range of purposes. One example is acceleration related capabilities. |
Vnf::ObjectClasses::VirtualComputeDesc ::requestAdditionalCapabilities |
computeRequirements |
KeyValuePair |
0..* |
OpenModelAttribute
Preliminary |
Specifies compute requirements. |
Vnf::ObjectClasses::VirtualComputeDesc ::computeRequirements |
virtualMemory |
VirtualMemoryData |
1 |
OpenModelAttribute
Preliminary |
The virtual memory of the virtualised compute. |
Vnf::ObjectClasses::VirtualComputeDesc ::virtualMemory |
virtualCpu |
VirtualCpuData |
1 |
OpenModelAttribute
Preliminary |
The virtual CPU(s) of the virtualised compute. |
Vnf::ObjectClasses::VirtualComputeDesc ::virtualCpu |
_logicalNodeRequirements |
LogicalNodeRequirements |
0..* |
OpenModelAttribute
Experimental |
The associated logical node requirements. |
Vnf::ObjectClasses::VirtualComputeDesc ::_logicalNodeRequirements |
virtualDisk |
BlockStorageData |
0..* |
OpenModelAttribute
Experimental |
The local or ephemeral disk(s) of the virtualised compute. |
Vnf::ObjectClasses::VirtualComputeDesc ::virtualDisk |
VirtualCpd
A VirtualCpd is a type of Cpd and describes a requirement to create a virtual connection point allowing the access to a number of VNFC instances (based on their respective VDUs).
Parent class: Cpd
Applied stereotypes:
Reference
reference: IFA011 v4.1.1
Experimental
OpenModelClass
support: MANDATORY
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
vdu |
Identifier |
1..* |
OpenModelAttribute
|
References the VDU(s) which implement this service. |
Vnf::ObjectClasses::VirtualCpd::vdu |
additionalServiceData |
AdditionalServiceData |
0..* |
OpenModelAttribute
|
Additional service identification data of the VirtualCp exposed to NFV-MANO. |
Vnf::ObjectClasses::VirtualCpd::additionalServiceData |
cpdId |
Identifier |
1 |
OpenModelAttribute
Preliminary |
Identifier of this Cpd information element. |
Common::Network::NetworkObjectClasses::Cpd ::cpdId |
cpdRole |
String |
0..1 |
OpenModelAttribute
Preliminary |
Identifies the role of the port in the context of the traffic flow patterns in the VNF or parent NS. For example a VNF with a tree flow pattern within the VNF will have legal cpRoles of ROOT and LEAF. |
Common::Network::NetworkObjectClasses::Cpd ::cpdRole |
description |
String |
0..1 |
OpenModelAttribute
Preliminary |
Provides human-readable information on the purpose of the CP (e.g. CP for control plane traffic). |
Common::Network::NetworkObjectClasses::Cpd ::description |
cpProtocol |
CpProtocolData |
0..* |
OpenModelAttribute
Experimental |
Identifies the protocol layering information the CP uses for connectivity purposes and associated information. There shall be one cpProtocol for each layer protocol as indicated by the attribute layerProtocol. Editor’s note: the attribute “layerProtocol” still needs further discussion and not included in this table. |
Common::Network::NetworkObjectClasses::Cpd ::cpProtocol |
trunkMode |
Boolean |
0..1 |
OpenModelAttribute
Experimental |
Information about whether the CP instantiated from this CPD is in Trunk mode (802.1Q or other). |
Common::Network::NetworkObjectClasses::Cpd ::trunkMode |
layerProtocol |
LayerProtocol |
1..* |
OpenModelAttribute
Experimental |
Identifies which protocol the CP uses for connectivity purposes (Ethernet, MPLS, ODU2, IPV4, IPV6, Pseudo-Wire, etc.). |
Common::Network::NetworkObjectClasses::Cpd ::layerProtocol |
securityGroupRuleId |
Identifier |
0..* |
OpenModelAttribute
Experimental |
Reference of the security group rules bound to this CPD. |
Common::Network::NetworkObjectClasses::Cpd ::securityGroupRuleId |
VirtualLinkDescFlavour
The VirtualLinkDescFlavour describes additional instantiation data for a given internal VL used in a DF.
Applied stereotypes:
Preliminary
Reference
reference: IFA011 v3.3.1
OpenModelClass
support: MANDATORY
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
qos |
VnfQoS |
0..1 |
OpenModelAttribute
Preliminary |
QoS of the VL. |
Vnf::ObjectClasses::VirtualLinkDescFlavour::qos |
flavourId |
Identifier |
1 |
OpenModelAttribute
Preliminary |
Identifies a flavour within a VnfVirtualLinkDesc. |
Vnf::ObjectClasses::VirtualLinkDescFlavour::flavourId |
VirtualLinkProfile
The VirtualLinkProfile describes additional instantiation data for a given VL used in a DF.
Applied stereotypes:
Preliminary
Reference
reference: IFA011 v3.3.1
OpenModelClass
support: MANDATORY
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
virtualLinkProfileId |
Identifier |
1 |
OpenModelAttribute
Experimental |
Uniquely identifies this VirtualLinkProfile class |
Vnf::ObjectClasses::VirtualLinkProfile::virtualLinkProfileId |
localAffinityOrAntiAffinityRule |
LocalAffinityOrAntiAffinityRule |
0..* |
OpenModelAttribute
Preliminary |
Specifies affinity or anti-affinity rules applicable between the VLs based on this VnfVirtualLinkDesc. When the cardinality is greater than 1, both affinity rule(s) and anti-affinity rule(s) with different scopes are applicable to the VLs based on this VnfVirtualLinkDesc. |
Vnf::ObjectClasses::VirtualLinkProfile::localAffinityOrAntiAffinityRule |
maxBitRateRequirements |
LinkBitrateRequirements |
1 |
OpenModelAttribute
Preliminary |
Specifies the minimum bitrate requirements for a VL instantiated according to this profile. |
Vnf::ObjectClasses::VirtualLinkProfile::maxBitRateRequirements |
minBitRateRequirements |
LinkBitrateRequirements |
1 |
OpenModelAttribute
Preliminary |
Specifies the minimum bitrate requirements for a VL instantiated according to this profile. |
Vnf::ObjectClasses::VirtualLinkProfile::minBitRateRequirements |
_flavourId |
VirtualLinkDescFlavour |
1 |
OpenModelAttribute
Preliminary |
Identifies a flavour within the VnfVirtualLinkDesc. |
Vnf::ObjectClasses::VirtualLinkProfile::_flavourId |
_affinityOrAntiAffinityGroupId |
AffinityOrAntiAffinityGroup |
0..* |
OpenModelAttribute
PassedByReference Experimental |
Identifies an affinity or anti-affinity group the VLs instantiated according to the VlProfile belong to. NOTE : Each identifier references an affinity or anti-affinity group which expresses affinity or anti-affinity relationship between the VL(s) using this VirtualLinkProfile and the VL(s) using other VirtualLinkProfile(s) in the same group. |
Vnf::ObjectClasses::VirtualLinkProfile::_affinityOrAntiAffinityGroupId |
_vnfVirtualLinkDescId |
VnfVirtualLinkDesc |
1 |
OpenModelAttribute
Preliminary PassedByReference |
Uniquely references a VLD. |
Vnf::ObjectClasses::VirtualLinkProfile::_vnfVirtualLinkDescId |
virtualLinkProtocolData |
VirtualLinkProtocolData |
0..* |
OpenModelAttribute
Preliminary |
Specifies the protocol data for a VL instantiated according to this profile. Cardinality 0 is used when no protocol data needs to be specified. |
Vnf::ObjectClasses::VirtualLinkProfile::virtualLinkProtocolData |
VirtualNetworkInterfaceRequirements
This class specifies requirements on a virtual network interface.
Applied stereotypes:
Preliminary
Reference
reference: IFA011 v3.3.1
OpenModelClass
support: MANDATORY
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
name |
String |
0..1 |
OpenModelAttribute
Preliminary |
Provides a human readable name for the requirement. |
Vnf::ObjectClasses::VirtualNetworkInterfaceRequirements::name |
description |
String |
0..1 |
OpenModelAttribute
Preliminary |
Provides a human readable description of the requirement. |
Vnf::ObjectClasses::VirtualNetworkInterfaceRequirements::description |
supportMandatory |
Boolean |
1 |
OpenModelAttribute
Preliminary Deprecated |
Indicates whether fulfilling the constraint is mandatory (TRUE) for successful operation or desirable (FALSE). |
Vnf::ObjectClasses::VirtualNetworkInterfaceRequirements::supportMandatory |
networkInterfaceRequirements |
KeyValuePair |
0..* |
OpenModelAttribute
Preliminary |
The network interface requirements. An element from an array of key-value pairs that articulate the network interface deployment requirements |
Vnf::ObjectClasses::VirtualNetworkInterfaceRequirements::networkInterfaceRequirements |
_nicIoRequirements |
LogicalNodeRequirements |
0..1 |
OpenModelAttribute
PassedByReference |
This references (couples) the CPD with any logical node I/O requirements (for network devices) that may have been created. Linking these attributes is necessary so that so that I/O requirements that need to be articulated at the logical node level can be associated with the network interface requirements associated with the CPD. |
Vnf::ObjectClasses::VirtualNetworkInterfaceRequirements::_nicIoRequirements |
VirtualStorageDesc
The VirtualStorageDesc information element supports the specifications of requirements related to persistent virtual storage resources. Ephemeral virtual storage is specified in VirtualComputeDesc information element.
Applied stereotypes:
Preliminary
Reference
reference: IFA011 v4.1.1
OpenModelClass
support: MANDATORY
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
id |
Identifier |
1 |
OpenModelAttribute
Preliminary |
Unique identifier of this VirtualStorageDesc in the VNFD. |
Vnf::ObjectClasses::VirtualStorageDesc::id |
typeOfStorage |
String |
1 |
OpenModelAttribute
Preliminary |
Type of virtualised storage resource (BLOCK, OBJECT, FILE). |
Vnf::ObjectClasses::VirtualStorageDesc::typeOfStorage |
sizeOfStorage |
Number |
1 |
OpenModelAttribute
Preliminary |
Size of virtualised storage resource (e.g. size of volume, in GB). |
Vnf::ObjectClasses::VirtualStorageDesc::sizeOfStorage |
blockStorageData |
BlockStorageData |
0..1 |
OpenModelAttribute
Preliminary |
Specifies the details of block storage. It shall be present when the “typeOfStorage” attribute is set to “BLOCK”. It shall be absent otherwise. |
Vnf::ObjectClasses::VirtualStorageDesc::blockStorageData |
objectStorageData |
ObjectStorageData |
0..1 |
OpenModelAttribute
Preliminary |
Specifies the details of object storage. It shall be present when the “typeOfStorage” attribute is set to “OBJECT”. It shall be absent |
Vnf::ObjectClasses::VirtualStorageDesc::objectStorageData |
fileStorageData |
FileStorageData |
0..1 |
OpenModelAttribute
Preliminary |
Specifies the details of file storage. It shall be present when the “typeOfStorage” attribute is set to “FILE”. It shall be absent otherwise. |
Vnf::ObjectClasses::VirtualStorageDesc::fileStorageData |
multiAttach |
Boolean |
0..1 |
OpenModelAttribute
Future |
Indicating whether a vDisk is a shared volume in VNFD. |
Vnf::ObjectClasses::VirtualStorageDesc::multiAttach |
storageQos |
StorageQos |
0..1 |
OpenModelAttribute
Future |
Describe storage Qos requirements. |
Vnf::ObjectClasses::VirtualStorageDesc::storageQos |
volumeType |
VolumeType |
0..1 |
OpenModelAttribute
Future |
Describe volume type. |
Vnf::ObjectClasses::VirtualStorageDesc::volumeType |
volumeTemplate |
Boolean |
0..1 |
OpenModelAttribute
|
Indicates whether the virtual storage descriptor shall be used as template, i.e. if the virtual storage resource shall be instantiated per VNFC instance. If the value is true (default), a persistent virtual storage resource shall be instantiated for each VNFC instance that is based on a VDU referring to this virtual storage descriptor. If the value is false, a single persistent virtual storage resource shall be instantiated with a lifetime independent of the lifetime of individual VNFC instances based on a VDU referring to this virtual storage descriptor. |
Vnf::ObjectClasses::VirtualStorageDesc::volumeTemplate |
VnfDf
The VnfDf describes a specific deployment version of a VNF.
Applied stereotypes:
Preliminary
Reference
reference: IFA011 v4.1.1
OpenModelClass
support: MANDATORY
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
flavorId |
Identifier |
1 |
OpenModelAttribute
Preliminary |
Identifier of this DF within the VNFD. |
Vnf::ObjectClasses::VnfDf ::flavorId |
description |
String |
1 |
OpenModelAttribute
Preliminary |
Human readable description of the DF. |
Vnf::ObjectClasses::VnfDf ::description |
defaultInstantiationLevel |
Identifier |
0..1 |
OpenModelAttribute
Experimental |
This attribute references the “instantiationLevel” entry which defines the default instantiation level for this DF. It shall be present if there are multiple “instantiationLevel” entries. |
Vnf::ObjectClasses::VnfDf ::defaultInstantiationLevel |
monitoringParameter |
MonitoringParameter |
0..* |
OpenModelAttribute
Experimental |
Specifies the virtualised resource related performance metrics to be tracked by the VNFM. |
Vnf::ObjectClasses::VnfDf ::monitoringParameter |
_virtuaLlinkProfile |
VirtualLinkProfile |
0..* |
OpenModelAttribute
Preliminary |
Defines the internal VLD along with additional data which is used in this DF. NOTE 1: This allows for different VNF internal topologies between DFs. NOTE 2: virtualLinkProfile needs to be provided for all VLs that the CPs of the VDUs in the VDU profiles connect to. |
Vnf::ObjectClasses::VnfDf ::_virtuaLlinkProfile |
_instantiationLevel |
InstantiationLevel |
1..* |
OpenModelAttribute
Preliminary |
Describes the various levels of resources that can be used to instantiate the VNF using this flavour. Examples: Small, Medium, Large. If there is only one “instantiationLevel” entry, it shall be treated as the default instantiation level for this DF. |
Vnf::ObjectClasses::VnfDf ::_instantiationLevel |
_affinityOrAntiAffinityGroup |
AffinityOrAntiAffinityGroup |
0..* |
OpenModelAttribute
Preliminary |
Specifies affinity or anti-affinity relationship applicable between the virtualisation containers (e.g. virtual machines) to be created using different VDUs or internal VLs to be created using different VnfVirtualLinkDesc(s) in the same affinity or anti-affinity group. NOTE: In the present specification, including either VDU(s) or VnfVirtualLinkDesc(s) into the same affinity or anti-affinity group is supported. Extension to support including both VDU(s) and VnfVirtualLinkDesc(s) into the same affinity or anti-affinity group is left for future specification. |
Vnf::ObjectClasses::VnfDf ::_affinityOrAntiAffinityGroup |
_scalingAspect |
ScalingAspect |
0..* |
OpenModelAttribute
Preliminary |
The scaling aspects supported by this DF of the VNF. scalingAspect shall be present if the VNF supports scaling. |
Vnf::ObjectClasses::VnfDf ::_scalingAspect |
_vduProfile |
VduProfile |
1..* |
OpenModelAttribute
Preliminary |
Describes additional instantiation data for the VDUs used in this flavor. |
Vnf::ObjectClasses::VnfDf ::_vduProfile |
vnfIndicator |
VnfIndicator |
0..* |
OpenModelAttribute
Experimental |
Declares the VNF indicators that are supported by this VNF (specific to this DF). |
Vnf::ObjectClasses::VnfDf ::vnfIndicator |
supportedVnfInterface |
VnfInterfaceDetails |
0..* |
OpenModelAttribute
Experimental |
Indicates which interfaces the VNF produces and provides additional details on how to access the interface endpoints. |
Vnf::ObjectClasses::VnfDf ::supportedVnfInterface |
mciopProfile |
MciopProfile |
0..* |
OpenModelAttribute
Reference
Experimental |
Describes additional instantiation data for the MCIOPs used in this deployment flavour. This attribute shall be present if the DF references (via the vduProfile) containerized workloads based on a MCIOP. |
Vnf::ObjectClasses::VnfDf ::mciopProfile |
VnfExtCp
Describes an external CP exposed by a VNF.
Parent class: Cp
Applied stereotypes:
OpenModelClass
support: MANDATORY
VnfExtCpd
A VnfExtCpd is a type of Cpd and describes an external interface, a.k.a external CP, exposed by this VNF enabling connection with a VL. When the VnfExtCpd is mapped to a VduCpd, the values for the attributes type, subType and description shall be identical for both elements.
Applied stereotypes:
Preliminary
Reference
reference: IFA011 v4.1.1
OpenModelClass
support: MANDATORY
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
_intVirtualLinkDesc |
VnfVirtualLinkDesc |
0..1 |
OpenModelAttribute
PassedByReference Experimental |
References the internal Virtual Link Descriptor (VLD) to which CPs instantiated from this external CP Descriptor (CPD) connect. One and only one of the following attributes shall be present: intVirtualLinkDesc or intCpd or vipCpd. |
Vnf::ObjectClasses::VnfExtCpd ::_intVirtualLinkDesc |
_intCpd |
VduCpd |
0..1 |
OpenModelAttribute
Preliminary PassedByReference |
References the internal VDU CPD which is used to instantiate internal CPs. These internal CPs are, in turn, exposed as external CPs defined by this external CPD. One and only one of the following attributes shall be present: intVirtualLinkDesc or intCpd or vipCpd. |
Vnf::ObjectClasses::VnfExtCpd ::_intCpd |
vipCpd |
Identifier |
0..1 |
OpenModelAttribute
PassedByReference Experimental |
References the VIP CPD which is used to instantiate CPs to hold virtual IP addresses. These CPs are, in turn, exposed as external CPs defined by this external CPD. One and only one of the following attributes shall be present: intVirtualLinkDesc or intCpd or vipCpd . |
Vnf::ObjectClasses::VnfExtCpd ::vipCpd |
virtualNetworkInterfaceRequirements |
VirtualNetworkInterfaceRequirements |
0..* |
OpenModelAttribute
Preliminary |
Specifies requirements on a virtual network interface realising the CPs instantiated from this CPD. NOTE: In case of referencing an intCpd via its identifier, the virtualNetworkInterfaceRequirements attribute of the referenced intCpd applies. |
Vnf::ObjectClasses::VnfExtCpd ::virtualNetworkInterfaceRequirements |
virtualCpd |
Identifier |
0..1 |
OpenModelAttribute
Reference
Experimental |
References the Virtual CPD which is used to describe a virtual connection point allowing to access a set of VNFC instances (based on their respective VDUs). |
Vnf::ObjectClasses::VnfExtCpd ::virtualCpd |
VnfIndicator
The VnfIndicator information element defines the indicator the VNF supports.
Applied stereotypes:
Preliminary
Reference
reference: IFA011 v3.3.1
OpenModelClass
support: MANDATORY
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
id |
Identifier |
1 |
OpenModelAttribute
Preliminary |
Unique identifier. |
Vnf::ObjectClasses::VnfIndicator::id |
name |
String |
0..1 |
OpenModelAttribute
Preliminary |
The human readable name of the VnfIndicator. |
Vnf::ObjectClasses::VnfIndicator::name |
indicatorValue |
String |
1..* |
OpenModelAttribute
Preliminary |
Defines the allowed values or value ranges of this indicator. |
Vnf::ObjectClasses::VnfIndicator::indicatorValue |
source |
VnfSource |
1 |
OpenModelAttribute
Preliminary |
Describe the source of the indicator. This tells the consumer where to send the subscription request. |
Vnf::ObjectClasses::VnfIndicator::source |
VnfInterfaceDetails
The VnfInterfaceDetails information element specifies the details of an interface produced by the VNF on the Ve-Vnfm reference point.
Applied stereotypes:
Reference
reference: IFA011 v3.3.1
Experimental
OpenModelClass
support: MANDATORY
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
cpdid |
Identifier |
1..* |
OpenModelAttribute
Experimental |
References one or more CPDs from which to instantiate external CPs through which interface endpoints on the VNF side can be reached by the VNFM. |
Vnf::ObjectClasses::VnfInterfaceDetails::cpdid |
interfacedetails |
invalid |
0..1 |
OpenModelAttribute
Experimental |
Provide additional data to access the interface endpoint (e.g. API URI prefix). |
Vnf::ObjectClasses::VnfInterfaceDetails::interfacedetails |
VnfLcmOperationCoordination
This information element defines the sets of information needed for a coordination action in a VNF lifecycle management operation.
Applied stereotypes:
Reference
reference: IFA011 v3.3.1
Experimental
OpenModelClass
support: MANDATORY
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
vnfLcmOpCoordinationId |
Identifier |
1 |
OpenModelAttribute
|
Identifies the specific VNF LCM operation coordination action. |
Vnf::ObjectClasses::VnfLcmOperationCoordination::vnfLcmOpCoordinationId |
description |
String |
1 |
OpenModelAttribute
|
Human readable description of the coordination action. |
Vnf::ObjectClasses::VnfLcmOperationCoordination::description |
endpointType |
EndpointType |
1 |
OpenModelAttribute
|
Specifies the type of the endpoint exposing the LCM operation coordination such as other operations supporting or management systems (e.g. an EM) or the VNF instance. Allowed values: ? MGMT: coordination with other operation supporting management systems. ? VNF: coordination with the VNF instance. |
Vnf::ObjectClasses::VnfLcmOperationCoordination::endpointType |
coordinationStage |
invalid |
0..1 |
OpenModelAttribute
|
Indicates the coordination stage during the VNF LCM operation. |
Vnf::ObjectClasses::VnfLcmOperationCoordination::coordinationStage |
coordinationParams |
invalid |
0..1 |
OpenModelAttribute
|
Input information needed by the external coordinating entity. |
Vnf::ObjectClasses::VnfLcmOperationCoordination::coordinationParams |
VnfPackageChangeInfo
A VnfPackageChangeInfo information element describes the processes and rules to be used for performing the resource related tasks while assisting the “change current VNF Package” to change a VNF instance to a different VNF Package (destination package). When creating a VNF package, the VNF vendor can include VnfPackageChangeInfo information elements in the package which allow the package to act as a source package or as a destination package for a modification in relation to another package, which has been created earlier or at the same time. To populate a VnfPackageChangeInfo information element and the underlying related information elements, knowledge of both the source package and the destination package is required.
Applied stereotypes:
Reference
reference: IFA011 v3.3.1
Experimental
OpenModelClass
support: MANDATORY
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
selector |
VersionSelector |
1 |
OpenModelAttribute
|
Information to identify the source and destination VNFD for the change, and the related deployment flavours. |
Vnf::ObjectClasses::VnfPackageChangeInfo::selector |
additionalParamsId |
Identifier |
0..1 |
OpenModelAttribute
|
References the ChangeCurrentVnfPackageOpConfig information element that defines the valid additional parameters for the change. |
Vnf::ObjectClasses::VnfPackageChangeInfo::additionalParamsId |
modificationQualifier |
ModificationQualifier |
1 |
OpenModelAttribute
|
Specifies the type of modification resulting from transitioning from srcVnfdId to dstVnfdId. The possible values are: UP - indicating that the destination VNF version is newer than the source version, DOWN - indicating that the destination VNF version is older than the source version. |
Vnf::ObjectClasses::VnfPackageChangeInfo::modificationQualifier |
additionalModificationDescription |
String |
0..* |
OpenModelAttribute
|
A VNF provider may define additional information to qualify further the change between the two versions, such as “VNF upgrade”, “VNF update”, “VNF downgrade”, etc. |
Vnf::ObjectClasses::VnfPackageChangeInfo::additionalModificationDescription |
componentMapping |
ComponentMapping |
0..* |
OpenModelAttribute
|
Mapping information related to identifiers of components in source VNFD and destination VNFD that concern to the change process. |
Vnf::ObjectClasses::VnfPackageChangeInfo::componentMapping |
lcmScriptId |
Identifier |
1 |
OpenModelAttribute
|
References a lifecycle management script that is executed as part of this “change current VNF Package” process. |
Vnf::ObjectClasses::VnfPackageChangeInfo::lcmScriptId |
coordinationId |
Identifier |
0..* |
OpenModelAttribute
|
References applicable VNF LCM operation coordination actions. |
Vnf::ObjectClasses::VnfPackageChangeInfo::coordinationId |
dstFlavourId |
Identifier |
1 |
OpenModelAttribute
|
Identifies the deployment flavour in the destination VNF package for which this change applies. The flavour ID is defined in the destination VNF package. |
Vnf::ObjectClasses::VnfPackageChangeInfo::dstFlavourId |
VnfVirtualLink
Parent class: VirtualLink
Applied stereotypes:
OpenModelClass
support: MANDATORY
VnfVirtualLinkDesc
Represents the type of network connectivity mandated by the VNF vendor between two or more Connection Points which includes at least one Internal Connection Point.
Parent class: VirtualLinkDesc
Applied stereotypes:
Reference
reference: IFA011 v3.3.1
Experimental
OpenModelClass
support: MANDATORY
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
monitoringParameter |
MonitoringParameter |
0..* |
OpenModelAttribute
Experimental |
Specifies the virtualised resource related performance metrics on VLD level to be tracked by the VNFM. |
Vnf::ObjectClasses::VnfVirtualLinkDesc::monitoringParameter |
_virtualLinkDescFlavour |
VirtualLinkDescFlavour |
1..* |
OpenModelAttribute
Preliminary |
Describes a specific flavour of the VL with specific bitrate requirements. |
Vnf::ObjectClasses::VnfVirtualLinkDesc::_virtualLinkDescFlavour |
virtualLinkDescId |
Identifier |
1 |
OpenModelAttribute
Preliminary |
Uniquely identifies a VLD in the parent descriptor. For VnfVirtualLinkDesc, the parent descriptor is the VNFD. For NsVirtualLinkDesc, the parent descriptor is the NSD. Note: the description of this class are different in ETSI GS NFV IFA 011 and ETSI GS NFV IFA 014. The present definition merges the 2 definitions. |
Common::Network::NetworkObjectClasses::VirtualLinkDesc::virtualLinkDescId |
connectivityType |
ConnectivityType |
1 |
OpenModelAttribute
Preliminary |
Specifies the protocol exposed by a VL and the flow pattern supported by the VL. |
Common::Network::NetworkObjectClasses::VirtualLinkDesc::connectivityType |
description |
String |
0..1 |
OpenModelAttribute
Preliminary |
Provides human-readable information on the purpose of the VL (e.g. control plane traffic). |
Common::Network::NetworkObjectClasses::VirtualLinkDesc::description |
validFor |
TimePeriod |
0..1 |
OpenModelAttribute
Preliminary |
The period during which the design entity is valid. |
Common::Root::RootObjectClasses::DesignEntity::validFor |
status |
String |
1 |
OpenModelAttribute
Preliminary |
The condition of the specification, such s active, inactive, or planned. |
Common::Root::RootObjectClasses::DesignEntity::status |
name |
String |
1 |
OpenModelAttribute
Preliminary |
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). |
Common::Root::RootObjectClasses::DesignEntity::name |
description |
String |
1 |
OpenModelAttribute
Preliminary |
Defines a textual free-form description of the object. |
Common::Root::RootObjectClasses::DesignEntity::description |
id |
Identifier |
1 |
OpenModelAttribute
Preliminary |
Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. |
Common::Root::RootObjectClasses::RootEntity::id |
VnfcCp
Parent class: Cp
Applied stereotypes:
Experimental
OpenModelClass
support: MANDATORY
Vnfd
A Vnfd, or VNF Descriptor, is template which describes a VNF in terms of deployment and operational behaviour requirements. It also contains connectivity, interface and virtualised resource requirements.
Parent class: NetworkFunctionDesc
Applied stereotypes:
Preliminary
Reference
reference: IFA011 v4.1.1
OpenModelClass
support: MANDATORY
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
vnfdId |
Identifier |
1 |
OpenModelAttribute
Preliminary |
Identifier of this VNFD information element. This attribute shall be globally unique. NOTE: The VNFD Identifier shall be used as the unique identifier of the VNF Package that contains this VNFD. Any modification of the content of the VNFD or the VNF Package shall result in a new VNFD Identifier. |
Vnf::ObjectClasses::Vnfd::vnfdId |
vnfProvider |
String |
1 |
OpenModelAttribute
Preliminary |
Provider of the VNF and of the VNFD. |
Vnf::ObjectClasses::Vnfd::vnfProvider |
vnfProductName |
String |
1 |
OpenModelAttribute
Preliminary |
Name to identify the VNF Product. Invariant for the VNF Product lifetime. |
Vnf::ObjectClasses::Vnfd::vnfProductName |
vnfSoftwareVersion |
Version |
1 |
OpenModelAttribute
Preliminary |
Software version of the VNF. This is changed when there is any change to the software that is included in the VNF Package. |
Vnf::ObjectClasses::Vnfd::vnfSoftwareVersion |
vnfdVersion |
Version |
1 |
OpenModelAttribute
Preliminary |
Identifies the version of the VNFD. |
Vnf::ObjectClasses::Vnfd::vnfdVersion |
vnfProductInfoName |
String |
0..1 |
OpenModelAttribute
Preliminary |
Human readable name for the VNF Product. Can change during the VNF Product lifetime. |
Vnf::ObjectClasses::Vnfd::vnfProductInfoName |
vnfProductInfoDescription |
String |
0..1 |
OpenModelAttribute
Preliminary |
Human readable description of the VNF Product. Can change during the VNF Product lifetime. |
Vnf::ObjectClasses::Vnfd::vnfProductInfoDescription |
vnfmInfo |
String |
0..* |
OpenModelAttribute
Preliminary |
Identifies VNFM(s) compatible with the VNF described in this version of the VNFD. Use the name of micro-service of the vnfm drive. For vendor specific VNFM, the value composes of “vendorname” and “vnfmdriver”, e.g. “mycompanyvnfmdriver”; for generic VNFM, the value is “gvnfmdriver”. |
Vnf::ObjectClasses::Vnfd::vnfmInfo |
localizationLanguage |
String |
0..* |
OpenModelAttribute
Preliminary |
Information about localization languages of the VNF (includes e.g. strings in the VNFD). Refer to ISO936 https://www.iso.org/iso-639-language-codes.html NOTE: This allows to provide one or more localization languages to support selecting a specific localization language at VNF instantiation time. |
Vnf::ObjectClasses::Vnfd::localizationLanguage |
defaultLocalizationLanguage |
String |
0..1 |
OpenModelAttribute
Preliminary |
Information about localization languages of the VNF (includes e.g. strings in the VNFD). Refer to ISO936 https://www.iso.org/iso-639-language-codes.html NOTE: This allows to provide one or more localization languages to support selecting a specific localization language at VNF instantiation time. |
Vnf::ObjectClasses::Vnfd::defaultLocalizationLanguage |
vdu |
Vdu |
1..* |
OpenModelAttribute
Preliminary |
Virtualisation Deployment Unit. |
Vnf::ObjectClasses::Vnfd::vdu |
virtualComputeDesc |
VirtualComputeDesc |
0..* |
OpenModelAttribute
Preliminary |
Defines descriptors of virtual compute resources to be used by the VNF when each of the VNFC instances of the VNF is intended to be deployed in a single VM. |
Vnf::ObjectClasses::Vnfd::virtualComputeDesc |
virtualStorageDesc |
VirtualStorageDesc |
0..* |
OpenModelAttribute
Preliminary |
Defines descriptors of virtual storage resources to be used by the VNF. |
Vnf::ObjectClasses::Vnfd::virtualStorageDesc |
osContainerDesc |
OsContainerDesc |
0..* |
OpenModelAttribute
Reference
Experimental |
Defines descriptors of container compute resources to be used by the VNF when the VDUs of the VNF are realized by a set of OS Containers sharing the same host and same networking namespace. |
Vnf::ObjectClasses::Vnfd::osContainerDesc |
swImageDesc |
SwImageDesc |
0..* |
OpenModelAttribute
Preliminary |
Defines descriptors of software images to be used by the VNF. NOTE: This shall be used to describe both the software image loaded on the virtualization container used to realize a VDU and the software images to be stored on VirtualStorage resources (e.g., volumes) attached to a virtualization container. |
Vnf::ObjectClasses::Vnfd::swImageDesc |
intVirtualLinkDesc |
VnfVirtualLinkDesc |
0..* |
OpenModelAttribute
Preliminary |
Represents the type of network connectivity mandated by the VNF provider between two or more CPs which includes at least one internal CP. |
Vnf::ObjectClasses::Vnfd::intVirtualLinkDesc |
securityGroupRule |
SecurityGroupRule |
0..* |
OpenModelAttribute
Experimental |
Defines security group rules to be used by the VNF. |
Vnf::ObjectClasses::Vnfd::securityGroupRule |
vnfExtCpd |
VnfExtCpd |
1..* |
OpenModelAttribute
Preliminary |
Describes external interface(s) exposed by this VNF enabling connection with a VL. |
Vnf::ObjectClasses::Vnfd::vnfExtCpd |
vipcpd |
vipCpd |
0..* |
OpenModelAttribute
Experimental |
Describes virtual IP addresses to be shared among instances of connection points. |
Vnf::ObjectClasses::Vnfd::vipcpd |
virtualCpd |
VirtualCpd |
0..* |
OpenModelAttribute
Reference
Experimental |
Describes a virtual connection point allowing to access a set of VNFC instances (based on their respective VDUs). |
Vnf::ObjectClasses::Vnfd::virtualCpd |
deploymentFlavour |
VnfDf |
1..* |
OpenModelAttribute
Preliminary |
Describes specific DF(s) of a VNF with specific requirements for capacity and performance. |
Vnf::ObjectClasses::Vnfd::deploymentFlavour |
configurableProperties |
VnfConfigurableProperties |
0..1 |
OpenModelAttribute
Preliminary |
Describes the configurable properties of the VNF (e.g. related to auto scaling and auto healing). |
Vnf::ObjectClasses::Vnfd::configurableProperties |
modifiableAttributes |
VnfInfoModifiableAttributes |
0..1 |
OpenModelAttribute
Preliminary |
Defines the VNF-specific extension and metadata attributes of the VnfInfo that are writeable via the ModifyVnfInfo operation. |
Vnf::ObjectClasses::Vnfd::modifiableAttributes |
lifecycleManagementScript |
VnfLifecycleManagementScript |
0..* |
OpenModelAttribute
Preliminary |
Includes a list of events and corresponding management scripts performed for the VNF. |
Vnf::ObjectClasses::Vnfd::lifecycleManagementScript |
vnfIndicator |
VnfIndicator |
0..* |
OpenModelAttribute
Preliminary |
Declares the VNF indicators that are supported by this VNF. |
Vnf::ObjectClasses::Vnfd::vnfIndicator |
autoScale |
Rule |
0..* |
OpenModelAttribute
Reference
Experimental |
Rule that determines when a scaling action needs to be triggered on a VNF instance e.g. based on certain VNF indicator values or VNF indicator value changes or a combination of VNF indicator value(s) and monitoring parameter(s). |
Vnf::ObjectClasses::Vnfd::autoScale |
vnfpackagechangeinfo |
VnfPackageChangeInfo |
0..* |
OpenModelAttribute
Reference
Experimental |
Information used for performing the change of the current VNF Package. More than one VNF Package Change Info construct is possible to cater the possibility that changes of the current VNF Package can be performed for different source VNFDs. |
Vnf::ObjectClasses::Vnfd::vnfpackagechangeinfo |
lcmOperationCoordination |
VnfLcmOperationCoordination |
0..* |
OpenModelAttribute
Reference
Experimental |
Provides information used for the coordination in VNF LCM operations. |
Vnf::ObjectClasses::Vnfd::lcmOperationCoordination |
mciopId |
Identifier |
0..* |
OpenModelAttribute
Reference
Experimental |
Identifies the MCIOP(s) in the VNF package, used in containerized workload management, when the VNF is realized by a set of OS containers. |
Vnf::ObjectClasses::Vnfd::mciopId |
isSharable |
Boolean |
1 |
OpenModelAttribute
Experimental |
Indicates whether the NetworkFunction can be shared. |
Nf::ObjectClasses::NetworkFunctionDesc::isSharable |
validFor |
TimePeriod |
0..1 |
OpenModelAttribute
Preliminary |
The period during which the design entity is valid. |
Common::Root::RootObjectClasses::DesignEntity::validFor |
status |
String |
1 |
OpenModelAttribute
Preliminary |
The condition of the specification, such s active, inactive, or planned. |
Common::Root::RootObjectClasses::DesignEntity::status |
name |
String |
1 |
OpenModelAttribute
Preliminary |
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). |
Common::Root::RootObjectClasses::DesignEntity::name |
description |
String |
1 |
OpenModelAttribute
Preliminary |
Defines a textual free-form description of the object. |
Common::Root::RootObjectClasses::DesignEntity::description |
id |
Identifier |
1 |
OpenModelAttribute
Preliminary |
Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. |
Common::Root::RootObjectClasses::RootEntity::id |
vipCpd
A VipCpd is a type of Cpd and describes a requirement to allocate one or a set of virtual IP addresses. A VipCpd inherits from the Cpd Class . All attributes of the Cpd are also attributes of the VipCpd. When intCpds are indicated, instances of VduCps created from those intCpds share the addresses created from the VipCpd. When vnfExtCpds are indicated, instances of VnfExtCps created from those vnfExtCpds share the addresses created from the VipCpd.
Parent class: Cpd
Applied stereotypes:
Reference
reference: IFA011 v3.3.1
Experimental
OpenModelClass
support: MANDATORY
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
intCpd |
Identifier |
0..* |
OpenModelAttribute
PassedByReference Experimental |
References the internal VDU CPD which is used to instantiate internal CPs. These internal CPs share the virtual IP addresses allocated when a VipCp instance is created from the VipCpd. |
Vnf::ObjectClasses::vipCpd::intCpd |
vnfExtCpd |
Identifier |
0..* |
OpenModelAttribute
PassedByReference |
References the VNF external CPD which is used to instantiate external CPs. These external CPs share the virtual IP addresses allocated when a VipCp instance is created from the VipCpd. |
Vnf::ObjectClasses::vipCpd::vnfExtCpd |
cpdId |
Identifier |
1 |
OpenModelAttribute
Preliminary |
Identifier of this Cpd information element. |
Common::Network::NetworkObjectClasses::Cpd ::cpdId |
cpdRole |
String |
0..1 |
OpenModelAttribute
Preliminary |
Identifies the role of the port in the context of the traffic flow patterns in the VNF or parent NS. For example a VNF with a tree flow pattern within the VNF will have legal cpRoles of ROOT and LEAF. |
Common::Network::NetworkObjectClasses::Cpd ::cpdRole |
description |
String |
0..1 |
OpenModelAttribute
Preliminary |
Provides human-readable information on the purpose of the CP (e.g. CP for control plane traffic). |
Common::Network::NetworkObjectClasses::Cpd ::description |
cpProtocol |
CpProtocolData |
0..* |
OpenModelAttribute
Experimental |
Identifies the protocol layering information the CP uses for connectivity purposes and associated information. There shall be one cpProtocol for each layer protocol as indicated by the attribute layerProtocol. Editor’s note: the attribute “layerProtocol” still needs further discussion and not included in this table. |
Common::Network::NetworkObjectClasses::Cpd ::cpProtocol |
trunkMode |
Boolean |
0..1 |
OpenModelAttribute
Experimental |
Information about whether the CP instantiated from this CPD is in Trunk mode (802.1Q or other). |
Common::Network::NetworkObjectClasses::Cpd ::trunkMode |
layerProtocol |
LayerProtocol |
1..* |
OpenModelAttribute
Experimental |
Identifies which protocol the CP uses for connectivity purposes (Ethernet, MPLS, ODU2, IPV4, IPV6, Pseudo-Wire, etc.). |
Common::Network::NetworkObjectClasses::Cpd ::layerProtocol |
securityGroupRuleId |
Identifier |
0..* |
OpenModelAttribute
Experimental |
Reference of the security group rules bound to this CPD. |
Common::Network::NetworkObjectClasses::Cpd ::securityGroupRuleId |
Associations
VnfdUsesVirtualComputeDesc
Defines descriptors of virtual compute resources to be used by the VNF.
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
virtualComputeDesc |
shared |
Navig. |
VirtualComputeDesc |
0..* |
Defines descriptors of virtual compute resources to be used by the VNF when each of the VNFC instances of the VNF is intended to be deployed in a single VM. |
vnfd |
none |
Not navig. |
Vnfd |
1 |
VnfdHasVdu
References to Vdus that are part of this group.
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
vdu |
composite |
Navig. |
Vdu |
1..* |
Virtualisation Deployment Unit. |
_vnfd |
none |
Not navig. |
Vnfd |
1 |
VnfdHasVnfDf
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
deploymentFlavour |
composite |
Navig. |
VnfDf |
1..* |
Describes specific DF(s) of a VNF with specific requirements for capacity and performance. |
_vnfd |
none |
Not navig. |
Vnfd |
1 |
VnfdHasExtCpd
Describes external interface(s) exposed by this VNF enabling connection with a VL.
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_vnfd |
none |
Not navig. |
Vnfd |
0..1 |
|
vnfExtCpd |
composite |
Navig. |
VnfExtCpd |
1..* |
Describes external interface(s) exposed by this VNF enabling connection with a VL. |
VnfdHasVnfIndicator
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_vnfd |
none |
Not navig. |
Vnfd |
1 |
|
vnfIndicator |
shared |
Navig. |
VnfIndicator |
0..* |
Declares the VNF indicators that are supported by this VNF. |
VnfdHasVSDesc
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
virtualStorageDesc |
shared |
Navig. |
VirtualStorageDesc |
0..* |
Defines descriptors of virtual storage resources to be used by the VNF. |
_vnfd |
none |
Not navig. |
Vnfd |
1 |
VduHasInternalVduCpd
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
intCpd |
shared |
Navig. |
VduCpd |
1 |
Describes network connectivity between a VNFC instance (based on this Vdu) and an internal Virtual Link (VL). |
_vdu |
none |
Not navig. |
Vdu |
1 |
VduHasVCDesc
Describes CPU, Memory and acceleration requirements of the Virtualisation Container realising this Vdu.
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
virtualComputeDesc |
shared |
Navig. |
VirtualComputeDesc |
1..* |
Describes CPU, Memory and acceleration requirements of the Virtualisation Container realising this Vdu. |
_vdu |
none |
Not navig. |
Vdu |
1 |
VduHasVSDesc
Describes storage requirements for a VirtualStorage instance attached to the virtualisation container created from virtualComputeDesc defined for this Vdu. support:
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_vdu |
none |
Not navig. |
Vdu |
0..* |
|
virtualStorageDesc |
shared |
Navig. |
VirtualStorageDesc |
0..* |
Describes storage requirements for a VirtualStorage instance attached to the virtualisation container created from virtualComputeDesc defined for this Vdu. |
VduHasSwImageDesc
Describes the software image which is directly loaded on the virtualisation container realising this Vdu. NOTE: More software images can be attached to the virtualisation container using VirtualStorage resources.
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
swImageDesc |
shared |
Navig. |
SwImageDesc |
0..1 |
Describes the software image which is directly loaded on the virtualisation container realising this Vdu. NOTE: More software images can be attached to the virtualisation container using VirtualStorage resources. |
_vdu |
none |
Not navig. |
Vdu |
1..* |
SwImageLoadedOnVS
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
swimagedesc |
none |
Not navig. |
SwImageDesc |
0..1 |
|
virtualstoragedesc |
none |
Not navig. |
VirtualStorageDesc |
0..* |
VnfExtCpdMapstoVduCpd
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_intCpd |
none |
Navig. |
VduCpd |
0..1 |
References the internal VDU CPD which is used to instantiate internal CPs. These internal CPs are, in turn, exposed as external CPs defined by this external CPD. One and only one of the following attributes shall be present: intVirtualLinkDesc or intCpd or vipCpd. |
_vnfExtCpd |
none |
Not navig. |
VnfExtCpd |
0..1 |
VLProfileHasVLDescFlavour
Identifies a flavour within a VnfVirtualLinkDesc.
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_flavourId |
shared |
Navig. |
VirtualLinkDescFlavour |
1 |
Identifies a flavour within the VnfVirtualLinkDesc. |
virtuallinkprofile |
none |
Not navig. |
VirtualLinkProfile |
1 |
VduCpdHasVNIR
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_virtualNetworkInterfaceRequirements |
composite |
Navig. |
VirtualNetworkInterfaceRequirements |
0..* |
Specifies requirements on a virtual network interface realising the CPs instantiated from this CPD. |
_vducpd |
none |
Not navig. |
VduCpd |
1 |
VnfDfHasAorAAGroup
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_affinityOrAntiAffinityGroup |
shared |
Navig. |
AffinityOrAntiAffinityGroup |
0..* |
Specifies affinity or anti-affinity relationship applicable between the virtualisation containers (e.g. virtual machines) to be created using different VDUs or internal VLs to be created using different VnfVirtualLinkDesc(s) in the same affinity or anti-affinity group. NOTE: In the present specification, including either VDU(s) or VnfVirtualLinkDesc(s) into the same affinity or anti-affinity group is supported. Extension to support including both VDU(s) and VnfVirtualLinkDesc(s) into the same affinity or anti-affinity group is left for future specification. |
_vnfDf |
none |
Not navig. |
VnfDf |
1..* |
VnfDfHasIL
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_instantiationLevel |
shared |
Navig. |
InstantiationLevel |
1..* |
Describes the various levels of resources that can be used to instantiate the VNF using this flavour. Examples: Small, Medium, Large. If there is only one “instantiationLevel” entry, it shall be treated as the default instantiation level for this DF. |
_vnfDf |
none |
Not navig. |
VnfDf |
1 |
VnfDfHasScalingAspect
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_scalingAspect |
shared |
Navig. |
ScalingAspect |
0..* |
The scaling aspects supported by this DF of the VNF. scalingAspect shall be present if the VNF supports scaling. |
_vnfDf |
none |
Not navig. |
VnfDf |
1..* |
VnfDfHasVLProfile
Defines the internal VLD along with additional data which is used in this DF. NOTE 1: This allows for different VNF internal topologies between DFs. NOTE 2: virtualLinkProfile needs to be provided for all VLs that the CPs of the VDUs in the VDU profiles connect to.
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_virtuaLlinkProfile |
shared |
Navig. |
VirtualLinkProfile |
0..* |
Defines the internal VLD along with additional data which is used in this DF. NOTE 1: This allows for different VNF internal topologies between DFs. NOTE 2: virtualLinkProfile needs to be provided for all VLs that the CPs of the VDUs in the VDU profiles connect to. |
_vnfDf |
none |
Not navig. |
VnfDf |
1..* |
VnfExtCdpHasVNIR
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
virtualNetworkInterfaceRequirements |
composite |
Navig. |
VirtualNetworkInterfaceRequirements |
0..* |
Specifies requirements on a virtual network interface realising the CPs instantiated from this CPD. NOTE: In case of referencing an intCpd via its identifier, the virtualNetworkInterfaceRequirements attribute of the referenced intCpd applies. |
_vnfExtCpd |
none |
Not navig. |
VnfExtCpd |
1 |
ILHasVduLevel
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_vduLevel |
composite |
Navig. |
VduLevel |
1..* |
Indicates the number of instance of this VDU to deploy for this level. |
_instantiationLevel |
none |
Not navig. |
InstantiationLevel |
1 |
VnfDfHasVduProfile
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_vduProfile |
shared |
Navig. |
VduProfile |
1..* |
Describes additional instantiation data for the VDUs used in this flavor. |
vnfdf |
none |
Not navig. |
VnfDf |
1..* |
VnfcDeployedUsingVdu
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_vdu |
none |
Navig. |
Vdu |
1 |
Reference to the VDU |
vnfc (vnfcinstance) |
none |
Not navig. |
Vnfc |
0..* |
VnfProfileReferencesVnfDf
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
flavourId |
none |
Navig. |
VnfDf |
1 |
Identifies a flavour within the VNFD. |
_vnfProfile |
none |
Not navig. |
VnfProfile |
0..* |
VnfProfileReferencesVnfd
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
vnfdId |
none |
Navig. |
Vnfd |
0..1 |
Reference to the VNFD. |
_vnfProfile |
none |
Not navig. |
VnfProfile |
0..* |
VnfdHasSwImageDesc
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
swImageDesc |
composite |
Navig. |
SwImageDesc |
0..* |
Defines descriptors of software images to be used by the VNF. NOTE: This shall be used to describe both the software image loaded on the virtualization container used to realize a VDU and the software images to be stored on VirtualStorage resources (e.g., volumes) attached to a virtualization container. |
_vnfd |
none |
Not navig. |
Vnfd |
1 |
SwImageDescHasSwImage
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_swImage |
none |
Navig. |
SwImage |
1 |
This is a reference to the actual software image. The reference can be relative to the root of the VNF Package or can be a URL |
_swImageDesc |
none |
Not navig. |
SwImageDesc |
1 |
VCDHasLNRequirements
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_logicalNodeRequirements |
composite |
Navig. |
LogicalNodeRequirements |
0..* |
The associated logical node requirements. |
_virtualComputeDesc |
none |
Not navig. |
VirtualComputeDesc |
1 |
VnfdHasInternalVnfVLDesc
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
intVirtualLinkDesc |
none |
Navig. |
VnfVirtualLinkDesc |
0..* |
Represents the type of network connectivity mandated by the VNF provider between two or more CPs which includes at least one internal CP. |
_vnfd |
none |
Not navig. |
Vnfd |
1 |
VirtualLinkProfileHasDescId
Uniquely references a VLD.
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_vnfVirtualLinkDescId |
none |
Navig. |
VnfVirtualLinkDesc |
1 |
Uniquely references a VLD. |
_virtualLinkProfile |
none |
Not navig. |
VirtualLinkProfile |
1 |
VduCpdHasInternvalVnfVLDesc
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_intVirtualLinkDesc |
none |
Navig. |
VnfVirtualLinkDesc |
0..1 |
Reference(s) of the Virtual Link Descriptor to which this Connection Point Descriptor(s) connects. |
_vduCpd |
none |
Not navig. |
VduCpd |
1 |
VnfVLDescHasVLDescFlavour
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_virtualLinkDescFlavour |
composite |
Navig. |
VirtualLinkDescFlavour |
1..* |
Describes a specific flavour of the VL with specific bitrate requirements. |
_vnfVirtualLinkDesc |
none |
Not navig. |
VnfVirtualLinkDesc |
1 |
VnfExtCpdHasVLDesc
Reference to the internal Virtual Link Descriptor (VLD) to which CPs instantiated from this external CP Descriptor (CPD) connect.
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_intVirtualLinkDesc |
none |
Navig. |
VnfVirtualLinkDesc |
0..1 |
References the internal Virtual Link Descriptor (VLD) to which CPs instantiated from this external CP Descriptor (CPD) connect. One and only one of the following attributes shall be present: intVirtualLinkDesc or intCpd or vipCpd. |
_vnfExtCpd |
none |
Not navig. |
VnfExtCpd |
1 |
VduProfileReferencesVdu
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_vduId |
shared |
Navig. |
Vdu |
1 |
|
_vduProfile |
none |
Not navig. |
VduProfile |
0..* |
VnfDfHasVnfIndicator
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
vnfIndicator |
none |
Navig. |
VnfIndicator |
0..* |
Declares the VNF indicators that are supported by this VNF (specific to this DF). |
_vnfDf |
none |
Not navig. |
VnfDf |
1 |
VlProfileHasAffOrAntiAffGroup
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_affinityOrAntiAffinityGroupId |
none |
Navig. |
AffinityOrAntiAffinityGroup |
0..* |
Identifies an affinity or anti-affinity group the VLs instantiated according to the VlProfile belong to. NOTE : Each identifier references an affinity or anti-affinity group which expresses affinity or anti-affinity relationship between the VL(s) using this VirtualLinkProfile and the VL(s) using other VirtualLinkProfile(s) in the same group. |
virtuallinkprofile |
none |
Not navig. |
VirtualLinkProfile |
0..* |
VduLevelHasVdu
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_vduId |
none |
Navig. |
Vdu |
1 |
Uniquely identifies a VDU. |
vdulevel |
none |
Not navig. |
VduLevel |
1 |
VnfdDefinesSecurityGroupRule
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
securityGroupRule |
none |
Navig. |
SecurityGroupRule |
0..* |
Defines security group rules to be used by the VNF. |
_vnfd |
none |
Not navig. |
Vnfd |
1 |
VNIRHasLNR
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_nicIoRequirements |
none |
Navig. |
LogicalNodeRequirements |
0..1 |
This references (couples) the CPD with any logical node I/O requirements (for network devices) that may have been created. Linking these attributes is necessary so that so that I/O requirements that need to be articulated at the logical node level can be associated with the network interface requirements associated with the CPD. |
_virtualNetworkInterfaceRequirements |
none |
Not navig. |
VirtualNetworkInterfaceRequirements |
1 |
VnfdhasVipCpd
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
vipcpd |
composite |
Navig. |
vipCpd |
0..* |
Describes virtual IP addresses to be shared among instances of connection points. |
vnfd |
none |
Not navig. |
Vnfd |
1 |
VnfDfHasSupportedVnfInterface
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
vnfdf |
none |
Not navig. |
VnfDf |
1 |
|
supportedVnfInterface |
composite |
Navig. |
VnfInterfaceDetails |
0..* |
Indicates which interfaces the VNF produces and provides additional details on how to access the interface endpoints. |
SwImageDescHasCheckSumData
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
checksumdata |
none |
Navig. |
ChecksumData |
1 |
|
swimagedesc |
none |
Not navig. |
SwImageDesc |
1 |
VnfdHasVnfPackageChangeInfo
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
vnfpackagechangeinfo |
composite |
Navig. |
VnfPackageChangeInfo |
0..* |
Information used for performing the change of the current VNF Package. More than one VNF Package Change Info construct is possible to cater the possibility that changes of the current VNF Package can be performed for different source VNFDs. |
vnfd |
none |
Not navig. |
Vnfd |
1 |
VnfdHasLcmOpCoordination
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
lcmOperationCoordination |
composite |
Navig. |
VnfLcmOperationCoordination |
0..* |
Provides information used for the coordination in VNF LCM operations. |
vnfd |
none |
Not navig. |
Vnfd |
1 |
VnfdHasOsContainerDesc
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
osContainerDesc |
composite |
Navig. |
OsContainerDesc |
0..* |
Defines descriptors of container compute resources to be used by the VNF when the VDUs of the VNF are realized by a set of OS Containers sharing the same host and same networking namespace. |
vnfd |
none |
Not navig. |
Vnfd |
1 |
VnfDfHasMciopProfile
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
mciopProfile |
composite |
Navig. |
MciopProfile |
0..* |
Describes additional instantiation data for the MCIOPs used in this deployment flavour. This attribute shall be present if the DF references (via the vduProfile) containerized workloads based on a MCIOP. |
vnfdf |
none |
Not navig. |
VnfDf |
1 |
VduRefOsContainerDesc
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
osContainerdesc |
none |
Navig. |
OsContainerDesc |
0..* |
Describes CPU, memory requirements and limits, and software images of the OS Containers realizing this Vdu corresponding to OS Containers sharing the same host and same network namespace. Each unique identifier is referenced only once within one VDU. |
vdu |
none |
Not navig. |
Vdu |
1 |
Data Types
AdditionalServiceData
This information element describes the additional service data of the VirtualCp used to expose properties of the VirtualCp to NFV-MANO. If the VirtualCp is exposed by a VNF component realized by one or a set of OS containers, the properties are mirrored from the declarative descriptor of the corresponding MCIO where available.
Applied stereotypes:
Reference
reference: IFA011 v4.1.1
Experimental
Attribute Name |
Type |
Mult. |
Access |
Stereotypes |
Description |
portData |
ServicePortData |
1..* |
RW |
OpenModelAttribute
|
Service port numbers exposed by the VirtualCp. |
serviceData |
invalid |
0..1 |
RW |
OpenModelAttribute
|
Service matching information exposed by the VirtualCp NOTE: This attribute shall only be present if additional information is needed to identify the service termination within the VNF, such as for example a url path information in an HTTP request required to allow a single VirtualCp IP address to be used for several HTTP based services that use the same portnumber. |
BlockStorageData
Specifies the details of the block storage resource.
Applied stereotypes:
Preliminary
Reference
reference: IFA011 v3.3.1
Attribute Name |
Type |
Mult. |
Access |
Stereotypes |
Description |
sizeOfStorage |
Number |
1 |
RW |
OpenModelAttribute
Preliminary |
Size of virtualised storage resource in GB. |
vduStorageRequirements |
KeyValuePair |
0..* |
RW |
OpenModelAttribute
Preliminary |
An array of key-value pairs that articulate the storage deployment requirements. |
rdmaEnabled |
Boolean |
0..1 |
RW |
OpenModelAttribute
Obsolete |
Indicates if the storage supports rdma. |
swImageDesc |
SwImageDesc |
0..1 |
RW |
OpenModelAttribute
Preliminary |
Software image to be loaded on the VirtualStorage resource created based on this VirtualStorageDesc. Shall be absent when used for virtual disks. |
ComponentMapping
With respect to a “change current VNF Package” process, a ComponentMapping information element defines a mapping between the identifier of a components or property in the source VNFD and the identifier of the corresponding component or property in the destination VNFD. Examples for components are VDUs, VLDs, etc., and an example for a property is a scaling aspect of the VNF.
Applied stereotypes:
Reference
reference: IFA011 v3.3.1
Experimental
Attribute Name |
Type |
Mult. |
Access |
Stereotypes |
Description |
componentType |
invalid |
1 |
RW |
OpenModelAttribute
|
The type of component or property. Possible values differentiate whether changes concern to some VNF component (e.g. VDU, internal VLD, etc.) or property (e.g. a Scaling Aspect, etc.). |
sourceDescId |
Identifier |
1 |
RW |
OpenModelAttribute
|
Identifier of the component or property in the source VNFD. |
dstDescId |
Identifier |
1 |
RW |
OpenModelAttribute
|
Identifier of the component or property in the destination VNFD. |
description |
EString |
0..1 |
RW |
OpenModelAttribute
|
Human readable description of the component changes. |
FileStorageData
The FileStorageData information element specifies the details of file storage resource.
Applied stereotypes:
Preliminary
Reference
reference: IFA011 v3.3.1
Attribute Name |
Type |
Mult. |
Access |
Stereotypes |
Description |
sizeOfStorage |
Number |
1 |
RW |
OpenModelAttribute
Preliminary |
Size of virtualised storage resource in GB. |
fileSystemProtocol |
String |
1 |
RW |
OpenModelAttribute
Preliminary |
The shared file system protocol (e.g. NFS, CIFS). |
intVirtualLinkDesc |
VnfVirtualLinkDesc |
1 |
RW |
OpenModelAttribute
Preliminary PassedByReference |
Reference of the internal VLD which this file storage connects to. The attached VDUs shall connect to the same internal VLD. |
MonitoringParameter
Specifies the virtualized resource related performance metric to be tracked by the VNFM, e.g. for auto-scaling purposes. The VNFM collects the values of performance metrics identified by this information element from the VIM(s) using one or more locally initiated PM Jobs. These values can be used as inputs to auto-scaling rules.
Applied stereotypes:
Preliminary
Reference
reference: IFA011 v3.3.1
Attribute Name |
Type |
Mult. |
Access |
Stereotypes |
Description |
id |
Identifier |
1 |
RW |
OpenModelAttribute
Preliminary |
Unique identifier of the monitoring parameter. |
name |
String |
0..1 |
RW |
OpenModelAttribute
Preliminary |
Human readable name of the monitoring parameter. |
performanceMetric |
String |
1 |
RW |
OpenModelAttribute
Preliminary |
Identifies the virtualized resource performance metric. |
collectionPeriod |
CollectionPeriod |
0..1 |
RW |
OpenModelAttribute
Preliminary |
An attribute that describes the periodicity at which to collect the performance information. |
localAffinityOrAntiAffinityRule |
LocalAffinityOrAntiAffinityRule |
0..1 |
RW |
OpenModelAttribute
Future |
ObjectStorageData
The ObjectStorageData information element specifies the details of object storage resource.
Applied stereotypes:
Preliminary
Reference
reference: IFA011 v3.3.1
Attribute Name |
Type |
Mult. |
Access |
Stereotypes |
Description |
maxSizeOfStorage |
Number |
0..1 |
RW |
OpenModelAttribute
Preliminary |
Max size of virtualised storage resource in GB. |
RequestedAdditionalCapabilityData
This information element describes requested additional capability for a particular VDU. Such a capability may be for acceleration or specific tasks.
Applied stereotypes:
Obsolete
Attribute Name |
Type |
Mult. |
Access |
Stereotypes |
Description |
supportMandatory |
Boolean |
1 |
RW |
OpenModelAttribute
Obsolete |
Indicates whether the requested additional capability is mandatory for successful operation. |
requestedAdditionalCapabilityName |
String |
1 |
RW |
OpenModelAttribute
Obsolete |
Identifies a requested additional capability for the VDU. |
minRequestedAdditionalCapabilityVersion |
Version |
0..1 |
RW |
OpenModelAttribute
Obsolete |
Identifies the minimum version of the requested additional capability. |
preferredRequestedAdditionalCapabilityVersion |
Version |
0..1 |
RW |
OpenModelAttribute
Obsolete |
Identifies the preferred version of the requested additional capability. |
targetPerformanceParameters |
KeyValuePair |
1..* |
RW |
OpenModelAttribute
Obsolete |
Identifies specific attributes, dependent on the requested additional capability type. |
ScaleInfo
The ScaleInfo information element represents a scale level for a particular scaling aspect.
Applied stereotypes:
Preliminary
Reference
reference: IFA011 v3.3.1
Attribute Name |
Type |
Mult. |
Access |
Stereotypes |
Description |
aspectId |
ScalingAspect |
1 |
RW |
OpenModelAttribute
Preliminary PassedByReference |
Reference to the scaling aspect. |
scaleLevel |
Integer |
1 |
RW |
OpenModelAttribute
Preliminary |
The scale level, greater than or equal to 0 |
ServicePortData
This information element describes the service identifying port properties exposed by the VirtualCp.
Applied stereotypes:
Reference
reference: IFA011 v4.1.1
Experimental
Attribute Name |
Type |
Mult. |
Access |
Stereotypes |
Description |
name |
String |
1 |
RW |
OpenModelAttribute
|
The name of the port exposed by the VirtualCp. |
protocol |
Integer |
1 |
RW |
OpenModelAttribute
|
The L4 protocol for this port exposed by the VirtualCp. VALUES: ? TCP ? UDP ? SCTP |
port |
Integer |
1 |
RW |
OpenModelAttribute
|
The L4 port number exposed by the VirtualCp. |
portConfigurable |
Boolean |
1 |
RW |
OpenModelAttribute
|
Specifies whether the port attribute value is allowed to be configurable. |
StorageQos
Applied stereotypes:
Future
Attribute Name |
Type |
Mult. |
Access |
Stereotypes |
Description |
qosId |
Identifier |
1 |
RW |
OpenModelAttribute
Future |
Unique identifier of the storage Qos in VNFD. |
qosName |
String |
1 |
RW |
OpenModelAttribute
Future |
Name of storage QoS. |
consumer |
ConsumerScope |
1 |
RW |
OpenModelAttribute
Future |
Consumer type. |
qosSpecs |
KeyValuePair |
0..* |
RW |
OpenModelAttribute
Future |
Describe qualities of Qos：total_bytes_sec、total_iops_sec. |
VersionSelector
The VersionSelector information element allows to identify the source and destination VNFDs (and implicitly, VNF packages) for a “change current VNF Package”, as well as the applicable source deployment flavour. The triplet (srcVnfdId, srcFlavourId, dstVnfdId) uniquely determines a change.
Applied stereotypes:
Reference
reference: IFA011 v3.3.1
Experimental
Attribute Name |
Type |
Mult. |
Access |
Stereotypes |
Description |
srcVnfId |
Identifier |
1 |
RW |
OpenModelAttribute
|
Identifier of the source VNFD and the source VNF package. |
dstVnfId |
Identifier |
1 |
RW |
OpenModelAttribute
|
Identifier of the destination VNFD and the destination VNF package |
srcFlavourId |
Identifier |
1 |
RW |
OpenModelAttribute
|
Identifier of the deployment flavour in the source VNF package for which this modification applies. |
VirtualCpuData
The VirtualCpuData information element supports the specification of requirements related to virtual CPU(s) of a virtual compute resource.
Applied stereotypes:
Preliminary
Reference
reference: IFA011 v3.3.1
Attribute Name |
Type |
Mult. |
Access |
Stereotypes |
Description |
cpuArchitecture |
String |
0..1 |
RW |
OpenModelAttribute
Preliminary |
CPU architecture type. Examples are x86, ARM. The cardinality can be 0 during the allocation request, if no particular CPU architecture type is requested. |
numVirtualCpu |
Integer |
1 |
RW |
OpenModelAttribute
Preliminary |
Number of virtual CPUs. |
virtualCpuClock |
Number |
0..1 |
RW |
OpenModelAttribute
Preliminary |
Minimum virtual CPU clock rate (e.g. in MHz). The cardinality can be 0 during the allocation request, if no particular value is requested. |
virtualCpuOversubscriptionPolicy |
String |
0..1 |
RW |
OpenModelAttribute
Obsolete |
The CPU core oversubscription policy e.g. the relation of virtual CPU cores to physical CPU cores/threads. The cardinality can be 0 during the allocation request, if no particular value is requested. |
vduCpuRequirements |
KeyValuePair |
0..* |
RW |
OpenModelAttribute
Preliminary |
Array of key-value pair requirements on the Compute (CPU) for the VDU. |
virtualCpuPinning |
VirtualCpuPinningData |
0..1 |
RW |
OpenModelAttribute
Obsolete |
The virtual CPU pinning configuration for the virtualised compute resource. |
VirtualCpuPinningData
The VirtualCpuPinningData information element supports the specification of requirements related to the virtual CPU pinning configuration of a virtual compute resource.
Applied stereotypes:
Obsolete
Attribute Name |
Type |
Mult. |
Access |
Stereotypes |
Description |
virtualCpuPinningPolicy |
PinningPolicy |
0..1 |
RW |
OpenModelAttribute
Obsolete |
The policy can take values of “static” or “dynamic”. In case of “static” the virtual CPU cores are requested to be allocated to logical CPU cores according to the rules defined in virtualCpuPinningRules. In case of “dynamic” the allocation of virtual CPU cores to logical CPU cores is decided by the VIM. (e.g.: SMT (Simultaneous Multi-Threading) requirements). |
virtualCpuPinningRule |
invalid |
0..1 |
RW |
OpenModelAttribute
Obsolete |
A list of rules that should be considered during the allocation of the virtual CPUs to logical CPUs in case of “static” virtualCpuPinningPolicy. |
VirtualLinkBitRateLevel
The VirtualLinkBitRateLevel information element specifies bitrate requirements applicable to a virtual link instantiated from a particular VnfVirtualLinkDesc.
Applied stereotypes:
Preliminary
Reference
reference: IFA011 v3.3.1
Attribute Name |
Type |
Mult. |
Access |
Stereotypes |
Description |
vnfVirtualLinkDescId |
VnfVirtualLinkDesc |
1 |
RW |
OpenModelAttribute
Preliminary PassedByReference |
Uniquely identifies a VnfVirtualLinkDesc |
bitrateRequirements |
LinkBitrateRequirements |
1 |
RW |
OpenModelAttribute
Preliminary |
Bitrate requirements for an instantiation level or bitrate delta for a scaling step. |
VirtualLinkProtocolData
The VirtualLinkProtocolData describes the protocol layer and associated protocol data for a virtual link
Applied stereotypes:
Preliminary
Reference
reference: IFA011 v3.3.1
Attribute Name |
Type |
Mult. |
Access |
Stereotypes |
Description |
associatedLayerProtocol |
LayerProtocol |
1 |
RW |
OpenModelAttribute
Preliminary |
One of the values of the attribute layerProtocol of the ConnectivityType IE. |
l2ProtocolData |
L2ProtocolData |
0..1 |
RW |
OpenModelAttribute
Preliminary |
Specifies the L2 protocol data for this virtual link. Shall be present when the associatedLayerProtocol attribute indicates a L2 protocol and shall be absent otherwise. |
l3ProtocolData |
L3ProtocolData |
0..1 |
RW |
OpenModelAttribute
Preliminary |
Specifies the L3 protocol data for this virtual link. Shall be present when the associatedLayerProtocol attribute indicates a L3 protocol and shall be absent otherwise. |
VirtualMemoryData
The VirtualMemoryData information element supports the specification of requirements related to virtual memory of a virtual compute resource.
Applied stereotypes:
Preliminary
Reference
reference: IFA011 v3.3.1
Attribute Name |
Type |
Mult. |
Access |
Stereotypes |
Description |
virtualMemSize |
Number |
1 |
RW |
OpenModelAttribute
Preliminary |
Amount of virtual Memory (e.g. in MB). |
virtualMemOversubscriptionPolicy |
String |
0..1 |
RW |
OpenModelAttribute
Obsolete |
The memory core oversubscription policy in terms of virtual memory to physical memory on the platform. The cardinality can be 0 during the allocation request, if no particular value is requested. |
vduMemRequirements |
KeyValuePair |
0..* |
RW |
OpenModelAttribute
Preliminary |
Array of key-value pair requirements on the memory for the VDU. |
numaEnabled |
Boolean |
0..1 |
RW |
OpenModelAttribute
Obsolete |
It specifies the memory allocation to be cognisant of the relevant process/core allocation. The cardinality can be 0 during the allocation request, if no particular value is requested. |
VnfConfigurableProperties
This information element provides a means to define in the VNFD attributes that represent the configurable properties of a VNF. Configurable properties can be standardized as listed below (e.g. related to auto scaling, auto healing and interface configuration), or can be VNF-specific as defined by the VNF provider. For a VNF instance, the value of these properties can be queried and modified through the VNFM, using the Query VNF and Modify VNF Information operations. Modifying these values affects directly the configuration of an existing VNF instance. If a configurable property is defined in the VNFD, an initial value may be defined as well.
Applied stereotypes:
Preliminary
Reference
reference: IFA011 v3.3.1
Attribute Name |
Type |
Mult. |
Access |
Stereotypes |
Description |
isAutoscaleEnabled |
Boolean |
0..1 |
RW |
OpenModelAttribute
Preliminary |
It permits to enable (TRUE)/disable (FALSE) the auto-scaling functionality. NOTE: A cardinality of “0” indicates that configuring this present VNF property is not supported. |
isAutohealEnabled |
Boolean |
0..1 |
RW |
OpenModelAttribute
Preliminary |
It permits to enable (TRUE)/disable (FALSE) the auto-healing functionality. NOTE: A cardinality of “0” indicates that configuring this present VNF property is not supported. |
vnfmInterfaceInfo |
invalid |
0..1 |
RW |
OpenModelAttribute
Experimental |
Contains information enabling access to the NFV-MANO interfaces produced by the VNFM (e.g. URIs and credentials) |
vnfmOauthServerInfo |
invalid |
0..1 |
RW |
OpenModelAttribute
Experimental |
Contains information to enable discovery of the authorization server protecting access to VNFM interface |
vnfOauthServerInfo |
invalid |
0..1 |
RW |
OpenModelAttribute
Experimental |
Contains information to enable discovery of the authorization server to validate the access tokens provided by the VNFM when the VNFM accesses the VNF interfaces, if that functionality (token introspection) is supported by the authorization server. |
additionalConfigurableProperty |
String |
0..* |
RW |
OpenModelAttribute
Preliminary |
VnfIndicatorData
The VnfIndicatorData datatype identifies a VNF indicator in a VNFD.
Applied stereotypes:
Preliminary
Reference
reference: IFA011 v3.3.1
Attribute Name |
Type |
Mult. |
Access |
Stereotypes |
Description |
vnfdId |
Vnfd |
1 |
RW |
OpenModelAttribute
Preliminary |
Identifies a VNFD. |
vnfIndicator |
VnfIndicator |
1 |
RW |
OpenModelAttribute
Preliminary |
Identifies a VNF indicator within the VNFD. |
VnfInfoModifiableAttributes
This datatype defines the VNF-specific extension and metadata attributes of the VnfInfo that are writeable via the ModifyVnfInfo operation.
Applied stereotypes:
Preliminary
Reference
reference: IFA011 v3.3.1
Attribute Name |
Type |
Mult. |
Access |
Stereotypes |
Description |
extension |
invalid |
0..* |
RW |
OpenModelAttribute
Experimental |
All additional VNF-specific attributes of VnfInfo that affect the lifecycle management of a VNF instance. For each VNF instance, these attributes are stored persistently by the VNFM and can be queried and modified through the VNFM. These attributes are intended to be consumed by the VNFM or by the lifecycle management scripts during the execution of VNF lifecycle management operations. Modifying these values has no direct effect on the VNF instance; however, modified values can be considered during subsequent VNF lifecycle management operations, which means that the modified values can indirectly affect the configuration of the VNF instance. |
metadata |
invalid |
0..* |
RW |
OpenModelAttribute
Experimental |
Additional VNF-specific attributes of VnfInfo that provide metadata describing the VNF instance and that are defined by the VNF provider. See note 2. For each VNF instance, these attributes are stored persistently by the VNFM and can be queried and modified through the VNFM. These attributes are intended to provide information to functional blocks external to the VNFM and will not be used by the VNFM or the VNF lifecycle management scripts when executing lifecycle management operations. Modifying these attributes has no effect on the VNF instance. It only affects the attribute values stored by the VNFM. |
VnfLcmOperationsConfiguration
This information element is a cont operations, structured by operation.
Applied stereotypes:
Reference
reference: IFA011 v3.3.1
Experimental
VnfLifecycleManagementScript
Applied stereotypes:
Preliminary
Reference
reference: IFA011 v3.3.1
Attribute Name |
Type |
Mult. |
Access |
Stereotypes |
Description |
event |
LcmEvent |
0..* |
RW |
OpenModelAttribute
Preliminary |
Describes VNF lifecycle event(s) or an external stimulus detected on a VNFM reference point. |
icmTransitionEvent |
String |
0..* |
RW |
OpenModelAttribute
Preliminary |
Describes the transition VNF lifecycle event(s) that cannot be mapped to any of the enumerated values defined for the event attribute. NOTE: At least one of these two attributes shall be included. |
script |
String |
1 |
RW |
OpenModelAttribute
Preliminary |
Information to locate a VNF LCM script (e.g. written in a DSL as specified in requirement VNF_PACK.LCM.001) triggered to react to one of the events listed in the event attribute. |
scriptDsl |
String |
1 |
RW |
OpenModelAttribute
Preliminary |
Defines the domain specific language (i.e. the type) of script that is provided. Types of scripts could include bash, python, etc. |
scriptInput |
KeyValuePair |
0..* |
RW |
OpenModelAttribute
Preliminary |
Array of KVP requirements with the key as the parameter name and the value as the parameter that need to be passed as an input to the script. NOTE: The scriptInput values are passed to the scripts in addition to the parameters received in the operation invocation request or indicator value change. |
VnfQoS
The QoS as applied to the vnf.
Applied stereotypes:
Preliminary
Reference
reference: IFA011 v3.3.1
VnfcConfigurableProperties
This information element provides a means to define additional VNF-specific attributes that represent the configurable properties of a VNFC. For a VNFC instance, the values of these properties can be queried and modified through the VNFM. Modifying these values affects directly the configuration of an existing VNFC instance.
Applied stereotypes:
Preliminary
Reference
reference: IFA011 v3.3.1
Attribute Name |
Type |
Mult. |
Access |
Stereotypes |
Description |
additionalVnfcConfigurableProperty |
String |
0..* |
RW |
OpenModelAttribute
Preliminary |
It provides VNFC configurable properties that can be modified using the ModifyVnfInfo operation. |
VolumeType
Applied stereotypes:
Future
Attribute Name |
Type |
Mult. |
Access |
Stereotypes |
Description |
volumeTypeId |
Identifier |
1 |
RW |
OpenModelAttribute
Future |
Unique identifier of volume type in VNFD. |
volumeTypeName |
String |
1 |
RW |
OpenModelAttribute
Future |
Name of volume type. |
backendName |
String |
1 |
RW |
OpenModelAttribute
Future |
Backend volume name of cinder. |
Enumerations
CollectionPeriod
Specifies the periodicity at which the producer will collect performance information. Note: at the end of each reportingPeriod, the producer will inform the consumer about availability of the performance data collected for each completed collection period during this reportingPeriod. While the exact definition of the types for collectionPeriod and reportingPeriod is left for further specification, it is recommended that the reportingPeriod be equal or a multiple of the collectionPeriod. In the latter case, the performance data for the collection periods within one reporting period would be reported together.
Contains Enumeration Literals:
ConsumerScope
Contains Enumeration Literals:
BACK_END:
Direction
Ingress or egress traffic
Contains Enumeration Literals:
INGRESS:
EGRESS:
EndpointType
Contains Enumeration Literals:
MGMT:
VNF:
HomingStrategy
Contains Enumeration Literals:
Colocation:
isolation:
InterfaceName
Specifies an interface produced by the VNF.
Contains Enumeration Literals:
VNF_CONFIGURATION:
VNF_INDICATOR:
LcmEvent
Describes VNF lifecycle event(s) or an external stimulus detected on a VNFM reference point.
Contains Enumeration Literals:
EVENT_START_INSTANTIATION:
EVENT_END_INSTANTIATION:
EVENT_START_SCALING:
EVENT_END_SCALING:
EVENT_START_SCALING_TO_LEVEL:
EVENT_END_SCALING_TO_LEVEL:
EVENT_START_HEALING:
EVENT_END_HEALING:
EVENT_START_TERMINATION:
EVENT_END_TERMINATION:
EVENT_START_VNF_FLAVOR_CHANGE:
EVENT_END_VNF_FLAVOR_CHANGE:
EVENT_START_VNF_OPERATION_CHANGE:
EVENT_END_VNF_OPERATION_CHANGE:
EVENT_START_VNF_EXT_CONN_CHANGE:
EVENT_END_VNF_EXT_CONN_CHANGE:
EVENT_START_VNFINFO_MODIFICATION:
EVENT_END_VNFINFO_MODIFICATION:
ModificationQualifier
Contains Enumeration Literals:
UP:
DOWN:
OperationalStatus
Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.
Contains Enumeration Literals:
IN_SERVICE:
OUT_OF_SERVICE:
OrchestrationStatus
Contains Enumeration Literals:
INVENTORIED:
ASSIGNED:
CREATED:
ACTIVE:
PinningPolicy
Defines the CPU pinning policy.
Contains Enumeration Literals:
STATIC:
DYNAMIC:
PlacementStrategy
Contains Enumeration Literals:
COLOCATION:
ISOLATION:
EXCLUSIVITY:
ProvStatus
Provisioning status, used as a trigger for operational monitoring of this resource by service assurance systems.
Contains Enumeration Literals:
PROVISIONED:
PREPROVISIONED:
CAPPED:
VnfSource
Describes the source of the indicator.
Contains Enumeration Literals:
VNF:
EM:
BOTH:
VnicType
Describes the type of VNIC to which a CP attaches.
Contains Enumeration Literals:
NORMAL:
MACVTAP:
DIRECT:
BAREMETAL:
DIRECT_PHYSICAL:
VIRTIO_FORWARDER:
SMART-NIC:
BRIDGE:
IPVLAN:
LOOPBACK:
MACVLAN:
PTP:
VLAN:
HOST-DEVICE:
vipFunction
It indicates the function the virtual IP address is used for.
Contains Enumeration Literals:
HIGH_AVAILABILITY:
LOAD_BALANCING:
PnfdModel
Classes
Pnf
An implementation of a NF via a tightly coupled software and hardware system.
Parent class: NetworkFunction
Applied stereotypes:
Future
OpenModelClass
support: MANDATORY
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
|---|---|---|---|---|
_pnfExtCp |
PnfExtCp |
1..* |
OpenModelAttribute
|
External CP of the PNF. |
id |
String |
1 |
Experimental OpenModelAttribute
|
Identifier of the network function |
name |
String |
0..1 |
Experimental OpenModelAttribute
|
|
type |
String |
1 |
Experimental OpenModelAttribute
|
Description of the type of network function |
description |
String |
0..1 |
Experimental OpenModelAttribute
|
Description of the network function |
role |
String |
1 |
Experimental OpenModelAttribute
|
Role the network function will be providing. |
PnfExtCp
External CP of the PNF.
Parent class: Cp
Applied stereotypes:
Future
OpenModelClass
support: MANDATORY
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
|---|---|---|---|---|
cpd |
invalid |
1 |
OpenModelAttribute
|
Cpd used to deploy this PNF CP. |
cpId |
Identifier |
1 |
OpenModelAttribute
|
Identifier of the connection point instance. |
cpName |
String |
1 |
OpenModelAttribute
|
Name of the Cp instance. |
cpNameAlt |
String |
1 |
OpenModelAttribute
|
alternative name of the Cp instance. |
cpType |
String |
1 |
OpenModelAttribute
|
Generic description of the type of Cp |
cpRole |
String |
1 |
OpenModelAttribute
|
Role in the network this Cp will be providing |
cpFunction |
String |
1 |
OpenModelAttribute
|
English description of the function this specific Cp will be providing |
cpDescription |
String |
1 |
OpenModelAttribute
|
Cp description |
cpBandwidth |
String |
1 |
OpenModelAttribute
|
Cp assigned (actual) bandwidth Cp (max? assigned?) bandwidth |
provStatus |
String |
1 |
OpenModelAttribute
|
provisioning status, used as a trigger for operational monitoring of this resource by service assurance systems valid value example: PROVISIONED, PREPROVISIONED, CAPPED |
adminsStatus |
String |
1 |
OpenModelAttribute
|
Administrative status of the connection point. |
protocol |
String |
1 |
OpenModelAttribute
|
Protocol used by the Cp |
trunkMode |
Boolean |
1 |
OpenModelAttribute
|
Indicator whether the Cp is in trunk mode |
addressType |
String |
1 |
OpenModelAttribute
|
Type of address: MAC address or IP address |
L2addressData |
L2AddressData |
0..1 |
OpenModelAttribute
|
Only present when addressType is MAC address |
L3addressData |
L3AddressData |
0..1 |
OpenModelAttribute
|
Only present when addressType is IP address |
PnfExtCpd
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
PnfProfile
The PnfProfile class describes additional data for a given PNF instance used in a DF.
Applied stereotypes:
Future
OpenModelClass
support: MANDATORY
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
|---|---|---|---|---|
pnfProfileId |
Identifier |
1 |
OpenModelAttribute
|
Identifier of this PnfProfile class. It uniquely identifies a PnfProfile. |
pnfVirtualLinkConnectivity |
NsVirtualLinkConnectivity |
1..* |
OpenModelAttribute
|
Defines the connection information of the PNF, it contains connection relationship between a PNF connection point and a NS virtual Link. |
Pnfd
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
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
|---|---|---|---|---|
pnfdId |
Identifier |
1 |
OpenModelAttribute
Preliminary |
Identifier of this Pnfd class. It uniquely identifies the PNFD. |
provider |
String |
1 |
OpenModelAttribute
Preliminary |
Identifies the provider of the PNFD. NOTE: The provider of the PNFD might be different from the provider of the PNF. |
version |
Version |
1 |
OpenModelAttribute
Preliminary |
Identifies the version of the PNFD |
security |
SecurityParameters |
0..1 |
OpenModelAttribute
Preliminary |
Provides a signature to prevent tampering. |
functionDescription |
String |
1 |
OpenModelAttribute
Preliminary |
Describes the PNF function. |
pnfdInvariantId |
Identifier |
1 |
OpenModelAttribute
Preliminary |
Identifies a PNFD in a version independent manner. This attribute is invariant across versions of PNFD. |
name |
String |
1 |
OpenModelAttribute
Preliminary |
Provides the human readable name of the PNFD. |
_pnfExtCpd |
PnfExtCpd |
1..* |
OpenModelAttribute
|
Specifies the characteristics of one or more connection points where to connect the PNF to a VL. |
Data Types
SwVersion
The software versions associated with the pnfd
Applied stereotypes:
Future
Attribute Name |
Type |
Mult. |
Access |
Stereotypes |
Description |
|---|---|---|---|---|---|
active |
String |
1 |
RW |
OpenModelAttribute
|
The active software |
passive |
String |
0..* |
RW |
OpenModelAttribute
|
The passive software |
recovery |
String |
0..* |
RW |
OpenModelAttribute
|
The recovery software |
NetworkServiceDescriptorModel
Diagram
NetworkServiceDescriptor
The NSD class is a deployment template whose instances are used by the NFVO for the lifecycle management of NSs. For all attributes in this class, the Producer is SDC and the Consumer is SDC/UUI/VFC
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminaryry
AttributeName |
Type |
Mult. |
Stereotypes |
Description |
|---|---|---|---|---|
nsdIdentifier |
Identifier |
1 |
Preliminary OpenModelAttribute
|
Identifier of this NSD class. It globally uniquely identifies an instance of the NSD. |
designer |
String |
1 |
Preliminary OpenModelAttribute
|
Identifies the designer of the NSD. |
version |
Version |
1 |
Preliminary OpenModelAttribute
|
Identifies the version of the NSD. |
nsdName |
String |
1 |
Preliminary OpenModelAttribute
|
Provides the human readable name of the NSD. |
nsdInvariantId |
Identifier |
1 |
Preliminary OpenModelAttribute
|
Identifies an NSD in a version independent manner. This attribute is invariant across versions of NSD. |
autoScalingRule |
Rule |
0..* |
Preliminary OpenModelAttribute
|
Specifies a rule to trigger a scaling action on a NS instantiated according to the NSD. NOTE 1: The rule is based on a combination of assertions on the values of virtualised resource- related performance metrics and VNF Indicators identified by the monitoredInfo attribute. NOTE 2: There may be multiple data sources (each identified as monitoredInfo) per rule |
monitoredInfo |
MonitoredData |
0..* |
Preliminary OpenModelAttribute
|
Identifies either a virtualised resource- related performance metric or a VNF Indicator. |
lifeCycleManagementScript |
NsLifeCycleManagementScript |
0..* |
Preliminary OpenModelAttribute
|
Provides a life cycle management script written in a Domain Specific Language (DSL). |
_virtualLinkDesc |
NsVirtualLinkDesc |
0..* |
Preliminary OpenModelAttribute
|
Provides the constituent VLDs. Cardinality of 0 means that the NS is a NF set with unspecified connectivity. |
_vnfdId |
Vnfd |
0..* |
Preliminary OpenModelAttribute
PassedByReference |
References the VNFD of a constituent VNF. |
_pnfdId |
Pnfd |
0..* |
Experimental OpenModelAttribute
PassedByReference |
References the PNFD of a constituent PNF. |
NsVirtualLinkDesc
The NsVirtualLinkDesc class provides general information enabling the instantiation of virtual links. For all attributes in this class the Producer is SDC and the Consumer is SDC/UUI/VFC.
Parent class: VirtualLinkDesc
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminaryry
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
|---|---|---|---|---|
vitualLinkDescProvider |
String |
0..1 |
Preliminary OpenModelAttribute
|
Defines the organization generating the VLD. |
virtuaLinkDescVersion |
Version |
1 |
Preliminary OpenModelAttribute
|
Specifies the version of the VLD. |
VirtualLinkDf |
VirtualLinkDf |
1 |
Preliminary OpenModelAttribute
|
Specifies properties for instantiating a VL according to a specific flavour. |
virtualLinkDescId |
Identifier |
1 |
Preliminary OpenModelAttribute
|
Uniquely identifies a VLD in the parent descriptor. For VnfVirtualL inkDesc, the parent descriptor is the VNFD. For NsVirtualLi- nkDesc, the parent descriptor is the NSD. Note: the description of this class are different in ETSI GS NFV IFA 011 and ETSI GS NFV IFA 014. The present definition merges the 2 definitions. |
connectivityType |
ConnectivityType |
1 |
Preliminary OpenModelAttribute
|
Specifies the protocol exposed by a VL and the flow pattern supported by the VL. |
description |
String |
0..1 |
Preliminary OpenModelAttribute
|
Provides human-readable information on the purpose of the VL (e.g. control plane traffic). |
Pnfd
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
Experimental
Vnfd
The Vnfd class is a deployment template enabling on-boarding VNFs and referencing them from an NSD.
ConnectivityType
The ConnectivityType datatype specifies the protocol exposed by a VL and the flow pattern supported by the VL.
Attribute Name |
Type |
Mult. |
Access |
Stereotypes |
Description |
|---|---|---|---|---|---|
layerProtocol |
LayerProtocol |
1 |
RW |
Preliminary OpenModelAttribute
|
identifies the protocol this VL gives access to (IPV4, IPV6). |
flowPatternrn |
String |
0..1 |
RW |
Preliminary OpenModelAttribute
|
Identifies the flow pattern of the connectivity (Line, Tree, Mesh). |
MonitoredData(TBD)
The MonitoredData datatype identifies information to be monitored during the lifetime of a network service instance.
NsLifeCycleManagementScript
The LifeCycleManagementScript information element specifies a script for the NS.
Attribute Name |
Type |
Mult. |
Access |
Stereotypes |
Description |
|---|---|---|---|---|---|
event |
String |
1..* |
RW |
OpenModelAttribute
|
Describes NS lifecycle event(s) or an external stimulus detected on an NFVO reference point. NOTE 1: A minimum set of NS lifecycle events triggered internally by the NFVO includes: start instantiation, end instantiation, start scaling, end scaling, start healing, end healing, start termination, end termination, start update, end update. NOTE 2: A minimum set of external stimulus includes: the receipt of request message of instantiation, scaling, healing, termination, update of NS. |
script |
String |
1 |
RW |
OpenModelAttribute
|
Includes an NS LCM script (e.g., written in a DSL) triggered to react to one of the events listed in the event attribute. |
NsQoS
The NsQoS datatype specifies quality of service parameters applicable to a NS VL.
Attribute Name |
Type |
Mult. |
Access |
Stereotypes |
Description |
|---|---|---|---|---|---|
priority |
Integer |
0..1 |
RW |
Preliminary OpenModelAttribute
|
Specifies the priority level in case of congestion on the underlying physical links. |
latency |
Number |
1 |
RW |
Preliminary OpenModelAttribute
|
Maximum latency in ms. |
packetDelayVariation |
Number |
1 |
RW |
Preliminary OpenModelAttribute
|
Maximum jitter in ms. |
packetLossRatio |
Number |
0..1 |
RW |
Preliminary OpenModelAttribute
|
Maximum packet loss ratio. Cardinality is 0 if no packetLossRatio requirement exists. |
VirtualLinkDf
The VirtualLinkDf datatype specifies properties for instantiating a VL according to a specific flavour.
Attribute Name |
Type |
Mult. |
Access |
Stereotypes |
Description |
|---|---|---|---|---|---|
flavourId |
Identifier |
1 |
RW |
Preliminary OpenModelAttribute
|
Identifies this VirtualLinkDF datatype within a VLD. |
qos |
NsQoS |
0..1 |
RW |
Preliminary OpenModelAttribute
|
Specifies quality of service parameters applicable to a VL. |
serviceAvaibilityLevel |
ServiceAvailabilityLevel |
0..1 |
RW |
Preliminary OpenModelAttribute
|
Specifies one of the three levels defined in ETSI GS NFV-REL 001:
|
ServiceAvailabilityLevel
Specifies one of the three levels defined in ETSI GS NFV-REL 001: Level 1 Level 2 Level 3
Contains Enumeration Literals:
LEVEL_1:
LEVEL_2:
LEVEL_3:
Business Interaction Model
Diagram
Business Interaction
Class Definition
BusinessInteractionItemRelationship class
Qualified Name: Common::Business Interaction::ObjectClasses:: BusinessInteractionItemRelationship
Applied Stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Reference
reference: From TMF SID
Table Attributes for Class BusinessInteractionItemRelationship
Attribute Name |
Type |
Mult. |
Description |
Stereotypes |
|---|---|---|---|---|
type |
String |
1 |
The type of relationship such as contains, relies on. |
OpenModelAttribute
Preliminary |
validFor |
TimePeriod |
1 |
Time period for which the relationship is valid |
OpenModelAttribute
Preliminary |
Agreement class
Qualified Name: Common::Business Interaction::ObjectClasses::Agreement
Description:
A type of BusinessInteraction that represents a contract or arrangement, either written or verbal and sometimes enforceable by law.
Parent class: BusinessInteraction
Applied Stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Reference
reference: From TMF SID
Table Attributes for class Agreement
Attribute Name |
Type |
Mult. |
Description |
Stereotypes |
|---|---|---|---|---|
documentNumber |
String |
1 |
A reference number assigned to an Agreement that follows a prescribed numbering system. |
OpenModelAttribute
Preliminary |
statementOfIntent |
String |
1 |
An overview and goals of the Agreement. |
OpenModelAttribute
Preliminary |
StartDate |
DateTime |
1 |
Date interaction initiated |
OpenModelAttribute
Preliminary |
endDate |
DateTime |
1 |
The date on which an interaction is closed or completed. |
OpenModelAttribute
Preliminary |
Status |
String |
0..1 |
The current condition of an interaction, such as open, in research, closed, and so forth |
OpenModelAttribute
Preliminary |
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
Preliminary |
description |
String |
0..1 |
Defines a textual free-form description of the object. |
OpenModelAttribute
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
Preliminary |
BusinessInteraction class
Qualified Name: Common::Business Interaction::ObjectClasses::BusinessInteraction
Description:
A BusinessInteraction is an arrangement, contract, communication or joint activity between one or more PartyRoles, ResourceRoles, or CustomerAccounts. A BusinessInteraction may consist of one or more BusinessInteractionItems. A BusinessInteractionItem may refer to a Product, Service, Resource, or one of their specifications. A BusinessInteraction is further defined by one or more Places. One BusinessInteraction may reference another BusinessInteraction and one BusinessInteractionItem may reference another BusinessInteractionItem on the same or different BusinessInteraction. Types of BusinessInteractions include : Requests, Responses, Notifications, and Agreements.
This class is abstract.
Parent class: RootEntity
Applied Stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Reference
reference: From TMF SID
Table Attributes for class BusinessInteraction
Attribute Name |
Type |
Mult. |
Description |
Stereotypes |
|---|---|---|---|---|
StartDate |
DateTime |
1 |
Date interaction initiated |
OpenModelAttribute
Preliminary |
endDate |
DateTime |
1 |
The date on which an interaction is closed or completed. |
OpenModelAttribute
Preliminary |
Status |
String |
0..1 |
The current condition of an interaction, such as open, in research, closed, and so forth |
OpenModelAttribute
Preliminary |
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
Preliminary |
description |
String |
0..1 |
Defines a textual free-form description of the object. |
OpenModelAttribute
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
Preliminary |
BusinessInteractionItem class
Qualified Name: Common::Business Interaction::ObjectClasses::BusinessInteractionItem
Description:
The purpose for the BusinessInteraction expressed in terms of a ProductSpecification, ProductOffering, ServiceSpecification or ResourceSpecification or may refer to a Product, Service, or Resource.
This class is abstract.
Applied Stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Reference
reference: From TMF SID
Table Attributes for class BusinessInteractionItem
Attribute Name |
Type |
Mult. |
Description |
Stereotypes |
|---|---|---|---|---|
quantity |
Integer |
1 |
Quantity of an interaction item involved in an interaction. |
OpenModelAttribute
Preliminary |
action |
String |
1 |
The action to take for an InteractionItem, such as add, change, remove. |
OpenModelAttribute
Preliminary |
BusinessInteractionRelationship class
Qualified Name: Common::Business Interaction::ObjectClasses::BusinessInteractionRelationship
Description:
An association between two Interactions. For example, a Notification sent to customers affected by a problem contained on a Trouble Report; a response to a request, an agreement and the interactions that led up to the agreement.
Applied Stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Reference
reference: From TMF SID
Table Attributes for class BusinessInteractionRelationship
Attribute Name |
Type |
Mult. |
Description |
Stereotypes |
|---|---|---|---|---|
type |
String |
1 |
A categorization of the relationship, such as bulk, parent/child, and so forth. |
OpenModelAttribute
Preliminary |
validFor |
TimePeriod |
1 |
Time period for which the relationship is valid |
OpenModelAttribute
Preliminary |
BusinessInteractionSpec class
Qualified Name: Common::Business Interaction::ObjectClasses::BusinessInteractionSpec
Description:
The invariant characteristics (attributes in the business view, and methods, constraints, relationships, and behavior in the system view) and behavior of a BusinessInteraction. This is done by optionally defining a set of BusinessInteractionSpecItems, each of which aggregates one or more other types of Specifications. This helps to ensure that different BusinessInteractions have the same basic characteristics and behavior by deriving them from the same BusinessInteractionSpec.
Applied Stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Reference
reference: From TMF SID
BusinessInteractionVersion class
Qualified Name: Common::Business Interaction::ObjectClasses::BusinessInteractionVersion
Description:
Version of the business interaction.
Applied Stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Reference
reference: From TMF SID
Notification class
Qualified Name: Common::Business Interaction::ObjectClasses::Notification
Description:
A communication that informs about something that has or will happen. A Notification is typically one-sided, in that no Response is expected. A Notification can be created as the result of a Request; for example, a Trouble Report may result in Notifications being sent to affected Parties. A Notification is a type of Business Interaction.
This class is abstract.
Parent class: BusinessInteraction
Applied Stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Reference
reference: From the TMF SID
Request class
Qualified Name: Common::Business Interaction::ObjectClasses::Request
Description:
The act of asking that something be done that typically involves a Response. Request is a type of Business Interaction.
This class is abstract.
Parent class: BusinessInteraction
Applied Stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Reference
reference: From the TMF SID
Response class
Qualified Name: Common::Business Interaction::ObjectClasses::Response
Description:
A reply to a Request
This class is abstract.
Parent class: BusinessInteraction
Applied Stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Reference
reference: From the TMF SID
VES Model
VES Model Diagram
Rooting VES
Event - High Level
Event Datatypes
Measurement Domain Entities
Mobile Flow Entities
Perf3gpp Entities
SipSignaling Entities
Voice Quality Entities
ipmi
VES Class Definition - part 1
CmNotify
Parent class: VesEvent
Applied stereotypes:
OpenModelClass
support: MANDATORY
Experimental
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
additionalInformation |
HashMap |
0..1 |
OpenModelAttribute
|
Additional information nf provider wants to convey. |
Ves::Diagrams::CmNotify::additionalInformation |
cmNotifyFieldsVersion |
String |
1 |
OpenModelAttribute
|
Version of the cmNotify |
Ves::Diagrams::CmNotify::cmNotifyFieldsVersion |
correlatedNotifications |
invalid |
0..* |
OpenModelAttribute
|
Notifications to which this notification is considered to be correlated |
Ves::Diagrams::CmNotify::correlatedNotifications |
eventTime |
DateTime |
1 |
OpenModelAttribute
|
Time of the cmNotify event. |
Ves::Diagrams::CmNotify::eventTime |
notificationId |
String |
1 |
OpenModelAttribute
|
Unique Identifier for the source of this occurrence of the notification. For 3GPP devices this is the notification identifier as defined by ITUT |
Ves::Diagrams::CmNotify::notificationId |
sourceIndicator |
SourceIndicator |
0..1 |
OpenModelAttribute
|
Indicates the source of the operation that led to the generation of the notification. |
Ves::Diagrams::CmNotify::sourceIndicator |
systemDN |
String |
0..1 |
OpenModelAttribute
|
DN of the management service provider |
Ves::Diagrams::CmNotify::systemDN |
_cmnotif |
cmNotif |
1..* |
OpenModelAttribute
|
Array of cmNotif notificatons |
Ves::Diagrams::CmNotify::_cmnotif |
domain |
Domain |
1 |
Experimental OpenModelAttribute
|
Update in definition only Event domain enumeration: ‘cmNotify’,’fault’, ‘heartbeat’, ‘measurement’, ‘mobileFlow’, ‘notification’, ‘other’, ‘pnfRegistration’, ‘sipSignaling’, ‘stateChange’, ‘syslog’, ‘thresholdCrossingAlert’, ‘voiceQuality’ |
Ves::ObjectClasses::VesEvent::domain |
eventType |
String |
0..1 |
Preliminary OpenModelAttribute
|
For example: ‘applicationNf’, ‘guestOS’, ‘hostOS’, ‘platform’ |
Ves::ObjectClasses::VesEvent::eventType |
lastEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
the latest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds |
Ves::ObjectClasses::VesEvent::lastEpochMicrosec |
nfcNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function component type: 3 characters (aligned with vfc naming standards) |
Ves::ObjectClasses::VesEvent::nfcNamingCode |
nfNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function type: 4 characters (aligned with vnf and pnf naming standards) |
Ves::ObjectClasses::VesEvent::nfNamingCode |
nfVendorName |
String |
1 |
Preliminary OpenModelAttribute
|
Network function vendor name |
Ves::ObjectClasses::VesEvent::nfVendorName |
priority |
Priority |
1 |
Preliminary OpenModelAttribute
|
Processing priority enumeration: ‘High’, ‘Medium’, ‘Normal’, ‘Low’ |
Ves::ObjectClasses::VesEvent::priority |
reportingEntityId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See ‘reportingEntityName’ for more information. reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. |
Ves::ObjectClasses::VesEvent::reportingEntityId |
reportingEntityName |
String |
1 |
Preliminary OpenModelAttribute
|
reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. |
Ves::ObjectClasses::VesEvent::reportingEntityName |
sequence |
Integer |
1 |
Preliminary OpenModelAttribute
|
sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ordering of events communicated by an event source instance (or 0 if not needed) |
Ves::ObjectClasses::VesEvent::sequence |
sourceId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See ‘sourceName’ for more information. sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. |
Ves::ObjectClasses::VesEvent::sourceId |
sourceName |
String |
1 |
Preliminary OpenModelAttribute
|
Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. |
Ves::ObjectClasses::VesEvent::sourceName |
startingEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) |
Ves::ObjectClasses::VesEvent::startingEpochMicrosec |
timeZoneOffset |
String |
0..1 |
Preliminary OpenModelAttribute
|
Offset to GMT to indicate local time zone for device formatted as ‘UTC+/-hh:mm’; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples |
Ves::ObjectClasses::VesEvent::timeZoneOffset |
version |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the event header as “#.#” where # is a digit; see section 1 for the correct digits to use. |
Ves::ObjectClasses::VesEvent::version |
vesEventListenerVersion |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the ves event listener api spec that this event is compliant with (as “#” or “#.#” or “#.#.#” where # is a digit; see section 1 for the correct digits to use). |
Ves::ObjectClasses::VesEvent::vesEventListenerVersion |
name |
String |
1 |
Preliminary OpenModelAttribute
|
Ves::ObjectClasses::VesEvent::name |
|
Status |
String |
0..1 |
Preliminary OpenModelAttribute
|
The current condition of an interaction, such as open, in research, closed, and so forth |
Common::Business Interaction::ObjectClasses::BusinessInteraction::Status |
description |
String |
0..1 |
Preliminary OpenModelAttribute
|
Defines a textual free-form description of the object. |
Common::Root::RootObjectClasses::RootEntity::description |
id |
Identifier |
1 |
Preliminary OpenModelAttribute
|
Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. |
Common::Root::RootObjectClasses::RootEntity::id |
CodecsInUse
The codecsInUse datatype consists of the following fields describing the number of times an identified codec was used over the measurementInterval
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
codecIdentifier |
String |
1 |
Preliminary OpenModelAttribute
|
Description of the codec. |
Ves::ObjectClasses::CodecsInUse::codecIdentifier |
numberInUse |
Integer |
1 |
Preliminary OpenModelAttribute
|
Number of such codecs in use. |
Ves::ObjectClasses::CodecsInUse::numberInUse |
CpuUsage
The cpuUsage datatype defines the usage of an identifier CPU and consists of the following fields:
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
cpuCapacityContention |
Number |
0..1 |
Preliminary OpenModelAttribute
|
The amount of time the CPU cannot run due to contention, in milliseconds over the measurementInterval |
Ves::ObjectClasses::CpuUsage::cpuCapacityContention |
cpuDemandAvg |
Number |
0..1 |
Preliminary OpenModelAttribute
|
The total CPU time that the NF/NFC/VM could use if there was no contention, in milliseconds over the measurementInterval |
Ves::ObjectClasses::CpuUsage::cpuDemandAvg |
cpuDemandMhz |
Number |
0..1 |
Preliminary OpenModelAttribute
|
CPU demand in MHz |
Ves::ObjectClasses::CpuUsage::cpuDemandMhz |
cpuDemandPct |
Number |
0..1 |
Preliminary OpenModelAttribute
|
CPU demand as a percentage of the provisioned capacity |
Ves::ObjectClasses::CpuUsage::cpuDemandPct |
cpuIdentifier |
String |
1 |
Preliminary OpenModelAttribute
|
CPU Identifier |
Ves::ObjectClasses::CpuUsage::cpuIdentifier |
cpuIdle |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Percentage of CPU time spent in the idle task |
Ves::ObjectClasses::CpuUsage::cpuIdle |
cpuLatencyAvg |
Number |
0..1 |
Preliminary OpenModelAttribute
|
cpuDemandAvg - The total CPU time that the VNF/VNFC/VM could use if there is no contention, in milliseconds. |
Ves::ObjectClasses::CpuUsage::cpuLatencyAvg |
cpuOverheadAvg |
Number |
0..1 |
Preliminary OpenModelAttribute
|
The overhead demand above available allocations and reservations, in milliseconds over the measurementInterval |
Ves::ObjectClasses::CpuUsage::cpuOverheadAvg |
cpuSwapWaitTime |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Swap wait time, in milliseconds over the measurementInterval |
Ves::ObjectClasses::CpuUsage::cpuSwapWaitTime |
cpuUsageInterrupt |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Percentage of time spent servicing interrupts |
Ves::ObjectClasses::CpuUsage::cpuUsageInterrupt |
cpuUsageNice |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Percentage of time spent running user space processes that have been niced |
Ves::ObjectClasses::CpuUsage::cpuUsageNice |
cpuUsageSoftIrq |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Percentage of time spent handling soft irq interrupts |
Ves::ObjectClasses::CpuUsage::cpuUsageSoftIrq |
cpuUsageSteal |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Percentage of time spent in involuntary wait which is neither user, system or idle time and is effectively time that went missing |
Ves::ObjectClasses::CpuUsage::cpuUsageSteal |
cpuUsageSystem |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Percentage of time spent on system tasks running the kernel |
Ves::ObjectClasses::CpuUsage::cpuUsageSystem |
cpuUsageUser |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Percentage of time spent running un-niced user space processes |
Ves::ObjectClasses::CpuUsage::cpuUsageUser |
cpuWait |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Percentage of CPU time spent waiting for I/O operations to complete |
Ves::ObjectClasses::CpuUsage::cpuWait |
percentUsage |
Number |
1 |
Preliminary OpenModelAttribute
|
Aggregate cpu usage of the virtual machine on which the xNFC reporting the event is running |
Ves::ObjectClasses::CpuUsage::percentUsage |
DiskUsage
The diskUsage datatype defines the usage of a disk device.
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
diskBusResets |
Number |
0..1 |
Preliminary OpenModelAttribute
|
The number of bus resets in the performance interval. |
Ves::ObjectClasses::DiskUsage::diskBusResets |
diskCommandsAborted |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of disk commands aborted over the measurementInterval. |
Ves::ObjectClasses::DiskUsage::diskCommandsAborted |
diskCommandsAvg |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Average number of commands per second over the measurementInterval. |
Ves::ObjectClasses::DiskUsage::diskCommandsAvg |
diskFlushRequests |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Total flush requests of the disk cache over the measurementInterval. |
Ves::ObjectClasses::DiskUsage::diskFlushRequests |
diskFlushTime |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Milliseconds spent on disk cache flushing over the measurementInterval. |
Ves::ObjectClasses::DiskUsage::diskFlushTime |
diskIdentifier |
String |
1 |
Preliminary OpenModelAttribute
|
Disk Identifier. |
Ves::ObjectClasses::DiskUsage::diskIdentifier |
diskIoTimeAvg |
Number |
1 |
Preliminary OpenModelAttribute
|
Milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the average over the measurement interval |
Ves::ObjectClasses::DiskUsage::diskIoTimeAvg |
diskIoTimeLast |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the last value measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskIoTimeLast |
diskIoTimeMax |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the maximum value measurement within the measurement interval |
Ves::ObjectClasses::DiskUsage::diskIoTimeMax |
diskIoTimeMin |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the minimum value measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskIoTimeMin |
diskMergedReadAvg |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the average measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskMergedReadAvg |
diskMergedReadLast |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the last value measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskMergedReadLast |
diskMergedReadMax |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the maximum value measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskMergedReadMax |
diskMergedReadMin |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the minimum value measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskMergedReadMin |
diskMergedWriteAvg |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the average measurement within the measurement interval |
Ves::ObjectClasses::DiskUsage::diskMergedWriteAvg |
diskMergedWriteLast |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the last value measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskMergedWriteLast |
diskMergedWriteMax |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the maximum value measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskMergedWriteMax |
diskMergedWriteMin |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the minimum value measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskMergedWriteMin |
diskOctetsReadAvg |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of octets per second read from a disk or partition; provide the average measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskOctetsReadAvg |
diskOctetsReadLast |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of octets per second read from a disk or partition; provide the last measurement within the measurement interval |
Ves::ObjectClasses::DiskUsage::diskOctetsReadLast |
diskOctetsReadMax |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of octets per second read from a disk or partition; provide the maximum measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskOctetsReadMax |
diskOctetsReadMin |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of octets per second read from a disk or partition; provide the minimum measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskOctetsReadMin |
diskOctetsWriteAvg |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of octets per second written to a disk or partition; provide the average measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskOctetsWriteAvg |
diskOctetsWriteLast |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of octets per second written to a disk or partition; provide the last measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskOctetsWriteLast |
diskOctetsWriteMax |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of octets per second written to a disk or partition; provide the maximum measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskOctetsWriteMax |
diskOctetsWriteMin |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of octets per second written to a disk or partition; provide the minimum measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskOctetsWriteMin |
diskOpsReadAvg |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of read operations per second issued to the disk; provide the average measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskOpsReadAvg |
diskOpsReadLast |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of read operations per second issued to the disk; provide the last measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskOpsReadLast |
diskOpsReadMax |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of read operations per second issued to the disk; provide the maximum measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskOpsReadMax |
diskOpsReadMin |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of read operations per second issued to the disk; provide the minimum measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskOpsReadMin |
diskOpsWriteAvg |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of write operations per second issued to the disk; provide the average measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskOpsWriteAvg |
diskOpsWriteLast |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of write operations per second issued to the disk; provide the last measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskOpsWriteLast |
diskOpsWriteMax |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of write operations per second issued to the disk; provide the maximum measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskOpsWriteMax |
diskOpsWriteMin |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of write operations per second issued to the disk; provide the minimum measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskOpsWriteMin |
diskPendingOperationsAvg |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Queue size of pending I/O operations per second; provide the average measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskPendingOperationsAvg |
diskPendingOperationsLast |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Queue size of pending I/O operations per second; provide the last measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskPendingOperationsLast |
diskPendingOperationsMax |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Queue size of pending I/O operations per second; provide the maximum measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskPendingOperationsMax |
diskPendingOperationsMin |
Number |
0..1 |
Preliminary OpenModelAttribute
|
diskPendingOperationsMin - Queue size of pending I/O operations per second; provide the minimum measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskPendingOperationsMin |
diskReadCommandsAvg |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Average number of read commands issued per second to the disk over the measurementInterval. |
Ves::ObjectClasses::DiskUsage::diskReadCommandsAvg |
diskTime |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Nanoseconds spent on disk cache reads/writes within the measurementInterval. |
Ves::ObjectClasses::DiskUsage::diskTime |
diskTimeReadAvg |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Milliseconds a read operation took to complete; provide the average measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskTimeReadAvg |
diskTimeReadLast |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Milliseconds a read operation took to complete; provide the last measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskTimeReadLast |
diskTimeReadMax |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Milliseconds a read operation took to complete; provide the maximum measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskTimeReadMax |
diskTimeReadMin |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Milliseconds a read operation took to complete; provide the minimum measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskTimeReadMin |
diskTimeWriteAvg |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Milliseconds a write operation took to complete; provide the average measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskTimeWriteAvg |
diskTimeWriteLast |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Milliseconds a write operation took to complete; provide the last measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskTimeWriteLast |
diskTimeWriteMax |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Milliseconds a write operation took to complete; provide the maximum measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskTimeWriteMax |
diskTimeWriteMin |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Milliseconds a write operation took to complete; provide the minimum measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskTimeWriteMin |
diskTotalReadLatencyAvg |
Number |
0..1 |
Preliminary OpenModelAttribute
|
The average amount of time taken for a read from the perspective of a Guest OS. This is the sum of Kernel Read Latency and Physical Device Read Latency in milliseconds over the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskTotalReadLatencyAvg |
diskTotalWriteLatencyAvg |
Number |
0..1 |
Preliminary OpenModelAttribute
|
The average amount of time taken for a write from the perspective of a Guest OS. This is the sum of Kernel Write Latency and Physical Device Write Latency in milliseconds over the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskTotalWriteLatencyAvg |
diskWeightedIoTimeAvg |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Measure in ms over 1 sec of both I/O completion time and the backlog that may be accumulating. Value is the average within the collection interval. |
Ves::ObjectClasses::DiskUsage::diskWeightedIoTimeAvg |
diskWeightedIoTimeLast |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Measure in ms over 1 sec of both I/O completion time and the backlog that may be accumulating. Value is the last within the collection interval. |
Ves::ObjectClasses::DiskUsage::diskWeightedIoTimeLast |
diskWeightedIoTimeMax |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Measure in ms over 1 sec of both I/O completion time and the backlog that may be accumulating. Value is the maximum within the collection interval. |
Ves::ObjectClasses::DiskUsage::diskWeightedIoTimeMax |
diskWeightedIoTimeMin |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Measure in ms over 1 sec of both I/O completion time and the backlog that may be accumulating. Value is the minimum within the collection interval. |
Ves::ObjectClasses::DiskUsage::diskWeightedIoTimeMin |
diskWriteCommandsAvg |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Average number of write commands issued per second to the disk over the measurementInterval |
Ves::ObjectClasses::DiskUsage::diskWriteCommandsAvg |
EndOfCallVqmSummaries
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
adjacencyName |
String |
1 |
Preliminary OpenModelAttribute
|
Adjacency name |
Ves::ObjectClasses::EndOfCallVqmSummaries::adjacencyName |
endpointAverageJitter |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Endpoint average jitter |
Ves::ObjectClasses::EndOfCallVqmSummaries::endpointAverageJitter |
endpointDescription |
EndpointDescription |
1 |
Preliminary OpenModelAttribute
|
Enumeration: ‘Caller’, ‘Callee’ |
Ves::ObjectClasses::EndOfCallVqmSummaries::endpointDescription |
endpointMaxJitter |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Endpoint maximum jitter |
Ves::ObjectClasses::EndOfCallVqmSummaries::endpointMaxJitter |
endpointRtpOctetsDiscarded |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Endpoint RTP octets discarded |
Ves::ObjectClasses::EndOfCallVqmSummaries::endpointRtpOctetsDiscarded |
endpointRtpOctetsLost |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Endpoint RTP octets lost |
Ves::ObjectClasses::EndOfCallVqmSummaries::endpointRtpOctetsLost |
endpointRtpOctetsReceived |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Endpoint RTP octets received |
Ves::ObjectClasses::EndOfCallVqmSummaries::endpointRtpOctetsReceived |
endpointRtpOctetsSent |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Endpoint RTP octets sent |
Ves::ObjectClasses::EndOfCallVqmSummaries::endpointRtpOctetsSent |
endpointRtpPacketsDiscarded |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Endpoint RTP packets discarded |
Ves::ObjectClasses::EndOfCallVqmSummaries::endpointRtpPacketsDiscarded |
endpointRtpPacketsLost |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Endpoint RTP packets lost |
Ves::ObjectClasses::EndOfCallVqmSummaries::endpointRtpPacketsLost |
endpointRtpPacketsReceived |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Endpoint RTP packets received |
Ves::ObjectClasses::EndOfCallVqmSummaries::endpointRtpPacketsReceived |
endpointRtpPacketsSent |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Endpoint RTP packets sent |
Ves::ObjectClasses::EndOfCallVqmSummaries::endpointRtpPacketsSent |
localAverageJitter |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Local average jitter |
Ves::ObjectClasses::EndOfCallVqmSummaries::localAverageJitter |
localAverageJitterBufferDelay |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Local average jitter buffer delay |
Ves::ObjectClasses::EndOfCallVqmSummaries::localAverageJitterBufferDelay |
localMaxJitter |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Local maximum jitter |
Ves::ObjectClasses::EndOfCallVqmSummaries::localMaxJitter |
localMaxJitterBufferDelay |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Local max jitter buffer delay |
Ves::ObjectClasses::EndOfCallVqmSummaries::localMaxJitterBufferDelay |
localRtpOctetsDiscarded |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Local RTP octets discarded |
Ves::ObjectClasses::EndOfCallVqmSummaries::localRtpOctetsDiscarded |
localRtpOctetsLost |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Local RTP octets lost |
Ves::ObjectClasses::EndOfCallVqmSummaries::localRtpOctetsLost |
localRtpOctetsReceived |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Local RTP octets received |
Ves::ObjectClasses::EndOfCallVqmSummaries::localRtpOctetsReceived |
localRtpOctetsSent |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Local RTP octets sent |
Ves::ObjectClasses::EndOfCallVqmSummaries::localRtpOctetsSent |
localRtpPacketsDiscarded |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Local RTP packets discarded |
Ves::ObjectClasses::EndOfCallVqmSummaries::localRtpPacketsDiscarded |
localRtpPacketsLost |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Local RTP packets lost |
Ves::ObjectClasses::EndOfCallVqmSummaries::localRtpPacketsLost |
localRtpPacketsReceived |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Local RTP packets received |
Ves::ObjectClasses::EndOfCallVqmSummaries::localRtpPacketsReceived |
localRtpPacketsSent |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Local RTP packets sent |
Ves::ObjectClasses::EndOfCallVqmSummaries::localRtpPacketsSent |
mosCqe |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Decimal range from 1 to 5 (1 decimal place) |
Ves::ObjectClasses::EndOfCallVqmSummaries::mosCqe |
oneWayDelay |
Number |
0..1 |
Preliminary OpenModelAttribute
|
one-way path delay in milliseconds |
Ves::ObjectClasses::EndOfCallVqmSummaries::oneWayDelay |
packetLossPercent |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Calculated percentage packet loss based on endpoint RTP packets lost (as reported in RTCP) and local RTP packets sent. Direction is based on endpoint description (Caller, Callee). Decimal (2 decimal places) |
Ves::ObjectClasses::EndOfCallVqmSummaries::packetLossPercent |
rFactor |
Number |
0..1 |
Preliminary OpenModelAttribute
|
rFactor from 0 to 100 |
Ves::ObjectClasses::EndOfCallVqmSummaries::rFactor |
roundTripDelay |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Round trip delay in milliseconds |
Ves::ObjectClasses::EndOfCallVqmSummaries::roundTripDelay |
Fault
Fields specific to fault events
Parent class: VesEvent
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
alarmAdditionalInformation |
HashMap |
0..1 |
Preliminary OpenModelAttribute
|
Additional alarm information. ? Note1: for SNMP mapping to VES, for hash key use OID of varbind, for value use incoming data for that varbind). ? Note2: Alarm ID for 3GPP should be included (if applicable) in alarmAdditonalInformation as ‘alarmId’:’alarmIdValue’. Could contain managed object instance as separate key:value; could add probable cause as separate key:value. |
Ves::ObjectClasses::Fault::alarmAdditionalInformation |
alarmCondition |
String |
1 |
Preliminary OpenModelAttribute
|
Short name of the alarm condition/problem, such as a trap name. Should not have white space (e.g., tpLgCgiNotInConfig, BfdSessionDown, linkDown, etc…) |
Ves::ObjectClasses::Fault::alarmCondition |
alarmInterfaceA |
String |
0..1 |
Preliminary OpenModelAttribute
|
Card, port, channel or interface name of the device generating the alarm. This could reflect managed object. |
Ves::ObjectClasses::Fault::alarmInterfaceA |
eventCatagory |
String |
0..1 |
Preliminary OpenModelAttribute
|
Event category, for example: ‘license’, ‘link’, ‘routing’, ‘security’, ‘signaling’ |
Ves::ObjectClasses::Fault::eventCatagory |
eventSeverity |
EventSeverity |
1 |
Preliminary OpenModelAttribute
|
Event severity enumeration: ‘CRITICAL’, ‘MAJOR’, ‘MINOR’, ‘WARNING’, ‘NORMAL’. NORMAL is used to represent clear. |
Ves::ObjectClasses::Fault::eventSeverity |
eventSourceType |
String |
1 |
Preliminary OpenModelAttribute
|
Examples: ‘card’, ‘host’, ‘other’, ‘port’, ‘portThreshold’, ‘router’, ‘slotThreshold’, ‘switch’, ‘virtualMachine’, ‘virtualNetworkFunction’. This could be managed object class. |
Ves::ObjectClasses::Fault::eventSourceType |
faultFieldsVersion |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the faultFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. |
Ves::ObjectClasses::Fault::faultFieldsVersion |
specificProblem |
String |
1 |
Preliminary OpenModelAttribute
|
Description of the alarm or problem (e.g., ‘eNodeB 155197 in PLMN 310-410 with eNodeB name KYL05197 is lost’). 3GPP probable cause would be included in this field. |
Ves::ObjectClasses::Fault::specificProblem |
vfStatus |
VfStatus |
1 |
Preliminary OpenModelAttribute
|
Virtual function status enumeration: ‘Active’, ‘Idle’, ‘Preparing to terminate’, ‘Ready to terminate’, ‘Requesting Termination’ |
Ves::ObjectClasses::Fault::vfStatus |
domain |
Domain |
1 |
Experimental OpenModelAttribute
|
Update in definition only Event domain enumeration: ‘cmNotify’,’fault’, ‘heartbeat’, ‘measurement’, ‘mobileFlow’, ‘notification’, ‘other’, ‘pnfRegistration’, ‘sipSignaling’, ‘stateChange’, ‘syslog’, ‘thresholdCrossingAlert’, ‘voiceQuality’ |
Ves::ObjectClasses::VesEvent::domain |
eventType |
String |
0..1 |
Preliminary OpenModelAttribute
|
For example: ‘applicationNf’, ‘guestOS’, ‘hostOS’, ‘platform’ |
Ves::ObjectClasses::VesEvent::eventType |
lastEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
the latest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds |
Ves::ObjectClasses::VesEvent::lastEpochMicrosec |
nfcNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function component type: 3 characters (aligned with vfc naming standards) |
Ves::ObjectClasses::VesEvent::nfcNamingCode |
nfNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function type: 4 characters (aligned with vnf and pnf naming standards) |
Ves::ObjectClasses::VesEvent::nfNamingCode |
nfVendorName |
String |
1 |
Preliminary OpenModelAttribute
|
Network function vendor name |
Ves::ObjectClasses::VesEvent::nfVendorName |
priority |
Priority |
1 |
Preliminary OpenModelAttribute
|
Processing priority enumeration: ‘High’, ‘Medium’, ‘Normal’, ‘Low’ |
Ves::ObjectClasses::VesEvent::priority |
reportingEntityId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See ‘reportingEntityName’ for more information. reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. |
Ves::ObjectClasses::VesEvent::reportingEntityId |
reportingEntityName |
String |
1 |
Preliminary OpenModelAttribute
|
reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. |
Ves::ObjectClasses::VesEvent::reportingEntityName |
sequence |
Integer |
1 |
Preliminary OpenModelAttribute
|
sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ordering of events communicated by an event source instance (or 0 if not needed) |
Ves::ObjectClasses::VesEvent::sequence |
sourceId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See ‘sourceName’ for more information. sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. |
Ves::ObjectClasses::VesEvent::sourceId |
sourceName |
String |
1 |
Preliminary OpenModelAttribute
|
Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. |
Ves::ObjectClasses::VesEvent::sourceName |
startingEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) |
Ves::ObjectClasses::VesEvent::startingEpochMicrosec |
timeZoneOffset |
String |
0..1 |
Preliminary OpenModelAttribute
|
Offset to GMT to indicate local time zone for device formatted as ‘UTC+/-hh:mm’; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples |
Ves::ObjectClasses::VesEvent::timeZoneOffset |
version |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the event header as “#.#” where # is a digit; see section 1 for the correct digits to use. |
Ves::ObjectClasses::VesEvent::version |
vesEventListenerVersion |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the ves event listener api spec that this event is compliant with (as “#” or “#.#” or “#.#.#” where # is a digit; see section 1 for the correct digits to use). |
Ves::ObjectClasses::VesEvent::vesEventListenerVersion |
name |
String |
1 |
Preliminary OpenModelAttribute
|
Ves::ObjectClasses::VesEvent::name |
|
Status |
String |
0..1 |
Preliminary OpenModelAttribute
|
The current condition of an interaction, such as open, in research, closed, and so forth |
Common::Business Interaction::ObjectClasses::BusinessInteraction::Status |
description |
String |
0..1 |
Preliminary OpenModelAttribute
|
Defines a textual free-form description of the object. |
Common::Root::RootObjectClasses::RootEntity::description |
id |
Identifier |
1 |
Preliminary OpenModelAttribute
|
Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. |
Common::Root::RootObjectClasses::RootEntity::id |
FilesystemUsage
The filesystemUsage datatype consists of the following fields:
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
blockConfigured |
Number |
1 |
Preliminary OpenModelAttribute
|
Configured block storage capacity in GB. |
Ves::ObjectClasses::FilesystemUsage::blockConfigured |
blockops |
Number |
1 |
Preliminary OpenModelAttribute
|
Block storage input-output operations per second. |
Ves::ObjectClasses::FilesystemUsage::blockops |
blockUsed |
Number |
1 |
Preliminary OpenModelAttribute
|
Used block storage capacity in GB. |
Ves::ObjectClasses::FilesystemUsage::blockUsed |
ephemeralConfigured |
Number |
1 |
Preliminary OpenModelAttribute
|
Configured ephemeral storage capacity in GB. |
Ves::ObjectClasses::FilesystemUsage::ephemeralConfigured |
ephemerallops |
Number |
1 |
Preliminary OpenModelAttribute
|
Ephemeral storage input-output operations per second. |
Ves::ObjectClasses::FilesystemUsage::ephemerallops |
ephemeralUsed |
Number |
1 |
Preliminary OpenModelAttribute
|
Used ephemeral storage capacity in GB. |
Ves::ObjectClasses::FilesystemUsage::ephemeralUsed |
filesysytemName |
String |
1 |
Preliminary OpenModelAttribute
|
File system name. |
Ves::ObjectClasses::FilesystemUsage::filesysytemName |
GtpPerFlowMetrics
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
avgBitErrorRate |
Number |
1 |
Preliminary OpenModelAttribute
|
Average bit error rate |
Ves::ObjectClasses::GtpPerFlowMetrics::avgBitErrorRate |
avgPacketDelayVariation |
Number |
1 |
Preliminary OpenModelAttribute
|
Average packet delay variation or jitter in milliseconds for received packets: Average difference between the packet timestamp and time received for all pairs of consecutive packets |
Ves::ObjectClasses::GtpPerFlowMetrics::avgPacketDelayVariation |
avgPacketLatency |
Number |
1 |
Preliminary OpenModelAttribute
|
Average delivery latency |
Ves::ObjectClasses::GtpPerFlowMetrics::avgPacketLatency |
avgReceiveThroughput |
Number |
1 |
Preliminary OpenModelAttribute
|
Average receive throughput |
Ves::ObjectClasses::GtpPerFlowMetrics::avgReceiveThroughput |
avgTransmitThroughput |
Number |
1 |
Preliminary OpenModelAttribute
|
Average transmit throughput |
Ves::ObjectClasses::GtpPerFlowMetrics::avgTransmitThroughput |
durConnectionFailedStatus |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Duration of failed state in milliseconds, computed as the cumulative time between a failed echo request and the next following successful error request, over this reporting interval |
Ves::ObjectClasses::GtpPerFlowMetrics::durConnectionFailedStatus |
durTunnelFailedStatus |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Duration of errored state, computed as the cumulative time between a tunnel error indicator and the next following non-errored indicator, over this reporting interval |
Ves::ObjectClasses::GtpPerFlowMetrics::durTunnelFailedStatus |
flowActivatedBy |
String |
0..1 |
Preliminary OpenModelAttribute
|
Endpoint activating the flow |
Ves::ObjectClasses::GtpPerFlowMetrics::flowActivatedBy |
flowActivationEpoch |
Number |
1 |
Preliminary OpenModelAttribute
|
Time the connection is activated in the flow (connection) being reported on, or transmission time of the first packet if activation time is not available |
Ves::ObjectClasses::GtpPerFlowMetrics::flowActivationEpoch |
flowActivationMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
Integer microseconds for the start of the flow connection |
Ves::ObjectClasses::GtpPerFlowMetrics::flowActivationMicrosec |
flowActivationTime |
String |
0..1 |
Preliminary OpenModelAttribute
|
Time the connection is activated in the flow being reported on, or transmission time of the first packet if activation time is not available; with RFC 2822 compliant format: ‘Sat, 13 Mar 2010 11:29:05 -0800’ |
Ves::ObjectClasses::GtpPerFlowMetrics::flowActivationTime |
flowDeactivatedBy |
String |
0..1 |
Preliminary OpenModelAttribute
|
Endpoint deactivating the flow |
Ves::ObjectClasses::GtpPerFlowMetrics::flowDeactivatedBy |
flowDeactivationEpoch |
Number |
1 |
Preliminary OpenModelAttribute
|
Time for the start of the flow connection, in integer UTC epoch time aka UNIX time |
Ves::ObjectClasses::GtpPerFlowMetrics::flowDeactivationEpoch |
flowDeactivationMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
Integer microseconds for the start of the flow connection |
Ves::ObjectClasses::GtpPerFlowMetrics::flowDeactivationMicrosec |
flowDeactivationTime |
String |
1 |
Preliminary OpenModelAttribute
|
Transmission time of the first packet in the flow connection being reported on; with RFC 2822 compliant format: ‘Sat, 13 Mar 2010 11:29:05 -0800’ |
Ves::ObjectClasses::GtpPerFlowMetrics::flowDeactivationTime |
flowStatus |
String |
1 |
Preliminary OpenModelAttribute
|
Connection status at reporting time as a working / inactive / failed indicator value |
Ves::ObjectClasses::GtpPerFlowMetrics::flowStatus |
gtpConnectionStatus |
String |
0..1 |
Preliminary OpenModelAttribute
|
Current connection state at reporting time |
Ves::ObjectClasses::GtpPerFlowMetrics::gtpConnectionStatus |
gtpTunnelStatus |
String |
0..1 |
Preliminary OpenModelAttribute
|
Current tunnel state at reporting time |
Ves::ObjectClasses::GtpPerFlowMetrics::gtpTunnelStatus |
ipTosCountList |
HashMap |
0..1 |
Preliminary OpenModelAttribute
|
Array of key: value pairs where the keys are drawn from the IP Type-of-Service identifiers which range from ‘0’ to ‘255’, and the values are the count of packets that had those ToS identifiers in the flow |
Ves::ObjectClasses::GtpPerFlowMetrics::ipTosCountList |
ipTosList |
String |
0..1 |
Preliminary OpenModelAttribute
|
Array of unique IP Type-of-Service values observed in the flow where values range from ‘0’ to ‘255’ |
Ves::ObjectClasses::GtpPerFlowMetrics::ipTosList |
largePacketRtt |
Number |
0..1 |
Preliminary OpenModelAttribute
|
large packet round trip time |
Ves::ObjectClasses::GtpPerFlowMetrics::largePacketRtt |
largePacketThreshold |
Number |
0..1 |
Preliminary OpenModelAttribute
|
large packet threshold being applied |
Ves::ObjectClasses::GtpPerFlowMetrics::largePacketThreshold |
maxPacketDelayVariation |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Maximum packet delay variation or jitter in milliseconds for received packets: Maximum of the difference between the packet timestamp and time received for all pairs of consecutive packets |
Ves::ObjectClasses::GtpPerFlowMetrics::maxPacketDelayVariation |
maxReceiveBitRate |
Number |
0..1 |
Preliminary OpenModelAttribute
|
maximum receive bit rate” |
Ves::ObjectClasses::GtpPerFlowMetrics::maxReceiveBitRate |
maxTransmitBitRate |
Number |
0..1 |
Preliminary OpenModelAttribute
|
maximum transmit bit rate |
Ves::ObjectClasses::GtpPerFlowMetrics::maxTransmitBitRate |
mobileQciCosCountList |
HashMap |
0..1 |
Preliminary OpenModelAttribute
|
array of key: value pairs where the keys are drawn from LTE QCI or UMTS class of service strings, and the values are the count of packets that had those strings in the flow |
Ves::ObjectClasses::GtpPerFlowMetrics::mobileQciCosCountList |
mobileQciCosList |
String |
0..1 |
Preliminary OpenModelAttribute
|
Array of unique LTE QCI or UMTS class-of-service values observed in the flow |
Ves::ObjectClasses::GtpPerFlowMetrics::mobileQciCosList |
numActivationFailures |
Number |
1 |
Preliminary OpenModelAttribute
|
Number of failed activation requests, as observed by the reporting node |
Ves::ObjectClasses::GtpPerFlowMetrics::numActivationFailures |
numBitErrors |
Number |
1 |
Preliminary OpenModelAttribute
|
number of errored bits number of errored bits |
Ves::ObjectClasses::GtpPerFlowMetrics::numBitErrors |
numBytesReceived |
Number |
1 |
Preliminary OpenModelAttribute
|
number of bytes received, including retransmissions |
Ves::ObjectClasses::GtpPerFlowMetrics::numBytesReceived |
numBytesTransmitted |
Number |
1 |
Preliminary OpenModelAttribute
|
number of bytes transmitted, including retransmissions |
Ves::ObjectClasses::GtpPerFlowMetrics::numBytesTransmitted |
numDroppedPackets |
Number |
1 |
Preliminary OpenModelAttribute
|
number of received packets dropped due to errors per virtual interface |
Ves::ObjectClasses::GtpPerFlowMetrics::numDroppedPackets |
numGtpEchoFailures |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of Echo request path failures where failed paths are defined in 3GPP TS 29.281 sec 7.2.1 and 3GPP TS 29.060 sec. 11.2 |
Ves::ObjectClasses::GtpPerFlowMetrics::numGtpEchoFailures |
numGtpTunnelErrors |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of tunnel error indications where errors are defined in 3GPP TS 29.281 sec 7.3.1 and 3GPP TS 29.060 sec. 11.1 |
Ves::ObjectClasses::GtpPerFlowMetrics::numGtpTunnelErrors |
numHttpErrors |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Http error count |
Ves::ObjectClasses::GtpPerFlowMetrics::numHttpErrors |
numL7BytesReceived |
Number |
1 |
Preliminary OpenModelAttribute
|
number of tunneled layer 7 bytes received, including retransmissions |
Ves::ObjectClasses::GtpPerFlowMetrics::numL7BytesReceived |
numL7BytesTransmitted |
Number |
1 |
Preliminary OpenModelAttribute
|
number of tunneled layer 7 bytes received, including retransmissions |
Ves::ObjectClasses::GtpPerFlowMetrics::numL7BytesTransmitted |
numLostPackets |
Number |
1 |
Preliminary OpenModelAttribute
|
number of tunneled layer 7 bytes received, including retransmissions |
Ves::ObjectClasses::GtpPerFlowMetrics::numLostPackets |
numOutOfOrderPackets |
Number |
1 |
Preliminary OpenModelAttribute
|
number of out-of-order packets |
Ves::ObjectClasses::GtpPerFlowMetrics::numOutOfOrderPackets |
numPacketErrors |
Number |
1 |
Preliminary OpenModelAttribute
|
number of errored packets |
Ves::ObjectClasses::GtpPerFlowMetrics::numPacketErrors |
numPacketsReceivedExclRetrans |
Number |
1 |
Preliminary OpenModelAttribute
|
number of packets received, excluding retransmission |
Ves::ObjectClasses::GtpPerFlowMetrics::numPacketsReceivedExclRetrans |
numPacketsReceivedInclRetrans |
Number |
1 |
Preliminary OpenModelAttribute
|
number of packets received, including retransmission |
Ves::ObjectClasses::GtpPerFlowMetrics::numPacketsReceivedInclRetrans |
numPacketsTransmittedInclRetrans |
Number |
1 |
Preliminary OpenModelAttribute
|
number of packets transmitted, including retransmissions |
Ves::ObjectClasses::GtpPerFlowMetrics::numPacketsTransmittedInclRetrans |
numRetries |
Number |
1 |
Preliminary OpenModelAttribute
|
number of packet retrie |
Ves::ObjectClasses::GtpPerFlowMetrics::numRetries |
numTimeouts |
Number |
1 |
Preliminary OpenModelAttribute
|
number of packet timeouts |
Ves::ObjectClasses::GtpPerFlowMetrics::numTimeouts |
numTunneledL7BytesReceived |
Number |
1 |
Preliminary OpenModelAttribute
|
number of tunneled layer 7 bytes received, excluding retransmissions |
Ves::ObjectClasses::GtpPerFlowMetrics::numTunneledL7BytesReceived |
roundTripTime |
Number |
1 |
Preliminary OpenModelAttribute
|
Round Trip time |
Ves::ObjectClasses::GtpPerFlowMetrics::roundTripTime |
tcpFlagCountList |
HashMap |
0..1 |
Preliminary OpenModelAttribute
|
Array of key: value pairs where the keys are drawn from TCP Flags and the values are the count of packets that had that TCP Flag in the flow |
Ves::ObjectClasses::GtpPerFlowMetrics::tcpFlagCountList |
tcpFlagList |
String |
0..1 |
Preliminary OpenModelAttribute
|
Array of unique TCP Flags observed in the flow |
Ves::ObjectClasses::GtpPerFlowMetrics::tcpFlagList |
timeToFirstByte |
Number |
1 |
Preliminary OpenModelAttribute
|
Time in milliseconds between the connection activation and first byte received |
Ves::ObjectClasses::GtpPerFlowMetrics::timeToFirstByte |
Heartbeat
The heartbeatFields datatype is an optional field block for fields specific to heartbeat events.
Parent class: VesEvent
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
additionalFields |
HashMap |
0..1 |
Preliminary OpenModelAttribute
|
Additional expansion fields if needed. |
Ves::ObjectClasses::Heartbeat::additionalFields |
heartbeatFieldVersion |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the heartbeatFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. |
Ves::ObjectClasses::Heartbeat::heartbeatFieldVersion |
heartbeatInterval |
Integer |
1 |
Preliminary OpenModelAttribute
|
Current heartbeatInterval in seconds. |
Ves::ObjectClasses::Heartbeat::heartbeatInterval |
domain |
Domain |
1 |
Experimental OpenModelAttribute
|
Update in definition only Event domain enumeration: ‘cmNotify’,’fault’, ‘heartbeat’, ‘measurement’, ‘mobileFlow’, ‘notification’, ‘other’, ‘pnfRegistration’, ‘sipSignaling’, ‘stateChange’, ‘syslog’, ‘thresholdCrossingAlert’, ‘voiceQuality’ |
Ves::ObjectClasses::VesEvent::domain |
eventType |
String |
0..1 |
Preliminary OpenModelAttribute
|
For example: ‘applicationNf’, ‘guestOS’, ‘hostOS’, ‘platform’ |
Ves::ObjectClasses::VesEvent::eventType |
lastEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
the latest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds |
Ves::ObjectClasses::VesEvent::lastEpochMicrosec |
nfcNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function component type: 3 characters (aligned with vfc naming standards) |
Ves::ObjectClasses::VesEvent::nfcNamingCode |
nfNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function type: 4 characters (aligned with vnf and pnf naming standards) |
Ves::ObjectClasses::VesEvent::nfNamingCode |
nfVendorName |
String |
1 |
Preliminary OpenModelAttribute
|
Network function vendor name |
Ves::ObjectClasses::VesEvent::nfVendorName |
priority |
Priority |
1 |
Preliminary OpenModelAttribute
|
Processing priority enumeration: ‘High’, ‘Medium’, ‘Normal’, ‘Low’ |
Ves::ObjectClasses::VesEvent::priority |
reportingEntityId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See ‘reportingEntityName’ for more information. reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. |
Ves::ObjectClasses::VesEvent::reportingEntityId |
reportingEntityName |
String |
1 |
Preliminary OpenModelAttribute
|
reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. |
Ves::ObjectClasses::VesEvent::reportingEntityName |
sequence |
Integer |
1 |
Preliminary OpenModelAttribute
|
sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ordering of events communicated by an event source instance (or 0 if not needed) |
Ves::ObjectClasses::VesEvent::sequence |
sourceId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See ‘sourceName’ for more information. sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. |
Ves::ObjectClasses::VesEvent::sourceId |
sourceName |
String |
1 |
Preliminary OpenModelAttribute
|
Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. |
Ves::ObjectClasses::VesEvent::sourceName |
startingEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) |
Ves::ObjectClasses::VesEvent::startingEpochMicrosec |
timeZoneOffset |
String |
0..1 |
Preliminary OpenModelAttribute
|
Offset to GMT to indicate local time zone for device formatted as ‘UTC+/-hh:mm’; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples |
Ves::ObjectClasses::VesEvent::timeZoneOffset |
version |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the event header as “#.#” where # is a digit; see section 1 for the correct digits to use. |
Ves::ObjectClasses::VesEvent::version |
vesEventListenerVersion |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the ves event listener api spec that this event is compliant with (as “#” or “#.#” or “#.#.#” where # is a digit; see section 1 for the correct digits to use). |
Ves::ObjectClasses::VesEvent::vesEventListenerVersion |
name |
String |
1 |
Preliminary OpenModelAttribute
|
Ves::ObjectClasses::VesEvent::name |
|
Status |
String |
0..1 |
Preliminary OpenModelAttribute
|
The current condition of an interaction, such as open, in research, closed, and so forth |
Common::Business Interaction::ObjectClasses::BusinessInteraction::Status |
description |
String |
0..1 |
Preliminary OpenModelAttribute
|
Defines a textual free-form description of the object. |
Common::Root::RootObjectClasses::RootEntity::description |
id |
Identifier |
1 |
Preliminary OpenModelAttribute
|
Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. |
Common::Root::RootObjectClasses::RootEntity::id |
HugePages
The hugePages datatype provides metrics on system hugePages
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
bytesFree |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of free hugePages in bytes. |
Ves::ObjectClasses::HugePages::bytesFree |
bytesUsed |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of used hugePages in bytes. |
Ves::ObjectClasses::HugePages::bytesUsed |
hugePagesIdentifier |
String |
1 |
Preliminary OpenModelAttribute
|
HugePages identifier |
Ves::ObjectClasses::HugePages::hugePagesIdentifier |
percentFree |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of free hugePages in percent. |
Ves::ObjectClasses::HugePages::percentFree |
percentused |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of used hugePages in percent. |
Ves::ObjectClasses::HugePages::percentused |
vmPageNumberFree |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of free hugePages in numbers. |
Ves::ObjectClasses::HugePages::vmPageNumberFree |
vmPageNumberUsed |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of used hugePages in numbers. |
Ves::ObjectClasses::HugePages::vmPageNumberUsed |
Ipmi
The ipmi (Intelligent Platform Management Interface) datatype provides intelligent platform management interface metrics; it consists of the following fields:
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
exitAirTemperature |
Number |
0..1 |
Preliminary OpenModelAttribute
|
System fan exit air flow temperature in Celsius |
Ves::ObjectClasses::Ipmi::exitAirTemperature |
frontPanelTemperature |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Front panel temp in Celsius |
Ves::ObjectClasses::Ipmi::frontPanelTemperature |
ioModuleTemperature |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Io module temp in Celsius |
Ves::ObjectClasses::Ipmi::ioModuleTemperature |
systemAirflow |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Airflow in cubic feet per minute (cfm) |
Ves::ObjectClasses::Ipmi::systemAirflow |
_ipmibaseboardtemperature |
IpmiBaseboardTemperature |
0..1 |
Preliminary OpenModelAttribute
|
Array of ipmiBaseboard Temperature objects |
Ves::ObjectClasses::Ipmi::_ipmibaseboardtemperature |
_ipmibaseboardvoltageregulator |
IpmiBaseboardVoltageRegulator |
0..1 |
Preliminary OpenModelAttribute
|
Array of ipmiBaseboard VoltageRegulator objects |
Ves::ObjectClasses::Ipmi::_ipmibaseboardvoltageregulator |
_ipmibattery |
IpmiBattery |
0..1 |
Preliminary OpenModelAttribute
|
Array of ipmiBattery objects |
Ves::ObjectClasses::Ipmi::_ipmibattery |
_ipmifan |
IpmiFan |
0..1 |
Preliminary OpenModelAttribute
|
Array of ipmiFan objects |
Ves::ObjectClasses::Ipmi::_ipmifan |
_ipmiglobalaggregatetemperaturemargin |
IpmiGlobalAggregateTemperatureMargin |
0..1 |
Preliminary OpenModelAttribute
|
ipmi global aggregate temperature margin |
Ves::ObjectClasses::Ipmi::_ipmiglobalaggregatetemperaturemargin |
_ipmihsbp |
IpmiHsbp |
0..1 |
Preliminary OpenModelAttribute
|
Array of ipmiHsbp objects |
Ves::ObjectClasses::Ipmi::_ipmihsbp |
_ipminic |
IpmiNic |
0..1 |
Preliminary OpenModelAttribute
|
Array of ipmiNic objects |
Ves::ObjectClasses::Ipmi::_ipminic |
_ipmipowersupply |
IpmiPowerSupply |
0..1 |
Preliminary OpenModelAttribute
|
Array of ipmiPowerSupply objects |
Ves::ObjectClasses::Ipmi::_ipmipowersupply |
_ipmiprocessor |
IpmiProcessor |
0..1 |
Preliminary OpenModelAttribute
|
Array of ipmiProcessor objects |
Ves::ObjectClasses::Ipmi::_ipmiprocessor |
IpmiBaseboardTemperature
The ipmiBaseboardTemperature datatype consists of the following fields which describe ipmi baseboard temperature metrics: Field Type Required? Description
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
baseboardTemperature |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Baseboard temperature in celsius |
Ves::ObjectClasses::IpmiBaseboardTemperature::baseboardTemperature |
baseboardTemperature Identifier |
String |
1 |
Preliminary OpenModelAttribute
|
Identifier for the location where the temperature is taken |
Ves::ObjectClasses::IpmiBaseboardTemperature::baseboardTemperature Identifier |
IpmiBaseboardVoltageRegulator
The ipmiBaseboardVoltageRegulator datatype consists of the following fields which describe ipmi baseboard voltage regulator metrics:
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
baseboaredVoltageRegulatorIdentifier |
String |
1 |
Preliminary OpenModelAttribute
|
Identifier for the baseboard voltage regulator |
Ves::ObjectClasses::IpmiBaseboardVoltageRegulator::baseboaredVoltageRegulatorIdentifier |
voltageRegulatorTemperature |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Voltage regulator temperature in celsius |
Ves::ObjectClasses::IpmiBaseboardVoltageRegulator::voltageRegulatorTemperature |
IpmiBattery
The ipmiBattery datatype consists of the following fields which describe ipmi battery metrics:
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
batteryIdentifier |
String |
1 |
Preliminary OpenModelAttribute
|
Identifier for the battery |
Ves::ObjectClasses::IpmiBattery::batteryIdentifier |
batteryType |
String |
0..1 |
Preliminary OpenModelAttribute
|
Type of battery |
Ves::ObjectClasses::IpmiBattery::batteryType |
batteryVoltageLevel |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Battery voltage level |
Ves::ObjectClasses::IpmiBattery::batteryVoltageLevel |
IpmiFan
The ipmiFan datatype consists of the following fields which describe ipmi fan metrics:
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
fanIdentifier |
String |
1 |
Preliminary OpenModelAttribute
|
Identifier for the fan |
Ves::ObjectClasses::IpmiFan::fanIdentifier |
fanSpeed |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Fan speed in revolutions per minute (rpm) |
Ves::ObjectClasses::IpmiFan::fanSpeed |
IpmiGlobalAggregateTemperatureMargin
The ipmiGlobalAggregateTemperatureMargin datatype consists of the following fields:
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
globalAggregateTemperatureMargin |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Temperature margin in Celsius relative to a throttling thermal trip point |
Ves::ObjectClasses::IpmiGlobalAggregateTemperatureMargin::globalAggregateTemperatureMargin |
globalAggregateTemperatureMarginIdentifier |
String |
1 |
Preliminary OpenModelAttribute
|
Identifier for the ipmi global aggregate temperature margin metrics |
Ves::ObjectClasses::IpmiGlobalAggregateTemperatureMargin::globalAggregateTemperatureMarginIdentifier |
IpmiHsbp
The ipmiHsbp datatype provides ipmi hot swap backplane power metrics; it consists of the following fields:
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
hsbpIdentifier |
String |
1 |
Preliminary OpenModelAttribute
|
Identifier for the hot swap backplane power unit |
Ves::ObjectClasses::IpmiHsbp::hsbpIdentifier |
hsbpTemperature |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Hot swap backplane power temperature in celsius |
Ves::ObjectClasses::IpmiHsbp::hsbpTemperature |
IpmiNic
The ipmiNic datatype provides network interface control care metrics; it consists of the following fields:
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
nicIdentifier |
String |
1 |
Preliminary OpenModelAttribute
|
Identifier for the network interface control card |
Ves::ObjectClasses::IpmiNic::nicIdentifier |
nicTemperature |
Number |
0..1 |
Preliminary OpenModelAttribute
|
nic temperature in Celsius |
Ves::ObjectClasses::IpmiNic::nicTemperature |
IpmiPowerSupply
The ipmiPowerSupply datatype provides ipmi power supply metrics; it consists of the following fields:
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
powerSupplyCurrentOutputPercent |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Current output voltage as a percentage of the design specified level |
Ves::ObjectClasses::IpmiPowerSupply::powerSupplyCurrentOutputPercent |
powerSupplyIdentifier |
String |
1 |
Preliminary OpenModelAttribute
|
Identifier for the power supply |
Ves::ObjectClasses::IpmiPowerSupply::powerSupplyIdentifier |
powerSupplyInputPower |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Input power in watts |
Ves::ObjectClasses::IpmiPowerSupply::powerSupplyInputPower |
powerSupplyTemperature |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Power supply temperature in Celsius |
Ves::ObjectClasses::IpmiPowerSupply::powerSupplyTemperature |
IpmiProcessor
The ipmiProcessor datatype provides ipmi processor metrics
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
processorThermalControlPercent |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Io module temperatue in celsius |
Ves::ObjectClasses::IpmiProcessor::processorThermalControlPercent |
processorDtsThermalMargin |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Front panel temperature in celsius |
Ves::ObjectClasses::IpmiProcessor::processorDtsThermalMargin |
_processordimmaggregatethermalmargin |
ProcessorDimmAggregateThermalMargin |
0..1 |
Preliminary OpenModelAttribute
|
Array of processorDimmAggregate ThermalMargin objects |
Ves::ObjectClasses::IpmiProcessor::_processordimmaggregatethermalmargin |
processorIdentifier |
String |
1 |
Preliminary OpenModelAttribute
|
Identifier for the power supply |
Ves::ObjectClasses::IpmiProcessor::processorIdentifier |
LatencyBucketMeasure
The latencyBucketMeasure datatype consists of the following fields which describe the number of counts falling within a defined latency bucket
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
countsInTheBucket |
Number |
1 |
Preliminary OpenModelAttribute
|
Number of counts falling within a defined latency bucket |
Ves::ObjectClasses::LatencyBucketMeasure::countsInTheBucket |
highEndOfLatencyBucket |
Number |
0..1 |
Preliminary OpenModelAttribute
|
High end of bucket range (typically in ms) |
Ves::ObjectClasses::LatencyBucketMeasure::highEndOfLatencyBucket |
lowEndOfLatencyBucket |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Low end of bucket range (typically in ms) |
Ves::ObjectClasses::LatencyBucketMeasure::lowEndOfLatencyBucket |
Load
The load datatype provides metrics on system cpu and io utilization obtained using /proc/loadavg
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
longTerm |
Number |
0..1 |
Preliminary OpenModelAttribute
|
number of jobs in the run queue (state R, cpu utilization) or waiting for disk I/O (state D, io utilization) averaged over 15 minutes using /proc/loadavg |
Ves::ObjectClasses::Load::longTerm |
midTerm |
Number |
0..1 |
Preliminary OpenModelAttribute
|
number of jobs in the run queue (state R, cpu utilization) or waiting for disk I/O (state D, io utilization) averaged over 5 minutes using /proc/loadavg |
Ves::ObjectClasses::Load::midTerm |
shortTerm |
Number |
0..1 |
Preliminary OpenModelAttribute
|
number of jobs in the run queue (state R, cpu utilization) or waiting for disk I/O (state D, io utilization) averaged over 1 minute using /proc/loadavg |
Ves::ObjectClasses::Load::shortTerm |
MachineCheckException
The machineCheckException datatype describes machine check exceptions
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
correctedMemoryErrors |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Total hardware errors that were corrected by the hardware (e.g. data corruption corrected via ECC) over the measurementInterval. These errors do not require immediate software actions, but are still reported for accounting and predictive failure analysis |
Ves::ObjectClasses::MachineCheckException::correctedMemoryErrors |
correctedMemoryErrors In1Hr |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Total hardware errors that were corrected by the hardware over the last one hour |
Ves::ObjectClasses::MachineCheckException::correctedMemoryErrors In1Hr |
vmlIdentifier |
String |
1 |
Preliminary OpenModelAttribute
|
processIdentifier |
Ves::ObjectClasses::MachineCheckException::vmlIdentifier |
uncorrectedMemoryErrors |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Total uncorrected hardware errors that were detected by the hardware (e.g., causing data corruption) over the measurementInterval. These errors require a software response. |
Ves::ObjectClasses::MachineCheckException::uncorrectedMemoryErrors |
uncorrectedMemoryErrors In1Hr |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Total uncorrected hardware errors that were detected by the hardware over the last one hour |
Ves::ObjectClasses::MachineCheckException::uncorrectedMemoryErrors In1Hr |
MeasDataCollection
The measDataCollection datatype defines a 3GPP measurement collection structure aligned with the 3GPP PM format
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
formatVersion |
String |
0..1 |
Preliminary OpenModelAttribute
|
3GPP PM reporting file format version from pre-standard TS 28.550 v2.0.0 |
Ves::ObjectClasses::MeasDataCollection::formatVersion |
granularityPeriod |
String |
1 |
Preliminary OpenModelAttribute
|
Granularity period for the PM report in seconds |
Ves::ObjectClasses::MeasDataCollection::granularityPeriod |
measObjInstIdList |
String |
0..1 |
Preliminary OpenModelAttribute
|
Array of monitored object local distinguished name ids per 3GPP TS 32.300 |
Ves::ObjectClasses::MeasDataCollection::measObjInstIdList |
measuredEntityDn |
String |
1 |
Preliminary OpenModelAttribute
|
Distinguished name per 3GPP TS 28.550 |
Ves::ObjectClasses::MeasDataCollection::measuredEntityDn |
measuredEntitySoftwareVersion |
String |
0..1 |
Preliminary OpenModelAttribute
|
Software version for the NF providing the PM data as specified in 3GPP TS 28.550 |
Ves::ObjectClasses::MeasDataCollection::measuredEntitySoftwareVersion |
measuredEntityUserName |
String |
0..1 |
Preliminary OpenModelAttribute
|
User Definable name for the measured object per 3GPP TS 28.550 |
Ves::ObjectClasses::MeasDataCollection::measuredEntityUserName |
_measinfo |
MeasInfo |
1..* |
Preliminary OpenModelAttribute
|
Array of monitored object local distinguished name ids per 3GPP TS 32.300 |
Ves::ObjectClasses::MeasDataCollection::_measinfo |
MeasInfo
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
jobId |
String |
0..1 |
Preliminary OpenModelAttribute
|
Name of the measurement job |
Ves::ObjectClasses::MeasInfo::jobId |
_measinfoidinteger |
measInfoIdInteger |
0..1 |
Preliminary OpenModelAttribute
|
Measurement group Identifier |
Ves::ObjectClasses::MeasInfo::_measinfoidinteger |
_measinfoidstring |
MeasInfoIdString |
0..1 |
Preliminary OpenModelAttribute
|
Measurement group Identifier |
Ves::ObjectClasses::MeasInfo::_measinfoidstring |
_meastypesinteger |
MeasTypesInteger |
0..1 |
Preliminary OpenModelAttribute
|
Array of measurement identifiers associated with the measurement results expressed as integers for efficiency rather than strings |
Ves::ObjectClasses::MeasInfo::_meastypesinteger |
_meastypesstring |
MeasTypesString |
0..1 |
Preliminary OpenModelAttribute
|
Array of measurement identifiers associated with the measurement results expressed as integers for efficiency rather than strings |
Ves::ObjectClasses::MeasInfo::_meastypesstring |
_measValuesList |
MeasValues |
1..* |
Experimental OpenModelAttribute
|
Array of measValues |
Ves::ObjectClasses::MeasInfo::_measValuesList |
MeasInfoIdString
The measInfoIdString datatype provides a string measurement group identifier;
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
sMeasInfoId |
Integer |
1 |
Preliminary OpenModelAttribute
|
String measurement group Identifier |
Ves::ObjectClasses::MeasInfoIdString::sMeasInfoId |
MeasResultInteger
The measResultInteger datatype provides an integer 3GPP PM measurement result;
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
p |
Integer |
1 |
Preliminary OpenModelAttribute
|
Integer reference to the counter |
Ves::ObjectClasses::MeasResultInteger::p |
iValue |
Integer |
1 |
Preliminary OpenModelAttribute
|
Integer counter value |
Ves::ObjectClasses::MeasResultInteger::iValue |
MeasResultString
The measResultString datatype provides a string 3GPP PM measurement result;
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
p |
Integer |
1 |
Preliminary OpenModelAttribute
|
Integer reference to the counter |
Ves::ObjectClasses::MeasResultString::p |
sVlaue |
String |
1 |
Preliminary OpenModelAttribute
|
String counter value |
Ves::ObjectClasses::MeasResultString::sVlaue |
MeasTypesInteger
The measTypesInteger datatype provides an array of integer measurement identifiers associated with the measurement results
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
iMeasTypesList |
Integer |
1..* |
Preliminary OpenModelAttribute
|
Array of integer measurement identifiers associated with the measurement results |
Ves::ObjectClasses::MeasTypesInteger::iMeasTypesList |
MeasTypesString
The measTypesString datatype provides an array of string measurement identifiers associated with the measurement results
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
sMeasTypesList |
String |
1..* |
Preliminary OpenModelAttribute
|
Array of string measurement identifiers associated with the measurement results |
Ves::ObjectClasses::MeasTypesString::sMeasTypesList |
MeasValues
The measValues datatype provides 3GPP measurement values
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
measObjAddFlds |
HashMap |
0..1 |
Preliminary OpenModelAttribute
|
Additional key-value pairs if needed |
Ves::ObjectClasses::MeasValues::measObjAddFlds |
suspectFlag |
Boolean |
1 |
Preliminary OpenModelAttribute
|
Enumeration: ‘true’, ‘false’. Indicates if the values are suspect VES 7.1 Spec has this attribute as a string. |
Ves::ObjectClasses::MeasValues::suspectFlag |
_measresultinteger |
MeasResultInteger |
0..* |
Preliminary OpenModelAttribute
|
Array of results |
Ves::ObjectClasses::MeasValues::_measresultinteger |
_measresultnull |
measResultNull |
0..* |
Preliminary OpenModelAttribute
|
Array of results |
Ves::ObjectClasses::MeasValues::_measresultnull |
_mesresultnumber |
MesResultNumber |
0..* |
Preliminary OpenModelAttribute
|
Array of results |
Ves::ObjectClasses::MeasValues::_mesresultnumber |
_measresultstring |
MeasResultString |
0..* |
Preliminary OpenModelAttribute
|
Array of results |
Ves::ObjectClasses::MeasValues::_measresultstring |
Measurement
Fields specific to measurement events
Parent class: VesEvent
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
additionalFields |
HashMap |
0..1 |
Preliminary OpenModelAttribute
|
Additional measurement fields if needed. |
Ves::ObjectClasses::Measurement::additionalFields |
additionalMeasurements |
ArrayofNamedHashMap |
0..1 |
Preliminary OpenModelAttribute
|
Array of named hashMap if needed. |
Ves::ObjectClasses::Measurement::additionalMeasurements |
additionalObjects |
ArrayOfSchemaObject |
0..1 |
Preliminary OpenModelAttribute
|
Array of Schema objects described by name, schema and other meta-information, if needed. |
Ves::ObjectClasses::Measurement::additionalObjects |
concurrentSessions |
Integer |
0..1 |
Preliminary OpenModelAttribute
|
Peak concurrent sessions for the VM or VNF (depending on the context) over the measurementInterval. |
Ves::ObjectClasses::Measurement::concurrentSessions |
configuredEntities |
Integer |
0..1 |
Preliminary OpenModelAttribute
|
Depending on the context over the measurementInterval: peak total number of users, subscribers, devices, adjacencies, etc., for the VM, or peak total number of subscribers, devices, etc., for the VNF |
Ves::ObjectClasses::Measurement::configuredEntities |
featureUsageArray |
HashMap |
0..1 |
Preliminary OpenModelAttribute
|
The hashMap key should identify the feature, while the value defines the number of times the identified feature was used. |
Ves::ObjectClasses::Measurement::featureUsageArray |
meanRequestLatency |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Mean seconds required to respond to each request for the VM on which the VNFC reporting the event is running. |
Ves::ObjectClasses::Measurement::meanRequestLatency |
measurementFieldsVersion |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the measurementFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. |
Ves::ObjectClasses::Measurement::measurementFieldsVersion |
measurementInterval |
Number |
1 |
Preliminary OpenModelAttribute
|
Interval over which measurements are being reported in seconds |
Ves::ObjectClasses::Measurement::measurementInterval |
nfcScalingMetric |
Integer |
0..1 |
Preliminary OpenModelAttribute
|
Represents busy-ness of the network function from 0 to 100 as reported by the nfc. |
Ves::ObjectClasses::Measurement::nfcScalingMetric |
numberOfMediaPortsInUse |
Integer |
1 |
Preliminary OpenModelAttribute
|
Number of media ports in use. |
Ves::ObjectClasses::Measurement::numberOfMediaPortsInUse |
requestRate |
Number |
1 |
Preliminary OpenModelAttribute
|
Peak request rate per second, for the VM over the measurementInterval |
Ves::ObjectClasses::Measurement::requestRate |
_Hugepages |
HugePages |
0..1 |
Preliminary OpenModelAttribute
|
Array of metrics on hugePages |
Ves::ObjectClasses::Measurement::_Hugepages |
_codecsinuse |
CodecsInUse |
0..* |
Preliminary OpenModelAttribute
|
Array of codecs in use |
Ves::ObjectClasses::Measurement::_codecsinuse |
_cpuUsage |
CpuUsage |
0..* |
Preliminary OpenModelAttribute
|
Usage of an array of CPUs |
Ves::ObjectClasses::Measurement::_cpuUsage |
_diskUsage |
DiskUsage |
0..* |
Preliminary OpenModelAttribute
|
Usage of an array of disks |
Ves::ObjectClasses::Measurement::_diskUsage |
_filesystemusage |
FilesystemUsage |
0..* |
Preliminary OpenModelAttribute
|
Filesystem usage of the VM on which the xNFC reporting the event is running |
Ves::ObjectClasses::Measurement::_filesystemusage |
_ipmi |
Ipmi |
0..1 |
Preliminary OpenModelAttribute
|
Array of intelligent platform management interface metrics |
Ves::ObjectClasses::Measurement::_ipmi |
_latencybucketmeasure |
LatencyBucketMeasure |
0..1 |
Preliminary OpenModelAttribute
|
Array of integers representing counts of requests whose latency in milliseconds falls within per-xNF configured ranges; where latency is the duration between a service request and its fulfillment. |
Ves::ObjectClasses::Measurement::_latencybucketmeasure |
_load |
Load |
0..1 |
Preliminary OpenModelAttribute
|
Array of system load metrics |
Ves::ObjectClasses::Measurement::_load |
_machinecheckexception |
MachineCheckException |
0..1 |
Preliminary OpenModelAttribute
|
Array of machine check exceptions |
Ves::ObjectClasses::Measurement::_machinecheckexception |
_memoryusage |
MemoryUsage |
0..* |
Preliminary OpenModelAttribute
|
Memory usage of an array of VMs |
Ves::ObjectClasses::Measurement::_memoryusage |
_nicperformance |
NicPerformance |
0..* |
Preliminary OpenModelAttribute
|
Performance metrics of an array of network interface cards |
Ves::ObjectClasses::Measurement::_nicperformance |
_processstats |
ProcessStats |
0..* |
Preliminary OpenModelAttribute
|
Array of metrics on system processes |
Ves::ObjectClasses::Measurement::_processstats |
domain |
Domain |
1 |
Experimental OpenModelAttribute
|
Update in definition only Event domain enumeration: ‘cmNotify’,’fault’, ‘heartbeat’, ‘measurement’, ‘mobileFlow’, ‘notification’, ‘other’, ‘pnfRegistration’, ‘sipSignaling’, ‘stateChange’, ‘syslog’, ‘thresholdCrossingAlert’, ‘voiceQuality’ |
Ves::ObjectClasses::VesEvent::domain |
eventType |
String |
0..1 |
Preliminary OpenModelAttribute
|
For example: ‘applicationNf’, ‘guestOS’, ‘hostOS’, ‘platform’ |
Ves::ObjectClasses::VesEvent::eventType |
lastEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
the latest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds |
Ves::ObjectClasses::VesEvent::lastEpochMicrosec |
nfcNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function component type: 3 characters (aligned with vfc naming standards) |
Ves::ObjectClasses::VesEvent::nfcNamingCode |
nfNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function type: 4 characters (aligned with vnf and pnf naming standards) |
Ves::ObjectClasses::VesEvent::nfNamingCode |
nfVendorName |
String |
1 |
Preliminary OpenModelAttribute
|
Network function vendor name |
Ves::ObjectClasses::VesEvent::nfVendorName |
priority |
Priority |
1 |
Preliminary OpenModelAttribute
|
Processing priority enumeration: ‘High’, ‘Medium’, ‘Normal’, ‘Low’ |
Ves::ObjectClasses::VesEvent::priority |
reportingEntityId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See ‘reportingEntityName’ for more information. reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. |
Ves::ObjectClasses::VesEvent::reportingEntityId |
reportingEntityName |
String |
1 |
Preliminary OpenModelAttribute
|
reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. |
Ves::ObjectClasses::VesEvent::reportingEntityName |
sequence |
Integer |
1 |
Preliminary OpenModelAttribute
|
sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ordering of events communicated by an event source instance (or 0 if not needed) |
Ves::ObjectClasses::VesEvent::sequence |
sourceId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See ‘sourceName’ for more information. sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. |
Ves::ObjectClasses::VesEvent::sourceId |
sourceName |
String |
1 |
Preliminary OpenModelAttribute
|
Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. |
Ves::ObjectClasses::VesEvent::sourceName |
startingEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) |
Ves::ObjectClasses::VesEvent::startingEpochMicrosec |
timeZoneOffset |
String |
0..1 |
Preliminary OpenModelAttribute
|
Offset to GMT to indicate local time zone for device formatted as ‘UTC+/-hh:mm’; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples |
Ves::ObjectClasses::VesEvent::timeZoneOffset |
version |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the event header as “#.#” where # is a digit; see section 1 for the correct digits to use. |
Ves::ObjectClasses::VesEvent::version |
vesEventListenerVersion |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the ves event listener api spec that this event is compliant with (as “#” or “#.#” or “#.#.#” where # is a digit; see section 1 for the correct digits to use). |
Ves::ObjectClasses::VesEvent::vesEventListenerVersion |
name |
String |
1 |
Preliminary OpenModelAttribute
|
Ves::ObjectClasses::VesEvent::name |
|
Status |
String |
0..1 |
Preliminary OpenModelAttribute
|
The current condition of an interaction, such as open, in research, closed, and so forth |
Common::Business Interaction::ObjectClasses::BusinessInteraction::Status |
description |
String |
0..1 |
Preliminary OpenModelAttribute
|
Defines a textual free-form description of the object. |
Common::Root::RootObjectClasses::RootEntity::description |
id |
Identifier |
1 |
Preliminary OpenModelAttribute
|
Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. |
Common::Root::RootObjectClasses::RootEntity::id |
MemoryUsage
The memoryUsage datatype defines the memory usage of a virtual machine and consists of the following fields:
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
memoryBuffered |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Kibibytes of temporary storage for raw disk blocks |
Ves::ObjectClasses::MemoryUsage::memoryBuffered |
memoryCached |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Kibibytes of memory used for cache |
Ves::ObjectClasses::MemoryUsage::memoryCached |
memoryConfigured |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Kibibytes of memory configured in the virtual machine on which the xNFC reporting the event is running |
Ves::ObjectClasses::MemoryUsage::memoryConfigured |
memoryDemand |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Host demand in kibibytes |
Ves::ObjectClasses::MemoryUsage::memoryDemand |
memoryFree |
Number |
1 |
Preliminary OpenModelAttribute
|
Kibibytes of physical RAM left unused by the system |
Ves::ObjectClasses::MemoryUsage::memoryFree |
memoryLatencyAvg |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Percentage of time the VM is waiting to access swapped or compressed memory |
Ves::ObjectClasses::MemoryUsage::memoryLatencyAvg |
memorySharedAvg |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Shared memory in kilobytes |
Ves::ObjectClasses::MemoryUsage::memorySharedAvg |
memorySlabRecl |
Number |
0..1 |
Preliminary OpenModelAttribute
|
The part of the slab that can be reclaimed such as caches measured in kibibytes |
Ves::ObjectClasses::MemoryUsage::memorySlabRecl |
memorySlabUnrecl |
Number |
0..1 |
Preliminary OpenModelAttribute
|
The part of the slab that cannot be reclaimed even when lacking memory measure in kibibytes |
Ves::ObjectClasses::MemoryUsage::memorySlabUnrecl |
memorySwapInAvg |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Amount of memory swapped-in from host cache in kibibytes |
Ves::ObjectClasses::MemoryUsage::memorySwapInAvg |
memorySwapInRateAvg |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Rate at which memory is swapped from disk into active memory during the interval in kilobytes per second |
Ves::ObjectClasses::MemoryUsage::memorySwapInRateAvg |
memorySwapOutAvg |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Amount of memory swapped-out to host cache in kibibytes |
Ves::ObjectClasses::MemoryUsage::memorySwapOutAvg |
memorySwapOutRateAvg |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Rate at which memory is being swapped from active memory to disk during the current interval in kilobytes per second |
Ves::ObjectClasses::MemoryUsage::memorySwapOutRateAvg |
memorySwapUsedAvg |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Space used for caching swapped pages in the host cache in kibibytes |
Ves::ObjectClasses::MemoryUsage::memorySwapUsedAvg |
memoryUsed |
Number |
1 |
Preliminary OpenModelAttribute
|
Total memory minus the sum of free, buffered, cached and slab memory measured in kibibytes |
Ves::ObjectClasses::MemoryUsage::memoryUsed |
percentMemoryUsage |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Percentage of memory usage; value = (memoryUsed / (memoryUsed + memoryFree) x 100 if denomintor is nonzero, or 0, if otherwise. |
Ves::ObjectClasses::MemoryUsage::percentMemoryUsage |
vmIdentifier |
String |
1 |
Preliminary OpenModelAttribute
|
Virtual Machine identifier associated with the memory metrics |
Ves::ObjectClasses::MemoryUsage::vmIdentifier |
MesResultNumber
The measResultNumber datatype provides a number 3GPP PM measurement result
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
p |
Integer |
1 |
Preliminary OpenModelAttribute
|
Integer reference to the counter |
Ves::ObjectClasses::MesResultNumber::p |
rValue |
Number |
1 |
Preliminary OpenModelAttribute
|
Number counter value |
Ves::ObjectClasses::MesResultNumber::rValue |
MobileFlow
Fields specific to mobility flow events
Parent class: VesEvent
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
additionalFields |
HashMap |
0..1 |
Preliminary OpenModelAttribute
|
additionalFields - Additional mobileFlow fields if needed. |
Ves::ObjectClasses::MobileFlow::additionalFields |
applicationType |
String |
0..1 |
Preliminary OpenModelAttribute
|
applicationType - Application type inferred |
Ves::ObjectClasses::MobileFlow::applicationType |
applProtocolType |
String |
0..1 |
Preliminary OpenModelAttribute
|
applProtocolType - Application protocol. |
Ves::ObjectClasses::MobileFlow::applProtocolType |
applProtocolVersion |
String |
0..1 |
Preliminary OpenModelAttribute
|
applProtocolVersion - Application version. |
Ves::ObjectClasses::MobileFlow::applProtocolVersion |
cid |
String |
0..1 |
Preliminary OpenModelAttribute
|
cid - Cell Id. |
Ves::ObjectClasses::MobileFlow::cid |
connectionType |
String |
0..1 |
Preliminary OpenModelAttribute
|
connectionType - Abbreviation referencing a 3GPP reference point e.g., S1-U, S11, etc. |
Ves::ObjectClasses::MobileFlow::connectionType |
ecgi |
String |
0..1 |
Preliminary OpenModelAttribute
|
ecgi - Evolved Cell Global Id. |
Ves::ObjectClasses::MobileFlow::ecgi |
flowDirection |
String |
0..1 |
Preliminary OpenModelAttribute
|
flowDirection - Flow direction, indicating if the reporting node is the source of the flow or destination for the flow. |
Ves::ObjectClasses::MobileFlow::flowDirection |
gtpProtocolType |
String |
0..1 |
Preliminary OpenModelAttribute
|
gtpProtocolType - GTP protocol |
Ves::ObjectClasses::MobileFlow::gtpProtocolType |
gtpVersion |
String |
0..1 |
Preliminary OpenModelAttribute
|
gtpVersion - GTP protocol version. |
Ves::ObjectClasses::MobileFlow::gtpVersion |
httpHeader |
String |
0..1 |
Preliminary OpenModelAttribute
|
httpHeader - HTTP request header, if the flow connects to a node referenced by HTTP. |
Ves::ObjectClasses::MobileFlow::httpHeader |
iemi |
String |
0..1 |
Preliminary OpenModelAttribute
|
imei - IMEI for the subscriber UE used in this flow, if the flow connects to a mobile device. |
Ves::ObjectClasses::MobileFlow::iemi |
imsi |
String |
0..1 |
Preliminary OpenModelAttribute
|
imsi - IMSI for the subscriber UE used in this flow, if the flow connects to a mobile device |
Ves::ObjectClasses::MobileFlow::imsi |
ipProtocolType |
String |
0..1 |
Preliminary OpenModelAttribute
|
ipProtocolType - IP protocol type e.g., TCP, UDP, RTP… |
Ves::ObjectClasses::MobileFlow::ipProtocolType |
ipVersion |
String |
0..1 |
Preliminary OpenModelAttribute
|
ipVersion - IP protocol version e.g., IPv4, IPv6 |
Ves::ObjectClasses::MobileFlow::ipVersion |
lac |
String |
0..1 |
Preliminary OpenModelAttribute
|
lac - Location area code. |
Ves::ObjectClasses::MobileFlow::lac |
mcc |
String |
0..1 |
Preliminary OpenModelAttribute
|
mcc - Mobile country code. |
Ves::ObjectClasses::MobileFlow::mcc |
mnc |
String |
0..1 |
Preliminary OpenModelAttribute
|
mnc - Mobile network code. |
Ves::ObjectClasses::MobileFlow::mnc |
mobileFlowFieldsVersion |
Number |
0..1 |
Preliminary OpenModelAttribute
|
mobileFlowFieldsVersion - Version of the mobileFlowFields block. |
Ves::ObjectClasses::MobileFlow::mobileFlowFieldsVersion |
msisdn |
String |
0..1 |
Preliminary OpenModelAttribute
|
msisdn - MSISDN for the subscriber UE used in this flow, as an integer, if the flow connects to a mobile device. |
Ves::ObjectClasses::MobileFlow::msisdn |
otherEndpointlpAddress |
String |
0..1 |
Preliminary OpenModelAttribute
|
otherEndpointIpAddress - IP address for the other endpoint, as used for the flow being reported on. Note: current data type (String) may be changed to Common Resource Datatype L3AddressData. =[gh]= |
Ves::ObjectClasses::MobileFlow::otherEndpointlpAddress |
otherEndpointPort |
Number |
0..1 |
Preliminary OpenModelAttribute
|
otherEndpointPort - IP Port for the reporting entity, as used for the flow being reported on |
Ves::ObjectClasses::MobileFlow::otherEndpointPort |
otherFunctionalRole |
String |
0..1 |
Preliminary OpenModelAttribute
|
otherFunctionalRole - Functional role of the other endpoint for the flow being reported on e.g., MME, S-GW, P-GW, PCRF… |
Ves::ObjectClasses::MobileFlow::otherFunctionalRole |
rac |
String |
0..1 |
Preliminary OpenModelAttribute
|
rac - Routing area code |
Ves::ObjectClasses::MobileFlow::rac |
radioAccessTechnology |
String |
0..1 |
Preliminary OpenModelAttribute
|
radioAccessTechnology - Radio Access Technology e.g., 2G, 3G, 4G and 5G. (GSM, UMTS, LTE, 5G) |
Ves::ObjectClasses::MobileFlow::radioAccessTechnology |
reportingEndpointlpAddr |
String |
0..1 |
Preliminary OpenModelAttribute
|
reportingEndpointIpAddr - IP address for the reporting entity, as used for the flow being reported on. Note: current data type (String) may be changed to Common Resource Datatype L3AddressData. =[gh]= |
Ves::ObjectClasses::MobileFlow::reportingEndpointlpAddr |
reportingEndpointPort |
Number |
0..1 |
Preliminary OpenModelAttribute
|
reportingEndpointPort - IP port for the reporting entity, as used for the flow being reported on. |
Ves::ObjectClasses::MobileFlow::reportingEndpointPort |
sac |
String |
0..1 |
Preliminary OpenModelAttribute
|
sac - Service area code |
Ves::ObjectClasses::MobileFlow::sac |
samplingAlgorithm |
Number |
0..1 |
Preliminary OpenModelAttribute
|
samplingAlgorithm - Integer identifier for the sampling algorithm or rule being applied in calculating the flow metrics if metrics are calculated based on a sample of packets, or 0 if no sampling is applied. |
Ves::ObjectClasses::MobileFlow::samplingAlgorithm |
tac |
String |
0..1 |
Preliminary OpenModelAttribute
|
tac - Transport area code |
Ves::ObjectClasses::MobileFlow::tac |
tunnelId |
String |
0..1 |
Preliminary OpenModelAttribute
|
tunnelId - Tunnel identifier |
Ves::ObjectClasses::MobileFlow::tunnelId |
vlanId |
String |
0..1 |
Preliminary OpenModelAttribute
|
vlanId - VLAN identifier used by this flow |
Ves::ObjectClasses::MobileFlow::vlanId |
_gtpperflowmetrics |
GtpPerFlowMetrics |
1 |
Preliminary OpenModelAttribute
|
Mobility GTP Protocol per flow metrics |
Ves::ObjectClasses::MobileFlow::_gtpperflowmetrics |
domain |
Domain |
1 |
Experimental OpenModelAttribute
|
Update in definition only Event domain enumeration: ‘cmNotify’,’fault’, ‘heartbeat’, ‘measurement’, ‘mobileFlow’, ‘notification’, ‘other’, ‘pnfRegistration’, ‘sipSignaling’, ‘stateChange’, ‘syslog’, ‘thresholdCrossingAlert’, ‘voiceQuality’ |
Ves::ObjectClasses::VesEvent::domain |
eventType |
String |
0..1 |
Preliminary OpenModelAttribute
|
For example: ‘applicationNf’, ‘guestOS’, ‘hostOS’, ‘platform’ |
Ves::ObjectClasses::VesEvent::eventType |
lastEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
the latest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds |
Ves::ObjectClasses::VesEvent::lastEpochMicrosec |
nfcNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function component type: 3 characters (aligned with vfc naming standards) |
Ves::ObjectClasses::VesEvent::nfcNamingCode |
nfNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function type: 4 characters (aligned with vnf and pnf naming standards) |
Ves::ObjectClasses::VesEvent::nfNamingCode |
nfVendorName |
String |
1 |
Preliminary OpenModelAttribute
|
Network function vendor name |
Ves::ObjectClasses::VesEvent::nfVendorName |
priority |
Priority |
1 |
Preliminary OpenModelAttribute
|
Processing priority enumeration: ‘High’, ‘Medium’, ‘Normal’, ‘Low’ |
Ves::ObjectClasses::VesEvent::priority |
reportingEntityId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See ‘reportingEntityName’ for more information. reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. |
Ves::ObjectClasses::VesEvent::reportingEntityId |
reportingEntityName |
String |
1 |
Preliminary OpenModelAttribute
|
reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. |
Ves::ObjectClasses::VesEvent::reportingEntityName |
sequence |
Integer |
1 |
Preliminary OpenModelAttribute
|
sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ordering of events communicated by an event source instance (or 0 if not needed) |
Ves::ObjectClasses::VesEvent::sequence |
sourceId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See ‘sourceName’ for more information. sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. |
Ves::ObjectClasses::VesEvent::sourceId |
sourceName |
String |
1 |
Preliminary OpenModelAttribute
|
Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. |
Ves::ObjectClasses::VesEvent::sourceName |
startingEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) |
Ves::ObjectClasses::VesEvent::startingEpochMicrosec |
timeZoneOffset |
String |
0..1 |
Preliminary OpenModelAttribute
|
Offset to GMT to indicate local time zone for device formatted as ‘UTC+/-hh:mm’; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples |
Ves::ObjectClasses::VesEvent::timeZoneOffset |
version |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the event header as “#.#” where # is a digit; see section 1 for the correct digits to use. |
Ves::ObjectClasses::VesEvent::version |
vesEventListenerVersion |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the ves event listener api spec that this event is compliant with (as “#” or “#.#” or “#.#.#” where # is a digit; see section 1 for the correct digits to use). |
Ves::ObjectClasses::VesEvent::vesEventListenerVersion |
name |
String |
1 |
Preliminary OpenModelAttribute
|
Ves::ObjectClasses::VesEvent::name |
|
Status |
String |
0..1 |
Preliminary OpenModelAttribute
|
The current condition of an interaction, such as open, in research, closed, and so forth |
Common::Business Interaction::ObjectClasses::BusinessInteraction::Status |
description |
String |
0..1 |
Preliminary OpenModelAttribute
|
Defines a textual free-form description of the object. |
Common::Root::RootObjectClasses::RootEntity::description |
id |
Identifier |
1 |
Preliminary OpenModelAttribute
|
Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. |
Common::Root::RootObjectClasses::RootEntity::id |
NicPerformance
The nicPerformance datatype consists of the following fields which describe the performance and errors of an of an identified virtual network interface card
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
administrativeState |
NicAdminState |
0..1 |
Preliminary OpenModelAttribute
|
Administrative state: enum: ‘inService’, ‘outOfService’ |
Ves::ObjectClasses::NicPerformance::administrativeState |
nicIdentifier |
String |
1 |
Preliminary OpenModelAttribute
|
Network interface card identifier |
Ves::ObjectClasses::NicPerformance::nicIdentifier |
operationalState |
NicOpsState |
0..1 |
Preliminary OpenModelAttribute
|
Operational state: enum: ‘inService’, ‘outOfService’ |
Ves::ObjectClasses::NicPerformance::operationalState |
receivedBroadcastPacketsAccumulated |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Cumulative count of broadcast packets received as read at the end of the measurement interval |
Ves::ObjectClasses::NicPerformance::receivedBroadcastPacketsAccumulated |
receivedBroadcastPacketsDelta |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Count of broadcast packets received within the measurement interval |
Ves::ObjectClasses::NicPerformance::receivedBroadcastPacketsDelta |
receivedDiscardedPacketsAccumulated |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Cumulative count of discarded packets received as read at the end of the measurement interval |
Ves::ObjectClasses::NicPerformance::receivedDiscardedPacketsAccumulated |
receivedDiscardedPacketsDelta |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Count of discarded packets received within the measurement interval |
Ves::ObjectClasses::NicPerformance::receivedDiscardedPacketsDelta |
receivedErrorPacketsAccumulated |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Cumulative count of error packets received as read at the end of the measurement interval |
Ves::ObjectClasses::NicPerformance::receivedErrorPacketsAccumulated |
receivedErrorPacketsDelta |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Count of error packets received within the measurement interval |
Ves::ObjectClasses::NicPerformance::receivedErrorPacketsDelta |
receivedMulticastPacketsAccumulated |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Cumulative count of multicast packets received as read at the end of the measurement interval |
Ves::ObjectClasses::NicPerformance::receivedMulticastPacketsAccumulated |
receivedMulticastPacketsDelta |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Count of multicast packets received within the measurement interval |
Ves::ObjectClasses::NicPerformance::receivedMulticastPacketsDelta |
receivedOctetsAccumulated |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Cumulative count of octets received as read at the end of the measurement interval |
Ves::ObjectClasses::NicPerformance::receivedOctetsAccumulated |
receivedOctetsDelta |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Count of octets received within the measurement interval |
Ves::ObjectClasses::NicPerformance::receivedOctetsDelta |
receivedPercentDiscard |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Percentage of discarded packets received; value = (receivedDiscardedPacketsDelta / receivedTotalPacketsDelta) x 100, if denominator is nonzero, or 0, if otherwise. |
Ves::ObjectClasses::NicPerformance::receivedPercentDiscard |
receivedPercentError |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Percentage of error packets received; value = (receivedErrorPacketsDelta / receivedTotalPacketsDelta) x 100, if denominator is nonzero, or 0, if otherwise. |
Ves::ObjectClasses::NicPerformance::receivedPercentError |
receivedTotalPacketsAccumulated |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Cumulative count of all packets received as read at the end of the measurement interval |
Ves::ObjectClasses::NicPerformance::receivedTotalPacketsAccumulated |
receivedTotalPacketsDelta |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Count of all packets received within the measurement interval |
Ves::ObjectClasses::NicPerformance::receivedTotalPacketsDelta |
receivedUnicastPacketsAccumulated |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Cumulative count of unicast packets received as read at the end of the measurement interval |
Ves::ObjectClasses::NicPerformance::receivedUnicastPacketsAccumulated |
receivedUnicastPacketsDelta |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Count of unicast packets received within the measurement interval |
Ves::ObjectClasses::NicPerformance::receivedUnicastPacketsDelta |
receivedUtilization |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Percentage of utilization received; value = (receivedOctetsDelta / (speed x (lastEpochMicrosec - startEpochMicrosec))) x 100, if denominator is nonzero, or 0, if otherwise. |
Ves::ObjectClasses::NicPerformance::receivedUtilization |
speed |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Speed configured in mbps. |
Ves::ObjectClasses::NicPerformance::speed |
transmittedBroadcastPacketsAccumulated |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Cumulative count of broadcast packets transmitted as read at the end of the measurement interval |
Ves::ObjectClasses::NicPerformance::transmittedBroadcastPacketsAccumulated |
transmittedBroadcastPacketsDelta |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Count of broadcast packets transmitted within the measurement interval |
Ves::ObjectClasses::NicPerformance::transmittedBroadcastPacketsDelta |
transmittedDiscardedPacketsAccumulated |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Cumulative count of discarded packets transmitted as read at the end of the measurement interval |
Ves::ObjectClasses::NicPerformance::transmittedDiscardedPacketsAccumulated |
transmittedDiscardedPacketsDelta |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Count of discarded packets transmitted within the measurement interval |
Ves::ObjectClasses::NicPerformance::transmittedDiscardedPacketsDelta |
transmittedErrorPacketsAccumulated |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Cumulative count of error packets transmitted as read at the end of the measurement interval |
Ves::ObjectClasses::NicPerformance::transmittedErrorPacketsAccumulated |
transmittedErrorPacketsDelta |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Count of error packets transmitted within the measurement interval |
Ves::ObjectClasses::NicPerformance::transmittedErrorPacketsDelta |
transmittedMulticastPacketsAccumulated |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Cumulative count of multicast packets transmitted as read at the end of the measurement interval |
Ves::ObjectClasses::NicPerformance::transmittedMulticastPacketsAccumulated |
transmittedMulticastPacketsDelta |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Count of multicast packets transmitted within the measurement interval |
Ves::ObjectClasses::NicPerformance::transmittedMulticastPacketsDelta |
transmittedOctetsAccumulated |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Cumulative count of octets transmitted as read at the end of the measurement interval |
Ves::ObjectClasses::NicPerformance::transmittedOctetsAccumulated |
transmittedOctetsDelta |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Count of octets transmitted within the measurement interval |
Ves::ObjectClasses::NicPerformance::transmittedOctetsDelta |
transmittedPercentDiscard |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Percentage of discarded packets transmitted; value = (transmittedDiscardedPacketsDelta / transmittedTotalPacketsDelta) x 100, if denominator is nonzero, or 0, if otherwise. |
Ves::ObjectClasses::NicPerformance::transmittedPercentDiscard |
transmittedPercentError |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Percentage of error packets received; value = (transmittedErrorPacketsDelta / transmittedTotalPacketsDelta) x 100, if denominator is nonzero, or 0, if otherwise. |
Ves::ObjectClasses::NicPerformance::transmittedPercentError |
transmittedTotalPacketsAccumulated |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Cumulative count of all packets transmitted as read at the end of the measurement interval |
Ves::ObjectClasses::NicPerformance::transmittedTotalPacketsAccumulated |
transmittedTotalPacketsDelta |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Count of all packets transmitted within the measurement interval |
Ves::ObjectClasses::NicPerformance::transmittedTotalPacketsDelta |
transmittedUnicastPacketsAccumulated |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Cumulative count of unicast packets transmitted as read at the end of the measurement interval |
Ves::ObjectClasses::NicPerformance::transmittedUnicastPacketsAccumulated |
transmittedUnicastPacketsDelta |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Count of unicast packets transmitted within the measurement interval |
Ves::ObjectClasses::NicPerformance::transmittedUnicastPacketsDelta |
transmittedUtilization |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Percentage of utilization transmitted; value = (transmittedOctetsDelta / (speed x (lastEpochMicrosec - startEpochMicrosec))) x 100, if denominator is nonzero, or 0, if otherwise. |
Ves::ObjectClasses::NicPerformance::transmittedUtilization |
valuesAreSuspect |
Boolean |
1 |
Preliminary OpenModelAttribute
|
Enumeration: ‘true’ or ‘false’. If ‘true’ then the vNicPerformance values are likely inaccurate due to counter overflow or other conditions. |
Ves::ObjectClasses::NicPerformance::valuesAreSuspect |
VES Class Definition - part 2
Notification
Fields specific to notification events
Parent class: VesEvent
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
additionalFields |
HashMap |
0..1 |
Preliminary OpenModelAttribute
|
Additional notification fields if needed. |
Ves::ObjectClasses::Notification::additionalFields |
arrayOfNamedHashMap |
NamedHashMap |
0..1 |
Preliminary OpenModelAttribute
|
arrayOfNamedHashMap - Array of named hashMaps |
Ves::ObjectClasses::Notification::arrayOfNamedHashMap |
changeContact |
String |
0..1 |
Preliminary OpenModelAttribute
|
Identifier for a contact related to the change. |
Ves::ObjectClasses::Notification::changeContact |
changeIdentifier |
String |
1 |
Preliminary OpenModelAttribute
|
System or session identifier associated with the change. |
Ves::ObjectClasses::Notification::changeIdentifier |
changeType |
String |
1 |
Preliminary OpenModelAttribute
|
Describes what has changed for the entity, for example: configuration changed, capability added, capability removed… |
Ves::ObjectClasses::Notification::changeType |
newState |
String |
0..1 |
Preliminary OpenModelAttribute
|
New state of the entity, for example: ‘inService’, ‘maintenance’, ‘outOfService’ |
Ves::ObjectClasses::Notification::newState |
notificationFieldsVersion |
Number |
1 |
Preliminary OpenModelAttribute
|
Version of the notificationFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. |
Ves::ObjectClasses::Notification::notificationFieldsVersion |
oldState |
String |
0..1 |
Preliminary OpenModelAttribute
|
Previous state of the entity. For example: “inService”, “outOfService”, “maintenance” |
Ves::ObjectClasses::Notification::oldState |
stateInterface |
String |
0..* |
Preliminary OpenModelAttribute
|
Card or port name of the entity that changed state. |
Ves::ObjectClasses::Notification::stateInterface |
domain |
Domain |
1 |
Experimental OpenModelAttribute
|
Update in definition only Event domain enumeration: ‘cmNotify’,’fault’, ‘heartbeat’, ‘measurement’, ‘mobileFlow’, ‘notification’, ‘other’, ‘pnfRegistration’, ‘sipSignaling’, ‘stateChange’, ‘syslog’, ‘thresholdCrossingAlert’, ‘voiceQuality’ |
Ves::ObjectClasses::VesEvent::domain |
eventType |
String |
0..1 |
Preliminary OpenModelAttribute
|
For example: ‘applicationNf’, ‘guestOS’, ‘hostOS’, ‘platform’ |
Ves::ObjectClasses::VesEvent::eventType |
lastEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
the latest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds |
Ves::ObjectClasses::VesEvent::lastEpochMicrosec |
nfcNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function component type: 3 characters (aligned with vfc naming standards) |
Ves::ObjectClasses::VesEvent::nfcNamingCode |
nfNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function type: 4 characters (aligned with vnf and pnf naming standards) |
Ves::ObjectClasses::VesEvent::nfNamingCode |
nfVendorName |
String |
1 |
Preliminary OpenModelAttribute
|
Network function vendor name |
Ves::ObjectClasses::VesEvent::nfVendorName |
priority |
Priority |
1 |
Preliminary OpenModelAttribute
|
Processing priority enumeration: ‘High’, ‘Medium’, ‘Normal’, ‘Low’ |
Ves::ObjectClasses::VesEvent::priority |
reportingEntityId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See ‘reportingEntityName’ for more information. reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. |
Ves::ObjectClasses::VesEvent::reportingEntityId |
reportingEntityName |
String |
1 |
Preliminary OpenModelAttribute
|
reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. |
Ves::ObjectClasses::VesEvent::reportingEntityName |
sequence |
Integer |
1 |
Preliminary OpenModelAttribute
|
sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ordering of events communicated by an event source instance (or 0 if not needed) |
Ves::ObjectClasses::VesEvent::sequence |
sourceId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See ‘sourceName’ for more information. sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. |
Ves::ObjectClasses::VesEvent::sourceId |
sourceName |
String |
1 |
Preliminary OpenModelAttribute
|
Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. |
Ves::ObjectClasses::VesEvent::sourceName |
startingEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) |
Ves::ObjectClasses::VesEvent::startingEpochMicrosec |
timeZoneOffset |
String |
0..1 |
Preliminary OpenModelAttribute
|
Offset to GMT to indicate local time zone for device formatted as ‘UTC+/-hh:mm’; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples |
Ves::ObjectClasses::VesEvent::timeZoneOffset |
version |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the event header as “#.#” where # is a digit; see section 1 for the correct digits to use. |
Ves::ObjectClasses::VesEvent::version |
vesEventListenerVersion |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the ves event listener api spec that this event is compliant with (as “#” or “#.#” or “#.#.#” where # is a digit; see section 1 for the correct digits to use). |
Ves::ObjectClasses::VesEvent::vesEventListenerVersion |
name |
String |
1 |
Preliminary OpenModelAttribute
|
Ves::ObjectClasses::VesEvent::name |
|
Status |
String |
0..1 |
Preliminary OpenModelAttribute
|
The current condition of an interaction, such as open, in research, closed, and so forth |
Common::Business Interaction::ObjectClasses::BusinessInteraction::Status |
description |
String |
0..1 |
Preliminary OpenModelAttribute
|
Defines a textual free-form description of the object. |
Common::Root::RootObjectClasses::RootEntity::description |
id |
Identifier |
1 |
Preliminary OpenModelAttribute
|
Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. |
Common::Root::RootObjectClasses::RootEntity::id |
Other
The otherFields datatype defines fields for events belonging to the ‘other’ domain of the commonEventHeader domain enumeration.
Parent class: VesEvent
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
arrayofNamedHashMap |
ArrayofNamedHashMap |
0..* |
Preliminary OpenModelAttribute
|
Array of named hashMaps |
Ves::ObjectClasses::Other::arrayofNamedHashMap |
hashMap |
HashMap |
0..1 |
Preliminary OpenModelAttribute
|
Array of name-value pairs. |
Ves::ObjectClasses::Other::hashMap |
schemaObjects |
ArrayOfSchemaObject |
0..1 |
Preliminary OpenModelAttribute
|
Array of schema objects described by name, schema and other meta-information. |
Ves::ObjectClasses::Other::schemaObjects |
otherFieldsVersion |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the otherFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. |
Ves::ObjectClasses::Other::otherFieldsVersion |
domain |
Domain |
1 |
Experimental OpenModelAttribute
|
Update in definition only Event domain enumeration: ‘cmNotify’,’fault’, ‘heartbeat’, ‘measurement’, ‘mobileFlow’, ‘notification’, ‘other’, ‘pnfRegistration’, ‘sipSignaling’, ‘stateChange’, ‘syslog’, ‘thresholdCrossingAlert’, ‘voiceQuality’ |
Ves::ObjectClasses::VesEvent::domain |
eventType |
String |
0..1 |
Preliminary OpenModelAttribute
|
For example: ‘applicationNf’, ‘guestOS’, ‘hostOS’, ‘platform’ |
Ves::ObjectClasses::VesEvent::eventType |
lastEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
the latest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds |
Ves::ObjectClasses::VesEvent::lastEpochMicrosec |
nfcNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function component type: 3 characters (aligned with vfc naming standards) |
Ves::ObjectClasses::VesEvent::nfcNamingCode |
nfNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function type: 4 characters (aligned with vnf and pnf naming standards) |
Ves::ObjectClasses::VesEvent::nfNamingCode |
nfVendorName |
String |
1 |
Preliminary OpenModelAttribute
|
Network function vendor name |
Ves::ObjectClasses::VesEvent::nfVendorName |
priority |
Priority |
1 |
Preliminary OpenModelAttribute
|
Processing priority enumeration: ‘High’, ‘Medium’, ‘Normal’, ‘Low’ |
Ves::ObjectClasses::VesEvent::priority |
reportingEntityId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See ‘reportingEntityName’ for more information. reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. |
Ves::ObjectClasses::VesEvent::reportingEntityId |
reportingEntityName |
String |
1 |
Preliminary OpenModelAttribute
|
reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. |
Ves::ObjectClasses::VesEvent::reportingEntityName |
sequence |
Integer |
1 |
Preliminary OpenModelAttribute
|
sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ordering of events communicated by an event source instance (or 0 if not needed) |
Ves::ObjectClasses::VesEvent::sequence |
sourceId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See ‘sourceName’ for more information. sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. |
Ves::ObjectClasses::VesEvent::sourceId |
sourceName |
String |
1 |
Preliminary OpenModelAttribute
|
Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. |
Ves::ObjectClasses::VesEvent::sourceName |
startingEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) |
Ves::ObjectClasses::VesEvent::startingEpochMicrosec |
timeZoneOffset |
String |
0..1 |
Preliminary OpenModelAttribute
|
Offset to GMT to indicate local time zone for device formatted as ‘UTC+/-hh:mm’; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples |
Ves::ObjectClasses::VesEvent::timeZoneOffset |
version |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the event header as “#.#” where # is a digit; see section 1 for the correct digits to use. |
Ves::ObjectClasses::VesEvent::version |
vesEventListenerVersion |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the ves event listener api spec that this event is compliant with (as “#” or “#.#” or “#.#.#” where # is a digit; see section 1 for the correct digits to use). |
Ves::ObjectClasses::VesEvent::vesEventListenerVersion |
name |
String |
1 |
Preliminary OpenModelAttribute
|
Ves::ObjectClasses::VesEvent::name |
|
Status |
String |
0..1 |
Preliminary OpenModelAttribute
|
The current condition of an interaction, such as open, in research, closed, and so forth |
Common::Business Interaction::ObjectClasses::BusinessInteraction::Status |
description |
String |
0..1 |
Preliminary OpenModelAttribute
|
Defines a textual free-form description of the object. |
Common::Root::RootObjectClasses::RootEntity::description |
id |
Identifier |
1 |
Preliminary OpenModelAttribute
|
Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. |
Common::Root::RootObjectClasses::RootEntity::id |
Perf3gpp
Parent class: VesEvent
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
eventAddlFields |
HashMap |
0..1 |
Preliminary OpenModelAttribute
|
Additional key-value pairs if needed |
Ves::ObjectClasses::Perf3gpp::eventAddlFields |
perf3gppFieldsVersion |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the perf3gpp event |
Ves::ObjectClasses::Perf3gpp::perf3gppFieldsVersion |
_measDataCollection |
MeasDataCollection |
1 |
Preliminary OpenModelAttribute
|
3GPP measurement collection structure |
Ves::ObjectClasses::Perf3gpp::_measDataCollection |
domain |
Domain |
1 |
Experimental OpenModelAttribute
|
Update in definition only Event domain enumeration: ‘cmNotify’,’fault’, ‘heartbeat’, ‘measurement’, ‘mobileFlow’, ‘notification’, ‘other’, ‘pnfRegistration’, ‘sipSignaling’, ‘stateChange’, ‘syslog’, ‘thresholdCrossingAlert’, ‘voiceQuality’ |
Ves::ObjectClasses::VesEvent::domain |
eventType |
String |
0..1 |
Preliminary OpenModelAttribute
|
For example: ‘applicationNf’, ‘guestOS’, ‘hostOS’, ‘platform’ |
Ves::ObjectClasses::VesEvent::eventType |
lastEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
the latest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds |
Ves::ObjectClasses::VesEvent::lastEpochMicrosec |
nfcNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function component type: 3 characters (aligned with vfc naming standards) |
Ves::ObjectClasses::VesEvent::nfcNamingCode |
nfNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function type: 4 characters (aligned with vnf and pnf naming standards) |
Ves::ObjectClasses::VesEvent::nfNamingCode |
nfVendorName |
String |
1 |
Preliminary OpenModelAttribute
|
Network function vendor name |
Ves::ObjectClasses::VesEvent::nfVendorName |
priority |
Priority |
1 |
Preliminary OpenModelAttribute
|
Processing priority enumeration: ‘High’, ‘Medium’, ‘Normal’, ‘Low’ |
Ves::ObjectClasses::VesEvent::priority |
reportingEntityId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See ‘reportingEntityName’ for more information. reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. |
Ves::ObjectClasses::VesEvent::reportingEntityId |
reportingEntityName |
String |
1 |
Preliminary OpenModelAttribute
|
reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. |
Ves::ObjectClasses::VesEvent::reportingEntityName |
sequence |
Integer |
1 |
Preliminary OpenModelAttribute
|
sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ordering of events communicated by an event source instance (or 0 if not needed) |
Ves::ObjectClasses::VesEvent::sequence |
sourceId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See ‘sourceName’ for more information. sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. |
Ves::ObjectClasses::VesEvent::sourceId |
sourceName |
String |
1 |
Preliminary OpenModelAttribute
|
Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. |
Ves::ObjectClasses::VesEvent::sourceName |
startingEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) |
Ves::ObjectClasses::VesEvent::startingEpochMicrosec |
timeZoneOffset |
String |
0..1 |
Preliminary OpenModelAttribute
|
Offset to GMT to indicate local time zone for device formatted as ‘UTC+/-hh:mm’; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples |
Ves::ObjectClasses::VesEvent::timeZoneOffset |
version |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the event header as “#.#” where # is a digit; see section 1 for the correct digits to use. |
Ves::ObjectClasses::VesEvent::version |
vesEventListenerVersion |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the ves event listener api spec that this event is compliant with (as “#” or “#.#” or “#.#.#” where # is a digit; see section 1 for the correct digits to use). |
Ves::ObjectClasses::VesEvent::vesEventListenerVersion |
name |
String |
1 |
Preliminary OpenModelAttribute
|
Ves::ObjectClasses::VesEvent::name |
|
Status |
String |
0..1 |
Preliminary OpenModelAttribute
|
The current condition of an interaction, such as open, in research, closed, and so forth |
Common::Business Interaction::ObjectClasses::BusinessInteraction::Status |
description |
String |
0..1 |
Preliminary OpenModelAttribute
|
Defines a textual free-form description of the object. |
Common::Root::RootObjectClasses::RootEntity::description |
id |
Identifier |
1 |
Preliminary OpenModelAttribute
|
Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. |
Common::Root::RootObjectClasses::RootEntity::id |
PnfRegistration
The pnfRegistrationFields datatype defines fields for events belonging to the ‘pnfRegistration’ domain of the commonEventHeader domain enumeration; it consists of the following fields:
Parent class: VesEvent
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
additionalFields |
HashMap |
0..1 |
Preliminary OpenModelAttribute
|
Additional pnfRegistration fields if needed |
Ves::ObjectClasses::PnfRegistration::additionalFields |
lastServiceDate |
String |
0..1 |
Preliminary OpenModelAttribute
|
TS 32.692 dateOfLastService = date of last service; e.g. 15022017 |
Ves::ObjectClasses::PnfRegistration::lastServiceDate |
macAddress |
String |
0..1 |
Preliminary OpenModelAttribute
|
MAC address of OAM interface of the unit |
Ves::ObjectClasses::PnfRegistration::macAddress |
manufactureDate |
String |
0..1 |
Preliminary OpenModelAttribute
|
TS 32.692 dateOfManufacture = manufacture date of the unit; 24032016 |
Ves::ObjectClasses::PnfRegistration::manufactureDate |
modelNumber |
String |
0..1 |
Preliminary OpenModelAttribute
|
TS 32.692 versionNumber = version of the unit from vendor; e.g. AJ02. Maps to AAI equip-model |
Ves::ObjectClasses::PnfRegistration::modelNumber |
oamV4lpAddress |
String |
0..1 |
Preliminary OpenModelAttribute
|
IPv4 m-plane IP address to be used by the manager to contact the PNF |
Ves::ObjectClasses::PnfRegistration::oamV4lpAddress |
oamV6lpAddress |
String |
0..1 |
Preliminary OpenModelAttribute
|
IPv6 m-plane IP address to be used by the manager to contact the PNF |
Ves::ObjectClasses::PnfRegistration::oamV6lpAddress |
pnfRegistrationFieldsVersion |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the registrationFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. |
Ves::ObjectClasses::PnfRegistration::pnfRegistrationFieldsVersion |
serialNumber |
String |
0..1 |
Preliminary OpenModelAttribute
|
TS 32.692 serialNumber = serial number of the unit; e.g. 6061ZW3 |
Ves::ObjectClasses::PnfRegistration::serialNumber |
softwareVersion |
String |
0..1 |
Preliminary OpenModelAttribute
|
TS 32.692 swName = active SW running on the unit; e.g. 5gDUv18.05.201 |
Ves::ObjectClasses::PnfRegistration::softwareVersion |
unitFamily |
String |
0..1 |
Preliminary OpenModelAttribute
|
TS 32.692 vendorUnitFamilyType = general type of HW unit; e.g. BBU |
Ves::ObjectClasses::PnfRegistration::unitFamily |
unitType |
String |
0..1 |
Preliminary OpenModelAttribute
|
TS 32.692 vendorUnitTypeNumber = vendor name for the unit; e.g. Airscale |
Ves::ObjectClasses::PnfRegistration::unitType |
vendorName |
String |
0..1 |
Preliminary OpenModelAttribute
|
TS 32.692 vendorName = name of manufacturer; e.g. Nokia. Maps to AAI equip-vendor |
Ves::ObjectClasses::PnfRegistration::vendorName |
domain |
Domain |
1 |
Experimental OpenModelAttribute
|
Update in definition only Event domain enumeration: ‘cmNotify’,’fault’, ‘heartbeat’, ‘measurement’, ‘mobileFlow’, ‘notification’, ‘other’, ‘pnfRegistration’, ‘sipSignaling’, ‘stateChange’, ‘syslog’, ‘thresholdCrossingAlert’, ‘voiceQuality’ |
Ves::ObjectClasses::VesEvent::domain |
eventType |
String |
0..1 |
Preliminary OpenModelAttribute
|
For example: ‘applicationNf’, ‘guestOS’, ‘hostOS’, ‘platform’ |
Ves::ObjectClasses::VesEvent::eventType |
lastEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
the latest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds |
Ves::ObjectClasses::VesEvent::lastEpochMicrosec |
nfcNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function component type: 3 characters (aligned with vfc naming standards) |
Ves::ObjectClasses::VesEvent::nfcNamingCode |
nfNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function type: 4 characters (aligned with vnf and pnf naming standards) |
Ves::ObjectClasses::VesEvent::nfNamingCode |
nfVendorName |
String |
1 |
Preliminary OpenModelAttribute
|
Network function vendor name |
Ves::ObjectClasses::VesEvent::nfVendorName |
priority |
Priority |
1 |
Preliminary OpenModelAttribute
|
Processing priority enumeration: ‘High’, ‘Medium’, ‘Normal’, ‘Low’ |
Ves::ObjectClasses::VesEvent::priority |
reportingEntityId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See ‘reportingEntityName’ for more information. reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. |
Ves::ObjectClasses::VesEvent::reportingEntityId |
reportingEntityName |
String |
1 |
Preliminary OpenModelAttribute
|
reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. |
Ves::ObjectClasses::VesEvent::reportingEntityName |
sequence |
Integer |
1 |
Preliminary OpenModelAttribute
|
sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ordering of events communicated by an event source instance (or 0 if not needed) |
Ves::ObjectClasses::VesEvent::sequence |
sourceId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See ‘sourceName’ for more information. sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. |
Ves::ObjectClasses::VesEvent::sourceId |
sourceName |
String |
1 |
Preliminary OpenModelAttribute
|
Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. |
Ves::ObjectClasses::VesEvent::sourceName |
startingEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) |
Ves::ObjectClasses::VesEvent::startingEpochMicrosec |
timeZoneOffset |
String |
0..1 |
Preliminary OpenModelAttribute
|
Offset to GMT to indicate local time zone for device formatted as ‘UTC+/-hh:mm’; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples |
Ves::ObjectClasses::VesEvent::timeZoneOffset |
version |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the event header as “#.#” where # is a digit; see section 1 for the correct digits to use. |
Ves::ObjectClasses::VesEvent::version |
vesEventListenerVersion |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the ves event listener api spec that this event is compliant with (as “#” or “#.#” or “#.#.#” where # is a digit; see section 1 for the correct digits to use). |
Ves::ObjectClasses::VesEvent::vesEventListenerVersion |
name |
String |
1 |
Preliminary OpenModelAttribute
|
Ves::ObjectClasses::VesEvent::name |
|
Status |
String |
0..1 |
Preliminary OpenModelAttribute
|
The current condition of an interaction, such as open, in research, closed, and so forth |
Common::Business Interaction::ObjectClasses::BusinessInteraction::Status |
description |
String |
0..1 |
Preliminary OpenModelAttribute
|
Defines a textual free-form description of the object. |
Common::Root::RootObjectClasses::RootEntity::description |
id |
Identifier |
1 |
Preliminary OpenModelAttribute
|
Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. |
Common::Root::RootObjectClasses::RootEntity::id |
ProcessStats
The processStats datatype provides metrics on system processes; it consists of the following fields:
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
forkRate |
Number |
0..1 |
Preliminary OpenModelAttribute
|
The number of threads created since the last reboot |
Ves::ObjectClasses::ProcessStats::forkRate |
processIdentifier |
String |
1 |
Preliminary OpenModelAttribute
|
processIdentifier |
Ves::ObjectClasses::ProcessStats::processIdentifier |
psStateBlocked |
Number |
0..1 |
Preliminary OpenModelAttribute
|
The number of processes in a blocked state |
Ves::ObjectClasses::ProcessStats::psStateBlocked |
psStatePaging |
Number |
0..1 |
Preliminary OpenModelAttribute
|
The number of processes in a paging state |
Ves::ObjectClasses::ProcessStats::psStatePaging |
psStateRunning |
Number |
0..1 |
Preliminary OpenModelAttribute
|
The number of processes in a running state |
Ves::ObjectClasses::ProcessStats::psStateRunning |
psStateSleeping |
Number |
0..1 |
Preliminary OpenModelAttribute
|
The number of processes in a sleeping state |
Ves::ObjectClasses::ProcessStats::psStateSleeping |
PsStateStopped |
Number |
0..1 |
Preliminary OpenModelAttribute
|
The number of processes in a stopped state |
Ves::ObjectClasses::ProcessStats::PsStateStopped |
psStateZombie |
Number |
0..1 |
Preliminary OpenModelAttribute
|
The number of processes in a zombie state |
Ves::ObjectClasses::ProcessStats::psStateZombie |
ProcessorDimmAggregateThermalMargin
The processorDimmAggregateThermalMargin datatype provides intelligent platform management interface (ipmi) processor dual inline memory module aggregate thermal margin metrics; it consists of the following fields:
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
processorDimmAggregateThermal MarginIdentifier |
String |
1 |
Preliminary OpenModelAttribute
|
identifier for the aggregate thermal margin metrics from the processor dual inline memory module |
Ves::ObjectClasses::ProcessorDimmAggregateThermalMargin::processorDimmAggregateThermal MarginIdentifier |
thermalMargin |
Number |
1 |
Preliminary OpenModelAttribute
|
the difference between the DIMM’s current temperature, in celsius, and the DIMM’s throttling thermal trip point |
Ves::ObjectClasses::ProcessorDimmAggregateThermalMargin::thermalMargin |
SipSignaling
sipSignalingFields - The sipSignalingFields datatype communicates information about SIP signaling messages, parameters and signaling state.
Parent class: VesEvent
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
additionalInformation |
HashMap |
0..1 |
Preliminary OpenModelAttribute
|
zdditionalInformation - Additional sipSignalling fields. |
Ves::ObjectClasses::SipSignaling::additionalInformation |
compressedSip |
String |
0..1 |
Preliminary OpenModelAttribute
|
compressedSip - The full SIP request/response including headers and bodies. |
Ves::ObjectClasses::SipSignaling::compressedSip |
correlator |
String |
1 |
Preliminary OpenModelAttribute
|
correlator - Constant across all events on this call. |
Ves::ObjectClasses::SipSignaling::correlator |
localipAddress |
String |
1 |
Preliminary OpenModelAttribute
|
localIpAddress - IP address on VNF. Note: current data type (String) may be changed to Common Resource Datatype L3AddressData. =[gh]= |
Ves::ObjectClasses::SipSignaling::localipAddress |
localPort |
String |
1 |
Preliminary OpenModelAttribute
|
localPort - Port on VNF. |
Ves::ObjectClasses::SipSignaling::localPort |
remoteipAddress |
String |
1 |
Preliminary OpenModelAttribute
|
remoteIpAddress - IP address of peer endpoint. Note: current data type (String) may be changed to Common Resource Datatype L3AddressData. =[gh]= |
Ves::ObjectClasses::SipSignaling::remoteipAddress |
remotePort |
String |
1 |
Preliminary OpenModelAttribute
|
remotePort - Port of peer endpoint |
Ves::ObjectClasses::SipSignaling::remotePort |
sipSignaliingFieldsVersion |
String |
1 |
Preliminary OpenModelAttribute
|
sipSignalingFieldsVersion - Version of the sipSignalingFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. |
Ves::ObjectClasses::SipSignaling::sipSignaliingFieldsVersion |
summarySip |
String |
0..1 |
Preliminary OpenModelAttribute
|
summarySip - The SIP Method or Response (‘INVITE’, ‘200 OK’, ‘BYE’, etc). |
Ves::ObjectClasses::SipSignaling::summarySip |
_vendorNfnamefields |
VendorNfNameFields |
1 |
Preliminary OpenModelAttribute
|
Vendor, NF and nfModule names |
Ves::ObjectClasses::SipSignaling::_vendorNfnamefields |
domain |
Domain |
1 |
Experimental OpenModelAttribute
|
Update in definition only Event domain enumeration: ‘cmNotify’,’fault’, ‘heartbeat’, ‘measurement’, ‘mobileFlow’, ‘notification’, ‘other’, ‘pnfRegistration’, ‘sipSignaling’, ‘stateChange’, ‘syslog’, ‘thresholdCrossingAlert’, ‘voiceQuality’ |
Ves::ObjectClasses::VesEvent::domain |
eventType |
String |
0..1 |
Preliminary OpenModelAttribute
|
For example: ‘applicationNf’, ‘guestOS’, ‘hostOS’, ‘platform’ |
Ves::ObjectClasses::VesEvent::eventType |
lastEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
the latest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds |
Ves::ObjectClasses::VesEvent::lastEpochMicrosec |
nfcNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function component type: 3 characters (aligned with vfc naming standards) |
Ves::ObjectClasses::VesEvent::nfcNamingCode |
nfNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function type: 4 characters (aligned with vnf and pnf naming standards) |
Ves::ObjectClasses::VesEvent::nfNamingCode |
nfVendorName |
String |
1 |
Preliminary OpenModelAttribute
|
Network function vendor name |
Ves::ObjectClasses::VesEvent::nfVendorName |
priority |
Priority |
1 |
Preliminary OpenModelAttribute
|
Processing priority enumeration: ‘High’, ‘Medium’, ‘Normal’, ‘Low’ |
Ves::ObjectClasses::VesEvent::priority |
reportingEntityId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See ‘reportingEntityName’ for more information. reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. |
Ves::ObjectClasses::VesEvent::reportingEntityId |
reportingEntityName |
String |
1 |
Preliminary OpenModelAttribute
|
reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. |
Ves::ObjectClasses::VesEvent::reportingEntityName |
sequence |
Integer |
1 |
Preliminary OpenModelAttribute
|
sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ordering of events communicated by an event source instance (or 0 if not needed) |
Ves::ObjectClasses::VesEvent::sequence |
sourceId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See ‘sourceName’ for more information. sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. |
Ves::ObjectClasses::VesEvent::sourceId |
sourceName |
String |
1 |
Preliminary OpenModelAttribute
|
Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. |
Ves::ObjectClasses::VesEvent::sourceName |
startingEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) |
Ves::ObjectClasses::VesEvent::startingEpochMicrosec |
timeZoneOffset |
String |
0..1 |
Preliminary OpenModelAttribute
|
Offset to GMT to indicate local time zone for device formatted as ‘UTC+/-hh:mm’; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples |
Ves::ObjectClasses::VesEvent::timeZoneOffset |
version |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the event header as “#.#” where # is a digit; see section 1 for the correct digits to use. |
Ves::ObjectClasses::VesEvent::version |
vesEventListenerVersion |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the ves event listener api spec that this event is compliant with (as “#” or “#.#” or “#.#.#” where # is a digit; see section 1 for the correct digits to use). |
Ves::ObjectClasses::VesEvent::vesEventListenerVersion |
name |
String |
1 |
Preliminary OpenModelAttribute
|
Ves::ObjectClasses::VesEvent::name |
|
Status |
String |
0..1 |
Preliminary OpenModelAttribute
|
The current condition of an interaction, such as open, in research, closed, and so forth |
Common::Business Interaction::ObjectClasses::BusinessInteraction::Status |
description |
String |
0..1 |
Preliminary OpenModelAttribute
|
Defines a textual free-form description of the object. |
Common::Root::RootObjectClasses::RootEntity::description |
id |
Identifier |
1 |
Preliminary OpenModelAttribute
|
Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. |
Common::Root::RootObjectClasses::RootEntity::id |
StateChange
Fields specific to state change events.
Parent class: VesEvent
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
additionalFields |
HashMap |
0..1 |
Preliminary OpenModelAttribute
|
Additional stateChange fields if needed |
Ves::ObjectClasses::StateChange::additionalFields |
newState |
invalid |
1 |
Preliminary OpenModelAttribute
|
New state of the entity: ‘inService’, ‘maintenance’, ‘outOfService’ |
Ves::ObjectClasses::StateChange::newState |
OldState |
invalid |
1 |
Preliminary OpenModelAttribute
|
Previous state of the entity: ‘inService’, ‘maintenance’, ‘outOfService’ |
Ves::ObjectClasses::StateChange::OldState |
stateChangeFieldsVersion |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the stateChangeFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. |
Ves::ObjectClasses::StateChange::stateChangeFieldsVersion |
stateInterface |
String |
1 |
Preliminary OpenModelAttribute
|
Card or port name of the entity that changed state |
Ves::ObjectClasses::StateChange::stateInterface |
domain |
Domain |
1 |
Experimental OpenModelAttribute
|
Update in definition only Event domain enumeration: ‘cmNotify’,’fault’, ‘heartbeat’, ‘measurement’, ‘mobileFlow’, ‘notification’, ‘other’, ‘pnfRegistration’, ‘sipSignaling’, ‘stateChange’, ‘syslog’, ‘thresholdCrossingAlert’, ‘voiceQuality’ |
Ves::ObjectClasses::VesEvent::domain |
eventType |
String |
0..1 |
Preliminary OpenModelAttribute
|
For example: ‘applicationNf’, ‘guestOS’, ‘hostOS’, ‘platform’ |
Ves::ObjectClasses::VesEvent::eventType |
lastEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
the latest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds |
Ves::ObjectClasses::VesEvent::lastEpochMicrosec |
nfcNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function component type: 3 characters (aligned with vfc naming standards) |
Ves::ObjectClasses::VesEvent::nfcNamingCode |
nfNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function type: 4 characters (aligned with vnf and pnf naming standards) |
Ves::ObjectClasses::VesEvent::nfNamingCode |
nfVendorName |
String |
1 |
Preliminary OpenModelAttribute
|
Network function vendor name |
Ves::ObjectClasses::VesEvent::nfVendorName |
priority |
Priority |
1 |
Preliminary OpenModelAttribute
|
Processing priority enumeration: ‘High’, ‘Medium’, ‘Normal’, ‘Low’ |
Ves::ObjectClasses::VesEvent::priority |
reportingEntityId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See ‘reportingEntityName’ for more information. reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. |
Ves::ObjectClasses::VesEvent::reportingEntityId |
reportingEntityName |
String |
1 |
Preliminary OpenModelAttribute
|
reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. |
Ves::ObjectClasses::VesEvent::reportingEntityName |
sequence |
Integer |
1 |
Preliminary OpenModelAttribute
|
sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ordering of events communicated by an event source instance (or 0 if not needed) |
Ves::ObjectClasses::VesEvent::sequence |
sourceId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See ‘sourceName’ for more information. sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. |
Ves::ObjectClasses::VesEvent::sourceId |
sourceName |
String |
1 |
Preliminary OpenModelAttribute
|
Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. |
Ves::ObjectClasses::VesEvent::sourceName |
startingEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) |
Ves::ObjectClasses::VesEvent::startingEpochMicrosec |
timeZoneOffset |
String |
0..1 |
Preliminary OpenModelAttribute
|
Offset to GMT to indicate local time zone for device formatted as ‘UTC+/-hh:mm’; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples |
Ves::ObjectClasses::VesEvent::timeZoneOffset |
version |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the event header as “#.#” where # is a digit; see section 1 for the correct digits to use. |
Ves::ObjectClasses::VesEvent::version |
vesEventListenerVersion |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the ves event listener api spec that this event is compliant with (as “#” or “#.#” or “#.#.#” where # is a digit; see section 1 for the correct digits to use). |
Ves::ObjectClasses::VesEvent::vesEventListenerVersion |
name |
String |
1 |
Preliminary OpenModelAttribute
|
Ves::ObjectClasses::VesEvent::name |
|
Status |
String |
0..1 |
Preliminary OpenModelAttribute
|
The current condition of an interaction, such as open, in research, closed, and so forth |
Common::Business Interaction::ObjectClasses::BusinessInteraction::Status |
description |
String |
0..1 |
Preliminary OpenModelAttribute
|
Defines a textual free-form description of the object. |
Common::Root::RootObjectClasses::RootEntity::description |
id |
Identifier |
1 |
Preliminary OpenModelAttribute
|
Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. |
Common::Root::RootObjectClasses::RootEntity::id |
StndDefined
Parent class: VesEvent
Applied stereotypes:
OpenModelClass
support: MANDATORY
Syslog
Syslog’s can be classified as either Control or Session/Traffic. They differ by message content and expected volume: ? Control logs are generally free-form human-readable text used for reporting errors or warnings supporting the operation and troubleshooting of NFs. The volume of these logs is typically less than 2k per day. ? Session logs use common structured fields to report normal NF processing such as DNS lookups or firewall rules processed. The volume of these logs is typically greater than 1k per hour (and sometimes as high as 10k per second). VES supports both classes of syslog, however VES is only recommended for control logs or for lower volume session logs, less than 60k per hour. High volume session logging should use a file-based transport solution.
Parent class: VesEvent
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
additionalFields |
HashMap |
0..* |
Preliminary OpenModelAttribute
|
Additional syslog fields if needed Ex: {“name1”: “value1”, “name2: “value2” … } |
Ves::ObjectClasses::Syslog::additionalFields |
eventSourceHost |
String |
0..1 |
Preliminary OpenModelAttribute
|
Hostname of the device |
Ves::ObjectClasses::Syslog::eventSourceHost |
eventSourceType |
String |
1 |
Preliminary OpenModelAttribute
|
Examples: ‘other’, ‘router’, ‘switch’, ‘host’, ‘card’, ‘port’, ‘slotThreshold’, ‘portThreshold’, ‘virtualMachine’, ‘virtualNetworkFunction’ |
Ves::ObjectClasses::Syslog::eventSourceType |
syslogSdId |
String |
0..1 |
Preliminary OpenModelAttribute
|
0-32 char in format name@number, i.e., ourSDID@32473 |
Ves::ObjectClasses::Syslog::syslogSdId |
syslogFacilty |
SyslogFacility |
0..1 |
Preliminary OpenModelAttribute
|
Numeric code from 0 to 23 for facility: 0 kernel messages 1 user-level messages 2 mail system 3 system daemons 4 security/authorization messages 5 messages generated internally by syslogd 6 line printer subsystem 7 network news subsystem 8 UUCP subsystem 9 clock daemon 10 security/authorization messages 11 FTP daemon 12 NTP subsystem 13 log audit 14 log alert 15 clock daemon (note 2) 16 local use 0 (local0) 17 local use 1 (local1) 18 local use 2 (local2) 19 local use 3 (local3) 20 local use 4 (local4) 21 local use 5 (local5) 22 local use 6 (local6) 23 local use 7 (local7 ) |
Ves::ObjectClasses::Syslog::syslogFacilty |
syslogFieldVersion |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the syslogFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. |
Ves::ObjectClasses::Syslog::syslogFieldVersion |
syslogMsg |
String |
1 |
Preliminary OpenModelAttribute
|
Syslog message |
Ves::ObjectClasses::Syslog::syslogMsg |
syslogMsgHost |
String |
0..1 |
Preliminary OpenModelAttribute
|
Hostname parsed from non-VES syslog message |
Ves::ObjectClasses::Syslog::syslogMsgHost |
syslogPri |
Integer |
0..1 |
Preliminary OpenModelAttribute
|
0-192 Combined Severity and Facility (see rfc5424) |
Ves::ObjectClasses::Syslog::syslogPri |
syslogProc |
String |
0..1 |
Preliminary OpenModelAttribute
|
Identifies the application that originated the message |
Ves::ObjectClasses::Syslog::syslogProc |
syslogProcId |
Number |
0..1 |
Preliminary OpenModelAttribute
|
The process number assigned by the OS when the application was started |
Ves::ObjectClasses::Syslog::syslogProcId |
syslogSData |
String |
0..1 |
Preliminary OpenModelAttribute
|
A <space> separated list of key=”value” pairs following the rfc5424 standard for SD-ELEMENT. Deprecated The entire rfc5424 syslogSData object, including square brackets [ ], SD-ID and list of SD-PARAMs |
Ves::ObjectClasses::Syslog::syslogSData |
syslogSev |
SyslogSev |
0..1 |
Preliminary OpenModelAttribute
|
Level-of-severity text enumeration defined below: Text Sev Description Emergency 0 system is unusable Alert 1 action must be taken immediately Critical 2 critical conditions Error 3 error conditions Warning 4 warning conditions Notice 5 normal but significant condition Info 6 Informational messages Debug 7 debug-level messages |
Ves::ObjectClasses::Syslog::syslogSev |
syslogTag |
String |
1 |
Preliminary OpenModelAttribute
|
Also known as MsgId. Brief non-spaced text indicating the type of message such as ‘TCPOUT’ or ‘BGP_STATUS_CHANGE’; ‘NILVALUE’ should be used when no other value can be provided |
Ves::ObjectClasses::Syslog::syslogTag |
syslogTs |
String |
0..1 |
Preliminary OpenModelAttribute
|
Timestamp parsed from non-VES syslog message |
Ves::ObjectClasses::Syslog::syslogTs |
syslogVer |
Number |
0..1 |
Preliminary OpenModelAttribute
|
IANA assigned version of the syslog protocol specification: 0: VES 1: IANA RFC5424 |
Ves::ObjectClasses::Syslog::syslogVer |
domain |
Domain |
1 |
Experimental OpenModelAttribute
|
Update in definition only Event domain enumeration: ‘cmNotify’,’fault’, ‘heartbeat’, ‘measurement’, ‘mobileFlow’, ‘notification’, ‘other’, ‘pnfRegistration’, ‘sipSignaling’, ‘stateChange’, ‘syslog’, ‘thresholdCrossingAlert’, ‘voiceQuality’ |
Ves::ObjectClasses::VesEvent::domain |
eventType |
String |
0..1 |
Preliminary OpenModelAttribute
|
For example: ‘applicationNf’, ‘guestOS’, ‘hostOS’, ‘platform’ |
Ves::ObjectClasses::VesEvent::eventType |
lastEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
the latest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds |
Ves::ObjectClasses::VesEvent::lastEpochMicrosec |
nfcNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function component type: 3 characters (aligned with vfc naming standards) |
Ves::ObjectClasses::VesEvent::nfcNamingCode |
nfNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function type: 4 characters (aligned with vnf and pnf naming standards) |
Ves::ObjectClasses::VesEvent::nfNamingCode |
nfVendorName |
String |
1 |
Preliminary OpenModelAttribute
|
Network function vendor name |
Ves::ObjectClasses::VesEvent::nfVendorName |
priority |
Priority |
1 |
Preliminary OpenModelAttribute
|
Processing priority enumeration: ‘High’, ‘Medium’, ‘Normal’, ‘Low’ |
Ves::ObjectClasses::VesEvent::priority |
reportingEntityId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See ‘reportingEntityName’ for more information. reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. |
Ves::ObjectClasses::VesEvent::reportingEntityId |
reportingEntityName |
String |
1 |
Preliminary OpenModelAttribute
|
reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. |
Ves::ObjectClasses::VesEvent::reportingEntityName |
sequence |
Integer |
1 |
Preliminary OpenModelAttribute
|
sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ordering of events communicated by an event source instance (or 0 if not needed) |
Ves::ObjectClasses::VesEvent::sequence |
sourceId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See ‘sourceName’ for more information. sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. |
Ves::ObjectClasses::VesEvent::sourceId |
sourceName |
String |
1 |
Preliminary OpenModelAttribute
|
Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. |
Ves::ObjectClasses::VesEvent::sourceName |
startingEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) |
Ves::ObjectClasses::VesEvent::startingEpochMicrosec |
timeZoneOffset |
String |
0..1 |
Preliminary OpenModelAttribute
|
Offset to GMT to indicate local time zone for device formatted as ‘UTC+/-hh:mm’; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples |
Ves::ObjectClasses::VesEvent::timeZoneOffset |
version |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the event header as “#.#” where # is a digit; see section 1 for the correct digits to use. |
Ves::ObjectClasses::VesEvent::version |
vesEventListenerVersion |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the ves event listener api spec that this event is compliant with (as “#” or “#.#” or “#.#.#” where # is a digit; see section 1 for the correct digits to use). |
Ves::ObjectClasses::VesEvent::vesEventListenerVersion |
name |
String |
1 |
Preliminary OpenModelAttribute
|
Ves::ObjectClasses::VesEvent::name |
|
Status |
String |
0..1 |
Preliminary OpenModelAttribute
|
The current condition of an interaction, such as open, in research, closed, and so forth |
Common::Business Interaction::ObjectClasses::BusinessInteraction::Status |
description |
String |
0..1 |
Preliminary OpenModelAttribute
|
Defines a textual free-form description of the object. |
Common::Root::RootObjectClasses::RootEntity::description |
id |
Identifier |
1 |
Preliminary OpenModelAttribute
|
Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. |
Common::Root::RootObjectClasses::RootEntity::id |
ThresholdCrossingAlert
The thresholdCrossingAlertFields datatype consists of the following fields:
Parent class: VesEvent
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
additionalFields |
HashMap |
0..1 |
Preliminary OpenModelAttribute
|
additionalFields - Additional pnfRegistration fields if needed. |
Ves::ObjectClasses::ThresholdCrossingAlert::additionalFields |
additionalParameters |
ThresholdCrossingAlertCounter |
1..* |
Preliminary OpenModelAttribute
|
Array of performance counters |
Ves::ObjectClasses::ThresholdCrossingAlert::additionalParameters |
alertAction |
AlertAction |
1 |
Preliminary OpenModelAttribute
|
Enumeration: ‘SET’, ‘CONT’, ‘CLEAR’ |
Ves::ObjectClasses::ThresholdCrossingAlert::alertAction |
alertDescription |
String |
1 |
Preliminary OpenModelAttribute
|
Unique short alert description (e.g., NE-CPUMEM) |
Ves::ObjectClasses::ThresholdCrossingAlert::alertDescription |
alertType |
AlertType |
1 |
Preliminary OpenModelAttribute
|
Enumeration: ‘CARD-ANOMALY’, ‘INTERFACE-ANOMALY’, ELEMENT-ANOMALY’, ‘SERVICE-ANOMALY’ |
Ves::ObjectClasses::ThresholdCrossingAlert::alertType |
alertValue |
String |
0..1 |
Preliminary OpenModelAttribute
|
Calculated API value (if applicable) |
Ves::ObjectClasses::ThresholdCrossingAlert::alertValue |
associatedAlertIdList |
String |
0..* |
Preliminary OpenModelAttribute
|
List of eventIds associated with the event being reported |
Ves::ObjectClasses::ThresholdCrossingAlert::associatedAlertIdList |
collectionTimestamp |
String |
1 |
Preliminary OpenModelAttribute
|
Time when the performance collector picked up the data; with RFC 2822 compliant format: ‘Sat, 13 Mar 2010 11:29:05 -0800’ |
Ves::ObjectClasses::ThresholdCrossingAlert::collectionTimestamp |
dataCollector |
String |
0..1 |
Preliminary OpenModelAttribute
|
Specific performance collector instance used |
Ves::ObjectClasses::ThresholdCrossingAlert::dataCollector |
elementType |
String |
0..1 |
Preliminary OpenModelAttribute
|
Type of network element (internal AT&T field) |
Ves::ObjectClasses::ThresholdCrossingAlert::elementType |
eventSeverity |
EventSeverity |
1 |
Preliminary OpenModelAttribute
|
Event severity or priority enumeration: ‘CRITICAL’, ‘MAJOR’, ‘MINOR’, ‘WARNING’, ‘NORMAL’ |
Ves::ObjectClasses::ThresholdCrossingAlert::eventSeverity |
eventStartTimestamp |
String |
1 |
Preliminary OpenModelAttribute
|
Time closest to when the measurement was made; with RFC 2822 compliant format: ‘Sat, 13 Mar 2010 11:29:05 -0800’ |
Ves::ObjectClasses::ThresholdCrossingAlert::eventStartTimestamp |
interfaceName |
String |
0..1 |
Preliminary OpenModelAttribute
|
Physical or logical port or card (if applicable |
Ves::ObjectClasses::ThresholdCrossingAlert::interfaceName |
networkService |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network name (internal AT&T field) |
Ves::ObjectClasses::ThresholdCrossingAlert::networkService |
possibleRootCause |
String |
0..1 |
Preliminary OpenModelAttribute
|
Reserved for future use |
Ves::ObjectClasses::ThresholdCrossingAlert::possibleRootCause |
thresholdCrossingFieldsVersion |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the thresholdCrossingAlertFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. |
Ves::ObjectClasses::ThresholdCrossingAlert::thresholdCrossingFieldsVersion |
domain |
Domain |
1 |
Experimental OpenModelAttribute
|
Update in definition only Event domain enumeration: ‘cmNotify’,’fault’, ‘heartbeat’, ‘measurement’, ‘mobileFlow’, ‘notification’, ‘other’, ‘pnfRegistration’, ‘sipSignaling’, ‘stateChange’, ‘syslog’, ‘thresholdCrossingAlert’, ‘voiceQuality’ |
Ves::ObjectClasses::VesEvent::domain |
eventType |
String |
0..1 |
Preliminary OpenModelAttribute
|
For example: ‘applicationNf’, ‘guestOS’, ‘hostOS’, ‘platform’ |
Ves::ObjectClasses::VesEvent::eventType |
lastEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
the latest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds |
Ves::ObjectClasses::VesEvent::lastEpochMicrosec |
nfcNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function component type: 3 characters (aligned with vfc naming standards) |
Ves::ObjectClasses::VesEvent::nfcNamingCode |
nfNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function type: 4 characters (aligned with vnf and pnf naming standards) |
Ves::ObjectClasses::VesEvent::nfNamingCode |
nfVendorName |
String |
1 |
Preliminary OpenModelAttribute
|
Network function vendor name |
Ves::ObjectClasses::VesEvent::nfVendorName |
priority |
Priority |
1 |
Preliminary OpenModelAttribute
|
Processing priority enumeration: ‘High’, ‘Medium’, ‘Normal’, ‘Low’ |
Ves::ObjectClasses::VesEvent::priority |
reportingEntityId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See ‘reportingEntityName’ for more information. reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. |
Ves::ObjectClasses::VesEvent::reportingEntityId |
reportingEntityName |
String |
1 |
Preliminary OpenModelAttribute
|
reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. |
Ves::ObjectClasses::VesEvent::reportingEntityName |
sequence |
Integer |
1 |
Preliminary OpenModelAttribute
|
sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ordering of events communicated by an event source instance (or 0 if not needed) |
Ves::ObjectClasses::VesEvent::sequence |
sourceId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See ‘sourceName’ for more information. sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. |
Ves::ObjectClasses::VesEvent::sourceId |
sourceName |
String |
1 |
Preliminary OpenModelAttribute
|
Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. |
Ves::ObjectClasses::VesEvent::sourceName |
startingEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) |
Ves::ObjectClasses::VesEvent::startingEpochMicrosec |
timeZoneOffset |
String |
0..1 |
Preliminary OpenModelAttribute
|
Offset to GMT to indicate local time zone for device formatted as ‘UTC+/-hh:mm’; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples |
Ves::ObjectClasses::VesEvent::timeZoneOffset |
version |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the event header as “#.#” where # is a digit; see section 1 for the correct digits to use. |
Ves::ObjectClasses::VesEvent::version |
vesEventListenerVersion |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the ves event listener api spec that this event is compliant with (as “#” or “#.#” or “#.#.#” where # is a digit; see section 1 for the correct digits to use). |
Ves::ObjectClasses::VesEvent::vesEventListenerVersion |
name |
String |
1 |
Preliminary OpenModelAttribute
|
Ves::ObjectClasses::VesEvent::name |
|
Status |
String |
0..1 |
Preliminary OpenModelAttribute
|
The current condition of an interaction, such as open, in research, closed, and so forth |
Common::Business Interaction::ObjectClasses::BusinessInteraction::Status |
description |
String |
0..1 |
Preliminary OpenModelAttribute
|
Defines a textual free-form description of the object. |
Common::Root::RootObjectClasses::RootEntity::description |
id |
Identifier |
1 |
Preliminary OpenModelAttribute
|
Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. |
Common::Root::RootObjectClasses::RootEntity::id |
VendorNfNameFields
vendorNfNameFields - The vendorNfNameFields provides vendor, nf and nfModule identifying information.
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
nfModuleName |
String |
0..1 |
Preliminary OpenModelAttribute
|
nfModuleName - Name of the nfModule generating the event. |
Ves::ObjectClasses::VendorNfNameFields::nfModuleName |
nfName |
String |
0..1 |
Preliminary OpenModelAttribute
|
nfName - Name of the network function generating the event |
Ves::ObjectClasses::VendorNfNameFields::nfName |
vendorName |
String |
1 |
Preliminary OpenModelAttribute
|
vendorName - Network function vendor name. |
Ves::ObjectClasses::VendorNfNameFields::vendorName |
VesEvent
An ONAP event is an aggregation of a header and a message. Event messages may be published to a message broker by service instances, resource instances, or ONAP platform components. Service or resource instances may be in support of network infrastructure or customer services. Interested platforms may subscribe to events on the message broker (e.g. Centralized Testing Platform CTP) may see an event on a service VNF instance and perform an automated test as part of a closed loop management policy. Events are unique and distinguishable from one another. ONAP event messages are serialized as a unicode ASCII character string which may be formatted as JSON, XML, etc… Appropriate schemas will be supplied.
Parent class: Notification
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
domain |
Domain |
1 |
Experimental OpenModelAttribute
|
Update in definition only Event domain enumeration: ‘cmNotify’,’fault’, ‘heartbeat’, ‘measurement’, ‘mobileFlow’, ‘notification’, ‘other’, ‘pnfRegistration’, ‘sipSignaling’, ‘stateChange’, ‘syslog’, ‘thresholdCrossingAlert’, ‘voiceQuality’ |
Ves::ObjectClasses::VesEvent::domain |
eventType |
String |
0..1 |
Preliminary OpenModelAttribute
|
For example: ‘applicationNf’, ‘guestOS’, ‘hostOS’, ‘platform’ |
Ves::ObjectClasses::VesEvent::eventType |
lastEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
the latest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds |
Ves::ObjectClasses::VesEvent::lastEpochMicrosec |
nfcNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function component type: 3 characters (aligned with vfc naming standards) |
Ves::ObjectClasses::VesEvent::nfcNamingCode |
nfNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function type: 4 characters (aligned with vnf and pnf naming standards) |
Ves::ObjectClasses::VesEvent::nfNamingCode |
nfVendorName |
String |
1 |
Preliminary OpenModelAttribute
|
Network function vendor name |
Ves::ObjectClasses::VesEvent::nfVendorName |
priority |
Priority |
1 |
Preliminary OpenModelAttribute
|
Processing priority enumeration: ‘High’, ‘Medium’, ‘Normal’, ‘Low’ |
Ves::ObjectClasses::VesEvent::priority |
reportingEntityId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See ‘reportingEntityName’ for more information. reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. |
Ves::ObjectClasses::VesEvent::reportingEntityId |
reportingEntityName |
String |
1 |
Preliminary OpenModelAttribute
|
reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. |
Ves::ObjectClasses::VesEvent::reportingEntityName |
sequence |
Integer |
1 |
Preliminary OpenModelAttribute
|
sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ordering of events communicated by an event source instance (or 0 if not needed) |
Ves::ObjectClasses::VesEvent::sequence |
sourceId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See ‘sourceName’ for more information. sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. |
Ves::ObjectClasses::VesEvent::sourceId |
sourceName |
String |
1 |
Preliminary OpenModelAttribute
|
Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. |
Ves::ObjectClasses::VesEvent::sourceName |
startingEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) |
Ves::ObjectClasses::VesEvent::startingEpochMicrosec |
timeZoneOffset |
String |
0..1 |
Preliminary OpenModelAttribute
|
Offset to GMT to indicate local time zone for device formatted as ‘UTC+/-hh:mm’; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples |
Ves::ObjectClasses::VesEvent::timeZoneOffset |
version |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the event header as “#.#” where # is a digit; see section 1 for the correct digits to use. |
Ves::ObjectClasses::VesEvent::version |
vesEventListenerVersion |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the ves event listener api spec that this event is compliant with (as “#” or “#.#” or “#.#.#” where # is a digit; see section 1 for the correct digits to use). |
Ves::ObjectClasses::VesEvent::vesEventListenerVersion |
name |
String |
1 |
Preliminary OpenModelAttribute
|
Ves::ObjectClasses::VesEvent::name |
|
Status |
String |
0..1 |
Preliminary OpenModelAttribute
|
The current condition of an interaction, such as open, in research, closed, and so forth |
Common::Business Interaction::ObjectClasses::BusinessInteraction::Status |
description |
String |
0..1 |
Preliminary OpenModelAttribute
|
Defines a textual free-form description of the object. |
Common::Root::RootObjectClasses::RootEntity::description |
id |
Identifier |
1 |
Preliminary OpenModelAttribute
|
Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. |
Common::Root::RootObjectClasses::RootEntity::id |
VoiceQuality
The voiceQuality class provides statistics related to customer facing voice products; consists of the following fields:
Parent class: VesEvent
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
additionalInformation |
HashMap |
0..1 |
Preliminary OpenModelAttribute
|
Additional voice quality fields |
Ves::ObjectClasses::VoiceQuality::additionalInformation |
calleeSideCodec |
String |
1 |
Preliminary OpenModelAttribute
|
Callee codec for the call |
Ves::ObjectClasses::VoiceQuality::calleeSideCodec |
callerSideCodec |
String |
1 |
Preliminary OpenModelAttribute
|
Caller codec for the call |
Ves::ObjectClasses::VoiceQuality::callerSideCodec |
correlator |
String |
1 |
Preliminary OpenModelAttribute
|
Constant across all events on this call |
Ves::ObjectClasses::VoiceQuality::correlator |
phoneNumber |
String |
0..1 |
Preliminary OpenModelAttribute
|
Phone number associated with the correlator |
Ves::ObjectClasses::VoiceQuality::phoneNumber |
midCallRtcp |
String |
1 |
Preliminary OpenModelAttribute
|
Base64 encoding of the binary RTCP data (excluding Eth/IP/UDP headers) |
Ves::ObjectClasses::VoiceQuality::midCallRtcp |
voiceQualityFieldsVersion |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the voiceQualityFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. |
Ves::ObjectClasses::VoiceQuality::voiceQualityFieldsVersion |
_endofcallvqmsummaries |
EndOfCallVqmSummaries |
0..1 |
Preliminary OpenModelAttribute
|
End of call voice quality metric summaries |
Ves::ObjectClasses::VoiceQuality::_endofcallvqmsummaries |
_vendornfnamefields |
VendorNfNameFields |
1 |
Preliminary OpenModelAttribute
|
Vendor, NF and nfModule names |
Ves::ObjectClasses::VoiceQuality::_vendornfnamefields |
domain |
Domain |
1 |
Experimental OpenModelAttribute
|
Update in definition only Event domain enumeration: ‘cmNotify’,’fault’, ‘heartbeat’, ‘measurement’, ‘mobileFlow’, ‘notification’, ‘other’, ‘pnfRegistration’, ‘sipSignaling’, ‘stateChange’, ‘syslog’, ‘thresholdCrossingAlert’, ‘voiceQuality’ |
Ves::ObjectClasses::VesEvent::domain |
eventType |
String |
0..1 |
Preliminary OpenModelAttribute
|
For example: ‘applicationNf’, ‘guestOS’, ‘hostOS’, ‘platform’ |
Ves::ObjectClasses::VesEvent::eventType |
lastEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
the latest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds |
Ves::ObjectClasses::VesEvent::lastEpochMicrosec |
nfcNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function component type: 3 characters (aligned with vfc naming standards) |
Ves::ObjectClasses::VesEvent::nfcNamingCode |
nfNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function type: 4 characters (aligned with vnf and pnf naming standards) |
Ves::ObjectClasses::VesEvent::nfNamingCode |
nfVendorName |
String |
1 |
Preliminary OpenModelAttribute
|
Network function vendor name |
Ves::ObjectClasses::VesEvent::nfVendorName |
priority |
Priority |
1 |
Preliminary OpenModelAttribute
|
Processing priority enumeration: ‘High’, ‘Medium’, ‘Normal’, ‘Low’ |
Ves::ObjectClasses::VesEvent::priority |
reportingEntityId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See ‘reportingEntityName’ for more information. reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. |
Ves::ObjectClasses::VesEvent::reportingEntityId |
reportingEntityName |
String |
1 |
Preliminary OpenModelAttribute
|
reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. |
Ves::ObjectClasses::VesEvent::reportingEntityName |
sequence |
Integer |
1 |
Preliminary OpenModelAttribute
|
sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ordering of events communicated by an event source instance (or 0 if not needed) |
Ves::ObjectClasses::VesEvent::sequence |
sourceId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See ‘sourceName’ for more information. sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. |
Ves::ObjectClasses::VesEvent::sourceId |
sourceName |
String |
1 |
Preliminary OpenModelAttribute
|
Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. |
Ves::ObjectClasses::VesEvent::sourceName |
startingEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) |
Ves::ObjectClasses::VesEvent::startingEpochMicrosec |
timeZoneOffset |
String |
0..1 |
Preliminary OpenModelAttribute
|
Offset to GMT to indicate local time zone for device formatted as ‘UTC+/-hh:mm’; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples |
Ves::ObjectClasses::VesEvent::timeZoneOffset |
version |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the event header as “#.#” where # is a digit; see section 1 for the correct digits to use. |
Ves::ObjectClasses::VesEvent::version |
vesEventListenerVersion |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the ves event listener api spec that this event is compliant with (as “#” or “#.#” or “#.#.#” where # is a digit; see section 1 for the correct digits to use). |
Ves::ObjectClasses::VesEvent::vesEventListenerVersion |
name |
String |
1 |
Preliminary OpenModelAttribute
|
Ves::ObjectClasses::VesEvent::name |
|
Status |
String |
0..1 |
Preliminary OpenModelAttribute
|
The current condition of an interaction, such as open, in research, closed, and so forth |
Common::Business Interaction::ObjectClasses::BusinessInteraction::Status |
description |
String |
0..1 |
Preliminary OpenModelAttribute
|
Defines a textual free-form description of the object. |
Common::Root::RootObjectClasses::RootEntity::description |
id |
Identifier |
1 |
Preliminary OpenModelAttribute
|
Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. |
Common::Root::RootObjectClasses::RootEntity::id |
cmNotif
Applied stereotypes:
OpenModelClass
support: MANDATORY
Experimental
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
notificationType |
String |
0..1 |
OpenModelAttribute
|
Type of notification. This is an enum (managedObjectCreation, managedObjectDeletion, managedObjectAttributeValueChanged) |
Ves::Diagrams::cmNotif::notificationType |
dN |
String |
0..1 |
OpenModelAttribute
|
Managed Object Instance that is the subject of this notification. In 3GPP devices this is the Distinguished Name (DN) which is used to uniquely identify a MO within a name space as defined by ITU-T |
Ves::Diagrams::cmNotif::dN |
objectIdentiferType |
String |
0..1 |
OpenModelAttribute
|
Type of object identifier (Ynag, or ….) |
Ves::Diagrams::cmNotif::objectIdentiferType |
attributeList |
AttributeList |
1..* |
OpenModelAttribute
|
[R1] Attribute Name and values (attributeName(string), newAttributeValue(any type), oldAttributeValue(any type) [R2] This is Mandatory for notifyMOIAttributeValueChange. 3GPP defines it as options for Creation and Deletion. |
Ves::Diagrams::cmNotif::attributeList |
measInfoIdInteger
The measInfoIdInteger datatype provides an integer measurement group identifier;
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
iMeasInfoId |
Integer |
1 |
Preliminary OpenModelAttribute
|
Integer measurement group Identifier |
Ves::ObjectClasses::measInfoIdInteger::iMeasInfoId |
measResultNull
The measResultNull datatype provides a null 3GPP PM measurement result
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
p |
Integer |
1 |
Preliminary OpenModelAttribute
|
Integer reference to the counter |
Ves::ObjectClasses::measResultNull::p |
isNull |
Boolean |
1 |
Preliminary OpenModelAttribute
|
Enumeration: ‘true’ or ‘false’ The VES 7.1 Spec has this attribute as a string. |
Ves::ObjectClasses::measResultNull::isNull |
VES Model Associations
MeasurementHasCodecsInUse
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_codecsinuse |
composite |
Navig. |
CodecsInUse |
0..* |
Array of codecs in use |
measurement |
none |
Not navig. |
Measurement |
1 |
MeasurementHasCpuUsage
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_cpuUsage |
composite |
Navig. |
CpuUsage |
0..* |
Usage of an array of CPUs |
measurement |
none |
Not navig. |
Measurement |
1 |
MeasurementHasDiskUsage
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_diskUsage |
composite |
Navig. |
DiskUsage |
0..* |
Usage of an array of disks |
measurement |
none |
Not navig. |
Measurement |
1 |
MeasurementHasHugePages
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_Hugepages |
composite |
Navig. |
HugePages |
0..1 |
Array of metrics on hugePages |
measurement |
none |
Not navig. |
Measurement |
1 |
MeasurementHasFilesystemUsage
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_filesystemusage |
composite |
Navig. |
FilesystemUsage |
0..* |
Filesystem usage of the VM on which the xNFC reporting the event is running |
measurementhasdiskusage |
none |
Not navig. |
Measurement |
1 |
MeasurementHasIpmi
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_ipmi |
composite |
Navig. |
Ipmi |
0..1 |
Array of intelligent platform management interface metrics |
measurement |
none |
Not navig. |
Measurement |
1 |
MeasurementHasLatencyBucketMeasure
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_latencybucketmeasure |
composite |
Navig. |
LatencyBucketMeasure |
0..1 |
Array of integers representing counts of requests whose latency in milliseconds falls within per-xNF configured ranges; where latency is the duration between a service request and its fulfillment. |
measurement |
none |
Not navig. |
Measurement |
1 |
MeasurementHasLoad
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_load |
composite |
Navig. |
Load |
0..1 |
Array of system load metrics |
measurement |
none |
Not navig. |
Measurement |
1 |
MeasurementHasMemoryUsage
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_memoryusage |
composite |
Navig. |
MemoryUsage |
0..* |
Memory usage of an array of VMs |
measurement |
none |
Not navig. |
Measurement |
1 |
MeasurementHasNicPerformance
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_nicperformance |
composite |
Navig. |
NicPerformance |
0..* |
Performance metrics of an array of network interface cards |
measurement |
none |
Not navig. |
Measurement |
1 |
MeasurementHasProcessStats
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_processstats |
composite |
Navig. |
ProcessStats |
0..* |
Array of metrics on system processes |
measurement |
none |
Not navig. |
Measurement |
1 |
MeausrementHasMachineCheckException
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_machinecheckexception |
composite |
Navig. |
MachineCheckException |
0..1 |
Array of machine check exceptions |
measurement |
none |
Not navig. |
Measurement |
1 |
IpmiHasIpmiBattery
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_ipmibattery |
composite |
Navig. |
IpmiBattery |
0..1 |
Array of ipmiBattery objects |
ipmi |
none |
Not navig. |
Ipmi |
1 |
IpmiHasIpmiBaseboardVoltageRegulator
Array of ipmiBaseboard VoltageRegulator objects
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_ipmibaseboardvoltageregulator |
composite |
Navig. |
IpmiBaseboardVoltageRegulator |
0..1 |
Array of ipmiBaseboard VoltageRegulator objects |
ipmi |
none |
Not navig. |
Ipmi |
1 |
IpmiHas IpmiFan
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_ipmifan |
composite |
Navig. |
IpmiFan |
0..1 |
Array of ipmiFan objects |
ipmi |
none |
Not navig. |
Ipmi |
1 |
IpmiHasIpmiBaseboardTemperature
Array of ipmiBaseboard Temperature objects
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_ipmibaseboardtemperature |
composite |
Navig. |
IpmiBaseboardTemperature |
0..1 |
Array of ipmiBaseboard Temperature objects |
ipmi |
none |
Not navig. |
Ipmi |
1 |
IpmiHasIpmiGlobalAggregateTemperatureMargin
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_ipmiglobalaggregatetemperaturemargin |
composite |
Navig. |
IpmiGlobalAggregateTemperatureMargin |
0..1 |
ipmi global aggregate temperature margin |
ipmi |
none |
Not navig. |
Ipmi |
1 |
IpmiHasIpmiHsbp
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_ipmihsbp |
composite |
Navig. |
IpmiHsbp |
0..1 |
Array of ipmiHsbp objects |
ipmi |
none |
Not navig. |
Ipmi |
1 |
IpmiHasIpmiNic
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_ipminic |
composite |
Navig. |
IpmiNic |
0..1 |
Array of ipmiNic objects |
ipmi |
none |
Not navig. |
Ipmi |
1 |
IpmiHasIpmiProcessor
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_ipmiprocessor |
composite |
Navig. |
IpmiProcessor |
0..1 |
Array of ipmiProcessor objects |
ipmi |
none |
Not navig. |
Ipmi |
1 |
IpmiHsIpmiPowerSupply
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_ipmipowersupply |
composite |
Navig. |
IpmiPowerSupply |
0..1 |
Array of ipmiPowerSupply objects |
ipmi |
none |
Not navig. |
Ipmi |
1 |
IpmiProcessorHasProcessorDimmAggregateThermalMargin
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_processordimmaggregatethermalmargin |
composite |
Navig. |
ProcessorDimmAggregateThermalMargin |
0..1 |
Array of processorDimmAggregate ThermalMargin objects |
ipmiprocessor |
none |
Not navig. |
IpmiProcessor |
1 |
MobileFlowHasGtpPerFlowMetrics
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_gtpperflowmetrics |
composite |
Navig. |
GtpPerFlowMetrics |
1 |
Mobility GTP Protocol per flow metrics |
mobileflow |
none |
Not navig. |
MobileFlow |
1 |
VoiceQualityHasEndOfCallVqmSummaries
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_endofcallvqmsummaries |
composite |
Navig. |
EndOfCallVqmSummaries |
0..1 |
End of call voice quality metric summaries |
voicequality |
none |
Not navig. |
VoiceQuality |
1 |
SipSignalingHasVendorNfNameFields
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_vendorNfnamefields |
composite |
Navig. |
VendorNfNameFields |
1 |
Vendor, NF and nfModule names |
sipsignaling |
none |
Not navig. |
SipSignaling |
1 |
VoiceQualityHasVendorNfNameFields
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_vendornfnamefields |
composite |
Navig. |
VendorNfNameFields |
1 |
Vendor, NF and nfModule names |
voicequality |
none |
Not navig. |
VoiceQuality |
1 |
Perf3gppContainsMeasDataCollection
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_measDataCollection |
composite |
Navig. |
MeasDataCollection |
1 |
3GPP measurement collection structure |
perf3gpp |
none |
Not navig. |
Perf3gpp |
1 |
MeasDataCollectionContainsMeasInfo
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_measinfo |
composite |
Navig. |
MeasInfo |
1..* |
Array of monitored object local distinguished name ids per 3GPP TS 32.300 |
measdatacollection |
none |
Not navig. |
MeasDataCollection |
1 |
MeasInfoContainsMeasInfoIdInteger
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_measinfoidinteger |
composite |
Navig. |
measInfoIdInteger |
0..1 |
Measurement group Identifier |
measinfo |
none |
Not navig. |
MeasInfo |
1 |
MeasInfoContainsMeasInfoIdString
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_measinfoidstring |
composite |
Navig. |
MeasInfoIdString |
0..1 |
Measurement group Identifier |
measinfo |
none |
Not navig. |
MeasInfo |
1 |
MeasInfoContainsMeasTypesInteger
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_meastypesinteger |
none |
Navig. |
MeasTypesInteger |
0..1 |
Array of measurement identifiers associated with the measurement results expressed as integers for efficiency rather than strings |
measinfo |
none |
Not navig. |
MeasInfo |
1 |
MeasInfoContainsMeasTypesString
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_meastypesstring |
composite |
Navig. |
MeasTypesString |
0..1 |
Array of measurement identifiers associated with the measurement results expressed as integers for efficiency rather than strings |
measinfo |
none |
Not navig. |
MeasInfo |
1 |
MeasInfoContainsMeasValues
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_measValuesList |
composite |
Navig. |
MeasValues |
1..* |
Array of measValues |
measinfo |
none |
Not navig. |
MeasInfo |
1 |
MeasValuesContainsMeasResultInteger
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_measresultinteger |
composite |
Navig. |
MeasResultInteger |
0..* |
Array of results |
measvalues |
none |
Not navig. |
MeasValues |
1 |
MeasValuesContainsMeasResultNull
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_measresultnull |
none |
Navig. |
measResultNull |
0..* |
Array of results |
measvalues |
none |
Not navig. |
MeasValues |
1 |
MeasValuesContainsMEasResultNumber
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_mesresultnumber |
none |
Navig. |
MesResultNumber |
0..* |
Array of results |
measvalues |
none |
Not navig. |
MeasValues |
1 |
MeasValuesContainsMeasResultString
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_measresultstring |
none |
Navig. |
MeasResultString |
0..* |
Array of results |
measvalues |
none |
Not navig. |
MeasValues |
1 |
CmNotifyHasCmNotif
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
_cmnotif |
composite |
Navig. |
cmNotif |
1..* |
Array of cmNotif notificatons |
cmnotify |
none |
Not navig. |
CmNotify |
1 |
VES Datatype Definition
Data Types
ArrayOfSchemaObject
arrayOfSchemaObject - The arrayOfSchemaObject datatype provides an array of json objects, each of which is described by name, schema and other meta-information.
Note: The VES Spec has this as a Json based object.
Applied stereotypes:
Preliminary
Attribute Name |
Type |
Mult. |
Access |
Stereotypes |
Description |
arrayOfSchemaObject |
SchemaObject |
1..* |
RW |
Preliminary OpenModelAttribute
|
arrayOfSchemaObject - arrayOfSchemaObject datatype provides an array of SchemaObjects, each of which is described by name, schema and other meta-information. |
ArrayofNamedHashMap
Array of named hashMaps
Applied stereotypes:
Preliminary
Attribute Name |
Type |
Mult. |
Access |
Stereotypes |
Description |
arrayOfNamedHashmap |
NamedHashMap |
1..* |
RW |
Preliminary OpenModelAttribute
|
Array of named hashMaps |
AttributeList
Applied stereotypes:
Experimental
Attribute Name |
Type |
Mult. |
Access |
Stereotypes |
Description |
atributeName |
String |
1 |
RW |
OpenModelAttribute
|
|
newAttributeValue |
String |
1 |
RW |
OpenModelAttribute
|
|
NewAttributeType |
String |
1 |
RW |
OpenModelAttribute
|
|
oldAttributeValue |
String |
1 |
RW |
OpenModelAttribute
|
|
oldAttributeType |
String |
1 |
RW |
OpenModelAttribute
|
HashMap
The hashMap datatype is an ‘associative array’, which is an unordered collection of key-value pairs of the form “key”: “value”, where each key and value are strings. Keys must use camel casing to separate words and acronyms; only the first letter of each acronym shall be capitalized.
Applied stereotypes:
Preliminary
Attribute Name |
Type |
Mult. |
Access |
Stereotypes |
Description |
hashmapEntry |
KeyValuePair |
0..* |
RW |
Preliminary OpenModelAttribute
|
A given entry in the hashmap, which is a key/value pair. |
NamedHashMap
namedHashMap [ ] - The namedHashmap datatype is a hashMap which is associated with and described by a name.
Applied stereotypes:
Preliminary
Attribute Name |
Type |
Mult. |
Access |
Stereotypes |
Description |
name |
String |
1 |
RW |
Preliminary OpenModelAttribute
|
name - Name for the array of name-value pairs. |
hashMap |
HashMap |
1 |
RW |
Preliminary OpenModelAttribute
|
hashMap - One or more key:value pairs. Note: in ATTServiceSpecification - VesEventListener v5.4.1 type = field []. |
ProcessStats
Applied stereotypes:
SchemaObject
SchemaObject - The SchemaObject datatype provides an object schema, name and other meta-information along with one or more object instances that conform to the schema.
Note: The VES Spec has this as a Json based object.
Applied stereotypes:
Preliminary
Attribute Name |
Type |
Mult. |
Access |
Stereotypes |
Description |
objectInstances |
SchemaObjectInstance |
1..* |
RW |
Preliminary OpenModelAttribute
|
objectInstances - Contains one or more instances of the SchemaObjectInstance object. |
objectName |
String |
1 |
RW |
Preliminary OpenModelAttribute
|
objectName - Name of the object. |
objectSchema |
String |
0..1 |
RW |
Preliminary OpenModelAttribute
|
objectSchema - schema for the object. |
objectSchemaUrl |
String |
0..1 |
RW |
Preliminary OpenModelAttribute
|
objectSchemaUrl - URL to the schema for the object. |
nfSubcribedObjectName |
String |
0..1 |
RW |
Preliminary OpenModelAttribute
|
nfSubscribedObjectName - Name of the object associated with the nfSubscriptionId. |
nfSubcriptionId |
String |
0..1 |
RW |
Preliminary OpenModelAttribute
|
nfSubscriptionId - Identifies an OpenConfig telemetry subscription on a network function, which configures the network function to send complex object data associated with the SchemaObject. |
SchemaObjectInstance
SchemaObjectInstance [ ] - The SchemabjectInstance datatype provides meta-information about an instance of a SchemaObject along with the actual object instance.
Note: The VES Spec has this as a Json based object.
Applied stereotypes:
Preliminary
Attribute Name |
Type |
Mult. |
Access |
Stereotypes |
Description |
schemaObject |
SchemaObject |
0..* |
RW |
Preliminary OpenModelAttribute
|
SchemaObject - Optional recursive specification on SchemaObject |
objectInstance |
Object |
0..1 |
RW |
Preliminary OpenModelAttribute
|
objectInstance - Contains an instance conforming to the SchemaObject schema |
objectInstanceEpochMicrosec |
UnixEpoch |
0..1 |
RW |
Preliminary OpenModelAttribute
|
objectInstanceEpochMicrosec - the unix time, aka epoch time, associated with this objectInstance–as microseconds elapsed since 1 Jan 1970 not including leap seconds. |
objectKeys |
Key |
0..* |
RW |
Preliminary OpenModelAttribute
|
objectKeys - An ordered set of keys that identifies this particular instance of SchemaObject (e.g., that places it in a hierarchy). |
ThresholdCrossingAlertCounter
Applied stereotypes:
Preliminary
Attribute Name |
Type |
Mult. |
Access |
Stereotypes |
Description |
criticality |
TCACriticality |
1 |
RW |
Preliminary OpenModelAttribute
|
Enumeration: ‘CRIT’, ‘MAJ’ |
hashMap |
HashMap |
1 |
RW |
Preliminary OpenModelAttribute
|
Key is the name of the counter and value is the current value of the counter |
thresholdCrossed |
String |
1 |
RW |
Preliminary OpenModelAttribute
|
Last threshold that was crossed |
VES Enumeration definition
Enumerations
AlertAction
Possible alertActions within thresholdCrossingAlertFields
Contains Enumeration Literals:
SET:
CONT:
CLEAR:
AlertType
Possible values for ThresholdCrossingAlertFIelds alertType attribute.
Contains Enumeration Literals:
CARD_ANOMALY:
INTERFACE_ANOMALY:
ELEMENT_ANOMALY:
SERVICE_ANOMALY:
Domain
domain - Event domain enumeration: ‘fault’, ‘heartbeat’, ‘measurementsForVfScaling’, ‘mobileFlow’, ‘other’, ‘sipSignaling’, ‘stateChange’, ‘syslog’, ‘thresholdCrossingAlert’, ‘voiceQuality’
Contains Enumeration Literals:
FAULT:
HEARTBEAT:
MEASUREMENT:
MOBILEFLOW:
NOTIFICATION:
OTHER:
PERF3GPP:
PNFREGISTRATION:
SIPSIGNALING:
STATECHANGE:
SYSLOG:
THRESHOLDCROSSINGALERT:
VOICEQUALITY:
STNDDEFINED:
STNDDEFINED:
EndpointDescription
Contains Enumeration Literals:
CALLER:
CALLEE:
EventSeverity
Event severity enumeration: ‘CRITICAL’, ‘MAJOR’, ‘MINOR’, ‘WARNING’, ‘NORMAL’. NORMAL is used to represent clear.
Contains Enumeration Literals:
CRITICAL:
MAJOR:
MINOR:
WARNING:
NORMAL:
NicAdminState
Contains Enumeration Literals:
IN_SERVICE:
OUT_OF_SERVICE:
NicOpsState
Contains Enumeration Literals:
IN_SERVICE:
OUT_OF_SERVICE:
SourceIndicator
Indicates the source of the operation
Contains Enumeration Literals:
RESOURCE_OPERATION:
internal operation of resource
MANAGEMENT_OPERATOIN:
response to management operation
SON_OPERATOIN:
result of SON
UNKNOWN:
can’t determine why
SyslogFacility
Numeric code from 0 to 23 for facility: 0 kernel messages 1 user-level messages 2 mail system 3 system daemons 4 security/authorization messages 5 messages generated internally by syslogd 6 line printer subsystem 7 network news subsystem 8 UUCP subsystem 9 clock daemon 10 security/authorization messages 11 FTP daemon 12 NTP subsystem 13 log audit 14 log alert 15 clock daemon (note 2) 16 local use 0 (local0) 17 local use 1 (local1) 18 local use 2 (local2) 19 local use 3 (local3) 20 local use 4 (local4) 21 local use 5 (local5) 22 local use 6 (local6) 23 local use 7 (local7)
Contains Enumeration Literals:
0:
kernel messages
1:
user-level messages
2:
mail system
3:
system daemons
4:
security/authorization messages
5:
messages generated internally by syslogd
6:
line printer subsystem
7:
network news subsystem
8:
UUCP subsystem
9:
clock daemon
10:
security/authorization messages
11:
FTP daemon
12:
NTP subsystem
13:
log audit
14:
log alert
15:
clock daemon
16:
local use 0 (local0)
17:
local use 1 (local1)
18:
local use 2 (local2)
19:
local use 3 (local3)
20:
local use 4 (local4)
21:
local use 5 (local5)
22:
local use 6 (local6)
23:
local use 7 (local7 )
SyslogSev
Level-of-severity text enumeration defined below: Text Sev Description Emergency 0 system is unusable Alert 1 action must be taken immediately Critical 2 critical conditions Error 3 error conditions Warning 4 warning conditions Notice 5 normal but significant condition Info 6 Informational messages Debug 7 debug-level messages
Contains Enumeration Literals:
EMERGENCY:
system is unusable
0
ALERT:
1
action must be taken immediately
CRITICAL:
critical conditions
2
ERROR:
3
error conditions
WARNING:
4
warning conditions
NOTICE:
normal but significant condition
5
INFO:
Informational messages
6
DEBUG:
debug-level messages
7
TCACriticality
Threshold Crossing Alert counter criticality - possible values of CRIT and MAJ.
Contains Enumeration Literals:
CRIT:
MAJ:
VfStatus
Virtual function status enumeration: ‘Active’, ‘Idle’, ‘Preparing to terminate’, ‘Ready to terminate’, ‘Requesting Termination’
Contains Enumeration Literals:
ACTIVE:
IDLE:
PREPARING_TO_TERMINATE:
READY_TO_TERMINATE:
REQUESTING_TERMINATION:
Enhanced Nested Service Model
Diagrams
Enhanced Nested Service Model
Classes
ServiceAtomicDescriptor
Parent class: ServiceDescriptor
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
_serviceAtomicInstance |
ServiceAtomicInstance |
0..* |
OpenModelAttribute
|
An implementation of atomic Service corresponding to a ServicecAtomicDescriptor. |
_resourceDesc (resourcespecification) |
ResourceDesc |
0..* |
OpenModelAttribute
|
Resource components of constituting a serivce descriptor. |
serviceInvariantId |
Identifier |
1 |
OpenModelAttribute
Preliminary |
Constant identifier of the service model. |
serviceId |
Identifier |
1 |
OpenModelAttribute
Preliminary |
Versioned identifier of the service model (this uuid is changed for every major version of the service) |
name |
String |
1 |
OpenModelAttribute
Preliminary |
The name of the service model designed. |
description |
String |
1 |
OpenModelAttribute
Preliminary |
The description of the service model designed. |
category |
String |
1..* |
OpenModelAttribute
Preliminary |
A predefined list which identifies the construct’s category. There is a predefined list of service categories. |
version |
String |
1 |
OpenModelAttribute
Preliminary |
The service model version. |
serviceType |
String |
0..1 |
OpenModelAttribute
Preliminary |
An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as “TRANSPORT”. |
serviceRole |
String |
0..1 |
OpenModelAttribute
Preliminary |
An optional string field for shortcode that defines the function that the service is providing. E.g. “MISVPN” or “AIM”. |
icon |
String |
1 |
OpenModelAttribute
Preliminary |
The icon path of the service. |
attachment |
Attachment |
0..* |
OpenModelAttribute
Preliminary |
|
isShared |
Boolean |
1 |
OpenModelAttribute
Preliminary |
Describe whether this service descriptor is shared or not in the service design. |
lifecycleManagementScript |
ServiceLifecycleManagementScript |
0..* |
OpenModelAttribute
Preliminary |
Includes a list of events and corresponding management scripts performed for the Service. |
class8 |
CustomizedKPIGroup |
0..1 |
OpenModelAttribute
|
|
SNSSAIId |
Identifier |
0..1 |
OpenModelAttribute
Experimental |
|
validFor |
TimePeriod |
0..1 |
OpenModelAttribute
Preliminary |
The period during which the design entity is valid. |
status |
String |
1 |
OpenModelAttribute
Preliminary |
The condition of the specification, such s active, inactive, or planned. |
name |
String |
1 |
OpenModelAttribute
Preliminary |
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). |
description |
String |
1 |
OpenModelAttribute
Preliminary |
Defines a textual free-form description of the object. |
id |
Identifier |
1 |
OpenModelAttribute
Preliminary |
Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. |
ServiceAtomicInstance
Parent class: ServiceInstance
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
_resourceInstance |
ResourceInstance |
0..* |
OpenModelAttribute
|
Resource instance components of constituting a service instance. |
serviceInstanceId |
Identifier |
1 |
OpenModelAttribute
Preliminary |
Uniquely identifies this instance of a service. Uniquely identifies this instance of a service. |
serviceInstanceName |
String |
0..1 |
OpenModelAttribute
Preliminary |
The name assigned to the service-instance. |
serviceType |
String |
0..1 |
OpenModelAttribute
Preliminary |
An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as “TRANSPORT”. |
serviceRole |
String |
1 |
OpenModelAttribute
Preliminary |
An optional string field for shortcode that defines the function that the service is providing. E.g. “MISVPN” or “AIM”. |
selfLink |
Uri |
1 |
OpenModelAttribute
Preliminary |
URL to endpoint where more details can be gotten. |
orchestrationStatus |
String |
1 |
OpenModelAttribute
Preliminary |
Orchestration status of the service instance. |
nsStatus |
String |
1 |
OpenModelAttribute
Preliminary |
Describe NS instance staus: instantiating(creating the Networek Service instance), active(the existed Network Service instance is under using), terminating(the existed Network Service instance stops using) or etc(healing and other possible status). |
instanceSharingNumber |
Integer |
0..1 |
OpenModelAttribute
Preliminary |
Record the number of services that are using this service instance. Note: This attribute can be used when a service instance is prepared to be deleted, the detected number will help to find how many services are using this instance. If number is greater than 1, it shows this instance is used by other service(s), otherwise it can be deleted. |
name |
String |
0..1 |
OpenModelAttribute
Preliminary |
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). |
description |
String |
0..1 |
OpenModelAttribute
Preliminary |
Defines a textual free-form description of the object. |
id |
Identifier |
1 |
OpenModelAttribute
Preliminary |
Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. |
ServiceCompositeDescriptor
ServcieCompositeDescriptor is used to model the design time representation of a service component or network service.
Parent class: ServiceDescriptor
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
_serviceDescriptor |
ServiceDescriptor |
0..* |
OpenModelAttribute
|
Describe the nested relationship between multiple Service Descriptors. |
_serviceCompositeInstance |
ServiceCompositeInstance |
0..* |
OpenModelAttribute
|
An implementation of composite Service corresponding to a ServiceCompositeDescriptor. |
_resourceDesc (resourcespecification) |
ResourceDesc |
0..* |
OpenModelAttribute
|
Resource components of constituting a serivce descriptor. |
serviceInvariantId |
Identifier |
1 |
OpenModelAttribute
Preliminary |
Constant identifier of the service model. |
serviceId |
Identifier |
1 |
OpenModelAttribute
Preliminary |
Versioned identifier of the service model (this uuid is changed for every major version of the service) |
name |
String |
1 |
OpenModelAttribute
Preliminary |
The name of the service model designed. |
description |
String |
1 |
OpenModelAttribute
Preliminary |
The description of the service model designed. |
category |
String |
1..* |
OpenModelAttribute
Preliminary |
A predefined list which identifies the construct’s category. There is a predefined list of service categories. |
version |
String |
1 |
OpenModelAttribute
Preliminary |
The service model version. |
serviceType |
String |
0..1 |
OpenModelAttribute
Preliminary |
An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as “TRANSPORT”. |
serviceRole |
String |
0..1 |
OpenModelAttribute
Preliminary |
An optional string field for shortcode that defines the function that the service is providing. E.g. “MISVPN” or “AIM”. |
icon |
String |
1 |
OpenModelAttribute
Preliminary |
The icon path of the service. |
attachment |
Attachment |
0..* |
OpenModelAttribute
Preliminary |
|
isShared |
Boolean |
1 |
OpenModelAttribute
Preliminary |
Describe whether this service descriptor is shared or not in the service design. |
lifecycleManagementScript |
ServiceLifecycleManagementScript |
0..* |
OpenModelAttribute
Preliminary |
Includes a list of events and corresponding management scripts performed for the Service. |
class8 |
CustomizedKPIGroup |
0..1 |
OpenModelAttribute
|
|
SNSSAIId |
Identifier |
0..1 |
OpenModelAttribute
Experimental |
|
validFor |
TimePeriod |
0..1 |
OpenModelAttribute
Preliminary |
The period during which the design entity is valid. |
status |
String |
1 |
OpenModelAttribute
Preliminary |
The condition of the specification, such s active, inactive, or planned. |
name |
String |
1 |
OpenModelAttribute
Preliminary |
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). |
description |
String |
1 |
OpenModelAttribute
Preliminary |
Defines a textual free-form description of the object. |
id |
Identifier |
1 |
OpenModelAttribute
Preliminary |
Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. |
ServiceCompositeInstance
Parent class: ServiceInstance
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
_resourceInstance |
ResourceInstance |
0..* |
OpenModelAttribute
|
Resource instance components of constituting a service instance. |
serviceInstanceId |
Identifier |
1 |
OpenModelAttribute
Preliminary |
Uniquely identifies this instance of a service. Uniquely identifies this instance of a service. |
serviceInstanceName |
String |
0..1 |
OpenModelAttribute
Preliminary |
The name assigned to the service-instance. |
serviceType |
String |
0..1 |
OpenModelAttribute
Preliminary |
An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as “TRANSPORT”. |
serviceRole |
String |
1 |
OpenModelAttribute
Preliminary |
An optional string field for shortcode that defines the function that the service is providing. E.g. “MISVPN” or “AIM”. |
selfLink |
Uri |
1 |
OpenModelAttribute
Preliminary |
URL to endpoint where more details can be gotten. |
orchestrationStatus |
String |
1 |
OpenModelAttribute
Preliminary |
Orchestration status of the service instance. |
nsStatus |
String |
1 |
OpenModelAttribute
Preliminary |
Describe NS instance staus: instantiating(creating the Networek Service instance), active(the existed Network Service instance is under using), terminating(the existed Network Service instance stops using) or etc(healing and other possible status). |
instanceSharingNumber |
Integer |
0..1 |
OpenModelAttribute
Preliminary |
Record the number of services that are using this service instance. Note: This attribute can be used when a service instance is prepared to be deleted, the detected number will help to find how many services are using this instance. If number is greater than 1, it shows this instance is used by other service(s), otherwise it can be deleted. |
name |
String |
0..1 |
OpenModelAttribute
Preliminary |
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). |
description |
String |
0..1 |
OpenModelAttribute
Preliminary |
Defines a textual free-form description of the object. |
id |
Identifier |
1 |
OpenModelAttribute
Preliminary |
Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. |
ServiceDescriptor
ServiceDescriptor is used to model the design time representation of a service.
Parent class: DesignEntity
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
serviceInvariantId |
Identifier |
1 |
OpenModelAttribute
Preliminary |
Constant identifier of the service model. |
serviceId |
Identifier |
1 |
OpenModelAttribute
Preliminary |
Versioned identifier of the service model (this uuid is changed for every major version of the service) |
name |
String |
1 |
OpenModelAttribute
Preliminary |
The name of the service model designed. |
description |
String |
1 |
OpenModelAttribute
Preliminary |
The description of the service model designed. |
category |
String |
1..* |
OpenModelAttribute
Preliminary |
A predefined list which identifies the construct’s category. There is a predefined list of service categories. |
version |
String |
1 |
OpenModelAttribute
Preliminary |
The service model version. |
serviceType |
String |
0..1 |
OpenModelAttribute
Preliminary |
An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as “TRANSPORT”. |
serviceRole |
String |
0..1 |
OpenModelAttribute
Preliminary |
An optional string field for shortcode that defines the function that the service is providing. E.g. “MISVPN” or “AIM”. |
icon |
String |
1 |
OpenModelAttribute
Preliminary |
The icon path of the service. |
attachment |
Attachment |
0..* |
OpenModelAttribute
Preliminary |
|
isShared |
Boolean |
1 |
OpenModelAttribute
Preliminary |
Describe whether this service descriptor is shared or not in the service design. |
lifecycleManagementScript |
ServiceLifecycleManagementScript |
0..* |
OpenModelAttribute
Preliminary |
Includes a list of events and corresponding management scripts performed for the Service. |
class8 |
CustomizedKPIGroup |
0..1 |
OpenModelAttribute
|
|
SNSSAIId |
Identifier |
0..1 |
OpenModelAttribute
Experimental |
|
validFor |
TimePeriod |
0..1 |
OpenModelAttribute
Preliminary |
The period during which the design entity is valid. |
status |
String |
1 |
OpenModelAttribute
Preliminary |
The condition of the specification, such s active, inactive, or planned. |
name |
String |
1 |
OpenModelAttribute
Preliminary |
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). |
description |
String |
1 |
OpenModelAttribute
Preliminary |
Defines a textual free-form description of the object. |
id |
Identifier |
1 |
OpenModelAttribute
Preliminary |
Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. |
ServiceInstance
ServiceInstance is used to model the run time representation of a service.
Parent class: OperationalEntity
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
serviceInstanceId |
Identifier |
1 |
OpenModelAttribute
Preliminary |
Uniquely identifies this instance of a service. Uniquely identifies this instance of a service. |
serviceInstanceName |
String |
0..1 |
OpenModelAttribute
Preliminary |
The name assigned to the service-instance. |
serviceType |
String |
0..1 |
OpenModelAttribute
Preliminary |
An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as “TRANSPORT”. |
serviceRole |
String |
1 |
OpenModelAttribute
Preliminary |
An optional string field for shortcode that defines the function that the service is providing. E.g. “MISVPN” or “AIM”. |
selfLink |
Uri |
1 |
OpenModelAttribute
Preliminary |
URL to endpoint where more details can be gotten. |
orchestrationStatus |
String |
1 |
OpenModelAttribute
Preliminary |
Orchestration status of the service instance. |
nsStatus |
String |
1 |
OpenModelAttribute
Preliminary |
Describe NS instance staus: instantiating(creating the Networek Service instance), active(the existed Network Service instance is under using), terminating(the existed Network Service instance stops using) or etc(healing and other possible status). |
instanceSharingNumber |
Integer |
0..1 |
OpenModelAttribute
Preliminary |
Record the number of services that are using this service instance. Note: This attribute can be used when a service instance is prepared to be deleted, the detected number will help to find how many services are using this instance. If number is greater than 1, it shows this instance is used by other service(s), otherwise it can be deleted. |
name |
String |
0..1 |
OpenModelAttribute
Preliminary |
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). |
description |
String |
0..1 |
OpenModelAttribute
Preliminary |
Defines a textual free-form description of the object. |
id |
Identifier |
1 |
OpenModelAttribute
Preliminary |
Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. |
Associations
ServiceCompositeInstanceHasServiceInstance
Applied stereotypes:
Preliminary
Attribute Name |
Aggreg. |
Navig. |
Mult. |
Type |
Description |
Stereotypes |
_serviceInstance |
shared |
Not navig. |
1..* |
ServiceInstance |
OpenModelAttribute
|
|
_servicecompositeinstance |
none |
Not navig. |
1..* |
ServiceCompositeInstance |
OpenModelAttribute
|
SerivceCompositeDescriptorMadeAvailableAsServiceCompositeInstance
An implementation of composite Service corresponding to a ServiceCompositeDescriptor.
Applied stereotypes:
Preliminary
Attribute Name |
Aggreg. |
Navig. |
Mult. |
Type |
Description |
Stereotypes |
_serviceCompositeInstance |
shared |
Not navig. |
0..* |
ServiceCompositeInstance |
OpenModelAttribute
|
|
_servicecompositedescriptor |
none |
Not navig. |
1 |
ServiceCompositeDescriptor |
OpenModelAttribute
|
ServiceCompositeDescriptorComprisedOfServiceDescriptor
Describe the nested relationship between multiple Serive Descriptors.
Applied stereotypes:
Preliminary
Attribute Name |
Aggreg. |
Navig. |
Mult. |
Type |
Description |
Stereotypes |
_serviceDescriptor |
shared |
Not navig. |
0..* |
ServiceDescriptor |
OpenModelAttribute
|
|
servicecompositedescriptor |
none |
Not navig. |
0..* |
ServiceCompositeDescriptor |
OpenModelAttribute
|
ServiceAtomicDescriptorMadeAvailableAsServiceAtomicInstance
An implementation of atomic Service corresponding to a ServicecAtomicDescriptor.
Applied stereotypes:
Preliminary
Attribute Name |
Aggreg. |
Navig. |
Mult. |
Type |
Description |
Stereotypes |
_serviceAtomicInstance |
shared |
Not navig. |
0..* |
ServiceAtomicInstance |
OpenModelAttribute
|
|
_serviceatomicdescriptor |
none |
Not navig. |
1 |
ServiceAtomicDescriptor |
OpenModelAttribute
|
ServiceAtomicDescriptorReferencesResourceDesc
Resource components of constituting a serivce descriptor.
Applied stereotypes:
Preliminary
Attribute Name |
Aggreg. |
Navig. |
Mult. |
Type |
Description |
Stereotypes |
_resourceDesc (resourcespecification) |
none |
Navig. |
0..* |
ResourceDesc |
Resource components of constituting a serivce descriptor. |
OpenModelAttribute
|
_serviceatomicdescriptor |
none |
Not navig. |
0..* |
ServiceAtomicDescriptor |
OpenModelAttribute
|
ServiceAtomicInstanceReferencesResourceInstance
Resource instance components of constituting a serivce instance.
Applied stereotypes:
Preliminary
Attribute Name |
Aggreg. |
Navig. |
Mult. |
Type |
Description |
Stereotypes |
_resourceInstance |
none |
Navig. |
0..* |
ResourceInstance |
Resource instance components of constituting a service instance. |
OpenModelAttribute
|
_serviceatomicinstance |
none |
Not navig. |
0..* |
ServiceAtomicInstance |
OpenModelAttribute
|
ServiceCompositeInstanceReferencesResourceInstance
Resource instance components of constituting a serivce instance.
Applied stereotypes:
Preliminary
Attribute Name |
Aggreg. |
Navig. |
Mult. |
Type |
Description |
Stereotypes |
_resourceInstance |
none |
Navig. |
0..* |
ResourceInstance |
Resource instance components of constituting a service instance. |
OpenModelAttribute
|
_servicecompositeinstance |
none |
Not navig. |
0..* |
ServiceCompositeInstance |
OpenModelAttribute
|
ServiceCompositeDescriptorReferencesResourceDesc
Resource components of constituting a serivce descriptor.
Applied stereotypes:
Preliminary
Attribute Name |
Aggreg. |
Navig. |
Mult. |
Type |
Description |
Stereotypes |
_resourceDesc (resourcespecification) |
none |
Navig. |
0..* |
ResourceDesc |
Resource components of constituting a serivce descriptor. |
OpenModelAttribute
|
_service compositedescriptor |
none |
Not navig. |
0..* |
ServiceCompositeDescriptor |
OpenModelAttribute
|
Data Types
ServiceLifecycleManagementScript
The LifeCycleManagementScript information element specifies a script for the service.
Applied stereotypes:
Preliminary
Attribute Name |
Type |
Mult. |
Access |
Stereotypes |
Description |
event |
ServiceLcmEvent |
0..* |
RW |
OpenModelAttribute
Preliminary |
Describes Service lifecycle event(s) or an external stimulus detected on an orchestrator reference point. Describes Service lifecycle event(s) or an external stimulus detected on an orchestrator reference point. |
lcmTransitionEvent |
String |
0..* |
RW |
OpenModelAttribute
Preliminary |
Describes the transition Service lifecycle event(s) that cannot be mapped to any of the enumerated values defined for the event attribute. |
script |
String |
1 |
RW |
OpenModelAttribute
Preliminary |
Includes a Service LCM script (e.g. written in a DSL) triggered to react to one of the events listed in the event attribute. |
scriptDsl |
String |
1 |
RW |
OpenModelAttribute
Preliminary |
Defines the domain specific language (i.e. the type) of script that is provided. Types of scripts could include bash, python, etc. |
scriptInput |
KeyValuePair |
0..* |
RW |
OpenModelAttribute
Preliminary |
Array of KVP requirements with the key as the parameter name and the value as the parameter that need to be passed as an input to the script. Note: The scriptInput values are passed to the scripts in addition to the parameters received in the operation invocation request or indicator value change. |
Enumerations
ServiceLcmEvent
Contains Enumeration Literals:
EVENT_START_DEPLOYMENT:
EVENT_END_DEPLOYMENT:
EVENT_START_CONFIGURATION:
EVENT_END_CONFIGURATION:
EVENT_START_TERMINATION:
EVENT_END_TERMINATION:
EVENT_START_DEPLOYMENT:
EVENT_END_DEPLOYMENT:
EVENT_START_CONFIGURATION:
EVENT_END_CONFIGURATION:
EVENT_START_TERMINATION:
EVENT_END_TERMINATION:
Service Order
Diagrams
Classes
OrderItemRelationship
Enables specifying any kind of relationships between ServiceOrderItems
Applied stereotypes:
Preliminary
OpenModelClass
support: MANDATORY
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
|---|---|---|---|---|
type |
String |
1 |
Preliminary OpenModelAttribute
|
The type of relationship such as contains, relies on. |
OrderRelationship
An association between two ServiceOrders.
Applied stereotypes:
Preliminary
OpenModelClass
support: MANDATORY
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
|---|---|---|---|---|
type |
String |
1 |
Preliminary OpenModelAttribute
|
A categorization of the relationship, such as bulk, parent/child, and so forth. |
ServiceCharacteristic
A quality or distinctive feature that defines an entity, including the name of this feature (attribute), and the type of the actual value.
Applied stereotypes:
Preliminary
OpenModelClass
support: MANDATORY
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
|---|---|---|---|---|
name |
String |
1 |
Preliminary OpenModelAttribute
|
Name of dynamic characteristic (attribute). |
valueType |
String |
1 |
Preliminary OpenModelAttribute
|
Type of the dynamic characteristic value. |
ServiceOrder
A type of Request that represents a Customer Order’s products decomposed into the services through which the products are realized.
Parent class: Request
Applied stereotypes:
Preliminary
OpenModelClass
support: MANDATORY
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
|---|---|---|---|---|
id |
String |
1 |
OpenModelAttribute
Preliminary |
Unique identifier for Interaction. |
externalId |
String |
1 |
OpenModelAttribute
Preliminary |
ID given by the order requester and only understandable by him (to facilitate his searches afterwards). It could an order number reference from the triggering system (OM) |
priority |
OrderPriority |
1 |
OpenModelAttribute
Preliminary |
A way that can be used by order requester to prioritize orders in Service Order |
description |
String |
1 |
OpenModelAttribute
Preliminary |
Narrative that explains the interaction and details about the interaction, such as why the interaction is taking place. |
category |
String |
1 |
OpenModelAttribute
Preliminary |
Used to categorize the order - Requester valued it and this category can be useful for the Service Order Management system and/or requester (e.g. “broadband”, “TV option”,). |
state |
OrderState |
1 |
OpenModelAttribute
Preliminary |
State of the order |
completionDate |
EDate |
1 |
OpenModelAttribute
Preliminary |
The date on which an interaction is closed or completed. |
requestedStartDate |
EDate |
1 |
OpenModelAttribute
Preliminary |
The date that was requested to start processing the order. |
requestedCompletionDate |
EDate |
1 |
OpenModelAttribute
Preliminary |
The date on which an interaction is closed or completed. |
expectedCompletionDate |
EDate |
1 |
OpenModelAttribute
Preliminary |
The date on which an interaction is expected to be completed. |
startDate |
EDate |
1 |
OpenModelAttribute
Preliminary |
The date on which an interaction is started. |
notificationContact |
String |
1 |
OpenModelAttribute
Preliminary |
Contact attached to the order to send back information regarding this order |
_serviceOrderItem |
ServiceOrderItem |
1..* |
OpenModelAttribute
|
Reference to ServiceOrderItem |
OrderDate |
EDate |
1 |
OpenModelAttribute
Preliminary |
The date the order was placed. |
ServiceOrderItem
The purpose for the ServiceOrder expressed in terms of a ServiceSpecification or a Service.
Applied stereotypes:
Preliminary
OpenModelClass
support: MANDATORY
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
|---|---|---|---|---|
id |
String |
1 |
Preliminary OpenModelAttribute
|
Identifier of the line item (generally it is a sequence number 01, 02, 03, …). |
action |
Action |
1 |
Preliminary OpenModelAttribute
|
The action to take for an InteractionItem, such as add, change, remove. |
state |
OrderState |
1 |
Preliminary OpenModelAttribute
|
State of the order item: described in the state machine diagram. This is the requested state. |
Quantity |
Integer |
1 |
Preliminary OpenModelAttribute
|
Quantity of an interaction item involved in an interaction. |
Value
Applied stereotypes:
Preliminary
OpenModelClass
support: MANDATORY
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
|---|---|---|---|---|
value |
String |
1 |
Preliminary OpenModelAttribute
|
The value of a given ServiceCharacteristic. |
Enumerations
Action
Contains Enumeration Literals:
ADD:
MODIFY:
DELETE:
NO_CHANGE:
OrderPriority
A way that can be used by order requester to prioritize orders in Service Order Management system (from 0 to 4: 0 is the highest priority, and 4 the lowest). It could be for example valued by BSS based on customer order requested priority.
Contains Enumeration Literals:
0:
1:
2:
3:
4:
OrderState
Contains Enumeration Literals:
ACKNOWLEDGED:
IN_PROGRESS:
PENDING:
HELD:
CANCELLED:
COMPLETED:
FAILED:
PARTIAL:
REJECTED:
Dynamic Parameters Model
Diagrams
Dynamic Parameters
Classes
DiscreteValueSpec
DiscreteValueSpec represents a specific valid value that a given Parameter can take on.
Parent class: ParmSpecValue
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
value |
String |
1 |
Preliminary OpenModelAttribute
|
A discrete value that the Parameter can take on. |
Parameter
Some parameter that is part of a ParameterGroup. If parameter can only hold certain values, those values are specified via ParameterSpecValue (design time). The actual value is specified via ParameterValue (runtime).
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
parameterName |
String |
1 |
Preliminary OpenModelAttribute
|
Name of parameter. |
IsInput |
Boolean |
1 |
Preliminary OpenModelAttribute
|
Boolean that specifices if this parameter is an input parameter. |
paramvalue |
ParameterValue |
0..* |
OpenModelAttribute
|
Parameter can have some number of runtime ParameterValues. Each ParameterValue is also associated with some OperationalEntity (VnfInstance, ServiceInstance, …). |
isModifiable |
Boolean |
1 |
Preliminary OpenModelAttribute
|
Bolean that specifices if the value can be modified or changed during the life of this parameter. |
valueType |
String |
1 |
Preliminary OpenModelAttribute
|
The type of this parameter (integer, string, …). |
unitOfMeasure |
String |
0..1 |
Preliminary OpenModelAttribute
|
A length, surface, volume, dry measure, liquid measure, money, weight, time, and the like. In general, a determinate quantity or magnitude of the kind designated, taken as a standard of comparison for others of the same kind, in assigning to them numerical values, as 1 foot, 1 yard, 1 mile, 1 square foot. |
description |
String |
1 |
Preliminary OpenModelAttribute
|
Description of the parameter. |
ParameterGroup
A group of parameters that somehow relate or work together.
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
parameterGroupName |
String |
1 |
Preliminary OpenModelAttribute
|
Name of ParameterGroup |
parameterGroupDescription |
String |
1 |
Preliminary OpenModelAttribute
|
Description of ParameterGroup. |
parameterGroupId |
Identifier |
1 |
Preliminary OpenModelAttribute
|
ID of ParameterGroup. |
ParameterValue
The actual value of Parameter (runtime).
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
parameter |
Parameter |
1 |
OpenModelAttribute
|
Runtime ParameterValue is associated with exactly one Parameter. Parameter can have some number of runtime ParameterValues. |
value |
String |
1 |
Preliminary OpenModelAttribute
|
The actual value of Parameter (runtime). |
ParmSpecValue
A valid value of parameter (design time). Values can be either a range (RangeValueSpec) or discrete (DiscreteValueSpec).
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
RangeValueSpec
RangeValueSpec is generally expected to be of valueType integer or
RangeValueSpec generally should have a valueType of either integer or real. valueFrom, valueTo, and rangeStep should all be of the same valuetype for some Parameter.
rangeStep should be greater than zero.
valueTo should be greater than valueFrom
Parent class: ParmSpecValue
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
valueMin |
String |
1 |
Preliminary OpenModelAttribute
|
The minimum value that a Parameter can take on. |
valueMax |
String |
1 |
Preliminary OpenModelAttribute
|
The maximum value that the parameter can take on. |
rangeStep |
String |
0..1 |
Preliminary OpenModelAttribute
|
The specification that a range of values increases in steps, such as a range from 0 to 100 in steps of 5 with the resulting permitted values being 0, 5, 10, 15,…100. This complements the valueFrom and valueTo attributes. |
Associations
ParameterGroupHasParameter
A Parameter can be in more than one ParameterGroup, and a ParameterGroup can have some number of Parameters.
Applied stereotypes:
Preliminary
Attribute Name |
Aggreg. |
Navig. |
Mult. |
Type |
Description |
Stereotypes |
parameter |
shared |
Not navig. |
1..* |
Parameter |
OpenModelAttribute
|
|
dynamicparameter |
none |
Not navig. |
0..* |
ParameterGroup |
OpenModelAttribute
|
ParameterHasInstanceValue
Applied stereotypes:
Preliminary
Attribute Name |
Aggreg. |
Navig. |
Mult. |
Type |
Description |
Stereotypes |
paramvalue |
composite |
Navig. |
0..* |
ParameterValue |
Parameter can have some number of runtime ParameterValues. Each ParameterValue is also associated with some OperationalEntity (VnfInstance, ServiceInstance, …). |
OpenModelAttribute
|
parameter |
none |
Navig. |
1 |
Parameter |
Runtime ParameterValue is associated with exactly one Parameter. Parameter can have some number of runtime ParameterValues. |
OpenModelAttribute
|
OperationalEntityFurtherDefinedByParam
Applied stereotypes:
Preliminary
Attribute Name |
Aggreg. |
Navig. |
Mult. |
Type |
Description |
Stereotypes |
dynamicparamvalue |
none |
Not navig. |
0..* |
ParameterValue |
OpenModelAttribute
|
|
operationalentity |
none |
Not navig. |
1 |
OperationalEntity |
OpenModelAttribute
|
DesignEntityFurtherDefinedByParmGroup
Applied stereotypes:
Preliminary
Attribute Name |
Aggreg. |
Navig. |
Mult. |
Type |
Description |
Stereotypes |
dynamicparameter |
none |
Not navig. |
0..* |
ParameterGroup |
OpenModelAttribute
|
|
designentity |
none |
Not navig. |
0..* |
DesignEntity |
OpenModelAttribute
|
ParmSpecValueIntantiatedAsDynamicParmValue
Applied stereotypes:
Preliminary
Attribute Name |
Aggreg. |
Navig. |
Mult. |
Type |
Description |
Stereotypes |
_parametervalue |
none |
Not navig. |
0..* |
ParameterValue |
OpenModelAttribute
|
|
parmspecvalueii |
none |
Not navig. |
0..1 |
ParmSpecValue |
OpenModelAttribute
|
ParameterEnumeratedBy SpecValue
Applied stereotypes:
Preliminary
Attribute Name |
Aggreg. |
Navig. |
Mult. |
Type |
Description |
Stereotypes |
parameter |
none |
Not navig. |
1 |
Parameter |
OpenModelAttribute
|
|
parmspecvalueii |
composite |
Not navig. |
0..* |
ParmSpecValue |
OpenModelAttribute
|
Selection Criteria Model
Diagrams
SelectionCriteria
Classes
SelectionCriteria
SelectionCriteria finds descriptors and instances according to specific properties of those entities.
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
SelectionCriteriaId |
Identifier |
1 |
Preliminary OpenModelAttribute
|
Unique indentifier of this SelectionCriteria. |
SelectionCriteriaAtomic
A simple (atomic) selection criteria that holds a specific attribute comparision expression.
Parent class: SelectionCriteria
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
metricName |
String |
1 |
Preliminary OpenModelAttribute
|
Name of compared parameter or attribute. Name of compared parameter or attribute. |
operator |
Operator |
1 |
Preliminary OpenModelAttribute
|
Comparison operator, e.g. equal, less than, greater or etc. |
value |
String |
1 |
Preliminary OpenModelAttribute
|
Compared value (can be a name of a parameter in referenced class). |
valueType |
String |
1 |
Preliminary OpenModelAttribute
|
The type of the value property (String, Integer, Real, …). |
SelectionCriteriaId |
Identifier |
1 |
Preliminary OpenModelAttribute
|
Unique indentifier of this SelectionCriteria. |
SelectionCriteriaComposite
A SelectionCriteria that is an aggregation of multiple selection criterias. Agregation can be for example AND, OR, or XOR logical operations.
Parent class: SelectionCriteria
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
compositeOperator |
CompositeOperator |
1 |
Preliminary OpenModelAttribute
|
Logical operation for filters composition, e.g. logical AND, OR, XOR. |
SelectionCriteriaId |
Identifier |
1 |
Preliminary OpenModelAttribute
|
Unique indentifier of this SelectionCriteria. |
Associations
DesignEntityHasSelectionCriteria
Applied stereotypes:
Preliminary
Attribute Name |
Aggreg. |
Navig. |
Mult. |
Type |
Description |
Stereotypes |
designentity |
none |
Not navig. |
0..* |
DesignEntity |
OpenModelAttribute
|
|
selectioncriteria |
none |
Not navig. |
0..* |
SelectionCriteria |
OpenModelAttribute
|
SelectionCriteriaCompositeComprisedOfSelectionCriteria
Applied stereotypes:
Preliminary
Attribute Name |
Aggreg. |
Navig. |
Mult. |
Type |
Description |
Stereotypes |
selectioncriteria |
shared |
Not navig. |
2..* |
SelectionCriteria |
OpenModelAttribute
|
|
selectioncriteriacomposite |
none |
Not navig. |
0..* |
SelectionCriteriaComposite |
OpenModelAttribute
|
Enumerations
CompositeOperator
The operator being applied to to some group of selectoin critiera.
Contains Enumeration Literals:
AND:
OR:
XOR:
Operator
The operator being applied to some atomic selection critera.
Contains Enumeration Literals:
MORETHAN:
LESSTHAN:
EQUAL:
License Management Model
Diagrams
Root Entity Hierarchy
License
Rooting License
License Keys
Entitlements
Classes
EntitlementPool
Note: description is required according to the inherited attribute, but it presently is optional.
An EntitlementPool is created for each type of Entitlement that is required for the VNFs. Each Entitlement Pool is assigned a Name and Description for modeling purposes and is uniquely identified by a UUID. In addition, a list of characteristics of the Entitlement Pool are defined. An EntitlementPool is not specific to a Feature Group. An Entitlement Pool may be related to multiple Feature Groups containing a VNF or even to multiple VNFs. Purchased entitlements are inventoried in the Entitlement Pools. Multiple pools for the same type of entitlement may be created based on the constraints.
Parent class: DesignEntity
Applied stereotypes:
Reference
reference: As Built in SDC; Not related to any release usecase.
Preliminary
OpenModelClass
support: MANDATORY
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
_spPoolLimit |
PoolLimit |
0..* |
OpenModelAttribute
|
Pool limits applied by the service provider |
_vendorPoolLimit |
PoolLimit |
0..* |
OpenModelAttribute
|
Pool limits applied by the vendor. |
entitlementManufactureReferenceNumber |
String |
0..1 |
OpenModelAttribute
Preliminary |
Reference number for the entitlement as described by the vendor in their price list / catalog /contract. |
entitlementPurchaseIncrements |
Integer |
0..1 |
OpenModelAttribute
Preliminary |
This field contains information to tell a Designer how the entitlement must be purchased. For example, if the entitlement must be purchased in blocks of 1000, the increment would be 1000. |
entitlementPoolThresholdValue |
Integer |
0..1 |
OpenModelAttribute
Preliminary |
A description of a threshold that will be assessed for some business purpose (e.g. 20% of entitlement pool remains available). (The threshold of interest to DCAE or Capacity Planning, etc.) This may be an absolute value or a percentage. For example: when 90% of the pool is in-use, trigger an additional purchase of inventory. A description of a threshold that will be assessed for some business purpose (e.g. 20% of entitlement pool remains available). (The threshold of interest to DCAE or Capacity Planning, etc.) This may be an absolute value or a percentage. For example: when 90% of the pool is in-use, trigger an additional purchase of inventory. |
entitlementPoolThresholdUnits |
ThresholdUnitType |
0..1 |
OpenModelAttribute
Preliminary |
Specifies the Units for the ThresholdValue. |
invariantId |
Identifier |
1 |
OpenModelAttribute
Preliminary |
Identifier that stays the same irrespective of version. Identifier that stays the same irrespective of version. |
Version |
String |
1 |
OpenModelAttribute
Preliminary |
The version of this entity. |
poolType |
LicenseGroupType |
1 |
OpenModelAttribute
Preliminary |
The license key may be ‘universal’ or ‘unique’ or ‘one-time’. - A ‘universal’ value indicates that the same exact license key (string) may be associated with all instances of the VNF. - A ‘unique’ value indicates that each instance of the VNF must be related to a unique license key (string). When no longer needed, the key may be returned to the license key pool for reuse. - A ‘one-time’ value indicates that each instance of the VNF must be related to a unique license key (string). When no longer needed, the key may not be reused. |
validFor |
TimePeriod |
0..1 |
Preliminary OpenModelAttribute
|
The period during which the design entity is valid. |
status |
String |
1 |
Preliminary OpenModelAttribute
|
The condition of the specification, such s active, inactive, or planned. |
name |
String |
1 |
Preliminary OpenModelAttribute
|
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). |
description |
String |
1 |
Preliminary OpenModelAttribute
|
Defines a textual free-form description of the object. |
id |
Identifier |
1 |
Preliminary OpenModelAttribute
|
Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. |
FeatureGroup
Feature groups represent a set of the features of one or more VNFs. Feature groups may be defined by the vendor and/or by the service provider. A VNF may be related to multiple feature groups. At least one feature group will be related to a VNF. If no sub-sets are needed, a single feature group will be defined that represents the base or core capabilities of the VNF(s) in it. If an Entitlement Pool or License Key Group is associated with a particular Feature Group, the Feature Group becomes a “constraint” for the pool/group.
Applied stereotypes:
Reference
reference: As Built in SDC; Not related to any release usecase.
Preliminary
OpenModelClass
support: MANDATORY
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
featureGroupName |
String |
1 |
OpenModelAttribute
Preliminary |
Name of the feature group |
featureGroupDescription |
String |
0..1 |
OpenModelAttribute
Preliminary |
Description of the feature group. |
featureGroupPartNumber |
String |
1 |
OpenModelAttribute
Preliminary |
The featureGroupPartNumber specifies the Vnf that this FeatureGroup is related to. The featureGroupPartNumber specifies the SKU or reference number that the Vendor has for the Vnf that this FeatureGroup is related to. |
LicenseAgreement
An agreement between the service provider and a given vendor granting the service provider to use the vendor’s products. Generally the license agreement is specific to a family of vendor products and/or to some service provider’s project/product or product family.
Parent class: Agreement
Applied stereotypes:
Reference
reference: As Built in SDC; Not related to any release usecase.
Preliminary
OpenModelClass
support: MANDATORY
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
requirementsAndConstraints |
String |
1..* |
OpenModelAttribute
Preliminary |
Free form text. Includes information such as operating system or hypervisor required for the VNF. This may also contain factors to be considered in deployment/placement of the VNF instances. These requirements and constraints may need to be abstracted as policies or other business rules. Free form text. Includes information such as operating system or hypervisor required for the VNF. This may also contain factors to be considered in deployment/placement of the VNF instances. These requirements and constraints may need to be abstracted as policies or other business rules. |
licenseTerm |
LicenseTerm |
1 |
OpenModelAttribute
Preliminary |
Term of the license: -fixed term -perpetual -unlimited -subscription |
documentNumber |
String |
1 |
Preliminary OpenModelAttribute
|
A reference number assigned to an Agreement that follows a prescribed numbering system. |
statementOfIntent |
String |
1 |
Preliminary OpenModelAttribute
|
An overview and goals of the Agreement. |
StartDate |
DateTime |
1 |
Preliminary OpenModelAttribute
|
Date interaction initiated |
endDate |
DateTime |
1 |
Preliminary OpenModelAttribute
|
The date on which an interaction is closed or completed. |
Status |
String |
0..1 |
Preliminary OpenModelAttribute
|
The current condition of an interaction, such as open, in research, closed, and so forth |
name |
String |
0..1 |
Preliminary OpenModelAttribute
|
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). |
description |
String |
0..1 |
Preliminary OpenModelAttribute
|
Defines a textual free-form description of the object. |
id |
Identifier |
1 |
Preliminary OpenModelAttribute
|
Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. |
LicenseKeyPool
A License Key Pool is created for each type of License Key that is required for the VNF. Each License Key Pool is assigned a Name and Description for modeling purposes and is uniquely identified by a UUID. In addition, a list of characteristics of the License Key Pool are defined. The license key Pool model provides a description to interested systems for the license keys that are provided by a vendor. A license key Pool is not specific to a feature group. A license key Pool may be related to multiple feature groups that a VNF belongs to or even to multiple VNFs.
Parent class: DesignEntity
Applied stereotypes:
Reference
reference: As Built in SDC; Not related to any release usecase.
Preliminary
OpenModelClass
support: MANDATORY
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
_spPooLlimit |
PoolLimit |
0..* |
OpenModelAttribute
|
Pool limits applied by the service provider |
_vendorPoollimit |
PoolLimit |
0..* |
OpenModelAttribute
|
Pool limits applied by the vendor. |
poolType |
LicenseGroupType |
1 |
OpenModelAttribute
Preliminary |
The license key may be ‘universal’ or ‘unique’ or ‘one-time’. - A ‘universal’ value indicates that the same exact license key (string) may be associated with all instances of the VNF. - A ‘unique’ value indicates that each instance of the VNF must be related to a unique license key (string). When no longer needed, the key may be returned to the license key pool for reuse. - A ‘one-time’ value indicates that each instance of the VNF must be related to a unique license key (string). When no longer needed, the key may not be reused. |
thresholdUnits |
ThresholdUnitType |
0..1 |
OpenModelAttribute
Preliminary |
Units can be either absolute or a percentage (%). |
thresholdValue |
Integer |
0..1 |
OpenModelAttribute
Preliminary |
Specified threshold value for the license key pool. |
keyPurchaseIncrements |
String |
0..1 |
OpenModelAttribute
Preliminary |
Specifies how the key must be purchased. If in blocks of 1000, the increment would be 1000. |
invariantId |
Identifier |
1 |
OpenModelAttribute
Preliminary |
Identifier that stays the same irrespective of version. |
Version |
String |
1 |
OpenModelAttribute
Preliminary |
The version of this entity. |
licenseManufactureReferenceNumber |
String |
0..1 |
OpenModelAttribute
Preliminary |
Identifier for the entitlement as described by the vendor in their price list / catalog /contract. |
validFor |
TimePeriod |
0..1 |
Preliminary OpenModelAttribute
|
The period during which the design entity is valid. |
status |
String |
1 |
Preliminary OpenModelAttribute
|
The condition of the specification, such s active, inactive, or planned. |
name |
String |
1 |
Preliminary OpenModelAttribute
|
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). |
description |
String |
1 |
Preliminary OpenModelAttribute
|
Defines a textual free-form description of the object. |
id |
Identifier |
1 |
Preliminary OpenModelAttribute
|
Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. |
PoolLimit
A variable set of values that identify the limits that may be imposed by an entitlement instance in the pool. Multiple constraints may be applicable for an instance of entitlement in the pool. For example, an entitlement based on GB and number of sessions. Increments, aggregation function, time scope, threshold value may repeat for each metric in the list. Limits can be applied by the vendor or the service provider.
Applied stereotypes:
Reference
reference: As Built in SDC; Not related to any release usecase.
Preliminary
OpenModelClass
support: MANDATORY
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
limitMetricType |
EPMetricType |
1 |
OpenModelAttribute
Preliminary |
Specifies if this pool holds entitlements based on usage of the VNF instance (number of users), number of sessions, country, line of business, etc. |
limitMetricValue |
Integer |
1 |
OpenModelAttribute
Preliminary |
The value of some limit being applied. |
aggregationFunction |
AggregationTypes |
0..1 |
OpenModelAttribute
Preliminary |
Type of aggregation being performed (Peak or Average) |
limitUnits |
LimitUnits |
1 |
OpenModelAttribute
Preliminary |
The units of the limit (Trunks, Users, Subscribers, Sessions, tentants, Tokens, Seats, TB, GB, MB, …) |
time |
DateTime |
0..1 |
OpenModelAttribute
Preliminary |
Units time is specified in (day, month, hour, minute, second, millisecond. |
poolMetricTypeOther |
String |
0..1 |
OpenModelAttribute
Preliminary |
LimitMetricType if Other enumeration is selected. |
Associations
LicenseKeyPoolHasSPLimits
LicenseKey can have some number of service provider based limits applied to it.
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Mult. |
Type |
Description |
Stereotypes |
_spPooLlimit |
composite |
Navig. |
0..* |
PoolLimit |
Pool limits applied by the service provider |
OpenModelAttribute
|
licencekeypool |
none |
Not navig. |
1 |
LicenseKeyPool |
lLicenseKeyPool can have some number of service provider specified PoolLimits |
OpenModelAttribute
|
LicenseKeyPoolHasVendorLimits
LicenseKey can have some number of vendor based limits applied to it.
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Mult. |
Type |
Description |
Stereotypes |
_vendorPoollimit |
composite |
Navig. |
0..* |
PoolLimit |
Pool limits applied by the vendor. |
OpenModelAttribute
|
licencekeypooldesc |
none |
Not navig. |
1 |
LicenseKeyPool |
OpenModelAttribute
|
EntitlementPoolHasSPPoolLimits
An EntitlementPool and the associated Entitlements can have some number of Service Provider based limits.
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Mult. |
Type |
Description |
Stereotypes |
_spPoolLimit |
composite |
Navig. |
0..* |
PoolLimit |
Pool limits applied by the service provider |
OpenModelAttribute
|
entitlementpool |
none |
Not navig. |
1 |
EntitlementPool |
EntitlementPool can have some number of service provider specified limits. |
OpenModelAttribute
|
EntitlementPoolHasVendorPoolLimits
An EntitlementPool and the associated Entitlements can have some number of Vendor based limits.
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Mult. |
Type |
Description |
Stereotypes |
_vendorPoolLimit |
composite |
Navig. |
0..* |
PoolLimit |
Pool limits applied by the vendor. |
OpenModelAttribute
|
entitlementpool |
none |
Not navig. |
1 |
EntitlementPool |
The EntitlementPool can have some number of Vendor specified limits. |
OpenModelAttribute
|
FeatureGroupHasEntitlementPool
A FeatureGroup can have one or more EntitlementPools associated with it.
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Mult. |
Type |
Description |
Stereotypes |
entitlementpool |
none |
Not navig. |
1..* |
EntitlementPool |
The EntitlementPool can be related to one FeatureGroup |
OpenModelAttribute
|
featuregroup |
none |
Not navig. |
0..* |
FeatureGroup |
FeatureGroup can be related to some number of EntitlementPools. |
OpenModelAttribute
|
FeatureGroupHasLicenceKeyPool
FeatureGroup can have 1 or more LicenseKeyPools and related LicenseKeys related to it.
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Mult. |
Type |
Description |
Stereotypes |
licencekeypool |
none |
Not navig. |
0..* |
LicenseKeyPool |
LicenseKeyPool is related to one FeatureGroup |
OpenModelAttribute
|
featuregroup |
none |
Not navig. |
0..* |
FeatureGroup |
A feature group can be related to some number of LicenseKeyPools |
OpenModelAttribute
|
LicenseAgreementHasFeatureGroup
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Mult. |
Type |
Description |
Stereotypes |
featuregroup |
none |
Not navig. |
1..* |
FeatureGroup |
OpenModelAttribute
|
|
licenseagreement |
none |
Not navig. |
1..* |
LicenseAgreement |
OpenModelAttribute
|
VendorHasVnfd
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Mult. |
Type |
Description |
Stereotypes |
vendor |
none |
Not navig. |
1 |
Vendor |
||
vnfd |
none |
Not navig. |
0..* |
Vnfd |
OpenModelAttribute
|
VendorHasLicenseAgreement
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Mult. |
Type |
Description |
Stereotypes |
vendor |
none |
Not navig. |
1 |
Vendor |
A Vendor can have some number of LicenseAgreements. |
OpenModelAttribute
|
licenseagreement |
none |
Not navig. |
0..* |
LicenseAgreement |
A LicenseAgreement is related to some vendor. |
OpenModelAttribute
|
VnfHasFeatureGroup
A Vnf can have some number of feature groups. A feature group can apply to one or more Vnfs.
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Mult. |
Type |
Description |
Stereotypes |
featuregroup |
none |
Not navig. |
0..* |
FeatureGroup |
||
vnfd |
none |
Not navig. |
1..* |
Vnfd |
OpenModelAttribute
|
Data Types
Enumerations
AggregationTypes
Contains Enumeration Literals:
PEAK:
AVERAGE:
EPMetricType
Contains Enumeration Literals:
BWTH:
COUNTRY:
SESSION:
LOB:
SITE:
USAGE:
OTHER:
LicenseDuration
Units of the entitlement/license term. Valid values: year, quarter, month, day.
Contains Enumeration Literals:
YEAR:
QUARTER:
MONTH:
DAY:
LicenseGroupType
Contains Enumeration Literals:
UNIVERSAL:
UNIQUE:
ONE_TIME:
LicenseTerm
Valid values: year, quarter, month, day. Not applicable when license type is Perpetual.
Contains Enumeration Literals:
FIXED_TERM:
PERPETUAL:
UNLIMITED:
OTHER:
TRIAL:
SUBSCRIPTION:
LimitUnits
Contains Enumeration Literals:
TRUNKS:
USERS:
SUBSCRIBERS:
SESSIONS:
TENANTS:
TOKENS:
SEATS:
TB:
GB:
MB:
OTHER:
ThresholdUnitType
Contains Enumeration Literals:
ABSOLUTE:
%:
Location Model
Diagrams
Place
Classes
Place
Parent class: RootEntity
Applied stereotypes:
Reference
reference: From TMF SID
Preliminary
OpenModelClass
support: MANDATORY
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
validFor |
TimePeriod |
0..1 |
OpenModelAttribute
Experimental |
Common::Location::ObjectClasses::Place::validFor |
|
geoCoordinates |
GeoCoordinates |
0..1 |
Reference
Preliminary OpenModelAttribute
|
Geographical coordinates |
Common::Location::ObjectClasses::Place::geoCoordinates |
civicAddress |
CivicAddress |
0..1 |
Reference
Preliminary OpenModelAttribute
|
Civic address |
Common::Location::ObjectClasses::Place::civicAddress |
name |
String |
0..1 |
Preliminary OpenModelAttribute
|
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). |
Common::Root::RootObjectClasses::RootEntity::name |
description |
String |
0..1 |
Preliminary OpenModelAttribute
|
Defines a textual free-form description of the object. |
Common::Root::RootObjectClasses::RootEntity::description |
id |
Identifier |
1 |
Preliminary OpenModelAttribute
|
Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. |
Common::Root::RootObjectClasses::RootEntity::id |
RootEntity
This is the top of the ONAP class hierarchy. The purpose of the RootEntity is to define a set of attributes that are common to all entities that derive from it. These properties enable us to name, describe, and identify all objects in the environment.
Applied stereotypes:
Preliminary
OpenModelClass
support: MANDATORY
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
name |
String |
0..1 |
Preliminary OpenModelAttribute
|
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). |
Common::Root::RootObjectClasses::RootEntity::name |
description |
String |
0..1 |
Preliminary OpenModelAttribute
|
Defines a textual free-form description of the object. |
Common::Root::RootObjectClasses::RootEntity::description |
id |
Identifier |
1 |
Preliminary OpenModelAttribute
|
Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. |
Common::Root::RootObjectClasses::RootEntity::id |
Data Types
CityQualifiers
Applied stereotypes:
Preliminary
Attribute Name |
Type |
Mult. |
Access |
Stereotypes |
Description |
cityName |
String |
1 |
RW |
Reference Preliminary OpenModelAttribute
|
Name of City, Township, or Parish |
cityDivision |
String |
0..1 |
RW |
Reference Preliminary OpenModelAttribute
|
Name of city division, ex. Borough, District, Ward, Chou |
cityNeighborhood |
String |
0..1 |
RW |
Reference Preliminary OpenModelAttribute
|
Name of neighborhood, ex. Block, Street group |
CivicAddress
Applied stereotypes:
Preliminary
Attribute Name |
Type |
Mult. |
Access |
Stereotypes |
Description |
country |
String |
1 |
RW |
Reference Preliminary OpenModelAttribute
|
The name of the country |
state |
String |
0..1 |
RW |
Reference Preliminary OpenModelAttribute
|
The name of the state or province |
region |
String |
0..1 |
RW |
Reference Preliminary OpenModelAttribute
|
The name of the region |
postalCode |
String |
0..1 |
RW |
Reference Preliminary OpenModelAttribute
|
The postal code or zip code |
city |
CityQualifiers |
0..1 |
RW |
Preliminary OpenModelAttribute
|
The name of the metropolitan area, city, township, borough, district, or ward. Allows further specific city sub-divisions to be specified, such as: division, borough, district, ward, chou, neighborhood, block, street group |
streetAddress |
String |
0..1 |
RW |
Reference Preliminary OpenModelAttribute
|
The street address |
lata |
String |
0..1 |
RW |
Preliminary OpenModelAttribute
|
Local access and transport area (LATA) represents a geographical area of the United States, used in U.S. telecommunications regulation. |
structureQualifiers |
StructureQualifiers |
0..1 |
RW |
Preliminary OpenModelAttribute
|
Additional pre-defined qualifier fields for a structure including: unit, floor, room, desk |
GeoCoordinates
Applied stereotypes:
Preliminary
Attribute Name |
Type |
Mult. |
Access |
Stereotypes |
Description |
mapDatum |
MapDatum |
1 |
RW |
Reference Preliminary OpenModelAttribute
|
Map Datum used for the coordinates given in this option. |
latitude |
String |
1 |
RW |
Reference Preliminary OpenModelAttribute
|
Latitude in binary geodetic form. A 34-bit fixed-point value consisting of 9 bits of integer and 25 bits of fraction. |
latitudeUncertainty |
String |
0..1 |
RW |
Reference Preliminary OpenModelAttribute
|
When mapDatum = WGS84, this field represents latitude uncertainty. Uncertainty = 2 ^ ( 21 - x ) x = 21 - ceil( log2( uncertainty ) ) |
longitude |
String |
1 |
RW |
Reference Preliminary OpenModelAttribute
|
Longitude in binary geodetic form. A 34-bit fixed-point value consisting of 9 bits of integer and 25 bits of fraction. |
longitudeUncertainty |
String |
0..1 |
RW |
Reference Preliminary OpenModelAttribute
|
When mapDatum = WGS84, this field represents longitude uncertainty. Uncertainty = 2 ^ ( 21 - x ) x = 21 - ceil( log2( uncertainty ) ) |
altitude |
String |
0..1 |
RW |
Reference Preliminary OpenModelAttribute
|
A 30-bit value defined by the Altitude Type field. |
altitudeUncertainty |
String |
0..1 |
RW |
Reference Preliminary OpenModelAttribute
|
When mapDatum = WGS84, this field represents altitude uncertainty. |
altitudeUnit |
AltitudeUnit |
0..1 |
RW |
Reference Preliminary OpenModelAttribute
|
Defines the unit for the altitude value. |
altitudeResolution |
String |
0..1 |
RW |
Reference Preliminary OpenModelAttribute
|
Encodes the number of high-order altitude bits that should be considered valid. |
Identifier
Applied stereotypes:
Preliminary
StructureQualifiers
Applied stereotypes:
Preliminary
Attribute Name |
Type |
Mult. |
Access |
Stereotypes |
Description |
unit |
String |
0..1 |
RW |
Reference Preliminary OpenModelAttribute
|
Unit (apartment, suite) |
floor |
String |
0..1 |
RW |
Reference Preliminary OpenModelAttribute
|
Floor |
room |
String |
0..1 |
RW |
Reference Preliminary OpenModelAttribute
|
Room |
desk |
String |
0..1 |
RW |
Reference Preliminary OpenModelAttribute
|
Seat, desk, cubicle, workstation |
placementInfo |
String |
0..1 |
RW |
Reference Preliminary OpenModelAttribute
|
Additional placement information, ex. shelf, rack |
poBox |
String |
0..1 |
RW |
Reference Preliminary OpenModelAttribute
|
Post office box number |
TimePeriod
A base / value business entity used to represent a period of time, between two timepoints
Applied stereotypes:
Preliminary
Attribute Name |
Type |
Mult. |
Access |
Stereotypes |
Description |
startDateTime |
DateTime |
1 |
RW |
OpenModelAttribute
|
An instant of time, starting at the TimePeriod Notes: If null, then represents to the beginning of time |
endDateTime |
DateTime |
1 |
RW |
OpenModelAttribute
|
An instant of time, ending at the TimePeriod: Notes: If null, then represents to the end of time |
Enumerations
AltitudeUnit
Contains Enumeration Literals:
METER:
FLOOR:
FOOT:
MapDatum
Contains Enumeration Literals:
WGS84:
NAD83 + NAVD88:
NAD83 + MLLW:
Simplified K8S Resource Model
Diagrams
K8S Resource
Classes
GenericVnf
Applied stereotypes:
Experimental
OpenModelClass
support: MANDATORY
K8sResource
A&AI object that represents a resource in K8S
Parent class: ResourceInstance
Applied stereotypes:
Reference
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
group |
String |
1 |
OpenModelAttribute
|
API group of the K8S resource, e.g., “apps” |
Vnf::ObjectClasses::K8sResource::group |
version |
String |
1 |
OpenModelAttribute
|
API version of the K8S resource, e.g., “v1” |
Vnf::ObjectClasses::K8sResource::version |
kind |
String |
1 |
OpenModelAttribute
|
type of the K8S resource, e.g., “Deployment” |
Vnf::ObjectClasses::K8sResource::kind |
namespace |
String |
0..1 |
OpenModelAttribute
|
namespace of the K8S resource |
Vnf::ObjectClasses::K8sResource::namespace |
labels |
String |
0..* |
OpenModelAttribute
|
labels of the K8S resource |
Vnf::ObjectClasses::K8sResource::labels |
k8sResourceSelflink |
String |
1 |
OpenModelAttribute
|
URI of the K8S resource |
Vnf::ObjectClasses::K8sResource::k8sResourceSelflink |
name |
String |
0..1 |
OpenModelAttribute
Preliminary |
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). |
Common::Root::RootObjectClasses::RootEntity::name |
description |
String |
0..1 |
OpenModelAttribute
Preliminary |
Defines a textual free-form description of the object. |
Common::Root::RootObjectClasses::RootEntity::description |
id |
Identifier |
1 |
OpenModelAttribute
Preliminary |
Unambiguously distinguishes different object instances. It is the naming attribute of the object. Identifier of this information element. This attribute shall be globally unique. |
Common::Root::RootObjectClasses::RootEntity::id |
Tenant
Applied stereotypes:
Experimental
OpenModelClass
support: MANDATORY
VfModule
Applied stereotypes:
Experimental
OpenModelClass
support: MANDATORY
Associations
K8sResourceBelongsToTenant
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
tenant |
none |
Navig. |
Tenant |
1 |
|
k8sresource |
none |
Not navig. |
K8sResource |
1..* |
GenericVnfHostedOnK8sResource
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
k8sresource |
none |
Navig. |
K8sResource |
0..* |
|
genericvnf |
none |
Not navig. |
GenericVnf |
1 |
VfModuleUsesK8sResource
Applied stereotypes:
Attribute Name |
Aggreg. |
Navig. |
Type |
Mult. |
Description |
k8sresource |
none |
Navig. |
K8sResource |
0..* |
|
vfmodule |
none |
Not navig. |
VfModule |
1 |
ONAP Data Model Specifications
Artifact Types
Capabilities Types
Data Types
Interface Types
Node Types
Relationships Types
The changes can be found in the Release Notes:
Modeling Spec Release Notes
Version: 12.0.0
- Release Date:
2023-4-26
- New Features
None
- Bug Fixes
None
Security Notes
Modeling code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found.
Quick Links: - Modeling project page - Passing Badge information for Modeling
- Known Issues
None
- Upgrade Notes
None
- Other
None
Version: 11.0.0
- Release Date:
2022-12-16
- New Features
New Information Model for General Intent Model
- Bug Fixes
None
Security Notes
Modeling code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found.
Quick Links: - Modeling project page - Passing Badge information for Modeling
- Known Issues
None
- Upgrade Notes
None
- Other
None
Version: 10.0.0
- Release Date:
2022-6-24
- New Features
None
- Bug Fixes
None
Security Notes
Modeling code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found.
Quick Links: - Modeling project page - Passing Badge information for Modeling
- Known Issues
None
- Upgrade Notes
None
- Other
None
Version: 9.0.0
- Release Date:
2021-11-5
New Features
Introduce the following new information model and data model:
simplified k8s resource model
Bug Fixes
Security Notes
Modeling code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found.
Quick Links: - Modeling project page - Passing Badge information for Modeling
- Known Issues
None
- Upgrade Notes
None
- Other
None
Version: 8.0.0
- Release Date:
2021-4-12
New Features
Introduce the following new information models:
location model
VES model v7.2 update to include standard defined domain
VNFD model enhancement to support CNF
Bug Fixes
Security Notes
Modeling code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found.
Quick Links: - Modeling project page - Passing Badge information for Modeling
- Known Issues
None
- Upgrade Notes
Update VNFD information model to align with ETSI NFV spec v3.3.1 and v4.1.1.
- Other
None
Version: 7.0.0
- Release Date:
2020-11-12
- New Features
None
Bug Fixes
Security Notes
Modeling code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found.
Quick Links: - Modeling project page - Passing Badge information for Modeling
- Known Issues
None
- Upgrade Notes
Update VNFD information model to align with ETSI NFV spec v2.7.1.
- Other
None
Version: 6.0.0
- Release Date:
2020-05-24
New Features
Introduce the following new information models:
dynamic parameters
selection criteria
license management
Enhance service information model for nested and shared service.
Bug Fixes
Security Notes
Modeling code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found.
Quick Links: - Modeling project page - Passing Badge information for Modeling
- Known Issues
None
- Upgrade Notes
Update root hierarchy information model.
- Other
None
Version: 5.0.0
- Release Date:
2019-09-17
New Features
Introduce root/core model for the information model. Introduce VES 7.1 model. Introduce business and interaction model.
Bug Fixes
Security Notes
Modeling code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found.
Quick Links: - Modeling project page - Passing Badge information for Modeling
- Known Issues
None
- Upgrade Notes
None
- Other
None
Version: 4.0.0
- Release Date:
2019-05-27
New Features
Introduce new PNFD onboarding model. Introduce generic parser.
Bug Fixes
Security Notes
Modeling code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found.
Quick Links: - Modeling project page - Passing Badge information for Modeling
- Known Issues
None
Upgrade Notes
Update VNFD information and data model to align with ETSI NFV IFA011/SOL001 v2.5.1 specifications.
- Other
None
Version: 3.1.1
- Release Date:
2018-11-07
New Features
Define design time VNFD model information model and onboarding data model specifications based on ETSI NFV specifications IFA011 and SOL001.
Bug Fixes
Security Notes
Modeling code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found.
Quick Links: - Modeling project page - Passing Badge information for Modeling
- Known Issues
None
- Upgrade Notes
None
- Other
None