VES Class Definition - part 1
CmNotify
Parent class: VesEvent
Applied stereotypes:
OpenModelClass
support: MANDATORY
Experimental
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
additionalInformation |
HashMap |
0..1 |
OpenModelAttribute
|
Additional information nf provider wants to convey. |
Ves::Diagrams::CmNotify::additionalInformation |
cmNotifyFieldsVersion |
String |
1 |
OpenModelAttribute
|
Version of the cmNotify |
Ves::Diagrams::CmNotify::cmNotifyFieldsVersion |
correlatedNotifications |
invalid |
0..* |
OpenModelAttribute
|
Notifications to which this notification is considered to be correlated |
Ves::Diagrams::CmNotify::correlatedNotifications |
eventTime |
DateTime |
1 |
OpenModelAttribute
|
Time of the cmNotify event. |
Ves::Diagrams::CmNotify::eventTime |
notificationId |
String |
1 |
OpenModelAttribute
|
Unique Identifier for the source of this occurrence of the notification. For 3GPP devices this is the notification identifier as defined by ITUT |
Ves::Diagrams::CmNotify::notificationId |
sourceIndicator |
SourceIndicator |
0..1 |
OpenModelAttribute
|
Indicates the source of the operation that led to the generation of the notification. |
Ves::Diagrams::CmNotify::sourceIndicator |
systemDN |
String |
0..1 |
OpenModelAttribute
|
DN of the management service provider |
Ves::Diagrams::CmNotify::systemDN |
_cmnotif |
cmNotif |
1..* |
OpenModelAttribute
|
Array of cmNotif notificatons |
Ves::Diagrams::CmNotify::_cmnotif |
domain |
Domain |
1 |
Experimental OpenModelAttribute
|
Update in definition only Event domain enumeration: ‘cmNotify’,’fault’, ‘heartbeat’, ‘measurement’, ‘mobileFlow’, ‘notification’, ‘other’, ‘pnfRegistration’, ‘sipSignaling’, ‘stateChange’, ‘syslog’, ‘thresholdCrossingAlert’, ‘voiceQuality’ |
Ves::ObjectClasses::VesEvent::domain |
eventType |
String |
0..1 |
Preliminary OpenModelAttribute
|
For example: ‘applicationNf’, ‘guestOS’, ‘hostOS’, ‘platform’ |
Ves::ObjectClasses::VesEvent::eventType |
lastEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
the latest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds |
Ves::ObjectClasses::VesEvent::lastEpochMicrosec |
nfcNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function component type: 3 characters (aligned with vfc naming standards) |
Ves::ObjectClasses::VesEvent::nfcNamingCode |
nfNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function type: 4 characters (aligned with vnf and pnf naming standards) |
Ves::ObjectClasses::VesEvent::nfNamingCode |
nfVendorName |
String |
1 |
Preliminary OpenModelAttribute
|
Network function vendor name |
Ves::ObjectClasses::VesEvent::nfVendorName |
priority |
Priority |
1 |
Preliminary OpenModelAttribute
|
Processing priority enumeration: ‘High’, ‘Medium’, ‘Normal’, ‘Low’ |
Ves::ObjectClasses::VesEvent::priority |
reportingEntityId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See ‘reportingEntityName’ for more information. reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. |
Ves::ObjectClasses::VesEvent::reportingEntityId |
reportingEntityName |
String |
1 |
Preliminary OpenModelAttribute
|
reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. |
Ves::ObjectClasses::VesEvent::reportingEntityName |
sequence |
Integer |
1 |
Preliminary OpenModelAttribute
|
sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ordering of events communicated by an event source instance (or 0 if not needed) |
Ves::ObjectClasses::VesEvent::sequence |
sourceId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See ‘sourceName’ for more information. sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. |
Ves::ObjectClasses::VesEvent::sourceId |
sourceName |
String |
1 |
Preliminary OpenModelAttribute
|
Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. |
Ves::ObjectClasses::VesEvent::sourceName |
startingEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) |
Ves::ObjectClasses::VesEvent::startingEpochMicrosec |
timeZoneOffset |
String |
0..1 |
Preliminary OpenModelAttribute
|
Offset to GMT to indicate local time zone for device formatted as ‘UTC+/-hh:mm’; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples |
Ves::ObjectClasses::VesEvent::timeZoneOffset |
version |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the event header as “#.#” where # is a digit; see section 1 for the correct digits to use. |
Ves::ObjectClasses::VesEvent::version |
vesEventListenerVersion |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the ves event listener api spec that this event is compliant with (as “#” or “#.#” or “#.#.#” where # is a digit; see section 1 for the correct digits to use). |
Ves::ObjectClasses::VesEvent::vesEventListenerVersion |
name |
String |
1 |
Preliminary OpenModelAttribute
|
Ves::ObjectClasses::VesEvent::name |
|
Status |
String |
0..1 |
Preliminary OpenModelAttribute
|
The current condition of an interaction, such as open, in research, closed, and so forth |
Common::Business Interaction::ObjectClasses::BusinessInteraction::Status |
description |
String |
0..1 |
Preliminary OpenModelAttribute
|
Defines a textual free-form description of the object. |
Common::Root::RootObjectClasses::RootEntity::description |
id |
Identifier |
1 |
Preliminary OpenModelAttribute
|
Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. |
Common::Root::RootObjectClasses::RootEntity::id |
CodecsInUse
The codecsInUse datatype consists of the following fields describing the number of times an identified codec was used over the measurementInterval
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
codecIdentifier |
String |
1 |
Preliminary OpenModelAttribute
|
Description of the codec. |
Ves::ObjectClasses::CodecsInUse::codecIdentifier |
numberInUse |
Integer |
1 |
Preliminary OpenModelAttribute
|
Number of such codecs in use. |
Ves::ObjectClasses::CodecsInUse::numberInUse |
CpuUsage
The cpuUsage datatype defines the usage of an identifier CPU and consists of the following fields:
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
cpuCapacityContention |
Number |
0..1 |
Preliminary OpenModelAttribute
|
The amount of time the CPU cannot run due to contention, in milliseconds over the measurementInterval |
Ves::ObjectClasses::CpuUsage::cpuCapacityContention |
cpuDemandAvg |
Number |
0..1 |
Preliminary OpenModelAttribute
|
The total CPU time that the NF/NFC/VM could use if there was no contention, in milliseconds over the measurementInterval |
Ves::ObjectClasses::CpuUsage::cpuDemandAvg |
cpuDemandMhz |
Number |
0..1 |
Preliminary OpenModelAttribute
|
CPU demand in MHz |
Ves::ObjectClasses::CpuUsage::cpuDemandMhz |
cpuDemandPct |
Number |
0..1 |
Preliminary OpenModelAttribute
|
CPU demand as a percentage of the provisioned capacity |
Ves::ObjectClasses::CpuUsage::cpuDemandPct |
cpuIdentifier |
String |
1 |
Preliminary OpenModelAttribute
|
CPU Identifier |
Ves::ObjectClasses::CpuUsage::cpuIdentifier |
cpuIdle |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Percentage of CPU time spent in the idle task |
Ves::ObjectClasses::CpuUsage::cpuIdle |
cpuLatencyAvg |
Number |
0..1 |
Preliminary OpenModelAttribute
|
cpuDemandAvg - The total CPU time that the VNF/VNFC/VM could use if there is no contention, in milliseconds. |
Ves::ObjectClasses::CpuUsage::cpuLatencyAvg |
cpuOverheadAvg |
Number |
0..1 |
Preliminary OpenModelAttribute
|
The overhead demand above available allocations and reservations, in milliseconds over the measurementInterval |
Ves::ObjectClasses::CpuUsage::cpuOverheadAvg |
cpuSwapWaitTime |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Swap wait time, in milliseconds over the measurementInterval |
Ves::ObjectClasses::CpuUsage::cpuSwapWaitTime |
cpuUsageInterrupt |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Percentage of time spent servicing interrupts |
Ves::ObjectClasses::CpuUsage::cpuUsageInterrupt |
cpuUsageNice |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Percentage of time spent running user space processes that have been niced |
Ves::ObjectClasses::CpuUsage::cpuUsageNice |
cpuUsageSoftIrq |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Percentage of time spent handling soft irq interrupts |
Ves::ObjectClasses::CpuUsage::cpuUsageSoftIrq |
cpuUsageSteal |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Percentage of time spent in involuntary wait which is neither user, system or idle time and is effectively time that went missing |
Ves::ObjectClasses::CpuUsage::cpuUsageSteal |
cpuUsageSystem |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Percentage of time spent on system tasks running the kernel |
Ves::ObjectClasses::CpuUsage::cpuUsageSystem |
cpuUsageUser |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Percentage of time spent running un-niced user space processes |
Ves::ObjectClasses::CpuUsage::cpuUsageUser |
cpuWait |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Percentage of CPU time spent waiting for I/O operations to complete |
Ves::ObjectClasses::CpuUsage::cpuWait |
percentUsage |
Number |
1 |
Preliminary OpenModelAttribute
|
Aggregate cpu usage of the virtual machine on which the xNFC reporting the event is running |
Ves::ObjectClasses::CpuUsage::percentUsage |
DiskUsage
The diskUsage datatype defines the usage of a disk device.
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
diskBusResets |
Number |
0..1 |
Preliminary OpenModelAttribute
|
The number of bus resets in the performance interval. |
Ves::ObjectClasses::DiskUsage::diskBusResets |
diskCommandsAborted |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of disk commands aborted over the measurementInterval. |
Ves::ObjectClasses::DiskUsage::diskCommandsAborted |
diskCommandsAvg |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Average number of commands per second over the measurementInterval. |
Ves::ObjectClasses::DiskUsage::diskCommandsAvg |
diskFlushRequests |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Total flush requests of the disk cache over the measurementInterval. |
Ves::ObjectClasses::DiskUsage::diskFlushRequests |
diskFlushTime |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Milliseconds spent on disk cache flushing over the measurementInterval. |
Ves::ObjectClasses::DiskUsage::diskFlushTime |
diskIdentifier |
String |
1 |
Preliminary OpenModelAttribute
|
Disk Identifier. |
Ves::ObjectClasses::DiskUsage::diskIdentifier |
diskIoTimeAvg |
Number |
1 |
Preliminary OpenModelAttribute
|
Milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the average over the measurement interval |
Ves::ObjectClasses::DiskUsage::diskIoTimeAvg |
diskIoTimeLast |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the last value measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskIoTimeLast |
diskIoTimeMax |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the maximum value measurement within the measurement interval |
Ves::ObjectClasses::DiskUsage::diskIoTimeMax |
diskIoTimeMin |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the minimum value measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskIoTimeMin |
diskMergedReadAvg |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the average measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskMergedReadAvg |
diskMergedReadLast |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the last value measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskMergedReadLast |
diskMergedReadMax |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the maximum value measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskMergedReadMax |
diskMergedReadMin |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the minimum value measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskMergedReadMin |
diskMergedWriteAvg |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the average measurement within the measurement interval |
Ves::ObjectClasses::DiskUsage::diskMergedWriteAvg |
diskMergedWriteLast |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the last value measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskMergedWriteLast |
diskMergedWriteMax |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the maximum value measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskMergedWriteMax |
diskMergedWriteMin |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the minimum value measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskMergedWriteMin |
diskOctetsReadAvg |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of octets per second read from a disk or partition; provide the average measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskOctetsReadAvg |
diskOctetsReadLast |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of octets per second read from a disk or partition; provide the last measurement within the measurement interval |
Ves::ObjectClasses::DiskUsage::diskOctetsReadLast |
diskOctetsReadMax |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of octets per second read from a disk or partition; provide the maximum measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskOctetsReadMax |
diskOctetsReadMin |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of octets per second read from a disk or partition; provide the minimum measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskOctetsReadMin |
diskOctetsWriteAvg |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of octets per second written to a disk or partition; provide the average measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskOctetsWriteAvg |
diskOctetsWriteLast |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of octets per second written to a disk or partition; provide the last measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskOctetsWriteLast |
diskOctetsWriteMax |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of octets per second written to a disk or partition; provide the maximum measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskOctetsWriteMax |
diskOctetsWriteMin |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of octets per second written to a disk or partition; provide the minimum measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskOctetsWriteMin |
diskOpsReadAvg |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of read operations per second issued to the disk; provide the average measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskOpsReadAvg |
diskOpsReadLast |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of read operations per second issued to the disk; provide the last measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskOpsReadLast |
diskOpsReadMax |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of read operations per second issued to the disk; provide the maximum measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskOpsReadMax |
diskOpsReadMin |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of read operations per second issued to the disk; provide the minimum measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskOpsReadMin |
diskOpsWriteAvg |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of write operations per second issued to the disk; provide the average measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskOpsWriteAvg |
diskOpsWriteLast |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of write operations per second issued to the disk; provide the last measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskOpsWriteLast |
diskOpsWriteMax |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of write operations per second issued to the disk; provide the maximum measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskOpsWriteMax |
diskOpsWriteMin |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of write operations per second issued to the disk; provide the minimum measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskOpsWriteMin |
diskPendingOperationsAvg |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Queue size of pending I/O operations per second; provide the average measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskPendingOperationsAvg |
diskPendingOperationsLast |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Queue size of pending I/O operations per second; provide the last measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskPendingOperationsLast |
diskPendingOperationsMax |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Queue size of pending I/O operations per second; provide the maximum measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskPendingOperationsMax |
diskPendingOperationsMin |
Number |
0..1 |
Preliminary OpenModelAttribute
|
diskPendingOperationsMin - Queue size of pending I/O operations per second; provide the minimum measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskPendingOperationsMin |
diskReadCommandsAvg |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Average number of read commands issued per second to the disk over the measurementInterval. |
Ves::ObjectClasses::DiskUsage::diskReadCommandsAvg |
diskTime |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Nanoseconds spent on disk cache reads/writes within the measurementInterval. |
Ves::ObjectClasses::DiskUsage::diskTime |
diskTimeReadAvg |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Milliseconds a read operation took to complete; provide the average measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskTimeReadAvg |
diskTimeReadLast |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Milliseconds a read operation took to complete; provide the last measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskTimeReadLast |
diskTimeReadMax |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Milliseconds a read operation took to complete; provide the maximum measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskTimeReadMax |
diskTimeReadMin |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Milliseconds a read operation took to complete; provide the minimum measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskTimeReadMin |
diskTimeWriteAvg |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Milliseconds a write operation took to complete; provide the average measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskTimeWriteAvg |
diskTimeWriteLast |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Milliseconds a write operation took to complete; provide the last measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskTimeWriteLast |
diskTimeWriteMax |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Milliseconds a write operation took to complete; provide the maximum measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskTimeWriteMax |
diskTimeWriteMin |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Milliseconds a write operation took to complete; provide the minimum measurement within the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskTimeWriteMin |
diskTotalReadLatencyAvg |
Number |
0..1 |
Preliminary OpenModelAttribute
|
The average amount of time taken for a read from the perspective of a Guest OS. This is the sum of Kernel Read Latency and Physical Device Read Latency in milliseconds over the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskTotalReadLatencyAvg |
diskTotalWriteLatencyAvg |
Number |
0..1 |
Preliminary OpenModelAttribute
|
The average amount of time taken for a write from the perspective of a Guest OS. This is the sum of Kernel Write Latency and Physical Device Write Latency in milliseconds over the measurement interval. |
Ves::ObjectClasses::DiskUsage::diskTotalWriteLatencyAvg |
diskWeightedIoTimeAvg |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Measure in ms over 1 sec of both I/O completion time and the backlog that may be accumulating. Value is the average within the collection interval. |
Ves::ObjectClasses::DiskUsage::diskWeightedIoTimeAvg |
diskWeightedIoTimeLast |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Measure in ms over 1 sec of both I/O completion time and the backlog that may be accumulating. Value is the last within the collection interval. |
Ves::ObjectClasses::DiskUsage::diskWeightedIoTimeLast |
diskWeightedIoTimeMax |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Measure in ms over 1 sec of both I/O completion time and the backlog that may be accumulating. Value is the maximum within the collection interval. |
Ves::ObjectClasses::DiskUsage::diskWeightedIoTimeMax |
diskWeightedIoTimeMin |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Measure in ms over 1 sec of both I/O completion time and the backlog that may be accumulating. Value is the minimum within the collection interval. |
Ves::ObjectClasses::DiskUsage::diskWeightedIoTimeMin |
diskWriteCommandsAvg |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Average number of write commands issued per second to the disk over the measurementInterval |
Ves::ObjectClasses::DiskUsage::diskWriteCommandsAvg |
EndOfCallVqmSummaries
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
adjacencyName |
String |
1 |
Preliminary OpenModelAttribute
|
Adjacency name |
Ves::ObjectClasses::EndOfCallVqmSummaries::adjacencyName |
endpointAverageJitter |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Endpoint average jitter |
Ves::ObjectClasses::EndOfCallVqmSummaries::endpointAverageJitter |
endpointDescription |
EndpointDescription |
1 |
Preliminary OpenModelAttribute
|
Enumeration: ‘Caller’, ‘Callee’ |
Ves::ObjectClasses::EndOfCallVqmSummaries::endpointDescription |
endpointMaxJitter |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Endpoint maximum jitter |
Ves::ObjectClasses::EndOfCallVqmSummaries::endpointMaxJitter |
endpointRtpOctetsDiscarded |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Endpoint RTP octets discarded |
Ves::ObjectClasses::EndOfCallVqmSummaries::endpointRtpOctetsDiscarded |
endpointRtpOctetsLost |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Endpoint RTP octets lost |
Ves::ObjectClasses::EndOfCallVqmSummaries::endpointRtpOctetsLost |
endpointRtpOctetsReceived |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Endpoint RTP octets received |
Ves::ObjectClasses::EndOfCallVqmSummaries::endpointRtpOctetsReceived |
endpointRtpOctetsSent |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Endpoint RTP octets sent |
Ves::ObjectClasses::EndOfCallVqmSummaries::endpointRtpOctetsSent |
endpointRtpPacketsDiscarded |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Endpoint RTP packets discarded |
Ves::ObjectClasses::EndOfCallVqmSummaries::endpointRtpPacketsDiscarded |
endpointRtpPacketsLost |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Endpoint RTP packets lost |
Ves::ObjectClasses::EndOfCallVqmSummaries::endpointRtpPacketsLost |
endpointRtpPacketsReceived |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Endpoint RTP packets received |
Ves::ObjectClasses::EndOfCallVqmSummaries::endpointRtpPacketsReceived |
endpointRtpPacketsSent |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Endpoint RTP packets sent |
Ves::ObjectClasses::EndOfCallVqmSummaries::endpointRtpPacketsSent |
localAverageJitter |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Local average jitter |
Ves::ObjectClasses::EndOfCallVqmSummaries::localAverageJitter |
localAverageJitterBufferDelay |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Local average jitter buffer delay |
Ves::ObjectClasses::EndOfCallVqmSummaries::localAverageJitterBufferDelay |
localMaxJitter |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Local maximum jitter |
Ves::ObjectClasses::EndOfCallVqmSummaries::localMaxJitter |
localMaxJitterBufferDelay |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Local max jitter buffer delay |
Ves::ObjectClasses::EndOfCallVqmSummaries::localMaxJitterBufferDelay |
localRtpOctetsDiscarded |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Local RTP octets discarded |
Ves::ObjectClasses::EndOfCallVqmSummaries::localRtpOctetsDiscarded |
localRtpOctetsLost |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Local RTP octets lost |
Ves::ObjectClasses::EndOfCallVqmSummaries::localRtpOctetsLost |
localRtpOctetsReceived |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Local RTP octets received |
Ves::ObjectClasses::EndOfCallVqmSummaries::localRtpOctetsReceived |
localRtpOctetsSent |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Local RTP octets sent |
Ves::ObjectClasses::EndOfCallVqmSummaries::localRtpOctetsSent |
localRtpPacketsDiscarded |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Local RTP packets discarded |
Ves::ObjectClasses::EndOfCallVqmSummaries::localRtpPacketsDiscarded |
localRtpPacketsLost |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Local RTP packets lost |
Ves::ObjectClasses::EndOfCallVqmSummaries::localRtpPacketsLost |
localRtpPacketsReceived |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Local RTP packets received |
Ves::ObjectClasses::EndOfCallVqmSummaries::localRtpPacketsReceived |
localRtpPacketsSent |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Local RTP packets sent |
Ves::ObjectClasses::EndOfCallVqmSummaries::localRtpPacketsSent |
mosCqe |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Decimal range from 1 to 5 (1 decimal place) |
Ves::ObjectClasses::EndOfCallVqmSummaries::mosCqe |
oneWayDelay |
Number |
0..1 |
Preliminary OpenModelAttribute
|
one-way path delay in milliseconds |
Ves::ObjectClasses::EndOfCallVqmSummaries::oneWayDelay |
packetLossPercent |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Calculated percentage packet loss based on endpoint RTP packets lost (as reported in RTCP) and local RTP packets sent. Direction is based on endpoint description (Caller, Callee). Decimal (2 decimal places) |
Ves::ObjectClasses::EndOfCallVqmSummaries::packetLossPercent |
rFactor |
Number |
0..1 |
Preliminary OpenModelAttribute
|
rFactor from 0 to 100 |
Ves::ObjectClasses::EndOfCallVqmSummaries::rFactor |
roundTripDelay |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Round trip delay in milliseconds |
Ves::ObjectClasses::EndOfCallVqmSummaries::roundTripDelay |
Fault
Fields specific to fault events
Parent class: VesEvent
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
alarmAdditionalInformation |
HashMap |
0..1 |
Preliminary OpenModelAttribute
|
Additional alarm information. ? Note1: for SNMP mapping to VES, for hash key use OID of varbind, for value use incoming data for that varbind). ? Note2: Alarm ID for 3GPP should be included (if applicable) in alarmAdditonalInformation as ‘alarmId’:’alarmIdValue’. Could contain managed object instance as separate key:value; could add probable cause as separate key:value. |
Ves::ObjectClasses::Fault::alarmAdditionalInformation |
alarmCondition |
String |
1 |
Preliminary OpenModelAttribute
|
Short name of the alarm condition/problem, such as a trap name. Should not have white space (e.g., tpLgCgiNotInConfig, BfdSessionDown, linkDown, etc…) |
Ves::ObjectClasses::Fault::alarmCondition |
alarmInterfaceA |
String |
0..1 |
Preliminary OpenModelAttribute
|
Card, port, channel or interface name of the device generating the alarm. This could reflect managed object. |
Ves::ObjectClasses::Fault::alarmInterfaceA |
eventCatagory |
String |
0..1 |
Preliminary OpenModelAttribute
|
Event category, for example: ‘license’, ‘link’, ‘routing’, ‘security’, ‘signaling’ |
Ves::ObjectClasses::Fault::eventCatagory |
eventSeverity |
EventSeverity |
1 |
Preliminary OpenModelAttribute
|
Event severity enumeration: ‘CRITICAL’, ‘MAJOR’, ‘MINOR’, ‘WARNING’, ‘NORMAL’. NORMAL is used to represent clear. |
Ves::ObjectClasses::Fault::eventSeverity |
eventSourceType |
String |
1 |
Preliminary OpenModelAttribute
|
Examples: ‘card’, ‘host’, ‘other’, ‘port’, ‘portThreshold’, ‘router’, ‘slotThreshold’, ‘switch’, ‘virtualMachine’, ‘virtualNetworkFunction’. This could be managed object class. |
Ves::ObjectClasses::Fault::eventSourceType |
faultFieldsVersion |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the faultFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. |
Ves::ObjectClasses::Fault::faultFieldsVersion |
specificProblem |
String |
1 |
Preliminary OpenModelAttribute
|
Description of the alarm or problem (e.g., ‘eNodeB 155197 in PLMN 310-410 with eNodeB name KYL05197 is lost’). 3GPP probable cause would be included in this field. |
Ves::ObjectClasses::Fault::specificProblem |
vfStatus |
VfStatus |
1 |
Preliminary OpenModelAttribute
|
Virtual function status enumeration: ‘Active’, ‘Idle’, ‘Preparing to terminate’, ‘Ready to terminate’, ‘Requesting Termination’ |
Ves::ObjectClasses::Fault::vfStatus |
domain |
Domain |
1 |
Experimental OpenModelAttribute
|
Update in definition only Event domain enumeration: ‘cmNotify’,’fault’, ‘heartbeat’, ‘measurement’, ‘mobileFlow’, ‘notification’, ‘other’, ‘pnfRegistration’, ‘sipSignaling’, ‘stateChange’, ‘syslog’, ‘thresholdCrossingAlert’, ‘voiceQuality’ |
Ves::ObjectClasses::VesEvent::domain |
eventType |
String |
0..1 |
Preliminary OpenModelAttribute
|
For example: ‘applicationNf’, ‘guestOS’, ‘hostOS’, ‘platform’ |
Ves::ObjectClasses::VesEvent::eventType |
lastEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
the latest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds |
Ves::ObjectClasses::VesEvent::lastEpochMicrosec |
nfcNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function component type: 3 characters (aligned with vfc naming standards) |
Ves::ObjectClasses::VesEvent::nfcNamingCode |
nfNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function type: 4 characters (aligned with vnf and pnf naming standards) |
Ves::ObjectClasses::VesEvent::nfNamingCode |
nfVendorName |
String |
1 |
Preliminary OpenModelAttribute
|
Network function vendor name |
Ves::ObjectClasses::VesEvent::nfVendorName |
priority |
Priority |
1 |
Preliminary OpenModelAttribute
|
Processing priority enumeration: ‘High’, ‘Medium’, ‘Normal’, ‘Low’ |
Ves::ObjectClasses::VesEvent::priority |
reportingEntityId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See ‘reportingEntityName’ for more information. reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. |
Ves::ObjectClasses::VesEvent::reportingEntityId |
reportingEntityName |
String |
1 |
Preliminary OpenModelAttribute
|
reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. |
Ves::ObjectClasses::VesEvent::reportingEntityName |
sequence |
Integer |
1 |
Preliminary OpenModelAttribute
|
sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ordering of events communicated by an event source instance (or 0 if not needed) |
Ves::ObjectClasses::VesEvent::sequence |
sourceId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See ‘sourceName’ for more information. sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. |
Ves::ObjectClasses::VesEvent::sourceId |
sourceName |
String |
1 |
Preliminary OpenModelAttribute
|
Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. |
Ves::ObjectClasses::VesEvent::sourceName |
startingEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) |
Ves::ObjectClasses::VesEvent::startingEpochMicrosec |
timeZoneOffset |
String |
0..1 |
Preliminary OpenModelAttribute
|
Offset to GMT to indicate local time zone for device formatted as ‘UTC+/-hh:mm’; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples |
Ves::ObjectClasses::VesEvent::timeZoneOffset |
version |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the event header as “#.#” where # is a digit; see section 1 for the correct digits to use. |
Ves::ObjectClasses::VesEvent::version |
vesEventListenerVersion |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the ves event listener api spec that this event is compliant with (as “#” or “#.#” or “#.#.#” where # is a digit; see section 1 for the correct digits to use). |
Ves::ObjectClasses::VesEvent::vesEventListenerVersion |
name |
String |
1 |
Preliminary OpenModelAttribute
|
Ves::ObjectClasses::VesEvent::name |
|
Status |
String |
0..1 |
Preliminary OpenModelAttribute
|
The current condition of an interaction, such as open, in research, closed, and so forth |
Common::Business Interaction::ObjectClasses::BusinessInteraction::Status |
description |
String |
0..1 |
Preliminary OpenModelAttribute
|
Defines a textual free-form description of the object. |
Common::Root::RootObjectClasses::RootEntity::description |
id |
Identifier |
1 |
Preliminary OpenModelAttribute
|
Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. |
Common::Root::RootObjectClasses::RootEntity::id |
FilesystemUsage
The filesystemUsage datatype consists of the following fields:
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
blockConfigured |
Number |
1 |
Preliminary OpenModelAttribute
|
Configured block storage capacity in GB. |
Ves::ObjectClasses::FilesystemUsage::blockConfigured |
blockops |
Number |
1 |
Preliminary OpenModelAttribute
|
Block storage input-output operations per second. |
Ves::ObjectClasses::FilesystemUsage::blockops |
blockUsed |
Number |
1 |
Preliminary OpenModelAttribute
|
Used block storage capacity in GB. |
Ves::ObjectClasses::FilesystemUsage::blockUsed |
ephemeralConfigured |
Number |
1 |
Preliminary OpenModelAttribute
|
Configured ephemeral storage capacity in GB. |
Ves::ObjectClasses::FilesystemUsage::ephemeralConfigured |
ephemerallops |
Number |
1 |
Preliminary OpenModelAttribute
|
Ephemeral storage input-output operations per second. |
Ves::ObjectClasses::FilesystemUsage::ephemerallops |
ephemeralUsed |
Number |
1 |
Preliminary OpenModelAttribute
|
Used ephemeral storage capacity in GB. |
Ves::ObjectClasses::FilesystemUsage::ephemeralUsed |
filesysytemName |
String |
1 |
Preliminary OpenModelAttribute
|
File system name. |
Ves::ObjectClasses::FilesystemUsage::filesysytemName |
GtpPerFlowMetrics
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
avgBitErrorRate |
Number |
1 |
Preliminary OpenModelAttribute
|
Average bit error rate |
Ves::ObjectClasses::GtpPerFlowMetrics::avgBitErrorRate |
avgPacketDelayVariation |
Number |
1 |
Preliminary OpenModelAttribute
|
Average packet delay variation or jitter in milliseconds for received packets: Average difference between the packet timestamp and time received for all pairs of consecutive packets |
Ves::ObjectClasses::GtpPerFlowMetrics::avgPacketDelayVariation |
avgPacketLatency |
Number |
1 |
Preliminary OpenModelAttribute
|
Average delivery latency |
Ves::ObjectClasses::GtpPerFlowMetrics::avgPacketLatency |
avgReceiveThroughput |
Number |
1 |
Preliminary OpenModelAttribute
|
Average receive throughput |
Ves::ObjectClasses::GtpPerFlowMetrics::avgReceiveThroughput |
avgTransmitThroughput |
Number |
1 |
Preliminary OpenModelAttribute
|
Average transmit throughput |
Ves::ObjectClasses::GtpPerFlowMetrics::avgTransmitThroughput |
durConnectionFailedStatus |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Duration of failed state in milliseconds, computed as the cumulative time between a failed echo request and the next following successful error request, over this reporting interval |
Ves::ObjectClasses::GtpPerFlowMetrics::durConnectionFailedStatus |
durTunnelFailedStatus |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Duration of errored state, computed as the cumulative time between a tunnel error indicator and the next following non-errored indicator, over this reporting interval |
Ves::ObjectClasses::GtpPerFlowMetrics::durTunnelFailedStatus |
flowActivatedBy |
String |
0..1 |
Preliminary OpenModelAttribute
|
Endpoint activating the flow |
Ves::ObjectClasses::GtpPerFlowMetrics::flowActivatedBy |
flowActivationEpoch |
Number |
1 |
Preliminary OpenModelAttribute
|
Time the connection is activated in the flow (connection) being reported on, or transmission time of the first packet if activation time is not available |
Ves::ObjectClasses::GtpPerFlowMetrics::flowActivationEpoch |
flowActivationMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
Integer microseconds for the start of the flow connection |
Ves::ObjectClasses::GtpPerFlowMetrics::flowActivationMicrosec |
flowActivationTime |
String |
0..1 |
Preliminary OpenModelAttribute
|
Time the connection is activated in the flow being reported on, or transmission time of the first packet if activation time is not available; with RFC 2822 compliant format: ‘Sat, 13 Mar 2010 11:29:05 -0800’ |
Ves::ObjectClasses::GtpPerFlowMetrics::flowActivationTime |
flowDeactivatedBy |
String |
0..1 |
Preliminary OpenModelAttribute
|
Endpoint deactivating the flow |
Ves::ObjectClasses::GtpPerFlowMetrics::flowDeactivatedBy |
flowDeactivationEpoch |
Number |
1 |
Preliminary OpenModelAttribute
|
Time for the start of the flow connection, in integer UTC epoch time aka UNIX time |
Ves::ObjectClasses::GtpPerFlowMetrics::flowDeactivationEpoch |
flowDeactivationMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
Integer microseconds for the start of the flow connection |
Ves::ObjectClasses::GtpPerFlowMetrics::flowDeactivationMicrosec |
flowDeactivationTime |
String |
1 |
Preliminary OpenModelAttribute
|
Transmission time of the first packet in the flow connection being reported on; with RFC 2822 compliant format: ‘Sat, 13 Mar 2010 11:29:05 -0800’ |
Ves::ObjectClasses::GtpPerFlowMetrics::flowDeactivationTime |
flowStatus |
String |
1 |
Preliminary OpenModelAttribute
|
Connection status at reporting time as a working / inactive / failed indicator value |
Ves::ObjectClasses::GtpPerFlowMetrics::flowStatus |
gtpConnectionStatus |
String |
0..1 |
Preliminary OpenModelAttribute
|
Current connection state at reporting time |
Ves::ObjectClasses::GtpPerFlowMetrics::gtpConnectionStatus |
gtpTunnelStatus |
String |
0..1 |
Preliminary OpenModelAttribute
|
Current tunnel state at reporting time |
Ves::ObjectClasses::GtpPerFlowMetrics::gtpTunnelStatus |
ipTosCountList |
HashMap |
0..1 |
Preliminary OpenModelAttribute
|
Array of key: value pairs where the keys are drawn from the IP Type-of-Service identifiers which range from ‘0’ to ‘255’, and the values are the count of packets that had those ToS identifiers in the flow |
Ves::ObjectClasses::GtpPerFlowMetrics::ipTosCountList |
ipTosList |
String |
0..1 |
Preliminary OpenModelAttribute
|
Array of unique IP Type-of-Service values observed in the flow where values range from ‘0’ to ‘255’ |
Ves::ObjectClasses::GtpPerFlowMetrics::ipTosList |
largePacketRtt |
Number |
0..1 |
Preliminary OpenModelAttribute
|
large packet round trip time |
Ves::ObjectClasses::GtpPerFlowMetrics::largePacketRtt |
largePacketThreshold |
Number |
0..1 |
Preliminary OpenModelAttribute
|
large packet threshold being applied |
Ves::ObjectClasses::GtpPerFlowMetrics::largePacketThreshold |
maxPacketDelayVariation |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Maximum packet delay variation or jitter in milliseconds for received packets: Maximum of the difference between the packet timestamp and time received for all pairs of consecutive packets |
Ves::ObjectClasses::GtpPerFlowMetrics::maxPacketDelayVariation |
maxReceiveBitRate |
Number |
0..1 |
Preliminary OpenModelAttribute
|
maximum receive bit rate” |
Ves::ObjectClasses::GtpPerFlowMetrics::maxReceiveBitRate |
maxTransmitBitRate |
Number |
0..1 |
Preliminary OpenModelAttribute
|
maximum transmit bit rate |
Ves::ObjectClasses::GtpPerFlowMetrics::maxTransmitBitRate |
mobileQciCosCountList |
HashMap |
0..1 |
Preliminary OpenModelAttribute
|
array of key: value pairs where the keys are drawn from LTE QCI or UMTS class of service strings, and the values are the count of packets that had those strings in the flow |
Ves::ObjectClasses::GtpPerFlowMetrics::mobileQciCosCountList |
mobileQciCosList |
String |
0..1 |
Preliminary OpenModelAttribute
|
Array of unique LTE QCI or UMTS class-of-service values observed in the flow |
Ves::ObjectClasses::GtpPerFlowMetrics::mobileQciCosList |
numActivationFailures |
Number |
1 |
Preliminary OpenModelAttribute
|
Number of failed activation requests, as observed by the reporting node |
Ves::ObjectClasses::GtpPerFlowMetrics::numActivationFailures |
numBitErrors |
Number |
1 |
Preliminary OpenModelAttribute
|
number of errored bits number of errored bits |
Ves::ObjectClasses::GtpPerFlowMetrics::numBitErrors |
numBytesReceived |
Number |
1 |
Preliminary OpenModelAttribute
|
number of bytes received, including retransmissions |
Ves::ObjectClasses::GtpPerFlowMetrics::numBytesReceived |
numBytesTransmitted |
Number |
1 |
Preliminary OpenModelAttribute
|
number of bytes transmitted, including retransmissions |
Ves::ObjectClasses::GtpPerFlowMetrics::numBytesTransmitted |
numDroppedPackets |
Number |
1 |
Preliminary OpenModelAttribute
|
number of received packets dropped due to errors per virtual interface |
Ves::ObjectClasses::GtpPerFlowMetrics::numDroppedPackets |
numGtpEchoFailures |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of Echo request path failures where failed paths are defined in 3GPP TS 29.281 sec 7.2.1 and 3GPP TS 29.060 sec. 11.2 |
Ves::ObjectClasses::GtpPerFlowMetrics::numGtpEchoFailures |
numGtpTunnelErrors |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of tunnel error indications where errors are defined in 3GPP TS 29.281 sec 7.3.1 and 3GPP TS 29.060 sec. 11.1 |
Ves::ObjectClasses::GtpPerFlowMetrics::numGtpTunnelErrors |
numHttpErrors |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Http error count |
Ves::ObjectClasses::GtpPerFlowMetrics::numHttpErrors |
numL7BytesReceived |
Number |
1 |
Preliminary OpenModelAttribute
|
number of tunneled layer 7 bytes received, including retransmissions |
Ves::ObjectClasses::GtpPerFlowMetrics::numL7BytesReceived |
numL7BytesTransmitted |
Number |
1 |
Preliminary OpenModelAttribute
|
number of tunneled layer 7 bytes received, including retransmissions |
Ves::ObjectClasses::GtpPerFlowMetrics::numL7BytesTransmitted |
numLostPackets |
Number |
1 |
Preliminary OpenModelAttribute
|
number of tunneled layer 7 bytes received, including retransmissions |
Ves::ObjectClasses::GtpPerFlowMetrics::numLostPackets |
numOutOfOrderPackets |
Number |
1 |
Preliminary OpenModelAttribute
|
number of out-of-order packets |
Ves::ObjectClasses::GtpPerFlowMetrics::numOutOfOrderPackets |
numPacketErrors |
Number |
1 |
Preliminary OpenModelAttribute
|
number of errored packets |
Ves::ObjectClasses::GtpPerFlowMetrics::numPacketErrors |
numPacketsReceivedExclRetrans |
Number |
1 |
Preliminary OpenModelAttribute
|
number of packets received, excluding retransmission |
Ves::ObjectClasses::GtpPerFlowMetrics::numPacketsReceivedExclRetrans |
numPacketsReceivedInclRetrans |
Number |
1 |
Preliminary OpenModelAttribute
|
number of packets received, including retransmission |
Ves::ObjectClasses::GtpPerFlowMetrics::numPacketsReceivedInclRetrans |
numPacketsTransmittedInclRetrans |
Number |
1 |
Preliminary OpenModelAttribute
|
number of packets transmitted, including retransmissions |
Ves::ObjectClasses::GtpPerFlowMetrics::numPacketsTransmittedInclRetrans |
numRetries |
Number |
1 |
Preliminary OpenModelAttribute
|
number of packet retrie |
Ves::ObjectClasses::GtpPerFlowMetrics::numRetries |
numTimeouts |
Number |
1 |
Preliminary OpenModelAttribute
|
number of packet timeouts |
Ves::ObjectClasses::GtpPerFlowMetrics::numTimeouts |
numTunneledL7BytesReceived |
Number |
1 |
Preliminary OpenModelAttribute
|
number of tunneled layer 7 bytes received, excluding retransmissions |
Ves::ObjectClasses::GtpPerFlowMetrics::numTunneledL7BytesReceived |
roundTripTime |
Number |
1 |
Preliminary OpenModelAttribute
|
Round Trip time |
Ves::ObjectClasses::GtpPerFlowMetrics::roundTripTime |
tcpFlagCountList |
HashMap |
0..1 |
Preliminary OpenModelAttribute
|
Array of key: value pairs where the keys are drawn from TCP Flags and the values are the count of packets that had that TCP Flag in the flow |
Ves::ObjectClasses::GtpPerFlowMetrics::tcpFlagCountList |
tcpFlagList |
String |
0..1 |
Preliminary OpenModelAttribute
|
Array of unique TCP Flags observed in the flow |
Ves::ObjectClasses::GtpPerFlowMetrics::tcpFlagList |
timeToFirstByte |
Number |
1 |
Preliminary OpenModelAttribute
|
Time in milliseconds between the connection activation and first byte received |
Ves::ObjectClasses::GtpPerFlowMetrics::timeToFirstByte |
Heartbeat
The heartbeatFields datatype is an optional field block for fields specific to heartbeat events.
Parent class: VesEvent
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
additionalFields |
HashMap |
0..1 |
Preliminary OpenModelAttribute
|
Additional expansion fields if needed. |
Ves::ObjectClasses::Heartbeat::additionalFields |
heartbeatFieldVersion |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the heartbeatFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. |
Ves::ObjectClasses::Heartbeat::heartbeatFieldVersion |
heartbeatInterval |
Integer |
1 |
Preliminary OpenModelAttribute
|
Current heartbeatInterval in seconds. |
Ves::ObjectClasses::Heartbeat::heartbeatInterval |
domain |
Domain |
1 |
Experimental OpenModelAttribute
|
Update in definition only Event domain enumeration: ‘cmNotify’,’fault’, ‘heartbeat’, ‘measurement’, ‘mobileFlow’, ‘notification’, ‘other’, ‘pnfRegistration’, ‘sipSignaling’, ‘stateChange’, ‘syslog’, ‘thresholdCrossingAlert’, ‘voiceQuality’ |
Ves::ObjectClasses::VesEvent::domain |
eventType |
String |
0..1 |
Preliminary OpenModelAttribute
|
For example: ‘applicationNf’, ‘guestOS’, ‘hostOS’, ‘platform’ |
Ves::ObjectClasses::VesEvent::eventType |
lastEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
the latest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds |
Ves::ObjectClasses::VesEvent::lastEpochMicrosec |
nfcNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function component type: 3 characters (aligned with vfc naming standards) |
Ves::ObjectClasses::VesEvent::nfcNamingCode |
nfNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function type: 4 characters (aligned with vnf and pnf naming standards) |
Ves::ObjectClasses::VesEvent::nfNamingCode |
nfVendorName |
String |
1 |
Preliminary OpenModelAttribute
|
Network function vendor name |
Ves::ObjectClasses::VesEvent::nfVendorName |
priority |
Priority |
1 |
Preliminary OpenModelAttribute
|
Processing priority enumeration: ‘High’, ‘Medium’, ‘Normal’, ‘Low’ |
Ves::ObjectClasses::VesEvent::priority |
reportingEntityId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See ‘reportingEntityName’ for more information. reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. |
Ves::ObjectClasses::VesEvent::reportingEntityId |
reportingEntityName |
String |
1 |
Preliminary OpenModelAttribute
|
reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. |
Ves::ObjectClasses::VesEvent::reportingEntityName |
sequence |
Integer |
1 |
Preliminary OpenModelAttribute
|
sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ordering of events communicated by an event source instance (or 0 if not needed) |
Ves::ObjectClasses::VesEvent::sequence |
sourceId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See ‘sourceName’ for more information. sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. |
Ves::ObjectClasses::VesEvent::sourceId |
sourceName |
String |
1 |
Preliminary OpenModelAttribute
|
Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. |
Ves::ObjectClasses::VesEvent::sourceName |
startingEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) |
Ves::ObjectClasses::VesEvent::startingEpochMicrosec |
timeZoneOffset |
String |
0..1 |
Preliminary OpenModelAttribute
|
Offset to GMT to indicate local time zone for device formatted as ‘UTC+/-hh:mm’; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples |
Ves::ObjectClasses::VesEvent::timeZoneOffset |
version |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the event header as “#.#” where # is a digit; see section 1 for the correct digits to use. |
Ves::ObjectClasses::VesEvent::version |
vesEventListenerVersion |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the ves event listener api spec that this event is compliant with (as “#” or “#.#” or “#.#.#” where # is a digit; see section 1 for the correct digits to use). |
Ves::ObjectClasses::VesEvent::vesEventListenerVersion |
name |
String |
1 |
Preliminary OpenModelAttribute
|
Ves::ObjectClasses::VesEvent::name |
|
Status |
String |
0..1 |
Preliminary OpenModelAttribute
|
The current condition of an interaction, such as open, in research, closed, and so forth |
Common::Business Interaction::ObjectClasses::BusinessInteraction::Status |
description |
String |
0..1 |
Preliminary OpenModelAttribute
|
Defines a textual free-form description of the object. |
Common::Root::RootObjectClasses::RootEntity::description |
id |
Identifier |
1 |
Preliminary OpenModelAttribute
|
Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. |
Common::Root::RootObjectClasses::RootEntity::id |
HugePages
The hugePages datatype provides metrics on system hugePages
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
bytesFree |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of free hugePages in bytes. |
Ves::ObjectClasses::HugePages::bytesFree |
bytesUsed |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of used hugePages in bytes. |
Ves::ObjectClasses::HugePages::bytesUsed |
hugePagesIdentifier |
String |
1 |
Preliminary OpenModelAttribute
|
HugePages identifier |
Ves::ObjectClasses::HugePages::hugePagesIdentifier |
percentFree |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of free hugePages in percent. |
Ves::ObjectClasses::HugePages::percentFree |
percentused |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of used hugePages in percent. |
Ves::ObjectClasses::HugePages::percentused |
vmPageNumberFree |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of free hugePages in numbers. |
Ves::ObjectClasses::HugePages::vmPageNumberFree |
vmPageNumberUsed |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Number of used hugePages in numbers. |
Ves::ObjectClasses::HugePages::vmPageNumberUsed |
Ipmi
The ipmi (Intelligent Platform Management Interface) datatype provides intelligent platform management interface metrics; it consists of the following fields:
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
exitAirTemperature |
Number |
0..1 |
Preliminary OpenModelAttribute
|
System fan exit air flow temperature in Celsius |
Ves::ObjectClasses::Ipmi::exitAirTemperature |
frontPanelTemperature |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Front panel temp in Celsius |
Ves::ObjectClasses::Ipmi::frontPanelTemperature |
ioModuleTemperature |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Io module temp in Celsius |
Ves::ObjectClasses::Ipmi::ioModuleTemperature |
systemAirflow |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Airflow in cubic feet per minute (cfm) |
Ves::ObjectClasses::Ipmi::systemAirflow |
_ipmibaseboardtemperature |
IpmiBaseboardTemperature |
0..1 |
Preliminary OpenModelAttribute
|
Array of ipmiBaseboard Temperature objects |
Ves::ObjectClasses::Ipmi::_ipmibaseboardtemperature |
_ipmibaseboardvoltageregulator |
IpmiBaseboardVoltageRegulator |
0..1 |
Preliminary OpenModelAttribute
|
Array of ipmiBaseboard VoltageRegulator objects |
Ves::ObjectClasses::Ipmi::_ipmibaseboardvoltageregulator |
_ipmibattery |
IpmiBattery |
0..1 |
Preliminary OpenModelAttribute
|
Array of ipmiBattery objects |
Ves::ObjectClasses::Ipmi::_ipmibattery |
_ipmifan |
IpmiFan |
0..1 |
Preliminary OpenModelAttribute
|
Array of ipmiFan objects |
Ves::ObjectClasses::Ipmi::_ipmifan |
_ipmiglobalaggregatetemperaturemargin |
IpmiGlobalAggregateTemperatureMargin |
0..1 |
Preliminary OpenModelAttribute
|
ipmi global aggregate temperature margin |
Ves::ObjectClasses::Ipmi::_ipmiglobalaggregatetemperaturemargin |
_ipmihsbp |
IpmiHsbp |
0..1 |
Preliminary OpenModelAttribute
|
Array of ipmiHsbp objects |
Ves::ObjectClasses::Ipmi::_ipmihsbp |
_ipminic |
IpmiNic |
0..1 |
Preliminary OpenModelAttribute
|
Array of ipmiNic objects |
Ves::ObjectClasses::Ipmi::_ipminic |
_ipmipowersupply |
IpmiPowerSupply |
0..1 |
Preliminary OpenModelAttribute
|
Array of ipmiPowerSupply objects |
Ves::ObjectClasses::Ipmi::_ipmipowersupply |
_ipmiprocessor |
IpmiProcessor |
0..1 |
Preliminary OpenModelAttribute
|
Array of ipmiProcessor objects |
Ves::ObjectClasses::Ipmi::_ipmiprocessor |
IpmiBaseboardTemperature
The ipmiBaseboardTemperature datatype consists of the following fields which describe ipmi baseboard temperature metrics: Field Type Required? Description
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
baseboardTemperature |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Baseboard temperature in celsius |
Ves::ObjectClasses::IpmiBaseboardTemperature::baseboardTemperature |
baseboardTemperature Identifier |
String |
1 |
Preliminary OpenModelAttribute
|
Identifier for the location where the temperature is taken |
Ves::ObjectClasses::IpmiBaseboardTemperature::baseboardTemperature Identifier |
IpmiBaseboardVoltageRegulator
The ipmiBaseboardVoltageRegulator datatype consists of the following fields which describe ipmi baseboard voltage regulator metrics:
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
baseboaredVoltageRegulatorIdentifier |
String |
1 |
Preliminary OpenModelAttribute
|
Identifier for the baseboard voltage regulator |
Ves::ObjectClasses::IpmiBaseboardVoltageRegulator::baseboaredVoltageRegulatorIdentifier |
voltageRegulatorTemperature |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Voltage regulator temperature in celsius |
Ves::ObjectClasses::IpmiBaseboardVoltageRegulator::voltageRegulatorTemperature |
IpmiBattery
The ipmiBattery datatype consists of the following fields which describe ipmi battery metrics:
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
batteryIdentifier |
String |
1 |
Preliminary OpenModelAttribute
|
Identifier for the battery |
Ves::ObjectClasses::IpmiBattery::batteryIdentifier |
batteryType |
String |
0..1 |
Preliminary OpenModelAttribute
|
Type of battery |
Ves::ObjectClasses::IpmiBattery::batteryType |
batteryVoltageLevel |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Battery voltage level |
Ves::ObjectClasses::IpmiBattery::batteryVoltageLevel |
IpmiFan
The ipmiFan datatype consists of the following fields which describe ipmi fan metrics:
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
fanIdentifier |
String |
1 |
Preliminary OpenModelAttribute
|
Identifier for the fan |
Ves::ObjectClasses::IpmiFan::fanIdentifier |
fanSpeed |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Fan speed in revolutions per minute (rpm) |
Ves::ObjectClasses::IpmiFan::fanSpeed |
IpmiGlobalAggregateTemperatureMargin
The ipmiGlobalAggregateTemperatureMargin datatype consists of the following fields:
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
globalAggregateTemperatureMargin |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Temperature margin in Celsius relative to a throttling thermal trip point |
Ves::ObjectClasses::IpmiGlobalAggregateTemperatureMargin::globalAggregateTemperatureMargin |
globalAggregateTemperatureMarginIdentifier |
String |
1 |
Preliminary OpenModelAttribute
|
Identifier for the ipmi global aggregate temperature margin metrics |
Ves::ObjectClasses::IpmiGlobalAggregateTemperatureMargin::globalAggregateTemperatureMarginIdentifier |
IpmiHsbp
The ipmiHsbp datatype provides ipmi hot swap backplane power metrics; it consists of the following fields:
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
hsbpIdentifier |
String |
1 |
Preliminary OpenModelAttribute
|
Identifier for the hot swap backplane power unit |
Ves::ObjectClasses::IpmiHsbp::hsbpIdentifier |
hsbpTemperature |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Hot swap backplane power temperature in celsius |
Ves::ObjectClasses::IpmiHsbp::hsbpTemperature |
IpmiNic
The ipmiNic datatype provides network interface control care metrics; it consists of the following fields:
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
nicIdentifier |
String |
1 |
Preliminary OpenModelAttribute
|
Identifier for the network interface control card |
Ves::ObjectClasses::IpmiNic::nicIdentifier |
nicTemperature |
Number |
0..1 |
Preliminary OpenModelAttribute
|
nic temperature in Celsius |
Ves::ObjectClasses::IpmiNic::nicTemperature |
IpmiPowerSupply
The ipmiPowerSupply datatype provides ipmi power supply metrics; it consists of the following fields:
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
powerSupplyCurrentOutputPercent |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Current output voltage as a percentage of the design specified level |
Ves::ObjectClasses::IpmiPowerSupply::powerSupplyCurrentOutputPercent |
powerSupplyIdentifier |
String |
1 |
Preliminary OpenModelAttribute
|
Identifier for the power supply |
Ves::ObjectClasses::IpmiPowerSupply::powerSupplyIdentifier |
powerSupplyInputPower |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Input power in watts |
Ves::ObjectClasses::IpmiPowerSupply::powerSupplyInputPower |
powerSupplyTemperature |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Power supply temperature in Celsius |
Ves::ObjectClasses::IpmiPowerSupply::powerSupplyTemperature |
IpmiProcessor
The ipmiProcessor datatype provides ipmi processor metrics
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
processorThermalControlPercent |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Io module temperatue in celsius |
Ves::ObjectClasses::IpmiProcessor::processorThermalControlPercent |
processorDtsThermalMargin |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Front panel temperature in celsius |
Ves::ObjectClasses::IpmiProcessor::processorDtsThermalMargin |
_processordimmaggregatethermalmargin |
ProcessorDimmAggregateThermalMargin |
0..1 |
Preliminary OpenModelAttribute
|
Array of processorDimmAggregate ThermalMargin objects |
Ves::ObjectClasses::IpmiProcessor::_processordimmaggregatethermalmargin |
processorIdentifier |
String |
1 |
Preliminary OpenModelAttribute
|
Identifier for the power supply |
Ves::ObjectClasses::IpmiProcessor::processorIdentifier |
LatencyBucketMeasure
The latencyBucketMeasure datatype consists of the following fields which describe the number of counts falling within a defined latency bucket
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
countsInTheBucket |
Number |
1 |
Preliminary OpenModelAttribute
|
Number of counts falling within a defined latency bucket |
Ves::ObjectClasses::LatencyBucketMeasure::countsInTheBucket |
highEndOfLatencyBucket |
Number |
0..1 |
Preliminary OpenModelAttribute
|
High end of bucket range (typically in ms) |
Ves::ObjectClasses::LatencyBucketMeasure::highEndOfLatencyBucket |
lowEndOfLatencyBucket |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Low end of bucket range (typically in ms) |
Ves::ObjectClasses::LatencyBucketMeasure::lowEndOfLatencyBucket |
Load
The load datatype provides metrics on system cpu and io utilization obtained using /proc/loadavg
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
longTerm |
Number |
0..1 |
Preliminary OpenModelAttribute
|
number of jobs in the run queue (state R, cpu utilization) or waiting for disk I/O (state D, io utilization) averaged over 15 minutes using /proc/loadavg |
Ves::ObjectClasses::Load::longTerm |
midTerm |
Number |
0..1 |
Preliminary OpenModelAttribute
|
number of jobs in the run queue (state R, cpu utilization) or waiting for disk I/O (state D, io utilization) averaged over 5 minutes using /proc/loadavg |
Ves::ObjectClasses::Load::midTerm |
shortTerm |
Number |
0..1 |
Preliminary OpenModelAttribute
|
number of jobs in the run queue (state R, cpu utilization) or waiting for disk I/O (state D, io utilization) averaged over 1 minute using /proc/loadavg |
Ves::ObjectClasses::Load::shortTerm |
MachineCheckException
The machineCheckException datatype describes machine check exceptions
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
correctedMemoryErrors |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Total hardware errors that were corrected by the hardware (e.g. data corruption corrected via ECC) over the measurementInterval. These errors do not require immediate software actions, but are still reported for accounting and predictive failure analysis |
Ves::ObjectClasses::MachineCheckException::correctedMemoryErrors |
correctedMemoryErrors In1Hr |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Total hardware errors that were corrected by the hardware over the last one hour |
Ves::ObjectClasses::MachineCheckException::correctedMemoryErrors In1Hr |
vmlIdentifier |
String |
1 |
Preliminary OpenModelAttribute
|
processIdentifier |
Ves::ObjectClasses::MachineCheckException::vmlIdentifier |
uncorrectedMemoryErrors |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Total uncorrected hardware errors that were detected by the hardware (e.g., causing data corruption) over the measurementInterval. These errors require a software response. |
Ves::ObjectClasses::MachineCheckException::uncorrectedMemoryErrors |
uncorrectedMemoryErrors In1Hr |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Total uncorrected hardware errors that were detected by the hardware over the last one hour |
Ves::ObjectClasses::MachineCheckException::uncorrectedMemoryErrors In1Hr |
MeasDataCollection
The measDataCollection datatype defines a 3GPP measurement collection structure aligned with the 3GPP PM format
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
formatVersion |
String |
0..1 |
Preliminary OpenModelAttribute
|
3GPP PM reporting file format version from pre-standard TS 28.550 v2.0.0 |
Ves::ObjectClasses::MeasDataCollection::formatVersion |
granularityPeriod |
String |
1 |
Preliminary OpenModelAttribute
|
Granularity period for the PM report in seconds |
Ves::ObjectClasses::MeasDataCollection::granularityPeriod |
measObjInstIdList |
String |
0..1 |
Preliminary OpenModelAttribute
|
Array of monitored object local distinguished name ids per 3GPP TS 32.300 |
Ves::ObjectClasses::MeasDataCollection::measObjInstIdList |
measuredEntityDn |
String |
1 |
Preliminary OpenModelAttribute
|
Distinguished name per 3GPP TS 28.550 |
Ves::ObjectClasses::MeasDataCollection::measuredEntityDn |
measuredEntitySoftwareVersion |
String |
0..1 |
Preliminary OpenModelAttribute
|
Software version for the NF providing the PM data as specified in 3GPP TS 28.550 |
Ves::ObjectClasses::MeasDataCollection::measuredEntitySoftwareVersion |
measuredEntityUserName |
String |
0..1 |
Preliminary OpenModelAttribute
|
User Definable name for the measured object per 3GPP TS 28.550 |
Ves::ObjectClasses::MeasDataCollection::measuredEntityUserName |
_measinfo |
MeasInfo |
1..* |
Preliminary OpenModelAttribute
|
Array of monitored object local distinguished name ids per 3GPP TS 32.300 |
Ves::ObjectClasses::MeasDataCollection::_measinfo |
MeasInfo
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
jobId |
String |
0..1 |
Preliminary OpenModelAttribute
|
Name of the measurement job |
Ves::ObjectClasses::MeasInfo::jobId |
_measinfoidinteger |
measInfoIdInteger |
0..1 |
Preliminary OpenModelAttribute
|
Measurement group Identifier |
Ves::ObjectClasses::MeasInfo::_measinfoidinteger |
_measinfoidstring |
MeasInfoIdString |
0..1 |
Preliminary OpenModelAttribute
|
Measurement group Identifier |
Ves::ObjectClasses::MeasInfo::_measinfoidstring |
_meastypesinteger |
MeasTypesInteger |
0..1 |
Preliminary OpenModelAttribute
|
Array of measurement identifiers associated with the measurement results expressed as integers for efficiency rather than strings |
Ves::ObjectClasses::MeasInfo::_meastypesinteger |
_meastypesstring |
MeasTypesString |
0..1 |
Preliminary OpenModelAttribute
|
Array of measurement identifiers associated with the measurement results expressed as integers for efficiency rather than strings |
Ves::ObjectClasses::MeasInfo::_meastypesstring |
_measValuesList |
MeasValues |
1..* |
Experimental OpenModelAttribute
|
Array of measValues |
Ves::ObjectClasses::MeasInfo::_measValuesList |
MeasInfoIdString
The measInfoIdString datatype provides a string measurement group identifier;
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
sMeasInfoId |
Integer |
1 |
Preliminary OpenModelAttribute
|
String measurement group Identifier |
Ves::ObjectClasses::MeasInfoIdString::sMeasInfoId |
MeasResultInteger
The measResultInteger datatype provides an integer 3GPP PM measurement result;
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
p |
Integer |
1 |
Preliminary OpenModelAttribute
|
Integer reference to the counter |
Ves::ObjectClasses::MeasResultInteger::p |
iValue |
Integer |
1 |
Preliminary OpenModelAttribute
|
Integer counter value |
Ves::ObjectClasses::MeasResultInteger::iValue |
MeasResultString
The measResultString datatype provides a string 3GPP PM measurement result;
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
p |
Integer |
1 |
Preliminary OpenModelAttribute
|
Integer reference to the counter |
Ves::ObjectClasses::MeasResultString::p |
sVlaue |
String |
1 |
Preliminary OpenModelAttribute
|
String counter value |
Ves::ObjectClasses::MeasResultString::sVlaue |
MeasTypesInteger
The measTypesInteger datatype provides an array of integer measurement identifiers associated with the measurement results
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
iMeasTypesList |
Integer |
1..* |
Preliminary OpenModelAttribute
|
Array of integer measurement identifiers associated with the measurement results |
Ves::ObjectClasses::MeasTypesInteger::iMeasTypesList |
MeasTypesString
The measTypesString datatype provides an array of string measurement identifiers associated with the measurement results
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
sMeasTypesList |
String |
1..* |
Preliminary OpenModelAttribute
|
Array of string measurement identifiers associated with the measurement results |
Ves::ObjectClasses::MeasTypesString::sMeasTypesList |
MeasValues
The measValues datatype provides 3GPP measurement values
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
measObjAddFlds |
HashMap |
0..1 |
Preliminary OpenModelAttribute
|
Additional key-value pairs if needed |
Ves::ObjectClasses::MeasValues::measObjAddFlds |
suspectFlag |
Boolean |
1 |
Preliminary OpenModelAttribute
|
Enumeration: ‘true’, ‘false’. Indicates if the values are suspect VES 7.1 Spec has this attribute as a string. |
Ves::ObjectClasses::MeasValues::suspectFlag |
_measresultinteger |
MeasResultInteger |
0..* |
Preliminary OpenModelAttribute
|
Array of results |
Ves::ObjectClasses::MeasValues::_measresultinteger |
_measresultnull |
measResultNull |
0..* |
Preliminary OpenModelAttribute
|
Array of results |
Ves::ObjectClasses::MeasValues::_measresultnull |
_mesresultnumber |
MesResultNumber |
0..* |
Preliminary OpenModelAttribute
|
Array of results |
Ves::ObjectClasses::MeasValues::_mesresultnumber |
_measresultstring |
MeasResultString |
0..* |
Preliminary OpenModelAttribute
|
Array of results |
Ves::ObjectClasses::MeasValues::_measresultstring |
Measurement
Fields specific to measurement events
Parent class: VesEvent
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
additionalFields |
HashMap |
0..1 |
Preliminary OpenModelAttribute
|
Additional measurement fields if needed. |
Ves::ObjectClasses::Measurement::additionalFields |
additionalMeasurements |
ArrayofNamedHashMap |
0..1 |
Preliminary OpenModelAttribute
|
Array of named hashMap if needed. |
Ves::ObjectClasses::Measurement::additionalMeasurements |
additionalObjects |
ArrayOfSchemaObject |
0..1 |
Preliminary OpenModelAttribute
|
Array of Schema objects described by name, schema and other meta-information, if needed. |
Ves::ObjectClasses::Measurement::additionalObjects |
concurrentSessions |
Integer |
0..1 |
Preliminary OpenModelAttribute
|
Peak concurrent sessions for the VM or VNF (depending on the context) over the measurementInterval. |
Ves::ObjectClasses::Measurement::concurrentSessions |
configuredEntities |
Integer |
0..1 |
Preliminary OpenModelAttribute
|
Depending on the context over the measurementInterval: peak total number of users, subscribers, devices, adjacencies, etc., for the VM, or peak total number of subscribers, devices, etc., for the VNF |
Ves::ObjectClasses::Measurement::configuredEntities |
featureUsageArray |
HashMap |
0..1 |
Preliminary OpenModelAttribute
|
The hashMap key should identify the feature, while the value defines the number of times the identified feature was used. |
Ves::ObjectClasses::Measurement::featureUsageArray |
meanRequestLatency |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Mean seconds required to respond to each request for the VM on which the VNFC reporting the event is running. |
Ves::ObjectClasses::Measurement::meanRequestLatency |
measurementFieldsVersion |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the measurementFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. |
Ves::ObjectClasses::Measurement::measurementFieldsVersion |
measurementInterval |
Number |
1 |
Preliminary OpenModelAttribute
|
Interval over which measurements are being reported in seconds |
Ves::ObjectClasses::Measurement::measurementInterval |
nfcScalingMetric |
Integer |
0..1 |
Preliminary OpenModelAttribute
|
Represents busy-ness of the network function from 0 to 100 as reported by the nfc. |
Ves::ObjectClasses::Measurement::nfcScalingMetric |
numberOfMediaPortsInUse |
Integer |
1 |
Preliminary OpenModelAttribute
|
Number of media ports in use. |
Ves::ObjectClasses::Measurement::numberOfMediaPortsInUse |
requestRate |
Number |
1 |
Preliminary OpenModelAttribute
|
Peak request rate per second, for the VM over the measurementInterval |
Ves::ObjectClasses::Measurement::requestRate |
_Hugepages |
HugePages |
0..1 |
Preliminary OpenModelAttribute
|
Array of metrics on hugePages |
Ves::ObjectClasses::Measurement::_Hugepages |
_codecsinuse |
CodecsInUse |
0..* |
Preliminary OpenModelAttribute
|
Array of codecs in use |
Ves::ObjectClasses::Measurement::_codecsinuse |
_cpuUsage |
CpuUsage |
0..* |
Preliminary OpenModelAttribute
|
Usage of an array of CPUs |
Ves::ObjectClasses::Measurement::_cpuUsage |
_diskUsage |
DiskUsage |
0..* |
Preliminary OpenModelAttribute
|
Usage of an array of disks |
Ves::ObjectClasses::Measurement::_diskUsage |
_filesystemusage |
FilesystemUsage |
0..* |
Preliminary OpenModelAttribute
|
Filesystem usage of the VM on which the xNFC reporting the event is running |
Ves::ObjectClasses::Measurement::_filesystemusage |
_ipmi |
Ipmi |
0..1 |
Preliminary OpenModelAttribute
|
Array of intelligent platform management interface metrics |
Ves::ObjectClasses::Measurement::_ipmi |
_latencybucketmeasure |
LatencyBucketMeasure |
0..1 |
Preliminary OpenModelAttribute
|
Array of integers representing counts of requests whose latency in milliseconds falls within per-xNF configured ranges; where latency is the duration between a service request and its fulfillment. |
Ves::ObjectClasses::Measurement::_latencybucketmeasure |
_load |
Load |
0..1 |
Preliminary OpenModelAttribute
|
Array of system load metrics |
Ves::ObjectClasses::Measurement::_load |
_machinecheckexception |
MachineCheckException |
0..1 |
Preliminary OpenModelAttribute
|
Array of machine check exceptions |
Ves::ObjectClasses::Measurement::_machinecheckexception |
_memoryusage |
MemoryUsage |
0..* |
Preliminary OpenModelAttribute
|
Memory usage of an array of VMs |
Ves::ObjectClasses::Measurement::_memoryusage |
_nicperformance |
NicPerformance |
0..* |
Preliminary OpenModelAttribute
|
Performance metrics of an array of network interface cards |
Ves::ObjectClasses::Measurement::_nicperformance |
_processstats |
ProcessStats |
0..* |
Preliminary OpenModelAttribute
|
Array of metrics on system processes |
Ves::ObjectClasses::Measurement::_processstats |
domain |
Domain |
1 |
Experimental OpenModelAttribute
|
Update in definition only Event domain enumeration: ‘cmNotify’,’fault’, ‘heartbeat’, ‘measurement’, ‘mobileFlow’, ‘notification’, ‘other’, ‘pnfRegistration’, ‘sipSignaling’, ‘stateChange’, ‘syslog’, ‘thresholdCrossingAlert’, ‘voiceQuality’ |
Ves::ObjectClasses::VesEvent::domain |
eventType |
String |
0..1 |
Preliminary OpenModelAttribute
|
For example: ‘applicationNf’, ‘guestOS’, ‘hostOS’, ‘platform’ |
Ves::ObjectClasses::VesEvent::eventType |
lastEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
the latest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds |
Ves::ObjectClasses::VesEvent::lastEpochMicrosec |
nfcNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function component type: 3 characters (aligned with vfc naming standards) |
Ves::ObjectClasses::VesEvent::nfcNamingCode |
nfNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function type: 4 characters (aligned with vnf and pnf naming standards) |
Ves::ObjectClasses::VesEvent::nfNamingCode |
nfVendorName |
String |
1 |
Preliminary OpenModelAttribute
|
Network function vendor name |
Ves::ObjectClasses::VesEvent::nfVendorName |
priority |
Priority |
1 |
Preliminary OpenModelAttribute
|
Processing priority enumeration: ‘High’, ‘Medium’, ‘Normal’, ‘Low’ |
Ves::ObjectClasses::VesEvent::priority |
reportingEntityId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See ‘reportingEntityName’ for more information. reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. |
Ves::ObjectClasses::VesEvent::reportingEntityId |
reportingEntityName |
String |
1 |
Preliminary OpenModelAttribute
|
reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. |
Ves::ObjectClasses::VesEvent::reportingEntityName |
sequence |
Integer |
1 |
Preliminary OpenModelAttribute
|
sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ordering of events communicated by an event source instance (or 0 if not needed) |
Ves::ObjectClasses::VesEvent::sequence |
sourceId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See ‘sourceName’ for more information. sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. |
Ves::ObjectClasses::VesEvent::sourceId |
sourceName |
String |
1 |
Preliminary OpenModelAttribute
|
Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. |
Ves::ObjectClasses::VesEvent::sourceName |
startingEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) |
Ves::ObjectClasses::VesEvent::startingEpochMicrosec |
timeZoneOffset |
String |
0..1 |
Preliminary OpenModelAttribute
|
Offset to GMT to indicate local time zone for device formatted as ‘UTC+/-hh:mm’; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples |
Ves::ObjectClasses::VesEvent::timeZoneOffset |
version |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the event header as “#.#” where # is a digit; see section 1 for the correct digits to use. |
Ves::ObjectClasses::VesEvent::version |
vesEventListenerVersion |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the ves event listener api spec that this event is compliant with (as “#” or “#.#” or “#.#.#” where # is a digit; see section 1 for the correct digits to use). |
Ves::ObjectClasses::VesEvent::vesEventListenerVersion |
name |
String |
1 |
Preliminary OpenModelAttribute
|
Ves::ObjectClasses::VesEvent::name |
|
Status |
String |
0..1 |
Preliminary OpenModelAttribute
|
The current condition of an interaction, such as open, in research, closed, and so forth |
Common::Business Interaction::ObjectClasses::BusinessInteraction::Status |
description |
String |
0..1 |
Preliminary OpenModelAttribute
|
Defines a textual free-form description of the object. |
Common::Root::RootObjectClasses::RootEntity::description |
id |
Identifier |
1 |
Preliminary OpenModelAttribute
|
Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. |
Common::Root::RootObjectClasses::RootEntity::id |
MemoryUsage
The memoryUsage datatype defines the memory usage of a virtual machine and consists of the following fields:
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
memoryBuffered |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Kibibytes of temporary storage for raw disk blocks |
Ves::ObjectClasses::MemoryUsage::memoryBuffered |
memoryCached |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Kibibytes of memory used for cache |
Ves::ObjectClasses::MemoryUsage::memoryCached |
memoryConfigured |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Kibibytes of memory configured in the virtual machine on which the xNFC reporting the event is running |
Ves::ObjectClasses::MemoryUsage::memoryConfigured |
memoryDemand |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Host demand in kibibytes |
Ves::ObjectClasses::MemoryUsage::memoryDemand |
memoryFree |
Number |
1 |
Preliminary OpenModelAttribute
|
Kibibytes of physical RAM left unused by the system |
Ves::ObjectClasses::MemoryUsage::memoryFree |
memoryLatencyAvg |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Percentage of time the VM is waiting to access swapped or compressed memory |
Ves::ObjectClasses::MemoryUsage::memoryLatencyAvg |
memorySharedAvg |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Shared memory in kilobytes |
Ves::ObjectClasses::MemoryUsage::memorySharedAvg |
memorySlabRecl |
Number |
0..1 |
Preliminary OpenModelAttribute
|
The part of the slab that can be reclaimed such as caches measured in kibibytes |
Ves::ObjectClasses::MemoryUsage::memorySlabRecl |
memorySlabUnrecl |
Number |
0..1 |
Preliminary OpenModelAttribute
|
The part of the slab that cannot be reclaimed even when lacking memory measure in kibibytes |
Ves::ObjectClasses::MemoryUsage::memorySlabUnrecl |
memorySwapInAvg |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Amount of memory swapped-in from host cache in kibibytes |
Ves::ObjectClasses::MemoryUsage::memorySwapInAvg |
memorySwapInRateAvg |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Rate at which memory is swapped from disk into active memory during the interval in kilobytes per second |
Ves::ObjectClasses::MemoryUsage::memorySwapInRateAvg |
memorySwapOutAvg |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Amount of memory swapped-out to host cache in kibibytes |
Ves::ObjectClasses::MemoryUsage::memorySwapOutAvg |
memorySwapOutRateAvg |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Rate at which memory is being swapped from active memory to disk during the current interval in kilobytes per second |
Ves::ObjectClasses::MemoryUsage::memorySwapOutRateAvg |
memorySwapUsedAvg |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Space used for caching swapped pages in the host cache in kibibytes |
Ves::ObjectClasses::MemoryUsage::memorySwapUsedAvg |
memoryUsed |
Number |
1 |
Preliminary OpenModelAttribute
|
Total memory minus the sum of free, buffered, cached and slab memory measured in kibibytes |
Ves::ObjectClasses::MemoryUsage::memoryUsed |
percentMemoryUsage |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Percentage of memory usage; value = (memoryUsed / (memoryUsed + memoryFree) x 100 if denomintor is nonzero, or 0, if otherwise. |
Ves::ObjectClasses::MemoryUsage::percentMemoryUsage |
vmIdentifier |
String |
1 |
Preliminary OpenModelAttribute
|
Virtual Machine identifier associated with the memory metrics |
Ves::ObjectClasses::MemoryUsage::vmIdentifier |
MesResultNumber
The measResultNumber datatype provides a number 3GPP PM measurement result
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
p |
Integer |
1 |
Preliminary OpenModelAttribute
|
Integer reference to the counter |
Ves::ObjectClasses::MesResultNumber::p |
rValue |
Number |
1 |
Preliminary OpenModelAttribute
|
Number counter value |
Ves::ObjectClasses::MesResultNumber::rValue |
MobileFlow
Fields specific to mobility flow events
Parent class: VesEvent
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
additionalFields |
HashMap |
0..1 |
Preliminary OpenModelAttribute
|
additionalFields - Additional mobileFlow fields if needed. |
Ves::ObjectClasses::MobileFlow::additionalFields |
applicationType |
String |
0..1 |
Preliminary OpenModelAttribute
|
applicationType - Application type inferred |
Ves::ObjectClasses::MobileFlow::applicationType |
applProtocolType |
String |
0..1 |
Preliminary OpenModelAttribute
|
applProtocolType - Application protocol. |
Ves::ObjectClasses::MobileFlow::applProtocolType |
applProtocolVersion |
String |
0..1 |
Preliminary OpenModelAttribute
|
applProtocolVersion - Application version. |
Ves::ObjectClasses::MobileFlow::applProtocolVersion |
cid |
String |
0..1 |
Preliminary OpenModelAttribute
|
cid - Cell Id. |
Ves::ObjectClasses::MobileFlow::cid |
connectionType |
String |
0..1 |
Preliminary OpenModelAttribute
|
connectionType - Abbreviation referencing a 3GPP reference point e.g., S1-U, S11, etc. |
Ves::ObjectClasses::MobileFlow::connectionType |
ecgi |
String |
0..1 |
Preliminary OpenModelAttribute
|
ecgi - Evolved Cell Global Id. |
Ves::ObjectClasses::MobileFlow::ecgi |
flowDirection |
String |
0..1 |
Preliminary OpenModelAttribute
|
flowDirection - Flow direction, indicating if the reporting node is the source of the flow or destination for the flow. |
Ves::ObjectClasses::MobileFlow::flowDirection |
gtpProtocolType |
String |
0..1 |
Preliminary OpenModelAttribute
|
gtpProtocolType - GTP protocol |
Ves::ObjectClasses::MobileFlow::gtpProtocolType |
gtpVersion |
String |
0..1 |
Preliminary OpenModelAttribute
|
gtpVersion - GTP protocol version. |
Ves::ObjectClasses::MobileFlow::gtpVersion |
httpHeader |
String |
0..1 |
Preliminary OpenModelAttribute
|
httpHeader - HTTP request header, if the flow connects to a node referenced by HTTP. |
Ves::ObjectClasses::MobileFlow::httpHeader |
iemi |
String |
0..1 |
Preliminary OpenModelAttribute
|
imei - IMEI for the subscriber UE used in this flow, if the flow connects to a mobile device. |
Ves::ObjectClasses::MobileFlow::iemi |
imsi |
String |
0..1 |
Preliminary OpenModelAttribute
|
imsi - IMSI for the subscriber UE used in this flow, if the flow connects to a mobile device |
Ves::ObjectClasses::MobileFlow::imsi |
ipProtocolType |
String |
0..1 |
Preliminary OpenModelAttribute
|
ipProtocolType - IP protocol type e.g., TCP, UDP, RTP… |
Ves::ObjectClasses::MobileFlow::ipProtocolType |
ipVersion |
String |
0..1 |
Preliminary OpenModelAttribute
|
ipVersion - IP protocol version e.g., IPv4, IPv6 |
Ves::ObjectClasses::MobileFlow::ipVersion |
lac |
String |
0..1 |
Preliminary OpenModelAttribute
|
lac - Location area code. |
Ves::ObjectClasses::MobileFlow::lac |
mcc |
String |
0..1 |
Preliminary OpenModelAttribute
|
mcc - Mobile country code. |
Ves::ObjectClasses::MobileFlow::mcc |
mnc |
String |
0..1 |
Preliminary OpenModelAttribute
|
mnc - Mobile network code. |
Ves::ObjectClasses::MobileFlow::mnc |
mobileFlowFieldsVersion |
Number |
0..1 |
Preliminary OpenModelAttribute
|
mobileFlowFieldsVersion - Version of the mobileFlowFields block. |
Ves::ObjectClasses::MobileFlow::mobileFlowFieldsVersion |
msisdn |
String |
0..1 |
Preliminary OpenModelAttribute
|
msisdn - MSISDN for the subscriber UE used in this flow, as an integer, if the flow connects to a mobile device. |
Ves::ObjectClasses::MobileFlow::msisdn |
otherEndpointlpAddress |
String |
0..1 |
Preliminary OpenModelAttribute
|
otherEndpointIpAddress - IP address for the other endpoint, as used for the flow being reported on. Note: current data type (String) may be changed to Common Resource Datatype L3AddressData. =[gh]= |
Ves::ObjectClasses::MobileFlow::otherEndpointlpAddress |
otherEndpointPort |
Number |
0..1 |
Preliminary OpenModelAttribute
|
otherEndpointPort - IP Port for the reporting entity, as used for the flow being reported on |
Ves::ObjectClasses::MobileFlow::otherEndpointPort |
otherFunctionalRole |
String |
0..1 |
Preliminary OpenModelAttribute
|
otherFunctionalRole - Functional role of the other endpoint for the flow being reported on e.g., MME, S-GW, P-GW, PCRF… |
Ves::ObjectClasses::MobileFlow::otherFunctionalRole |
rac |
String |
0..1 |
Preliminary OpenModelAttribute
|
rac - Routing area code |
Ves::ObjectClasses::MobileFlow::rac |
radioAccessTechnology |
String |
0..1 |
Preliminary OpenModelAttribute
|
radioAccessTechnology - Radio Access Technology e.g., 2G, 3G, 4G and 5G. (GSM, UMTS, LTE, 5G) |
Ves::ObjectClasses::MobileFlow::radioAccessTechnology |
reportingEndpointlpAddr |
String |
0..1 |
Preliminary OpenModelAttribute
|
reportingEndpointIpAddr - IP address for the reporting entity, as used for the flow being reported on. Note: current data type (String) may be changed to Common Resource Datatype L3AddressData. =[gh]= |
Ves::ObjectClasses::MobileFlow::reportingEndpointlpAddr |
reportingEndpointPort |
Number |
0..1 |
Preliminary OpenModelAttribute
|
reportingEndpointPort - IP port for the reporting entity, as used for the flow being reported on. |
Ves::ObjectClasses::MobileFlow::reportingEndpointPort |
sac |
String |
0..1 |
Preliminary OpenModelAttribute
|
sac - Service area code |
Ves::ObjectClasses::MobileFlow::sac |
samplingAlgorithm |
Number |
0..1 |
Preliminary OpenModelAttribute
|
samplingAlgorithm - Integer identifier for the sampling algorithm or rule being applied in calculating the flow metrics if metrics are calculated based on a sample of packets, or 0 if no sampling is applied. |
Ves::ObjectClasses::MobileFlow::samplingAlgorithm |
tac |
String |
0..1 |
Preliminary OpenModelAttribute
|
tac - Transport area code |
Ves::ObjectClasses::MobileFlow::tac |
tunnelId |
String |
0..1 |
Preliminary OpenModelAttribute
|
tunnelId - Tunnel identifier |
Ves::ObjectClasses::MobileFlow::tunnelId |
vlanId |
String |
0..1 |
Preliminary OpenModelAttribute
|
vlanId - VLAN identifier used by this flow |
Ves::ObjectClasses::MobileFlow::vlanId |
_gtpperflowmetrics |
GtpPerFlowMetrics |
1 |
Preliminary OpenModelAttribute
|
Mobility GTP Protocol per flow metrics |
Ves::ObjectClasses::MobileFlow::_gtpperflowmetrics |
domain |
Domain |
1 |
Experimental OpenModelAttribute
|
Update in definition only Event domain enumeration: ‘cmNotify’,’fault’, ‘heartbeat’, ‘measurement’, ‘mobileFlow’, ‘notification’, ‘other’, ‘pnfRegistration’, ‘sipSignaling’, ‘stateChange’, ‘syslog’, ‘thresholdCrossingAlert’, ‘voiceQuality’ |
Ves::ObjectClasses::VesEvent::domain |
eventType |
String |
0..1 |
Preliminary OpenModelAttribute
|
For example: ‘applicationNf’, ‘guestOS’, ‘hostOS’, ‘platform’ |
Ves::ObjectClasses::VesEvent::eventType |
lastEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
the latest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds |
Ves::ObjectClasses::VesEvent::lastEpochMicrosec |
nfcNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function component type: 3 characters (aligned with vfc naming standards) |
Ves::ObjectClasses::VesEvent::nfcNamingCode |
nfNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function type: 4 characters (aligned with vnf and pnf naming standards) |
Ves::ObjectClasses::VesEvent::nfNamingCode |
nfVendorName |
String |
1 |
Preliminary OpenModelAttribute
|
Network function vendor name |
Ves::ObjectClasses::VesEvent::nfVendorName |
priority |
Priority |
1 |
Preliminary OpenModelAttribute
|
Processing priority enumeration: ‘High’, ‘Medium’, ‘Normal’, ‘Low’ |
Ves::ObjectClasses::VesEvent::priority |
reportingEntityId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See ‘reportingEntityName’ for more information. reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. |
Ves::ObjectClasses::VesEvent::reportingEntityId |
reportingEntityName |
String |
1 |
Preliminary OpenModelAttribute
|
reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. |
Ves::ObjectClasses::VesEvent::reportingEntityName |
sequence |
Integer |
1 |
Preliminary OpenModelAttribute
|
sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ordering of events communicated by an event source instance (or 0 if not needed) |
Ves::ObjectClasses::VesEvent::sequence |
sourceId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See ‘sourceName’ for more information. sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. |
Ves::ObjectClasses::VesEvent::sourceId |
sourceName |
String |
1 |
Preliminary OpenModelAttribute
|
Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. |
Ves::ObjectClasses::VesEvent::sourceName |
startingEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) |
Ves::ObjectClasses::VesEvent::startingEpochMicrosec |
timeZoneOffset |
String |
0..1 |
Preliminary OpenModelAttribute
|
Offset to GMT to indicate local time zone for device formatted as ‘UTC+/-hh:mm’; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples |
Ves::ObjectClasses::VesEvent::timeZoneOffset |
version |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the event header as “#.#” where # is a digit; see section 1 for the correct digits to use. |
Ves::ObjectClasses::VesEvent::version |
vesEventListenerVersion |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the ves event listener api spec that this event is compliant with (as “#” or “#.#” or “#.#.#” where # is a digit; see section 1 for the correct digits to use). |
Ves::ObjectClasses::VesEvent::vesEventListenerVersion |
name |
String |
1 |
Preliminary OpenModelAttribute
|
Ves::ObjectClasses::VesEvent::name |
|
Status |
String |
0..1 |
Preliminary OpenModelAttribute
|
The current condition of an interaction, such as open, in research, closed, and so forth |
Common::Business Interaction::ObjectClasses::BusinessInteraction::Status |
description |
String |
0..1 |
Preliminary OpenModelAttribute
|
Defines a textual free-form description of the object. |
Common::Root::RootObjectClasses::RootEntity::description |
id |
Identifier |
1 |
Preliminary OpenModelAttribute
|
Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. |
Common::Root::RootObjectClasses::RootEntity::id |
NicPerformance
The nicPerformance datatype consists of the following fields which describe the performance and errors of an of an identified virtual network interface card
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
administrativeState |
NicAdminState |
0..1 |
Preliminary OpenModelAttribute
|
Administrative state: enum: ‘inService’, ‘outOfService’ |
Ves::ObjectClasses::NicPerformance::administrativeState |
nicIdentifier |
String |
1 |
Preliminary OpenModelAttribute
|
Network interface card identifier |
Ves::ObjectClasses::NicPerformance::nicIdentifier |
operationalState |
NicOpsState |
0..1 |
Preliminary OpenModelAttribute
|
Operational state: enum: ‘inService’, ‘outOfService’ |
Ves::ObjectClasses::NicPerformance::operationalState |
receivedBroadcastPacketsAccumulated |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Cumulative count of broadcast packets received as read at the end of the measurement interval |
Ves::ObjectClasses::NicPerformance::receivedBroadcastPacketsAccumulated |
receivedBroadcastPacketsDelta |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Count of broadcast packets received within the measurement interval |
Ves::ObjectClasses::NicPerformance::receivedBroadcastPacketsDelta |
receivedDiscardedPacketsAccumulated |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Cumulative count of discarded packets received as read at the end of the measurement interval |
Ves::ObjectClasses::NicPerformance::receivedDiscardedPacketsAccumulated |
receivedDiscardedPacketsDelta |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Count of discarded packets received within the measurement interval |
Ves::ObjectClasses::NicPerformance::receivedDiscardedPacketsDelta |
receivedErrorPacketsAccumulated |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Cumulative count of error packets received as read at the end of the measurement interval |
Ves::ObjectClasses::NicPerformance::receivedErrorPacketsAccumulated |
receivedErrorPacketsDelta |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Count of error packets received within the measurement interval |
Ves::ObjectClasses::NicPerformance::receivedErrorPacketsDelta |
receivedMulticastPacketsAccumulated |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Cumulative count of multicast packets received as read at the end of the measurement interval |
Ves::ObjectClasses::NicPerformance::receivedMulticastPacketsAccumulated |
receivedMulticastPacketsDelta |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Count of multicast packets received within the measurement interval |
Ves::ObjectClasses::NicPerformance::receivedMulticastPacketsDelta |
receivedOctetsAccumulated |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Cumulative count of octets received as read at the end of the measurement interval |
Ves::ObjectClasses::NicPerformance::receivedOctetsAccumulated |
receivedOctetsDelta |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Count of octets received within the measurement interval |
Ves::ObjectClasses::NicPerformance::receivedOctetsDelta |
receivedPercentDiscard |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Percentage of discarded packets received; value = (receivedDiscardedPacketsDelta / receivedTotalPacketsDelta) x 100, if denominator is nonzero, or 0, if otherwise. |
Ves::ObjectClasses::NicPerformance::receivedPercentDiscard |
receivedPercentError |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Percentage of error packets received; value = (receivedErrorPacketsDelta / receivedTotalPacketsDelta) x 100, if denominator is nonzero, or 0, if otherwise. |
Ves::ObjectClasses::NicPerformance::receivedPercentError |
receivedTotalPacketsAccumulated |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Cumulative count of all packets received as read at the end of the measurement interval |
Ves::ObjectClasses::NicPerformance::receivedTotalPacketsAccumulated |
receivedTotalPacketsDelta |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Count of all packets received within the measurement interval |
Ves::ObjectClasses::NicPerformance::receivedTotalPacketsDelta |
receivedUnicastPacketsAccumulated |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Cumulative count of unicast packets received as read at the end of the measurement interval |
Ves::ObjectClasses::NicPerformance::receivedUnicastPacketsAccumulated |
receivedUnicastPacketsDelta |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Count of unicast packets received within the measurement interval |
Ves::ObjectClasses::NicPerformance::receivedUnicastPacketsDelta |
receivedUtilization |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Percentage of utilization received; value = (receivedOctetsDelta / (speed x (lastEpochMicrosec - startEpochMicrosec))) x 100, if denominator is nonzero, or 0, if otherwise. |
Ves::ObjectClasses::NicPerformance::receivedUtilization |
speed |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Speed configured in mbps. |
Ves::ObjectClasses::NicPerformance::speed |
transmittedBroadcastPacketsAccumulated |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Cumulative count of broadcast packets transmitted as read at the end of the measurement interval |
Ves::ObjectClasses::NicPerformance::transmittedBroadcastPacketsAccumulated |
transmittedBroadcastPacketsDelta |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Count of broadcast packets transmitted within the measurement interval |
Ves::ObjectClasses::NicPerformance::transmittedBroadcastPacketsDelta |
transmittedDiscardedPacketsAccumulated |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Cumulative count of discarded packets transmitted as read at the end of the measurement interval |
Ves::ObjectClasses::NicPerformance::transmittedDiscardedPacketsAccumulated |
transmittedDiscardedPacketsDelta |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Count of discarded packets transmitted within the measurement interval |
Ves::ObjectClasses::NicPerformance::transmittedDiscardedPacketsDelta |
transmittedErrorPacketsAccumulated |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Cumulative count of error packets transmitted as read at the end of the measurement interval |
Ves::ObjectClasses::NicPerformance::transmittedErrorPacketsAccumulated |
transmittedErrorPacketsDelta |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Count of error packets transmitted within the measurement interval |
Ves::ObjectClasses::NicPerformance::transmittedErrorPacketsDelta |
transmittedMulticastPacketsAccumulated |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Cumulative count of multicast packets transmitted as read at the end of the measurement interval |
Ves::ObjectClasses::NicPerformance::transmittedMulticastPacketsAccumulated |
transmittedMulticastPacketsDelta |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Count of multicast packets transmitted within the measurement interval |
Ves::ObjectClasses::NicPerformance::transmittedMulticastPacketsDelta |
transmittedOctetsAccumulated |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Cumulative count of octets transmitted as read at the end of the measurement interval |
Ves::ObjectClasses::NicPerformance::transmittedOctetsAccumulated |
transmittedOctetsDelta |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Count of octets transmitted within the measurement interval |
Ves::ObjectClasses::NicPerformance::transmittedOctetsDelta |
transmittedPercentDiscard |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Percentage of discarded packets transmitted; value = (transmittedDiscardedPacketsDelta / transmittedTotalPacketsDelta) x 100, if denominator is nonzero, or 0, if otherwise. |
Ves::ObjectClasses::NicPerformance::transmittedPercentDiscard |
transmittedPercentError |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Percentage of error packets received; value = (transmittedErrorPacketsDelta / transmittedTotalPacketsDelta) x 100, if denominator is nonzero, or 0, if otherwise. |
Ves::ObjectClasses::NicPerformance::transmittedPercentError |
transmittedTotalPacketsAccumulated |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Cumulative count of all packets transmitted as read at the end of the measurement interval |
Ves::ObjectClasses::NicPerformance::transmittedTotalPacketsAccumulated |
transmittedTotalPacketsDelta |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Count of all packets transmitted within the measurement interval |
Ves::ObjectClasses::NicPerformance::transmittedTotalPacketsDelta |
transmittedUnicastPacketsAccumulated |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Cumulative count of unicast packets transmitted as read at the end of the measurement interval |
Ves::ObjectClasses::NicPerformance::transmittedUnicastPacketsAccumulated |
transmittedUnicastPacketsDelta |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Count of unicast packets transmitted within the measurement interval |
Ves::ObjectClasses::NicPerformance::transmittedUnicastPacketsDelta |
transmittedUtilization |
Number |
0..1 |
Preliminary OpenModelAttribute
|
Percentage of utilization transmitted; value = (transmittedOctetsDelta / (speed x (lastEpochMicrosec - startEpochMicrosec))) x 100, if denominator is nonzero, or 0, if otherwise. |
Ves::ObjectClasses::NicPerformance::transmittedUtilization |
valuesAreSuspect |
Boolean |
1 |
Preliminary OpenModelAttribute
|
Enumeration: ‘true’ or ‘false’. If ‘true’ then the vNicPerformance values are likely inaccurate due to counter overflow or other conditions. |
Ves::ObjectClasses::NicPerformance::valuesAreSuspect |