diff options
| author |   yxpoke <yangxu5@huawei.com> | 2021-05-09 17:42:31 +0800 |
|---|---|---|
| committer | yxpoke <yangxu5@huawei.com> | 2021-05-09 17:42:31 +0800 |
| commit | e218e53b51cc1b57d7a4030a9cced975565c95dd (patch) | |
| tree | 5602b3546414081fce49a9e543bb5c842c9ab1e7 | |
| parent | 7d61dd242794d0348dab184f90e1867440adc71b (diff) | |
model spec update for VES v7.2
Issue-ID: MODELING-517
Signed-off-by: yxpoke <yangxu5@huawei.com>
Change-Id: Idcfe7fcf6a2ea9e766850f8be54de6937cf7cdbb
16 files changed, 8334 insertions, 12452 deletions
diff --git a/docs/ONAP Model Spec/im/VES/VES index.rst b/docs/ONAP Model Spec/im/VES/VES index.rst index 2440f38..70ea090 100644 --- a/docs/ONAP Model Spec/im/VES/VES index.rst +++ b/docs/ONAP Model Spec/im/VES/VES index.rst @@ -1,4 +1,4 @@ -.. Copyright 2019 +.. Copyright 2021 .. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE .. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode @@ -8,7 +8,9 @@ VES Model .. toctree:: :maxdepth: 2 + VES-diagram VES-class-1 VES-class-2 + VES-association VES-datatype - VES-enumeration
\ No newline at end of file + VES-enumeration diff --git a/docs/ONAP Model Spec/im/VES/VES-association.rst b/docs/ONAP Model Spec/im/VES/VES-association.rst new file mode 100644 index 0000000..2f71a7a --- /dev/null +++ b/docs/ONAP Model Spec/im/VES/VES-association.rst @@ -0,0 +1,428 @@ +.. Copyright 2021 +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +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 +================== =========== ========== ======== ========= ============================= diff --git a/docs/ONAP Model Spec/im/VES/VES-class-1.rst b/docs/ONAP Model Spec/im/VES/VES-class-1.rst index aa30e95..3a5b091 100644 --- a/docs/ONAP Model Spec/im/VES/VES-class-1.rst +++ b/docs/ONAP Model Spec/im/VES/VES-class-1.rst @@ -9,7543 +9,4878 @@ VES Class Definition - part 1 :depth: 3 .. -CodecsInUse class -^^^^^^^^^^^^^^^^^ +CmNotify +~~~~~~~~ -**Qualified Name:** Ves::ObjectClasses::CodecsInUse +**Parent class:** VesEvent + +Applied stereotypes: + +- OpenModelClass -**Description:** +- **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 + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +cmNotifyFieldsVersion String 1 OpenModelAttribute Version of the cmNotify Ves::Diagrams::CmNotify::cmNotifyFieldsVersion + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +correlatedNotifications invalid 0..\* OpenModelAttribute Notifications to which this notification is considered to be correlated Ves::Diagrams::CmNotify::correlatedNotifications + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +eventTime DateTime 1 OpenModelAttribute Time of the cmNotify event. Ves::Diagrams::CmNotify::eventTime + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +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 + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sourceIndicator SourceIndicator 0..1 OpenModelAttribute Indicates the source of the operation that led to the generation of the notification. Ves::Diagrams::CmNotify::sourceIndicator + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +systemDN String 0..1 OpenModelAttribute DN of the management service provider Ves::Diagrams::CmNotify::systemDN + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_cmnotif cmNotif 1..\* OpenModelAttribute Array of cmNotif notificatons Ves::Diagrams::CmNotify::_cmnotif + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +domain Domain 1 Experimental Update in definition only Ves::ObjectClasses::VesEvent::domain + + OpenModelAttribute Event domain enumeration: 'cmNotify','fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +eventType String 0..1 Preliminary For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' Ves::ObjectClasses::VesEvent::eventType + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +lastEpochMicrosec Number 1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfcNamingCode String 0..1 Preliminary Network function component type: 3 characters (aligned with vfc naming standards) Ves::ObjectClasses::VesEvent::nfcNamingCode + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfNamingCode String 0..1 Preliminary Network function type: 4 characters (aligned with vnf and pnf naming standards) Ves::ObjectClasses::VesEvent::nfNamingCode + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfVendorName String 1 Preliminary Network function vendor name Ves::ObjectClasses::VesEvent::nfVendorName + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +priority Priority 1 Preliminary Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' Ves::ObjectClasses::VesEvent::priority + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +reportingEntityId String 0..1 Preliminary 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. Ves::ObjectClasses::VesEvent::reportingEntityId + + OpenModelAttribute 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. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +reportingEntityName String 1 Preliminary 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. Ves::ObjectClasses::VesEvent::reportingEntityName + + OpenModelAttribute 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. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sequence Integer 1 Preliminary sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ves::ObjectClasses::VesEvent::sequence + + OpenModelAttribute Ordering of events communicated by an event source instance (or 0 if not needed) + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sourceId String 0..1 Preliminary 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. Ves::ObjectClasses::VesEvent::sourceId + + OpenModelAttribute 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. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sourceName String 1 Preliminary 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 + + OpenModelAttribute 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. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +startingEpochMicrosec Number 1 Preliminary 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…). Ves::ObjectClasses::VesEvent::startingEpochMicrosec + 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). + OpenModelAttribute + 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) + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +timeZoneOffset String 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +version String 1 Preliminary Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. Ves::ObjectClasses::VesEvent::version + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +vesEventListenerVersion String 1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +name String 1 Preliminary Ves::ObjectClasses::VesEvent::name + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +Status String 0..1 Preliminary The current condition of an interaction, such as open, in research, closed, and so forth Common::Business Interaction::ObjectClasses::BusinessInteraction::Status + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +description String 0..1 Preliminary Defines a textual free-form description of the object. Common::Root::RootObjectClasses::RootEntity::description + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +id Identifier 1 Preliminary Identifier of this information element. This attribute shall be globally unique. Common::Root::RootObjectClasses::RootEntity::id + + OpenModelAttribute Unambiguously distinguishes different object instances. It is the naming attribute of the object. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +======================= =============== ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== + +CodecsInUse +~~~~~~~~~~~ The codecsInUse datatype consists of the following fields describing the number of times an identified codec was used over the measurementInterval -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class CodecsInUse** - -================== ======== ========= ============================= ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -================== ======== ========= ============================= ===================== -codecIdentifier String 1 Description of the codec. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -numberInUse Integer 1 Number of such codecs in use. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -================== ======== ========= ============================= ===================== - -CpuUsage class -^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::CpuUsage - -**Description:** +================== ======== ========= ================================== ============================= ================================================ +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +codecIdentifier String 1 Preliminary Description of the codec. Ves::ObjectClasses::CodecsInUse::codecIdentifier + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +numberInUse Integer 1 Preliminary Number of such codecs in use. Ves::ObjectClasses::CodecsInUse::numberInUse + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= ================================== ============================= ================================================ + +CpuUsage +~~~~~~~~ The cpuUsage datatype defines the usage of an identifier CPU and consists of the following fields: -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class CpuUsage** - -===================== ======== ========= ================================================================================================================================= ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -===================== ======== ========= ================================================================================================================================= ===================== -cpuCapacityContention Number 0..1 The amount of time the CPU cannot run due to contention, in milliseconds over the measurementInterval OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -cpuDemandAvg Number 0..1 The total CPU time that the NF/NFC/VM could use if there was no contention, in milliseconds over the measurementInterval OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -cpuDemandMhz Number 0..1 CPU demand in MHz OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -cpuDemandPct Number 0..1 CPU demand as a percentage of the provisioned capacity OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -cpuIdentifier String 1 CPU Identifier OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -cpuIdle Number 0..1 Percentage of CPU time spent in the idle task OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -cpuLatencyAvg Number 0..1 cpuDemandAvg - The total CPU time that the VNF/VNFC/VM could use if there is no contention, in milliseconds. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -cpuOverheadAvg Number 0..1 The overhead demand above available allocations and reservations, in milliseconds over the measurementInterval OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -cpuSwapWaitTime Number 0..1 Swap wait time, in milliseconds over the measurementInterval OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -cpuUsageInterrupt Number 0..1 Percentage of time spent servicing interrupts OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -cpuUsageNice Number 0..1 Percentage of time spent running user space processes that have been niced OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -cpuUsageSoftIrq Number 0..1 Percentage of time spent handling soft irq interrupts OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -cpuUsageSteal Number 0..1 Percentage of time spent in involuntary wait which is neither user, system or idle time and is effectively time that went missing OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -cpuUsageSystem Number 0..1 Percentage of time spent on system tasks running the kernel OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -cpuUsageUser Number 0..1 Percentage of time spent running un-niced user space processes OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -cpuWait Number 0..1 Percentage of CPU time spent waiting for I/O operations to complete OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -percentUsage Number 1 Aggregate cpu usage of the virtual machine on which the xNFC reporting the event is running OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -===================== ======== ========= ================================================================================================================================= ===================== - -DiskUsage class -^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::DiskUsage - -**Description:** +===================== ======== ========= ================================== ================================================================================================================================= =================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +cpuCapacityContention Number 0..1 Preliminary The amount of time the CPU cannot run due to contention, in milliseconds over the measurementInterval Ves::ObjectClasses::CpuUsage::cpuCapacityContention + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +cpuDemandAvg Number 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +cpuDemandMhz Number 0..1 Preliminary CPU demand in MHz Ves::ObjectClasses::CpuUsage::cpuDemandMhz + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +cpuDemandPct Number 0..1 Preliminary CPU demand as a percentage of the provisioned capacity Ves::ObjectClasses::CpuUsage::cpuDemandPct + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +cpuIdentifier String 1 Preliminary CPU Identifier Ves::ObjectClasses::CpuUsage::cpuIdentifier + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +cpuIdle Number 0..1 Preliminary Percentage of CPU time spent in the idle task Ves::ObjectClasses::CpuUsage::cpuIdle + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +cpuLatencyAvg Number 0..1 Preliminary cpuDemandAvg - The total CPU time that the VNF/VNFC/VM could use if there is no contention, in milliseconds. Ves::ObjectClasses::CpuUsage::cpuLatencyAvg + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +cpuOverheadAvg Number 0..1 Preliminary The overhead demand above available allocations and reservations, in milliseconds over the measurementInterval Ves::ObjectClasses::CpuUsage::cpuOverheadAvg + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +cpuSwapWaitTime Number 0..1 Preliminary Swap wait time, in milliseconds over the measurementInterval Ves::ObjectClasses::CpuUsage::cpuSwapWaitTime + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +cpuUsageInterrupt Number 0..1 Preliminary Percentage of time spent servicing interrupts Ves::ObjectClasses::CpuUsage::cpuUsageInterrupt + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +cpuUsageNice Number 0..1 Preliminary Percentage of time spent running user space processes that have been niced Ves::ObjectClasses::CpuUsage::cpuUsageNice + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +cpuUsageSoftIrq Number 0..1 Preliminary Percentage of time spent handling soft irq interrupts Ves::ObjectClasses::CpuUsage::cpuUsageSoftIrq + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +cpuUsageSteal Number 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +cpuUsageSystem Number 0..1 Preliminary Percentage of time spent on system tasks running the kernel Ves::ObjectClasses::CpuUsage::cpuUsageSystem + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +cpuUsageUser Number 0..1 Preliminary Percentage of time spent running un-niced user space processes Ves::ObjectClasses::CpuUsage::cpuUsageUser + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +cpuWait Number 0..1 Preliminary Percentage of CPU time spent waiting for I/O operations to complete Ves::ObjectClasses::CpuUsage::cpuWait + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +percentUsage Number 1 Preliminary Aggregate cpu usage of the virtual machine on which the xNFC reporting the event is running Ves::ObjectClasses::CpuUsage::percentUsage + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +===================== ======== ========= ================================== ================================================================================================================================= =================================================== + +DiskUsage +~~~~~~~~~ The diskUsage datatype defines the usage of a disk device. -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class DiskUsage** - -========================= ======== ========= ============================================================================================================================================================================================================================ ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -========================= ======== ========= ============================================================================================================================================================================================================================ ===================== -diskBusResets Number 0..1 The number of bus resets in the performance interval. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskCommandsAborted Number 0..1 Number of disk commands aborted over the measurementInterval. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskCommandsAvg Number 0..1 Average number of commands per second over the measurementInterval. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskFlushRequests Number 0..1 Total flush requests of the disk cache over the measurementInterval. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskFlushTime Number 0..1 Milliseconds spent on disk cache flushing over the measurementInterval. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskIdentifier String 1 Disk Identifier. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskIoTimeAvg Number 1 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 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskIoTimeLast Number 0..1 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. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskIoTimeMax Number 0..1 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 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskIoTimeMin Number 0..1 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. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskMergedReadAvg Number 0..1 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. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskMergedReadLast Number 0..1 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. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskMergedReadMax Number 0..1 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. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskMergedReadMin Number 0..1 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. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskMergedWriteAvg Number 0..1 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 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskMergedWriteLast Number 0..1 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. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskMergedWriteMax Number 0..1 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. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskMergedWriteMin Number 0..1 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. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskOctetsReadAvg Number 0..1 Number of octets per second read from a disk or partition; provide the average measurement within the measurement interval. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskOctetsReadLast Number 0..1 Number of octets per second read from a disk or partition; provide the last measurement within the measurement interval OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskOctetsReadMax Number 0..1 Number of octets per second read from a disk or partition; provide the maximum measurement within the measurement interval. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskOctetsReadMin Number 0..1 Number of octets per second read from a disk or partition; provide the minimum measurement within the measurement interval. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskOctetsWriteAvg Number 0..1 Number of octets per second written to a disk or partition; provide the average measurement within the measurement interval. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskOctetsWriteLast Number 0..1 Number of octets per second written to a disk or partition; provide the last measurement within the measurement interval. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskOctetsWriteMax Number 0..1 Number of octets per second written to a disk or partition; provide the maximum measurement within the measurement interval. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskOctetsWriteMin Number 0..1 Number of octets per second written to a disk or partition; provide the minimum measurement within the measurement interval. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskOpsReadAvg Number 0..1 Number of read operations per second issued to the disk; provide the average measurement within the measurement interval. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskOpsReadLast Number 0..1 Number of read operations per second issued to the disk; provide the last measurement within the measurement interval. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskOpsReadMax Number 0..1 Number of read operations per second issued to the disk; provide the maximum measurement within the measurement interval. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskOpsReadMin Number 0..1 Number of read operations per second issued to the disk; provide the minimum measurement within the measurement interval. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskOpsWriteAvg Number 0..1 Number of write operations per second issued to the disk; provide the average measurement within the measurement interval. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskOpsWriteLast Number 0..1 Number of write operations per second issued to the disk; provide the last measurement within the measurement interval. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskOpsWriteMax Number 0..1 Number of write operations per second issued to the disk; provide the maximum measurement within the measurement interval. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskOpsWriteMin Number 0..1 Number of write operations per second issued to the disk; provide the minimum measurement within the measurement interval. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskPendingOperationsAvg Number 0..1 Queue size of pending I/O operations per second; provide the average measurement within the measurement interval. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskPendingOperationsLast Number 0..1 Queue size of pending I/O operations per second; provide the last measurement within the measurement interval. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskPendingOperationsMax Number 0..1 Queue size of pending I/O operations per second; provide the maximum measurement within the measurement interval. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskPendingOperationsMin Number 0..1 diskPendingOperationsMin - Queue size of pending I/O operations per second; provide the minimum measurement within the measurement interval. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskReadCommandsAvg Number 0..1 Average number of read commands issued per second to the disk over the measurementInterval. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskTime Number 0..1 Nanoseconds spent on disk cache reads/writes within the measurementInterval. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskTimeReadAvg Number 0..1 Milliseconds a read operation took to complete; provide the average measurement within the measurement interval. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskTimeReadLast Number 0..1 Milliseconds a read operation took to complete; provide the last measurement within the measurement interval. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskTimeReadMax Number 0..1 Milliseconds a read operation took to complete; provide the maximum measurement within the measurement interval. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskTimeReadMin Number 0..1 Milliseconds a read operation took to complete; provide the minimum measurement within the measurement interval. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskTimeWriteAvg Number 0..1 Milliseconds a write operation took to complete; provide the average measurement within the measurement interval. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskTimeWriteLast Number 0..1 Milliseconds a write operation took to complete; provide the last measurement within the measurement interval. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskTimeWriteMax Number 0..1 Milliseconds a write operation took to complete; provide the maximum measurement within the measurement interval. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskTimeWriteMin Number 0..1 Milliseconds a write operation took to complete; provide the minimum measurement within the measurement interval. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskTotalReadLatencyAvg Number 0..1 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. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskTotalWriteLatencyAvg Number 0..1 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. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskWeightedIoTimeAvg Number 0..1 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. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskWeightedIoTimeLast Number 0..1 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. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskWeightedIoTimeMax Number 0..1 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. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskWeightedIoTimeMin Number 0..1 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. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -diskWriteCommandsAvg Number 0..1 Average number of write commands issued per second to the disk over the measurementInterval OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -========================= ======== ========= ============================================================================================================================================================================================================================ ===================== - -EndOfCallVqmSummaries class -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::EndOfCallVqmSummaries - -**Applied Stereotypes:** +========================= ======== ========= ================================== ============================================================================================================================================================================================================================ ======================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +diskBusResets Number 0..1 Preliminary The number of bus resets in the performance interval. Ves::ObjectClasses::DiskUsage::diskBusResets + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskCommandsAborted Number 0..1 Preliminary Number of disk commands aborted over the measurementInterval. Ves::ObjectClasses::DiskUsage::diskCommandsAborted + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskCommandsAvg Number 0..1 Preliminary Average number of commands per second over the measurementInterval. Ves::ObjectClasses::DiskUsage::diskCommandsAvg + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskFlushRequests Number 0..1 Preliminary Total flush requests of the disk cache over the measurementInterval. Ves::ObjectClasses::DiskUsage::diskFlushRequests + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskFlushTime Number 0..1 Preliminary Milliseconds spent on disk cache flushing over the measurementInterval. Ves::ObjectClasses::DiskUsage::diskFlushTime + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskIdentifier String 1 Preliminary Disk Identifier. Ves::ObjectClasses::DiskUsage::diskIdentifier + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskIoTimeAvg Number 1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskIoTimeLast Number 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskIoTimeMax Number 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskIoTimeMin Number 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskMergedReadAvg Number 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskMergedReadLast Number 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskMergedReadMax Number 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskMergedReadMin Number 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskMergedWriteAvg Number 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskMergedWriteLast Number 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskMergedWriteMax Number 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskMergedWriteMin Number 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskOctetsReadAvg Number 0..1 Preliminary Number of octets per second read from a disk or partition; provide the average measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskOctetsReadAvg + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskOctetsReadLast Number 0..1 Preliminary Number of octets per second read from a disk or partition; provide the last measurement within the measurement interval Ves::ObjectClasses::DiskUsage::diskOctetsReadLast + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskOctetsReadMax Number 0..1 Preliminary Number of octets per second read from a disk or partition; provide the maximum measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskOctetsReadMax + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskOctetsReadMin Number 0..1 Preliminary Number of octets per second read from a disk or partition; provide the minimum measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskOctetsReadMin + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskOctetsWriteAvg Number 0..1 Preliminary Number of octets per second written to a disk or partition; provide the average measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskOctetsWriteAvg + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskOctetsWriteLast Number 0..1 Preliminary Number of octets per second written to a disk or partition; provide the last measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskOctetsWriteLast + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskOctetsWriteMax Number 0..1 Preliminary Number of octets per second written to a disk or partition; provide the maximum measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskOctetsWriteMax + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskOctetsWriteMin Number 0..1 Preliminary Number of octets per second written to a disk or partition; provide the minimum measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskOctetsWriteMin + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskOpsReadAvg Number 0..1 Preliminary Number of read operations per second issued to the disk; provide the average measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskOpsReadAvg + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskOpsReadLast Number 0..1 Preliminary Number of read operations per second issued to the disk; provide the last measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskOpsReadLast + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskOpsReadMax Number 0..1 Preliminary Number of read operations per second issued to the disk; provide the maximum measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskOpsReadMax + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskOpsReadMin Number 0..1 Preliminary Number of read operations per second issued to the disk; provide the minimum measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskOpsReadMin + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskOpsWriteAvg Number 0..1 Preliminary Number of write operations per second issued to the disk; provide the average measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskOpsWriteAvg + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskOpsWriteLast Number 0..1 Preliminary Number of write operations per second issued to the disk; provide the last measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskOpsWriteLast + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskOpsWriteMax Number 0..1 Preliminary Number of write operations per second issued to the disk; provide the maximum measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskOpsWriteMax + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskOpsWriteMin Number 0..1 Preliminary Number of write operations per second issued to the disk; provide the minimum measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskOpsWriteMin + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskPendingOperationsAvg Number 0..1 Preliminary Queue size of pending I/O operations per second; provide the average measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskPendingOperationsAvg + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskPendingOperationsLast Number 0..1 Preliminary Queue size of pending I/O operations per second; provide the last measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskPendingOperationsLast + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskPendingOperationsMax Number 0..1 Preliminary Queue size of pending I/O operations per second; provide the maximum measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskPendingOperationsMax + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskPendingOperationsMin Number 0..1 Preliminary diskPendingOperationsMin - Queue size of pending I/O operations per second; provide the minimum measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskPendingOperationsMin + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskReadCommandsAvg Number 0..1 Preliminary Average number of read commands issued per second to the disk over the measurementInterval. Ves::ObjectClasses::DiskUsage::diskReadCommandsAvg + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskTime Number 0..1 Preliminary Nanoseconds spent on disk cache reads/writes within the measurementInterval. Ves::ObjectClasses::DiskUsage::diskTime + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskTimeReadAvg Number 0..1 Preliminary Milliseconds a read operation took to complete; provide the average measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskTimeReadAvg + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskTimeReadLast Number 0..1 Preliminary Milliseconds a read operation took to complete; provide the last measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskTimeReadLast + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskTimeReadMax Number 0..1 Preliminary Milliseconds a read operation took to complete; provide the maximum measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskTimeReadMax + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskTimeReadMin Number 0..1 Preliminary Milliseconds a read operation took to complete; provide the minimum measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskTimeReadMin + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskTimeWriteAvg Number 0..1 Preliminary Milliseconds a write operation took to complete; provide the average measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskTimeWriteAvg + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskTimeWriteLast Number 0..1 Preliminary Milliseconds a write operation took to complete; provide the last measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskTimeWriteLast + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskTimeWriteMax Number 0..1 Preliminary Milliseconds a write operation took to complete; provide the maximum measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskTimeWriteMax + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskTimeWriteMin Number 0..1 Preliminary Milliseconds a write operation took to complete; provide the minimum measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskTimeWriteMin + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskTotalReadLatencyAvg Number 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskTotalWriteLatencyAvg Number 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskWeightedIoTimeAvg Number 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskWeightedIoTimeLast Number 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskWeightedIoTimeMax Number 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskWeightedIoTimeMin Number 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +diskWriteCommandsAvg Number 0..1 Preliminary Average number of write commands issued per second to the disk over the measurementInterval Ves::ObjectClasses::DiskUsage::diskWriteCommandsAvg + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +========================= ======== ========= ================================== ============================================================================================================================================================================================================================ ======================================================== + +EndOfCallVqmSummaries +~~~~~~~~~~~~~~~~~~~~~ + +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class EndOfCallVqmSummaries** - -============================= =================== ========= ============================================================================================================================================================================================================== ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -============================= =================== ========= ============================================================================================================================================================================================================== ===================== -adjacencyName String 1 Adjacency name OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -endpointAverageJitter Number 0..1 Endpoint average jitter OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -endpointDescription EndpointDescription 1 Enumeration: 'Caller', 'Callee' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -endpointMaxJitter Number 0..1 Endpoint maximum jitter OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -endpointRtpOctetsDiscarded Number 0..1 Endpoint RTP octets discarded OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -endpointRtpOctetsLost Number 0..1 Endpoint RTP octets lost OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -endpointRtpOctetsReceived Number 0..1 Endpoint RTP octets received OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -endpointRtpOctetsSent Number 0..1 Endpoint RTP octets sent OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -endpointRtpPacketsDiscarded Number 0..1 Endpoint RTP packets discarded OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -endpointRtpPacketsLost Number 0..1 Endpoint RTP packets lost OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -endpointRtpPacketsReceived Number 0..1 Endpoint RTP packets received OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -endpointRtpPacketsSent Number 0..1 Endpoint RTP packets sent OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -localAverageJitter Number 0..1 Local average jitter OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -localAverageJitterBufferDelay Number 0..1 Local average jitter buffer delay OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -localMaxJitter Number 0..1 Local maximum jitter OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -localMaxJitterBufferDelay Number 0..1 Local max jitter buffer delay OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -localRtpOctetsDiscarded Number 0..1 Local RTP octets discarded OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -localRtpOctetsLost Number 0..1 Local RTP octets lost OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -localRtpOctetsReceived Number 0..1 Local RTP octets received OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -localRtpOctetsSent Number 0..1 Local RTP octets sent OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -localRtpPacketsDiscarded Number 0..1 Local RTP packets discarded OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -localRtpPacketsLost Number 0..1 Local RTP packets lost OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -localRtpPacketsReceived Number 0..1 Local RTP packets received OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -localRtpPacketsSent Number 0..1 Local RTP packets sent OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -mosCqe Number 0..1 Decimal range from 1 to 5 (1 decimal place) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -oneWayDelay Number 0..1 one-way path delay in milliseconds OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -packetLossPercent Number 0..1 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) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -rFactor Number 0..1 rFactor from 0 to 100 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -roundTripDelay Number 0..1 Round trip delay in milliseconds OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -============================= =================== ========= ============================================================================================================================================================================================================== ===================== - -Fault class -^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::Fault - -**Description:** +============================= =================== ========= ================================== ============================================================================================================================================================================================================== ======================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +adjacencyName String 1 Preliminary Adjacency name Ves::ObjectClasses::EndOfCallVqmSummaries::adjacencyName + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +endpointAverageJitter Number 0..1 Preliminary Endpoint average jitter Ves::ObjectClasses::EndOfCallVqmSummaries::endpointAverageJitter + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +endpointDescription EndpointDescription 1 Preliminary Enumeration: 'Caller', 'Callee' Ves::ObjectClasses::EndOfCallVqmSummaries::endpointDescription + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +endpointMaxJitter Number 0..1 Preliminary Endpoint maximum jitter Ves::ObjectClasses::EndOfCallVqmSummaries::endpointMaxJitter + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +endpointRtpOctetsDiscarded Number 0..1 Preliminary Endpoint RTP octets discarded Ves::ObjectClasses::EndOfCallVqmSummaries::endpointRtpOctetsDiscarded + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +endpointRtpOctetsLost Number 0..1 Preliminary Endpoint RTP octets lost Ves::ObjectClasses::EndOfCallVqmSummaries::endpointRtpOctetsLost + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +endpointRtpOctetsReceived Number 0..1 Preliminary Endpoint RTP octets received Ves::ObjectClasses::EndOfCallVqmSummaries::endpointRtpOctetsReceived + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +endpointRtpOctetsSent Number 0..1 Preliminary Endpoint RTP octets sent Ves::ObjectClasses::EndOfCallVqmSummaries::endpointRtpOctetsSent + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +endpointRtpPacketsDiscarded Number 0..1 Preliminary Endpoint RTP packets discarded Ves::ObjectClasses::EndOfCallVqmSummaries::endpointRtpPacketsDiscarded + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +endpointRtpPacketsLost Number 0..1 Preliminary Endpoint RTP packets lost Ves::ObjectClasses::EndOfCallVqmSummaries::endpointRtpPacketsLost + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +endpointRtpPacketsReceived Number 0..1 Preliminary Endpoint RTP packets received Ves::ObjectClasses::EndOfCallVqmSummaries::endpointRtpPacketsReceived + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +endpointRtpPacketsSent Number 0..1 Preliminary Endpoint RTP packets sent Ves::ObjectClasses::EndOfCallVqmSummaries::endpointRtpPacketsSent + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +localAverageJitter Number 0..1 Preliminary Local average jitter Ves::ObjectClasses::EndOfCallVqmSummaries::localAverageJitter + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +localAverageJitterBufferDelay Number 0..1 Preliminary Local average jitter buffer delay Ves::ObjectClasses::EndOfCallVqmSummaries::localAverageJitterBufferDelay + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +localMaxJitter Number 0..1 Preliminary Local maximum jitter Ves::ObjectClasses::EndOfCallVqmSummaries::localMaxJitter + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +localMaxJitterBufferDelay Number 0..1 Preliminary Local max jitter buffer delay Ves::ObjectClasses::EndOfCallVqmSummaries::localMaxJitterBufferDelay + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +localRtpOctetsDiscarded Number 0..1 Preliminary Local RTP octets discarded Ves::ObjectClasses::EndOfCallVqmSummaries::localRtpOctetsDiscarded + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +localRtpOctetsLost Number 0..1 Preliminary Local RTP octets lost Ves::ObjectClasses::EndOfCallVqmSummaries::localRtpOctetsLost + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +localRtpOctetsReceived Number 0..1 Preliminary Local RTP octets received Ves::ObjectClasses::EndOfCallVqmSummaries::localRtpOctetsReceived + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +localRtpOctetsSent Number 0..1 Preliminary Local RTP octets sent Ves::ObjectClasses::EndOfCallVqmSummaries::localRtpOctetsSent + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +localRtpPacketsDiscarded Number 0..1 Preliminary Local RTP packets discarded Ves::ObjectClasses::EndOfCallVqmSummaries::localRtpPacketsDiscarded + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +localRtpPacketsLost Number 0..1 Preliminary Local RTP packets lost Ves::ObjectClasses::EndOfCallVqmSummaries::localRtpPacketsLost + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +localRtpPacketsReceived Number 0..1 Preliminary Local RTP packets received Ves::ObjectClasses::EndOfCallVqmSummaries::localRtpPacketsReceived + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +localRtpPacketsSent Number 0..1 Preliminary Local RTP packets sent Ves::ObjectClasses::EndOfCallVqmSummaries::localRtpPacketsSent + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +mosCqe Number 0..1 Preliminary Decimal range from 1 to 5 (1 decimal place) Ves::ObjectClasses::EndOfCallVqmSummaries::mosCqe + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +oneWayDelay Number 0..1 Preliminary one-way path delay in milliseconds Ves::ObjectClasses::EndOfCallVqmSummaries::oneWayDelay + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +packetLossPercent Number 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +rFactor Number 0..1 Preliminary rFactor from 0 to 100 Ves::ObjectClasses::EndOfCallVqmSummaries::rFactor + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +roundTripDelay Number 0..1 Preliminary Round trip delay in milliseconds Ves::ObjectClasses::EndOfCallVqmSummaries::roundTripDelay + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +============================= =================== ========= ================================== ============================================================================================================================================================================================================== ======================================================================== + +Fault +~~~~~ Fields specific to fault events **Parent class:** VesEvent -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class Fault** - -========================== ============= ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -========================== ============= ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== -alarmAdditionalInformation HashMap 0..1 Additional alarm information. OpenModelAttribute - • 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'. - partOfObjectKey: 0 - Could contain managed object instance as separate key:value; could add probable cause as separate key:value. - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -alarmCondition String 1 Short name of the alarm condition/problem, such as a trap name. Should not have white space (e.g., tpLgCgiNotInConfig, BfdSessionDown, linkDown, etc…) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -alarmInterfaceA String 0..1 Card, port, channel or interface name of the device generating the alarm. This could reflect managed object. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -eventCatagory String 0..1 Event category, for example: 'license', 'link', 'routing', 'security', 'signaling' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -eventSeverity EventSeverity 1 Event severity enumeration: 'CRITICAL', 'MAJOR', 'MINOR', 'WARNING', 'NORMAL'. NORMAL is used to represent clear. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -eventSourceType String 1 Examples: 'card', 'host', 'other', 'port', 'portThreshold', 'router', 'slotThreshold', 'switch', 'virtualMachine', 'virtualNetworkFunction'. This could be managed object class. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -faultFieldsVersion String 1 Version of the faultFields block as "#.#" where # is a digit; see section 1 for the correct digits to use. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -specificProblem String 1 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. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -vfStatus VfStatus 1 Virtual function status enumeration: 'Active', 'Idle', 'Preparing to terminate', 'Ready to terminate', 'Requesting Termination' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -domain Domain 1 Event domain enumeration: 'fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -eventType String 0..1 For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -lastEpochMicrosec Number 1 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 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfcNamingCode String 0..1 Network function component type: 3 characters (aligned with vfc naming standards) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfNamingCode String 0..1 Network function type: 4 characters (aligned with vnf and pnf naming standards) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfVendorName String 1 Network function vendor name OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -priority Priority 1 Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -reportingEntityId String 0..1 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. OpenModelAttribute - - | reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. - partOfObjectKey: 0 - | 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. - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -reportingEntityName String 1 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. 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. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sequence Integer 1 sequence - Ordering of events communicated by an event source instance (or 0 if not needed) OpenModelAttribute - - Ordering of events communicated by an event source instance (or 0 if not needed) - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sourceId String 0..1 | sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity OpenModelAttribute - | 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. - - partOfObjectKey: 0 - 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. - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sourceName String 1 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. 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. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -startingEpochMicrosec Number 1 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) 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…). - partOfObjectKey: 0 - | 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). - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -timeZoneOffset String 0..1 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 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -version String 1 Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -vesEventListenerVersion String 1 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). OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -name String 1 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -Status String 0..1 The current condition of an interaction, such as open, in research, closed, and so forth OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -description String 0..1 Defines a textual free-form description of the object. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -id Identifier 1 Identifier of this information element. This attribute shall be globally unique. OpenModelAttribute - - Unambiguously distinguishes different object instances. It is the naming attribute of the object. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -========================== ============= ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== - -FilesystemUsage class -^^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::FilesystemUsage - -**Description:** +========================== ============= ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +alarmAdditionalInformation HashMap 0..1 Preliminary Additional alarm information. Ves::ObjectClasses::Fault::alarmAdditionalInformation + ? Note1: for SNMP mapping to VES, for hash key use OID of varbind, for value use incoming data for that varbind). + OpenModelAttribute ? 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. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +alarmCondition String 1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +alarmInterfaceA String 0..1 Preliminary Card, port, channel or interface name of the device generating the alarm. This could reflect managed object. Ves::ObjectClasses::Fault::alarmInterfaceA + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +eventCatagory String 0..1 Preliminary Event category, for example: 'license', 'link', 'routing', 'security', 'signaling' Ves::ObjectClasses::Fault::eventCatagory + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +eventSeverity EventSeverity 1 Preliminary Event severity enumeration: 'CRITICAL', 'MAJOR', 'MINOR', 'WARNING', 'NORMAL'. NORMAL is used to represent clear. Ves::ObjectClasses::Fault::eventSeverity + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +eventSourceType String 1 Preliminary Examples: 'card', 'host', 'other', 'port', 'portThreshold', 'router', 'slotThreshold', 'switch', 'virtualMachine', 'virtualNetworkFunction'. This could be managed object class. Ves::ObjectClasses::Fault::eventSourceType + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +faultFieldsVersion String 1 Preliminary Version of the faultFields block as "#.#" where # is a digit; see section 1 for the correct digits to use. Ves::ObjectClasses::Fault::faultFieldsVersion + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +specificProblem String 1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +vfStatus VfStatus 1 Preliminary Virtual function status enumeration: 'Active', 'Idle', 'Preparing to terminate', 'Ready to terminate', 'Requesting Termination' Ves::ObjectClasses::Fault::vfStatus + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +domain Domain 1 Experimental Update in definition only Ves::ObjectClasses::VesEvent::domain + + OpenModelAttribute Event domain enumeration: 'cmNotify','fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +eventType String 0..1 Preliminary For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' Ves::ObjectClasses::VesEvent::eventType + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +lastEpochMicrosec Number 1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfcNamingCode String 0..1 Preliminary Network function component type: 3 characters (aligned with vfc naming standards) Ves::ObjectClasses::VesEvent::nfcNamingCode + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfNamingCode String 0..1 Preliminary Network function type: 4 characters (aligned with vnf and pnf naming standards) Ves::ObjectClasses::VesEvent::nfNamingCode + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfVendorName String 1 Preliminary Network function vendor name Ves::ObjectClasses::VesEvent::nfVendorName + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +priority Priority 1 Preliminary Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' Ves::ObjectClasses::VesEvent::priority + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +reportingEntityId String 0..1 Preliminary 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. Ves::ObjectClasses::VesEvent::reportingEntityId + + OpenModelAttribute 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. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +reportingEntityName String 1 Preliminary 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. Ves::ObjectClasses::VesEvent::reportingEntityName + + OpenModelAttribute 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. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sequence Integer 1 Preliminary sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ves::ObjectClasses::VesEvent::sequence + + OpenModelAttribute Ordering of events communicated by an event source instance (or 0 if not needed) + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sourceId String 0..1 Preliminary 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. Ves::ObjectClasses::VesEvent::sourceId + + OpenModelAttribute 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. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sourceName String 1 Preliminary 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 + + OpenModelAttribute 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. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +startingEpochMicrosec Number 1 Preliminary 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…). Ves::ObjectClasses::VesEvent::startingEpochMicrosec + 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). + OpenModelAttribute + 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) + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +timeZoneOffset String 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +version String 1 Preliminary Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. Ves::ObjectClasses::VesEvent::version + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +vesEventListenerVersion String 1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +name String 1 Preliminary Ves::ObjectClasses::VesEvent::name + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +Status String 0..1 Preliminary The current condition of an interaction, such as open, in research, closed, and so forth Common::Business Interaction::ObjectClasses::BusinessInteraction::Status + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +description String 0..1 Preliminary Defines a textual free-form description of the object. Common::Root::RootObjectClasses::RootEntity::description + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +id Identifier 1 Preliminary Identifier of this information element. This attribute shall be globally unique. Common::Root::RootObjectClasses::RootEntity::id + + OpenModelAttribute Unambiguously distinguishes different object instances. It is the naming attribute of the object. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +========================== ============= ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== + +FilesystemUsage +~~~~~~~~~~~~~~~ The filesystemUsage datatype consists of the following fields: -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class FilesystemUsage** - -=================== ======== ========= ===================================================== ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -=================== ======== ========= ===================================================== ===================== -blockConfigured Number 1 Configured block storage capacity in GB. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -blockops Number 1 Block storage input-output operations per second. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -blockUsed Number 1 Used block storage capacity in GB. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -ephemeralConfigured Number 1 Configured ephemeral storage capacity in GB. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -ephemerallops Number 1 Ephemeral storage input-output operations per second. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -ephemeralUsed Number 1 Used ephemeral storage capacity in GB. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -filesysytemName String 1 File system name. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -=================== ======== ========= ===================================================== ===================== - -GtpPerFlowMetrics class -^^^^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::GtpPerFlowMetrics - -**Applied Stereotypes:** +=================== ======== ========= ================================== ===================================================== ======================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +blockConfigured Number 1 Preliminary Configured block storage capacity in GB. Ves::ObjectClasses::FilesystemUsage::blockConfigured + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +blockops Number 1 Preliminary Block storage input-output operations per second. Ves::ObjectClasses::FilesystemUsage::blockops + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +blockUsed Number 1 Preliminary Used block storage capacity in GB. Ves::ObjectClasses::FilesystemUsage::blockUsed + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +ephemeralConfigured Number 1 Preliminary Configured ephemeral storage capacity in GB. Ves::ObjectClasses::FilesystemUsage::ephemeralConfigured + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +ephemerallops Number 1 Preliminary Ephemeral storage input-output operations per second. Ves::ObjectClasses::FilesystemUsage::ephemerallops + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +ephemeralUsed Number 1 Preliminary Used ephemeral storage capacity in GB. Ves::ObjectClasses::FilesystemUsage::ephemeralUsed + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +filesysytemName String 1 Preliminary File system name. Ves::ObjectClasses::FilesystemUsage::filesysytemName + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +=================== ======== ========= ================================== ===================================================== ======================================================== + +GtpPerFlowMetrics +~~~~~~~~~~~~~~~~~ + +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class GtpPerFlowMetrics** - -================================ ======== ========= ================================================================================================================================================================================================================================ ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -================================ ======== ========= ================================================================================================================================================================================================================================ ===================== -avgBitErrorRate Number 1 Average bit error rate OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -avgPacketDelayVariation Number 1 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 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -avgPacketLatency Number 1 Average delivery latency OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -avgReceiveThroughput Number 1 Average receive throughput OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -avgTransmitThroughput Number 1 Average transmit throughput OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -durConnectionFailedStatus Number 0..1 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 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -durTunnelFailedStatus Number 0..1 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 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -flowActivatedBy String 0..1 Endpoint activating the flow OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -flowActivationEpoch Number 1 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 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -flowActivationMicrosec Number 1 Integer microseconds for the start of the flow connection OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -flowActivationTime String 0..1 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' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -flowDeactivatedBy String 0..1 Endpoint deactivating the flow OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -flowDeactivationEpoch Number 1 Time for the start of the flow connection, in integer UTC epoch time aka UNIX time OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -flowDeactivationMicrosec Number 1 Integer microseconds for the start of the flow connection OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -flowDeactivationTime String 1 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' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -flowStatus String 1 Connection status at reporting time as a working / inactive / failed indicator value OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -gtpConnectionStatus String 0..1 Current connection state at reporting time OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -gtpTunnelStatus String 0..1 Current tunnel state at reporting time OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -ipTosCountList HashMap 0..1 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 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -ipTosList String 0..1 Array of unique IP Type-of-Service values observed in the flow where values range from '0' to '255' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -largePacketRtt Number 0..1 large packet round trip time OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -largePacketThreshold Number 0..1 large packet threshold being applied OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -maxPacketDelayVariation Number 0..1 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 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -maxReceiveBitRate Number 0..1 maximum receive bit rate OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -maxTransmitBitRate Number 0..1 maximum transmit bit rate OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -mobileQciCosCountList HashMap 0..1 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 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -mobileQciCosList String 0..1 Array of unique LTE QCI or UMTS class-of-service values observed in the flow OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -numActivationFailures Number 1 Number of failed activation requests, as observed by the reporting node OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -numBitErrors Number 1 number of errored bits OpenModelAttribute - - number of errored bits - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -numBytesReceived Number 1 number of bytes received, including retransmissions OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -numBytesTransmitted Number 1 number of bytes transmitted, including retransmissions OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -numDroppedPackets Number 1 number of received packets dropped due to errors per virtual interface OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -numGtpEchoFailures Number 0..1 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 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -numGtpTunnelErrors Number 0..1 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 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -numHttpErrors Number 0..1 Http error count OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -numL7BytesReceived Number 1 number of tunneled layer 7 bytes received, including retransmissions OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -numL7BytesTransmitted Number 1 number of tunneled layer 7 bytes received, including retransmissions OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -numLostPackets Number 1 number of tunneled layer 7 bytes received, including retransmissions OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -numOutOfOrderPackets Number 1 number of out-of-order packets OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -numPacketErrors Number 1 number of errored packets OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -numPacketsReceivedExclRetrans Number 1 number of packets received, excluding retransmission OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -numPacketsReceivedInclRetrans Number 1 number of packets received, including retransmission OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -numPacketsTransmittedInclRetrans Number 1 number of packets transmitted, including retransmissions OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -numRetries Number 1 number of packet retrie OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -numTimeouts Number 1 number of packet timeouts OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -numTunneledL7BytesReceived Number 1 number of tunneled layer 7 bytes received, excluding retransmissions OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -roundTripTime Number 1 Round Trip time OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -tcpFlagCountList HashMap 0..1 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 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -tcpFlagList String 0..1 Array of unique TCP Flags observed in the flow OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -timeToFirstByte Number 1 Time in milliseconds between the connection activation and first byte received OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -================================ ======== ========= ================================================================================================================================================================================================================================ ===================== - -Heartbeat class -^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::Heartbeat - -**Description:** +================================ ======== ========= ================================== =============================================================================================================================================================================================================== ======================================================================= +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +avgBitErrorRate Number 1 Preliminary Average bit error rate Ves::ObjectClasses::GtpPerFlowMetrics::avgBitErrorRate + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +avgPacketDelayVariation Number 1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +avgPacketLatency Number 1 Preliminary Average delivery latency Ves::ObjectClasses::GtpPerFlowMetrics::avgPacketLatency + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +avgReceiveThroughput Number 1 Preliminary Average receive throughput Ves::ObjectClasses::GtpPerFlowMetrics::avgReceiveThroughput + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +avgTransmitThroughput Number 1 Preliminary Average transmit throughput Ves::ObjectClasses::GtpPerFlowMetrics::avgTransmitThroughput + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +durConnectionFailedStatus Number 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +durTunnelFailedStatus Number 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +flowActivatedBy String 0..1 Preliminary Endpoint activating the flow Ves::ObjectClasses::GtpPerFlowMetrics::flowActivatedBy + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +flowActivationEpoch Number 1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +flowActivationMicrosec Number 1 Preliminary Integer microseconds for the start of the flow connection Ves::ObjectClasses::GtpPerFlowMetrics::flowActivationMicrosec + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +flowActivationTime String 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +flowDeactivatedBy String 0..1 Preliminary Endpoint deactivating the flow Ves::ObjectClasses::GtpPerFlowMetrics::flowDeactivatedBy + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +flowDeactivationEpoch Number 1 Preliminary Time for the start of the flow connection, in integer UTC epoch time aka UNIX time Ves::ObjectClasses::GtpPerFlowMetrics::flowDeactivationEpoch + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +flowDeactivationMicrosec Number 1 Preliminary Integer microseconds for the start of the flow connection Ves::ObjectClasses::GtpPerFlowMetrics::flowDeactivationMicrosec + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +flowDeactivationTime String 1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +flowStatus String 1 Preliminary Connection status at reporting time as a working / inactive / failed indicator value Ves::ObjectClasses::GtpPerFlowMetrics::flowStatus + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +gtpConnectionStatus String 0..1 Preliminary Current connection state at reporting time Ves::ObjectClasses::GtpPerFlowMetrics::gtpConnectionStatus + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +gtpTunnelStatus String 0..1 Preliminary Current tunnel state at reporting time Ves::ObjectClasses::GtpPerFlowMetrics::gtpTunnelStatus + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +ipTosCountList HashMap 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +ipTosList String 0..1 Preliminary Array of unique IP Type-of-Service values observed in the flow where values range from '0' to '255' Ves::ObjectClasses::GtpPerFlowMetrics::ipTosList + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +largePacketRtt Number 0..1 Preliminary large packet round trip time Ves::ObjectClasses::GtpPerFlowMetrics::largePacketRtt + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +largePacketThreshold Number 0..1 Preliminary large packet threshold being applied Ves::ObjectClasses::GtpPerFlowMetrics::largePacketThreshold + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +maxPacketDelayVariation Number 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +maxReceiveBitRate Number 0..1 Preliminary maximum receive bit rate" Ves::ObjectClasses::GtpPerFlowMetrics::maxReceiveBitRate + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +maxTransmitBitRate Number 0..1 Preliminary maximum transmit bit rate Ves::ObjectClasses::GtpPerFlowMetrics::maxTransmitBitRate + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +mobileQciCosCountList HashMap 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +mobileQciCosList String 0..1 Preliminary Array of unique LTE QCI or UMTS class-of-service values observed in the flow Ves::ObjectClasses::GtpPerFlowMetrics::mobileQciCosList + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +numActivationFailures Number 1 Preliminary Number of failed activation requests, as observed by the reporting node Ves::ObjectClasses::GtpPerFlowMetrics::numActivationFailures + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +numBitErrors Number 1 Preliminary number of errored bits Ves::ObjectClasses::GtpPerFlowMetrics::numBitErrors + + OpenModelAttribute number of errored bits + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +numBytesReceived Number 1 Preliminary number of bytes received, including retransmissions Ves::ObjectClasses::GtpPerFlowMetrics::numBytesReceived + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +numBytesTransmitted Number 1 Preliminary number of bytes transmitted, including retransmissions Ves::ObjectClasses::GtpPerFlowMetrics::numBytesTransmitted + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +numDroppedPackets Number 1 Preliminary number of received packets dropped due to errors per virtual interface Ves::ObjectClasses::GtpPerFlowMetrics::numDroppedPackets + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +numGtpEchoFailures Number 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +numGtpTunnelErrors Number 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +numHttpErrors Number 0..1 Preliminary Http error count Ves::ObjectClasses::GtpPerFlowMetrics::numHttpErrors + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +numL7BytesReceived Number 1 Preliminary number of tunneled layer 7 bytes received, including retransmissions Ves::ObjectClasses::GtpPerFlowMetrics::numL7BytesReceived + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +numL7BytesTransmitted Number 1 Preliminary number of tunneled layer 7 bytes received, including retransmissions Ves::ObjectClasses::GtpPerFlowMetrics::numL7BytesTransmitted + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +numLostPackets Number 1 Preliminary number of tunneled layer 7 bytes received, including retransmissions Ves::ObjectClasses::GtpPerFlowMetrics::numLostPackets + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +numOutOfOrderPackets Number 1 Preliminary number of out-of-order packets Ves::ObjectClasses::GtpPerFlowMetrics::numOutOfOrderPackets + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +numPacketErrors Number 1 Preliminary number of errored packets Ves::ObjectClasses::GtpPerFlowMetrics::numPacketErrors + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +numPacketsReceivedExclRetrans Number 1 Preliminary number of packets received, excluding retransmission Ves::ObjectClasses::GtpPerFlowMetrics::numPacketsReceivedExclRetrans + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +numPacketsReceivedInclRetrans Number 1 Preliminary number of packets received, including retransmission Ves::ObjectClasses::GtpPerFlowMetrics::numPacketsReceivedInclRetrans + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +numPacketsTransmittedInclRetrans Number 1 Preliminary number of packets transmitted, including retransmissions Ves::ObjectClasses::GtpPerFlowMetrics::numPacketsTransmittedInclRetrans + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +numRetries Number 1 Preliminary number of packet retrie Ves::ObjectClasses::GtpPerFlowMetrics::numRetries + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +numTimeouts Number 1 Preliminary number of packet timeouts Ves::ObjectClasses::GtpPerFlowMetrics::numTimeouts + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +numTunneledL7BytesReceived Number 1 Preliminary number of tunneled layer 7 bytes received, excluding retransmissions Ves::ObjectClasses::GtpPerFlowMetrics::numTunneledL7BytesReceived + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +roundTripTime Number 1 Preliminary Round Trip time Ves::ObjectClasses::GtpPerFlowMetrics::roundTripTime + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +tcpFlagCountList HashMap 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +tcpFlagList String 0..1 Preliminary Array of unique TCP Flags observed in the flow Ves::ObjectClasses::GtpPerFlowMetrics::tcpFlagList + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +timeToFirstByte Number 1 Preliminary Time in milliseconds between the connection activation and first byte received Ves::ObjectClasses::GtpPerFlowMetrics::timeToFirstByte + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================================ ======== ========= ================================== =============================================================================================================================================================================================================== ======================================================================= + +Heartbeat +~~~~~~~~~ The heartbeatFields datatype is an optional field block for fields specific to heartbeat events. **Parent class:** VesEvent -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class Heartbeat** - -======================= ========== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -======================= ========== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== -additionalFields HashMap 0..1 Additional expansion fields if needed. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -heartbeatFieldVersion String 1 Version of the heartbeatFields block as "#.#" where # is a digit; see section 1 for the correct digits to use. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -heartbeatInterval Integer 1 Current heartbeatInterval in seconds. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -domain Domain 1 Event domain enumeration: 'fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -eventType String 0..1 For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -lastEpochMicrosec Number 1 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 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfcNamingCode String 0..1 Network function component type: 3 characters (aligned with vfc naming standards) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfNamingCode String 0..1 Network function type: 4 characters (aligned with vnf and pnf naming standards) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfVendorName String 1 Network function vendor name OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -priority Priority 1 Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -reportingEntityId String 0..1 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. OpenModelAttribute - - | reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. - partOfObjectKey: 0 - | 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. - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -reportingEntityName String 1 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. 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. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sequence Integer 1 sequence - Ordering of events communicated by an event source instance (or 0 if not needed) OpenModelAttribute - - Ordering of events communicated by an event source instance (or 0 if not needed) - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sourceId String 0..1 | sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity OpenModelAttribute - | 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. - - partOfObjectKey: 0 - 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. - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sourceName String 1 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. 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. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -startingEpochMicrosec Number 1 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) 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…). - partOfObjectKey: 0 - | 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). - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -timeZoneOffset String 0..1 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 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -version String 1 Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -vesEventListenerVersion String 1 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). OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -name String 1 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -Status String 0..1 The current condition of an interaction, such as open, in research, closed, and so forth OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -description String 0..1 Defines a textual free-form description of the object. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -id Identifier 1 Identifier of this information element. This attribute shall be globally unique. OpenModelAttribute - - Unambiguously distinguishes different object instances. It is the naming attribute of the object. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -======================= ========== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== - -HugePages class -^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::HugePages - -**Description:** +======================= ========== ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +additionalFields HashMap 0..1 Preliminary Additional expansion fields if needed. Ves::ObjectClasses::Heartbeat::additionalFields + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +heartbeatFieldVersion String 1 Preliminary Version of the heartbeatFields block as "#.#" where # is a digit; see section 1 for the correct digits to use. Ves::ObjectClasses::Heartbeat::heartbeatFieldVersion + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +heartbeatInterval Integer 1 Preliminary Current heartbeatInterval in seconds. Ves::ObjectClasses::Heartbeat::heartbeatInterval + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +domain Domain 1 Experimental Update in definition only Ves::ObjectClasses::VesEvent::domain + + OpenModelAttribute Event domain enumeration: 'cmNotify','fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +eventType String 0..1 Preliminary For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' Ves::ObjectClasses::VesEvent::eventType + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +lastEpochMicrosec Number 1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfcNamingCode String 0..1 Preliminary Network function component type: 3 characters (aligned with vfc naming standards) Ves::ObjectClasses::VesEvent::nfcNamingCode + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfNamingCode String 0..1 Preliminary Network function type: 4 characters (aligned with vnf and pnf naming standards) Ves::ObjectClasses::VesEvent::nfNamingCode + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfVendorName String 1 Preliminary Network function vendor name Ves::ObjectClasses::VesEvent::nfVendorName + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +priority Priority 1 Preliminary Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' Ves::ObjectClasses::VesEvent::priority + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +reportingEntityId String 0..1 Preliminary 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. Ves::ObjectClasses::VesEvent::reportingEntityId + + OpenModelAttribute 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. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +reportingEntityName String 1 Preliminary 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. Ves::ObjectClasses::VesEvent::reportingEntityName + + OpenModelAttribute 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. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sequence Integer 1 Preliminary sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ves::ObjectClasses::VesEvent::sequence + + OpenModelAttribute Ordering of events communicated by an event source instance (or 0 if not needed) + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sourceId String 0..1 Preliminary 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. Ves::ObjectClasses::VesEvent::sourceId + + OpenModelAttribute 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. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sourceName String 1 Preliminary 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 + + OpenModelAttribute 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. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +startingEpochMicrosec Number 1 Preliminary 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…). Ves::ObjectClasses::VesEvent::startingEpochMicrosec + 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). + OpenModelAttribute + 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) + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +timeZoneOffset String 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +version String 1 Preliminary Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. Ves::ObjectClasses::VesEvent::version + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +vesEventListenerVersion String 1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +name String 1 Preliminary Ves::ObjectClasses::VesEvent::name + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +Status String 0..1 Preliminary The current condition of an interaction, such as open, in research, closed, and so forth Common::Business Interaction::ObjectClasses::BusinessInteraction::Status + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +description String 0..1 Preliminary Defines a textual free-form description of the object. Common::Root::RootObjectClasses::RootEntity::description + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +id Identifier 1 Preliminary Identifier of this information element. This attribute shall be globally unique. Common::Root::RootObjectClasses::RootEntity::id + + OpenModelAttribute Unambiguously distinguishes different object instances. It is the naming attribute of the object. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +======================= ========== ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== + +HugePages +~~~~~~~~~ The hugePages datatype provides metrics on system hugePages -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class HugePages** - -=================== ======== ========= ==================================== ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -=================== ======== ========= ==================================== ===================== -bytesFree Number 0..1 Number of free hugePages in bytes. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -bytesUsed Number 0..1 Number of used hugePages in bytes. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -hugePagesIdentifier String 1 HugePages identifier OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -percentFree Number 0..1 Number of free hugePages in percent. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -percentused Number 0..1 Number of used hugePages in percent. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -vmPageNumberFree Number 0..1 Number of free hugePages in numbers. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -vmPageNumberUsed Number 0..1 Number of used hugePages in numbers. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -=================== ======== ========= ==================================== ===================== - -Ipmi class -^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::Ipmi - -**Description:** +=================== ======== ========= ================================== ==================================== ================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +bytesFree Number 0..1 Preliminary Number of free hugePages in bytes. Ves::ObjectClasses::HugePages::bytesFree + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +bytesUsed Number 0..1 Preliminary Number of used hugePages in bytes. Ves::ObjectClasses::HugePages::bytesUsed + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +hugePagesIdentifier String 1 Preliminary HugePages identifier Ves::ObjectClasses::HugePages::hugePagesIdentifier + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +percentFree Number 0..1 Preliminary Number of free hugePages in percent. Ves::ObjectClasses::HugePages::percentFree + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +percentused Number 0..1 Preliminary Number of used hugePages in percent. Ves::ObjectClasses::HugePages::percentused + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +vmPageNumberFree Number 0..1 Preliminary Number of free hugePages in numbers. Ves::ObjectClasses::HugePages::vmPageNumberFree + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +vmPageNumberUsed Number 0..1 Preliminary Number of used hugePages in numbers. Ves::ObjectClasses::HugePages::vmPageNumberUsed + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +=================== ======== ========= ================================== ==================================== ================================================== + +.. _ipmi-1: + +Ipmi +~~~~ The ipmi (Intelligent Platform Management Interface) datatype provides intelligent platform management interface metrics; it consists of the following fields: -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class Ipmi** - -====================================== ==================================== ========= =============================================== ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -====================================== ==================================== ========= =============================================== ===================== -exitAirTemperature Number 0..1 System fan exit air flow temperature in Celsius OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -frontPanelTemperature Number 0..1 Front panel temp in Celsius OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -ioModuleTemperature Number 0..1 Io module temp in Celsius OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -systemAirflow Number 0..1 Airflow in cubic feet per minute (cfm) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -\_ipmibaseboardtemperature IpmiBaseboardTemperature 0..1 Array of ipmiBaseboard Temperature objects OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -\_ipmibaseboardvoltageregulator IpmiBaseboardVoltageRegulator 0..1 Array of ipmiBaseboard VoltageRegulator objects OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -\_ipmibattery IpmiBattery 0..1 Array of ipmiBattery objects OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -\_ipmifan IpmiFan 0..1 Array of ipmiFan objects OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -\_ipmiglobalaggregatetemperaturemargin IpmiGlobalAggregateTemperatureMargin 0..1 ipmi global aggregate temperature margin OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -\_ipmihsbp IpmiHsbp 0..1 Array of ipmiHsbp objects OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -\_ipminic IpmiNic 0..1 Array of ipmiNic objects OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -\_ipmipowersupply IpmiPowerSupply 0..1 Array of ipmiPowerSupply objects OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -\_ipmiprocessor IpmiProcessor 0..1 Array of ipmiProcessor objects OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -====================================== ==================================== ========= =============================================== ===================== - -IpmiBaseboardTemperature class -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::IpmiBaseboardTemperature - -**Description:** +====================================== ==================================== ========= ================================== =============================================== =============================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +exitAirTemperature Number 0..1 Preliminary System fan exit air flow temperature in Celsius Ves::ObjectClasses::Ipmi::exitAirTemperature + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +frontPanelTemperature Number 0..1 Preliminary Front panel temp in Celsius Ves::ObjectClasses::Ipmi::frontPanelTemperature + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +ioModuleTemperature Number 0..1 Preliminary Io module temp in Celsius Ves::ObjectClasses::Ipmi::ioModuleTemperature + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +systemAirflow Number 0..1 Preliminary Airflow in cubic feet per minute (cfm) Ves::ObjectClasses::Ipmi::systemAirflow + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_ipmibaseboardtemperature IpmiBaseboardTemperature 0..1 Preliminary Array of ipmiBaseboard Temperature objects Ves::ObjectClasses::Ipmi::_ipmibaseboardtemperature + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_ipmibaseboardvoltageregulator IpmiBaseboardVoltageRegulator 0..1 Preliminary Array of ipmiBaseboard VoltageRegulator objects Ves::ObjectClasses::Ipmi::_ipmibaseboardvoltageregulator + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_ipmibattery IpmiBattery 0..1 Preliminary Array of ipmiBattery objects Ves::ObjectClasses::Ipmi::_ipmibattery + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_ipmifan IpmiFan 0..1 Preliminary Array of ipmiFan objects Ves::ObjectClasses::Ipmi::_ipmifan + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_ipmiglobalaggregatetemperaturemargin IpmiGlobalAggregateTemperatureMargin 0..1 Preliminary ipmi global aggregate temperature margin Ves::ObjectClasses::Ipmi::_ipmiglobalaggregatetemperaturemargin + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_ipmihsbp IpmiHsbp 0..1 Preliminary Array of ipmiHsbp objects Ves::ObjectClasses::Ipmi::_ipmihsbp + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_ipminic IpmiNic 0..1 Preliminary Array of ipmiNic objects Ves::ObjectClasses::Ipmi::_ipminic + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_ipmipowersupply IpmiPowerSupply 0..1 Preliminary Array of ipmiPowerSupply objects Ves::ObjectClasses::Ipmi::_ipmipowersupply + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_ipmiprocessor IpmiProcessor 0..1 Preliminary Array of ipmiProcessor objects Ves::ObjectClasses::Ipmi::_ipmiprocessor + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +====================================== ==================================== ========= ================================== =============================================== =============================================================== + +IpmiBaseboardTemperature +~~~~~~~~~~~~~~~~~~~~~~~~ The ipmiBaseboardTemperature datatype consists of the following fields which describe ipmi baseboard temperature metrics: - Field Type Required? Description -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class IpmiBaseboardTemperature** - -=============================== ======== ========= ========================================================== ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -=============================== ======== ========= ========================================================== ===================== -baseboardTemperature Number 0..1 Baseboard temperature in celsius OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -baseboardTemperature Identifier String 1 Identifier for the location where the temperature is taken OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -=============================== ======== ========= ========================================================== ===================== - -IpmiBaseboardVoltageRegulator class -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::IpmiBaseboardVoltageRegulator - -**Description:** +=============================== ======== ========= ================================== ========================================================== ============================================================================= +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +baseboardTemperature Number 0..1 Preliminary Baseboard temperature in celsius Ves::ObjectClasses::IpmiBaseboardTemperature::baseboardTemperature + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +baseboardTemperature Identifier String 1 Preliminary Identifier for the location where the temperature is taken Ves::ObjectClasses::IpmiBaseboardTemperature::baseboardTemperature Identifier + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +=============================== ======== ========= ================================== ========================================================== ============================================================================= + +IpmiBaseboardVoltageRegulator +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The ipmiBaseboardVoltageRegulator datatype consists of the following fields which describe ipmi baseboard voltage regulator metrics: -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class IpmiBaseboardVoltageRegulator** - -==================================== ======== ========= ============================================== ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -==================================== ======== ========= ============================================== ===================== -baseboaredVoltageRegulatorIdentifier String 1 Identifier for the baseboard voltage regulator OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -voltageRegulatorTemperature Number 0..1 Voltage regulator temperature in celsius OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -==================================== ======== ========= ============================================== ===================== - -IpmiBattery class -^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::IpmiBattery +==================================== ======== ========= ================================== ============================================== ======================================================================================= +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +baseboaredVoltageRegulatorIdentifier String 1 Preliminary Identifier for the baseboard voltage regulator Ves::ObjectClasses::IpmiBaseboardVoltageRegulator::baseboaredVoltageRegulatorIdentifier + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +voltageRegulatorTemperature Number 0..1 Preliminary Voltage regulator temperature in celsius Ves::ObjectClasses::IpmiBaseboardVoltageRegulator::voltageRegulatorTemperature + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +==================================== ======== ========= ================================== ============================================== ======================================================================================= -**Description:** +IpmiBattery +~~~~~~~~~~~ The ipmiBattery datatype consists of the following fields which describe ipmi battery metrics: -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class IpmiBattery** - -=================== ======== ========= ========================== ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -=================== ======== ========= ========================== ===================== -batteryIdentifier String 1 Identifier for the battery OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -batteryType String 0..1 Type of battery OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -batteryVoltageLevel Number 0..1 Battery voltage level OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -=================== ======== ========= ========================== ===================== - -IpmiFan class -^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::IpmiFan - -**Description:** - -**Applied Stereotypes:** +=================== ======== ========= ================================== ========================== ==================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +batteryIdentifier String 1 Preliminary Identifier for the battery Ves::ObjectClasses::IpmiBattery::batteryIdentifier + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +batteryType String 0..1 Preliminary Type of battery Ves::ObjectClasses::IpmiBattery::batteryType + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +batteryVoltageLevel Number 0..1 Preliminary Battery voltage level Ves::ObjectClasses::IpmiBattery::batteryVoltageLevel + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +=================== ======== ========= ================================== ========================== ==================================================== + +IpmiFan +~~~~~~~ + +The ipmiFan datatype consists of the following fields which describe ipmi fan metrics: + +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class IpmiFan** - -================== ======== ========= ========================================= ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -================== ======== ========= ========================================= ===================== -fanIdentifier String 1 Identifier for the fan OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -fanSpeed Number 0..1 Fan speed in revolutions per minute (rpm) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -================== ======== ========= ========================================= ===================== - -IpmiGlobalAggregateTemperatureMargin class -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::IpmiGlobalAggregateTemperatureMargin - -**Description:** +================== ======== ========= ================================== ========================================= ========================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +fanIdentifier String 1 Preliminary Identifier for the fan Ves::ObjectClasses::IpmiFan::fanIdentifier + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +fanSpeed Number 0..1 Preliminary Fan speed in revolutions per minute (rpm) Ves::ObjectClasses::IpmiFan::fanSpeed + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= ================================== ========================================= ========================================== + +IpmiGlobalAggregateTemperatureMargin +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The ipmiGlobalAggregateTemperatureMargin datatype consists of the following fields: -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class IpmiGlobalAggregateTemperatureMargin** - -========================================== ======== ========= ========================================================================= ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -========================================== ======== ========= ========================================================================= ===================== -globalAggregateTemperatureMargin Number 0..1 Temperature margin in Celsius relative to a throttling thermal trip point OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -globalAggregateTemperatureMarginIdentifier String 1 Identifier for the ipmi global aggregate temperature margin metrics OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -========================================== ======== ========= ========================================================================= ===================== - -IpmiHsbp class -^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::IpmiHsbp - -**Description:** +========================================== ======== ========= ================================== ========================================================================= ==================================================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +globalAggregateTemperatureMargin Number 0..1 Preliminary Temperature margin in Celsius relative to a throttling thermal trip point Ves::ObjectClasses::IpmiGlobalAggregateTemperatureMargin::globalAggregateTemperatureMargin + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +globalAggregateTemperatureMarginIdentifier String 1 Preliminary Identifier for the ipmi global aggregate temperature margin metrics Ves::ObjectClasses::IpmiGlobalAggregateTemperatureMargin::globalAggregateTemperatureMarginIdentifier + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +========================================== ======== ========= ================================== ========================================================================= ==================================================================================================== + +IpmiHsbp +~~~~~~~~ The ipmiHsbp datatype provides ipmi hot swap backplane power metrics; it consists of the following fields: -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class IpmiHsbp** - -================== ======== ========= ================================================ ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -================== ======== ========= ================================================ ===================== -hsbpIdentifier String 1 Identifier for the hot swap backplane power unit OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -hsbpTemperature Number 0..1 Hot swap backplane power temperature in celsius OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -================== ======== ========= ================================================ ===================== - -IpmiNic class -^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::IpmiNic - -**Description:** +================== ======== ========= ================================== ================================================ ============================================= +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +hsbpIdentifier String 1 Preliminary Identifier for the hot swap backplane power unit Ves::ObjectClasses::IpmiHsbp::hsbpIdentifier + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +hsbpTemperature Number 0..1 Preliminary Hot swap backplane power temperature in celsius Ves::ObjectClasses::IpmiHsbp::hsbpTemperature + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= ================================== ================================================ ============================================= + +IpmiNic +~~~~~~~ The ipmiNic datatype provides network interface control care metrics; it consists of the following fields: -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class IpmiNic** - -================== ======== ========= ================================================= ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -================== ======== ========= ================================================= ===================== -nicIdentifier String 1 Identifier for the network interface control card OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nicTemperature Number 0..1 nic temperature in Celsius OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -================== ======== ========= ================================================= ===================== - -IpmiPowerSupply class -^^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::IpmiPowerSupply - -**Description:** +================== ======== ========= ================================== ================================================= =========================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +nicIdentifier String 1 Preliminary Identifier for the network interface control card Ves::ObjectClasses::IpmiNic::nicIdentifier + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nicTemperature Number 0..1 Preliminary nic temperature in Celsius Ves::ObjectClasses::IpmiNic::nicTemperature + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= ================================== ================================================= =========================================== + +IpmiPowerSupply +~~~~~~~~~~~~~~~ The ipmiPowerSupply datatype provides ipmi power supply metrics; it consists of the following fields: -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class IpmiPowerSupply** - -=============================== ======== ========= ==================================================================== ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -=============================== ======== ========= ==================================================================== ===================== -powerSupplyCurrentOutputPercent Number 0..1 Current output voltage as a percentage of the design specified level OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -powerSupplyIdentifier String 1 Identifier for the power supply OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -powerSupplyInputPower Number 0..1 Input power in watts OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -powerSupplyTemperature Number 0..1 Power supply temperature in Celsius OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -=============================== ======== ========= ==================================================================== ===================== - -IpmiProcessor class -^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::IpmiProcessor - -**Description:** +=============================== ======== ========= ================================== ==================================================================== ==================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +powerSupplyCurrentOutputPercent Number 0..1 Preliminary Current output voltage as a percentage of the design specified level Ves::ObjectClasses::IpmiPowerSupply::powerSupplyCurrentOutputPercent + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +powerSupplyIdentifier String 1 Preliminary Identifier for the power supply Ves::ObjectClasses::IpmiPowerSupply::powerSupplyIdentifier + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +powerSupplyInputPower Number 0..1 Preliminary Input power in watts Ves::ObjectClasses::IpmiPowerSupply::powerSupplyInputPower + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +powerSupplyTemperature Number 0..1 Preliminary Power supply temperature in Celsius Ves::ObjectClasses::IpmiPowerSupply::powerSupplyTemperature + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +=============================== ======== ========= ================================== ==================================================================== ==================================================================== + +IpmiProcessor +~~~~~~~~~~~~~ The ipmiProcessor datatype provides ipmi processor metrics -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class IpmiProcessor** - -===================================== =================================== ========= ===================================================== ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -===================================== =================================== ========= ===================================================== ===================== -processorThermalControlPercent Number 0..1 Io module temperatue in celsius OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -processorDtsThermalMargin Number 0..1 Front panel temperature in celsius OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -\_processordimmaggregatethermalmargin ProcessorDimmAggregateThermalMargin 0..1 Array of processorDimmAggregate ThermalMargin objects OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -processorIdentifier String 1 Identifier for the power supply OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -===================================== =================================== ========= ===================================================== ===================== - -LatencyBucketMeasure class -^^^^^^^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::LatencyBucketMeasure - -**Description:** +===================================== =================================== ========= ================================== ===================================================== ======================================================================= +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +processorThermalControlPercent Number 0..1 Preliminary Io module temperatue in celsius Ves::ObjectClasses::IpmiProcessor::processorThermalControlPercent + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +processorDtsThermalMargin Number 0..1 Preliminary Front panel temperature in celsius Ves::ObjectClasses::IpmiProcessor::processorDtsThermalMargin + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_processordimmaggregatethermalmargin ProcessorDimmAggregateThermalMargin 0..1 Preliminary Array of processorDimmAggregate ThermalMargin objects Ves::ObjectClasses::IpmiProcessor::_processordimmaggregatethermalmargin + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +processorIdentifier String 1 Preliminary Identifier for the power supply Ves::ObjectClasses::IpmiProcessor::processorIdentifier + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +===================================== =================================== ========= ================================== ===================================================== ======================================================================= + +LatencyBucketMeasure +~~~~~~~~~~~~~~~~~~~~ The latencyBucketMeasure datatype consists of the following fields which describe the number of counts falling within a defined latency bucket -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class LatencyBucketMeasure** - -====================== ======== ========= ======================================================== ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -====================== ======== ========= ======================================================== ===================== -countsInTheBucket Number 1 Number of counts falling within a defined latency bucket OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -highEndOfLatencyBucket Number 0..1 High end of bucket range (typically in ms) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -lowEndOfLatencyBucket Number 0..1 Low end of bucket range (typically in ms) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -====================== ======== ========= ======================================================== ===================== - -Load class -^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::Load - -**Description:** +====================== ======== ========= ================================== ======================================================== ================================================================ +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +countsInTheBucket Number 1 Preliminary Number of counts falling within a defined latency bucket Ves::ObjectClasses::LatencyBucketMeasure::countsInTheBucket + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +highEndOfLatencyBucket Number 0..1 Preliminary High end of bucket range (typically in ms) Ves::ObjectClasses::LatencyBucketMeasure::highEndOfLatencyBucket + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +lowEndOfLatencyBucket Number 0..1 Preliminary Low end of bucket range (typically in ms) Ves::ObjectClasses::LatencyBucketMeasure::lowEndOfLatencyBucket + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +====================== ======== ========= ================================== ======================================================== ================================================================ + +Load +~~~~ The load datatype provides metrics on system cpu and io utilization obtained using /proc/loadavg -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class Load** - -================== ======== ========= ========================================================================================================================================================= ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -================== ======== ========= ========================================================================================================================================================= ===================== -longTerm Number 0..1 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 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -midTerm Number 0..1 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 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -shortTerm Number 0..1 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 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -================== ======== ========= ========================================================================================================================================================= ===================== - -MachineCheckException class -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::MachineCheckException - -**Description:** +================== ======== ========= ================================== ========================================================================================================================================================= =================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +longTerm Number 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +midTerm Number 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +shortTerm Number 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= ================================== ========================================================================================================================================================= =================================== + +MachineCheckException +~~~~~~~~~~~~~~~~~~~~~ The machineCheckException datatype describes machine check exceptions -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class MachineCheckException** - -============================= ======== ========= ============================================================================================================================================================================================================================================================== ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -============================= ======== ========= ============================================================================================================================================================================================================================================================== ===================== -correctedMemoryErrors Number 0..1 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 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -correctedMemoryErrors In1Hr Number 0..1 Total hardware errors that were corrected by the hardware over the last one hour OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -vmlIdentifier String 1 processIdentifier OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -uncorrectedMemoryErrors Number 0..1 Total uncorrected hardware errors that were detected by the hardware (e.g., causing data corruption) over the measurementInterval. These errors require a software response. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -uncorrectedMemoryErrors In1Hr Number 0..1 Total uncorrected hardware errors that were detected by the hardware over the last one hour OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -============================= ======== ========= ============================================================================================================================================================================================================================================================== ===================== - -MeasDataCollection class -^^^^^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::MeasDataCollection - -**Description:** +============================= ======== ========= ================================== ============================================================================================================================================================================================================================================================== ======================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +correctedMemoryErrors Number 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +correctedMemoryErrors In1Hr Number 0..1 Preliminary Total hardware errors that were corrected by the hardware over the last one hour Ves::ObjectClasses::MachineCheckException::correctedMemoryErrors In1Hr + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +vmlIdentifier String 1 Preliminary processIdentifier Ves::ObjectClasses::MachineCheckException::vmlIdentifier + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +uncorrectedMemoryErrors Number 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +uncorrectedMemoryErrors In1Hr Number 0..1 Preliminary Total uncorrected hardware errors that were detected by the hardware over the last one hour Ves::ObjectClasses::MachineCheckException::uncorrectedMemoryErrors In1Hr + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +============================= ======== ========= ================================== ============================================================================================================================================================================================================================================================== ======================================================================== + +MeasDataCollection +~~~~~~~~~~~~~~~~~~ The measDataCollection datatype defines a 3GPP measurement collection structure aligned with the 3GPP PM format -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class MeasDataCollection** - -============================= ======== ========= ================================================================================ ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -============================= ======== ========= ================================================================================ ===================== -formatVersion String 0..1 3GPP PM reporting file format version from pre-standard TS 28.550 v2.0.0 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -granularityPeriod String 1 Granularity period for the PM report in seconds OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -measObjInstIdList String 0..1 Array of monitored object local distinguished name ids per 3GPP TS 32.300 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -measuredEntityDn String 1 Distinguished name per 3GPP TS 28.550 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -measuredEntitySoftwareVersion String 0..1 Software version for the NF providing the PM data as specified in 3GPP TS 28.550 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -measuredEntityUserName String 0..1 User Definable name for the measured object per 3GPP TS 28.550 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -\_measinfo MeasInfo 1..\* Array of monitored object local distinguished name ids per 3GPP TS 32.300 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -============================= ======== ========= ================================================================================ ===================== - -MeasInfo class -^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::MeasInfo - -**Applied Stereotypes:** +============================= ======== ========= ================================== ================================================================================ ===================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +formatVersion String 0..1 Preliminary 3GPP PM reporting file format version from pre-standard TS 28.550 v2.0.0 Ves::ObjectClasses::MeasDataCollection::formatVersion + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +granularityPeriod String 1 Preliminary Granularity period for the PM report in seconds Ves::ObjectClasses::MeasDataCollection::granularityPeriod + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +measObjInstIdList String 0..1 Preliminary Array of monitored object local distinguished name ids per 3GPP TS 32.300 Ves::ObjectClasses::MeasDataCollection::measObjInstIdList + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +measuredEntityDn String 1 Preliminary Distinguished name per 3GPP TS 28.550 Ves::ObjectClasses::MeasDataCollection::measuredEntityDn + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +measuredEntitySoftwareVersion String 0..1 Preliminary Software version for the NF providing the PM data as specified in 3GPP TS 28.550 Ves::ObjectClasses::MeasDataCollection::measuredEntitySoftwareVersion + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +measuredEntityUserName String 0..1 Preliminary User Definable name for the measured object per 3GPP TS 28.550 Ves::ObjectClasses::MeasDataCollection::measuredEntityUserName + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_measinfo MeasInfo 1..\* Preliminary Array of monitored object local distinguished name ids per 3GPP TS 32.300 Ves::ObjectClasses::MeasDataCollection::_measinfo + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +============================= ======== ========= ================================== ================================================================================ ===================================================================== + +MeasInfo +~~~~~~~~ + +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class MeasInfo** - -=================== ================= ========= ================================================================================================================================= ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -=================== ================= ========= ================================================================================================================================= ===================== -jobId String 0..1 Name of the measurement job OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -\_measinfoidinteger measInfoIdInteger 0..1 Measurement group Identifier OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -\_measinfoidstring MeasInfoIdString 0..1 Measurement group Identifier OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -\_meastypesinteger MeasTypesInteger 0..1 Array of measurement identifiers associated with the measurement results expressed as integers for efficiency rather than strings OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -\_meastypesstring MeasTypesString 0..1 Array of measurement identifiers associated with the measurement results expressed as integers for efficiency rather than strings OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -\_measvalues MeasValues 1..\* Array of measValues OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -=================== ================= ========= ================================================================================================================================= ===================== - -MeasInfoIdString class -^^^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::MeasInfoIdString - -**Description:** +=================== ================= ========= ================================== ================================================================================================================================= ================================================ +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +jobId String 0..1 Preliminary Name of the measurement job Ves::ObjectClasses::MeasInfo::jobId + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_measinfoidinteger measInfoIdInteger 0..1 Preliminary Measurement group Identifier Ves::ObjectClasses::MeasInfo::_measinfoidinteger + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_measinfoidstring MeasInfoIdString 0..1 Preliminary Measurement group Identifier Ves::ObjectClasses::MeasInfo::_measinfoidstring + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_meastypesinteger MeasTypesInteger 0..1 Preliminary Array of measurement identifiers associated with the measurement results expressed as integers for efficiency rather than strings Ves::ObjectClasses::MeasInfo::_meastypesinteger + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_meastypesstring MeasTypesString 0..1 Preliminary Array of measurement identifiers associated with the measurement results expressed as integers for efficiency rather than strings Ves::ObjectClasses::MeasInfo::_meastypesstring + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_measValuesList MeasValues 1..\* Experimental Array of measValues Ves::ObjectClasses::MeasInfo::_measValuesList + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +=================== ================= ========= ================================== ================================================================================================================================= ================================================ + +MeasInfoIdString +~~~~~~~~~~~~~~~~ The measInfoIdString datatype provides a string measurement group identifier; -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class MeasInfoIdString** - -================== ======== ========= =================================== ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -================== ======== ========= =================================== ===================== -sMeasInfoId Integer 1 String measurement group Identifier OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -================== ======== ========= =================================== ===================== - -MeasResultInteger class -^^^^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::MeasResultInteger - -**Description:** +================== ======== ========= ================================== =================================== ================================================= +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +sMeasInfoId Integer 1 Preliminary String measurement group Identifier Ves::ObjectClasses::MeasInfoIdString::sMeasInfoId + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= ================================== =================================== ================================================= + +MeasResultInteger +~~~~~~~~~~~~~~~~~ The measResultInteger datatype provides an integer 3GPP PM measurement result; -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class MeasResultInteger** - -================== ======== ========= ================================ ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -================== ======== ========= ================================ ===================== -p Integer 1 Integer reference to the counter OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -iValue Integer 1 Integer counter value OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -================== ======== ========= ================================ ===================== - -MeasResultString class -^^^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::MeasResultString - -**Description:** +================== ======== ========= ================================== ================================ ============================================= +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +p Integer 1 Preliminary Integer reference to the counter Ves::ObjectClasses::MeasResultInteger::p + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +iValue Integer 1 Preliminary Integer counter value Ves::ObjectClasses::MeasResultInteger::iValue + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= ================================== ================================ ============================================= + +MeasResultString +~~~~~~~~~~~~~~~~ The measResultString datatype provides a string 3GPP PM measurement result; -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class MeasResultString** - -================== ======== ========= ================================ ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -================== ======== ========= ================================ ===================== -p Integer 1 Integer reference to the counter OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sVlaue String 1 String counter value OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -================== ======== ========= ================================ ===================== - -MeasTypesInteger class -^^^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::MeasTypesInteger - -**Description:** +================== ======== ========= ================================== ================================ ============================================ +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +p Integer 1 Preliminary Integer reference to the counter Ves::ObjectClasses::MeasResultString::p + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sVlaue String 1 Preliminary String counter value Ves::ObjectClasses::MeasResultString::sVlaue + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= ================================== ================================ ============================================ + +MeasTypesInteger +~~~~~~~~~~~~~~~~ The measTypesInteger datatype provides an array of integer measurement identifiers associated with the measurement results -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class MeasTypesInteger** - -================== ======== ========= ================================================================================ ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -================== ======== ========= ================================================================================ ===================== -iMeasTypesList Integer 1..\* Array of integer measurement identifiers associated with the measurement results OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -================== ======== ========= ================================================================================ ===================== - -MeasTypesString class -^^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::MeasTypesString - -**Description:** +================== ======== ========= ================================== ================================================================================ ==================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +iMeasTypesList Integer 1..\* Preliminary Array of integer measurement identifiers associated with the measurement results Ves::ObjectClasses::MeasTypesInteger::iMeasTypesList + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= ================================== ================================================================================ ==================================================== + +MeasTypesString +~~~~~~~~~~~~~~~ The measTypesString datatype provides an array of string measurement identifiers associated with the measurement results -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class MeasTypesString** - -================== ======== ========= =============================================================================== ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -================== ======== ========= =============================================================================== ===================== -sMeasTypesList String 1..\* Array of string measurement identifiers associated with the measurement results OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -================== ======== ========= =============================================================================== ===================== - -MeasValues class -^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::MeasValues - -**Description:** +================== ======== ========= ================================== =============================================================================== =================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +sMeasTypesList String 1..\* Preliminary Array of string measurement identifiers associated with the measurement results Ves::ObjectClasses::MeasTypesString::sMeasTypesList + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= ================================== =============================================================================== =================================================== + +MeasValues +~~~~~~~~~~ The measValues datatype provides 3GPP measurement values -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class MeasValues** - -=================== ================= ========= ================================================================= ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -=================== ================= ========= ================================================================= ===================== -measObjAddFlds HashMap 0..1 Additional key-value pairs if needed OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -suspectFlag Boolean 1 Enumeration: 'true', 'false'. Indicates if the values are suspect OpenModelAttribute - - VES 7.1 Spec has this attribute as a string. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -\_measresultinteger MeasResultInteger 0..\* Array of results OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -\_measresultnull measResultNull 0..\* Array of results OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -\_mesresultnumber MesResultNumber 0..\* Array of results OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -\_measresultstring MeasResultString 0..\* Array of results OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -=================== ================= ========= ================================================================= ===================== - -Measurement class -^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::Measurement - -**Description:** +=================== ================= ========= ================================== ================================================================= ================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +measObjAddFlds HashMap 0..1 Preliminary Additional key-value pairs if needed Ves::ObjectClasses::MeasValues::measObjAddFlds + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +suspectFlag Boolean 1 Preliminary Enumeration: 'true', 'false'. Indicates if the values are suspect Ves::ObjectClasses::MeasValues::suspectFlag + + OpenModelAttribute VES 7.1 Spec has this attribute as a string. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_measresultinteger MeasResultInteger 0..\* Preliminary Array of results Ves::ObjectClasses::MeasValues::_measresultinteger + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_measresultnull measResultNull 0..\* Preliminary Array of results Ves::ObjectClasses::MeasValues::_measresultnull + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_mesresultnumber MesResultNumber 0..\* Preliminary Array of results Ves::ObjectClasses::MeasValues::_mesresultnumber + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_measresultstring MeasResultString 0..\* Preliminary Array of results Ves::ObjectClasses::MeasValues::_measresultstring + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +=================== ================= ========= ================================== ================================================================= ================================================== + +Measurement +~~~~~~~~~~~ Fields specific to measurement events **Parent class:** VesEvent -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class Measurement** - -======================== ===================== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -======================== ===================== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== -additionalFields HashMap 0..1 Additional measurement fields if needed. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -additionalMeasurements ArrayofNamedHashMap 0..1 Array of named hashMap if needed. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -additionalObjects ArrayOfSchemaObject 0..1 Array of Schema objects described by name, schema and other meta-information, if needed. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -concurrentSessions Integer 0..1 Peak concurrent sessions for the VM or VNF (depending on the context) over the measurementInterval. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -configuredEntities Integer 0..1 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 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -featureUsageArray HashMap 0..1 The hashMap key should identify the feature, while the value defines the number of times the identified feature was used. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -meanRequestLatency Number 0..1 Mean seconds required to respond to each request for the VM on which the VNFC reporting the event is running. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -measurementFieldsVersion String 1 Version of the measurementFields block as "#.#" where # is a digit; see section 1 for the correct digits to use. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -measurementInterval Number 1 Interval over which measurements are being reported in seconds OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfcScalingMetric Integer 0..1 Represents busy-ness of the network function from 0 to 100 as reported by the nfc. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -numberOfMediaPortsInUse Integer 1 Number of media ports in use. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -requestRate Number 1 Peak request rate per second, for the VM over the measurementInterval OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -\_Hugepages HugePages 0..1 Array of metrics on hugePages OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -\_codecsinuse CodecsInUse 0..\* Array of codecs in use OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -\_cpuUsage CpuUsage 0..\* Usage of an array of CPUs OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -\_diskUsage DiskUsage 0..\* Usage of an array of disks OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -\_filesystemusage FilesystemUsage 0..\* Filesystem usage of the VM on which the xNFC reporting the event is running OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -\_ipmi Ipmi 0..1 Array of intelligent platform management interface metrics OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -\_latencybucketmeasure 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. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -\_load Load 0..1 Array of system load metrics OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -\_machinecheckexception MachineCheckException 0..1 Array of machine check exceptions OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -\_memoryusage MemoryUsage 0..\* Memory usage of an array of VMs OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -\_nicperformance NicPerformance 0..\* Performance metrics of an array of network interface cards OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -\_processstats ProcessStats 0..\* Array of metrics on system processes OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -domain Domain 1 Event domain enumeration: 'fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -eventType String 0..1 For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -lastEpochMicrosec Number 1 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 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfcNamingCode String 0..1 Network function component type: 3 characters (aligned with vfc naming standards) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfNamingCode String 0..1 Network function type: 4 characters (aligned with vnf and pnf naming standards) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfVendorName String 1 Network function vendor name OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -priority Priority 1 Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -reportingEntityId String 0..1 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. OpenModelAttribute - - | reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. - partOfObjectKey: 0 - | 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. - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -reportingEntityName String 1 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. 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. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sequence Integer 1 sequence - Ordering of events communicated by an event source instance (or 0 if not needed) OpenModelAttribute - - Ordering of events communicated by an event source instance (or 0 if not needed) - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sourceId String 0..1 | sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity OpenModelAttribute - | 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. - - partOfObjectKey: 0 - 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. - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sourceName String 1 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. 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. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -startingEpochMicrosec Number 1 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) 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…). - partOfObjectKey: 0 - | 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). - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -timeZoneOffset String 0..1 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 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -version String 1 Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -vesEventListenerVersion String 1 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). OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -name String 1 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -Status String 0..1 The current condition of an interaction, such as open, in research, closed, and so forth OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -description String 0..1 Defines a textual free-form description of the object. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -id Identifier 1 Identifier of this information element. This attribute shall be globally unique. OpenModelAttribute - - Unambiguously distinguishes different object instances. It is the naming attribute of the object. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -======================== ===================== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== - -MemoryUsage class -^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::MemoryUsage - -**Description:** +======================== ===================== ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +additionalFields HashMap 0..1 Preliminary Additional measurement fields if needed. Ves::ObjectClasses::Measurement::additionalFields + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +additionalMeasurements ArrayofNamedHashMap 0..1 Preliminary Array of named hashMap if needed. Ves::ObjectClasses::Measurement::additionalMeasurements + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +additionalObjects ArrayOfSchemaObject 0..1 Preliminary Array of Schema objects described by name, schema and other meta-information, if needed. Ves::ObjectClasses::Measurement::additionalObjects + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +concurrentSessions Integer 0..1 Preliminary Peak concurrent sessions for the VM or VNF (depending on the context) over the measurementInterval. Ves::ObjectClasses::Measurement::concurrentSessions + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +configuredEntities Integer 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +featureUsageArray HashMap 0..1 Preliminary The hashMap key should identify the feature, while the value defines the number of times the identified feature was used. Ves::ObjectClasses::Measurement::featureUsageArray + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +meanRequestLatency Number 0..1 Preliminary Mean seconds required to respond to each request for the VM on which the VNFC reporting the event is running. Ves::ObjectClasses::Measurement::meanRequestLatency + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +measurementFieldsVersion String 1 Preliminary Version of the measurementFields block as "#.#" where # is a digit; see section 1 for the correct digits to use. Ves::ObjectClasses::Measurement::measurementFieldsVersion + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +measurementInterval Number 1 Preliminary Interval over which measurements are being reported in seconds Ves::ObjectClasses::Measurement::measurementInterval + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfcScalingMetric Integer 0..1 Preliminary Represents busy-ness of the network function from 0 to 100 as reported by the nfc. Ves::ObjectClasses::Measurement::nfcScalingMetric + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +numberOfMediaPortsInUse Integer 1 Preliminary Number of media ports in use. Ves::ObjectClasses::Measurement::numberOfMediaPortsInUse + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +requestRate Number 1 Preliminary Peak request rate per second, for the VM over the measurementInterval Ves::ObjectClasses::Measurement::requestRate + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_Hugepages HugePages 0..1 Preliminary Array of metrics on hugePages Ves::ObjectClasses::Measurement::_Hugepages + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_codecsinuse CodecsInUse 0..\* Preliminary Array of codecs in use Ves::ObjectClasses::Measurement::_codecsinuse + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_cpuUsage CpuUsage 0..\* Preliminary Usage of an array of CPUs Ves::ObjectClasses::Measurement::_cpuUsage + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_diskUsage DiskUsage 0..\* Preliminary Usage of an array of disks Ves::ObjectClasses::Measurement::_diskUsage + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_filesystemusage FilesystemUsage 0..\* Preliminary Filesystem usage of the VM on which the xNFC reporting the event is running Ves::ObjectClasses::Measurement::_filesystemusage + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_ipmi Ipmi 0..1 Preliminary Array of intelligent platform management interface metrics Ves::ObjectClasses::Measurement::_ipmi + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_latencybucketmeasure LatencyBucketMeasure 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_load Load 0..1 Preliminary Array of system load metrics Ves::ObjectClasses::Measurement::_load + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_machinecheckexception MachineCheckException 0..1 Preliminary Array of machine check exceptions Ves::ObjectClasses::Measurement::_machinecheckexception + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_memoryusage MemoryUsage 0..\* Preliminary Memory usage of an array of VMs Ves::ObjectClasses::Measurement::_memoryusage + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_nicperformance NicPerformance 0..\* Preliminary Performance metrics of an array of network interface cards Ves::ObjectClasses::Measurement::_nicperformance + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_processstats ProcessStats 0..\* Preliminary Array of metrics on system processes Ves::ObjectClasses::Measurement::_processstats + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +domain Domain 1 Experimental Update in definition only Ves::ObjectClasses::VesEvent::domain + + OpenModelAttribute Event domain enumeration: 'cmNotify','fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +eventType String 0..1 Preliminary For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' Ves::ObjectClasses::VesEvent::eventType + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +lastEpochMicrosec Number 1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfcNamingCode String 0..1 Preliminary Network function component type: 3 characters (aligned with vfc naming standards) Ves::ObjectClasses::VesEvent::nfcNamingCode + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfNamingCode String 0..1 Preliminary Network function type: 4 characters (aligned with vnf and pnf naming standards) Ves::ObjectClasses::VesEvent::nfNamingCode + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfVendorName String 1 Preliminary Network function vendor name Ves::ObjectClasses::VesEvent::nfVendorName + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +priority Priority 1 Preliminary Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' Ves::ObjectClasses::VesEvent::priority + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +reportingEntityId String 0..1 Preliminary 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. Ves::ObjectClasses::VesEvent::reportingEntityId + + OpenModelAttribute 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. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +reportingEntityName String 1 Preliminary 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. Ves::ObjectClasses::VesEvent::reportingEntityName + + OpenModelAttribute 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. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sequence Integer 1 Preliminary sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ves::ObjectClasses::VesEvent::sequence + + OpenModelAttribute Ordering of events communicated by an event source instance (or 0 if not needed) + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sourceId String 0..1 Preliminary 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. Ves::ObjectClasses::VesEvent::sourceId + + OpenModelAttribute 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. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sourceName String 1 Preliminary 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 + + OpenModelAttribute 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. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +startingEpochMicrosec Number 1 Preliminary 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…). Ves::ObjectClasses::VesEvent::startingEpochMicrosec + 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). + OpenModelAttribute + 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) + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +timeZoneOffset String 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +version String 1 Preliminary Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. Ves::ObjectClasses::VesEvent::version + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +vesEventListenerVersion String 1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +name String 1 Preliminary Ves::ObjectClasses::VesEvent::name + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +Status String 0..1 Preliminary The current condition of an interaction, such as open, in research, closed, and so forth Common::Business Interaction::ObjectClasses::BusinessInteraction::Status + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +description String 0..1 Preliminary Defines a textual free-form description of the object. Common::Root::RootObjectClasses::RootEntity::description + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +id Identifier 1 Preliminary Identifier of this information element. This attribute shall be globally unique. Common::Root::RootObjectClasses::RootEntity::id + + OpenModelAttribute Unambiguously distinguishes different object instances. It is the naming attribute of the object. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +======================== ===================== ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== + +MemoryUsage +~~~~~~~~~~~ The memoryUsage datatype defines the memory usage of a virtual machine and consists of the following fields: -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class MemoryUsage** - -==================== ======== ========= =============================================================================================================================== ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -==================== ======== ========= =============================================================================================================================== ===================== -memoryBuffered Number 0..1 Kibibytes of temporary storage for raw disk blocks OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -memoryCached Number 0..1 Kibibytes of memory used for cache OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -memoryConfigured Number 0..1 Kibibytes of memory configured in the virtual machine on which the xNFC reporting the event is running OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -memoryDemand Number 0..1 Host demand in kibibytes OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -memoryFree Number 1 Kibibytes of physical RAM left unused by the system OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -memoryLatencyAvg Number 0..1 Percentage of time the VM is waiting to access swapped or compressed memory OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -memorySharedAvg Number 0..1 Shared memory in kilobytes OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -memorySlabRecl Number 0..1 The part of the slab that can be reclaimed such as caches measured in kibibytes OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -memorySlabUnrecl Number 0..1 The part of the slab that cannot be reclaimed even when lacking memory measure in kibibytes OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -memorySwapInAvg Number 0..1 Amount of memory swapped-in from host cache in kibibytes OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -memorySwapInRateAvg Number 0..1 Rate at which memory is swapped from disk into active memory during the interval in kilobytes per second OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -memorySwapOutAvg Number 0..1 Amount of memory swapped-out to host cache in kibibytes OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -memorySwapOutRateAvg Number 0..1 Rate at which memory is being swapped from active memory to disk during the current interval in kilobytes per second OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -memorySwapUsedAvg Number 0..1 Space used for caching swapped pages in the host cache in kibibytes OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -memoryUsed Number 1 Total memory minus the sum of free, buffered, cached and slab memory measured in kibibytes OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -percentMemoryUsage Number 0..1 Percentage of memory usage; value = (memoryUsed / (memoryUsed + memoryFree) x 100 if denomintor is nonzero, or 0, if otherwise. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -vmIdentifier String 1 Virtual Machine identifier associated with the memory metrics OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -==================== ======== ========= =============================================================================================================================== ===================== - -MesResultNumber class -^^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::MesResultNumber - -**Description:** +==================== ======== ========= ================================== =============================================================================================================================== ===================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +memoryBuffered Number 0..1 Preliminary Kibibytes of temporary storage for raw disk blocks Ves::ObjectClasses::MemoryUsage::memoryBuffered + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +memoryCached Number 0..1 Preliminary Kibibytes of memory used for cache Ves::ObjectClasses::MemoryUsage::memoryCached + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +memoryConfigured Number 0..1 Preliminary Kibibytes of memory configured in the virtual machine on which the xNFC reporting the event is running Ves::ObjectClasses::MemoryUsage::memoryConfigured + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +memoryDemand Number 0..1 Preliminary Host demand in kibibytes Ves::ObjectClasses::MemoryUsage::memoryDemand + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +memoryFree Number 1 Preliminary Kibibytes of physical RAM left unused by the system Ves::ObjectClasses::MemoryUsage::memoryFree + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +memoryLatencyAvg Number 0..1 Preliminary Percentage of time the VM is waiting to access swapped or compressed memory Ves::ObjectClasses::MemoryUsage::memoryLatencyAvg + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +memorySharedAvg Number 0..1 Preliminary Shared memory in kilobytes Ves::ObjectClasses::MemoryUsage::memorySharedAvg + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +memorySlabRecl Number 0..1 Preliminary The part of the slab that can be reclaimed such as caches measured in kibibytes Ves::ObjectClasses::MemoryUsage::memorySlabRecl + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +memorySlabUnrecl Number 0..1 Preliminary The part of the slab that cannot be reclaimed even when lacking memory measure in kibibytes Ves::ObjectClasses::MemoryUsage::memorySlabUnrecl + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +memorySwapInAvg Number 0..1 Preliminary Amount of memory swapped-in from host cache in kibibytes Ves::ObjectClasses::MemoryUsage::memorySwapInAvg + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +memorySwapInRateAvg Number 0..1 Preliminary Rate at which memory is swapped from disk into active memory during the interval in kilobytes per second Ves::ObjectClasses::MemoryUsage::memorySwapInRateAvg + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +memorySwapOutAvg Number 0..1 Preliminary Amount of memory swapped-out to host cache in kibibytes Ves::ObjectClasses::MemoryUsage::memorySwapOutAvg + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +memorySwapOutRateAvg Number 0..1 Preliminary Rate at which memory is being swapped from active memory to disk during the current interval in kilobytes per second Ves::ObjectClasses::MemoryUsage::memorySwapOutRateAvg + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +memorySwapUsedAvg Number 0..1 Preliminary Space used for caching swapped pages in the host cache in kibibytes Ves::ObjectClasses::MemoryUsage::memorySwapUsedAvg + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +memoryUsed Number 1 Preliminary Total memory minus the sum of free, buffered, cached and slab memory measured in kibibytes Ves::ObjectClasses::MemoryUsage::memoryUsed + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +percentMemoryUsage Number 0..1 Preliminary Percentage of memory usage; value = (memoryUsed / (memoryUsed + memoryFree) x 100 if denomintor is nonzero, or 0, if otherwise. Ves::ObjectClasses::MemoryUsage::percentMemoryUsage + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +vmIdentifier String 1 Preliminary Virtual Machine identifier associated with the memory metrics Ves::ObjectClasses::MemoryUsage::vmIdentifier + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +==================== ======== ========= ================================== =============================================================================================================================== ===================================================== + +MesResultNumber +~~~~~~~~~~~~~~~ The measResultNumber datatype provides a number 3GPP PM measurement result -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class MesResultNumber** - -================== ======== ========= ================================ ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -================== ======== ========= ================================ ===================== -p Integer 1 Integer reference to the counter OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -rValue Number 1 Number counter value OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -================== ======== ========= ================================ ===================== - -MobileFlow class -^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::MobileFlow - -**Description:** +================== ======== ========= ================================== ================================ =========================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +p Integer 1 Preliminary Integer reference to the counter Ves::ObjectClasses::MesResultNumber::p + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +rValue Number 1 Preliminary Number counter value Ves::ObjectClasses::MesResultNumber::rValue + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= ================================== ================================ =========================================== + +MobileFlow +~~~~~~~~~~ Fields specific to mobility flow events **Parent class:** VesEvent -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class MobileFlow** - -======================= ================= ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -======================= ================= ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== -additionalFields HashMap 0..1 additionalFields - Additional mobileFlow fields if needed. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -applicationType String 0..1 applicationType - Application type inferred OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -applProtocolType String 0..1 applProtocolType - Application protocol. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -applProtocolVersion String 0..1 applProtocolVersion - Application version. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -cid String 0..1 cid - Cell Id. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -connectionType String 0..1 connectionType - Abbreviation referencing a 3GPP reference point e.g., S1-U, S11, etc. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -ecgi String 0..1 ecgi - Evolved Cell Global Id. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -flowDirection String 0..1 flowDirection - Flow direction, indicating if the reporting node is the source of the flow or destination for the flow. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -gtpProtocolType String 0..1 gtpProtocolType - GTP protocol OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -gtpVersion String 0..1 gtpVersion - GTP protocol version. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -httpHeader String 0..1 httpHeader - HTTP request header, if the flow connects to a node referenced by HTTP. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -iemi String 0..1 imei - IMEI for the subscriber UE used in this flow, if the flow connects to a mobile device. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -imsi String 0..1 imsi - IMSI for the subscriber UE used in this flow, if the flow connects to a mobile device OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -ipProtocolType String 0..1 ipProtocolType - IP protocol type e.g., TCP, UDP, RTP... OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -ipVersion String 0..1 ipVersion - IP protocol version e.g., IPv4, IPv6 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -lac String 0..1 lac - Location area code. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -mcc String 0..1 mcc - Mobile country code. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -mnc String 0..1 mnc - Mobile network code. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -mobileFlowFieldsVersion Number 0..1 mobileFlowFieldsVersion - Version of the mobileFlowFields block. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -msisdn String 0..1 msisdn - MSISDN for the subscriber UE used in this flow, as an integer, if the flow connects to a mobile device. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -otherEndpointlpAddress String 0..1 otherEndpointIpAddress - IP address for the other endpoint, as used for the flow being reported on. OpenModelAttribute - Note: current data type (String) may be changed to Common Resource Datatype L3AddressData. =[gh]= - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -otherEndpointPort Number 0..1 otherEndpointPort - IP Port for the reporting entity, as used for the flow being reported on OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -otherFunctionalRole String 0..1 otherFunctionalRole - Functional role of the other endpoint for the flow being reported on e.g., MME, S-GW, P-GW, PCRF... OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -rac String 0..1 rac - Routing area code OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -radioAccessTechnology String 0..1 radioAccessTechnology - Radio Access Technology e.g., 2G, 3G, 4G and 5G. (GSM, UMTS, LTE, 5G) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -reportingEndpointlpAddr String 0..1 reportingEndpointIpAddr - IP address for the reporting entity, as used for the flow being reported on. OpenModelAttribute - Note: current data type (String) may be changed to Common Resource Datatype L3AddressData. =[gh]= - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -reportingEndpointPort Number 0..1 reportingEndpointPort - IP port for the reporting entity, as used for the flow being reported on. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sac String 0..1 sac - Service area code OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -samplingAlgorithm Number 0..1 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. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -tac String 0..1 tac - Transport area code OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -tunnelId String 0..1 tunnelId - Tunnel identifier OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -vlanId String 0..1 vlanId - VLAN identifier used by this flow OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -\_gtpperflowmetrics GtpPerFlowMetrics 1 Mobility GTP Protocol per flow metrics OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -domain Domain 1 Event domain enumeration: 'fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -eventType String 0..1 For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -lastEpochMicrosec Number 1 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 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfcNamingCode String 0..1 Network function component type: 3 characters (aligned with vfc naming standards) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfNamingCode String 0..1 Network function type: 4 characters (aligned with vnf and pnf naming standards) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfVendorName String 1 Network function vendor name OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -priority Priority 1 Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -reportingEntityId String 0..1 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. OpenModelAttribute - - | reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. - partOfObjectKey: 0 - | 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. - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -reportingEntityName String 1 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. 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. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sequence Integer 1 sequence - Ordering of events communicated by an event source instance (or 0 if not needed) OpenModelAttribute - - Ordering of events communicated by an event source instance (or 0 if not needed) - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sourceId String 0..1 | sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity OpenModelAttribute - | 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. - - partOfObjectKey: 0 - 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. - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sourceName String 1 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. 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. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -startingEpochMicrosec Number 1 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) 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…). - partOfObjectKey: 0 - | 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). - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -timeZoneOffset String 0..1 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 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -version String 1 Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -vesEventListenerVersion String 1 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). OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -name String 1 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -Status String 0..1 The current condition of an interaction, such as open, in research, closed, and so forth OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -description String 0..1 Defines a textual free-form description of the object. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -id Identifier 1 Identifier of this information element. This attribute shall be globally unique. OpenModelAttribute - - Unambiguously distinguishes different object instances. It is the naming attribute of the object. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -======================= ================= ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== - -NicPerformance class -^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::NicPerformance - -**Description:** +======================= ================= ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +additionalFields HashMap 0..1 Preliminary additionalFields - Additional mobileFlow fields if needed. Ves::ObjectClasses::MobileFlow::additionalFields + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +applicationType String 0..1 Preliminary applicationType - Application type inferred Ves::ObjectClasses::MobileFlow::applicationType + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +applProtocolType String 0..1 Preliminary applProtocolType - Application protocol. Ves::ObjectClasses::MobileFlow::applProtocolType + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +applProtocolVersion String 0..1 Preliminary applProtocolVersion - Application version. Ves::ObjectClasses::MobileFlow::applProtocolVersion + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +cid String 0..1 Preliminary cid - Cell Id. Ves::ObjectClasses::MobileFlow::cid + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +connectionType String 0..1 Preliminary connectionType - Abbreviation referencing a 3GPP reference point e.g., S1-U, S11, etc. Ves::ObjectClasses::MobileFlow::connectionType + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +ecgi String 0..1 Preliminary ecgi - Evolved Cell Global Id. Ves::ObjectClasses::MobileFlow::ecgi + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +flowDirection String 0..1 Preliminary flowDirection - Flow direction, indicating if the reporting node is the source of the flow or destination for the flow. Ves::ObjectClasses::MobileFlow::flowDirection + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +gtpProtocolType String 0..1 Preliminary gtpProtocolType - GTP protocol Ves::ObjectClasses::MobileFlow::gtpProtocolType + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +gtpVersion String 0..1 Preliminary gtpVersion - GTP protocol version. Ves::ObjectClasses::MobileFlow::gtpVersion + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +httpHeader String 0..1 Preliminary httpHeader - HTTP request header, if the flow connects to a node referenced by HTTP. Ves::ObjectClasses::MobileFlow::httpHeader + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +iemi String 0..1 Preliminary imei - IMEI for the subscriber UE used in this flow, if the flow connects to a mobile device. Ves::ObjectClasses::MobileFlow::iemi + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +imsi String 0..1 Preliminary imsi - IMSI for the subscriber UE used in this flow, if the flow connects to a mobile device Ves::ObjectClasses::MobileFlow::imsi + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +ipProtocolType String 0..1 Preliminary ipProtocolType - IP protocol type e.g., TCP, UDP, RTP... Ves::ObjectClasses::MobileFlow::ipProtocolType + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +ipVersion String 0..1 Preliminary ipVersion - IP protocol version e.g., IPv4, IPv6 Ves::ObjectClasses::MobileFlow::ipVersion + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +lac String 0..1 Preliminary lac - Location area code. Ves::ObjectClasses::MobileFlow::lac + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +mcc String 0..1 Preliminary mcc - Mobile country code. Ves::ObjectClasses::MobileFlow::mcc + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +mnc String 0..1 Preliminary mnc - Mobile network code. Ves::ObjectClasses::MobileFlow::mnc + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +mobileFlowFieldsVersion Number 0..1 Preliminary mobileFlowFieldsVersion - Version of the mobileFlowFields block. Ves::ObjectClasses::MobileFlow::mobileFlowFieldsVersion + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +msisdn String 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +otherEndpointlpAddress String 0..1 Preliminary otherEndpointIpAddress - IP address for the other endpoint, as used for the flow being reported on. Ves::ObjectClasses::MobileFlow::otherEndpointlpAddress + Note: current data type (String) may be changed to Common Resource Datatype L3AddressData. =[gh]= + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +otherEndpointPort Number 0..1 Preliminary otherEndpointPort - IP Port for the reporting entity, as used for the flow being reported on Ves::ObjectClasses::MobileFlow::otherEndpointPort + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +otherFunctionalRole String 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +rac String 0..1 Preliminary rac - Routing area code Ves::ObjectClasses::MobileFlow::rac + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +radioAccessTechnology String 0..1 Preliminary radioAccessTechnology - Radio Access Technology e.g., 2G, 3G, 4G and 5G. (GSM, UMTS, LTE, 5G) Ves::ObjectClasses::MobileFlow::radioAccessTechnology + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +reportingEndpointlpAddr String 0..1 Preliminary reportingEndpointIpAddr - IP address for the reporting entity, as used for the flow being reported on. Ves::ObjectClasses::MobileFlow::reportingEndpointlpAddr + Note: current data type (String) may be changed to Common Resource Datatype L3AddressData. =[gh]= + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +reportingEndpointPort Number 0..1 Preliminary reportingEndpointPort - IP port for the reporting entity, as used for the flow being reported on. Ves::ObjectClasses::MobileFlow::reportingEndpointPort + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sac String 0..1 Preliminary sac - Service area code Ves::ObjectClasses::MobileFlow::sac + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +samplingAlgorithm Number 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +tac String 0..1 Preliminary tac - Transport area code Ves::ObjectClasses::MobileFlow::tac + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +tunnelId String 0..1 Preliminary tunnelId - Tunnel identifier Ves::ObjectClasses::MobileFlow::tunnelId + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +vlanId String 0..1 Preliminary vlanId - VLAN identifier used by this flow Ves::ObjectClasses::MobileFlow::vlanId + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_gtpperflowmetrics GtpPerFlowMetrics 1 Preliminary Mobility GTP Protocol per flow metrics Ves::ObjectClasses::MobileFlow::_gtpperflowmetrics + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +domain Domain 1 Experimental Update in definition only Ves::ObjectClasses::VesEvent::domain + + OpenModelAttribute Event domain enumeration: 'cmNotify','fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +eventType String 0..1 Preliminary For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' Ves::ObjectClasses::VesEvent::eventType + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +lastEpochMicrosec Number 1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfcNamingCode String 0..1 Preliminary Network function component type: 3 characters (aligned with vfc naming standards) Ves::ObjectClasses::VesEvent::nfcNamingCode + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfNamingCode String 0..1 Preliminary Network function type: 4 characters (aligned with vnf and pnf naming standards) Ves::ObjectClasses::VesEvent::nfNamingCode + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfVendorName String 1 Preliminary Network function vendor name Ves::ObjectClasses::VesEvent::nfVendorName + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +priority Priority 1 Preliminary Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' Ves::ObjectClasses::VesEvent::priority + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +reportingEntityId String 0..1 Preliminary 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. Ves::ObjectClasses::VesEvent::reportingEntityId + + OpenModelAttribute 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. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +reportingEntityName String 1 Preliminary 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. Ves::ObjectClasses::VesEvent::reportingEntityName + + OpenModelAttribute 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. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sequence Integer 1 Preliminary sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ves::ObjectClasses::VesEvent::sequence + + OpenModelAttribute Ordering of events communicated by an event source instance (or 0 if not needed) + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sourceId String 0..1 Preliminary 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. Ves::ObjectClasses::VesEvent::sourceId + + OpenModelAttribute 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. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sourceName String 1 Preliminary 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 + + OpenModelAttribute 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. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +startingEpochMicrosec Number 1 Preliminary 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…). Ves::ObjectClasses::VesEvent::startingEpochMicrosec + 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). + OpenModelAttribute + 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) + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +timeZoneOffset String 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +version String 1 Preliminary Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. Ves::ObjectClasses::VesEvent::version + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +vesEventListenerVersion String 1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +name String 1 Preliminary Ves::ObjectClasses::VesEvent::name + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +Status String 0..1 Preliminary The current condition of an interaction, such as open, in research, closed, and so forth Common::Business Interaction::ObjectClasses::BusinessInteraction::Status + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +description String 0..1 Preliminary Defines a textual free-form description of the object. Common::Root::RootObjectClasses::RootEntity::description + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +id Identifier 1 Preliminary Identifier of this information element. This attribute shall be globally unique. Common::Root::RootObjectClasses::RootEntity::id + + OpenModelAttribute Unambiguously distinguishes different object instances. It is the naming attribute of the object. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +======================= ================= ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== + +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:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class NicPerformance** - -====================================== ============= ========= ================================================================================================================================================================================== ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -====================================== ============= ========= ================================================================================================================================================================================== ===================== -administrativeState NicAdminState 0..1 Administrative state: enum: 'inService', 'outOfService' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nicIdentifier String 1 Network interface card identifier OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -operationalState NicOpsState 0..1 Operational state: enum: 'inService', 'outOfService' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -receivedBroadcastPacketsAccumulated Number 0..1 Cumulative count of broadcast packets received as read at the end of the measurement interval OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -receivedBroadcastPacketsDelta Number 0..1 Count of broadcast packets received within the measurement interval OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -receivedDiscardedPacketsAccumulated Number 0..1 Cumulative count of discarded packets received as read at the end of the measurement interval OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -receivedDiscardedPacketsDelta Number 0..1 Count of discarded packets received within the measurement interval OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -receivedErrorPacketsAccumulated Number 0..1 Cumulative count of error packets received as read at the end of the measurement interval OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -receivedErrorPacketsDelta Number 0..1 Count of error packets received within the measurement interval OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -receivedMulticastPacketsAccumulated Number 0..1 Cumulative count of multicast packets received as read at the end of the measurement interval OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -receivedMulticastPacketsDelta Number 0..1 Count of multicast packets received within the measurement interval OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -receivedOctetsAccumulated Number 0..1 Cumulative count of octets received as read at the end of the measurement interval OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -receivedOctetsDelta Number 0..1 Count of octets received within the measurement interval OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -receivedPercentDiscard Number 0..1 Percentage of discarded packets received; value = (receivedDiscardedPacketsDelta / receivedTotalPacketsDelta) x 100, if denominator is nonzero, or 0, if otherwise. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -receivedPercentError Number 0..1 Percentage of error packets received; value = (receivedErrorPacketsDelta / receivedTotalPacketsDelta) x 100, if denominator is nonzero, or 0, if otherwise. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -receivedTotalPacketsAccumulated Number 0..1 Cumulative count of all packets received as read at the end of the measurement interval OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -receivedTotalPacketsDelta Number 0..1 Count of all packets received within the measurement interval OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -receivedUnicastPacketsAccumulated Number 0..1 Cumulative count of unicast packets received as read at the end of the measurement interval OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -receivedUnicastPacketsDelta Number 0..1 Count of unicast packets received within the measurement interval OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -receivedUtilization Number 0..1 Percentage of utilization received; value = (receivedOctetsDelta / (speed x (lastEpochMicrosec - startEpochMicrosec))) x 100, if denominator is nonzero, or 0, if otherwise. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -speed Number 0..1 Speed configured in mbps. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -transmittedBroadcastPacketsAccumulated Number 0..1 Cumulative count of broadcast packets transmitted as read at the end of the measurement interval OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -transmittedBroadcastPacketsDelta Number 0..1 Count of broadcast packets transmitted within the measurement interval OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -transmittedDiscardedPacketsAccumulated Number 0..1 Cumulative count of discarded packets transmitted as read at the end of the measurement interval OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -transmittedDiscardedPacketsDelta Number 0..1 Count of discarded packets transmitted within the measurement interval OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -transmittedErrorPacketsAccumulated Number 0..1 Cumulative count of error packets transmitted as read at the end of the measurement interval OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -transmittedErrorPacketsDelta Number 0..1 Count of error packets transmitted within the measurement interval OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -transmittedMulticastPacketsAccumulated Number 0..1 Cumulative count of multicast packets transmitted as read at the end of the measurement interval OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -transmittedMulticastPacketsDelta Number 0..1 Count of multicast packets transmitted within the measurement interval OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -transmittedOctetsAccumulated Number 0..1 Cumulative count of octets transmitted as read at the end of the measurement interval OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -transmittedOctetsDelta Number 0..1 Count of octets transmitted within the measurement interval OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -transmittedPercentDiscard Number 0..1 Percentage of discarded packets transmitted; value = (transmittedDiscardedPacketsDelta / transmittedTotalPacketsDelta) x 100, if denominator is nonzero, or 0, if otherwise. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -transmittedPercentError Number 0..1 Percentage of error packets received; value = (transmittedErrorPacketsDelta / transmittedTotalPacketsDelta) x 100, if denominator is nonzero, or 0, if otherwise. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -transmittedTotalPacketsAccumulated Number 0..1 Cumulative count of all packets transmitted as read at the end of the measurement interval OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -transmittedTotalPacketsDelta Number 0..1 Count of all packets transmitted within the measurement interval OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -transmittedUnicastPacketsAccumulated Number 0..1 Cumulative count of unicast packets transmitted as read at the end of the measurement interval OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -transmittedUnicastPacketsDelta Number 0..1 Count of unicast packets transmitted within the measurement interval OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -transmittedUtilization Number 0..1 Percentage of utilization transmitted; value = (transmittedOctetsDelta / (speed x (lastEpochMicrosec - startEpochMicrosec))) x 100, if denominator is nonzero, or 0, if otherwise. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -valuesAreSuspect Boolean 1 Enumeration: 'true' or 'false'. If 'true' then the vNicPerformance values are likely inaccurate due to counter overflow or other conditions. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -====================================== ============= ========= ================================================================================================================================================================================== ===================== +====================================== ============= ========= ================================== ================================================================================================================================================================================== ========================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +administrativeState NicAdminState 0..1 Preliminary Administrative state: enum: 'inService', 'outOfService' Ves::ObjectClasses::NicPerformance::administrativeState + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nicIdentifier String 1 Preliminary Network interface card identifier Ves::ObjectClasses::NicPerformance::nicIdentifier + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +operationalState NicOpsState 0..1 Preliminary Operational state: enum: 'inService', 'outOfService' Ves::ObjectClasses::NicPerformance::operationalState + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +receivedBroadcastPacketsAccumulated Number 0..1 Preliminary Cumulative count of broadcast packets received as read at the end of the measurement interval Ves::ObjectClasses::NicPerformance::receivedBroadcastPacketsAccumulated + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +receivedBroadcastPacketsDelta Number 0..1 Preliminary Count of broadcast packets received within the measurement interval Ves::ObjectClasses::NicPerformance::receivedBroadcastPacketsDelta + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +receivedDiscardedPacketsAccumulated Number 0..1 Preliminary Cumulative count of discarded packets received as read at the end of the measurement interval Ves::ObjectClasses::NicPerformance::receivedDiscardedPacketsAccumulated + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +receivedDiscardedPacketsDelta Number 0..1 Preliminary Count of discarded packets received within the measurement interval Ves::ObjectClasses::NicPerformance::receivedDiscardedPacketsDelta + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +receivedErrorPacketsAccumulated Number 0..1 Preliminary Cumulative count of error packets received as read at the end of the measurement interval Ves::ObjectClasses::NicPerformance::receivedErrorPacketsAccumulated + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +receivedErrorPacketsDelta Number 0..1 Preliminary Count of error packets received within the measurement interval Ves::ObjectClasses::NicPerformance::receivedErrorPacketsDelta + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +receivedMulticastPacketsAccumulated Number 0..1 Preliminary Cumulative count of multicast packets received as read at the end of the measurement interval Ves::ObjectClasses::NicPerformance::receivedMulticastPacketsAccumulated + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +receivedMulticastPacketsDelta Number 0..1 Preliminary Count of multicast packets received within the measurement interval Ves::ObjectClasses::NicPerformance::receivedMulticastPacketsDelta + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +receivedOctetsAccumulated Number 0..1 Preliminary Cumulative count of octets received as read at the end of the measurement interval Ves::ObjectClasses::NicPerformance::receivedOctetsAccumulated + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +receivedOctetsDelta Number 0..1 Preliminary Count of octets received within the measurement interval Ves::ObjectClasses::NicPerformance::receivedOctetsDelta + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +receivedPercentDiscard Number 0..1 Preliminary Percentage of discarded packets received; value = (receivedDiscardedPacketsDelta / receivedTotalPacketsDelta) x 100, if denominator is nonzero, or 0, if otherwise. Ves::ObjectClasses::NicPerformance::receivedPercentDiscard + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +receivedPercentError Number 0..1 Preliminary Percentage of error packets received; value = (receivedErrorPacketsDelta / receivedTotalPacketsDelta) x 100, if denominator is nonzero, or 0, if otherwise. Ves::ObjectClasses::NicPerformance::receivedPercentError + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +receivedTotalPacketsAccumulated Number 0..1 Preliminary Cumulative count of all packets received as read at the end of the measurement interval Ves::ObjectClasses::NicPerformance::receivedTotalPacketsAccumulated + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +receivedTotalPacketsDelta Number 0..1 Preliminary Count of all packets received within the measurement interval Ves::ObjectClasses::NicPerformance::receivedTotalPacketsDelta + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +receivedUnicastPacketsAccumulated Number 0..1 Preliminary Cumulative count of unicast packets received as read at the end of the measurement interval Ves::ObjectClasses::NicPerformance::receivedUnicastPacketsAccumulated + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +receivedUnicastPacketsDelta Number 0..1 Preliminary Count of unicast packets received within the measurement interval Ves::ObjectClasses::NicPerformance::receivedUnicastPacketsDelta + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +receivedUtilization Number 0..1 Preliminary Percentage of utilization received; value = (receivedOctetsDelta / (speed x (lastEpochMicrosec - startEpochMicrosec))) x 100, if denominator is nonzero, or 0, if otherwise. Ves::ObjectClasses::NicPerformance::receivedUtilization + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +speed Number 0..1 Preliminary Speed configured in mbps. Ves::ObjectClasses::NicPerformance::speed + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +transmittedBroadcastPacketsAccumulated Number 0..1 Preliminary Cumulative count of broadcast packets transmitted as read at the end of the measurement interval Ves::ObjectClasses::NicPerformance::transmittedBroadcastPacketsAccumulated + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +transmittedBroadcastPacketsDelta Number 0..1 Preliminary Count of broadcast packets transmitted within the measurement interval Ves::ObjectClasses::NicPerformance::transmittedBroadcastPacketsDelta + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +transmittedDiscardedPacketsAccumulated Number 0..1 Preliminary Cumulative count of discarded packets transmitted as read at the end of the measurement interval Ves::ObjectClasses::NicPerformance::transmittedDiscardedPacketsAccumulated + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +transmittedDiscardedPacketsDelta Number 0..1 Preliminary Count of discarded packets transmitted within the measurement interval Ves::ObjectClasses::NicPerformance::transmittedDiscardedPacketsDelta + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +transmittedErrorPacketsAccumulated Number 0..1 Preliminary Cumulative count of error packets transmitted as read at the end of the measurement interval Ves::ObjectClasses::NicPerformance::transmittedErrorPacketsAccumulated + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +transmittedErrorPacketsDelta Number 0..1 Preliminary Count of error packets transmitted within the measurement interval Ves::ObjectClasses::NicPerformance::transmittedErrorPacketsDelta + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +transmittedMulticastPacketsAccumulated Number 0..1 Preliminary Cumulative count of multicast packets transmitted as read at the end of the measurement interval Ves::ObjectClasses::NicPerformance::transmittedMulticastPacketsAccumulated + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +transmittedMulticastPacketsDelta Number 0..1 Preliminary Count of multicast packets transmitted within the measurement interval Ves::ObjectClasses::NicPerformance::transmittedMulticastPacketsDelta + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +transmittedOctetsAccumulated Number 0..1 Preliminary Cumulative count of octets transmitted as read at the end of the measurement interval Ves::ObjectClasses::NicPerformance::transmittedOctetsAccumulated + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +transmittedOctetsDelta Number 0..1 Preliminary Count of octets transmitted within the measurement interval Ves::ObjectClasses::NicPerformance::transmittedOctetsDelta + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +transmittedPercentDiscard Number 0..1 Preliminary Percentage of discarded packets transmitted; value = (transmittedDiscardedPacketsDelta / transmittedTotalPacketsDelta) x 100, if denominator is nonzero, or 0, if otherwise. Ves::ObjectClasses::NicPerformance::transmittedPercentDiscard + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +transmittedPercentError Number 0..1 Preliminary Percentage of error packets received; value = (transmittedErrorPacketsDelta / transmittedTotalPacketsDelta) x 100, if denominator is nonzero, or 0, if otherwise. Ves::ObjectClasses::NicPerformance::transmittedPercentError + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +transmittedTotalPacketsAccumulated Number 0..1 Preliminary Cumulative count of all packets transmitted as read at the end of the measurement interval Ves::ObjectClasses::NicPerformance::transmittedTotalPacketsAccumulated + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +transmittedTotalPacketsDelta Number 0..1 Preliminary Count of all packets transmitted within the measurement interval Ves::ObjectClasses::NicPerformance::transmittedTotalPacketsDelta + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +transmittedUnicastPacketsAccumulated Number 0..1 Preliminary Cumulative count of unicast packets transmitted as read at the end of the measurement interval Ves::ObjectClasses::NicPerformance::transmittedUnicastPacketsAccumulated + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +transmittedUnicastPacketsDelta Number 0..1 Preliminary Count of unicast packets transmitted within the measurement interval Ves::ObjectClasses::NicPerformance::transmittedUnicastPacketsDelta + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +transmittedUtilization Number 0..1 Preliminary Percentage of utilization transmitted; value = (transmittedOctetsDelta / (speed x (lastEpochMicrosec - startEpochMicrosec))) x 100, if denominator is nonzero, or 0, if otherwise. Ves::ObjectClasses::NicPerformance::transmittedUtilization + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +valuesAreSuspect Boolean 1 Preliminary Enumeration: 'true' or 'false'. If 'true' then the vNicPerformance values are likely inaccurate due to counter overflow or other conditions. Ves::ObjectClasses::NicPerformance::valuesAreSuspect + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +====================================== ============= ========= ================================== ================================================================================================================================================================================== ========================================================================== diff --git a/docs/ONAP Model Spec/im/VES/VES-class-2.rst b/docs/ONAP Model Spec/im/VES/VES-class-2.rst index 9711f8b..c32ff53 100644 --- a/docs/ONAP Model Spec/im/VES/VES-class-2.rst +++ b/docs/ONAP Model Spec/im/VES/VES-class-2.rst @@ -1,4 +1,4 @@ -.. Copyright 2019 +.. Copyright 2021 .. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE .. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode @@ -9,4911 +9,3059 @@ VES Class Definition - part 2 :depth: 3 .. -Notification class -^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::Notification - -**Description:** +Notification +~~~~~~~~~~~~ Fields specific to notification events **Parent class:** VesEvent -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class Notification** - -========================= ============ ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -========================= ============ ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== -additionalFields HashMap 0..1 Additional notification fields if needed. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -arrayOfNamedHashMap NamedHashMap 0..1 arrayOfNamedHashMap - Array of named hashMaps OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -changeContact String 0..1 Identifier for a contact related to the change. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -changeIdentifier String 1 System or session identifier associated with the change. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -changeType String 1 Describes what has changed for the entity, for example: configuration changed, capability added, capability removed… OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -newState String 0..1 New state of the entity, for example: 'inService', 'maintenance', 'outOfService' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -notificationFieldsVersion Number 1 Version of the notificationFields block as "#.#" where # is a digit; see section 1 for the correct digits to use. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -oldState String 0..1 Previous state of the entity. OpenModelAttribute - For example: "inService", "outOfService", "maintenance" - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -stateInterface String 0..\* Card or port name of the entity that changed state. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -domain Domain 1 Event domain enumeration: 'fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -eventType String 0..1 For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -lastEpochMicrosec Number 1 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 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfcNamingCode String 0..1 Network function component type: 3 characters (aligned with vfc naming standards) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfNamingCode String 0..1 Network function type: 4 characters (aligned with vnf and pnf naming standards) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfVendorName String 1 Network function vendor name OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -priority Priority 1 Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -reportingEntityId String 0..1 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. OpenModelAttribute - - | reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. - partOfObjectKey: 0 - | 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. - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -reportingEntityName String 1 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. 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. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sequence Integer 1 sequence - Ordering of events communicated by an event source instance (or 0 if not needed) OpenModelAttribute - - Ordering of events communicated by an event source instance (or 0 if not needed) - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sourceId String 0..1 | sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity OpenModelAttribute - | 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. - - partOfObjectKey: 0 - 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. - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sourceName String 1 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. 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. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -startingEpochMicrosec Number 1 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) 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…). - partOfObjectKey: 0 - | 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). - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -timeZoneOffset String 0..1 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 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -version String 1 Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -vesEventListenerVersion String 1 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). OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -name String 1 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -Status String 0..1 The current condition of an interaction, such as open, in research, closed, and so forth OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -description String 0..1 Defines a textual free-form description of the object. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -id Identifier 1 Identifier of this information element. This attribute shall be globally unique. OpenModelAttribute - - Unambiguously distinguishes different object instances. It is the naming attribute of the object. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -========================= ============ ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== - -Other class -^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::Other - -**Description:** +========================= ============ ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +additionalFields HashMap 0..1 Preliminary Additional notification fields if needed. Ves::ObjectClasses::Notification::additionalFields + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +arrayOfNamedHashMap NamedHashMap 0..1 Preliminary arrayOfNamedHashMap - Array of named hashMaps Ves::ObjectClasses::Notification::arrayOfNamedHashMap + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +changeContact String 0..1 Preliminary Identifier for a contact related to the change. Ves::ObjectClasses::Notification::changeContact + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +changeIdentifier String 1 Preliminary System or session identifier associated with the change. Ves::ObjectClasses::Notification::changeIdentifier + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +changeType String 1 Preliminary Describes what has changed for the entity, for example: configuration changed, capability added, capability removed… Ves::ObjectClasses::Notification::changeType + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +newState String 0..1 Preliminary New state of the entity, for example: 'inService', 'maintenance', 'outOfService' Ves::ObjectClasses::Notification::newState + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +notificationFieldsVersion Number 1 Preliminary Version of the notificationFields block as "#.#" where # is a digit; see section 1 for the correct digits to use. Ves::ObjectClasses::Notification::notificationFieldsVersion + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +oldState String 0..1 Preliminary Previous state of the entity. Ves::ObjectClasses::Notification::oldState + For example: "inService", "outOfService", "maintenance" + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +stateInterface String 0..\* Preliminary Card or port name of the entity that changed state. Ves::ObjectClasses::Notification::stateInterface + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +domain Domain 1 Experimental Update in definition only Ves::ObjectClasses::VesEvent::domain + + OpenModelAttribute Event domain enumeration: 'cmNotify','fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +eventType String 0..1 Preliminary For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' Ves::ObjectClasses::VesEvent::eventType + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +lastEpochMicrosec Number 1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfcNamingCode String 0..1 Preliminary Network function component type: 3 characters (aligned with vfc naming standards) Ves::ObjectClasses::VesEvent::nfcNamingCode + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfNamingCode String 0..1 Preliminary Network function type: 4 characters (aligned with vnf and pnf naming standards) Ves::ObjectClasses::VesEvent::nfNamingCode + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfVendorName String 1 Preliminary Network function vendor name Ves::ObjectClasses::VesEvent::nfVendorName + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +priority Priority 1 Preliminary Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' Ves::ObjectClasses::VesEvent::priority + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +reportingEntityId String 0..1 Preliminary 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. Ves::ObjectClasses::VesEvent::reportingEntityId + + OpenModelAttribute 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. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +reportingEntityName String 1 Preliminary 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. Ves::ObjectClasses::VesEvent::reportingEntityName + + OpenModelAttribute 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. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sequence Integer 1 Preliminary sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ves::ObjectClasses::VesEvent::sequence + + OpenModelAttribute Ordering of events communicated by an event source instance (or 0 if not needed) + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sourceId String 0..1 Preliminary 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. Ves::ObjectClasses::VesEvent::sourceId + + OpenModelAttribute 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. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sourceName String 1 Preliminary 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 + + OpenModelAttribute 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. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +startingEpochMicrosec Number 1 Preliminary 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…). Ves::ObjectClasses::VesEvent::startingEpochMicrosec + 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). + OpenModelAttribute + 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) + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +timeZoneOffset String 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +version String 1 Preliminary Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. Ves::ObjectClasses::VesEvent::version + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +vesEventListenerVersion String 1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +name String 1 Preliminary Ves::ObjectClasses::VesEvent::name + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +Status String 0..1 Preliminary The current condition of an interaction, such as open, in research, closed, and so forth Common::Business Interaction::ObjectClasses::BusinessInteraction::Status + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +description String 0..1 Preliminary Defines a textual free-form description of the object. Common::Root::RootObjectClasses::RootEntity::description + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +id Identifier 1 Preliminary Identifier of this information element. This attribute shall be globally unique. Common::Root::RootObjectClasses::RootEntity::id + + OpenModelAttribute Unambiguously distinguishes different object instances. It is the naming attribute of the object. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +========================= ============ ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== + +Other +~~~~~ The otherFields datatype defines fields for events belonging to the 'other' domain of the commonEventHeader domain enumeration. **Parent class:** VesEvent -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class Other** - -======================= =================== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -======================= =================== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== -arrayofNamedHashMap ArrayofNamedHashMap 0..\* Array of named hashMaps OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -hashMap HashMap 0..1 Array of name-value pairs. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -schemaObjects ArrayOfSchemaObject 0..1 Array of schema objects described by name, schema and other meta-information. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -otherFieldsVersion String 1 Version of the otherFields block as "#.#" where # is a digit; see section 1 for the correct digits to use. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -domain Domain 1 Event domain enumeration: 'fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -eventType String 0..1 For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -lastEpochMicrosec Number 1 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 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfcNamingCode String 0..1 Network function component type: 3 characters (aligned with vfc naming standards) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfNamingCode String 0..1 Network function type: 4 characters (aligned with vnf and pnf naming standards) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfVendorName String 1 Network function vendor name OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -priority Priority 1 Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -reportingEntityId String 0..1 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. OpenModelAttribute - - | reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. - partOfObjectKey: 0 - | 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. - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -reportingEntityName String 1 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. 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. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sequence Integer 1 sequence - Ordering of events communicated by an event source instance (or 0 if not needed) OpenModelAttribute - - Ordering of events communicated by an event source instance (or 0 if not needed) - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sourceId String 0..1 | sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity OpenModelAttribute - | 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. - - partOfObjectKey: 0 - 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. - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sourceName String 1 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. 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. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -startingEpochMicrosec Number 1 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) 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…). - partOfObjectKey: 0 - | 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). - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -timeZoneOffset String 0..1 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 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -version String 1 Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -vesEventListenerVersion String 1 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). OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -name String 1 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -Status String 0..1 The current condition of an interaction, such as open, in research, closed, and so forth OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -description String 0..1 Defines a textual free-form description of the object. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -id Identifier 1 Identifier of this information element. This attribute shall be globally unique. OpenModelAttribute - - Unambiguously distinguishes different object instances. It is the naming attribute of the object. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -======================= =================== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== - -Perf3gpp class -^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::Perf3gpp +======================= =================== ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +arrayofNamedHashMap ArrayofNamedHashMap 0..\* Preliminary Array of named hashMaps Ves::ObjectClasses::Other::arrayofNamedHashMap + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +hashMap HashMap 0..1 Preliminary Array of name-value pairs. Ves::ObjectClasses::Other::hashMap + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +schemaObjects ArrayOfSchemaObject 0..1 Preliminary Array of schema objects described by name, schema and other meta-information. Ves::ObjectClasses::Other::schemaObjects + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +otherFieldsVersion String 1 Preliminary Version of the otherFields block as "#.#" where # is a digit; see section 1 for the correct digits to use. Ves::ObjectClasses::Other::otherFieldsVersion + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +domain Domain 1 Experimental Update in definition only Ves::ObjectClasses::VesEvent::domain + + OpenModelAttribute Event domain enumeration: 'cmNotify','fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +eventType String 0..1 Preliminary For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' Ves::ObjectClasses::VesEvent::eventType + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +lastEpochMicrosec Number 1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfcNamingCode String 0..1 Preliminary Network function component type: 3 characters (aligned with vfc naming standards) Ves::ObjectClasses::VesEvent::nfcNamingCode + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfNamingCode String 0..1 Preliminary Network function type: 4 characters (aligned with vnf and pnf naming standards) Ves::ObjectClasses::VesEvent::nfNamingCode + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfVendorName String 1 Preliminary Network function vendor name Ves::ObjectClasses::VesEvent::nfVendorName + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +priority Priority 1 Preliminary Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' Ves::ObjectClasses::VesEvent::priority + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +reportingEntityId String 0..1 Preliminary 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. Ves::ObjectClasses::VesEvent::reportingEntityId + + OpenModelAttribute 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. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +reportingEntityName String 1 Preliminary 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. Ves::ObjectClasses::VesEvent::reportingEntityName + + OpenModelAttribute 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. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sequence Integer 1 Preliminary sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ves::ObjectClasses::VesEvent::sequence + + OpenModelAttribute Ordering of events communicated by an event source instance (or 0 if not needed) + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sourceId String 0..1 Preliminary 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. Ves::ObjectClasses::VesEvent::sourceId + + OpenModelAttribute 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. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sourceName String 1 Preliminary 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 + + OpenModelAttribute 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. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +startingEpochMicrosec Number 1 Preliminary 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…). Ves::ObjectClasses::VesEvent::startingEpochMicrosec + 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). + OpenModelAttribute + 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) + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +timeZoneOffset String 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +version String 1 Preliminary Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. Ves::ObjectClasses::VesEvent::version + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +vesEventListenerVersion String 1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +name String 1 Preliminary Ves::ObjectClasses::VesEvent::name + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +Status String 0..1 Preliminary The current condition of an interaction, such as open, in research, closed, and so forth Common::Business Interaction::ObjectClasses::BusinessInteraction::Status + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +description String 0..1 Preliminary Defines a textual free-form description of the object. Common::Root::RootObjectClasses::RootEntity::description + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +id Identifier 1 Preliminary Identifier of this information element. This attribute shall be globally unique. Common::Root::RootObjectClasses::RootEntity::id + + OpenModelAttribute Unambiguously distinguishes different object instances. It is the naming attribute of the object. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +======================= =================== ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== + +Perf3gpp +~~~~~~~~ **Parent class:** VesEvent -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class Perf3gpp** - -======================= ================== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -======================= ================== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== -eventAddlFields HashMap 0..1 Additional key-value pairs if needed OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -perf3gppFieldsVersion String 1 Version of the perf3gpp event OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -\_measDataCollection MeasDataCollection 1 3GPP measurement collection structure OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -domain Domain 1 Event domain enumeration: 'fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -eventType String 0..1 For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -lastEpochMicrosec Number 1 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 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfcNamingCode String 0..1 Network function component type: 3 characters (aligned with vfc naming standards) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfNamingCode String 0..1 Network function type: 4 characters (aligned with vnf and pnf naming standards) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfVendorName String 1 Network function vendor name OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -priority Priority 1 Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -reportingEntityId String 0..1 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. OpenModelAttribute - - | reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. - partOfObjectKey: 0 - | 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. - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -reportingEntityName String 1 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. 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. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sequence Integer 1 sequence - Ordering of events communicated by an event source instance (or 0 if not needed) OpenModelAttribute - - Ordering of events communicated by an event source instance (or 0 if not needed) - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sourceId String 0..1 | sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity OpenModelAttribute - | 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. - - partOfObjectKey: 0 - 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. - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sourceName String 1 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. 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. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -startingEpochMicrosec Number 1 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) 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…). - partOfObjectKey: 0 - | 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). - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -timeZoneOffset String 0..1 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 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -version String 1 Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -vesEventListenerVersion String 1 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). OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -name String 1 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -Status String 0..1 The current condition of an interaction, such as open, in research, closed, and so forth OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -description String 0..1 Defines a textual free-form description of the object. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -id Identifier 1 Identifier of this information element. This attribute shall be globally unique. OpenModelAttribute - - Unambiguously distinguishes different object instances. It is the naming attribute of the object. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -======================= ================== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== - -PnfRegistration class -^^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::PnfRegistration - -**Description:** +======================= ================== ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +eventAddlFields HashMap 0..1 Preliminary Additional key-value pairs if needed Ves::ObjectClasses::Perf3gpp::eventAddlFields + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +perf3gppFieldsVersion String 1 Preliminary Version of the perf3gpp event Ves::ObjectClasses::Perf3gpp::perf3gppFieldsVersion + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_measDataCollection MeasDataCollection 1 Preliminary 3GPP measurement collection structure Ves::ObjectClasses::Perf3gpp::_measDataCollection + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +domain Domain 1 Experimental Update in definition only Ves::ObjectClasses::VesEvent::domain + + OpenModelAttribute Event domain enumeration: 'cmNotify','fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +eventType String 0..1 Preliminary For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' Ves::ObjectClasses::VesEvent::eventType + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +lastEpochMicrosec Number 1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfcNamingCode String 0..1 Preliminary Network function component type: 3 characters (aligned with vfc naming standards) Ves::ObjectClasses::VesEvent::nfcNamingCode + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfNamingCode String 0..1 Preliminary Network function type: 4 characters (aligned with vnf and pnf naming standards) Ves::ObjectClasses::VesEvent::nfNamingCode + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfVendorName String 1 Preliminary Network function vendor name Ves::ObjectClasses::VesEvent::nfVendorName + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +priority Priority 1 Preliminary Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' Ves::ObjectClasses::VesEvent::priority + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +reportingEntityId String 0..1 Preliminary 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. Ves::ObjectClasses::VesEvent::reportingEntityId + + OpenModelAttribute 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. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +reportingEntityName String 1 Preliminary 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. Ves::ObjectClasses::VesEvent::reportingEntityName + + OpenModelAttribute 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. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sequence Integer 1 Preliminary sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ves::ObjectClasses::VesEvent::sequence + + OpenModelAttribute Ordering of events communicated by an event source instance (or 0 if not needed) + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sourceId String 0..1 Preliminary 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. Ves::ObjectClasses::VesEvent::sourceId + + OpenModelAttribute 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. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sourceName String 1 Preliminary 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 + + OpenModelAttribute 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. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +startingEpochMicrosec Number 1 Preliminary 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…). Ves::ObjectClasses::VesEvent::startingEpochMicrosec + 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). + OpenModelAttribute + 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) + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +timeZoneOffset String 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +version String 1 Preliminary Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. Ves::ObjectClasses::VesEvent::version + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +vesEventListenerVersion String 1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +name String 1 Preliminary Ves::ObjectClasses::VesEvent::name + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +Status String 0..1 Preliminary The current condition of an interaction, such as open, in research, closed, and so forth Common::Business Interaction::ObjectClasses::BusinessInteraction::Status + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +description String 0..1 Preliminary Defines a textual free-form description of the object. Common::Root::RootObjectClasses::RootEntity::description + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +id Identifier 1 Preliminary Identifier of this information element. This attribute shall be globally unique. Common::Root::RootObjectClasses::RootEntity::id + + OpenModelAttribute Unambiguously distinguishes different object instances. It is the naming attribute of the object. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +======================= ================== ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== + +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:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class PnfRegistration** - -============================ ========== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -============================ ========== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== -additionalFields HashMap 0..1 Additional pnfRegistration fields if needed OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -lastServiceDate String 0..1 TS 32.692 dateOfLastService = date of last service; e.g. 15022017 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -macAddress String 0..1 MAC address of OAM interface of the unit OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -manufactureDate String 0..1 TS 32.692 dateOfManufacture = manufacture date of the unit; 24032016 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -modelNumber String 0..1 TS 32.692 versionNumber = version of the unit from vendor; e.g. AJ02. Maps to AAI equip-model OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -oamV4lpAddress String 0..1 IPv4 m-plane IP address to be used by the manager to contact the PNF OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -oamV6lpAddress String 0..1 IPv6 m-plane IP address to be used by the manager to contact the PNF OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -pnfRegistrationFieldsVersion String 1 Version of the registrationFields block as "#.#" where # is a digit; see section 1 for the correct digits to use. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -serialNumber String 0..1 TS 32.692 serialNumber = serial number of the unit; e.g. 6061ZW3 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -softwareVersion String 0..1 TS 32.692 swName = active SW running on the unit; e.g. 5gDUv18.05.201 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -unitFamily String 0..1 TS 32.692 vendorUnitFamilyType = general type of HW unit; e.g. BBU OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -unitType String 0..1 TS 32.692 vendorUnitTypeNumber = vendor name for the unit; e.g. Airscale OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -vendorName String 0..1 TS 32.692 vendorName = name of manufacturer; e.g. Nokia. Maps to AAI equip-vendor OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -domain Domain 1 Event domain enumeration: 'fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -eventType String 0..1 For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -lastEpochMicrosec Number 1 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 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfcNamingCode String 0..1 Network function component type: 3 characters (aligned with vfc naming standards) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfNamingCode String 0..1 Network function type: 4 characters (aligned with vnf and pnf naming standards) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfVendorName String 1 Network function vendor name OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -priority Priority 1 Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -reportingEntityId String 0..1 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. OpenModelAttribute - - | reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. - partOfObjectKey: 0 - | 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. - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -reportingEntityName String 1 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. 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. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sequence Integer 1 sequence - Ordering of events communicated by an event source instance (or 0 if not needed) OpenModelAttribute - - Ordering of events communicated by an event source instance (or 0 if not needed) - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sourceId String 0..1 | sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity OpenModelAttribute - | 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. - - partOfObjectKey: 0 - 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. - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sourceName String 1 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. 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. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -startingEpochMicrosec Number 1 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) 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…). - partOfObjectKey: 0 - | 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). - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -timeZoneOffset String 0..1 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 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -version String 1 Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -vesEventListenerVersion String 1 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). OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -name String 1 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -Status String 0..1 The current condition of an interaction, such as open, in research, closed, and so forth OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -description String 0..1 Defines a textual free-form description of the object. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -id Identifier 1 Identifier of this information element. This attribute shall be globally unique. OpenModelAttribute - - Unambiguously distinguishes different object instances. It is the naming attribute of the object. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -============================ ========== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== - -ProcessStats class -^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::ProcessStats - -**Description:** +============================ ========== ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +additionalFields HashMap 0..1 Preliminary Additional pnfRegistration fields if needed Ves::ObjectClasses::PnfRegistration::additionalFields + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +lastServiceDate String 0..1 Preliminary TS 32.692 dateOfLastService = date of last service; e.g. 15022017 Ves::ObjectClasses::PnfRegistration::lastServiceDate + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +macAddress String 0..1 Preliminary MAC address of OAM interface of the unit Ves::ObjectClasses::PnfRegistration::macAddress + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +manufactureDate String 0..1 Preliminary TS 32.692 dateOfManufacture = manufacture date of the unit; 24032016 Ves::ObjectClasses::PnfRegistration::manufactureDate + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +modelNumber String 0..1 Preliminary TS 32.692 versionNumber = version of the unit from vendor; e.g. AJ02. Maps to AAI equip-model Ves::ObjectClasses::PnfRegistration::modelNumber + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +oamV4lpAddress String 0..1 Preliminary IPv4 m-plane IP address to be used by the manager to contact the PNF Ves::ObjectClasses::PnfRegistration::oamV4lpAddress + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +oamV6lpAddress String 0..1 Preliminary IPv6 m-plane IP address to be used by the manager to contact the PNF Ves::ObjectClasses::PnfRegistration::oamV6lpAddress + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +pnfRegistrationFieldsVersion String 1 Preliminary Version of the registrationFields block as "#.#" where # is a digit; see section 1 for the correct digits to use. Ves::ObjectClasses::PnfRegistration::pnfRegistrationFieldsVersion + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +serialNumber String 0..1 Preliminary TS 32.692 serialNumber = serial number of the unit; e.g. 6061ZW3 Ves::ObjectClasses::PnfRegistration::serialNumber + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +softwareVersion String 0..1 Preliminary TS 32.692 swName = active SW running on the unit; e.g. 5gDUv18.05.201 Ves::ObjectClasses::PnfRegistration::softwareVersion + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +unitFamily String 0..1 Preliminary TS 32.692 vendorUnitFamilyType = general type of HW unit; e.g. BBU Ves::ObjectClasses::PnfRegistration::unitFamily + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +unitType String 0..1 Preliminary TS 32.692 vendorUnitTypeNumber = vendor name for the unit; e.g. Airscale Ves::ObjectClasses::PnfRegistration::unitType + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +vendorName String 0..1 Preliminary TS 32.692 vendorName = name of manufacturer; e.g. Nokia. Maps to AAI equip-vendor Ves::ObjectClasses::PnfRegistration::vendorName + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +domain Domain 1 Experimental Update in definition only Ves::ObjectClasses::VesEvent::domain + + OpenModelAttribute Event domain enumeration: 'cmNotify','fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +eventType String 0..1 Preliminary For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' Ves::ObjectClasses::VesEvent::eventType + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +lastEpochMicrosec Number 1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfcNamingCode String 0..1 Preliminary Network function component type: 3 characters (aligned with vfc naming standards) Ves::ObjectClasses::VesEvent::nfcNamingCode + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfNamingCode String 0..1 Preliminary Network function type: 4 characters (aligned with vnf and pnf naming standards) Ves::ObjectClasses::VesEvent::nfNamingCode + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfVendorName String 1 Preliminary Network function vendor name Ves::ObjectClasses::VesEvent::nfVendorName + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +priority Priority 1 Preliminary Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' Ves::ObjectClasses::VesEvent::priority + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +reportingEntityId String 0..1 Preliminary 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. Ves::ObjectClasses::VesEvent::reportingEntityId + + OpenModelAttribute 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. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +reportingEntityName String 1 Preliminary 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. Ves::ObjectClasses::VesEvent::reportingEntityName + + OpenModelAttribute 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. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sequence Integer 1 Preliminary sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ves::ObjectClasses::VesEvent::sequence + + OpenModelAttribute Ordering of events communicated by an event source instance (or 0 if not needed) + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sourceId String 0..1 Preliminary 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. Ves::ObjectClasses::VesEvent::sourceId + + OpenModelAttribute 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. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sourceName String 1 Preliminary 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 + + OpenModelAttribute 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. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +startingEpochMicrosec Number 1 Preliminary 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…). Ves::ObjectClasses::VesEvent::startingEpochMicrosec + 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). + OpenModelAttribute + 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) + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +timeZoneOffset String 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +version String 1 Preliminary Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. Ves::ObjectClasses::VesEvent::version + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +vesEventListenerVersion String 1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +name String 1 Preliminary Ves::ObjectClasses::VesEvent::name + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +Status String 0..1 Preliminary The current condition of an interaction, such as open, in research, closed, and so forth Common::Business Interaction::ObjectClasses::BusinessInteraction::Status + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +description String 0..1 Preliminary Defines a textual free-form description of the object. Common::Root::RootObjectClasses::RootEntity::description + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +id Identifier 1 Preliminary Identifier of this information element. This attribute shall be globally unique. Common::Root::RootObjectClasses::RootEntity::id + + OpenModelAttribute Unambiguously distinguishes different object instances. It is the naming attribute of the object. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +============================ ========== ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== + +ProcessStats +~~~~~~~~~~~~ The processStats datatype provides metrics on system processes; it consists of the following fields: -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class ProcessStats** - -================== ======== ========= =================================================== ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -================== ======== ========= =================================================== ===================== -forkRate Number 0..1 The number of threads created since the last reboot OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -processIdentifier String 1 processIdentifier OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -psStateBlocked Number 0..1 The number of processes in a blocked state OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -psStatePaging Number 0..1 The number of processes in a paging state OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -psStateRunning Number 0..1 The number of processes in a running state OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -psStateSleeping Number 0..1 The number of processes in a sleeping state OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -PsStateStopped Number 0..1 The number of processes in a stopped state OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -psStateZombie Number 0..1 The number of processes in a zombie state OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -================== ======== ========= =================================================== ===================== - -ProcessorDimmAggregateThermalMargin class -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::ProcessorDimmAggregateThermalMargin - -**Description:** +================== ======== ========= ================================== =================================================== =================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +forkRate Number 0..1 Preliminary The number of threads created since the last reboot Ves::ObjectClasses::ProcessStats::forkRate + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +processIdentifier String 1 Preliminary processIdentifier Ves::ObjectClasses::ProcessStats::processIdentifier + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +psStateBlocked Number 0..1 Preliminary The number of processes in a blocked state Ves::ObjectClasses::ProcessStats::psStateBlocked + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +psStatePaging Number 0..1 Preliminary The number of processes in a paging state Ves::ObjectClasses::ProcessStats::psStatePaging + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +psStateRunning Number 0..1 Preliminary The number of processes in a running state Ves::ObjectClasses::ProcessStats::psStateRunning + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +psStateSleeping Number 0..1 Preliminary The number of processes in a sleeping state Ves::ObjectClasses::ProcessStats::psStateSleeping + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +PsStateStopped Number 0..1 Preliminary The number of processes in a stopped state Ves::ObjectClasses::ProcessStats::PsStateStopped + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +psStateZombie Number 0..1 Preliminary The number of processes in a zombie state Ves::ObjectClasses::ProcessStats::psStateZombie + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= ================================== =================================================== =================================================== + +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:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class ProcessorDimmAggregateThermalMargin** - -============================================== ======== ========= ========================================================================================================================= ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -============================================== ======== ========= ========================================================================================================================= ===================== -processorDimmAggregateThermal MarginIdentifier String 1 identifier for the aggregate thermal margin metrics from the processor dual inline memory module OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -thermalMargin Number 1 the difference between the DIMM's current temperature, in celsius, and the DIMM's throttling thermal trip point OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -============================================== ======== ========= ========================================================================================================================= ===================== - -SipSignaling class -^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::SipSignaling - -**Description:** +============================================== ======== ========= ================================== =============================================================================================================== ======================================================================================================= +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +processorDimmAggregateThermal MarginIdentifier String 1 Preliminary identifier for the aggregate thermal margin metrics from the processor dual inline memory module Ves::ObjectClasses::ProcessorDimmAggregateThermalMargin::processorDimmAggregateThermal MarginIdentifier + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +thermalMargin Number 1 Preliminary the difference between the DIMM's current temperature, in celsius, and the DIMM's throttling thermal trip point Ves::ObjectClasses::ProcessorDimmAggregateThermalMargin::thermalMargin + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +============================================== ======== ========= ================================== =============================================================================================================== ======================================================================================================= + +SipSignaling +~~~~~~~~~~~~ sipSignalingFields - The sipSignalingFields datatype communicates information about SIP signaling messages, parameters and signaling state. **Parent class:** VesEvent -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class SipSignaling** - -========================== ================== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -========================== ================== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== -additionalInformation HashMap 0..1 zdditionalInformation - Additional sipSignalling fields. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -compressedSip String 0..1 compressedSip - The full SIP request/response including headers and bodies. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -correlator String 1 correlator - Constant across all events on this call. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -localipAddress String 1 localIpAddress - IP address on VNF. OpenModelAttribute - Note: current data type (String) may be changed to Common Resource Datatype L3AddressData. =[gh]= - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -localPort String 1 localPort - Port on VNF. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -remoteipAddress String 1 remoteIpAddress - IP address of peer endpoint. OpenModelAttribute - Note: current data type (String) may be changed to Common Resource Datatype L3AddressData. =[gh]= - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -remotePort String 1 remotePort - Port of peer endpoint OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sipSignaliingFieldsVersion String 1 sipSignalingFieldsVersion - Version of the sipSignalingFields block as "#.#" where # is a digit; see section 1 for the correct digits to use. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -summarySip String 0..1 summarySip - The SIP Method or Response ('INVITE', '200 OK', 'BYE', etc). OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -\_vendorNfnamefields VendorNfNameFields 1 Vendor, NF and nfModule names OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -domain Domain 1 Event domain enumeration: 'fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -eventType String 0..1 For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -lastEpochMicrosec Number 1 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 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfcNamingCode String 0..1 Network function component type: 3 characters (aligned with vfc naming standards) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfNamingCode String 0..1 Network function type: 4 characters (aligned with vnf and pnf naming standards) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfVendorName String 1 Network function vendor name OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -priority Priority 1 Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -reportingEntityId String 0..1 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. OpenModelAttribute - - | reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. - partOfObjectKey: 0 - | 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. - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -reportingEntityName String 1 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. 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. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sequence Integer 1 sequence - Ordering of events communicated by an event source instance (or 0 if not needed) OpenModelAttribute - - Ordering of events communicated by an event source instance (or 0 if not needed) - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sourceId String 0..1 | sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity OpenModelAttribute - | 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. - - partOfObjectKey: 0 - 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. - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sourceName String 1 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. 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. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -startingEpochMicrosec Number 1 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) 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…). - partOfObjectKey: 0 - | 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). - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -timeZoneOffset String 0..1 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 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -version String 1 Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -vesEventListenerVersion String 1 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). OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -name String 1 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -Status String 0..1 The current condition of an interaction, such as open, in research, closed, and so forth OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -description String 0..1 Defines a textual free-form description of the object. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -id Identifier 1 Identifier of this information element. This attribute shall be globally unique. OpenModelAttribute - - Unambiguously distinguishes different object instances. It is the naming attribute of the object. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -========================== ================== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== - -StateChange class -^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::StateChange - -**Description:** +========================== ================== ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +additionalInformation HashMap 0..1 Preliminary zdditionalInformation - Additional sipSignalling fields. Ves::ObjectClasses::SipSignaling::additionalInformation + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +compressedSip String 0..1 Preliminary compressedSip - The full SIP request/response including headers and bodies. Ves::ObjectClasses::SipSignaling::compressedSip + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +correlator String 1 Preliminary correlator - Constant across all events on this call. Ves::ObjectClasses::SipSignaling::correlator + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +localipAddress String 1 Preliminary localIpAddress - IP address on VNF. Ves::ObjectClasses::SipSignaling::localipAddress + Note: current data type (String) may be changed to Common Resource Datatype L3AddressData. =[gh]= + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +localPort String 1 Preliminary localPort - Port on VNF. Ves::ObjectClasses::SipSignaling::localPort + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +remoteipAddress String 1 Preliminary remoteIpAddress - IP address of peer endpoint. Ves::ObjectClasses::SipSignaling::remoteipAddress + Note: current data type (String) may be changed to Common Resource Datatype L3AddressData. =[gh]= + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +remotePort String 1 Preliminary remotePort - Port of peer endpoint Ves::ObjectClasses::SipSignaling::remotePort + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sipSignaliingFieldsVersion String 1 Preliminary sipSignalingFieldsVersion - Version of the sipSignalingFields block as "#.#" where # is a digit; see section 1 for the correct digits to use. Ves::ObjectClasses::SipSignaling::sipSignaliingFieldsVersion + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +summarySip String 0..1 Preliminary summarySip - The SIP Method or Response ('INVITE', '200 OK', 'BYE', etc). Ves::ObjectClasses::SipSignaling::summarySip + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_vendorNfnamefields VendorNfNameFields 1 Preliminary Vendor, NF and nfModule names Ves::ObjectClasses::SipSignaling::_vendorNfnamefields + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +domain Domain 1 Experimental Update in definition only Ves::ObjectClasses::VesEvent::domain + + OpenModelAttribute Event domain enumeration: 'cmNotify','fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +eventType String 0..1 Preliminary For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' Ves::ObjectClasses::VesEvent::eventType + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +lastEpochMicrosec Number 1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfcNamingCode String 0..1 Preliminary Network function component type: 3 characters (aligned with vfc naming standards) Ves::ObjectClasses::VesEvent::nfcNamingCode + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfNamingCode String 0..1 Preliminary Network function type: 4 characters (aligned with vnf and pnf naming standards) Ves::ObjectClasses::VesEvent::nfNamingCode + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfVendorName String 1 Preliminary Network function vendor name Ves::ObjectClasses::VesEvent::nfVendorName + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +priority Priority 1 Preliminary Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' Ves::ObjectClasses::VesEvent::priority + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +reportingEntityId String 0..1 Preliminary 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. Ves::ObjectClasses::VesEvent::reportingEntityId + + OpenModelAttribute 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. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +reportingEntityName String 1 Preliminary 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. Ves::ObjectClasses::VesEvent::reportingEntityName + + OpenModelAttribute 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. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sequence Integer 1 Preliminary sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ves::ObjectClasses::VesEvent::sequence + + OpenModelAttribute Ordering of events communicated by an event source instance (or 0 if not needed) + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sourceId String 0..1 Preliminary 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. Ves::ObjectClasses::VesEvent::sourceId + + OpenModelAttribute 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. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sourceName String 1 Preliminary 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 + + OpenModelAttribute 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. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +startingEpochMicrosec Number 1 Preliminary 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…). Ves::ObjectClasses::VesEvent::startingEpochMicrosec + 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). + OpenModelAttribute + 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) + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +timeZoneOffset String 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +version String 1 Preliminary Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. Ves::ObjectClasses::VesEvent::version + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +vesEventListenerVersion String 1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +name String 1 Preliminary Ves::ObjectClasses::VesEvent::name + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +Status String 0..1 Preliminary The current condition of an interaction, such as open, in research, closed, and so forth Common::Business Interaction::ObjectClasses::BusinessInteraction::Status + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +description String 0..1 Preliminary Defines a textual free-form description of the object. Common::Root::RootObjectClasses::RootEntity::description + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +id Identifier 1 Preliminary Identifier of this information element. This attribute shall be globally unique. Common::Root::RootObjectClasses::RootEntity::id + + OpenModelAttribute Unambiguously distinguishes different object instances. It is the naming attribute of the object. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +========================== ================== ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== + +StateChange +~~~~~~~~~~~ Fields specific to state change events. **Parent class:** VesEvent -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class StateChange** - -======================== ========== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -======================== ========== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== -additionalFields HashMap 0..1 Additional stateChange fields if needed OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -newState 1 New state of the entity: 'inService', 'maintenance', 'outOfService' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -OldState 1 Previous state of the entity: 'inService', 'maintenance', 'outOfService' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -stateChangeFieldsVersion String 1 Version of the stateChangeFields block as "#.#" where # is a digit; see section 1 for the correct digits to use. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -stateInterface String 1 Card or port name of the entity that changed state OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -domain Domain 1 Event domain enumeration: 'fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -eventType String 0..1 For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -lastEpochMicrosec Number 1 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 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfcNamingCode String 0..1 Network function component type: 3 characters (aligned with vfc naming standards) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfNamingCode String 0..1 Network function type: 4 characters (aligned with vnf and pnf naming standards) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfVendorName String 1 Network function vendor name OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -priority Priority 1 Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -reportingEntityId String 0..1 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. OpenModelAttribute - - | reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. - partOfObjectKey: 0 - | 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. - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -reportingEntityName String 1 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. 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. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sequence Integer 1 sequence - Ordering of events communicated by an event source instance (or 0 if not needed) OpenModelAttribute - - Ordering of events communicated by an event source instance (or 0 if not needed) - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sourceId String 0..1 | sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity OpenModelAttribute - | 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. - - partOfObjectKey: 0 - 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. - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sourceName String 1 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. 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. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -startingEpochMicrosec Number 1 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) 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…). - partOfObjectKey: 0 - | 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). - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -timeZoneOffset String 0..1 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 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -version String 1 Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -vesEventListenerVersion String 1 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). OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -name String 1 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -Status String 0..1 The current condition of an interaction, such as open, in research, closed, and so forth OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -description String 0..1 Defines a textual free-form description of the object. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -id Identifier 1 Identifier of this information element. This attribute shall be globally unique. OpenModelAttribute - - Unambiguously distinguishes different object instances. It is the naming attribute of the object. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -======================== ========== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== +======================== ========== ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +additionalFields HashMap 0..1 Preliminary Additional stateChange fields if needed Ves::ObjectClasses::StateChange::additionalFields + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +newState invalid 1 Preliminary New state of the entity: 'inService', 'maintenance', 'outOfService' Ves::ObjectClasses::StateChange::newState + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +OldState invalid 1 Preliminary Previous state of the entity: 'inService', 'maintenance', 'outOfService' Ves::ObjectClasses::StateChange::OldState + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +stateChangeFieldsVersion String 1 Preliminary Version of the stateChangeFields block as "#.#" where # is a digit; see section 1 for the correct digits to use. Ves::ObjectClasses::StateChange::stateChangeFieldsVersion + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +stateInterface String 1 Preliminary Card or port name of the entity that changed state Ves::ObjectClasses::StateChange::stateInterface + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +domain Domain 1 Experimental Update in definition only Ves::ObjectClasses::VesEvent::domain + + OpenModelAttribute Event domain enumeration: 'cmNotify','fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +eventType String 0..1 Preliminary For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' Ves::ObjectClasses::VesEvent::eventType + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +lastEpochMicrosec Number 1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfcNamingCode String 0..1 Preliminary Network function component type: 3 characters (aligned with vfc naming standards) Ves::ObjectClasses::VesEvent::nfcNamingCode + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfNamingCode String 0..1 Preliminary Network function type: 4 characters (aligned with vnf and pnf naming standards) Ves::ObjectClasses::VesEvent::nfNamingCode + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfVendorName String 1 Preliminary Network function vendor name Ves::ObjectClasses::VesEvent::nfVendorName + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +priority Priority 1 Preliminary Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' Ves::ObjectClasses::VesEvent::priority + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +reportingEntityId String 0..1 Preliminary 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. Ves::ObjectClasses::VesEvent::reportingEntityId + + OpenModelAttribute 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. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +reportingEntityName String 1 Preliminary 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. Ves::ObjectClasses::VesEvent::reportingEntityName + + OpenModelAttribute 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. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sequence Integer 1 Preliminary sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ves::ObjectClasses::VesEvent::sequence + + OpenModelAttribute Ordering of events communicated by an event source instance (or 0 if not needed) + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sourceId String 0..1 Preliminary 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. Ves::ObjectClasses::VesEvent::sourceId + + OpenModelAttribute 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. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sourceName String 1 Preliminary 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 + + OpenModelAttribute 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. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +startingEpochMicrosec Number 1 Preliminary 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…). Ves::ObjectClasses::VesEvent::startingEpochMicrosec + 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). + OpenModelAttribute + 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) + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +timeZoneOffset String 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +version String 1 Preliminary Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. Ves::ObjectClasses::VesEvent::version + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +vesEventListenerVersion String 1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +name String 1 Preliminary Ves::ObjectClasses::VesEvent::name + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +Status String 0..1 Preliminary The current condition of an interaction, such as open, in research, closed, and so forth Common::Business Interaction::ObjectClasses::BusinessInteraction::Status + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +description String 0..1 Preliminary Defines a textual free-form description of the object. Common::Root::RootObjectClasses::RootEntity::description + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +id Identifier 1 Preliminary Identifier of this information element. This attribute shall be globally unique. Common::Root::RootObjectClasses::RootEntity::id + + OpenModelAttribute Unambiguously distinguishes different object instances. It is the naming attribute of the object. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +======================== ========== ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== + +StndDefined +~~~~~~~~~~~ -Syslog class -^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::Syslog +**Parent class:** VesEvent -**Description:** +Applied stereotypes: -Syslog's can be classified as either Control or Session/Traffic. They differ by message content and expected volume: +- OpenModelClass -• 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. +- **support: MANDATORY** -• 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). +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:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class Syslog** - -======================= ============== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -======================= ============== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== -additionalFields HashMap 0..\* Additional syslog fields if needed Ex: {"name1": "value1", "name2: "value2" … } OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -eventSourceHost String 0..1 Hostname of the device OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -eventSourceType String 1 Examples: 'other', 'router', 'switch', 'host', 'card', 'port', 'slotThreshold', 'portThreshold', 'virtualMachine', 'virtualNetworkFunction' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -syslogSdId String 0..1 0-32 char in format name@number, OpenModelAttribute - i.e., ourSDID@32473 - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -syslogFacilty SyslogFacility 0..1 Numeric code from 0 to 23 for facility: OpenModelAttribute - 0 kernel messages - 1 user-level messages - partOfObjectKey: 0 - 2 mail system - 3 system daemons - uniqueSet: - 4 security/authorization messages - 5 messages generated internally by syslogd - isInvariant: false - 6 line printer subsystem - 7 network news subsystem - unsigned: false - 8 UUCP subsystem - 9 clock daemon - counter: NA - 10 security/authorization messages - 11 FTP daemon - support: MANDATORY - 12 NTP subsystem - 13 log audit Preliminary - 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 ) -syslogFieldVersion String 1 Version of the syslogFields block as "#.#" where # is a digit; see section 1 for the correct digits to use. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -syslogMsg String 1 Syslog message OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -syslogMsgHost String 0..1 Hostname parsed from non-VES syslog message OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -syslogPri Integer 0..1 0-192 OpenModelAttribute - Combined Severity and Facility (see rfc5424) - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -syslogProc String 0..1 Identifies the application that originated the message OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -syslogProcId Number 0..1 The process number assigned by the OS when the application was started OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -syslogSData String 0..1 A <space> separated list of key="value" pairs following the rfc5424 standard for SD-ELEMENT. OpenModelAttribute - Deprecated - The entire rfc5424 syslogSData object, including square brackets [ ], SD-ID and list of SD-PARAMs - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -syslogSev SyslogSev 0..1 Level-of-severity text enumeration defined below: OpenModelAttribute - Text Sev Description - Emergency 0 system is unusable - partOfObjectKey: 0 - Alert 1 action must be taken immediately - Critical 2 critical conditions - uniqueSet: - Error 3 error conditions - Warning 4 warning conditions - isInvariant: false - Notice 5 normal but significant condition - Info 6 Informational messages - unsigned: false - Debug 7 debug-level messages - - counter: NA - - - support: MANDATORY - - Preliminary -syslogTag String 1 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 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -syslogTs String 0..1 Timestamp parsed from non-VES syslog message OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -syslogVer Number 0..1 IANA assigned version of the syslog protocol specification: OpenModelAttribute - 0: VES - 1: IANA RFC5424 - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -domain Domain 1 Event domain enumeration: 'fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -eventType String 0..1 For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -lastEpochMicrosec Number 1 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 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfcNamingCode String 0..1 Network function component type: 3 characters (aligned with vfc naming standards) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfNamingCode String 0..1 Network function type: 4 characters (aligned with vnf and pnf naming standards) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfVendorName String 1 Network function vendor name OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -priority Priority 1 Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -reportingEntityId String 0..1 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. OpenModelAttribute - - | reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. - partOfObjectKey: 0 - | 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. - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -reportingEntityName String 1 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. 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. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sequence Integer 1 sequence - Ordering of events communicated by an event source instance (or 0 if not needed) OpenModelAttribute - - Ordering of events communicated by an event source instance (or 0 if not needed) - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sourceId String 0..1 | sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity OpenModelAttribute - | 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. - - partOfObjectKey: 0 - 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. - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sourceName String 1 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. 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. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -startingEpochMicrosec Number 1 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) 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…). - partOfObjectKey: 0 - | 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). - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -timeZoneOffset String 0..1 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 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -version String 1 Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -vesEventListenerVersion String 1 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). OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -name String 1 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -Status String 0..1 The current condition of an interaction, such as open, in research, closed, and so forth OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -description String 0..1 Defines a textual free-form description of the object. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -id Identifier 1 Identifier of this information element. This attribute shall be globally unique. OpenModelAttribute - - Unambiguously distinguishes different object instances. It is the naming attribute of the object. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -======================= ============== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== - -ThresholdCrossingAlert class -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::ThresholdCrossingAlert - -**Description:** +======================= ============== ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +additionalFields HashMap 0..\* Preliminary Additional syslog fields if needed Ex: {"name1": "value1", "name2: "value2" … } Ves::ObjectClasses::Syslog::additionalFields + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +eventSourceHost String 0..1 Preliminary Hostname of the device Ves::ObjectClasses::Syslog::eventSourceHost + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +eventSourceType String 1 Preliminary Examples: 'other', 'router', 'switch', 'host', 'card', 'port', 'slotThreshold', 'portThreshold', 'virtualMachine', 'virtualNetworkFunction' Ves::ObjectClasses::Syslog::eventSourceType + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +syslogSdId String 0..1 Preliminary 0-32 char in format name@number, Ves::ObjectClasses::Syslog::syslogSdId + i.e., ourSDID@32473 + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +syslogFacilty SyslogFacility 0..1 Preliminary Numeric code from 0 to 23 for facility: Ves::ObjectClasses::Syslog::syslogFacilty + 0 kernel messages + OpenModelAttribute 1 user-level messages + 2 mail system + - isInvariant: false 3 system daemons + 4 security/authorization messages + - valueRange: no range constraint 5 messages generated internally by syslogd + 6 line printer subsystem + - support: MANDATORY 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 ) +syslogFieldVersion String 1 Preliminary Version of the syslogFields block as "#.#" where # is a digit; see section 1 for the correct digits to use. Ves::ObjectClasses::Syslog::syslogFieldVersion + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +syslogMsg String 1 Preliminary Syslog message Ves::ObjectClasses::Syslog::syslogMsg + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +syslogMsgHost String 0..1 Preliminary Hostname parsed from non-VES syslog message Ves::ObjectClasses::Syslog::syslogMsgHost + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +syslogPri Integer 0..1 Preliminary 0-192 Ves::ObjectClasses::Syslog::syslogPri + Combined Severity and Facility (see rfc5424) + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +syslogProc String 0..1 Preliminary Identifies the application that originated the message Ves::ObjectClasses::Syslog::syslogProc + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +syslogProcId Number 0..1 Preliminary The process number assigned by the OS when the application was started Ves::ObjectClasses::Syslog::syslogProcId + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +syslogSData String 0..1 Preliminary A <space> separated list of key="value" pairs following the rfc5424 standard for SD-ELEMENT. Ves::ObjectClasses::Syslog::syslogSData + Deprecated + OpenModelAttribute The entire rfc5424 syslogSData object, including square brackets [ ], SD-ID and list of SD-PARAMs + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +syslogSev SyslogSev 0..1 Preliminary Level-of-severity text enumeration defined below: Ves::ObjectClasses::Syslog::syslogSev + Text Sev Description + OpenModelAttribute Emergency 0 system is unusable + Alert 1 action must be taken immediately + - isInvariant: false Critical 2 critical conditions + Error 3 error conditions + - valueRange: no range constraint Warning 4 warning conditions + Notice 5 normal but significant condition + - support: MANDATORY Info 6 Informational messages + Debug 7 debug-level messages +syslogTag String 1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +syslogTs String 0..1 Preliminary Timestamp parsed from non-VES syslog message Ves::ObjectClasses::Syslog::syslogTs + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +syslogVer Number 0..1 Preliminary IANA assigned version of the syslog protocol specification: Ves::ObjectClasses::Syslog::syslogVer + 0: VES + OpenModelAttribute 1: IANA RFC5424 + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +domain Domain 1 Experimental Update in definition only Ves::ObjectClasses::VesEvent::domain + + OpenModelAttribute Event domain enumeration: 'cmNotify','fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +eventType String 0..1 Preliminary For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' Ves::ObjectClasses::VesEvent::eventType + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +lastEpochMicrosec Number 1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfcNamingCode String 0..1 Preliminary Network function component type: 3 characters (aligned with vfc naming standards) Ves::ObjectClasses::VesEvent::nfcNamingCode + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfNamingCode String 0..1 Preliminary Network function type: 4 characters (aligned with vnf and pnf naming standards) Ves::ObjectClasses::VesEvent::nfNamingCode + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfVendorName String 1 Preliminary Network function vendor name Ves::ObjectClasses::VesEvent::nfVendorName + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +priority Priority 1 Preliminary Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' Ves::ObjectClasses::VesEvent::priority + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +reportingEntityId String 0..1 Preliminary 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. Ves::ObjectClasses::VesEvent::reportingEntityId + + OpenModelAttribute 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. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +reportingEntityName String 1 Preliminary 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. Ves::ObjectClasses::VesEvent::reportingEntityName + + OpenModelAttribute 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. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sequence Integer 1 Preliminary sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ves::ObjectClasses::VesEvent::sequence + + OpenModelAttribute Ordering of events communicated by an event source instance (or 0 if not needed) + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sourceId String 0..1 Preliminary 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. Ves::ObjectClasses::VesEvent::sourceId + + OpenModelAttribute 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. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sourceName String 1 Preliminary 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 + + OpenModelAttribute 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. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +startingEpochMicrosec Number 1 Preliminary 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…). Ves::ObjectClasses::VesEvent::startingEpochMicrosec + 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). + OpenModelAttribute + 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) + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +timeZoneOffset String 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +version String 1 Preliminary Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. Ves::ObjectClasses::VesEvent::version + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +vesEventListenerVersion String 1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +name String 1 Preliminary Ves::ObjectClasses::VesEvent::name + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +Status String 0..1 Preliminary The current condition of an interaction, such as open, in research, closed, and so forth Common::Business Interaction::ObjectClasses::BusinessInteraction::Status + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +description String 0..1 Preliminary Defines a textual free-form description of the object. Common::Root::RootObjectClasses::RootEntity::description + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +id Identifier 1 Preliminary Identifier of this information element. This attribute shall be globally unique. Common::Root::RootObjectClasses::RootEntity::id + + OpenModelAttribute Unambiguously distinguishes different object instances. It is the naming attribute of the object. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +======================= ============== ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== + +ThresholdCrossingAlert +~~~~~~~~~~~~~~~~~~~~~~ The thresholdCrossingAlertFields datatype consists of the following fields: **Parent class:** VesEvent -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class ThresholdCrossingAlert** - -============================== ============================= ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -============================== ============================= ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== -additionalFields HashMap 0..1 additionalFields - Additional pnfRegistration fields if needed. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -additionalParameters ThresholdCrossingAlertCounter 1..\* Array of performance counters OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -alertAction AlertAction 1 Enumeration: 'SET', 'CONT', 'CLEAR' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -alertDescription String 1 Unique short alert description (e.g., NE-CPUMEM) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -alertType AlertType 1 Enumeration: 'CARD-ANOMALY', 'INTERFACE-ANOMALY', ELEMENT-ANOMALY', 'SERVICE-ANOMALY' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -alertValue String 0..1 Calculated API value (if applicable) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -associatedAlertIdList String 0..\* List of eventIds associated with the event being reported OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -collectionTimestamp String 1 Time when the performance collector picked up the data; with RFC 2822 compliant format: 'Sat, 13 Mar 2010 11:29:05 -0800' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -dataCollector String 0..1 Specific performance collector instance used OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -elementType String 0..1 Type of network element (internal AT&T field) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -eventSeverity EventSeverity 1 Event severity or priority enumeration: 'CRITICAL', 'MAJOR', 'MINOR', 'WARNING', 'NORMAL' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -eventStartTimestamp String 1 Time closest to when the measurement was made; with RFC 2822 compliant format: 'Sat, 13 Mar 2010 11:29:05 -0800' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -interfaceName String 0..1 Physical or logical port or card (if applicable OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -networkService String 0..1 Network name (internal AT&T field) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -possibleRootCause String 0..1 Reserved for future use OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -thresholdCrossingFieldsVersion String 1 Version of the thresholdCrossingAlertFields block as "#.#" where # is a digit; see section 1 for the correct digits to use. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -domain Domain 1 Event domain enumeration: 'fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -eventType String 0..1 For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -lastEpochMicrosec Number 1 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 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfcNamingCode String 0..1 Network function component type: 3 characters (aligned with vfc naming standards) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfNamingCode String 0..1 Network function type: 4 characters (aligned with vnf and pnf naming standards) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfVendorName String 1 Network function vendor name OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -priority Priority 1 Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -reportingEntityId String 0..1 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. OpenModelAttribute - - | reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. - partOfObjectKey: 0 - | 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. - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -reportingEntityName String 1 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. 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. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sequence Integer 1 sequence - Ordering of events communicated by an event source instance (or 0 if not needed) OpenModelAttribute - - Ordering of events communicated by an event source instance (or 0 if not needed) - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sourceId String 0..1 | sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity OpenModelAttribute - | 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. - - partOfObjectKey: 0 - 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. - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sourceName String 1 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. 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. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -startingEpochMicrosec Number 1 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) 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…). - partOfObjectKey: 0 - | 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). - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -timeZoneOffset String 0..1 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 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -version String 1 Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -vesEventListenerVersion String 1 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). OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -name String 1 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -Status String 0..1 The current condition of an interaction, such as open, in research, closed, and so forth OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -description String 0..1 Defines a textual free-form description of the object. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -id Identifier 1 Identifier of this information element. This attribute shall be globally unique. OpenModelAttribute - - Unambiguously distinguishes different object instances. It is the naming attribute of the object. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -============================== ============================= ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== - -VendorNfNameFields class -^^^^^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::VendorNfNameFields - -**Description:** +============================== ============================= ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ========================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +additionalFields HashMap 0..1 Preliminary additionalFields - Additional pnfRegistration fields if needed. Ves::ObjectClasses::ThresholdCrossingAlert::additionalFields + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +additionalParameters ThresholdCrossingAlertCounter 1..\* Preliminary Array of performance counters Ves::ObjectClasses::ThresholdCrossingAlert::additionalParameters + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +alertAction AlertAction 1 Preliminary Enumeration: 'SET', 'CONT', 'CLEAR' Ves::ObjectClasses::ThresholdCrossingAlert::alertAction + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +alertDescription String 1 Preliminary Unique short alert description (e.g., NE-CPUMEM) Ves::ObjectClasses::ThresholdCrossingAlert::alertDescription + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +alertType AlertType 1 Preliminary Enumeration: 'CARD-ANOMALY', 'INTERFACE-ANOMALY', ELEMENT-ANOMALY', 'SERVICE-ANOMALY' Ves::ObjectClasses::ThresholdCrossingAlert::alertType + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +alertValue String 0..1 Preliminary Calculated API value (if applicable) Ves::ObjectClasses::ThresholdCrossingAlert::alertValue + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +associatedAlertIdList String 0..\* Preliminary List of eventIds associated with the event being reported Ves::ObjectClasses::ThresholdCrossingAlert::associatedAlertIdList + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +collectionTimestamp String 1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +dataCollector String 0..1 Preliminary Specific performance collector instance used Ves::ObjectClasses::ThresholdCrossingAlert::dataCollector + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +elementType String 0..1 Preliminary Type of network element (internal AT&T field) Ves::ObjectClasses::ThresholdCrossingAlert::elementType + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +eventSeverity EventSeverity 1 Preliminary Event severity or priority enumeration: 'CRITICAL', 'MAJOR', 'MINOR', 'WARNING', 'NORMAL' Ves::ObjectClasses::ThresholdCrossingAlert::eventSeverity + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +eventStartTimestamp String 1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +interfaceName String 0..1 Preliminary Physical or logical port or card (if applicable Ves::ObjectClasses::ThresholdCrossingAlert::interfaceName + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +networkService String 0..1 Preliminary Network name (internal AT&T field) Ves::ObjectClasses::ThresholdCrossingAlert::networkService + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +possibleRootCause String 0..1 Preliminary Reserved for future use Ves::ObjectClasses::ThresholdCrossingAlert::possibleRootCause + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +thresholdCrossingFieldsVersion String 1 Preliminary Version of the thresholdCrossingAlertFields block as "#.#" where # is a digit; see section 1 for the correct digits to use. Ves::ObjectClasses::ThresholdCrossingAlert::thresholdCrossingFieldsVersion + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +domain Domain 1 Experimental Update in definition only Ves::ObjectClasses::VesEvent::domain + + OpenModelAttribute Event domain enumeration: 'cmNotify','fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +eventType String 0..1 Preliminary For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' Ves::ObjectClasses::VesEvent::eventType + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +lastEpochMicrosec Number 1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfcNamingCode String 0..1 Preliminary Network function component type: 3 characters (aligned with vfc naming standards) Ves::ObjectClasses::VesEvent::nfcNamingCode + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfNamingCode String 0..1 Preliminary Network function type: 4 characters (aligned with vnf and pnf naming standards) Ves::ObjectClasses::VesEvent::nfNamingCode + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfVendorName String 1 Preliminary Network function vendor name Ves::ObjectClasses::VesEvent::nfVendorName + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +priority Priority 1 Preliminary Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' Ves::ObjectClasses::VesEvent::priority + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +reportingEntityId String 0..1 Preliminary 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. Ves::ObjectClasses::VesEvent::reportingEntityId + + OpenModelAttribute 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. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +reportingEntityName String 1 Preliminary 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. Ves::ObjectClasses::VesEvent::reportingEntityName + + OpenModelAttribute 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. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sequence Integer 1 Preliminary sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ves::ObjectClasses::VesEvent::sequence + + OpenModelAttribute Ordering of events communicated by an event source instance (or 0 if not needed) + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sourceId String 0..1 Preliminary 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. Ves::ObjectClasses::VesEvent::sourceId + + OpenModelAttribute 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. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sourceName String 1 Preliminary 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 + + OpenModelAttribute 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. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +startingEpochMicrosec Number 1 Preliminary 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…). Ves::ObjectClasses::VesEvent::startingEpochMicrosec + 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). + OpenModelAttribute + 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) + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +timeZoneOffset String 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +version String 1 Preliminary Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. Ves::ObjectClasses::VesEvent::version + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +vesEventListenerVersion String 1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +name String 1 Preliminary Ves::ObjectClasses::VesEvent::name + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +Status String 0..1 Preliminary The current condition of an interaction, such as open, in research, closed, and so forth Common::Business Interaction::ObjectClasses::BusinessInteraction::Status + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +description String 0..1 Preliminary Defines a textual free-form description of the object. Common::Root::RootObjectClasses::RootEntity::description + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +id Identifier 1 Preliminary Identifier of this information element. This attribute shall be globally unique. Common::Root::RootObjectClasses::RootEntity::id + + OpenModelAttribute Unambiguously distinguishes different object instances. It is the naming attribute of the object. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +============================== ============================= ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ========================================================================== + +VendorNfNameFields +~~~~~~~~~~~~~~~~~~ vendorNfNameFields - The vendorNfNameFields provides vendor, nf and nfModule identifying information. -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class VendorNfNameFields** - -================== ======== ========= ========================================================== ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -================== ======== ========= ========================================================== ===================== -nfModuleName String 0..1 nfModuleName - Name of the nfModule generating the event. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfName String 0..1 nfName - Name of the network function generating the event OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -vendorName String 1 vendorName - Network function vendor name. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -================== ======== ========= ========================================================== ===================== - -VesEvent class -^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::VesEvent - -**Description:** +================== ======== ========= ================================== ========================================================== ==================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +nfModuleName String 0..1 Preliminary nfModuleName - Name of the nfModule generating the event. Ves::ObjectClasses::VendorNfNameFields::nfModuleName + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfName String 0..1 Preliminary nfName - Name of the network function generating the event Ves::ObjectClasses::VendorNfNameFields::nfName + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +vendorName String 1 Preliminary vendorName - Network function vendor name. Ves::ObjectClasses::VendorNfNameFields::vendorName + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= ================================== ========================================================== ==================================================== + +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:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class VesEvent** - -======================= ========== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -======================= ========== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== -domain Domain 1 Event domain enumeration: 'fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -eventType String 0..1 For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -lastEpochMicrosec Number 1 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 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfcNamingCode String 0..1 Network function component type: 3 characters (aligned with vfc naming standards) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfNamingCode String 0..1 Network function type: 4 characters (aligned with vnf and pnf naming standards) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfVendorName String 1 Network function vendor name OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -priority Priority 1 Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -reportingEntityId String 0..1 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. OpenModelAttribute - - | reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. - partOfObjectKey: 0 - | 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. - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -reportingEntityName String 1 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. 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. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sequence Integer 1 sequence - Ordering of events communicated by an event source instance (or 0 if not needed) OpenModelAttribute - - Ordering of events communicated by an event source instance (or 0 if not needed) - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sourceId String 0..1 | sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity OpenModelAttribute - | 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. - - partOfObjectKey: 0 - 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. - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sourceName String 1 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. 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. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -startingEpochMicrosec Number 1 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) 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…). - partOfObjectKey: 0 - | 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). - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -timeZoneOffset String 0..1 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 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -version String 1 Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -vesEventListenerVersion String 1 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). OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -name String 1 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -Status String 0..1 The current condition of an interaction, such as open, in research, closed, and so forth OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -description String 0..1 Defines a textual free-form description of the object. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -id Identifier 1 Identifier of this information element. This attribute shall be globally unique. OpenModelAttribute - - Unambiguously distinguishes different object instances. It is the naming attribute of the object. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -======================= ========== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== - -VoiceQuality class -^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::VoiceQuality - -**Description:** +======================= ========== ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +domain Domain 1 Experimental Update in definition only Ves::ObjectClasses::VesEvent::domain + + OpenModelAttribute Event domain enumeration: 'cmNotify','fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +eventType String 0..1 Preliminary For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' Ves::ObjectClasses::VesEvent::eventType + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +lastEpochMicrosec Number 1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfcNamingCode String 0..1 Preliminary Network function component type: 3 characters (aligned with vfc naming standards) Ves::ObjectClasses::VesEvent::nfcNamingCode + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfNamingCode String 0..1 Preliminary Network function type: 4 characters (aligned with vnf and pnf naming standards) Ves::ObjectClasses::VesEvent::nfNamingCode + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfVendorName String 1 Preliminary Network function vendor name Ves::ObjectClasses::VesEvent::nfVendorName + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +priority Priority 1 Preliminary Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' Ves::ObjectClasses::VesEvent::priority + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +reportingEntityId String 0..1 Preliminary 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. Ves::ObjectClasses::VesEvent::reportingEntityId + + OpenModelAttribute 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. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +reportingEntityName String 1 Preliminary 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. Ves::ObjectClasses::VesEvent::reportingEntityName + + OpenModelAttribute 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. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sequence Integer 1 Preliminary sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ves::ObjectClasses::VesEvent::sequence + + OpenModelAttribute Ordering of events communicated by an event source instance (or 0 if not needed) + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sourceId String 0..1 Preliminary 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. Ves::ObjectClasses::VesEvent::sourceId + + OpenModelAttribute 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. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sourceName String 1 Preliminary 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 + + OpenModelAttribute 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. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +startingEpochMicrosec Number 1 Preliminary 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…). Ves::ObjectClasses::VesEvent::startingEpochMicrosec + 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). + OpenModelAttribute + 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) + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +timeZoneOffset String 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +version String 1 Preliminary Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. Ves::ObjectClasses::VesEvent::version + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +vesEventListenerVersion String 1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +name String 1 Preliminary Ves::ObjectClasses::VesEvent::name + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +Status String 0..1 Preliminary The current condition of an interaction, such as open, in research, closed, and so forth Common::Business Interaction::ObjectClasses::BusinessInteraction::Status + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +description String 0..1 Preliminary Defines a textual free-form description of the object. Common::Root::RootObjectClasses::RootEntity::description + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +id Identifier 1 Preliminary Identifier of this information element. This attribute shall be globally unique. Common::Root::RootObjectClasses::RootEntity::id + + OpenModelAttribute Unambiguously distinguishes different object instances. It is the naming attribute of the object. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +======================= ========== ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== + +VoiceQuality +~~~~~~~~~~~~ The voiceQuality class provides statistics related to customer facing voice products; consists of the following fields: **Parent class:** VesEvent -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class VoiceQuality** - -========================= ===================== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -========================= ===================== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== -additionalInformation HashMap 0..1 Additional voice quality fields OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -calleeSideCodec String 1 Callee codec for the call OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -callerSideCodec String 1 Caller codec for the call OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -correlator String 1 Constant across all events on this call OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -phoneNumber String 0..1 Phone number associated with the correlator OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -midCallRtcp String 1 Base64 encoding of the binary RTCP data (excluding Eth/IP/UDP headers) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -voiceQualityFieldsVersion String 1 Version of the voiceQualityFields block as "#.#" where # is a digit; see section 1 for the correct digits to use. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -\_endofcallvqmsummaries EndOfCallVqmSummaries 0..1 End of call voice quality metric summaries OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -\_vendornfnamefields VendorNfNameFields 1 Vendor, NF and nfModule names OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -domain Domain 1 Event domain enumeration: 'fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -eventType String 0..1 For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -lastEpochMicrosec Number 1 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 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfcNamingCode String 0..1 Network function component type: 3 characters (aligned with vfc naming standards) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfNamingCode String 0..1 Network function type: 4 characters (aligned with vnf and pnf naming standards) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfVendorName String 1 Network function vendor name OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -priority Priority 1 Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -reportingEntityId String 0..1 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. OpenModelAttribute - - | reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. - partOfObjectKey: 0 - | 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. - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -reportingEntityName String 1 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. 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. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sequence Integer 1 sequence - Ordering of events communicated by an event source instance (or 0 if not needed) OpenModelAttribute - - Ordering of events communicated by an event source instance (or 0 if not needed) - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sourceId String 0..1 | sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity OpenModelAttribute - | 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. - - partOfObjectKey: 0 - 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. - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sourceName String 1 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. 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. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -startingEpochMicrosec Number 1 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) 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…). - partOfObjectKey: 0 - | 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). - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -timeZoneOffset String 0..1 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 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -version String 1 Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -vesEventListenerVersion String 1 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). OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -name String 1 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -Status String 0..1 The current condition of an interaction, such as open, in research, closed, and so forth OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -description String 0..1 Defines a textual free-form description of the object. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -id Identifier 1 Identifier of this information element. This attribute shall be globally unique. OpenModelAttribute - - Unambiguously distinguishes different object instances. It is the naming attribute of the object. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -========================= ===================== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== +========================= ===================== ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +additionalInformation HashMap 0..1 Preliminary Additional voice quality fields Ves::ObjectClasses::VoiceQuality::additionalInformation + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +calleeSideCodec String 1 Preliminary Callee codec for the call Ves::ObjectClasses::VoiceQuality::calleeSideCodec + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +callerSideCodec String 1 Preliminary Caller codec for the call Ves::ObjectClasses::VoiceQuality::callerSideCodec + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +correlator String 1 Preliminary Constant across all events on this call Ves::ObjectClasses::VoiceQuality::correlator + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +phoneNumber String 0..1 Preliminary Phone number associated with the correlator Ves::ObjectClasses::VoiceQuality::phoneNumber + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +midCallRtcp String 1 Preliminary Base64 encoding of the binary RTCP data (excluding Eth/IP/UDP headers) Ves::ObjectClasses::VoiceQuality::midCallRtcp + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +voiceQualityFieldsVersion String 1 Preliminary Version of the voiceQualityFields block as "#.#" where # is a digit; see section 1 for the correct digits to use. Ves::ObjectClasses::VoiceQuality::voiceQualityFieldsVersion + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_endofcallvqmsummaries EndOfCallVqmSummaries 0..1 Preliminary End of call voice quality metric summaries Ves::ObjectClasses::VoiceQuality::_endofcallvqmsummaries + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_vendornfnamefields VendorNfNameFields 1 Preliminary Vendor, NF and nfModule names Ves::ObjectClasses::VoiceQuality::_vendornfnamefields + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +domain Domain 1 Experimental Update in definition only Ves::ObjectClasses::VesEvent::domain + + OpenModelAttribute Event domain enumeration: 'cmNotify','fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +eventType String 0..1 Preliminary For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' Ves::ObjectClasses::VesEvent::eventType + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +lastEpochMicrosec Number 1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfcNamingCode String 0..1 Preliminary Network function component type: 3 characters (aligned with vfc naming standards) Ves::ObjectClasses::VesEvent::nfcNamingCode + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfNamingCode String 0..1 Preliminary Network function type: 4 characters (aligned with vnf and pnf naming standards) Ves::ObjectClasses::VesEvent::nfNamingCode + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfVendorName String 1 Preliminary Network function vendor name Ves::ObjectClasses::VesEvent::nfVendorName + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +priority Priority 1 Preliminary Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' Ves::ObjectClasses::VesEvent::priority + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +reportingEntityId String 0..1 Preliminary 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. Ves::ObjectClasses::VesEvent::reportingEntityId + + OpenModelAttribute 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. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +reportingEntityName String 1 Preliminary 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. Ves::ObjectClasses::VesEvent::reportingEntityName + + OpenModelAttribute 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. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sequence Integer 1 Preliminary sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ves::ObjectClasses::VesEvent::sequence + + OpenModelAttribute Ordering of events communicated by an event source instance (or 0 if not needed) + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sourceId String 0..1 Preliminary 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. Ves::ObjectClasses::VesEvent::sourceId + + OpenModelAttribute 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. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sourceName String 1 Preliminary 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 + + OpenModelAttribute 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. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +startingEpochMicrosec Number 1 Preliminary 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…). Ves::ObjectClasses::VesEvent::startingEpochMicrosec + 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). + OpenModelAttribute + 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) + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +timeZoneOffset String 0..1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +version String 1 Preliminary Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. Ves::ObjectClasses::VesEvent::version + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +vesEventListenerVersion String 1 Preliminary 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 + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +name String 1 Preliminary Ves::ObjectClasses::VesEvent::name + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +Status String 0..1 Preliminary The current condition of an interaction, such as open, in research, closed, and so forth Common::Business Interaction::ObjectClasses::BusinessInteraction::Status + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +description String 0..1 Preliminary Defines a textual free-form description of the object. Common::Root::RootObjectClasses::RootEntity::description + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +id Identifier 1 Preliminary Identifier of this information element. This attribute shall be globally unique. Common::Root::RootObjectClasses::RootEntity::id + + OpenModelAttribute Unambiguously distinguishes different object instances. It is the naming attribute of the object. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +========================= ===================== ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== + +cmNotif +~~~~~~~ + +Applied stereotypes: -measInfoIdInteger class -^^^^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::measInfoIdInteger +- OpenModelClass -**Description:** +- **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 + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +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 + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +objectIdentiferType String 0..1 OpenModelAttribute Type of object identifier (Ynag, or ....) Ves::Diagrams::cmNotif::objectIdentiferType + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +attributeList AttributeList 1..\* OpenModelAttribute [R1] Attribute Name and values (attributeName(string), newAttributeValue(any type), oldAttributeValue(any type) Ves::Diagrams::cmNotif::attributeList + [R2] This is Mandatory for notifyMOIAttributeValueChange. 3GPP defines it as options for Creation and Deletion. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +=================== ============= ========= ================================== ===================================================================================================================================================================================================== =========================================== + +measInfoIdInteger +~~~~~~~~~~~~~~~~~ The measInfoIdInteger datatype provides an integer measurement group identifier; -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class measInfoIdInteger** - -================== ======== ========= ==================================== ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -================== ======== ========= ==================================== ===================== -iMeasInfoId Integer 1 Integer measurement group Identifier OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -================== ======== ========= ==================================== ===================== - -measResultNull class -^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::measResultNull - -**Description:** +================== ======== ========= ================================== ==================================== ================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +iMeasInfoId Integer 1 Preliminary Integer measurement group Identifier Ves::ObjectClasses::measInfoIdInteger::iMeasInfoId + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= ================================== ==================================== ================================================== + +measResultNull +~~~~~~~~~~~~~~ The measResultNull datatype provides a null 3GPP PM measurement result -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class measResultNull** - -================== ======== ========= ================================================ ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -================== ======== ========= ================================================ ===================== -p Integer 1 Integer reference to the counter OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -isNull Boolean 1 Enumeration: 'true' or 'false' OpenModelAttribute - - The VES 7.1 Spec has this attribute as a string. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -================== ======== ========= ================================================ ===================== +================== ======== ========= ================================== ================================================ ========================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +p Integer 1 Preliminary Integer reference to the counter Ves::ObjectClasses::measResultNull::p + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +isNull Boolean 1 Preliminary Enumeration: 'true' or 'false' Ves::ObjectClasses::measResultNull::isNull + + OpenModelAttribute The VES 7.1 Spec has this attribute as a string. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= ================================== ================================================ ========================================== diff --git a/docs/ONAP Model Spec/im/VES/VES-datatype.png b/docs/ONAP Model Spec/im/VES/VES-datatype.png Binary files differnew file mode 100644 index 0000000..f76a032 --- /dev/null +++ b/docs/ONAP Model Spec/im/VES/VES-datatype.png diff --git a/docs/ONAP Model Spec/im/VES/VES-datatype.rst b/docs/ONAP Model Spec/im/VES/VES-datatype.rst index f8ff20a..a657da9 100644 --- a/docs/ONAP Model Spec/im/VES/VES-datatype.rst +++ b/docs/ONAP Model Spec/im/VES/VES-datatype.rst @@ -1,4 +1,4 @@ -.. Copyright 2019 +.. Copyright 2021 .. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE .. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode @@ -9,311 +9,315 @@ VES Datatype Definition :depth: 3 .. -ArrayOfSchemaObject datatype -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Data Types +---------- -**Qualified Name:** Ves::TypeDefinitions::ArrayOfSchemaObject - -**Description:** +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:** +Applied stereotypes: - Preliminary -**Table** **Attributes for Data Type ArrayOfSchemaObject** - -=================== ============ ========= ============================================================================================================================================================= ================================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -=================== ============ ========= ============================================================================================================================================================= ================================== -arrayOfSchemaObject SchemaObject 1..\* arrayOfSchemaObject - arrayOfSchemaObject datatype provides an array of SchemaObjects, each of which is described by name, schema and other meta-information. OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -=================== ============ ========= ============================================================================================================================================================= ================================== - -ArrayofNamedHashMap datatype -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::TypeDefinitions::ArrayofNamedHashMap - -**Description:** +=================== ============ ========= ========== ================================== ============================================================================================================================================================= +**Attribute Name** **Type** **Mult.** **Access** **Stereotypes** **Description** +arrayOfSchemaObject SchemaObject 1..\* RW Preliminary arrayOfSchemaObject - arrayOfSchemaObject datatype provides an array of SchemaObjects, each of which is described by name, schema and other meta-information. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +=================== ============ ========= ========== ================================== ============================================================================================================================================================= + +ArrayofNamedHashMap +~~~~~~~~~~~~~~~~~~~ Array of named hashMaps -**Applied Stereotypes:** +Applied stereotypes: - Preliminary -**Table** **Attributes for Data Type ArrayofNamedHashMap** - -=================== ============ ========= ======================= ================================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -=================== ============ ========= ======================= ================================== -arrayOfNamedHashmap NamedHashMap 1..\* Array of named hashMaps OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -=================== ============ ========= ======================= ================================== - -HashMap datatype -^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::TypeDefinitions::HashMap - -**Description:** +=================== ============ ========= ========== ================================== ======================= +**Attribute Name** **Type** **Mult.** **Access** **Stereotypes** **Description** +arrayOfNamedHashmap NamedHashMap 1..\* RW Preliminary Array of named hashMaps + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +=================== ============ ========= ========== ================================== ======================= + +AttributeList +~~~~~~~~~~~~~ + +Applied stereotypes: + +- Experimental + +================== ======== ========= ========== ================================== =============== +**Attribute Name** **Type** **Mult.** **Access** **Stereotypes** **Description** +atributeName String 1 RW OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +newAttributeValue String 1 RW OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +NewAttributeType String 1 RW OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +oldAttributeValue String 1 RW OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +oldAttributeType String 1 RW OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= ========== ================================== =============== + +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:** +Applied stereotypes: - Preliminary -**Table** **Attributes for Data Type HashMap** - -================== ============ ========= ======================================================== ================================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -================== ============ ========= ======================================================== ================================== -hashmapEntry KeyValuePair 0..\* A given entry in the hashmap, which is a key/value pair. OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -================== ============ ========= ======================================================== ================================== - -NamedHashMap datatype -^^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::TypeDefinitions::NamedHashMap - -**Description:** +================== ============ ========= ========== ================================== ======================================================== +**Attribute Name** **Type** **Mult.** **Access** **Stereotypes** **Description** +hashmapEntry KeyValuePair 0..\* RW Preliminary A given entry in the hashmap, which is a key/value pair. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ============ ========= ========== ================================== ======================================================== + +NamedHashMap +~~~~~~~~~~~~ namedHashMap [ ] - The namedHashmap datatype is a hashMap which is associated with and described by a name. -**Applied Stereotypes:** +Applied stereotypes: - Preliminary -**Table** **Attributes for Data Type NamedHashMap** - -================== ======== ========= =========================================================================== ================================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -================== ======== ========= =========================================================================== ================================== -name String 1 name - Name for the array of name-value pairs. OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -hashMap HashMap 1 hashMap - One or more key:value pairs. OpenModelAttribute - Note: in ATTServiceSpecification - VesEventListener v5.4.1 type = field []. - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -================== ======== ========= =========================================================================== ================================== - -ProcessStats datatype -^^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::TypeDefinitions::ProcessStats - -SchemaObject datatype -^^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::TypeDefinitions::SchemaObject - -**Description:** +================== ======== ========= ========== ================================== =========================================================================== +**Attribute Name** **Type** **Mult.** **Access** **Stereotypes** **Description** +name String 1 RW Preliminary name - Name for the array of name-value pairs. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +hashMap HashMap 1 RW Preliminary hashMap - One or more key:value pairs. + Note: in ATTServiceSpecification - VesEventListener v5.4.1 type = field []. + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= ========== ================================== =========================================================================== + +.. _processstats-1: + +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:** +Applied stereotypes: - Preliminary -**Table** **Attributes for Data Type SchemaObject** - -===================== ==================== ========= ============================================================================================================================================================================================= ================================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -===================== ==================== ========= ============================================================================================================================================================================================= ================================== -objectInstances SchemaObjectInstance 1..\* objectInstances - Contains one or more instances of the SchemaObjectInstance object. OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -objectName String 1 objectName - Name of the object. OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -objectSchema String 0..1 objectSchema - schema for the object. OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -objectSchemaUrl String 0..1 objectSchemaUrl - URL to the schema for the object. OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -nfSubcribedObjectName String 0..1 nfSubscribedObjectName - Name of the object associated with the nfSubscriptionId. OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -nfSubcriptionId String 0..1 nfSubscriptionId - Identifies an OpenConfig telemetry subscription on a network function, which configures the network function to send complex object data associated with the SchemaObject. OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -===================== ==================== ========= ============================================================================================================================================================================================= ================================== - -SchemaObjectInstance datatype -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::TypeDefinitions::SchemaObjectInstance - -**Description:** +===================== ==================== ========= ========== ================================== ============================================================================================================================================================================================= +**Attribute Name** **Type** **Mult.** **Access** **Stereotypes** **Description** +objectInstances SchemaObjectInstance 1..\* RW Preliminary objectInstances - Contains one or more instances of the SchemaObjectInstance object. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +objectName String 1 RW Preliminary objectName - Name of the object. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +objectSchema String 0..1 RW Preliminary objectSchema - schema for the object. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +objectSchemaUrl String 0..1 RW Preliminary objectSchemaUrl - URL to the schema for the object. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfSubcribedObjectName String 0..1 RW Preliminary nfSubscribedObjectName - Name of the object associated with the nfSubscriptionId. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfSubcriptionId String 0..1 RW Preliminary nfSubscriptionId - Identifies an OpenConfig telemetry subscription on a network function, which configures the network function to send complex object data associated with the SchemaObject. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +===================== ==================== ========= ========== ================================== ============================================================================================================================================================================================= + +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:** +Applied stereotypes: - Preliminary -**Table** **Attributes for Data Type SchemaObjectInstance** - -=========================== ============ ========= ====================================================================================================================================================================== ================================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -=========================== ============ ========= ====================================================================================================================================================================== ================================== -schemaObject SchemaObject 0..\* SchemaObject - Optional recursive specification on SchemaObject OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -objectInstance Object 0..1 objectInstance - Contains an instance conforming to the SchemaObject schema OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -objectInstanceEpochMicrosec UnixEpoch 0..1 objectInstanceEpochMicrosec - the unix time, aka epoch time, associated with this objectInstance--as microseconds elapsed since 1 Jan 1970 not including leap seconds. OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -objectKeys Key 0..\* objectKeys - An ordered set of keys that identifies this particular instance of SchemaObject (e.g., that places it in a hierarchy). OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -=========================== ============ ========= ====================================================================================================================================================================== ================================== - -ThresholdCrossingAlertCounter datatype -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::TypeDefinitions::ThresholdCrossingAlertCounter - -**Applied Stereotypes:** +=========================== ============ ========= ========== ================================== ====================================================================================================================================================================== +**Attribute Name** **Type** **Mult.** **Access** **Stereotypes** **Description** +schemaObject SchemaObject 0..\* RW Preliminary SchemaObject - Optional recursive specification on SchemaObject + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +objectInstance Object 0..1 RW Preliminary objectInstance - Contains an instance conforming to the SchemaObject schema + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +objectInstanceEpochMicrosec UnixEpoch 0..1 RW Preliminary objectInstanceEpochMicrosec - the unix time, aka epoch time, associated with this objectInstance--as microseconds elapsed since 1 Jan 1970 not including leap seconds. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +objectKeys Key 0..\* RW Preliminary objectKeys - An ordered set of keys that identifies this particular instance of SchemaObject (e.g., that places it in a hierarchy). + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +=========================== ============ ========= ========== ================================== ====================================================================================================================================================================== + +ThresholdCrossingAlertCounter +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Applied stereotypes: - Preliminary -**Table** **Attributes for Data Type ThresholdCrossingAlertCounter** - -================== ============== ========= ============================================================================ ================================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -================== ============== ========= ============================================================================ ================================== -criticality TCACriticality 1 Enumeration: 'CRIT', 'MAJ' OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -hashMap HashMap 1 Key is the name of the counter and value is the current value of the counter OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -thresholdCrossed String 1 Last threshold that was crossed OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -================== ============== ========= ============================================================================ ================================== +================== ============== ========= ========== ================================== ============================================================================ +**Attribute Name** **Type** **Mult.** **Access** **Stereotypes** **Description** +criticality TCACriticality 1 RW Preliminary Enumeration: 'CRIT', 'MAJ' + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +hashMap HashMap 1 RW Preliminary Key is the name of the counter and value is the current value of the counter + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +thresholdCrossed String 1 RW Preliminary Last threshold that was crossed + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ============== ========= ========== ================================== ============================================================================ diff --git a/docs/ONAP Model Spec/im/VES/VES-diagram.rst b/docs/ONAP Model Spec/im/VES/VES-diagram.rst new file mode 100644 index 0000000..0af66f5 --- /dev/null +++ b/docs/ONAP Model Spec/im/VES/VES-diagram.rst @@ -0,0 +1,51 @@ +.. Copyright 2021 +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +VES Model Diagram +----------------- + +Rooting VES +~~~~~~~~~~~ + +.. image:: VES-root.png + +Event - High Level +~~~~~~~~~~~~~~~~~~ + +.. image:: VES-event.png + +Event Datatypes +~~~~~~~~~~~~~~~ + +.. image:: VES-datatype.png + +Measurement Domain Entities +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. image:: VES-measure.png + +Mobile Flow Entities +~~~~~~~~~~~~~~~~~~~~ + +.. image:: VES-mobile.png + +Perf3gpp Entities +~~~~~~~~~~~~~~~~~ + +.. image:: VES-perf3gpp.png + +SipSignaling Entities +~~~~~~~~~~~~~~~~~~~~~ + +.. image:: VES-sipsignal.png + +Voice Quality Entities +~~~~~~~~~~~~~~~~~~~~~~ + +.. image:: VES-voice.png + +ipmi +~~~~ + +.. image:: VES-ipmi.png diff --git a/docs/ONAP Model Spec/im/VES/VES-enumeration.rst b/docs/ONAP Model Spec/im/VES/VES-enumeration.rst index b4b08db..d67dbea 100644 --- a/docs/ONAP Model Spec/im/VES/VES-enumeration.rst +++ b/docs/ONAP Model Spec/im/VES/VES-enumeration.rst @@ -1,4 +1,4 @@ -.. Copyright 2019 +.. Copyright 2021 .. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE .. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode @@ -9,443 +9,357 @@ VES Enumeration definition :depth: 3 .. -AlertAction enumeration -^^^^^^^^^^^^^^^^^^^^^^^ +Enumerations +------------ -**Qualified Name:** Ves::TypeDefinitions::AlertAction - -**Description:** +AlertAction +~~~~~~~~~~~ Possible alertActions within thresholdCrossingAlertFields -**Applied Stereotypes:** - -- Preliminary - -**Contains Enumeration Literals:** - -- SET - -- CONT +Contains Enumeration Literals: -- CLEAR +- SET: -AlertType enumeration -^^^^^^^^^^^^^^^^^^^^^ +- CONT: -**Qualified Name:** Ves::TypeDefinitions::AlertType +- CLEAR: -**Description:** +AlertType +~~~~~~~~~ Possible values for ThresholdCrossingAlertFIelds alertType attribute. -**Applied Stereotypes:** +Contains Enumeration Literals: -- Preliminary +- CARD_ANOMALY: -**Contains Enumeration Literals:** +- INTERFACE_ANOMALY: -- CARD_ANOMALY +- ELEMENT_ANOMALY: -- INTERFACE_ANOMALY +- SERVICE_ANOMALY: -- ELEMENT_ANOMALY - -- SERVICE_ANOMALY - -Domain enumeration -^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::TypeDefinitions::Domain - -**Description:** +Domain +~~~~~~ domain - Event domain enumeration: - 'fault', 'heartbeat', 'measurementsForVfScaling', 'mobileFlow', 'other', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' -**Applied Stereotypes:** +Contains Enumeration Literals: -- Preliminary +- FAULT: -**Contains Enumeration Literals:** +- HEARTBEAT: -- FAULT +- MEASUREMENT: -- HEARTBEAT +- MOBILEFLOW: -- MEASUREMENT +- NOTIFICATION: -- MOBILEFLOW +- OTHER: -- NOTIFICATION +- PERF3GPP: -- OTHER +- PNFREGISTRATION: -- PERF3GPP +- SIPSIGNALING: -- PNFREGISTRATION +- STATECHANGE: -- SIPSIGNALING +- SYSLOG: -- STATECHANGE +- THRESHOLDCROSSINGALERT: -- SYSLOG +- VOICEQUALITY: -- THRESHOLDCROSSINGALERT +- STNDDEFINED: -- VOICEQUALITY +- STNDDEFINED: -EndpointDescription enumeration -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +EndpointDescription +~~~~~~~~~~~~~~~~~~~ -**Qualified Name:** Ves::TypeDefinitions::EndpointDescription +Contains Enumeration Literals: -**Applied Stereotypes:** +- CALLER: -- Preliminary +- CALLEE: -**Contains Enumeration Literals:** - -- CALLER - -- CALLEE - -EventSeverity enumeration -^^^^^^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::TypeDefinitions::EventSeverity - -**Description:** +EventSeverity +~~~~~~~~~~~~~ Event severity enumeration: 'CRITICAL', 'MAJOR', 'MINOR', 'WARNING', 'NORMAL'. NORMAL is used to represent clear. -**Applied Stereotypes:** +Contains Enumeration Literals: -- Preliminary +- CRITICAL: -**Contains Enumeration Literals:** +- MAJOR: -- CRITICAL +- MINOR: -- MAJOR +- WARNING: -- MINOR +- NORMAL: -- WARNING +NicAdminState +~~~~~~~~~~~~~ -- NORMAL +Contains Enumeration Literals: -NicAdminState enumeration -^^^^^^^^^^^^^^^^^^^^^^^^^ +- IN_SERVICE: -**Qualified Name:** Ves::TypeDefinitions::NicAdminState +- OUT_OF_SERVICE: -**Applied Stereotypes:** +NicOpsState +~~~~~~~~~~~ -- Preliminary +Contains Enumeration Literals: -**Contains Enumeration Literals:** +- IN_SERVICE: -- IN_SERVICE +- OUT_OF_SERVICE: -- OUT_OF_SERVICE +SourceIndicator +~~~~~~~~~~~~~~~ -NicOpsState enumeration -^^^^^^^^^^^^^^^^^^^^^^^ +Indicates the source of the operation -**Qualified Name:** Ves::TypeDefinitions::NicOpsState +Contains Enumeration Literals: -**Applied Stereotypes:** +- RESOURCE_OPERATION: -- Preliminary + - internal operation of resource -**Contains Enumeration Literals:** +- MANAGEMENT_OPERATOIN: -- IN_SERVICE + - response to management operation -- OUT_OF_SERVICE +- SON_OPERATOIN: -SyslogFacility enumeration -^^^^^^^^^^^^^^^^^^^^^^^^^^ + - result of SON -**Qualified Name:** Ves::TypeDefinitions::SyslogFacility +- UNKNOWN: -**Description:** + - can't determine why -Numeric code from 0 to 23 for facility: +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) -**Applied Stereotypes:** - -- Preliminary - -**Contains Enumeration Literals:** +Contains Enumeration Literals: -- 0 +- 0: - kernel messages -- 1 +- 1: - user-level messages -- 2 +- 2: - mail system -- 3 +- 3: - system daemons -- 4 +- 4: - security/authorization messages -- 5 +- 5: - messages generated internally by syslogd -- 6 +- 6: - line printer subsystem -- 7 +- 7: - network news subsystem -- 8 +- 8: - UUCP subsystem -- 9 +- 9: - clock daemon -- 10 +- 10: - security/authorization messages -- 11 +- 11: - FTP daemon -- 12 +- 12: - NTP subsystem -- 13 +- 13: - log audit -- 14 +- 14: - log alert -- 15 +- 15: - clock daemon -- 16 +- 16: - local use 0 (local0) -- 17 +- 17: - local use 1 (local1) -- 18 +- 18: - local use 2 (local2) -- 19 +- 19: - local use 3 (local3) -- 20 +- 20: - local use 4 (local4) -- 21 +- 21: - local use 5 (local5) -- 22 +- 22: - local use 6 (local6) -- 23 +- 23: - local use 7 (local7 ) -SyslogSev enumeration -^^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::TypeDefinitions::SyslogSev - -**Description:** +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 -**Applied Stereotypes:** - -- Preliminary +Contains Enumeration Literals: -**Contains Enumeration Literals:** +- EMERGENCY: -- EMERGENCY + - system is unusable - 0 - - system is unusable +- ALERT: -- ALERT + - 1 - action must be taken immediately - - 1 +- CRITICAL: -- CRITICAL + - critical conditions - 2 - - critical conditions +- ERROR: -- ERROR + - 3 - error conditions - - 3 - -- WARNING +- WARNING: - 4 - warning conditions -- NOTICE - - - 5 +- NOTICE: - normal but significant condition -- INFO + - 5 - - 6 +- INFO: - Informational messages -- DEBUG + - 6 - - 7 +- DEBUG: - debug-level messages -TCACriticality enumeration -^^^^^^^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::TypeDefinitions::TCACriticality + - 7 -**Description:** +TCACriticality +~~~~~~~~~~~~~~ Threshold Crossing Alert counter criticality - possible values of CRIT and MAJ. -**Applied Stereotypes:** - -- Preliminary - -**Contains Enumeration Literals:** +Contains Enumeration Literals: -- CRIT +- CRIT: -- MAJ +- MAJ: -VfStatus enumeration -^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::TypeDefinitions::VfStatus - -**Description:** +VfStatus +~~~~~~~~ Virtual function status enumeration: 'Active', 'Idle', 'Preparing to terminate', 'Ready to terminate', 'Requesting Termination' -**Applied Stereotypes:** - -- Preliminary - -**Contains Enumeration Literals:** +Contains Enumeration Literals: -- ACTIVE +- ACTIVE: -- IDLE +- IDLE: -- PREPARING_TO_TERMINATE +- PREPARING_TO_TERMINATE: -- READY_TO_TERMINATE +- READY_TO_TERMINATE: -- REQUESTING_TERMINATION +- REQUESTING_TERMINATION: diff --git a/docs/ONAP Model Spec/im/VES/VES-event.png b/docs/ONAP Model Spec/im/VES/VES-event.png Binary files differnew file mode 100644 index 0000000..b99a833 --- /dev/null +++ b/docs/ONAP Model Spec/im/VES/VES-event.png diff --git a/docs/ONAP Model Spec/im/VES/VES-ipmi.png b/docs/ONAP Model Spec/im/VES/VES-ipmi.png Binary files differnew file mode 100644 index 0000000..8630df3 --- /dev/null +++ b/docs/ONAP Model Spec/im/VES/VES-ipmi.png diff --git a/docs/ONAP Model Spec/im/VES/VES-measure.png b/docs/ONAP Model Spec/im/VES/VES-measure.png Binary files differnew file mode 100644 index 0000000..a06bc7d --- /dev/null +++ b/docs/ONAP Model Spec/im/VES/VES-measure.png diff --git a/docs/ONAP Model Spec/im/VES/VES-mobile.png b/docs/ONAP Model Spec/im/VES/VES-mobile.png Binary files differnew file mode 100644 index 0000000..21fa531 --- /dev/null +++ b/docs/ONAP Model Spec/im/VES/VES-mobile.png diff --git a/docs/ONAP Model Spec/im/VES/VES-perf3gpp.png b/docs/ONAP Model Spec/im/VES/VES-perf3gpp.png Binary files differnew file mode 100644 index 0000000..21d6fd2 --- /dev/null +++ b/docs/ONAP Model Spec/im/VES/VES-perf3gpp.png diff --git a/docs/ONAP Model Spec/im/VES/VES-root.png b/docs/ONAP Model Spec/im/VES/VES-root.png Binary files differnew file mode 100644 index 0000000..6f5076b --- /dev/null +++ b/docs/ONAP Model Spec/im/VES/VES-root.png diff --git a/docs/ONAP Model Spec/im/VES/VES-sipsignal.png b/docs/ONAP Model Spec/im/VES/VES-sipsignal.png Binary files differnew file mode 100644 index 0000000..893851d --- /dev/null +++ b/docs/ONAP Model Spec/im/VES/VES-sipsignal.png diff --git a/docs/ONAP Model Spec/im/VES/VES-voice.png b/docs/ONAP Model Spec/im/VES/VES-voice.png Binary files differnew file mode 100644 index 0000000..3becc78 --- /dev/null +++ b/docs/ONAP Model Spec/im/VES/VES-voice.png |
