VES Class Definition - part 2
Notification
Fields specific to notification events
Parent class: VesEvent
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
additionalFields |
HashMap |
0..1 |
Preliminary OpenModelAttribute
|
Additional notification fields if needed. |
Ves::ObjectClasses::Notification::additionalFields |
arrayOfNamedHashMap |
NamedHashMap |
0..1 |
Preliminary OpenModelAttribute
|
arrayOfNamedHashMap - Array of named hashMaps |
Ves::ObjectClasses::Notification::arrayOfNamedHashMap |
changeContact |
String |
0..1 |
Preliminary OpenModelAttribute
|
Identifier for a contact related to the change. |
Ves::ObjectClasses::Notification::changeContact |
changeIdentifier |
String |
1 |
Preliminary OpenModelAttribute
|
System or session identifier associated with the change. |
Ves::ObjectClasses::Notification::changeIdentifier |
changeType |
String |
1 |
Preliminary OpenModelAttribute
|
Describes what has changed for the entity, for example: configuration changed, capability added, capability removed… |
Ves::ObjectClasses::Notification::changeType |
newState |
String |
0..1 |
Preliminary OpenModelAttribute
|
New state of the entity, for example: ‘inService’, ‘maintenance’, ‘outOfService’ |
Ves::ObjectClasses::Notification::newState |
notificationFieldsVersion |
Number |
1 |
Preliminary OpenModelAttribute
|
Version of the notificationFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. |
Ves::ObjectClasses::Notification::notificationFieldsVersion |
oldState |
String |
0..1 |
Preliminary OpenModelAttribute
|
Previous state of the entity. For example: “inService”, “outOfService”, “maintenance” |
Ves::ObjectClasses::Notification::oldState |
stateInterface |
String |
0..* |
Preliminary OpenModelAttribute
|
Card or port name of the entity that changed state. |
Ves::ObjectClasses::Notification::stateInterface |
domain |
Domain |
1 |
Experimental OpenModelAttribute
|
Update in definition only Event domain enumeration: ‘cmNotify’,’fault’, ‘heartbeat’, ‘measurement’, ‘mobileFlow’, ‘notification’, ‘other’, ‘pnfRegistration’, ‘sipSignaling’, ‘stateChange’, ‘syslog’, ‘thresholdCrossingAlert’, ‘voiceQuality’ |
Ves::ObjectClasses::VesEvent::domain |
eventType |
String |
0..1 |
Preliminary OpenModelAttribute
|
For example: ‘applicationNf’, ‘guestOS’, ‘hostOS’, ‘platform’ |
Ves::ObjectClasses::VesEvent::eventType |
lastEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
the latest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds |
Ves::ObjectClasses::VesEvent::lastEpochMicrosec |
nfcNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function component type: 3 characters (aligned with vfc naming standards) |
Ves::ObjectClasses::VesEvent::nfcNamingCode |
nfNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function type: 4 characters (aligned with vnf and pnf naming standards) |
Ves::ObjectClasses::VesEvent::nfNamingCode |
nfVendorName |
String |
1 |
Preliminary OpenModelAttribute
|
Network function vendor name |
Ves::ObjectClasses::VesEvent::nfVendorName |
priority |
Priority |
1 |
Preliminary OpenModelAttribute
|
Processing priority enumeration: ‘High’, ‘Medium’, ‘Normal’, ‘Low’ |
Ves::ObjectClasses::VesEvent::priority |
reportingEntityId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See ‘reportingEntityName’ for more information. reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. |
Ves::ObjectClasses::VesEvent::reportingEntityId |
reportingEntityName |
String |
1 |
Preliminary OpenModelAttribute
|
reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. |
Ves::ObjectClasses::VesEvent::reportingEntityName |
sequence |
Integer |
1 |
Preliminary OpenModelAttribute
|
sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ordering of events communicated by an event source instance (or 0 if not needed) |
Ves::ObjectClasses::VesEvent::sequence |
sourceId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See ‘sourceName’ for more information. sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. |
Ves::ObjectClasses::VesEvent::sourceId |
sourceName |
String |
1 |
Preliminary OpenModelAttribute
|
Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. |
Ves::ObjectClasses::VesEvent::sourceName |
startingEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) |
Ves::ObjectClasses::VesEvent::startingEpochMicrosec |
timeZoneOffset |
String |
0..1 |
Preliminary OpenModelAttribute
|
Offset to GMT to indicate local time zone for device formatted as ‘UTC+/-hh:mm’; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples |
Ves::ObjectClasses::VesEvent::timeZoneOffset |
version |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the event header as “#.#” where # is a digit; see section 1 for the correct digits to use. |
Ves::ObjectClasses::VesEvent::version |
vesEventListenerVersion |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the ves event listener api spec that this event is compliant with (as “#” or “#.#” or “#.#.#” where # is a digit; see section 1 for the correct digits to use). |
Ves::ObjectClasses::VesEvent::vesEventListenerVersion |
name |
String |
1 |
Preliminary OpenModelAttribute
|
Ves::ObjectClasses::VesEvent::name |
|
Status |
String |
0..1 |
Preliminary OpenModelAttribute
|
The current condition of an interaction, such as open, in research, closed, and so forth |
Common::Business Interaction::ObjectClasses::BusinessInteraction::Status |
description |
String |
0..1 |
Preliminary OpenModelAttribute
|
Defines a textual free-form description of the object. |
Common::Root::RootObjectClasses::RootEntity::description |
id |
Identifier |
1 |
Preliminary OpenModelAttribute
|
Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. |
Common::Root::RootObjectClasses::RootEntity::id |
Other
The otherFields datatype defines fields for events belonging to the ‘other’ domain of the commonEventHeader domain enumeration.
Parent class: VesEvent
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
arrayofNamedHashMap |
ArrayofNamedHashMap |
0..* |
Preliminary OpenModelAttribute
|
Array of named hashMaps |
Ves::ObjectClasses::Other::arrayofNamedHashMap |
hashMap |
HashMap |
0..1 |
Preliminary OpenModelAttribute
|
Array of name-value pairs. |
Ves::ObjectClasses::Other::hashMap |
schemaObjects |
ArrayOfSchemaObject |
0..1 |
Preliminary OpenModelAttribute
|
Array of schema objects described by name, schema and other meta-information. |
Ves::ObjectClasses::Other::schemaObjects |
otherFieldsVersion |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the otherFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. |
Ves::ObjectClasses::Other::otherFieldsVersion |
domain |
Domain |
1 |
Experimental OpenModelAttribute
|
Update in definition only Event domain enumeration: ‘cmNotify’,’fault’, ‘heartbeat’, ‘measurement’, ‘mobileFlow’, ‘notification’, ‘other’, ‘pnfRegistration’, ‘sipSignaling’, ‘stateChange’, ‘syslog’, ‘thresholdCrossingAlert’, ‘voiceQuality’ |
Ves::ObjectClasses::VesEvent::domain |
eventType |
String |
0..1 |
Preliminary OpenModelAttribute
|
For example: ‘applicationNf’, ‘guestOS’, ‘hostOS’, ‘platform’ |
Ves::ObjectClasses::VesEvent::eventType |
lastEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
the latest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds |
Ves::ObjectClasses::VesEvent::lastEpochMicrosec |
nfcNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function component type: 3 characters (aligned with vfc naming standards) |
Ves::ObjectClasses::VesEvent::nfcNamingCode |
nfNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function type: 4 characters (aligned with vnf and pnf naming standards) |
Ves::ObjectClasses::VesEvent::nfNamingCode |
nfVendorName |
String |
1 |
Preliminary OpenModelAttribute
|
Network function vendor name |
Ves::ObjectClasses::VesEvent::nfVendorName |
priority |
Priority |
1 |
Preliminary OpenModelAttribute
|
Processing priority enumeration: ‘High’, ‘Medium’, ‘Normal’, ‘Low’ |
Ves::ObjectClasses::VesEvent::priority |
reportingEntityId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See ‘reportingEntityName’ for more information. reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. |
Ves::ObjectClasses::VesEvent::reportingEntityId |
reportingEntityName |
String |
1 |
Preliminary OpenModelAttribute
|
reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. |
Ves::ObjectClasses::VesEvent::reportingEntityName |
sequence |
Integer |
1 |
Preliminary OpenModelAttribute
|
sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ordering of events communicated by an event source instance (or 0 if not needed) |
Ves::ObjectClasses::VesEvent::sequence |
sourceId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See ‘sourceName’ for more information. sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. |
Ves::ObjectClasses::VesEvent::sourceId |
sourceName |
String |
1 |
Preliminary OpenModelAttribute
|
Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. |
Ves::ObjectClasses::VesEvent::sourceName |
startingEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) |
Ves::ObjectClasses::VesEvent::startingEpochMicrosec |
timeZoneOffset |
String |
0..1 |
Preliminary OpenModelAttribute
|
Offset to GMT to indicate local time zone for device formatted as ‘UTC+/-hh:mm’; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples |
Ves::ObjectClasses::VesEvent::timeZoneOffset |
version |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the event header as “#.#” where # is a digit; see section 1 for the correct digits to use. |
Ves::ObjectClasses::VesEvent::version |
vesEventListenerVersion |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the ves event listener api spec that this event is compliant with (as “#” or “#.#” or “#.#.#” where # is a digit; see section 1 for the correct digits to use). |
Ves::ObjectClasses::VesEvent::vesEventListenerVersion |
name |
String |
1 |
Preliminary OpenModelAttribute
|
Ves::ObjectClasses::VesEvent::name |
|
Status |
String |
0..1 |
Preliminary OpenModelAttribute
|
The current condition of an interaction, such as open, in research, closed, and so forth |
Common::Business Interaction::ObjectClasses::BusinessInteraction::Status |
description |
String |
0..1 |
Preliminary OpenModelAttribute
|
Defines a textual free-form description of the object. |
Common::Root::RootObjectClasses::RootEntity::description |
id |
Identifier |
1 |
Preliminary OpenModelAttribute
|
Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. |
Common::Root::RootObjectClasses::RootEntity::id |
Perf3gpp
Parent class: VesEvent
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
eventAddlFields |
HashMap |
0..1 |
Preliminary OpenModelAttribute
|
Additional key-value pairs if needed |
Ves::ObjectClasses::Perf3gpp::eventAddlFields |
perf3gppFieldsVersion |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the perf3gpp event |
Ves::ObjectClasses::Perf3gpp::perf3gppFieldsVersion |
_measDataCollection |
MeasDataCollection |
1 |
Preliminary OpenModelAttribute
|
3GPP measurement collection structure |
Ves::ObjectClasses::Perf3gpp::_measDataCollection |
domain |
Domain |
1 |
Experimental OpenModelAttribute
|
Update in definition only Event domain enumeration: ‘cmNotify’,’fault’, ‘heartbeat’, ‘measurement’, ‘mobileFlow’, ‘notification’, ‘other’, ‘pnfRegistration’, ‘sipSignaling’, ‘stateChange’, ‘syslog’, ‘thresholdCrossingAlert’, ‘voiceQuality’ |
Ves::ObjectClasses::VesEvent::domain |
eventType |
String |
0..1 |
Preliminary OpenModelAttribute
|
For example: ‘applicationNf’, ‘guestOS’, ‘hostOS’, ‘platform’ |
Ves::ObjectClasses::VesEvent::eventType |
lastEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
the latest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds |
Ves::ObjectClasses::VesEvent::lastEpochMicrosec |
nfcNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function component type: 3 characters (aligned with vfc naming standards) |
Ves::ObjectClasses::VesEvent::nfcNamingCode |
nfNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function type: 4 characters (aligned with vnf and pnf naming standards) |
Ves::ObjectClasses::VesEvent::nfNamingCode |
nfVendorName |
String |
1 |
Preliminary OpenModelAttribute
|
Network function vendor name |
Ves::ObjectClasses::VesEvent::nfVendorName |
priority |
Priority |
1 |
Preliminary OpenModelAttribute
|
Processing priority enumeration: ‘High’, ‘Medium’, ‘Normal’, ‘Low’ |
Ves::ObjectClasses::VesEvent::priority |
reportingEntityId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See ‘reportingEntityName’ for more information. reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. |
Ves::ObjectClasses::VesEvent::reportingEntityId |
reportingEntityName |
String |
1 |
Preliminary OpenModelAttribute
|
reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. |
Ves::ObjectClasses::VesEvent::reportingEntityName |
sequence |
Integer |
1 |
Preliminary OpenModelAttribute
|
sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ordering of events communicated by an event source instance (or 0 if not needed) |
Ves::ObjectClasses::VesEvent::sequence |
sourceId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See ‘sourceName’ for more information. sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. |
Ves::ObjectClasses::VesEvent::sourceId |
sourceName |
String |
1 |
Preliminary OpenModelAttribute
|
Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. |
Ves::ObjectClasses::VesEvent::sourceName |
startingEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) |
Ves::ObjectClasses::VesEvent::startingEpochMicrosec |
timeZoneOffset |
String |
0..1 |
Preliminary OpenModelAttribute
|
Offset to GMT to indicate local time zone for device formatted as ‘UTC+/-hh:mm’; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples |
Ves::ObjectClasses::VesEvent::timeZoneOffset |
version |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the event header as “#.#” where # is a digit; see section 1 for the correct digits to use. |
Ves::ObjectClasses::VesEvent::version |
vesEventListenerVersion |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the ves event listener api spec that this event is compliant with (as “#” or “#.#” or “#.#.#” where # is a digit; see section 1 for the correct digits to use). |
Ves::ObjectClasses::VesEvent::vesEventListenerVersion |
name |
String |
1 |
Preliminary OpenModelAttribute
|
Ves::ObjectClasses::VesEvent::name |
|
Status |
String |
0..1 |
Preliminary OpenModelAttribute
|
The current condition of an interaction, such as open, in research, closed, and so forth |
Common::Business Interaction::ObjectClasses::BusinessInteraction::Status |
description |
String |
0..1 |
Preliminary OpenModelAttribute
|
Defines a textual free-form description of the object. |
Common::Root::RootObjectClasses::RootEntity::description |
id |
Identifier |
1 |
Preliminary OpenModelAttribute
|
Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. |
Common::Root::RootObjectClasses::RootEntity::id |
PnfRegistration
The pnfRegistrationFields datatype defines fields for events belonging to the ‘pnfRegistration’ domain of the commonEventHeader domain enumeration; it consists of the following fields:
Parent class: VesEvent
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
additionalFields |
HashMap |
0..1 |
Preliminary OpenModelAttribute
|
Additional pnfRegistration fields if needed |
Ves::ObjectClasses::PnfRegistration::additionalFields |
lastServiceDate |
String |
0..1 |
Preliminary OpenModelAttribute
|
TS 32.692 dateOfLastService = date of last service; e.g. 15022017 |
Ves::ObjectClasses::PnfRegistration::lastServiceDate |
macAddress |
String |
0..1 |
Preliminary OpenModelAttribute
|
MAC address of OAM interface of the unit |
Ves::ObjectClasses::PnfRegistration::macAddress |
manufactureDate |
String |
0..1 |
Preliminary OpenModelAttribute
|
TS 32.692 dateOfManufacture = manufacture date of the unit; 24032016 |
Ves::ObjectClasses::PnfRegistration::manufactureDate |
modelNumber |
String |
0..1 |
Preliminary OpenModelAttribute
|
TS 32.692 versionNumber = version of the unit from vendor; e.g. AJ02. Maps to AAI equip-model |
Ves::ObjectClasses::PnfRegistration::modelNumber |
oamV4lpAddress |
String |
0..1 |
Preliminary OpenModelAttribute
|
IPv4 m-plane IP address to be used by the manager to contact the PNF |
Ves::ObjectClasses::PnfRegistration::oamV4lpAddress |
oamV6lpAddress |
String |
0..1 |
Preliminary OpenModelAttribute
|
IPv6 m-plane IP address to be used by the manager to contact the PNF |
Ves::ObjectClasses::PnfRegistration::oamV6lpAddress |
pnfRegistrationFieldsVersion |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the registrationFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. |
Ves::ObjectClasses::PnfRegistration::pnfRegistrationFieldsVersion |
serialNumber |
String |
0..1 |
Preliminary OpenModelAttribute
|
TS 32.692 serialNumber = serial number of the unit; e.g. 6061ZW3 |
Ves::ObjectClasses::PnfRegistration::serialNumber |
softwareVersion |
String |
0..1 |
Preliminary OpenModelAttribute
|
TS 32.692 swName = active SW running on the unit; e.g. 5gDUv18.05.201 |
Ves::ObjectClasses::PnfRegistration::softwareVersion |
unitFamily |
String |
0..1 |
Preliminary OpenModelAttribute
|
TS 32.692 vendorUnitFamilyType = general type of HW unit; e.g. BBU |
Ves::ObjectClasses::PnfRegistration::unitFamily |
unitType |
String |
0..1 |
Preliminary OpenModelAttribute
|
TS 32.692 vendorUnitTypeNumber = vendor name for the unit; e.g. Airscale |
Ves::ObjectClasses::PnfRegistration::unitType |
vendorName |
String |
0..1 |
Preliminary OpenModelAttribute
|
TS 32.692 vendorName = name of manufacturer; e.g. Nokia. Maps to AAI equip-vendor |
Ves::ObjectClasses::PnfRegistration::vendorName |
domain |
Domain |
1 |
Experimental OpenModelAttribute
|
Update in definition only Event domain enumeration: ‘cmNotify’,’fault’, ‘heartbeat’, ‘measurement’, ‘mobileFlow’, ‘notification’, ‘other’, ‘pnfRegistration’, ‘sipSignaling’, ‘stateChange’, ‘syslog’, ‘thresholdCrossingAlert’, ‘voiceQuality’ |
Ves::ObjectClasses::VesEvent::domain |
eventType |
String |
0..1 |
Preliminary OpenModelAttribute
|
For example: ‘applicationNf’, ‘guestOS’, ‘hostOS’, ‘platform’ |
Ves::ObjectClasses::VesEvent::eventType |
lastEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
the latest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds |
Ves::ObjectClasses::VesEvent::lastEpochMicrosec |
nfcNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function component type: 3 characters (aligned with vfc naming standards) |
Ves::ObjectClasses::VesEvent::nfcNamingCode |
nfNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function type: 4 characters (aligned with vnf and pnf naming standards) |
Ves::ObjectClasses::VesEvent::nfNamingCode |
nfVendorName |
String |
1 |
Preliminary OpenModelAttribute
|
Network function vendor name |
Ves::ObjectClasses::VesEvent::nfVendorName |
priority |
Priority |
1 |
Preliminary OpenModelAttribute
|
Processing priority enumeration: ‘High’, ‘Medium’, ‘Normal’, ‘Low’ |
Ves::ObjectClasses::VesEvent::priority |
reportingEntityId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See ‘reportingEntityName’ for more information. reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. |
Ves::ObjectClasses::VesEvent::reportingEntityId |
reportingEntityName |
String |
1 |
Preliminary OpenModelAttribute
|
reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. |
Ves::ObjectClasses::VesEvent::reportingEntityName |
sequence |
Integer |
1 |
Preliminary OpenModelAttribute
|
sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ordering of events communicated by an event source instance (or 0 if not needed) |
Ves::ObjectClasses::VesEvent::sequence |
sourceId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See ‘sourceName’ for more information. sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. |
Ves::ObjectClasses::VesEvent::sourceId |
sourceName |
String |
1 |
Preliminary OpenModelAttribute
|
Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. |
Ves::ObjectClasses::VesEvent::sourceName |
startingEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) |
Ves::ObjectClasses::VesEvent::startingEpochMicrosec |
timeZoneOffset |
String |
0..1 |
Preliminary OpenModelAttribute
|
Offset to GMT to indicate local time zone for device formatted as ‘UTC+/-hh:mm’; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples |
Ves::ObjectClasses::VesEvent::timeZoneOffset |
version |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the event header as “#.#” where # is a digit; see section 1 for the correct digits to use. |
Ves::ObjectClasses::VesEvent::version |
vesEventListenerVersion |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the ves event listener api spec that this event is compliant with (as “#” or “#.#” or “#.#.#” where # is a digit; see section 1 for the correct digits to use). |
Ves::ObjectClasses::VesEvent::vesEventListenerVersion |
name |
String |
1 |
Preliminary OpenModelAttribute
|
Ves::ObjectClasses::VesEvent::name |
|
Status |
String |
0..1 |
Preliminary OpenModelAttribute
|
The current condition of an interaction, such as open, in research, closed, and so forth |
Common::Business Interaction::ObjectClasses::BusinessInteraction::Status |
description |
String |
0..1 |
Preliminary OpenModelAttribute
|
Defines a textual free-form description of the object. |
Common::Root::RootObjectClasses::RootEntity::description |
id |
Identifier |
1 |
Preliminary OpenModelAttribute
|
Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. |
Common::Root::RootObjectClasses::RootEntity::id |
ProcessStats
The processStats datatype provides metrics on system processes; it consists of the following fields:
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
forkRate |
Number |
0..1 |
Preliminary OpenModelAttribute
|
The number of threads created since the last reboot |
Ves::ObjectClasses::ProcessStats::forkRate |
processIdentifier |
String |
1 |
Preliminary OpenModelAttribute
|
processIdentifier |
Ves::ObjectClasses::ProcessStats::processIdentifier |
psStateBlocked |
Number |
0..1 |
Preliminary OpenModelAttribute
|
The number of processes in a blocked state |
Ves::ObjectClasses::ProcessStats::psStateBlocked |
psStatePaging |
Number |
0..1 |
Preliminary OpenModelAttribute
|
The number of processes in a paging state |
Ves::ObjectClasses::ProcessStats::psStatePaging |
psStateRunning |
Number |
0..1 |
Preliminary OpenModelAttribute
|
The number of processes in a running state |
Ves::ObjectClasses::ProcessStats::psStateRunning |
psStateSleeping |
Number |
0..1 |
Preliminary OpenModelAttribute
|
The number of processes in a sleeping state |
Ves::ObjectClasses::ProcessStats::psStateSleeping |
PsStateStopped |
Number |
0..1 |
Preliminary OpenModelAttribute
|
The number of processes in a stopped state |
Ves::ObjectClasses::ProcessStats::PsStateStopped |
psStateZombie |
Number |
0..1 |
Preliminary OpenModelAttribute
|
The number of processes in a zombie state |
Ves::ObjectClasses::ProcessStats::psStateZombie |
ProcessorDimmAggregateThermalMargin
The processorDimmAggregateThermalMargin datatype provides intelligent platform management interface (ipmi) processor dual inline memory module aggregate thermal margin metrics; it consists of the following fields:
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
processorDimmAggregateThermal MarginIdentifier |
String |
1 |
Preliminary OpenModelAttribute
|
identifier for the aggregate thermal margin metrics from the processor dual inline memory module |
Ves::ObjectClasses::ProcessorDimmAggregateThermalMargin::processorDimmAggregateThermal MarginIdentifier |
thermalMargin |
Number |
1 |
Preliminary OpenModelAttribute
|
the difference between the DIMM’s current temperature, in celsius, and the DIMM’s throttling thermal trip point |
Ves::ObjectClasses::ProcessorDimmAggregateThermalMargin::thermalMargin |
SipSignaling
sipSignalingFields - The sipSignalingFields datatype communicates information about SIP signaling messages, parameters and signaling state.
Parent class: VesEvent
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
additionalInformation |
HashMap |
0..1 |
Preliminary OpenModelAttribute
|
zdditionalInformation - Additional sipSignalling fields. |
Ves::ObjectClasses::SipSignaling::additionalInformation |
compressedSip |
String |
0..1 |
Preliminary OpenModelAttribute
|
compressedSip - The full SIP request/response including headers and bodies. |
Ves::ObjectClasses::SipSignaling::compressedSip |
correlator |
String |
1 |
Preliminary OpenModelAttribute
|
correlator - Constant across all events on this call. |
Ves::ObjectClasses::SipSignaling::correlator |
localipAddress |
String |
1 |
Preliminary OpenModelAttribute
|
localIpAddress - IP address on VNF. Note: current data type (String) may be changed to Common Resource Datatype L3AddressData. =[gh]= |
Ves::ObjectClasses::SipSignaling::localipAddress |
localPort |
String |
1 |
Preliminary OpenModelAttribute
|
localPort - Port on VNF. |
Ves::ObjectClasses::SipSignaling::localPort |
remoteipAddress |
String |
1 |
Preliminary OpenModelAttribute
|
remoteIpAddress - IP address of peer endpoint. Note: current data type (String) may be changed to Common Resource Datatype L3AddressData. =[gh]= |
Ves::ObjectClasses::SipSignaling::remoteipAddress |
remotePort |
String |
1 |
Preliminary OpenModelAttribute
|
remotePort - Port of peer endpoint |
Ves::ObjectClasses::SipSignaling::remotePort |
sipSignaliingFieldsVersion |
String |
1 |
Preliminary OpenModelAttribute
|
sipSignalingFieldsVersion - Version of the sipSignalingFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. |
Ves::ObjectClasses::SipSignaling::sipSignaliingFieldsVersion |
summarySip |
String |
0..1 |
Preliminary OpenModelAttribute
|
summarySip - The SIP Method or Response (‘INVITE’, ‘200 OK’, ‘BYE’, etc). |
Ves::ObjectClasses::SipSignaling::summarySip |
_vendorNfnamefields |
VendorNfNameFields |
1 |
Preliminary OpenModelAttribute
|
Vendor, NF and nfModule names |
Ves::ObjectClasses::SipSignaling::_vendorNfnamefields |
domain |
Domain |
1 |
Experimental OpenModelAttribute
|
Update in definition only Event domain enumeration: ‘cmNotify’,’fault’, ‘heartbeat’, ‘measurement’, ‘mobileFlow’, ‘notification’, ‘other’, ‘pnfRegistration’, ‘sipSignaling’, ‘stateChange’, ‘syslog’, ‘thresholdCrossingAlert’, ‘voiceQuality’ |
Ves::ObjectClasses::VesEvent::domain |
eventType |
String |
0..1 |
Preliminary OpenModelAttribute
|
For example: ‘applicationNf’, ‘guestOS’, ‘hostOS’, ‘platform’ |
Ves::ObjectClasses::VesEvent::eventType |
lastEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
the latest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds |
Ves::ObjectClasses::VesEvent::lastEpochMicrosec |
nfcNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function component type: 3 characters (aligned with vfc naming standards) |
Ves::ObjectClasses::VesEvent::nfcNamingCode |
nfNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function type: 4 characters (aligned with vnf and pnf naming standards) |
Ves::ObjectClasses::VesEvent::nfNamingCode |
nfVendorName |
String |
1 |
Preliminary OpenModelAttribute
|
Network function vendor name |
Ves::ObjectClasses::VesEvent::nfVendorName |
priority |
Priority |
1 |
Preliminary OpenModelAttribute
|
Processing priority enumeration: ‘High’, ‘Medium’, ‘Normal’, ‘Low’ |
Ves::ObjectClasses::VesEvent::priority |
reportingEntityId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See ‘reportingEntityName’ for more information. reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. |
Ves::ObjectClasses::VesEvent::reportingEntityId |
reportingEntityName |
String |
1 |
Preliminary OpenModelAttribute
|
reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. |
Ves::ObjectClasses::VesEvent::reportingEntityName |
sequence |
Integer |
1 |
Preliminary OpenModelAttribute
|
sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ordering of events communicated by an event source instance (or 0 if not needed) |
Ves::ObjectClasses::VesEvent::sequence |
sourceId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See ‘sourceName’ for more information. sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. |
Ves::ObjectClasses::VesEvent::sourceId |
sourceName |
String |
1 |
Preliminary OpenModelAttribute
|
Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. |
Ves::ObjectClasses::VesEvent::sourceName |
startingEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) |
Ves::ObjectClasses::VesEvent::startingEpochMicrosec |
timeZoneOffset |
String |
0..1 |
Preliminary OpenModelAttribute
|
Offset to GMT to indicate local time zone for device formatted as ‘UTC+/-hh:mm’; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples |
Ves::ObjectClasses::VesEvent::timeZoneOffset |
version |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the event header as “#.#” where # is a digit; see section 1 for the correct digits to use. |
Ves::ObjectClasses::VesEvent::version |
vesEventListenerVersion |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the ves event listener api spec that this event is compliant with (as “#” or “#.#” or “#.#.#” where # is a digit; see section 1 for the correct digits to use). |
Ves::ObjectClasses::VesEvent::vesEventListenerVersion |
name |
String |
1 |
Preliminary OpenModelAttribute
|
Ves::ObjectClasses::VesEvent::name |
|
Status |
String |
0..1 |
Preliminary OpenModelAttribute
|
The current condition of an interaction, such as open, in research, closed, and so forth |
Common::Business Interaction::ObjectClasses::BusinessInteraction::Status |
description |
String |
0..1 |
Preliminary OpenModelAttribute
|
Defines a textual free-form description of the object. |
Common::Root::RootObjectClasses::RootEntity::description |
id |
Identifier |
1 |
Preliminary OpenModelAttribute
|
Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. |
Common::Root::RootObjectClasses::RootEntity::id |
StateChange
Fields specific to state change events.
Parent class: VesEvent
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
additionalFields |
HashMap |
0..1 |
Preliminary OpenModelAttribute
|
Additional stateChange fields if needed |
Ves::ObjectClasses::StateChange::additionalFields |
newState |
invalid |
1 |
Preliminary OpenModelAttribute
|
New state of the entity: ‘inService’, ‘maintenance’, ‘outOfService’ |
Ves::ObjectClasses::StateChange::newState |
OldState |
invalid |
1 |
Preliminary OpenModelAttribute
|
Previous state of the entity: ‘inService’, ‘maintenance’, ‘outOfService’ |
Ves::ObjectClasses::StateChange::OldState |
stateChangeFieldsVersion |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the stateChangeFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. |
Ves::ObjectClasses::StateChange::stateChangeFieldsVersion |
stateInterface |
String |
1 |
Preliminary OpenModelAttribute
|
Card or port name of the entity that changed state |
Ves::ObjectClasses::StateChange::stateInterface |
domain |
Domain |
1 |
Experimental OpenModelAttribute
|
Update in definition only Event domain enumeration: ‘cmNotify’,’fault’, ‘heartbeat’, ‘measurement’, ‘mobileFlow’, ‘notification’, ‘other’, ‘pnfRegistration’, ‘sipSignaling’, ‘stateChange’, ‘syslog’, ‘thresholdCrossingAlert’, ‘voiceQuality’ |
Ves::ObjectClasses::VesEvent::domain |
eventType |
String |
0..1 |
Preliminary OpenModelAttribute
|
For example: ‘applicationNf’, ‘guestOS’, ‘hostOS’, ‘platform’ |
Ves::ObjectClasses::VesEvent::eventType |
lastEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
the latest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds |
Ves::ObjectClasses::VesEvent::lastEpochMicrosec |
nfcNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function component type: 3 characters (aligned with vfc naming standards) |
Ves::ObjectClasses::VesEvent::nfcNamingCode |
nfNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function type: 4 characters (aligned with vnf and pnf naming standards) |
Ves::ObjectClasses::VesEvent::nfNamingCode |
nfVendorName |
String |
1 |
Preliminary OpenModelAttribute
|
Network function vendor name |
Ves::ObjectClasses::VesEvent::nfVendorName |
priority |
Priority |
1 |
Preliminary OpenModelAttribute
|
Processing priority enumeration: ‘High’, ‘Medium’, ‘Normal’, ‘Low’ |
Ves::ObjectClasses::VesEvent::priority |
reportingEntityId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See ‘reportingEntityName’ for more information. reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. |
Ves::ObjectClasses::VesEvent::reportingEntityId |
reportingEntityName |
String |
1 |
Preliminary OpenModelAttribute
|
reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. |
Ves::ObjectClasses::VesEvent::reportingEntityName |
sequence |
Integer |
1 |
Preliminary OpenModelAttribute
|
sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ordering of events communicated by an event source instance (or 0 if not needed) |
Ves::ObjectClasses::VesEvent::sequence |
sourceId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See ‘sourceName’ for more information. sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. |
Ves::ObjectClasses::VesEvent::sourceId |
sourceName |
String |
1 |
Preliminary OpenModelAttribute
|
Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. |
Ves::ObjectClasses::VesEvent::sourceName |
startingEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) |
Ves::ObjectClasses::VesEvent::startingEpochMicrosec |
timeZoneOffset |
String |
0..1 |
Preliminary OpenModelAttribute
|
Offset to GMT to indicate local time zone for device formatted as ‘UTC+/-hh:mm’; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples |
Ves::ObjectClasses::VesEvent::timeZoneOffset |
version |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the event header as “#.#” where # is a digit; see section 1 for the correct digits to use. |
Ves::ObjectClasses::VesEvent::version |
vesEventListenerVersion |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the ves event listener api spec that this event is compliant with (as “#” or “#.#” or “#.#.#” where # is a digit; see section 1 for the correct digits to use). |
Ves::ObjectClasses::VesEvent::vesEventListenerVersion |
name |
String |
1 |
Preliminary OpenModelAttribute
|
Ves::ObjectClasses::VesEvent::name |
|
Status |
String |
0..1 |
Preliminary OpenModelAttribute
|
The current condition of an interaction, such as open, in research, closed, and so forth |
Common::Business Interaction::ObjectClasses::BusinessInteraction::Status |
description |
String |
0..1 |
Preliminary OpenModelAttribute
|
Defines a textual free-form description of the object. |
Common::Root::RootObjectClasses::RootEntity::description |
id |
Identifier |
1 |
Preliminary OpenModelAttribute
|
Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. |
Common::Root::RootObjectClasses::RootEntity::id |
StndDefined
Parent class: VesEvent
Applied stereotypes:
OpenModelClass
support: MANDATORY
Syslog
Syslog’s can be classified as either Control or Session/Traffic. They differ by message content and expected volume: ? Control logs are generally free-form human-readable text used for reporting errors or warnings supporting the operation and troubleshooting of NFs. The volume of these logs is typically less than 2k per day. ? Session logs use common structured fields to report normal NF processing such as DNS lookups or firewall rules processed. The volume of these logs is typically greater than 1k per hour (and sometimes as high as 10k per second). VES supports both classes of syslog, however VES is only recommended for control logs or for lower volume session logs, less than 60k per hour. High volume session logging should use a file-based transport solution.
Parent class: VesEvent
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
additionalFields |
HashMap |
0..* |
Preliminary OpenModelAttribute
|
Additional syslog fields if needed Ex: {“name1”: “value1”, “name2: “value2” … } |
Ves::ObjectClasses::Syslog::additionalFields |
eventSourceHost |
String |
0..1 |
Preliminary OpenModelAttribute
|
Hostname of the device |
Ves::ObjectClasses::Syslog::eventSourceHost |
eventSourceType |
String |
1 |
Preliminary OpenModelAttribute
|
Examples: ‘other’, ‘router’, ‘switch’, ‘host’, ‘card’, ‘port’, ‘slotThreshold’, ‘portThreshold’, ‘virtualMachine’, ‘virtualNetworkFunction’ |
Ves::ObjectClasses::Syslog::eventSourceType |
syslogSdId |
String |
0..1 |
Preliminary OpenModelAttribute
|
0-32 char in format name@number, i.e., ourSDID@32473 |
Ves::ObjectClasses::Syslog::syslogSdId |
syslogFacilty |
SyslogFacility |
0..1 |
Preliminary OpenModelAttribute
|
Numeric code from 0 to 23 for facility: 0 kernel messages 1 user-level messages 2 mail system 3 system daemons 4 security/authorization messages 5 messages generated internally by syslogd 6 line printer subsystem 7 network news subsystem 8 UUCP subsystem 9 clock daemon 10 security/authorization messages 11 FTP daemon 12 NTP subsystem 13 log audit 14 log alert 15 clock daemon (note 2) 16 local use 0 (local0) 17 local use 1 (local1) 18 local use 2 (local2) 19 local use 3 (local3) 20 local use 4 (local4) 21 local use 5 (local5) 22 local use 6 (local6) 23 local use 7 (local7 ) |
Ves::ObjectClasses::Syslog::syslogFacilty |
syslogFieldVersion |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the syslogFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. |
Ves::ObjectClasses::Syslog::syslogFieldVersion |
syslogMsg |
String |
1 |
Preliminary OpenModelAttribute
|
Syslog message |
Ves::ObjectClasses::Syslog::syslogMsg |
syslogMsgHost |
String |
0..1 |
Preliminary OpenModelAttribute
|
Hostname parsed from non-VES syslog message |
Ves::ObjectClasses::Syslog::syslogMsgHost |
syslogPri |
Integer |
0..1 |
Preliminary OpenModelAttribute
|
0-192 Combined Severity and Facility (see rfc5424) |
Ves::ObjectClasses::Syslog::syslogPri |
syslogProc |
String |
0..1 |
Preliminary OpenModelAttribute
|
Identifies the application that originated the message |
Ves::ObjectClasses::Syslog::syslogProc |
syslogProcId |
Number |
0..1 |
Preliminary OpenModelAttribute
|
The process number assigned by the OS when the application was started |
Ves::ObjectClasses::Syslog::syslogProcId |
syslogSData |
String |
0..1 |
Preliminary OpenModelAttribute
|
A <space> separated list of key=”value” pairs following the rfc5424 standard for SD-ELEMENT. Deprecated The entire rfc5424 syslogSData object, including square brackets [ ], SD-ID and list of SD-PARAMs |
Ves::ObjectClasses::Syslog::syslogSData |
syslogSev |
SyslogSev |
0..1 |
Preliminary OpenModelAttribute
|
Level-of-severity text enumeration defined below: Text Sev Description Emergency 0 system is unusable Alert 1 action must be taken immediately Critical 2 critical conditions Error 3 error conditions Warning 4 warning conditions Notice 5 normal but significant condition Info 6 Informational messages Debug 7 debug-level messages |
Ves::ObjectClasses::Syslog::syslogSev |
syslogTag |
String |
1 |
Preliminary OpenModelAttribute
|
Also known as MsgId. Brief non-spaced text indicating the type of message such as ‘TCPOUT’ or ‘BGP_STATUS_CHANGE’; ‘NILVALUE’ should be used when no other value can be provided |
Ves::ObjectClasses::Syslog::syslogTag |
syslogTs |
String |
0..1 |
Preliminary OpenModelAttribute
|
Timestamp parsed from non-VES syslog message |
Ves::ObjectClasses::Syslog::syslogTs |
syslogVer |
Number |
0..1 |
Preliminary OpenModelAttribute
|
IANA assigned version of the syslog protocol specification: 0: VES 1: IANA RFC5424 |
Ves::ObjectClasses::Syslog::syslogVer |
domain |
Domain |
1 |
Experimental OpenModelAttribute
|
Update in definition only Event domain enumeration: ‘cmNotify’,’fault’, ‘heartbeat’, ‘measurement’, ‘mobileFlow’, ‘notification’, ‘other’, ‘pnfRegistration’, ‘sipSignaling’, ‘stateChange’, ‘syslog’, ‘thresholdCrossingAlert’, ‘voiceQuality’ |
Ves::ObjectClasses::VesEvent::domain |
eventType |
String |
0..1 |
Preliminary OpenModelAttribute
|
For example: ‘applicationNf’, ‘guestOS’, ‘hostOS’, ‘platform’ |
Ves::ObjectClasses::VesEvent::eventType |
lastEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
the latest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds |
Ves::ObjectClasses::VesEvent::lastEpochMicrosec |
nfcNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function component type: 3 characters (aligned with vfc naming standards) |
Ves::ObjectClasses::VesEvent::nfcNamingCode |
nfNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function type: 4 characters (aligned with vnf and pnf naming standards) |
Ves::ObjectClasses::VesEvent::nfNamingCode |
nfVendorName |
String |
1 |
Preliminary OpenModelAttribute
|
Network function vendor name |
Ves::ObjectClasses::VesEvent::nfVendorName |
priority |
Priority |
1 |
Preliminary OpenModelAttribute
|
Processing priority enumeration: ‘High’, ‘Medium’, ‘Normal’, ‘Low’ |
Ves::ObjectClasses::VesEvent::priority |
reportingEntityId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See ‘reportingEntityName’ for more information. reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. |
Ves::ObjectClasses::VesEvent::reportingEntityId |
reportingEntityName |
String |
1 |
Preliminary OpenModelAttribute
|
reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. |
Ves::ObjectClasses::VesEvent::reportingEntityName |
sequence |
Integer |
1 |
Preliminary OpenModelAttribute
|
sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ordering of events communicated by an event source instance (or 0 if not needed) |
Ves::ObjectClasses::VesEvent::sequence |
sourceId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See ‘sourceName’ for more information. sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. |
Ves::ObjectClasses::VesEvent::sourceId |
sourceName |
String |
1 |
Preliminary OpenModelAttribute
|
Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. |
Ves::ObjectClasses::VesEvent::sourceName |
startingEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) |
Ves::ObjectClasses::VesEvent::startingEpochMicrosec |
timeZoneOffset |
String |
0..1 |
Preliminary OpenModelAttribute
|
Offset to GMT to indicate local time zone for device formatted as ‘UTC+/-hh:mm’; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples |
Ves::ObjectClasses::VesEvent::timeZoneOffset |
version |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the event header as “#.#” where # is a digit; see section 1 for the correct digits to use. |
Ves::ObjectClasses::VesEvent::version |
vesEventListenerVersion |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the ves event listener api spec that this event is compliant with (as “#” or “#.#” or “#.#.#” where # is a digit; see section 1 for the correct digits to use). |
Ves::ObjectClasses::VesEvent::vesEventListenerVersion |
name |
String |
1 |
Preliminary OpenModelAttribute
|
Ves::ObjectClasses::VesEvent::name |
|
Status |
String |
0..1 |
Preliminary OpenModelAttribute
|
The current condition of an interaction, such as open, in research, closed, and so forth |
Common::Business Interaction::ObjectClasses::BusinessInteraction::Status |
description |
String |
0..1 |
Preliminary OpenModelAttribute
|
Defines a textual free-form description of the object. |
Common::Root::RootObjectClasses::RootEntity::description |
id |
Identifier |
1 |
Preliminary OpenModelAttribute
|
Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. |
Common::Root::RootObjectClasses::RootEntity::id |
ThresholdCrossingAlert
The thresholdCrossingAlertFields datatype consists of the following fields:
Parent class: VesEvent
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
additionalFields |
HashMap |
0..1 |
Preliminary OpenModelAttribute
|
additionalFields - Additional pnfRegistration fields if needed. |
Ves::ObjectClasses::ThresholdCrossingAlert::additionalFields |
additionalParameters |
ThresholdCrossingAlertCounter |
1..* |
Preliminary OpenModelAttribute
|
Array of performance counters |
Ves::ObjectClasses::ThresholdCrossingAlert::additionalParameters |
alertAction |
AlertAction |
1 |
Preliminary OpenModelAttribute
|
Enumeration: ‘SET’, ‘CONT’, ‘CLEAR’ |
Ves::ObjectClasses::ThresholdCrossingAlert::alertAction |
alertDescription |
String |
1 |
Preliminary OpenModelAttribute
|
Unique short alert description (e.g., NE-CPUMEM) |
Ves::ObjectClasses::ThresholdCrossingAlert::alertDescription |
alertType |
AlertType |
1 |
Preliminary OpenModelAttribute
|
Enumeration: ‘CARD-ANOMALY’, ‘INTERFACE-ANOMALY’, ELEMENT-ANOMALY’, ‘SERVICE-ANOMALY’ |
Ves::ObjectClasses::ThresholdCrossingAlert::alertType |
alertValue |
String |
0..1 |
Preliminary OpenModelAttribute
|
Calculated API value (if applicable) |
Ves::ObjectClasses::ThresholdCrossingAlert::alertValue |
associatedAlertIdList |
String |
0..* |
Preliminary OpenModelAttribute
|
List of eventIds associated with the event being reported |
Ves::ObjectClasses::ThresholdCrossingAlert::associatedAlertIdList |
collectionTimestamp |
String |
1 |
Preliminary OpenModelAttribute
|
Time when the performance collector picked up the data; with RFC 2822 compliant format: ‘Sat, 13 Mar 2010 11:29:05 -0800’ |
Ves::ObjectClasses::ThresholdCrossingAlert::collectionTimestamp |
dataCollector |
String |
0..1 |
Preliminary OpenModelAttribute
|
Specific performance collector instance used |
Ves::ObjectClasses::ThresholdCrossingAlert::dataCollector |
elementType |
String |
0..1 |
Preliminary OpenModelAttribute
|
Type of network element (internal AT&T field) |
Ves::ObjectClasses::ThresholdCrossingAlert::elementType |
eventSeverity |
EventSeverity |
1 |
Preliminary OpenModelAttribute
|
Event severity or priority enumeration: ‘CRITICAL’, ‘MAJOR’, ‘MINOR’, ‘WARNING’, ‘NORMAL’ |
Ves::ObjectClasses::ThresholdCrossingAlert::eventSeverity |
eventStartTimestamp |
String |
1 |
Preliminary OpenModelAttribute
|
Time closest to when the measurement was made; with RFC 2822 compliant format: ‘Sat, 13 Mar 2010 11:29:05 -0800’ |
Ves::ObjectClasses::ThresholdCrossingAlert::eventStartTimestamp |
interfaceName |
String |
0..1 |
Preliminary OpenModelAttribute
|
Physical or logical port or card (if applicable |
Ves::ObjectClasses::ThresholdCrossingAlert::interfaceName |
networkService |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network name (internal AT&T field) |
Ves::ObjectClasses::ThresholdCrossingAlert::networkService |
possibleRootCause |
String |
0..1 |
Preliminary OpenModelAttribute
|
Reserved for future use |
Ves::ObjectClasses::ThresholdCrossingAlert::possibleRootCause |
thresholdCrossingFieldsVersion |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the thresholdCrossingAlertFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. |
Ves::ObjectClasses::ThresholdCrossingAlert::thresholdCrossingFieldsVersion |
domain |
Domain |
1 |
Experimental OpenModelAttribute
|
Update in definition only Event domain enumeration: ‘cmNotify’,’fault’, ‘heartbeat’, ‘measurement’, ‘mobileFlow’, ‘notification’, ‘other’, ‘pnfRegistration’, ‘sipSignaling’, ‘stateChange’, ‘syslog’, ‘thresholdCrossingAlert’, ‘voiceQuality’ |
Ves::ObjectClasses::VesEvent::domain |
eventType |
String |
0..1 |
Preliminary OpenModelAttribute
|
For example: ‘applicationNf’, ‘guestOS’, ‘hostOS’, ‘platform’ |
Ves::ObjectClasses::VesEvent::eventType |
lastEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
the latest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds |
Ves::ObjectClasses::VesEvent::lastEpochMicrosec |
nfcNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function component type: 3 characters (aligned with vfc naming standards) |
Ves::ObjectClasses::VesEvent::nfcNamingCode |
nfNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function type: 4 characters (aligned with vnf and pnf naming standards) |
Ves::ObjectClasses::VesEvent::nfNamingCode |
nfVendorName |
String |
1 |
Preliminary OpenModelAttribute
|
Network function vendor name |
Ves::ObjectClasses::VesEvent::nfVendorName |
priority |
Priority |
1 |
Preliminary OpenModelAttribute
|
Processing priority enumeration: ‘High’, ‘Medium’, ‘Normal’, ‘Low’ |
Ves::ObjectClasses::VesEvent::priority |
reportingEntityId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See ‘reportingEntityName’ for more information. reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. |
Ves::ObjectClasses::VesEvent::reportingEntityId |
reportingEntityName |
String |
1 |
Preliminary OpenModelAttribute
|
reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. |
Ves::ObjectClasses::VesEvent::reportingEntityName |
sequence |
Integer |
1 |
Preliminary OpenModelAttribute
|
sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ordering of events communicated by an event source instance (or 0 if not needed) |
Ves::ObjectClasses::VesEvent::sequence |
sourceId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See ‘sourceName’ for more information. sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. |
Ves::ObjectClasses::VesEvent::sourceId |
sourceName |
String |
1 |
Preliminary OpenModelAttribute
|
Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. |
Ves::ObjectClasses::VesEvent::sourceName |
startingEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) |
Ves::ObjectClasses::VesEvent::startingEpochMicrosec |
timeZoneOffset |
String |
0..1 |
Preliminary OpenModelAttribute
|
Offset to GMT to indicate local time zone for device formatted as ‘UTC+/-hh:mm’; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples |
Ves::ObjectClasses::VesEvent::timeZoneOffset |
version |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the event header as “#.#” where # is a digit; see section 1 for the correct digits to use. |
Ves::ObjectClasses::VesEvent::version |
vesEventListenerVersion |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the ves event listener api spec that this event is compliant with (as “#” or “#.#” or “#.#.#” where # is a digit; see section 1 for the correct digits to use). |
Ves::ObjectClasses::VesEvent::vesEventListenerVersion |
name |
String |
1 |
Preliminary OpenModelAttribute
|
Ves::ObjectClasses::VesEvent::name |
|
Status |
String |
0..1 |
Preliminary OpenModelAttribute
|
The current condition of an interaction, such as open, in research, closed, and so forth |
Common::Business Interaction::ObjectClasses::BusinessInteraction::Status |
description |
String |
0..1 |
Preliminary OpenModelAttribute
|
Defines a textual free-form description of the object. |
Common::Root::RootObjectClasses::RootEntity::description |
id |
Identifier |
1 |
Preliminary OpenModelAttribute
|
Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. |
Common::Root::RootObjectClasses::RootEntity::id |
VendorNfNameFields
vendorNfNameFields - The vendorNfNameFields provides vendor, nf and nfModule identifying information.
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
nfModuleName |
String |
0..1 |
Preliminary OpenModelAttribute
|
nfModuleName - Name of the nfModule generating the event. |
Ves::ObjectClasses::VendorNfNameFields::nfModuleName |
nfName |
String |
0..1 |
Preliminary OpenModelAttribute
|
nfName - Name of the network function generating the event |
Ves::ObjectClasses::VendorNfNameFields::nfName |
vendorName |
String |
1 |
Preliminary OpenModelAttribute
|
vendorName - Network function vendor name. |
Ves::ObjectClasses::VendorNfNameFields::vendorName |
VesEvent
An ONAP event is an aggregation of a header and a message. Event messages may be published to a message broker by service instances, resource instances, or ONAP platform components. Service or resource instances may be in support of network infrastructure or customer services. Interested platforms may subscribe to events on the message broker (e.g. Centralized Testing Platform CTP) may see an event on a service VNF instance and perform an automated test as part of a closed loop management policy. Events are unique and distinguishable from one another. ONAP event messages are serialized as a unicode ASCII character string which may be formatted as JSON, XML, etc… Appropriate schemas will be supplied.
Parent class: Notification
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
domain |
Domain |
1 |
Experimental OpenModelAttribute
|
Update in definition only Event domain enumeration: ‘cmNotify’,’fault’, ‘heartbeat’, ‘measurement’, ‘mobileFlow’, ‘notification’, ‘other’, ‘pnfRegistration’, ‘sipSignaling’, ‘stateChange’, ‘syslog’, ‘thresholdCrossingAlert’, ‘voiceQuality’ |
Ves::ObjectClasses::VesEvent::domain |
eventType |
String |
0..1 |
Preliminary OpenModelAttribute
|
For example: ‘applicationNf’, ‘guestOS’, ‘hostOS’, ‘platform’ |
Ves::ObjectClasses::VesEvent::eventType |
lastEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
the latest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds |
Ves::ObjectClasses::VesEvent::lastEpochMicrosec |
nfcNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function component type: 3 characters (aligned with vfc naming standards) |
Ves::ObjectClasses::VesEvent::nfcNamingCode |
nfNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function type: 4 characters (aligned with vnf and pnf naming standards) |
Ves::ObjectClasses::VesEvent::nfNamingCode |
nfVendorName |
String |
1 |
Preliminary OpenModelAttribute
|
Network function vendor name |
Ves::ObjectClasses::VesEvent::nfVendorName |
priority |
Priority |
1 |
Preliminary OpenModelAttribute
|
Processing priority enumeration: ‘High’, ‘Medium’, ‘Normal’, ‘Low’ |
Ves::ObjectClasses::VesEvent::priority |
reportingEntityId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See ‘reportingEntityName’ for more information. reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. |
Ves::ObjectClasses::VesEvent::reportingEntityId |
reportingEntityName |
String |
1 |
Preliminary OpenModelAttribute
|
reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. |
Ves::ObjectClasses::VesEvent::reportingEntityName |
sequence |
Integer |
1 |
Preliminary OpenModelAttribute
|
sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ordering of events communicated by an event source instance (or 0 if not needed) |
Ves::ObjectClasses::VesEvent::sequence |
sourceId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See ‘sourceName’ for more information. sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. |
Ves::ObjectClasses::VesEvent::sourceId |
sourceName |
String |
1 |
Preliminary OpenModelAttribute
|
Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. |
Ves::ObjectClasses::VesEvent::sourceName |
startingEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) |
Ves::ObjectClasses::VesEvent::startingEpochMicrosec |
timeZoneOffset |
String |
0..1 |
Preliminary OpenModelAttribute
|
Offset to GMT to indicate local time zone for device formatted as ‘UTC+/-hh:mm’; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples |
Ves::ObjectClasses::VesEvent::timeZoneOffset |
version |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the event header as “#.#” where # is a digit; see section 1 for the correct digits to use. |
Ves::ObjectClasses::VesEvent::version |
vesEventListenerVersion |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the ves event listener api spec that this event is compliant with (as “#” or “#.#” or “#.#.#” where # is a digit; see section 1 for the correct digits to use). |
Ves::ObjectClasses::VesEvent::vesEventListenerVersion |
name |
String |
1 |
Preliminary OpenModelAttribute
|
Ves::ObjectClasses::VesEvent::name |
|
Status |
String |
0..1 |
Preliminary OpenModelAttribute
|
The current condition of an interaction, such as open, in research, closed, and so forth |
Common::Business Interaction::ObjectClasses::BusinessInteraction::Status |
description |
String |
0..1 |
Preliminary OpenModelAttribute
|
Defines a textual free-form description of the object. |
Common::Root::RootObjectClasses::RootEntity::description |
id |
Identifier |
1 |
Preliminary OpenModelAttribute
|
Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. |
Common::Root::RootObjectClasses::RootEntity::id |
VoiceQuality
The voiceQuality class provides statistics related to customer facing voice products; consists of the following fields:
Parent class: VesEvent
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
additionalInformation |
HashMap |
0..1 |
Preliminary OpenModelAttribute
|
Additional voice quality fields |
Ves::ObjectClasses::VoiceQuality::additionalInformation |
calleeSideCodec |
String |
1 |
Preliminary OpenModelAttribute
|
Callee codec for the call |
Ves::ObjectClasses::VoiceQuality::calleeSideCodec |
callerSideCodec |
String |
1 |
Preliminary OpenModelAttribute
|
Caller codec for the call |
Ves::ObjectClasses::VoiceQuality::callerSideCodec |
correlator |
String |
1 |
Preliminary OpenModelAttribute
|
Constant across all events on this call |
Ves::ObjectClasses::VoiceQuality::correlator |
phoneNumber |
String |
0..1 |
Preliminary OpenModelAttribute
|
Phone number associated with the correlator |
Ves::ObjectClasses::VoiceQuality::phoneNumber |
midCallRtcp |
String |
1 |
Preliminary OpenModelAttribute
|
Base64 encoding of the binary RTCP data (excluding Eth/IP/UDP headers) |
Ves::ObjectClasses::VoiceQuality::midCallRtcp |
voiceQualityFieldsVersion |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the voiceQualityFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. |
Ves::ObjectClasses::VoiceQuality::voiceQualityFieldsVersion |
_endofcallvqmsummaries |
EndOfCallVqmSummaries |
0..1 |
Preliminary OpenModelAttribute
|
End of call voice quality metric summaries |
Ves::ObjectClasses::VoiceQuality::_endofcallvqmsummaries |
_vendornfnamefields |
VendorNfNameFields |
1 |
Preliminary OpenModelAttribute
|
Vendor, NF and nfModule names |
Ves::ObjectClasses::VoiceQuality::_vendornfnamefields |
domain |
Domain |
1 |
Experimental OpenModelAttribute
|
Update in definition only Event domain enumeration: ‘cmNotify’,’fault’, ‘heartbeat’, ‘measurement’, ‘mobileFlow’, ‘notification’, ‘other’, ‘pnfRegistration’, ‘sipSignaling’, ‘stateChange’, ‘syslog’, ‘thresholdCrossingAlert’, ‘voiceQuality’ |
Ves::ObjectClasses::VesEvent::domain |
eventType |
String |
0..1 |
Preliminary OpenModelAttribute
|
For example: ‘applicationNf’, ‘guestOS’, ‘hostOS’, ‘platform’ |
Ves::ObjectClasses::VesEvent::eventType |
lastEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
the latest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds |
Ves::ObjectClasses::VesEvent::lastEpochMicrosec |
nfcNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function component type: 3 characters (aligned with vfc naming standards) |
Ves::ObjectClasses::VesEvent::nfcNamingCode |
nfNamingCode |
String |
0..1 |
Preliminary OpenModelAttribute
|
Network function type: 4 characters (aligned with vnf and pnf naming standards) |
Ves::ObjectClasses::VesEvent::nfNamingCode |
nfVendorName |
String |
1 |
Preliminary OpenModelAttribute
|
Network function vendor name |
Ves::ObjectClasses::VesEvent::nfVendorName |
priority |
Priority |
1 |
Preliminary OpenModelAttribute
|
Processing priority enumeration: ‘High’, ‘Medium’, ‘Normal’, ‘Low’ |
Ves::ObjectClasses::VesEvent::priority |
reportingEntityId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See ‘reportingEntityName’ for more information. reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. |
Ves::ObjectClasses::VesEvent::reportingEntityId |
reportingEntityName |
String |
1 |
Preliminary OpenModelAttribute
|
reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. |
Ves::ObjectClasses::VesEvent::reportingEntityName |
sequence |
Integer |
1 |
Preliminary OpenModelAttribute
|
sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ordering of events communicated by an event source instance (or 0 if not needed) |
Ves::ObjectClasses::VesEvent::sequence |
sourceId |
String |
0..1 |
Preliminary OpenModelAttribute
|
UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See ‘sourceName’ for more information. sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. |
Ves::ObjectClasses::VesEvent::sourceId |
sourceName |
String |
1 |
Preliminary OpenModelAttribute
|
Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. |
Ves::ObjectClasses::VesEvent::sourceName |
startingEpochMicrosec |
Number |
1 |
Preliminary OpenModelAttribute
|
startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). the earliest unix time aka epoch time associated with the event from any component–as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) |
Ves::ObjectClasses::VesEvent::startingEpochMicrosec |
timeZoneOffset |
String |
0..1 |
Preliminary OpenModelAttribute
|
Offset to GMT to indicate local time zone for device formatted as ‘UTC+/-hh:mm’; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples |
Ves::ObjectClasses::VesEvent::timeZoneOffset |
version |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the event header as “#.#” where # is a digit; see section 1 for the correct digits to use. |
Ves::ObjectClasses::VesEvent::version |
vesEventListenerVersion |
String |
1 |
Preliminary OpenModelAttribute
|
Version of the ves event listener api spec that this event is compliant with (as “#” or “#.#” or “#.#.#” where # is a digit; see section 1 for the correct digits to use). |
Ves::ObjectClasses::VesEvent::vesEventListenerVersion |
name |
String |
1 |
Preliminary OpenModelAttribute
|
Ves::ObjectClasses::VesEvent::name |
|
Status |
String |
0..1 |
Preliminary OpenModelAttribute
|
The current condition of an interaction, such as open, in research, closed, and so forth |
Common::Business Interaction::ObjectClasses::BusinessInteraction::Status |
description |
String |
0..1 |
Preliminary OpenModelAttribute
|
Defines a textual free-form description of the object. |
Common::Root::RootObjectClasses::RootEntity::description |
id |
Identifier |
1 |
Preliminary OpenModelAttribute
|
Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. |
Common::Root::RootObjectClasses::RootEntity::id |
cmNotif
Applied stereotypes:
OpenModelClass
support: MANDATORY
Experimental
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
notificationType |
String |
0..1 |
OpenModelAttribute
|
Type of notification. This is an enum (managedObjectCreation, managedObjectDeletion, managedObjectAttributeValueChanged) |
Ves::Diagrams::cmNotif::notificationType |
dN |
String |
0..1 |
OpenModelAttribute
|
Managed Object Instance that is the subject of this notification. In 3GPP devices this is the Distinguished Name (DN) which is used to uniquely identify a MO within a name space as defined by ITU-T |
Ves::Diagrams::cmNotif::dN |
objectIdentiferType |
String |
0..1 |
OpenModelAttribute
|
Type of object identifier (Ynag, or ….) |
Ves::Diagrams::cmNotif::objectIdentiferType |
attributeList |
AttributeList |
1..* |
OpenModelAttribute
|
[R1] Attribute Name and values (attributeName(string), newAttributeValue(any type), oldAttributeValue(any type) [R2] This is Mandatory for notifyMOIAttributeValueChange. 3GPP defines it as options for Creation and Deletion. |
Ves::Diagrams::cmNotif::attributeList |
measInfoIdInteger
The measInfoIdInteger datatype provides an integer measurement group identifier;
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
iMeasInfoId |
Integer |
1 |
Preliminary OpenModelAttribute
|
Integer measurement group Identifier |
Ves::ObjectClasses::measInfoIdInteger::iMeasInfoId |
measResultNull
The measResultNull datatype provides a null 3GPP PM measurement result
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
Defined in |
p |
Integer |
1 |
Preliminary OpenModelAttribute
|
Integer reference to the counter |
Ves::ObjectClasses::measResultNull::p |
isNull |
Boolean |
1 |
Preliminary OpenModelAttribute
|
Enumeration: ‘true’ or ‘false’ The VES 7.1 Spec has this attribute as a string. |
Ves::ObjectClasses::measResultNull::isNull |