diff options
Diffstat (limited to 'docs/ONAP Model Spec')
| -rw-r--r-- | docs/ONAP Model Spec/im/VES index.rst | 14 | ||||
| -rw-r--r-- | docs/ONAP Model Spec/im/VES/VES-class-1.rst | 7551 |
2 files changed, 7565 insertions, 0 deletions
diff --git a/docs/ONAP Model Spec/im/VES index.rst b/docs/ONAP Model Spec/im/VES index.rst new file mode 100644 index 0000000..2440f38 --- /dev/null +++ b/docs/ONAP Model Spec/im/VES index.rst @@ -0,0 +1,14 @@ +.. Copyright 2019 +.. 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 +============= + +.. toctree:: + :maxdepth: 2 + + VES-class-1 + VES-class-2 + VES-datatype + VES-enumeration
\ No newline at end of file diff --git a/docs/ONAP Model Spec/im/VES/VES-class-1.rst b/docs/ONAP Model Spec/im/VES/VES-class-1.rst new file mode 100644 index 0000000..aa30e95 --- /dev/null +++ b/docs/ONAP Model Spec/im/VES/VES-class-1.rst @@ -0,0 +1,7551 @@ +.. Copyright 2019 +.. 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 Class Definition - part 1 +----------------------------- + +.. contents:: + :depth: 3 +.. + +CodecsInUse class +^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Ves::ObjectClasses::CodecsInUse + +**Description:** + +The codecsInUse datatype consists of the following fields describing the number of times an identified codec was used over the measurementInterval + +**Applied Stereotypes:** + +- OpenModelClass + +- support: MANDATORY + +- Preliminary + +**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:** + +The cpuUsage datatype defines the usage of an identifier CPU and consists of the following fields: + +**Applied Stereotypes:** + +- OpenModelClass + +- 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:** + +The diskUsage datatype defines the usage of a disk device. + +**Applied Stereotypes:** + +- OpenModelClass + +- 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:** + +- OpenModelClass + +- 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:** + +Fields specific to fault events + +**Parent class:** VesEvent + +**Applied Stereotypes:** + +- OpenModelClass + +- 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:** + +The filesystemUsage datatype consists of the following fields: + +**Applied Stereotypes:** + +- OpenModelClass + +- 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:** + +- OpenModelClass + +- 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:** + +The heartbeatFields datatype is an optional field block for fields specific to heartbeat events. + +**Parent class:** VesEvent + +**Applied Stereotypes:** + +- OpenModelClass + +- 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:** + +The hugePages datatype provides metrics on system hugePages + +**Applied Stereotypes:** + +- OpenModelClass + +- 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:** + +The ipmi (Intelligent Platform Management Interface) datatype provides intelligent platform management interface metrics; it consists of the following fields: + +**Applied Stereotypes:** + +- OpenModelClass + +- support: MANDATORY + +- Preliminary + +**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:** + +The ipmiBaseboardTemperature datatype consists of the following fields which describe ipmi baseboard temperature metrics: + +Field Type Required? Description + +**Applied Stereotypes:** + +- OpenModelClass + +- 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:** + +The ipmiBaseboardVoltageRegulator datatype consists of the following fields which describe ipmi baseboard voltage regulator metrics: + +**Applied Stereotypes:** + +- OpenModelClass + +- 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 + +**Description:** + +The ipmiBattery datatype consists of the following fields which describe ipmi battery metrics: + +**Applied Stereotypes:** + +- OpenModelClass + +- 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:** + +- OpenModelClass + +- 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:** + +The ipmiGlobalAggregateTemperatureMargin datatype consists of the following fields: + +**Applied Stereotypes:** + +- OpenModelClass + +- 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:** + +The ipmiHsbp datatype provides ipmi hot swap backplane power metrics; it consists of the following fields: + +**Applied Stereotypes:** + +- OpenModelClass + +- 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:** + +The ipmiNic datatype provides network interface control care metrics; it consists of the following fields: + +**Applied Stereotypes:** + +- OpenModelClass + +- 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:** + +The ipmiPowerSupply datatype provides ipmi power supply metrics; it consists of the following fields: + +**Applied Stereotypes:** + +- OpenModelClass + +- 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:** + +The ipmiProcessor datatype provides ipmi processor metrics + +**Applied Stereotypes:** + +- OpenModelClass + +- 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:** + +The latencyBucketMeasure datatype consists of the following fields which describe the number of counts falling within a defined latency bucket + +**Applied Stereotypes:** + +- OpenModelClass + +- support: MANDATORY + +- Preliminary + +**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:** + +The load datatype provides metrics on system cpu and io utilization obtained using /proc/loadavg + +**Applied Stereotypes:** + +- OpenModelClass + +- 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:** + +The machineCheckException datatype describes machine check exceptions + +**Applied Stereotypes:** + +- OpenModelClass + +- 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:** + +The measDataCollection datatype defines a 3GPP measurement collection structure aligned with the 3GPP PM format + +**Applied Stereotypes:** + +- OpenModelClass + +- 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:** + +- OpenModelClass + +- 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:** + +The measInfoIdString datatype provides a string measurement group identifier; + +**Applied Stereotypes:** + +- OpenModelClass + +- 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:** + +The measResultInteger datatype provides an integer 3GPP PM measurement result; + +**Applied Stereotypes:** + +- OpenModelClass + +- 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:** + +The measResultString datatype provides a string 3GPP PM measurement result; + +**Applied Stereotypes:** + +- OpenModelClass + +- 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:** + +The measTypesInteger datatype provides an array of integer measurement identifiers associated with the measurement results + +**Applied Stereotypes:** + +- OpenModelClass + +- 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:** + +The measTypesString datatype provides an array of string measurement identifiers associated with the measurement results + +**Applied Stereotypes:** + +- OpenModelClass + +- 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:** + +The measValues datatype provides 3GPP measurement values + +**Applied Stereotypes:** + +- OpenModelClass + +- 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:** + +Fields specific to measurement events + +**Parent class:** VesEvent + +**Applied Stereotypes:** + +- OpenModelClass + +- 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:** + +The memoryUsage datatype defines the memory usage of a virtual machine and consists of the following fields: + +**Applied Stereotypes:** + +- OpenModelClass + +- 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:** + +The measResultNumber datatype provides a number 3GPP PM measurement result + +**Applied Stereotypes:** + +- OpenModelClass + +- 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:** + +Fields specific to mobility flow events + +**Parent class:** VesEvent + +**Applied Stereotypes:** + +- OpenModelClass + +- 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:** + +The nicPerformance datatype consists of the following fields which describe the performance and errors of an of an identified virtual network interface card + +**Applied Stereotypes:** + +- OpenModelClass + +- support: MANDATORY + +- Preliminary + +**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 +====================================== ============= ========= ================================================================================================================================================================================== ===================== |