Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

1.1.1                                 Event - High Level


Image RemovedImage Added


1.1.2                                 Event Datatypes


Image RemovedImage Added


1.1.3                                 Measurement Domain Entities

...

Attribute Name

Type

Mult.

Stereotypes

Description

alarmAdditionalInformation

HashMap

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.



alarmCondition

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Short name of the alarm condition/problem, such as a trap name. Should not have white space (e.g., tpLgCgiNotInConfig, BfdSessionDown, linkDown, etc…)



alarmInterfaceA

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Card, port, channel or interface name of the device generating the alarm. This could reflect managed object.



eventCatagory

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Event category, for example: 'license', 'link', 'routing', 'security', 'signaling'



eventSeverity

EventSeverity

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Event severity enumeration: 'CRITICAL', 'MAJOR', 'MINOR', 'WARNING', 'NORMAL'. NORMAL is used to represent clear.



eventSourceType

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Examples: 'card', 'host', 'other', 'port', 'portThreshold', 'router', 'slotThreshold', 'switch', 'virtualMachine', 'virtualNetworkFunction'. This could be managed object class.



faultFieldsVersion

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Version of the faultFields block as "#.#" where # is a digit; see section 1 for the correct digits to use.



specificProblem

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.



vfStatus

VfStatus

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Virtual function status enumeration: 'Active', 'Idle', 'Preparing to terminate', 'Ready to terminate', 'Requesting Termination'



domain

Domain

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Event domain enumeration: 'fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'stndDefined', 'syslog', 'thresholdCrossingAlert', 'voiceQuality'



eventType

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

For example: 'applicationNf', 'guestOS', 'hostOS', 'platform'



lastEpochMicrosec

Number

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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



nfcNamingCode

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Network function component type: 3 characters (aligned with vfc naming standards)



nfNamingCode

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Network function type: 4 characters (aligned with vnf and pnf naming standards)



nfVendorName

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Network function vendor name



priority

Priority

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low'



reportingEntityId

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.



reportingEntityName

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.

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.



sequence

Integer

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Ordering of events communicated by an event source instance (or 0 if not needed)

sequence - Ordering of events communicated by an event source instance (or 0 if not needed)



sourceId

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.

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.



sourceName

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.

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.



startingEpochMicrosec

Number

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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)



timeZoneOffset

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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



version

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use.



vesEventListenerVersion

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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).



name

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY



Status

String

0..1

Experimental

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

The current condition of an interaction, such as open, in research, closed, and so forth



description

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Defines a textual free-form description of the object.



id

Identifier

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Unambiguously distinguishes different object instances. It is the naming attribute of the object.

Identifier of this information element.   This attribute shall be globally unique.



...

Attribute Name

Type

Mult.

Stereotypes

Description

additionalFields

HashMap

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Additional expansion fields if needed.



heartbeatFieldVersion

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Version of the heartbeatFields block as "#.#" where # is a digit; see section 1 for the correct digits to use.



heartbeatInterval

Integer

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Current heartbeatInterval in seconds.



domain

Domain

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Event domain enumeration: 'fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'stndDefined', 'syslog', 'thresholdCrossingAlert', 'voiceQuality'



eventType

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

For example: 'applicationNf', 'guestOS', 'hostOS', 'platform'



lastEpochMicrosec

Number

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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



nfcNamingCode

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Network function component type: 3 characters (aligned with vfc naming standards)



nfNamingCode

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Network function type: 4 characters (aligned with vnf and pnf naming standards)



nfVendorName

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Network function vendor name



priority

Priority

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low'



reportingEntityId

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.



reportingEntityName

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.

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.



sequence

Integer

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Ordering of events communicated by an event source instance (or 0 if not needed)

sequence - Ordering of events communicated by an event source instance (or 0 if not needed)



sourceId

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.

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.



sourceName

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.

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.



startingEpochMicrosec

Number

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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)



timeZoneOffset

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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



version

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use.



vesEventListenerVersion

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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).



name

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY



Status

String

0..1

Experimental

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

The current condition of an interaction, such as open, in research, closed, and so forth



description

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Defines a textual free-form description of the object.



id

Identifier

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Unambiguously distinguishes different object instances. It is the naming attribute of the object.

Identifier of this information element.   This attribute shall be globally unique.



...

Attribute Name

Type

Mult.

Stereotypes

Description

additionalFields

HashMap

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Additional measurement fields if needed.



additionalMeasurements

ArrayofNamedHashMap

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Array of named hashMap if needed.



additionalObjects

ArrayOfSchemaObject

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Array of Schema objects described by name, schema and other meta-information, if needed.



concurrentSessions

Integer

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Peak concurrent sessions for the VM or VNF (depending on the context) over the measurementInterval.



configuredEntities

Integer

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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



featureUsageArray

HashMap

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

The hashMap key should identify the feature, while the value defines the number of times the identified feature was used.



meanRequestLatency

Number

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Mean seconds required to respond to each request for the VM on which the VNFC reporting the event is running.



measurementFieldsVersion

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Version of the measurementFields block as "#.#" where # is a digit; see section 1 for the correct digits to use.



measurementInterval

Number

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Interval over which measurements are being reported in seconds



nfcScalingMetric

Integer

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Represents busy-ness of the network function from 0 to 100 as reported by the nfc.



numberOfMediaPortsInUse

Integer

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Number of media ports in use.



requestRate

Number

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Peak request rate per second, for the VM over the measurementInterval



_Hugepages

HugePages

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Array of metrics on hugePages



_codecsinuse

CodecsInUse

0..*

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Array of codecs in use



_cpuUsage

CpuUsage

0..*

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Usage of an array of CPUs



_diskUsage

DiskUsage

0..*

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Usage of an array of disks



_filesystemusage

FilesystemUsage

0..*

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Filesystem usage of the VM on which the xNFC reporting the event is running



_ipmi

Ipmi

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Array of intelligent platform management interface metrics



_latencybucketmeasure

LatencyBucketMeasure

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.



_load

Load

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Array of system load metrics



_machinecheckexception

MachineCheckException

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Array of machine check exceptions



_memoryusage

MemoryUsage

0..*

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Memory usage of an array of VMs



_nicperformance

NicPerformance

0..*

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Performance metrics of an array of network interface cards



_processstats

ProcessStats

0..*

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Array of metrics on system processes



domain

Domain

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Event domain enumeration: 'fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'stndDefined', 'syslog', 'thresholdCrossingAlert', 'voiceQuality'



eventType

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

For example: 'applicationNf', 'guestOS', 'hostOS', 'platform'



lastEpochMicrosec

Number

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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



nfcNamingCode

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Network function component type: 3 characters (aligned with vfc naming standards)



nfNamingCode

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Network function type: 4 characters (aligned with vnf and pnf naming standards)



nfVendorName

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Network function vendor name



priority

Priority

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low'



reportingEntityId

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.



reportingEntityName

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.

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.



sequence

Integer

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Ordering of events communicated by an event source instance (or 0 if not needed)

sequence - Ordering of events communicated by an event source instance (or 0 if not needed)



sourceId

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.

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.



sourceName

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.

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.



startingEpochMicrosec

Number

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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)



timeZoneOffset

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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



version

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use.



vesEventListenerVersion

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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).



name

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY



Status

String

0..1

Experimental

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

The current condition of an interaction, such as open, in research, closed, and so forth



description

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Defines a textual free-form description of the object.



id

Identifier

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Unambiguously distinguishes different object instances. It is the naming attribute of the object.

Identifier of this information element.   This attribute shall be globally unique.



...

Attribute Name

Type

Mult.

Stereotypes

Description

additionalFields

HashMap

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

additionalFields - Additional mobileFlow fields if needed.



applicationType

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

applicationType - Application type inferred



applProtocolType

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

applProtocolType - Application protocol.



applProtocolVersion

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

applProtocolVersion - Application version.



cid

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

cid - Cell Id.



connectionType

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

connectionType - Abbreviation referencing a 3GPP reference point e.g., S1-U, S11, etc.



ecgi

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

ecgi - Evolved Cell Global Id.



flowDirection

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

flowDirection - Flow direction, indicating if the reporting node is the source of the flow or destination for the flow.



gtpProtocolType

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

gtpProtocolType - GTP protocol



gtpVersion

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

gtpVersion - GTP protocol version.



httpHeader

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

httpHeader - HTTP request header, if the flow connects to a node referenced by HTTP.



iemi

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

imei - IMEI for the subscriber UE used in this flow, if the flow connects to a mobile device.



imsi

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

imsi - IMSI for the subscriber UE used in this flow, if the flow connects to a mobile device



ipProtocolType

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

ipProtocolType - IP protocol type e.g., TCP, UDP, RTP...



ipVersion

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

ipVersion - IP protocol version e.g., IPv4, IPv6



lac

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

lac - Location area code.



mcc

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

mcc - Mobile country code.



mnc

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

mnc - Mobile network code.



mobileFlowFieldsVersion

Number

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

mobileFlowFieldsVersion - Version of the mobileFlowFields block.



msisdn

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

msisdn - MSISDN for the subscriber UE used in this flow, as an integer, if the flow connects to a mobile device.



otherEndpointlpAddress

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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]=



otherEndpointPort

Number

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

otherEndpointPort - IP Port for the reporting entity, as used for the flow being reported on



otherFunctionalRole

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

otherFunctionalRole - Functional role of the other endpoint for the flow being reported on e.g., MME, S-GW, P-GW, PCRF...



rac

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

rac - Routing area code



radioAccessTechnology

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

radioAccessTechnology - Radio Access Technology e.g., 2G, 3G, 4G and 5G. (GSM, UMTS, LTE, 5G)



reportingEndpointlpAddr

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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]=



reportingEndpointPort

Number

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

reportingEndpointPort - IP port for the reporting entity, as used for the flow being reported on.



sac

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

sac - Service area code



samplingAlgorithm

Number

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.



tac

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

tac - Transport area code



tunnelId

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

tunnelId - Tunnel identifier



vlanId

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

vlanId - VLAN identifier used by this flow



_gtpperflowmetrics

GtpPerFlowMetrics

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Mobility GTP Protocol per flow metrics



domain

Domain

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Event domain enumeration: 'fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'stndDefined', 'syslog', 'thresholdCrossingAlert', 'voiceQuality'



eventType

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

For example: 'applicationNf', 'guestOS', 'hostOS', 'platform'



lastEpochMicrosec

Number

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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



nfcNamingCode

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Network function component type: 3 characters (aligned with vfc naming standards)



nfNamingCode

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Network function type: 4 characters (aligned with vnf and pnf naming standards)



nfVendorName

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Network function vendor name



priority

Priority

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low'



reportingEntityId

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.



reportingEntityName

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.

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.



sequence

Integer

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Ordering of events communicated by an event source instance (or 0 if not needed)

sequence - Ordering of events communicated by an event source instance (or 0 if not needed)



sourceId

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.

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.



sourceName

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.

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.



startingEpochMicrosec

Number

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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)



timeZoneOffset

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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



version

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use.



vesEventListenerVersion

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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).



name

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY



Status

String

0..1

Experimental

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

The current condition of an interaction, such as open, in research, closed, and so forth



description

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Defines a textual free-form description of the object.



id

Identifier

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Unambiguously distinguishes different object instances. It is the naming attribute of the object.

Identifier of this information element.   This attribute shall be globally unique.



...

Attribute Name

Type

Mult.

Stereotypes

Description

additionalFields

HashMap

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Additional notification fields if needed.



arrayOfNamedHashMap

NamedHashMap

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

arrayOfNamedHashMap - Array of named hashMaps



changeContact

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Identifier for a contact related to the change.



changeIdentifier

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

System or session identifier associated with the change.



changeType

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Describes what has changed for the entity, for example: configuration changed, capability added, capability removed…



newState

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

New state of the entity, for example: 'inService', 'maintenance', 'outOfService'



notificationFieldsVersion

Number

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Version of the notificationFields block as "#.#" where # is a digit; see section 1 for the correct digits to use.



oldState

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Previous state of the entity. For example: "inService", "outOfService", "maintenance"



stateInterface

String

0..*

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Card or port name of the entity that changed state.



domain

Domain

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Event domain enumeration: 'fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'stndDefined', 'syslog', 'thresholdCrossingAlert', 'voiceQuality'



eventType

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

For example: 'applicationNf', 'guestOS', 'hostOS', 'platform'



lastEpochMicrosec

Number

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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



nfcNamingCode

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Network function component type: 3 characters (aligned with vfc naming standards)



nfNamingCode

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Network function type: 4 characters (aligned with vnf and pnf naming standards)



nfVendorName

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Network function vendor name



priority

Priority

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low'



reportingEntityId

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.



reportingEntityName

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.

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.



sequence

Integer

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Ordering of events communicated by an event source instance (or 0 if not needed)

sequence - Ordering of events communicated by an event source instance (or 0 if not needed)



sourceId

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.

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.



sourceName

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.

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.



startingEpochMicrosec

Number

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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)



timeZoneOffset

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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



version

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use.



vesEventListenerVersion

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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).



name

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY



Status

String

0..1

Experimental

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

The current condition of an interaction, such as open, in research, closed, and so forth



description

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Defines a textual free-form description of the object.



id

Identifier

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Unambiguously distinguishes different object instances. It is the naming attribute of the object.

Identifier of this information element.  This attribute shall be globally unique.



...

Attribute Name

Type

Mult.

Stereotypes

Description

arrayofNamedHashMap

ArrayofNamedHashMap

0..*

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Array of named hashMaps



hashMap

HashMap

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Array of name-value pairs.



schemaObjects

ArrayOfSchemaObject

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Array of schema objects described by name, schema and other meta-information.



otherFieldsVersion

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Version of the otherFields block as "#.#" where # is a digit; see section 1 for the correct digits to use.



domain

Domain

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Event domain enumeration: 'fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'stndDefined', 'syslog', 'thresholdCrossingAlert', 'voiceQuality'



eventType

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

For example: 'applicationNf', 'guestOS', 'hostOS', 'platform'



lastEpochMicrosec

Number

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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



nfcNamingCode

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Network function component type: 3 characters (aligned with vfc naming standards)



nfNamingCode

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Network function type: 4 characters (aligned with vnf and pnf naming standards)



nfVendorName

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Network function vendor name



priority

Priority

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low'



reportingEntityId

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.



reportingEntityName

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.

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.



sequence

Integer

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Ordering of events communicated by an event source instance (or 0 if not needed)

sequence - Ordering of events communicated by an event source instance (or 0 if not needed)



sourceId

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.

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.



sourceName

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.

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.



startingEpochMicrosec

Number

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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)



timeZoneOffset

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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



version

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use.



vesEventListenerVersion

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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).



name

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY



Status

String

0..1

Experimental

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

The current condition of an interaction, such as open, in research, closed, and so forth



description

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Defines a textual free-form description of the object.



id

Identifier

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Unambiguously distinguishes different object instances. It is the naming attribute of the object.

Identifier of this information element.   This attribute shall be globally unique.



...

Attribute Name

Type

Mult.

Stereotypes

Description

eventAddlFields

HashMap

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Additional key-value pairs if needed



perf3gppFieldsVersion

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Version of the perf3gpp event



_measDataCollection

MeasDataCollection

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

3GPP measurement collection structure



domain

Domain

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Event domain enumeration: 'fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'stndDefined', 'syslog', 'thresholdCrossingAlert', 'voiceQuality'



eventType

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

For example: 'applicationNf', 'guestOS', 'hostOS', 'platform'



lastEpochMicrosec

Number

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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



nfcNamingCode

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Network function component type: 3 characters (aligned with vfc naming standards)



nfNamingCode

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Network function type: 4 characters (aligned with vnf and pnf naming standards)



nfVendorName

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Network function vendor name



priority

Priority

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low'



reportingEntityId

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.



reportingEntityName

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.

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.



sequence

Integer

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Ordering of events communicated by an event source instance (or 0 if not needed)

sequence - Ordering of events communicated by an event source instance (or 0 if not needed)



sourceId

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.

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.



sourceName

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.

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.



startingEpochMicrosec

Number

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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)



timeZoneOffset

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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



version

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use.



vesEventListenerVersion

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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).



name

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY



Status

String

0..1

Experimental

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

The current condition of an interaction, such as open, in research, closed, and so forth



description

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Defines a textual free-form description of the object.



id

Identifier

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Unambiguously distinguishes different object instances. It is the naming attribute of the object.

Identifier of this information element.   This attribute shall be globally unique.



...

Attribute Name

Type

Mult.

Stereotypes

Description

additionalFields

HashMap

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Additional pnfRegistration fields if needed



lastServiceDate

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

TS 32.692 dateOfLastService = date of last service; e.g. 15022017



macAddress

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

MAC address of OAM interface of the unit



manufactureDate

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

TS 32.692 dateOfManufacture = manufacture date of the unit; 24032016



modelNumber

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

TS 32.692 versionNumber = version of the unit from vendor; e.g. AJ02. Maps to AAI equip-model



oamV4lpAddress

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

IPv4 m-plane IP address to be used by the manager to contact the PNF



oamV6lpAddress

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

IPv6 m-plane IP address to be used by the manager to contact the PNF



pnfRegistrationFieldsVersion

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Version of the registrationFields block as "#.#" where # is a digit; see section 1 for the correct digits to use.



serialNumber

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

TS 32.692 serialNumber = serial number of the unit; e.g. 6061ZW3



softwareVersion

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

TS 32.692 swName = active SW running on the unit; e.g. 5gDUv18.05.201



unitFamily

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

TS 32.692 vendorUnitFamilyType = general type of HW unit; e.g. BBU



unitType

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

TS 32.692 vendorUnitTypeNumber = vendor name for the unit; e.g. Airscale



vendorName

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

TS 32.692 vendorName = name of manufacturer; e.g. Nokia. Maps to AAI equip-vendor



domain

Domain

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Event domain enumeration: 'fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'stndDefined', 'syslog', 'thresholdCrossingAlert', 'voiceQuality'



eventType

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

For example: 'applicationNf', 'guestOS', 'hostOS', 'platform'



lastEpochMicrosec

Number

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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



nfcNamingCode

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Network function component type: 3 characters (aligned with vfc naming standards)



nfNamingCode

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Network function type: 4 characters (aligned with vnf and pnf naming standards)



nfVendorName

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Network function vendor name



priority

Priority

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low'



reportingEntityId

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.



reportingEntityName

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.

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.



sequence

Integer

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Ordering of events communicated by an event source instance (or 0 if not needed)

sequence - Ordering of events communicated by an event source instance (or 0 if not needed)



sourceId

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.

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.



sourceName

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.

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.



startingEpochMicrosec

Number

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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)



timeZoneOffset

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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



version

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use.



vesEventListenerVersion

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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).



name

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY



Status

String

0..1

Experimental

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

The current condition of an interaction, such as open, in research, closed, and so forth



description

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Defines a textual free-form description of the object.



id

Identifier

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Unambiguously distinguishes different object instances. It is the naming attribute of the object.

Identifier of this information element.   This attribute shall be globally unique.



...

Attribute Name

Type

Mult.

Stereotypes

Description

additionalInformation

HashMap

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

zdditionalInformation - Additional sipSignalling fields.



compressedSip

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

compressedSip - The full SIP request/response including headers and bodies.



correlator

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

correlator - Constant across all events on this call.



localipAddress

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

localIpAddress - IP address on VNF. Note: current data type (String) may be changed to Common Resource Datatype L3AddressData. =[gh]=



localPort

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

localPort - Port on VNF.



remoteipAddress

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

remoteIpAddress - IP address of peer endpoint. Note: current data type (String) may be changed to Common Resource Datatype L3AddressData. =[gh]=



remotePort

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

remotePort - Port of peer endpoint



sipSignaliingFieldsVersion

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

sipSignalingFieldsVersion - Version of the sipSignalingFields block as "#.#" where # is a digit; see section 1 for the correct digits to use.



summarySip

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

summarySip - The SIP Method or Response ('INVITE', '200 OK', 'BYE', etc).



_vendorNfnamefields

VendorNfNameFields

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Vendor, NF and nfModule names



domain

Domain

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Event domain enumeration: 'fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'stndDefined', 'syslog', 'thresholdCrossingAlert', 'voiceQuality'



eventType

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

For example: 'applicationNf', 'guestOS', 'hostOS', 'platform'



lastEpochMicrosec

Number

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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



nfcNamingCode

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Network function component type: 3 characters (aligned with vfc naming standards)



nfNamingCode

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Network function type: 4 characters (aligned with vnf and pnf naming standards)



nfVendorName

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Network function vendor name



priority

Priority

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low'



reportingEntityId

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.



reportingEntityName

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.

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.



sequence

Integer

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Ordering of events communicated by an event source instance (or 0 if not needed)

sequence - Ordering of events communicated by an event source instance (or 0 if not needed)



sourceId

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.

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.



sourceName

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.

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.



startingEpochMicrosec

Number

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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)



timeZoneOffset

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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



version

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use.



vesEventListenerVersion

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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).



name

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY



Status

String

0..1

Experimental

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

The current condition of an interaction, such as open, in research, closed, and so forth



description

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Defines a textual free-form description of the object.



id

Identifier

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Unambiguously distinguishes different object instances. It is the naming attribute of the object.

Identifier of this information element.   This attribute shall be globally unique.



...

Attribute Name

Type

Mult.

Stereotypes

Description

additionalFields

HashMap

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Additional stateChange fields if needed



newState

invalid

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

New state of the entity: 'inService', 'maintenance', 'outOfService'



OldState

invalid

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Previous state of the entity: 'inService', 'maintenance', 'outOfService'



stateChangeFieldsVersion

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Version of the stateChangeFields block as "#.#" where # is a digit; see section 1 for the correct digits to use.



stateInterface

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Card or port name of the entity that changed state



domain

Domain

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Event domain enumeration: 'fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'stndDefined', 'syslog', 'thresholdCrossingAlert', 'voiceQuality'



eventType

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

For example: 'applicationNf', 'guestOS', 'hostOS', 'platform'



lastEpochMicrosec

Number

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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



nfcNamingCode

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Network function component type: 3 characters (aligned with vfc naming standards)



nfNamingCode

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Network function type: 4 characters (aligned with vnf and pnf naming standards)



nfVendorName

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Network function vendor name



priority

Priority

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low'



reportingEntityId

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.



reportingEntityName

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.

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.



sequence

Integer

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Ordering of events communicated by an event source instance (or 0 if not needed)

sequence - Ordering of events communicated by an event source instance (or 0 if not needed)



sourceId

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.

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.



sourceName

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.

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.



startingEpochMicrosec

Number

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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)



timeZoneOffset

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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



version

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use.



vesEventListenerVersion

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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).



name

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY



Status

String

0..1

Experimental

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

The current condition of an interaction, such as open, in research, closed, and so forth



description

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Defines a textual free-form description of the object.



id

Identifier

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Unambiguously distinguishes different object instances. It is the naming attribute of the object.

Identifier of this information element.   This attribute shall be globally unique.




1.2.

...

44                           StndDefined (New with R7 Release)

The stndDefined datatype defines fields for events belonging to the 'stndDefined' domain of the commonEventHeader domain enumeration; it consists of the following fields:Syslog's can be classified as either Control or Session/Traffic. They differ by message content and expected volume:   • Control logs are generally free-form human-readable text used for reporting errors or warnings supporting the operation and troubleshooting of NFs. The volume of these logs is typically less than 2k per day. • Session logs use common structured fields to report normal NF processing such as DNS lookups or firewall rules processed. The volume of these logs is typically greater than 1k per hour (and sometimes as high as 10k per second). VES supports both classes of syslog, however VES is only recommended for control logs or for lower volume session logs, less than 60k per hour. High volume session logging should use a file-based transport solution.

Parent class: VesEvent

Applied stereotypes:

  • OpenModelClass
    • support: MANDATORY
  • Preliminary


HashMap*

Attribute Name

Type

Mult.

Stereotypes

Description

additionalFields

stndDefined:: schemaReference

String

0..

1

Preliminary

OpenModelAttribute

·   isInvariant: true

·   valueRange:  no range constraint

·   support:
OPTIONAL

An uri of a standards-defined JSON object schema; used to valide the stndDefinedFields.data property contents



stndDefined::
data

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

A native standards-defined JSON notification



stndDefined:: stndDefinedFieldsVersion

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Version of the stndDefinedFields block as "#.#" where # is a digit; see section 1 for the correct digits to use.



VesEvent:: domain

Domain

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Event domain enumeration: 'fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'stndDefined', 'syslog', 'thresholdCrossingAlert', 'voiceQuality'



VesEvent:: eventType

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

For example: 'applicationNf', 'guestOS', 'hostOS', 'platform'



VesEvent:: lastEpochMicrosec

Number

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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



VesEvent:: nfcNamingCode

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Network function component type: 3 characters (aligned with vfc naming standards)



VesEvent:: nfNamingCode

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Network function type: 4 characters (aligned with vnf and pnf naming standards)



VesEvent:: nfVendorName

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Network function vendor name



VesEvent:: priority

Priority

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low'



VesEvent:: reportingEntityId

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.



VesEvent:: reportingEntityName

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.

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.



VesEvent:: sequence

Integer

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Ordering of events communicated by an event source instance (or 0 if not needed)

sequence - Ordering of events communicated by an event source instance (or 0 if not needed)



VesEvent:: sourceId

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.

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.



VesEvent:: sourceName

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.

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.



VesEvent:: startingEpochMicrosec

Number

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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)



VesEvent:: stndDefinedNamespaceString0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Standards organization defined event namespace; expected usage includes event routing by the event listener

VesEvent:: timeZoneOffset

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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



VesEvent:: version

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use.



VesEvent:: vesEventListenerVersion

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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).



VesEvent:: name

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY



VesEvent:: Status

String

0..1

Experimental

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

The current condition of an interaction, such as open, in research, closed, and so forth



VesEvent:: description

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Defines a textual free-form description of the object.



VesEvent:: id

Identifier

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Unambiguously distinguishes different object instances. It is the naming attribute of the object.

Identifier of this information element.   This attribute shall be globally unique.



1.2.45                           Syslog

Syslog's can be classified as either Control or Session/Traffic. They differ by message content and expected volume:   • Control logs are generally free-form human-readable text used for reporting errors or warnings supporting the operation and troubleshooting of NFs. The volume of these logs is typically less than 2k per day. • Session logs use common structured fields to report normal NF processing such as DNS lookups or firewall rules processed. The volume of these logs is typically greater than 1k per hour (and sometimes as high as 10k per second). VES supports both classes of syslog, however VES is only recommended for control logs or for lower volume session logs, less than 60k per hour. High volume session logging should use a file-based transport solution.

Parent class: VesEvent

Applied stereotypes:

  • OpenModelClass
    • support: MANDATORY
  • Preliminary


Attribute Name

Type

Mult.

Stereotypes

Description

additionalFields

HashMap

0..*

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Additional syslog fields if needed Ex:   {"name1": "value1", "name2: "value2" … }



eventSourceHost

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Hostname of the device



eventSourceType

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Examples: 'other', 'router', 'switch', 'host', 'card', 'port', 'slotThreshold', 'portThreshold', 'virtualMachine', 'virtualNetworkFunction'



syslogSdId

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

0-32 char in format name@number, i.e., ourSDID@32473



syslogFacilty

SyslogFacility

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Numeric code from 0 to 23 for facility:             0             kernel messages         1             user-level messages         2             mail system         3              system daemons         4             security/authorization messages         5             messages generated internally by syslogd         6             line printer subsystem         7             network news subsystem         8            UUCP subsystem         9             clock daemon         10             security/authorization messages         11             FTP daemon         12             NTP subsystem         13             log audit         14             log alert         15             clock daemon (note 2)         16             local use 0 (local0)         17             local use 1 (local1)         18             local use 2 (local2)         19             local use 3 (local3)         20             local use 4 (local4)         21             local use 5 (local5)         22             local use 6 (local6)         23             local use 7 (local7 )



syslogFieldVersion

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Version of the syslogFields block as "#.#" where # is a digit; see section 1 for the correct digits to use.



syslogMsg

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Syslog message



syslogMsgHost

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Hostname parsed from non-VES syslog message



syslogPri

Integer

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

0-192 Combined Severity and Facility (see rfc5424)



syslogProc

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Identifies the application that originated the message



syslogProcId

Number

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

The process number assigned by the OS when the application was started



syslogSData

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

A <space> separated list of key="value" pairs following the rfc5424 standard for SD-ELEMENT.   Deprecated The entire rfc5424 syslogSData object, including square brackets [ ], SD-ID and list of SD-PARAMs



syslogSev

SyslogSev

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Level-of-severity text enumeration defined below:   Text Sev Description Emergency 0 system is unusable Alert 1 action must be taken immediately Critical 2 critical conditions Error 3 error conditions Warning 4 warning conditions Notice 5 normal but significant condition Info 6 Informational messages Debug           7     debug-level messages



syslogTag

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Also known as MsgId. Brief non-spaced text indicating the type of message such as 'TCPOUT' or 'BGP_STATUS_CHANGE'; 'NILVALUE' should be used when no other value can be provided



syslogTs

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Timestamp parsed from non-VES syslog message



syslogVer

Number

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

IANA assigned version of the syslog protocol specification:   0: VES     1: IANA RFC5424



domain

Domain

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Event domain enumeration: 'fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'stndDefined, 'syslog', 'thresholdCrossingAlert', 'voiceQuality'



eventType

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

For example: 'applicationNf', 'guestOS', 'hostOS', 'platform'



lastEpochMicrosec

Number

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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



nfcNamingCode

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Network function component type: 3 characters (aligned with vfc naming standards)



nfNamingCode

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Network function type: 4 characters (aligned with vnf and pnf naming standards)



nfVendorName

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Network function vendor name



priority

Priority

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low'



reportingEntityId

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.



reportingEntityName

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.

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.



sequence

Integer

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Ordering of events communicated by an event source instance (or 0 if not needed)

sequence - Ordering of events communicated by an event source instance (or 0 if not needed)



sourceId

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.

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.



sourceName

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.

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.



startingEpochMicrosec

Number

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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)



timeZoneOffset

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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



version

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use.



vesEventListenerVersion

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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).



name

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY



Status

String

0..1

Experimental

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

The current condition of an interaction, such as open, in research, closed, and so forth



description

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Defines a textual free-form description of the object.



id

Identifier

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Unambiguously distinguishes different object instances. It is the naming attribute of the object.

Identifier of this information element.   This attribute shall be globally unique.




1.2.

...

46                            ThresholdCrossingAlert

The thresholdCrossingAlertFields datatype consists of the following fields:

...

Attribute Name

Type

Mult.

Stereotypes

Description

additionalFields

HashMap

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

additionalFields - Additional pnfRegistration fields if needed.



additionalParameters

ThresholdCrossingAlertCounter

1..*

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Array of performance counters



alertAction

AlertAction

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Enumeration: 'SET', 'CONT', 'CLEAR'



alertDescription

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Unique short alert description (e.g., NE-CPUMEM)



alertType

AlertType

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Enumeration: 'CARD-ANOMALY', 'INTERFACE-ANOMALY', ELEMENT-ANOMALY', 'SERVICE-ANOMALY'



alertValue

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Calculated API value (if applicable)



associatedAlertIdList

String

0..*

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

List of eventIds associated with the event being reported



collectionTimestamp

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Time when the performance collector picked up the data; with RFC 2822 compliant format: 'Sat, 13 Mar 2010 11:29:05 -0800'



dataCollector

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Specific performance collector instance used



elementType

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Type of network element (internal AT&T field)



eventSeverity

EventSeverity

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Event severity or priority enumeration: 'CRITICAL', 'MAJOR', 'MINOR', 'WARNING', 'NORMAL'



eventStartTimestamp

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Time closest to when the measurement was made; with RFC 2822 compliant format: 'Sat, 13 Mar 2010 11:29:05 -0800'



interfaceName

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Physical or logical port or card (if applicable



networkService

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Network name (internal AT&T field)



possibleRootCause

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Reserved for future use



thresholdCrossingFieldsVersion

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Version of the thresholdCrossingAlertFields block as "#.#" where # is a digit; see section 1 for the correct digits to use.



domain

Domain

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Event domain enumeration: 'fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'stndDefined', 'syslog', 'thresholdCrossingAlert', 'voiceQuality'



eventType

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

For example: 'applicationNf', 'guestOS', 'hostOS', 'platform'



lastEpochMicrosec

Number

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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



nfcNamingCode

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Network function component type: 3 characters (aligned with vfc naming standards)



nfNamingCode

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Network function type: 4 characters (aligned with vnf and pnf naming standards)



nfVendorName

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Network function vendor name



priority

Priority

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low'



reportingEntityId

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.



reportingEntityName

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.

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.



sequence

Integer

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Ordering of events communicated by an event source instance (or 0 if not needed)

sequence - Ordering of events communicated by an event source instance (or 0 if not needed)



sourceId

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.

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.



sourceName

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.

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.



startingEpochMicrosec

Number

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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)



timeZoneOffset

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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



version

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use.



vesEventListenerVersion

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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).



name

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY



Status

String

0..1

Experimental

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

The current condition of an interaction, such as open, in research, closed, and so forth



description

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Defines a textual free-form description of the object.



id

Identifier

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Unambiguously distinguishes different object instances. It is the naming attribute of the object.

Identifier of this information element.   This attribute shall be globally unique.




1.2.

...

47                            VendorNfNameFields

vendorNfNameFields - The vendorNfNameFields provides vendor, nf and nfModule identifying information.

...

Attribute Name

Type

Mult.

Stereotypes

Description

nfModuleName

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

nfModuleName - Name of the nfModule generating the event.



nfName

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

nfName - Name of the network function generating the event



vendorName

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

vendorName - Network function vendor name.




1.2.

...

48                            VesEvent

An ONAP event is an aggregation of a header and a message. Event messages may be published to a message broker by service instances, resource instances, or ONAP platform components. Service or resource instances may be in support of network infrastructure or customer services. Interested platforms may subscribe to events on the message broker (e.g. Centralized Testing Platform CTP) may see an event on a service VNF instance and perform an automated test as part of a closed loop management policy. Events are unique and distinguishable from one another. ONAP event messages are serialized as a unicode ASCII character string which may be formatted as JSON, XML, etc... Appropriate schemas will be supplied.

...

Attribute Name

Type

Mult.

Stereotypes

Description

domain

Domain

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Event domain enumeration: 'fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'stndDefined', 'syslog', 'thresholdCrossingAlert', 'voiceQuality'



eventType

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

For example: 'applicationNf', 'guestOS', 'hostOS', 'platform'



lastEpochMicrosec

Number

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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



nfcNamingCode

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Network function component type: 3 characters (aligned with vfc naming standards)



nfNamingCode

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Network function type: 4 characters (aligned with vnf and pnf naming standards)



nfVendorName

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Network function vendor name



priority

Priority

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low'



reportingEntityId

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.



reportingEntityName

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.

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.



sequence

Integer

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Ordering of events communicated by an event source instance (or 0 if not needed)

sequence - Ordering of events communicated by an event source instance (or 0 if not needed)



sourceId

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.

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.



sourceName

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.

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.



startingEpochMicrosec

Number

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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)



timeZoneOffset

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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



version

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use.



vesEventListenerVersion

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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).



name

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY



Status

String

0..1

Experimental

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

The current condition of an interaction, such as open, in research, closed, and so forth



description

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Defines a textual free-form description of the object.



id

Identifier

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Unambiguously distinguishes different object instances. It is the naming attribute of the object.

Identifier of this information element.   This attribute shall be globally unique.




1.2.

...

49                            VoiceQuality

The voiceQuality class provides statistics related to customer facing voice products; consists of the following fields:

...

Attribute Name

Type

Mult.

Stereotypes

Description

additionalInformation

HashMap

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Additional voice quality fields



calleeSideCodec

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Callee codec for the call



callerSideCodec

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Caller codec for the call



correlator

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Constant across all events on this call



phoneNumber

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Phone number associated with the correlator



midCallRtcp

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Base64 encoding of the binary RTCP data (excluding Eth/IP/UDP headers)



voiceQualityFieldsVersion

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Version of the voiceQualityFields block as "#.#" where # is a digit; see section 1 for the correct digits to use.



_endofcallvqmsummaries

EndOfCallVqmSummaries

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

End of call voice quality metric summaries



_vendornfnamefields

VendorNfNameFields

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Vendor, NF and nfModule names



domain

Domain

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Event domain enumeration: 'fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'stndDefined', 'syslog', 'thresholdCrossingAlert', 'voiceQuality'



eventType

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

For example: 'applicationNf', 'guestOS', 'hostOS', 'platform'



lastEpochMicrosec

Number

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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



nfcNamingCode

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Network function component type: 3 characters (aligned with vfc naming standards)



nfNamingCode

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Network function type: 4 characters (aligned with vnf and pnf naming standards)



nfVendorName

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Network function vendor name



priority

Priority

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low'



reportingEntityId

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.



reportingEntityName

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.

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.



sequence

Integer

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Ordering of events communicated by an event source instance (or 0 if not needed)

sequence - Ordering of events communicated by an event source instance (or 0 if not needed)



sourceId

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.

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.



sourceName

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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.

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.



startingEpochMicrosec

Number

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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)



timeZoneOffset

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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



version

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use.



vesEventListenerVersion

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

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).



name

String

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY



Status

String

0..1

Experimental

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

The current condition of an interaction, such as open, in research, closed, and so forth



description

String

0..1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Defines a textual free-form description of the object.



id

Identifier

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Unambiguously distinguishes different object instances. It is the naming attribute of the object.

Identifier of this information element.   This attribute shall be globally unique.




1.2.

...

50                            measInfoIdInteger

The measInfoIdInteger datatype provides an integer measurement group identifier;

...

Attribute Name

Type

Mult.

Stereotypes

Description

iMeasInfoId

Integer

1

Preliminary

OpenModelAttribute

·   isInvariant: false

·   valueRange:  no range constraint

·   support: MANDATORY

Integer measurement group Identifier




1.2.

...

51                            measResultNull

The measResultNull datatype provides a null 3GPP PM measurement result

...

domain - Event domain enumeration:   'fault', 'heartbeat', 'measurementsForVfScaling', 'mobileFlow', 'other', 'sipSignaling', 'stateChange', 'stndDefined', 'syslog', 'thresholdCrossingAlert', 'voiceQuality'

...

  • FAULT:
  • HEARTBEAT:
  • MEASUREMENT:
  • MOBILEFLOW:
  • NOTIFICATION:
  • OTHER:
  • PERF3GPP:
  • PNFREGISTRATION:
  • SIPSIGNALING:
  • STATECHANGE:
  • STNDDEFINED:
  • SYSLOG:
  • THRESHOLDCROSSINGALERT:
  • VOICEQUALITY:

...