diff options
Diffstat (limited to 'docs/ONAP Model Spec/im/VES/VES-class-2.rst')
| -rw-r--r-- | docs/ONAP Model Spec/im/VES/VES-class-2.rst | 7644 |
1 files changed, 2896 insertions, 4748 deletions
diff --git a/docs/ONAP Model Spec/im/VES/VES-class-2.rst b/docs/ONAP Model Spec/im/VES/VES-class-2.rst index 9711f8b..c32ff53 100644 --- a/docs/ONAP Model Spec/im/VES/VES-class-2.rst +++ b/docs/ONAP Model Spec/im/VES/VES-class-2.rst @@ -1,4 +1,4 @@ -.. Copyright 2019 +.. Copyright 2021 .. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE .. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode @@ -9,4911 +9,3059 @@ VES Class Definition - part 2 :depth: 3 .. -Notification class -^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::Notification - -**Description:** +Notification +~~~~~~~~~~~~ Fields specific to notification events **Parent class:** VesEvent -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class Notification** - -========================= ============ ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -========================= ============ ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== -additionalFields HashMap 0..1 Additional notification fields if needed. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -arrayOfNamedHashMap NamedHashMap 0..1 arrayOfNamedHashMap - Array of named hashMaps OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -changeContact String 0..1 Identifier for a contact related to the change. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -changeIdentifier String 1 System or session identifier associated with the change. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -changeType String 1 Describes what has changed for the entity, for example: configuration changed, capability added, capability removed… OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -newState String 0..1 New state of the entity, for example: 'inService', 'maintenance', 'outOfService' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -notificationFieldsVersion Number 1 Version of the notificationFields block as "#.#" where # is a digit; see section 1 for the correct digits to use. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -oldState String 0..1 Previous state of the entity. OpenModelAttribute - For example: "inService", "outOfService", "maintenance" - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -stateInterface String 0..\* Card or port name of the entity that changed state. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -domain Domain 1 Event domain enumeration: 'fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -eventType String 0..1 For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -lastEpochMicrosec Number 1 the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfcNamingCode String 0..1 Network function component type: 3 characters (aligned with vfc naming standards) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfNamingCode String 0..1 Network function type: 4 characters (aligned with vnf and pnf naming standards) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfVendorName String 1 Network function vendor name OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -priority Priority 1 Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -reportingEntityId String 0..1 UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See 'reportingEntityName' for more information. OpenModelAttribute - - | reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. - partOfObjectKey: 0 - | Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -reportingEntityName String 1 Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. OpenModelAttribute - - reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sequence Integer 1 sequence - Ordering of events communicated by an event source instance (or 0 if not needed) OpenModelAttribute - - Ordering of events communicated by an event source instance (or 0 if not needed) - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sourceId String 0..1 | sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity OpenModelAttribute - | Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. - - partOfObjectKey: 0 - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See 'sourceName' for more information. - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sourceName String 1 sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. OpenModelAttribute - - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -startingEpochMicrosec Number 1 the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) OpenModelAttribute - - | startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). - partOfObjectKey: 0 - | For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -timeZoneOffset String 0..1 Offset to GMT to indicate local time zone for device formatted as 'UTC+/-hh:mm'; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -version String 1 Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -vesEventListenerVersion String 1 Version of the ves event listener api spec that this event is compliant with (as "#" or "#.#" or "#.#.#" where # is a digit; see section 1 for the correct digits to use). OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -name String 1 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -Status String 0..1 The current condition of an interaction, such as open, in research, closed, and so forth OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -description String 0..1 Defines a textual free-form description of the object. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -id Identifier 1 Identifier of this information element. This attribute shall be globally unique. OpenModelAttribute - - Unambiguously distinguishes different object instances. It is the naming attribute of the object. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -========================= ============ ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== - -Other class -^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::Other - -**Description:** +========================= ============ ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +additionalFields HashMap 0..1 Preliminary Additional notification fields if needed. Ves::ObjectClasses::Notification::additionalFields + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +arrayOfNamedHashMap NamedHashMap 0..1 Preliminary arrayOfNamedHashMap - Array of named hashMaps Ves::ObjectClasses::Notification::arrayOfNamedHashMap + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +changeContact String 0..1 Preliminary Identifier for a contact related to the change. Ves::ObjectClasses::Notification::changeContact + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +changeIdentifier String 1 Preliminary System or session identifier associated with the change. Ves::ObjectClasses::Notification::changeIdentifier + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +changeType String 1 Preliminary Describes what has changed for the entity, for example: configuration changed, capability added, capability removed… Ves::ObjectClasses::Notification::changeType + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +newState String 0..1 Preliminary New state of the entity, for example: 'inService', 'maintenance', 'outOfService' Ves::ObjectClasses::Notification::newState + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +notificationFieldsVersion Number 1 Preliminary Version of the notificationFields block as "#.#" where # is a digit; see section 1 for the correct digits to use. Ves::ObjectClasses::Notification::notificationFieldsVersion + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +oldState String 0..1 Preliminary Previous state of the entity. Ves::ObjectClasses::Notification::oldState + For example: "inService", "outOfService", "maintenance" + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +stateInterface String 0..\* Preliminary Card or port name of the entity that changed state. Ves::ObjectClasses::Notification::stateInterface + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +domain Domain 1 Experimental Update in definition only Ves::ObjectClasses::VesEvent::domain + + OpenModelAttribute Event domain enumeration: 'cmNotify','fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +eventType String 0..1 Preliminary For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' Ves::ObjectClasses::VesEvent::eventType + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +lastEpochMicrosec Number 1 Preliminary the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds Ves::ObjectClasses::VesEvent::lastEpochMicrosec + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfcNamingCode String 0..1 Preliminary Network function component type: 3 characters (aligned with vfc naming standards) Ves::ObjectClasses::VesEvent::nfcNamingCode + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfNamingCode String 0..1 Preliminary Network function type: 4 characters (aligned with vnf and pnf naming standards) Ves::ObjectClasses::VesEvent::nfNamingCode + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfVendorName String 1 Preliminary Network function vendor name Ves::ObjectClasses::VesEvent::nfVendorName + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +priority Priority 1 Preliminary Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' Ves::ObjectClasses::VesEvent::priority + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +reportingEntityId String 0..1 Preliminary UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See 'reportingEntityName' for more information. Ves::ObjectClasses::VesEvent::reportingEntityId + + OpenModelAttribute reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. + Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +reportingEntityName String 1 Preliminary reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. Ves::ObjectClasses::VesEvent::reportingEntityName + + OpenModelAttribute Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sequence Integer 1 Preliminary sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ves::ObjectClasses::VesEvent::sequence + + OpenModelAttribute Ordering of events communicated by an event source instance (or 0 if not needed) + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sourceId String 0..1 Preliminary UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See 'sourceName' for more information. Ves::ObjectClasses::VesEvent::sourceId + + OpenModelAttribute sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity + Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sourceName String 1 Preliminary Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. Ves::ObjectClasses::VesEvent::sourceName + + OpenModelAttribute sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +startingEpochMicrosec Number 1 Preliminary startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). Ves::ObjectClasses::VesEvent::startingEpochMicrosec + For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). + OpenModelAttribute + the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +timeZoneOffset String 0..1 Preliminary Offset to GMT to indicate local time zone for device formatted as 'UTC+/-hh:mm'; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples Ves::ObjectClasses::VesEvent::timeZoneOffset + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +version String 1 Preliminary Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. Ves::ObjectClasses::VesEvent::version + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +vesEventListenerVersion String 1 Preliminary Version of the ves event listener api spec that this event is compliant with (as "#" or "#.#" or "#.#.#" where # is a digit; see section 1 for the correct digits to use). Ves::ObjectClasses::VesEvent::vesEventListenerVersion + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +name String 1 Preliminary Ves::ObjectClasses::VesEvent::name + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +Status String 0..1 Preliminary The current condition of an interaction, such as open, in research, closed, and so forth Common::Business Interaction::ObjectClasses::BusinessInteraction::Status + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +description String 0..1 Preliminary Defines a textual free-form description of the object. Common::Root::RootObjectClasses::RootEntity::description + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +id Identifier 1 Preliminary Identifier of this information element. This attribute shall be globally unique. Common::Root::RootObjectClasses::RootEntity::id + + OpenModelAttribute Unambiguously distinguishes different object instances. It is the naming attribute of the object. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +========================= ============ ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== + +Other +~~~~~ The otherFields datatype defines fields for events belonging to the 'other' domain of the commonEventHeader domain enumeration. **Parent class:** VesEvent -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class Other** - -======================= =================== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -======================= =================== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== -arrayofNamedHashMap ArrayofNamedHashMap 0..\* Array of named hashMaps OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -hashMap HashMap 0..1 Array of name-value pairs. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -schemaObjects ArrayOfSchemaObject 0..1 Array of schema objects described by name, schema and other meta-information. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -otherFieldsVersion String 1 Version of the otherFields block as "#.#" where # is a digit; see section 1 for the correct digits to use. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -domain Domain 1 Event domain enumeration: 'fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -eventType String 0..1 For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -lastEpochMicrosec Number 1 the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfcNamingCode String 0..1 Network function component type: 3 characters (aligned with vfc naming standards) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfNamingCode String 0..1 Network function type: 4 characters (aligned with vnf and pnf naming standards) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfVendorName String 1 Network function vendor name OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -priority Priority 1 Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -reportingEntityId String 0..1 UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See 'reportingEntityName' for more information. OpenModelAttribute - - | reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. - partOfObjectKey: 0 - | Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -reportingEntityName String 1 Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. OpenModelAttribute - - reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sequence Integer 1 sequence - Ordering of events communicated by an event source instance (or 0 if not needed) OpenModelAttribute - - Ordering of events communicated by an event source instance (or 0 if not needed) - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sourceId String 0..1 | sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity OpenModelAttribute - | Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. - - partOfObjectKey: 0 - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See 'sourceName' for more information. - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sourceName String 1 sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. OpenModelAttribute - - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -startingEpochMicrosec Number 1 the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) OpenModelAttribute - - | startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). - partOfObjectKey: 0 - | For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -timeZoneOffset String 0..1 Offset to GMT to indicate local time zone for device formatted as 'UTC+/-hh:mm'; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -version String 1 Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -vesEventListenerVersion String 1 Version of the ves event listener api spec that this event is compliant with (as "#" or "#.#" or "#.#.#" where # is a digit; see section 1 for the correct digits to use). OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -name String 1 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -Status String 0..1 The current condition of an interaction, such as open, in research, closed, and so forth OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -description String 0..1 Defines a textual free-form description of the object. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -id Identifier 1 Identifier of this information element. This attribute shall be globally unique. OpenModelAttribute - - Unambiguously distinguishes different object instances. It is the naming attribute of the object. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -======================= =================== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== - -Perf3gpp class -^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::Perf3gpp +======================= =================== ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +arrayofNamedHashMap ArrayofNamedHashMap 0..\* Preliminary Array of named hashMaps Ves::ObjectClasses::Other::arrayofNamedHashMap + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +hashMap HashMap 0..1 Preliminary Array of name-value pairs. Ves::ObjectClasses::Other::hashMap + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +schemaObjects ArrayOfSchemaObject 0..1 Preliminary Array of schema objects described by name, schema and other meta-information. Ves::ObjectClasses::Other::schemaObjects + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +otherFieldsVersion String 1 Preliminary Version of the otherFields block as "#.#" where # is a digit; see section 1 for the correct digits to use. Ves::ObjectClasses::Other::otherFieldsVersion + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +domain Domain 1 Experimental Update in definition only Ves::ObjectClasses::VesEvent::domain + + OpenModelAttribute Event domain enumeration: 'cmNotify','fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +eventType String 0..1 Preliminary For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' Ves::ObjectClasses::VesEvent::eventType + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +lastEpochMicrosec Number 1 Preliminary the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds Ves::ObjectClasses::VesEvent::lastEpochMicrosec + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfcNamingCode String 0..1 Preliminary Network function component type: 3 characters (aligned with vfc naming standards) Ves::ObjectClasses::VesEvent::nfcNamingCode + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfNamingCode String 0..1 Preliminary Network function type: 4 characters (aligned with vnf and pnf naming standards) Ves::ObjectClasses::VesEvent::nfNamingCode + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfVendorName String 1 Preliminary Network function vendor name Ves::ObjectClasses::VesEvent::nfVendorName + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +priority Priority 1 Preliminary Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' Ves::ObjectClasses::VesEvent::priority + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +reportingEntityId String 0..1 Preliminary UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See 'reportingEntityName' for more information. Ves::ObjectClasses::VesEvent::reportingEntityId + + OpenModelAttribute reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. + Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +reportingEntityName String 1 Preliminary reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. Ves::ObjectClasses::VesEvent::reportingEntityName + + OpenModelAttribute Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sequence Integer 1 Preliminary sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ves::ObjectClasses::VesEvent::sequence + + OpenModelAttribute Ordering of events communicated by an event source instance (or 0 if not needed) + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sourceId String 0..1 Preliminary UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See 'sourceName' for more information. Ves::ObjectClasses::VesEvent::sourceId + + OpenModelAttribute sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity + Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sourceName String 1 Preliminary Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. Ves::ObjectClasses::VesEvent::sourceName + + OpenModelAttribute sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +startingEpochMicrosec Number 1 Preliminary startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). Ves::ObjectClasses::VesEvent::startingEpochMicrosec + For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). + OpenModelAttribute + the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +timeZoneOffset String 0..1 Preliminary Offset to GMT to indicate local time zone for device formatted as 'UTC+/-hh:mm'; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples Ves::ObjectClasses::VesEvent::timeZoneOffset + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +version String 1 Preliminary Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. Ves::ObjectClasses::VesEvent::version + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +vesEventListenerVersion String 1 Preliminary Version of the ves event listener api spec that this event is compliant with (as "#" or "#.#" or "#.#.#" where # is a digit; see section 1 for the correct digits to use). Ves::ObjectClasses::VesEvent::vesEventListenerVersion + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +name String 1 Preliminary Ves::ObjectClasses::VesEvent::name + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +Status String 0..1 Preliminary The current condition of an interaction, such as open, in research, closed, and so forth Common::Business Interaction::ObjectClasses::BusinessInteraction::Status + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +description String 0..1 Preliminary Defines a textual free-form description of the object. Common::Root::RootObjectClasses::RootEntity::description + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +id Identifier 1 Preliminary Identifier of this information element. This attribute shall be globally unique. Common::Root::RootObjectClasses::RootEntity::id + + OpenModelAttribute Unambiguously distinguishes different object instances. It is the naming attribute of the object. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +======================= =================== ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== + +Perf3gpp +~~~~~~~~ **Parent class:** VesEvent -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class Perf3gpp** - -======================= ================== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -======================= ================== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== -eventAddlFields HashMap 0..1 Additional key-value pairs if needed OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -perf3gppFieldsVersion String 1 Version of the perf3gpp event OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -\_measDataCollection MeasDataCollection 1 3GPP measurement collection structure OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -domain Domain 1 Event domain enumeration: 'fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -eventType String 0..1 For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -lastEpochMicrosec Number 1 the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfcNamingCode String 0..1 Network function component type: 3 characters (aligned with vfc naming standards) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfNamingCode String 0..1 Network function type: 4 characters (aligned with vnf and pnf naming standards) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfVendorName String 1 Network function vendor name OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -priority Priority 1 Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -reportingEntityId String 0..1 UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See 'reportingEntityName' for more information. OpenModelAttribute - - | reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. - partOfObjectKey: 0 - | Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -reportingEntityName String 1 Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. OpenModelAttribute - - reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sequence Integer 1 sequence - Ordering of events communicated by an event source instance (or 0 if not needed) OpenModelAttribute - - Ordering of events communicated by an event source instance (or 0 if not needed) - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sourceId String 0..1 | sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity OpenModelAttribute - | Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. - - partOfObjectKey: 0 - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See 'sourceName' for more information. - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sourceName String 1 sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. OpenModelAttribute - - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -startingEpochMicrosec Number 1 the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) OpenModelAttribute - - | startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). - partOfObjectKey: 0 - | For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -timeZoneOffset String 0..1 Offset to GMT to indicate local time zone for device formatted as 'UTC+/-hh:mm'; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -version String 1 Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -vesEventListenerVersion String 1 Version of the ves event listener api spec that this event is compliant with (as "#" or "#.#" or "#.#.#" where # is a digit; see section 1 for the correct digits to use). OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -name String 1 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -Status String 0..1 The current condition of an interaction, such as open, in research, closed, and so forth OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -description String 0..1 Defines a textual free-form description of the object. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -id Identifier 1 Identifier of this information element. This attribute shall be globally unique. OpenModelAttribute - - Unambiguously distinguishes different object instances. It is the naming attribute of the object. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -======================= ================== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== - -PnfRegistration class -^^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::PnfRegistration - -**Description:** +======================= ================== ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +eventAddlFields HashMap 0..1 Preliminary Additional key-value pairs if needed Ves::ObjectClasses::Perf3gpp::eventAddlFields + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +perf3gppFieldsVersion String 1 Preliminary Version of the perf3gpp event Ves::ObjectClasses::Perf3gpp::perf3gppFieldsVersion + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_measDataCollection MeasDataCollection 1 Preliminary 3GPP measurement collection structure Ves::ObjectClasses::Perf3gpp::_measDataCollection + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +domain Domain 1 Experimental Update in definition only Ves::ObjectClasses::VesEvent::domain + + OpenModelAttribute Event domain enumeration: 'cmNotify','fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +eventType String 0..1 Preliminary For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' Ves::ObjectClasses::VesEvent::eventType + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +lastEpochMicrosec Number 1 Preliminary the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds Ves::ObjectClasses::VesEvent::lastEpochMicrosec + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfcNamingCode String 0..1 Preliminary Network function component type: 3 characters (aligned with vfc naming standards) Ves::ObjectClasses::VesEvent::nfcNamingCode + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfNamingCode String 0..1 Preliminary Network function type: 4 characters (aligned with vnf and pnf naming standards) Ves::ObjectClasses::VesEvent::nfNamingCode + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfVendorName String 1 Preliminary Network function vendor name Ves::ObjectClasses::VesEvent::nfVendorName + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +priority Priority 1 Preliminary Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' Ves::ObjectClasses::VesEvent::priority + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +reportingEntityId String 0..1 Preliminary UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See 'reportingEntityName' for more information. Ves::ObjectClasses::VesEvent::reportingEntityId + + OpenModelAttribute reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. + Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +reportingEntityName String 1 Preliminary reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. Ves::ObjectClasses::VesEvent::reportingEntityName + + OpenModelAttribute Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sequence Integer 1 Preliminary sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ves::ObjectClasses::VesEvent::sequence + + OpenModelAttribute Ordering of events communicated by an event source instance (or 0 if not needed) + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sourceId String 0..1 Preliminary UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See 'sourceName' for more information. Ves::ObjectClasses::VesEvent::sourceId + + OpenModelAttribute sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity + Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sourceName String 1 Preliminary Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. Ves::ObjectClasses::VesEvent::sourceName + + OpenModelAttribute sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +startingEpochMicrosec Number 1 Preliminary startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). Ves::ObjectClasses::VesEvent::startingEpochMicrosec + For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). + OpenModelAttribute + the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +timeZoneOffset String 0..1 Preliminary Offset to GMT to indicate local time zone for device formatted as 'UTC+/-hh:mm'; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples Ves::ObjectClasses::VesEvent::timeZoneOffset + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +version String 1 Preliminary Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. Ves::ObjectClasses::VesEvent::version + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +vesEventListenerVersion String 1 Preliminary Version of the ves event listener api spec that this event is compliant with (as "#" or "#.#" or "#.#.#" where # is a digit; see section 1 for the correct digits to use). Ves::ObjectClasses::VesEvent::vesEventListenerVersion + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +name String 1 Preliminary Ves::ObjectClasses::VesEvent::name + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +Status String 0..1 Preliminary The current condition of an interaction, such as open, in research, closed, and so forth Common::Business Interaction::ObjectClasses::BusinessInteraction::Status + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +description String 0..1 Preliminary Defines a textual free-form description of the object. Common::Root::RootObjectClasses::RootEntity::description + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +id Identifier 1 Preliminary Identifier of this information element. This attribute shall be globally unique. Common::Root::RootObjectClasses::RootEntity::id + + OpenModelAttribute Unambiguously distinguishes different object instances. It is the naming attribute of the object. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +======================= ================== ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== + +PnfRegistration +~~~~~~~~~~~~~~~ The pnfRegistrationFields datatype defines fields for events belonging to the 'pnfRegistration' domain of the commonEventHeader domain enumeration; it consists of the following fields: **Parent class:** VesEvent -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class PnfRegistration** - -============================ ========== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -============================ ========== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== -additionalFields HashMap 0..1 Additional pnfRegistration fields if needed OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -lastServiceDate String 0..1 TS 32.692 dateOfLastService = date of last service; e.g. 15022017 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -macAddress String 0..1 MAC address of OAM interface of the unit OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -manufactureDate String 0..1 TS 32.692 dateOfManufacture = manufacture date of the unit; 24032016 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -modelNumber String 0..1 TS 32.692 versionNumber = version of the unit from vendor; e.g. AJ02. Maps to AAI equip-model OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -oamV4lpAddress String 0..1 IPv4 m-plane IP address to be used by the manager to contact the PNF OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -oamV6lpAddress String 0..1 IPv6 m-plane IP address to be used by the manager to contact the PNF OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -pnfRegistrationFieldsVersion String 1 Version of the registrationFields block as "#.#" where # is a digit; see section 1 for the correct digits to use. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -serialNumber String 0..1 TS 32.692 serialNumber = serial number of the unit; e.g. 6061ZW3 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -softwareVersion String 0..1 TS 32.692 swName = active SW running on the unit; e.g. 5gDUv18.05.201 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -unitFamily String 0..1 TS 32.692 vendorUnitFamilyType = general type of HW unit; e.g. BBU OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -unitType String 0..1 TS 32.692 vendorUnitTypeNumber = vendor name for the unit; e.g. Airscale OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -vendorName String 0..1 TS 32.692 vendorName = name of manufacturer; e.g. Nokia. Maps to AAI equip-vendor OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -domain Domain 1 Event domain enumeration: 'fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -eventType String 0..1 For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -lastEpochMicrosec Number 1 the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfcNamingCode String 0..1 Network function component type: 3 characters (aligned with vfc naming standards) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfNamingCode String 0..1 Network function type: 4 characters (aligned with vnf and pnf naming standards) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfVendorName String 1 Network function vendor name OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -priority Priority 1 Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -reportingEntityId String 0..1 UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See 'reportingEntityName' for more information. OpenModelAttribute - - | reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. - partOfObjectKey: 0 - | Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -reportingEntityName String 1 Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. OpenModelAttribute - - reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sequence Integer 1 sequence - Ordering of events communicated by an event source instance (or 0 if not needed) OpenModelAttribute - - Ordering of events communicated by an event source instance (or 0 if not needed) - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sourceId String 0..1 | sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity OpenModelAttribute - | Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. - - partOfObjectKey: 0 - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See 'sourceName' for more information. - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sourceName String 1 sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. OpenModelAttribute - - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -startingEpochMicrosec Number 1 the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) OpenModelAttribute - - | startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). - partOfObjectKey: 0 - | For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -timeZoneOffset String 0..1 Offset to GMT to indicate local time zone for device formatted as 'UTC+/-hh:mm'; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -version String 1 Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -vesEventListenerVersion String 1 Version of the ves event listener api spec that this event is compliant with (as "#" or "#.#" or "#.#.#" where # is a digit; see section 1 for the correct digits to use). OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -name String 1 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -Status String 0..1 The current condition of an interaction, such as open, in research, closed, and so forth OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -description String 0..1 Defines a textual free-form description of the object. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -id Identifier 1 Identifier of this information element. This attribute shall be globally unique. OpenModelAttribute - - Unambiguously distinguishes different object instances. It is the naming attribute of the object. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -============================ ========== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== - -ProcessStats class -^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::ProcessStats - -**Description:** +============================ ========== ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +additionalFields HashMap 0..1 Preliminary Additional pnfRegistration fields if needed Ves::ObjectClasses::PnfRegistration::additionalFields + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +lastServiceDate String 0..1 Preliminary TS 32.692 dateOfLastService = date of last service; e.g. 15022017 Ves::ObjectClasses::PnfRegistration::lastServiceDate + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +macAddress String 0..1 Preliminary MAC address of OAM interface of the unit Ves::ObjectClasses::PnfRegistration::macAddress + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +manufactureDate String 0..1 Preliminary TS 32.692 dateOfManufacture = manufacture date of the unit; 24032016 Ves::ObjectClasses::PnfRegistration::manufactureDate + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +modelNumber String 0..1 Preliminary TS 32.692 versionNumber = version of the unit from vendor; e.g. AJ02. Maps to AAI equip-model Ves::ObjectClasses::PnfRegistration::modelNumber + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +oamV4lpAddress String 0..1 Preliminary IPv4 m-plane IP address to be used by the manager to contact the PNF Ves::ObjectClasses::PnfRegistration::oamV4lpAddress + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +oamV6lpAddress String 0..1 Preliminary IPv6 m-plane IP address to be used by the manager to contact the PNF Ves::ObjectClasses::PnfRegistration::oamV6lpAddress + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +pnfRegistrationFieldsVersion String 1 Preliminary Version of the registrationFields block as "#.#" where # is a digit; see section 1 for the correct digits to use. Ves::ObjectClasses::PnfRegistration::pnfRegistrationFieldsVersion + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +serialNumber String 0..1 Preliminary TS 32.692 serialNumber = serial number of the unit; e.g. 6061ZW3 Ves::ObjectClasses::PnfRegistration::serialNumber + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +softwareVersion String 0..1 Preliminary TS 32.692 swName = active SW running on the unit; e.g. 5gDUv18.05.201 Ves::ObjectClasses::PnfRegistration::softwareVersion + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +unitFamily String 0..1 Preliminary TS 32.692 vendorUnitFamilyType = general type of HW unit; e.g. BBU Ves::ObjectClasses::PnfRegistration::unitFamily + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +unitType String 0..1 Preliminary TS 32.692 vendorUnitTypeNumber = vendor name for the unit; e.g. Airscale Ves::ObjectClasses::PnfRegistration::unitType + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +vendorName String 0..1 Preliminary TS 32.692 vendorName = name of manufacturer; e.g. Nokia. Maps to AAI equip-vendor Ves::ObjectClasses::PnfRegistration::vendorName + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +domain Domain 1 Experimental Update in definition only Ves::ObjectClasses::VesEvent::domain + + OpenModelAttribute Event domain enumeration: 'cmNotify','fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +eventType String 0..1 Preliminary For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' Ves::ObjectClasses::VesEvent::eventType + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +lastEpochMicrosec Number 1 Preliminary the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds Ves::ObjectClasses::VesEvent::lastEpochMicrosec + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfcNamingCode String 0..1 Preliminary Network function component type: 3 characters (aligned with vfc naming standards) Ves::ObjectClasses::VesEvent::nfcNamingCode + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfNamingCode String 0..1 Preliminary Network function type: 4 characters (aligned with vnf and pnf naming standards) Ves::ObjectClasses::VesEvent::nfNamingCode + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfVendorName String 1 Preliminary Network function vendor name Ves::ObjectClasses::VesEvent::nfVendorName + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +priority Priority 1 Preliminary Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' Ves::ObjectClasses::VesEvent::priority + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +reportingEntityId String 0..1 Preliminary UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See 'reportingEntityName' for more information. Ves::ObjectClasses::VesEvent::reportingEntityId + + OpenModelAttribute reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. + Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +reportingEntityName String 1 Preliminary reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. Ves::ObjectClasses::VesEvent::reportingEntityName + + OpenModelAttribute Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sequence Integer 1 Preliminary sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ves::ObjectClasses::VesEvent::sequence + + OpenModelAttribute Ordering of events communicated by an event source instance (or 0 if not needed) + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sourceId String 0..1 Preliminary UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See 'sourceName' for more information. Ves::ObjectClasses::VesEvent::sourceId + + OpenModelAttribute sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity + Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sourceName String 1 Preliminary Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. Ves::ObjectClasses::VesEvent::sourceName + + OpenModelAttribute sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +startingEpochMicrosec Number 1 Preliminary startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). Ves::ObjectClasses::VesEvent::startingEpochMicrosec + For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). + OpenModelAttribute + the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +timeZoneOffset String 0..1 Preliminary Offset to GMT to indicate local time zone for device formatted as 'UTC+/-hh:mm'; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples Ves::ObjectClasses::VesEvent::timeZoneOffset + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +version String 1 Preliminary Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. Ves::ObjectClasses::VesEvent::version + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +vesEventListenerVersion String 1 Preliminary Version of the ves event listener api spec that this event is compliant with (as "#" or "#.#" or "#.#.#" where # is a digit; see section 1 for the correct digits to use). Ves::ObjectClasses::VesEvent::vesEventListenerVersion + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +name String 1 Preliminary Ves::ObjectClasses::VesEvent::name + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +Status String 0..1 Preliminary The current condition of an interaction, such as open, in research, closed, and so forth Common::Business Interaction::ObjectClasses::BusinessInteraction::Status + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +description String 0..1 Preliminary Defines a textual free-form description of the object. Common::Root::RootObjectClasses::RootEntity::description + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +id Identifier 1 Preliminary Identifier of this information element. This attribute shall be globally unique. Common::Root::RootObjectClasses::RootEntity::id + + OpenModelAttribute Unambiguously distinguishes different object instances. It is the naming attribute of the object. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +============================ ========== ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== + +ProcessStats +~~~~~~~~~~~~ The processStats datatype provides metrics on system processes; it consists of the following fields: -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class ProcessStats** - -================== ======== ========= =================================================== ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -================== ======== ========= =================================================== ===================== -forkRate Number 0..1 The number of threads created since the last reboot OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -processIdentifier String 1 processIdentifier OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -psStateBlocked Number 0..1 The number of processes in a blocked state OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -psStatePaging Number 0..1 The number of processes in a paging state OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -psStateRunning Number 0..1 The number of processes in a running state OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -psStateSleeping Number 0..1 The number of processes in a sleeping state OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -PsStateStopped Number 0..1 The number of processes in a stopped state OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -psStateZombie Number 0..1 The number of processes in a zombie state OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -================== ======== ========= =================================================== ===================== - -ProcessorDimmAggregateThermalMargin class -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::ProcessorDimmAggregateThermalMargin - -**Description:** +================== ======== ========= ================================== =================================================== =================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +forkRate Number 0..1 Preliminary The number of threads created since the last reboot Ves::ObjectClasses::ProcessStats::forkRate + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +processIdentifier String 1 Preliminary processIdentifier Ves::ObjectClasses::ProcessStats::processIdentifier + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +psStateBlocked Number 0..1 Preliminary The number of processes in a blocked state Ves::ObjectClasses::ProcessStats::psStateBlocked + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +psStatePaging Number 0..1 Preliminary The number of processes in a paging state Ves::ObjectClasses::ProcessStats::psStatePaging + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +psStateRunning Number 0..1 Preliminary The number of processes in a running state Ves::ObjectClasses::ProcessStats::psStateRunning + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +psStateSleeping Number 0..1 Preliminary The number of processes in a sleeping state Ves::ObjectClasses::ProcessStats::psStateSleeping + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +PsStateStopped Number 0..1 Preliminary The number of processes in a stopped state Ves::ObjectClasses::ProcessStats::PsStateStopped + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +psStateZombie Number 0..1 Preliminary The number of processes in a zombie state Ves::ObjectClasses::ProcessStats::psStateZombie + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= ================================== =================================================== =================================================== + +ProcessorDimmAggregateThermalMargin +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The processorDimmAggregateThermalMargin datatype provides intelligent platform management interface (ipmi) processor dual inline memory module aggregate thermal margin metrics; it consists of the following fields: -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class ProcessorDimmAggregateThermalMargin** - -============================================== ======== ========= ========================================================================================================================= ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -============================================== ======== ========= ========================================================================================================================= ===================== -processorDimmAggregateThermal MarginIdentifier String 1 identifier for the aggregate thermal margin metrics from the processor dual inline memory module OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -thermalMargin Number 1 the difference between the DIMM's current temperature, in celsius, and the DIMM's throttling thermal trip point OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -============================================== ======== ========= ========================================================================================================================= ===================== - -SipSignaling class -^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::SipSignaling - -**Description:** +============================================== ======== ========= ================================== =============================================================================================================== ======================================================================================================= +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +processorDimmAggregateThermal MarginIdentifier String 1 Preliminary identifier for the aggregate thermal margin metrics from the processor dual inline memory module Ves::ObjectClasses::ProcessorDimmAggregateThermalMargin::processorDimmAggregateThermal MarginIdentifier + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +thermalMargin Number 1 Preliminary the difference between the DIMM's current temperature, in celsius, and the DIMM's throttling thermal trip point Ves::ObjectClasses::ProcessorDimmAggregateThermalMargin::thermalMargin + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +============================================== ======== ========= ================================== =============================================================================================================== ======================================================================================================= + +SipSignaling +~~~~~~~~~~~~ sipSignalingFields - The sipSignalingFields datatype communicates information about SIP signaling messages, parameters and signaling state. **Parent class:** VesEvent -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class SipSignaling** - -========================== ================== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -========================== ================== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== -additionalInformation HashMap 0..1 zdditionalInformation - Additional sipSignalling fields. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -compressedSip String 0..1 compressedSip - The full SIP request/response including headers and bodies. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -correlator String 1 correlator - Constant across all events on this call. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -localipAddress String 1 localIpAddress - IP address on VNF. OpenModelAttribute - Note: current data type (String) may be changed to Common Resource Datatype L3AddressData. =[gh]= - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -localPort String 1 localPort - Port on VNF. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -remoteipAddress String 1 remoteIpAddress - IP address of peer endpoint. OpenModelAttribute - Note: current data type (String) may be changed to Common Resource Datatype L3AddressData. =[gh]= - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -remotePort String 1 remotePort - Port of peer endpoint OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sipSignaliingFieldsVersion String 1 sipSignalingFieldsVersion - Version of the sipSignalingFields block as "#.#" where # is a digit; see section 1 for the correct digits to use. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -summarySip String 0..1 summarySip - The SIP Method or Response ('INVITE', '200 OK', 'BYE', etc). OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -\_vendorNfnamefields VendorNfNameFields 1 Vendor, NF and nfModule names OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -domain Domain 1 Event domain enumeration: 'fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -eventType String 0..1 For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -lastEpochMicrosec Number 1 the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfcNamingCode String 0..1 Network function component type: 3 characters (aligned with vfc naming standards) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfNamingCode String 0..1 Network function type: 4 characters (aligned with vnf and pnf naming standards) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfVendorName String 1 Network function vendor name OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -priority Priority 1 Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -reportingEntityId String 0..1 UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See 'reportingEntityName' for more information. OpenModelAttribute - - | reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. - partOfObjectKey: 0 - | Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -reportingEntityName String 1 Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. OpenModelAttribute - - reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sequence Integer 1 sequence - Ordering of events communicated by an event source instance (or 0 if not needed) OpenModelAttribute - - Ordering of events communicated by an event source instance (or 0 if not needed) - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sourceId String 0..1 | sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity OpenModelAttribute - | Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. - - partOfObjectKey: 0 - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See 'sourceName' for more information. - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sourceName String 1 sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. OpenModelAttribute - - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -startingEpochMicrosec Number 1 the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) OpenModelAttribute - - | startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). - partOfObjectKey: 0 - | For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -timeZoneOffset String 0..1 Offset to GMT to indicate local time zone for device formatted as 'UTC+/-hh:mm'; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -version String 1 Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -vesEventListenerVersion String 1 Version of the ves event listener api spec that this event is compliant with (as "#" or "#.#" or "#.#.#" where # is a digit; see section 1 for the correct digits to use). OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -name String 1 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -Status String 0..1 The current condition of an interaction, such as open, in research, closed, and so forth OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -description String 0..1 Defines a textual free-form description of the object. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -id Identifier 1 Identifier of this information element. This attribute shall be globally unique. OpenModelAttribute - - Unambiguously distinguishes different object instances. It is the naming attribute of the object. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -========================== ================== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== - -StateChange class -^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::StateChange - -**Description:** +========================== ================== ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +additionalInformation HashMap 0..1 Preliminary zdditionalInformation - Additional sipSignalling fields. Ves::ObjectClasses::SipSignaling::additionalInformation + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +compressedSip String 0..1 Preliminary compressedSip - The full SIP request/response including headers and bodies. Ves::ObjectClasses::SipSignaling::compressedSip + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +correlator String 1 Preliminary correlator - Constant across all events on this call. Ves::ObjectClasses::SipSignaling::correlator + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +localipAddress String 1 Preliminary localIpAddress - IP address on VNF. Ves::ObjectClasses::SipSignaling::localipAddress + Note: current data type (String) may be changed to Common Resource Datatype L3AddressData. =[gh]= + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +localPort String 1 Preliminary localPort - Port on VNF. Ves::ObjectClasses::SipSignaling::localPort + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +remoteipAddress String 1 Preliminary remoteIpAddress - IP address of peer endpoint. Ves::ObjectClasses::SipSignaling::remoteipAddress + Note: current data type (String) may be changed to Common Resource Datatype L3AddressData. =[gh]= + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +remotePort String 1 Preliminary remotePort - Port of peer endpoint Ves::ObjectClasses::SipSignaling::remotePort + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sipSignaliingFieldsVersion String 1 Preliminary sipSignalingFieldsVersion - Version of the sipSignalingFields block as "#.#" where # is a digit; see section 1 for the correct digits to use. Ves::ObjectClasses::SipSignaling::sipSignaliingFieldsVersion + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +summarySip String 0..1 Preliminary summarySip - The SIP Method or Response ('INVITE', '200 OK', 'BYE', etc). Ves::ObjectClasses::SipSignaling::summarySip + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_vendorNfnamefields VendorNfNameFields 1 Preliminary Vendor, NF and nfModule names Ves::ObjectClasses::SipSignaling::_vendorNfnamefields + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +domain Domain 1 Experimental Update in definition only Ves::ObjectClasses::VesEvent::domain + + OpenModelAttribute Event domain enumeration: 'cmNotify','fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +eventType String 0..1 Preliminary For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' Ves::ObjectClasses::VesEvent::eventType + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +lastEpochMicrosec Number 1 Preliminary the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds Ves::ObjectClasses::VesEvent::lastEpochMicrosec + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfcNamingCode String 0..1 Preliminary Network function component type: 3 characters (aligned with vfc naming standards) Ves::ObjectClasses::VesEvent::nfcNamingCode + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfNamingCode String 0..1 Preliminary Network function type: 4 characters (aligned with vnf and pnf naming standards) Ves::ObjectClasses::VesEvent::nfNamingCode + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfVendorName String 1 Preliminary Network function vendor name Ves::ObjectClasses::VesEvent::nfVendorName + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +priority Priority 1 Preliminary Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' Ves::ObjectClasses::VesEvent::priority + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +reportingEntityId String 0..1 Preliminary UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See 'reportingEntityName' for more information. Ves::ObjectClasses::VesEvent::reportingEntityId + + OpenModelAttribute reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. + Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +reportingEntityName String 1 Preliminary reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. Ves::ObjectClasses::VesEvent::reportingEntityName + + OpenModelAttribute Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sequence Integer 1 Preliminary sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ves::ObjectClasses::VesEvent::sequence + + OpenModelAttribute Ordering of events communicated by an event source instance (or 0 if not needed) + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sourceId String 0..1 Preliminary UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See 'sourceName' for more information. Ves::ObjectClasses::VesEvent::sourceId + + OpenModelAttribute sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity + Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sourceName String 1 Preliminary Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. Ves::ObjectClasses::VesEvent::sourceName + + OpenModelAttribute sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +startingEpochMicrosec Number 1 Preliminary startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). Ves::ObjectClasses::VesEvent::startingEpochMicrosec + For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). + OpenModelAttribute + the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +timeZoneOffset String 0..1 Preliminary Offset to GMT to indicate local time zone for device formatted as 'UTC+/-hh:mm'; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples Ves::ObjectClasses::VesEvent::timeZoneOffset + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +version String 1 Preliminary Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. Ves::ObjectClasses::VesEvent::version + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +vesEventListenerVersion String 1 Preliminary Version of the ves event listener api spec that this event is compliant with (as "#" or "#.#" or "#.#.#" where # is a digit; see section 1 for the correct digits to use). Ves::ObjectClasses::VesEvent::vesEventListenerVersion + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +name String 1 Preliminary Ves::ObjectClasses::VesEvent::name + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +Status String 0..1 Preliminary The current condition of an interaction, such as open, in research, closed, and so forth Common::Business Interaction::ObjectClasses::BusinessInteraction::Status + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +description String 0..1 Preliminary Defines a textual free-form description of the object. Common::Root::RootObjectClasses::RootEntity::description + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +id Identifier 1 Preliminary Identifier of this information element. This attribute shall be globally unique. Common::Root::RootObjectClasses::RootEntity::id + + OpenModelAttribute Unambiguously distinguishes different object instances. It is the naming attribute of the object. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +========================== ================== ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== + +StateChange +~~~~~~~~~~~ Fields specific to state change events. **Parent class:** VesEvent -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class StateChange** - -======================== ========== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -======================== ========== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== -additionalFields HashMap 0..1 Additional stateChange fields if needed OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -newState 1 New state of the entity: 'inService', 'maintenance', 'outOfService' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -OldState 1 Previous state of the entity: 'inService', 'maintenance', 'outOfService' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -stateChangeFieldsVersion String 1 Version of the stateChangeFields block as "#.#" where # is a digit; see section 1 for the correct digits to use. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -stateInterface String 1 Card or port name of the entity that changed state OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -domain Domain 1 Event domain enumeration: 'fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -eventType String 0..1 For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -lastEpochMicrosec Number 1 the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfcNamingCode String 0..1 Network function component type: 3 characters (aligned with vfc naming standards) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfNamingCode String 0..1 Network function type: 4 characters (aligned with vnf and pnf naming standards) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfVendorName String 1 Network function vendor name OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -priority Priority 1 Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -reportingEntityId String 0..1 UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See 'reportingEntityName' for more information. OpenModelAttribute - - | reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. - partOfObjectKey: 0 - | Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -reportingEntityName String 1 Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. OpenModelAttribute - - reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sequence Integer 1 sequence - Ordering of events communicated by an event source instance (or 0 if not needed) OpenModelAttribute - - Ordering of events communicated by an event source instance (or 0 if not needed) - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sourceId String 0..1 | sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity OpenModelAttribute - | Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. - - partOfObjectKey: 0 - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See 'sourceName' for more information. - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sourceName String 1 sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. OpenModelAttribute - - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -startingEpochMicrosec Number 1 the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) OpenModelAttribute - - | startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). - partOfObjectKey: 0 - | For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -timeZoneOffset String 0..1 Offset to GMT to indicate local time zone for device formatted as 'UTC+/-hh:mm'; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -version String 1 Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -vesEventListenerVersion String 1 Version of the ves event listener api spec that this event is compliant with (as "#" or "#.#" or "#.#.#" where # is a digit; see section 1 for the correct digits to use). OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -name String 1 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -Status String 0..1 The current condition of an interaction, such as open, in research, closed, and so forth OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -description String 0..1 Defines a textual free-form description of the object. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -id Identifier 1 Identifier of this information element. This attribute shall be globally unique. OpenModelAttribute - - Unambiguously distinguishes different object instances. It is the naming attribute of the object. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -======================== ========== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== +======================== ========== ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +additionalFields HashMap 0..1 Preliminary Additional stateChange fields if needed Ves::ObjectClasses::StateChange::additionalFields + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +newState invalid 1 Preliminary New state of the entity: 'inService', 'maintenance', 'outOfService' Ves::ObjectClasses::StateChange::newState + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +OldState invalid 1 Preliminary Previous state of the entity: 'inService', 'maintenance', 'outOfService' Ves::ObjectClasses::StateChange::OldState + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +stateChangeFieldsVersion String 1 Preliminary Version of the stateChangeFields block as "#.#" where # is a digit; see section 1 for the correct digits to use. Ves::ObjectClasses::StateChange::stateChangeFieldsVersion + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +stateInterface String 1 Preliminary Card or port name of the entity that changed state Ves::ObjectClasses::StateChange::stateInterface + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +domain Domain 1 Experimental Update in definition only Ves::ObjectClasses::VesEvent::domain + + OpenModelAttribute Event domain enumeration: 'cmNotify','fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +eventType String 0..1 Preliminary For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' Ves::ObjectClasses::VesEvent::eventType + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +lastEpochMicrosec Number 1 Preliminary the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds Ves::ObjectClasses::VesEvent::lastEpochMicrosec + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfcNamingCode String 0..1 Preliminary Network function component type: 3 characters (aligned with vfc naming standards) Ves::ObjectClasses::VesEvent::nfcNamingCode + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfNamingCode String 0..1 Preliminary Network function type: 4 characters (aligned with vnf and pnf naming standards) Ves::ObjectClasses::VesEvent::nfNamingCode + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfVendorName String 1 Preliminary Network function vendor name Ves::ObjectClasses::VesEvent::nfVendorName + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +priority Priority 1 Preliminary Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' Ves::ObjectClasses::VesEvent::priority + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +reportingEntityId String 0..1 Preliminary UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See 'reportingEntityName' for more information. Ves::ObjectClasses::VesEvent::reportingEntityId + + OpenModelAttribute reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. + Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +reportingEntityName String 1 Preliminary reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. Ves::ObjectClasses::VesEvent::reportingEntityName + + OpenModelAttribute Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sequence Integer 1 Preliminary sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ves::ObjectClasses::VesEvent::sequence + + OpenModelAttribute Ordering of events communicated by an event source instance (or 0 if not needed) + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sourceId String 0..1 Preliminary UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See 'sourceName' for more information. Ves::ObjectClasses::VesEvent::sourceId + + OpenModelAttribute sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity + Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sourceName String 1 Preliminary Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. Ves::ObjectClasses::VesEvent::sourceName + + OpenModelAttribute sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +startingEpochMicrosec Number 1 Preliminary startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). Ves::ObjectClasses::VesEvent::startingEpochMicrosec + For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). + OpenModelAttribute + the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +timeZoneOffset String 0..1 Preliminary Offset to GMT to indicate local time zone for device formatted as 'UTC+/-hh:mm'; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples Ves::ObjectClasses::VesEvent::timeZoneOffset + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +version String 1 Preliminary Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. Ves::ObjectClasses::VesEvent::version + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +vesEventListenerVersion String 1 Preliminary Version of the ves event listener api spec that this event is compliant with (as "#" or "#.#" or "#.#.#" where # is a digit; see section 1 for the correct digits to use). Ves::ObjectClasses::VesEvent::vesEventListenerVersion + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +name String 1 Preliminary Ves::ObjectClasses::VesEvent::name + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +Status String 0..1 Preliminary The current condition of an interaction, such as open, in research, closed, and so forth Common::Business Interaction::ObjectClasses::BusinessInteraction::Status + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +description String 0..1 Preliminary Defines a textual free-form description of the object. Common::Root::RootObjectClasses::RootEntity::description + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +id Identifier 1 Preliminary Identifier of this information element. This attribute shall be globally unique. Common::Root::RootObjectClasses::RootEntity::id + + OpenModelAttribute Unambiguously distinguishes different object instances. It is the naming attribute of the object. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +======================== ========== ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== + +StndDefined +~~~~~~~~~~~ -Syslog class -^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::Syslog +**Parent class:** VesEvent -**Description:** +Applied stereotypes: -Syslog's can be classified as either Control or Session/Traffic. They differ by message content and expected volume: +- OpenModelClass -• Control logs are generally free-form human-readable text used for reporting errors or warnings supporting the operation and troubleshooting of NFs. The volume of these logs is typically less than 2k per day. +- **support: MANDATORY** -• Session logs use common structured fields to report normal NF processing such as DNS lookups or firewall rules processed. The volume of these logs is typically greater than 1k per hour (and sometimes as high as 10k per second). +Syslog +~~~~~~ +Syslog's can be classified as either Control or Session/Traffic. They differ by message content and expected volume: +? Control logs are generally free-form human-readable text used for reporting errors or warnings supporting the operation and troubleshooting of NFs. The volume of these logs is typically less than 2k per day. +? Session logs use common structured fields to report normal NF processing such as DNS lookups or firewall rules processed. The volume of these logs is typically greater than 1k per hour (and sometimes as high as 10k per second). VES supports both classes of syslog, however VES is only recommended for control logs or for lower volume session logs, less than 60k per hour. High volume session logging should use a file-based transport solution. **Parent class:** VesEvent -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class Syslog** - -======================= ============== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -======================= ============== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== -additionalFields HashMap 0..\* Additional syslog fields if needed Ex: {"name1": "value1", "name2: "value2" … } OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -eventSourceHost String 0..1 Hostname of the device OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -eventSourceType String 1 Examples: 'other', 'router', 'switch', 'host', 'card', 'port', 'slotThreshold', 'portThreshold', 'virtualMachine', 'virtualNetworkFunction' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -syslogSdId String 0..1 0-32 char in format name@number, OpenModelAttribute - i.e., ourSDID@32473 - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -syslogFacilty SyslogFacility 0..1 Numeric code from 0 to 23 for facility: OpenModelAttribute - 0 kernel messages - 1 user-level messages - partOfObjectKey: 0 - 2 mail system - 3 system daemons - uniqueSet: - 4 security/authorization messages - 5 messages generated internally by syslogd - isInvariant: false - 6 line printer subsystem - 7 network news subsystem - unsigned: false - 8 UUCP subsystem - 9 clock daemon - counter: NA - 10 security/authorization messages - 11 FTP daemon - support: MANDATORY - 12 NTP subsystem - 13 log audit Preliminary - 14 log alert - 15 clock daemon (note 2) - 16 local use 0 (local0) - 17 local use 1 (local1) - 18 local use 2 (local2) - 19 local use 3 (local3) - 20 local use 4 (local4) - 21 local use 5 (local5) - 22 local use 6 (local6) - 23 local use 7 (local7 ) -syslogFieldVersion String 1 Version of the syslogFields block as "#.#" where # is a digit; see section 1 for the correct digits to use. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -syslogMsg String 1 Syslog message OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -syslogMsgHost String 0..1 Hostname parsed from non-VES syslog message OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -syslogPri Integer 0..1 0-192 OpenModelAttribute - Combined Severity and Facility (see rfc5424) - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -syslogProc String 0..1 Identifies the application that originated the message OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -syslogProcId Number 0..1 The process number assigned by the OS when the application was started OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -syslogSData String 0..1 A <space> separated list of key="value" pairs following the rfc5424 standard for SD-ELEMENT. OpenModelAttribute - Deprecated - The entire rfc5424 syslogSData object, including square brackets [ ], SD-ID and list of SD-PARAMs - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -syslogSev SyslogSev 0..1 Level-of-severity text enumeration defined below: OpenModelAttribute - Text Sev Description - Emergency 0 system is unusable - partOfObjectKey: 0 - Alert 1 action must be taken immediately - Critical 2 critical conditions - uniqueSet: - Error 3 error conditions - Warning 4 warning conditions - isInvariant: false - Notice 5 normal but significant condition - Info 6 Informational messages - unsigned: false - Debug 7 debug-level messages - - counter: NA - - - support: MANDATORY - - Preliminary -syslogTag String 1 Also known as MsgId. Brief non-spaced text indicating the type of message such as 'TCPOUT' or 'BGP_STATUS_CHANGE'; 'NILVALUE' should be used when no other value can be provided OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -syslogTs String 0..1 Timestamp parsed from non-VES syslog message OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -syslogVer Number 0..1 IANA assigned version of the syslog protocol specification: OpenModelAttribute - 0: VES - 1: IANA RFC5424 - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -domain Domain 1 Event domain enumeration: 'fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -eventType String 0..1 For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -lastEpochMicrosec Number 1 the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfcNamingCode String 0..1 Network function component type: 3 characters (aligned with vfc naming standards) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfNamingCode String 0..1 Network function type: 4 characters (aligned with vnf and pnf naming standards) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfVendorName String 1 Network function vendor name OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -priority Priority 1 Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -reportingEntityId String 0..1 UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See 'reportingEntityName' for more information. OpenModelAttribute - - | reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. - partOfObjectKey: 0 - | Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -reportingEntityName String 1 Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. OpenModelAttribute - - reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sequence Integer 1 sequence - Ordering of events communicated by an event source instance (or 0 if not needed) OpenModelAttribute - - Ordering of events communicated by an event source instance (or 0 if not needed) - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sourceId String 0..1 | sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity OpenModelAttribute - | Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. - - partOfObjectKey: 0 - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See 'sourceName' for more information. - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sourceName String 1 sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. OpenModelAttribute - - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -startingEpochMicrosec Number 1 the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) OpenModelAttribute - - | startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). - partOfObjectKey: 0 - | For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -timeZoneOffset String 0..1 Offset to GMT to indicate local time zone for device formatted as 'UTC+/-hh:mm'; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -version String 1 Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -vesEventListenerVersion String 1 Version of the ves event listener api spec that this event is compliant with (as "#" or "#.#" or "#.#.#" where # is a digit; see section 1 for the correct digits to use). OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -name String 1 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -Status String 0..1 The current condition of an interaction, such as open, in research, closed, and so forth OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -description String 0..1 Defines a textual free-form description of the object. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -id Identifier 1 Identifier of this information element. This attribute shall be globally unique. OpenModelAttribute - - Unambiguously distinguishes different object instances. It is the naming attribute of the object. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -======================= ============== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== - -ThresholdCrossingAlert class -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::ThresholdCrossingAlert - -**Description:** +======================= ============== ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +additionalFields HashMap 0..\* Preliminary Additional syslog fields if needed Ex: {"name1": "value1", "name2: "value2" … } Ves::ObjectClasses::Syslog::additionalFields + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +eventSourceHost String 0..1 Preliminary Hostname of the device Ves::ObjectClasses::Syslog::eventSourceHost + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +eventSourceType String 1 Preliminary Examples: 'other', 'router', 'switch', 'host', 'card', 'port', 'slotThreshold', 'portThreshold', 'virtualMachine', 'virtualNetworkFunction' Ves::ObjectClasses::Syslog::eventSourceType + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +syslogSdId String 0..1 Preliminary 0-32 char in format name@number, Ves::ObjectClasses::Syslog::syslogSdId + i.e., ourSDID@32473 + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +syslogFacilty SyslogFacility 0..1 Preliminary Numeric code from 0 to 23 for facility: Ves::ObjectClasses::Syslog::syslogFacilty + 0 kernel messages + OpenModelAttribute 1 user-level messages + 2 mail system + - isInvariant: false 3 system daemons + 4 security/authorization messages + - valueRange: no range constraint 5 messages generated internally by syslogd + 6 line printer subsystem + - support: MANDATORY 7 network news subsystem + 8 UUCP subsystem + 9 clock daemon + 10 security/authorization messages + 11 FTP daemon + 12 NTP subsystem + 13 log audit + 14 log alert + 15 clock daemon (note 2) + 16 local use 0 (local0) + 17 local use 1 (local1) + 18 local use 2 (local2) + 19 local use 3 (local3) + 20 local use 4 (local4) + 21 local use 5 (local5) + 22 local use 6 (local6) + 23 local use 7 (local7 ) +syslogFieldVersion String 1 Preliminary Version of the syslogFields block as "#.#" where # is a digit; see section 1 for the correct digits to use. Ves::ObjectClasses::Syslog::syslogFieldVersion + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +syslogMsg String 1 Preliminary Syslog message Ves::ObjectClasses::Syslog::syslogMsg + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +syslogMsgHost String 0..1 Preliminary Hostname parsed from non-VES syslog message Ves::ObjectClasses::Syslog::syslogMsgHost + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +syslogPri Integer 0..1 Preliminary 0-192 Ves::ObjectClasses::Syslog::syslogPri + Combined Severity and Facility (see rfc5424) + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +syslogProc String 0..1 Preliminary Identifies the application that originated the message Ves::ObjectClasses::Syslog::syslogProc + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +syslogProcId Number 0..1 Preliminary The process number assigned by the OS when the application was started Ves::ObjectClasses::Syslog::syslogProcId + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +syslogSData String 0..1 Preliminary A <space> separated list of key="value" pairs following the rfc5424 standard for SD-ELEMENT. Ves::ObjectClasses::Syslog::syslogSData + Deprecated + OpenModelAttribute The entire rfc5424 syslogSData object, including square brackets [ ], SD-ID and list of SD-PARAMs + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +syslogSev SyslogSev 0..1 Preliminary Level-of-severity text enumeration defined below: Ves::ObjectClasses::Syslog::syslogSev + Text Sev Description + OpenModelAttribute Emergency 0 system is unusable + Alert 1 action must be taken immediately + - isInvariant: false Critical 2 critical conditions + Error 3 error conditions + - valueRange: no range constraint Warning 4 warning conditions + Notice 5 normal but significant condition + - support: MANDATORY Info 6 Informational messages + Debug 7 debug-level messages +syslogTag String 1 Preliminary Also known as MsgId. Brief non-spaced text indicating the type of message such as 'TCPOUT' or 'BGP_STATUS_CHANGE'; 'NILVALUE' should be used when no other value can be provided Ves::ObjectClasses::Syslog::syslogTag + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +syslogTs String 0..1 Preliminary Timestamp parsed from non-VES syslog message Ves::ObjectClasses::Syslog::syslogTs + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +syslogVer Number 0..1 Preliminary IANA assigned version of the syslog protocol specification: Ves::ObjectClasses::Syslog::syslogVer + 0: VES + OpenModelAttribute 1: IANA RFC5424 + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +domain Domain 1 Experimental Update in definition only Ves::ObjectClasses::VesEvent::domain + + OpenModelAttribute Event domain enumeration: 'cmNotify','fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +eventType String 0..1 Preliminary For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' Ves::ObjectClasses::VesEvent::eventType + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +lastEpochMicrosec Number 1 Preliminary the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds Ves::ObjectClasses::VesEvent::lastEpochMicrosec + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfcNamingCode String 0..1 Preliminary Network function component type: 3 characters (aligned with vfc naming standards) Ves::ObjectClasses::VesEvent::nfcNamingCode + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfNamingCode String 0..1 Preliminary Network function type: 4 characters (aligned with vnf and pnf naming standards) Ves::ObjectClasses::VesEvent::nfNamingCode + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfVendorName String 1 Preliminary Network function vendor name Ves::ObjectClasses::VesEvent::nfVendorName + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +priority Priority 1 Preliminary Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' Ves::ObjectClasses::VesEvent::priority + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +reportingEntityId String 0..1 Preliminary UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See 'reportingEntityName' for more information. Ves::ObjectClasses::VesEvent::reportingEntityId + + OpenModelAttribute reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. + Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +reportingEntityName String 1 Preliminary reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. Ves::ObjectClasses::VesEvent::reportingEntityName + + OpenModelAttribute Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sequence Integer 1 Preliminary sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ves::ObjectClasses::VesEvent::sequence + + OpenModelAttribute Ordering of events communicated by an event source instance (or 0 if not needed) + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sourceId String 0..1 Preliminary UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See 'sourceName' for more information. Ves::ObjectClasses::VesEvent::sourceId + + OpenModelAttribute sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity + Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sourceName String 1 Preliminary Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. Ves::ObjectClasses::VesEvent::sourceName + + OpenModelAttribute sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +startingEpochMicrosec Number 1 Preliminary startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). Ves::ObjectClasses::VesEvent::startingEpochMicrosec + For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). + OpenModelAttribute + the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +timeZoneOffset String 0..1 Preliminary Offset to GMT to indicate local time zone for device formatted as 'UTC+/-hh:mm'; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples Ves::ObjectClasses::VesEvent::timeZoneOffset + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +version String 1 Preliminary Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. Ves::ObjectClasses::VesEvent::version + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +vesEventListenerVersion String 1 Preliminary Version of the ves event listener api spec that this event is compliant with (as "#" or "#.#" or "#.#.#" where # is a digit; see section 1 for the correct digits to use). Ves::ObjectClasses::VesEvent::vesEventListenerVersion + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +name String 1 Preliminary Ves::ObjectClasses::VesEvent::name + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +Status String 0..1 Preliminary The current condition of an interaction, such as open, in research, closed, and so forth Common::Business Interaction::ObjectClasses::BusinessInteraction::Status + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +description String 0..1 Preliminary Defines a textual free-form description of the object. Common::Root::RootObjectClasses::RootEntity::description + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +id Identifier 1 Preliminary Identifier of this information element. This attribute shall be globally unique. Common::Root::RootObjectClasses::RootEntity::id + + OpenModelAttribute Unambiguously distinguishes different object instances. It is the naming attribute of the object. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +======================= ============== ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== + +ThresholdCrossingAlert +~~~~~~~~~~~~~~~~~~~~~~ The thresholdCrossingAlertFields datatype consists of the following fields: **Parent class:** VesEvent -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class ThresholdCrossingAlert** - -============================== ============================= ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -============================== ============================= ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== -additionalFields HashMap 0..1 additionalFields - Additional pnfRegistration fields if needed. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -additionalParameters ThresholdCrossingAlertCounter 1..\* Array of performance counters OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -alertAction AlertAction 1 Enumeration: 'SET', 'CONT', 'CLEAR' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -alertDescription String 1 Unique short alert description (e.g., NE-CPUMEM) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -alertType AlertType 1 Enumeration: 'CARD-ANOMALY', 'INTERFACE-ANOMALY', ELEMENT-ANOMALY', 'SERVICE-ANOMALY' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -alertValue String 0..1 Calculated API value (if applicable) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -associatedAlertIdList String 0..\* List of eventIds associated with the event being reported OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -collectionTimestamp String 1 Time when the performance collector picked up the data; with RFC 2822 compliant format: 'Sat, 13 Mar 2010 11:29:05 -0800' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -dataCollector String 0..1 Specific performance collector instance used OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -elementType String 0..1 Type of network element (internal AT&T field) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -eventSeverity EventSeverity 1 Event severity or priority enumeration: 'CRITICAL', 'MAJOR', 'MINOR', 'WARNING', 'NORMAL' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -eventStartTimestamp String 1 Time closest to when the measurement was made; with RFC 2822 compliant format: 'Sat, 13 Mar 2010 11:29:05 -0800' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -interfaceName String 0..1 Physical or logical port or card (if applicable OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -networkService String 0..1 Network name (internal AT&T field) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -possibleRootCause String 0..1 Reserved for future use OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -thresholdCrossingFieldsVersion String 1 Version of the thresholdCrossingAlertFields block as "#.#" where # is a digit; see section 1 for the correct digits to use. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -domain Domain 1 Event domain enumeration: 'fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -eventType String 0..1 For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -lastEpochMicrosec Number 1 the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfcNamingCode String 0..1 Network function component type: 3 characters (aligned with vfc naming standards) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfNamingCode String 0..1 Network function type: 4 characters (aligned with vnf and pnf naming standards) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfVendorName String 1 Network function vendor name OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -priority Priority 1 Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -reportingEntityId String 0..1 UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See 'reportingEntityName' for more information. OpenModelAttribute - - | reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. - partOfObjectKey: 0 - | Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -reportingEntityName String 1 Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. OpenModelAttribute - - reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sequence Integer 1 sequence - Ordering of events communicated by an event source instance (or 0 if not needed) OpenModelAttribute - - Ordering of events communicated by an event source instance (or 0 if not needed) - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sourceId String 0..1 | sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity OpenModelAttribute - | Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. - - partOfObjectKey: 0 - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See 'sourceName' for more information. - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sourceName String 1 sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. OpenModelAttribute - - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -startingEpochMicrosec Number 1 the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) OpenModelAttribute - - | startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). - partOfObjectKey: 0 - | For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -timeZoneOffset String 0..1 Offset to GMT to indicate local time zone for device formatted as 'UTC+/-hh:mm'; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -version String 1 Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -vesEventListenerVersion String 1 Version of the ves event listener api spec that this event is compliant with (as "#" or "#.#" or "#.#.#" where # is a digit; see section 1 for the correct digits to use). OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -name String 1 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -Status String 0..1 The current condition of an interaction, such as open, in research, closed, and so forth OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -description String 0..1 Defines a textual free-form description of the object. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -id Identifier 1 Identifier of this information element. This attribute shall be globally unique. OpenModelAttribute - - Unambiguously distinguishes different object instances. It is the naming attribute of the object. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -============================== ============================= ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== - -VendorNfNameFields class -^^^^^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::VendorNfNameFields - -**Description:** +============================== ============================= ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ========================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +additionalFields HashMap 0..1 Preliminary additionalFields - Additional pnfRegistration fields if needed. Ves::ObjectClasses::ThresholdCrossingAlert::additionalFields + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +additionalParameters ThresholdCrossingAlertCounter 1..\* Preliminary Array of performance counters Ves::ObjectClasses::ThresholdCrossingAlert::additionalParameters + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +alertAction AlertAction 1 Preliminary Enumeration: 'SET', 'CONT', 'CLEAR' Ves::ObjectClasses::ThresholdCrossingAlert::alertAction + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +alertDescription String 1 Preliminary Unique short alert description (e.g., NE-CPUMEM) Ves::ObjectClasses::ThresholdCrossingAlert::alertDescription + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +alertType AlertType 1 Preliminary Enumeration: 'CARD-ANOMALY', 'INTERFACE-ANOMALY', ELEMENT-ANOMALY', 'SERVICE-ANOMALY' Ves::ObjectClasses::ThresholdCrossingAlert::alertType + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +alertValue String 0..1 Preliminary Calculated API value (if applicable) Ves::ObjectClasses::ThresholdCrossingAlert::alertValue + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +associatedAlertIdList String 0..\* Preliminary List of eventIds associated with the event being reported Ves::ObjectClasses::ThresholdCrossingAlert::associatedAlertIdList + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +collectionTimestamp String 1 Preliminary Time when the performance collector picked up the data; with RFC 2822 compliant format: 'Sat, 13 Mar 2010 11:29:05 -0800' Ves::ObjectClasses::ThresholdCrossingAlert::collectionTimestamp + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +dataCollector String 0..1 Preliminary Specific performance collector instance used Ves::ObjectClasses::ThresholdCrossingAlert::dataCollector + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +elementType String 0..1 Preliminary Type of network element (internal AT&T field) Ves::ObjectClasses::ThresholdCrossingAlert::elementType + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +eventSeverity EventSeverity 1 Preliminary Event severity or priority enumeration: 'CRITICAL', 'MAJOR', 'MINOR', 'WARNING', 'NORMAL' Ves::ObjectClasses::ThresholdCrossingAlert::eventSeverity + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +eventStartTimestamp String 1 Preliminary Time closest to when the measurement was made; with RFC 2822 compliant format: 'Sat, 13 Mar 2010 11:29:05 -0800' Ves::ObjectClasses::ThresholdCrossingAlert::eventStartTimestamp + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +interfaceName String 0..1 Preliminary Physical or logical port or card (if applicable Ves::ObjectClasses::ThresholdCrossingAlert::interfaceName + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +networkService String 0..1 Preliminary Network name (internal AT&T field) Ves::ObjectClasses::ThresholdCrossingAlert::networkService + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +possibleRootCause String 0..1 Preliminary Reserved for future use Ves::ObjectClasses::ThresholdCrossingAlert::possibleRootCause + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +thresholdCrossingFieldsVersion String 1 Preliminary Version of the thresholdCrossingAlertFields block as "#.#" where # is a digit; see section 1 for the correct digits to use. Ves::ObjectClasses::ThresholdCrossingAlert::thresholdCrossingFieldsVersion + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +domain Domain 1 Experimental Update in definition only Ves::ObjectClasses::VesEvent::domain + + OpenModelAttribute Event domain enumeration: 'cmNotify','fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +eventType String 0..1 Preliminary For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' Ves::ObjectClasses::VesEvent::eventType + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +lastEpochMicrosec Number 1 Preliminary the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds Ves::ObjectClasses::VesEvent::lastEpochMicrosec + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfcNamingCode String 0..1 Preliminary Network function component type: 3 characters (aligned with vfc naming standards) Ves::ObjectClasses::VesEvent::nfcNamingCode + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfNamingCode String 0..1 Preliminary Network function type: 4 characters (aligned with vnf and pnf naming standards) Ves::ObjectClasses::VesEvent::nfNamingCode + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfVendorName String 1 Preliminary Network function vendor name Ves::ObjectClasses::VesEvent::nfVendorName + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +priority Priority 1 Preliminary Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' Ves::ObjectClasses::VesEvent::priority + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +reportingEntityId String 0..1 Preliminary UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See 'reportingEntityName' for more information. Ves::ObjectClasses::VesEvent::reportingEntityId + + OpenModelAttribute reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. + Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +reportingEntityName String 1 Preliminary reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. Ves::ObjectClasses::VesEvent::reportingEntityName + + OpenModelAttribute Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sequence Integer 1 Preliminary sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ves::ObjectClasses::VesEvent::sequence + + OpenModelAttribute Ordering of events communicated by an event source instance (or 0 if not needed) + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sourceId String 0..1 Preliminary UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See 'sourceName' for more information. Ves::ObjectClasses::VesEvent::sourceId + + OpenModelAttribute sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity + Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sourceName String 1 Preliminary Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. Ves::ObjectClasses::VesEvent::sourceName + + OpenModelAttribute sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +startingEpochMicrosec Number 1 Preliminary startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). Ves::ObjectClasses::VesEvent::startingEpochMicrosec + For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). + OpenModelAttribute + the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +timeZoneOffset String 0..1 Preliminary Offset to GMT to indicate local time zone for device formatted as 'UTC+/-hh:mm'; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples Ves::ObjectClasses::VesEvent::timeZoneOffset + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +version String 1 Preliminary Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. Ves::ObjectClasses::VesEvent::version + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +vesEventListenerVersion String 1 Preliminary Version of the ves event listener api spec that this event is compliant with (as "#" or "#.#" or "#.#.#" where # is a digit; see section 1 for the correct digits to use). Ves::ObjectClasses::VesEvent::vesEventListenerVersion + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +name String 1 Preliminary Ves::ObjectClasses::VesEvent::name + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +Status String 0..1 Preliminary The current condition of an interaction, such as open, in research, closed, and so forth Common::Business Interaction::ObjectClasses::BusinessInteraction::Status + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +description String 0..1 Preliminary Defines a textual free-form description of the object. Common::Root::RootObjectClasses::RootEntity::description + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +id Identifier 1 Preliminary Identifier of this information element. This attribute shall be globally unique. Common::Root::RootObjectClasses::RootEntity::id + + OpenModelAttribute Unambiguously distinguishes different object instances. It is the naming attribute of the object. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +============================== ============================= ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ========================================================================== + +VendorNfNameFields +~~~~~~~~~~~~~~~~~~ vendorNfNameFields - The vendorNfNameFields provides vendor, nf and nfModule identifying information. -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class VendorNfNameFields** - -================== ======== ========= ========================================================== ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -================== ======== ========= ========================================================== ===================== -nfModuleName String 0..1 nfModuleName - Name of the nfModule generating the event. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfName String 0..1 nfName - Name of the network function generating the event OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -vendorName String 1 vendorName - Network function vendor name. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -================== ======== ========= ========================================================== ===================== - -VesEvent class -^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::VesEvent - -**Description:** +================== ======== ========= ================================== ========================================================== ==================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +nfModuleName String 0..1 Preliminary nfModuleName - Name of the nfModule generating the event. Ves::ObjectClasses::VendorNfNameFields::nfModuleName + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfName String 0..1 Preliminary nfName - Name of the network function generating the event Ves::ObjectClasses::VendorNfNameFields::nfName + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +vendorName String 1 Preliminary vendorName - Network function vendor name. Ves::ObjectClasses::VendorNfNameFields::vendorName + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= ================================== ========================================================== ==================================================== + +VesEvent +~~~~~~~~ An ONAP event is an aggregation of a header and a message. Event messages may be published to a message broker by service instances, resource instances, or ONAP platform components. Service or resource instances may be in support of network infrastructure or customer services. Interested platforms may subscribe to events on the message broker (e.g. Centralized Testing Platform CTP) may see an event on a service VNF instance and perform an automated test as part of a closed loop management policy. Events are unique and distinguishable from one another. - ONAP event messages are serialized as a unicode ASCII character string which may be formatted as JSON, XML, etc... Appropriate schemas will be supplied. **Parent class:** Notification -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class VesEvent** - -======================= ========== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -======================= ========== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== -domain Domain 1 Event domain enumeration: 'fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -eventType String 0..1 For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -lastEpochMicrosec Number 1 the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfcNamingCode String 0..1 Network function component type: 3 characters (aligned with vfc naming standards) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfNamingCode String 0..1 Network function type: 4 characters (aligned with vnf and pnf naming standards) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfVendorName String 1 Network function vendor name OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -priority Priority 1 Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -reportingEntityId String 0..1 UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See 'reportingEntityName' for more information. OpenModelAttribute - - | reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. - partOfObjectKey: 0 - | Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -reportingEntityName String 1 Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. OpenModelAttribute - - reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sequence Integer 1 sequence - Ordering of events communicated by an event source instance (or 0 if not needed) OpenModelAttribute - - Ordering of events communicated by an event source instance (or 0 if not needed) - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sourceId String 0..1 | sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity OpenModelAttribute - | Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. - - partOfObjectKey: 0 - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See 'sourceName' for more information. - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sourceName String 1 sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. OpenModelAttribute - - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -startingEpochMicrosec Number 1 the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) OpenModelAttribute - - | startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). - partOfObjectKey: 0 - | For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -timeZoneOffset String 0..1 Offset to GMT to indicate local time zone for device formatted as 'UTC+/-hh:mm'; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -version String 1 Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -vesEventListenerVersion String 1 Version of the ves event listener api spec that this event is compliant with (as "#" or "#.#" or "#.#.#" where # is a digit; see section 1 for the correct digits to use). OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -name String 1 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -Status String 0..1 The current condition of an interaction, such as open, in research, closed, and so forth OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -description String 0..1 Defines a textual free-form description of the object. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -id Identifier 1 Identifier of this information element. This attribute shall be globally unique. OpenModelAttribute - - Unambiguously distinguishes different object instances. It is the naming attribute of the object. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -======================= ========== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== - -VoiceQuality class -^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::VoiceQuality - -**Description:** +======================= ========== ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +domain Domain 1 Experimental Update in definition only Ves::ObjectClasses::VesEvent::domain + + OpenModelAttribute Event domain enumeration: 'cmNotify','fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +eventType String 0..1 Preliminary For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' Ves::ObjectClasses::VesEvent::eventType + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +lastEpochMicrosec Number 1 Preliminary the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds Ves::ObjectClasses::VesEvent::lastEpochMicrosec + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfcNamingCode String 0..1 Preliminary Network function component type: 3 characters (aligned with vfc naming standards) Ves::ObjectClasses::VesEvent::nfcNamingCode + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfNamingCode String 0..1 Preliminary Network function type: 4 characters (aligned with vnf and pnf naming standards) Ves::ObjectClasses::VesEvent::nfNamingCode + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfVendorName String 1 Preliminary Network function vendor name Ves::ObjectClasses::VesEvent::nfVendorName + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +priority Priority 1 Preliminary Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' Ves::ObjectClasses::VesEvent::priority + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +reportingEntityId String 0..1 Preliminary UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See 'reportingEntityName' for more information. Ves::ObjectClasses::VesEvent::reportingEntityId + + OpenModelAttribute reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. + Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +reportingEntityName String 1 Preliminary reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. Ves::ObjectClasses::VesEvent::reportingEntityName + + OpenModelAttribute Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sequence Integer 1 Preliminary sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ves::ObjectClasses::VesEvent::sequence + + OpenModelAttribute Ordering of events communicated by an event source instance (or 0 if not needed) + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sourceId String 0..1 Preliminary UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See 'sourceName' for more information. Ves::ObjectClasses::VesEvent::sourceId + + OpenModelAttribute sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity + Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sourceName String 1 Preliminary Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. Ves::ObjectClasses::VesEvent::sourceName + + OpenModelAttribute sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +startingEpochMicrosec Number 1 Preliminary startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). Ves::ObjectClasses::VesEvent::startingEpochMicrosec + For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). + OpenModelAttribute + the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +timeZoneOffset String 0..1 Preliminary Offset to GMT to indicate local time zone for device formatted as 'UTC+/-hh:mm'; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples Ves::ObjectClasses::VesEvent::timeZoneOffset + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +version String 1 Preliminary Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. Ves::ObjectClasses::VesEvent::version + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +vesEventListenerVersion String 1 Preliminary Version of the ves event listener api spec that this event is compliant with (as "#" or "#.#" or "#.#.#" where # is a digit; see section 1 for the correct digits to use). Ves::ObjectClasses::VesEvent::vesEventListenerVersion + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +name String 1 Preliminary Ves::ObjectClasses::VesEvent::name + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +Status String 0..1 Preliminary The current condition of an interaction, such as open, in research, closed, and so forth Common::Business Interaction::ObjectClasses::BusinessInteraction::Status + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +description String 0..1 Preliminary Defines a textual free-form description of the object. Common::Root::RootObjectClasses::RootEntity::description + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +id Identifier 1 Preliminary Identifier of this information element. This attribute shall be globally unique. Common::Root::RootObjectClasses::RootEntity::id + + OpenModelAttribute Unambiguously distinguishes different object instances. It is the naming attribute of the object. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +======================= ========== ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== + +VoiceQuality +~~~~~~~~~~~~ The voiceQuality class provides statistics related to customer facing voice products; consists of the following fields: **Parent class:** VesEvent -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class VoiceQuality** - -========================= ===================== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -========================= ===================== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== -additionalInformation HashMap 0..1 Additional voice quality fields OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -calleeSideCodec String 1 Callee codec for the call OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -callerSideCodec String 1 Caller codec for the call OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -correlator String 1 Constant across all events on this call OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -phoneNumber String 0..1 Phone number associated with the correlator OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -midCallRtcp String 1 Base64 encoding of the binary RTCP data (excluding Eth/IP/UDP headers) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -voiceQualityFieldsVersion String 1 Version of the voiceQualityFields block as "#.#" where # is a digit; see section 1 for the correct digits to use. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -\_endofcallvqmsummaries EndOfCallVqmSummaries 0..1 End of call voice quality metric summaries OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -\_vendornfnamefields VendorNfNameFields 1 Vendor, NF and nfModule names OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -domain Domain 1 Event domain enumeration: 'fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -eventType String 0..1 For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -lastEpochMicrosec Number 1 the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfcNamingCode String 0..1 Network function component type: 3 characters (aligned with vfc naming standards) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfNamingCode String 0..1 Network function type: 4 characters (aligned with vnf and pnf naming standards) OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -nfVendorName String 1 Network function vendor name OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -priority Priority 1 Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -reportingEntityId String 0..1 UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See 'reportingEntityName' for more information. OpenModelAttribute - - | reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. - partOfObjectKey: 0 - | Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -reportingEntityName String 1 Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. OpenModelAttribute - - reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sequence Integer 1 sequence - Ordering of events communicated by an event source instance (or 0 if not needed) OpenModelAttribute - - Ordering of events communicated by an event source instance (or 0 if not needed) - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sourceId String 0..1 | sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity OpenModelAttribute - | Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. - - partOfObjectKey: 0 - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See 'sourceName' for more information. - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -sourceName String 1 sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. OpenModelAttribute - - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -startingEpochMicrosec Number 1 the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) OpenModelAttribute - - | startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). - partOfObjectKey: 0 - | For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -timeZoneOffset String 0..1 Offset to GMT to indicate local time zone for device formatted as 'UTC+/-hh:mm'; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -version String 1 Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -vesEventListenerVersion String 1 Version of the ves event listener api spec that this event is compliant with (as "#" or "#.#" or "#.#.#" where # is a digit; see section 1 for the correct digits to use). OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -name String 1 OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -Status String 0..1 The current condition of an interaction, such as open, in research, closed, and so forth OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -description String 0..1 Defines a textual free-form description of the object. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -id Identifier 1 Identifier of this information element. This attribute shall be globally unique. OpenModelAttribute - - Unambiguously distinguishes different object instances. It is the naming attribute of the object. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -========================= ===================== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== +========================= ===================== ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +additionalInformation HashMap 0..1 Preliminary Additional voice quality fields Ves::ObjectClasses::VoiceQuality::additionalInformation + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +calleeSideCodec String 1 Preliminary Callee codec for the call Ves::ObjectClasses::VoiceQuality::calleeSideCodec + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +callerSideCodec String 1 Preliminary Caller codec for the call Ves::ObjectClasses::VoiceQuality::callerSideCodec + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +correlator String 1 Preliminary Constant across all events on this call Ves::ObjectClasses::VoiceQuality::correlator + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +phoneNumber String 0..1 Preliminary Phone number associated with the correlator Ves::ObjectClasses::VoiceQuality::phoneNumber + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +midCallRtcp String 1 Preliminary Base64 encoding of the binary RTCP data (excluding Eth/IP/UDP headers) Ves::ObjectClasses::VoiceQuality::midCallRtcp + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +voiceQualityFieldsVersion String 1 Preliminary Version of the voiceQualityFields block as "#.#" where # is a digit; see section 1 for the correct digits to use. Ves::ObjectClasses::VoiceQuality::voiceQualityFieldsVersion + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_endofcallvqmsummaries EndOfCallVqmSummaries 0..1 Preliminary End of call voice quality metric summaries Ves::ObjectClasses::VoiceQuality::_endofcallvqmsummaries + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_vendornfnamefields VendorNfNameFields 1 Preliminary Vendor, NF and nfModule names Ves::ObjectClasses::VoiceQuality::_vendornfnamefields + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +domain Domain 1 Experimental Update in definition only Ves::ObjectClasses::VesEvent::domain + + OpenModelAttribute Event domain enumeration: 'cmNotify','fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +eventType String 0..1 Preliminary For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' Ves::ObjectClasses::VesEvent::eventType + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +lastEpochMicrosec Number 1 Preliminary the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds Ves::ObjectClasses::VesEvent::lastEpochMicrosec + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfcNamingCode String 0..1 Preliminary Network function component type: 3 characters (aligned with vfc naming standards) Ves::ObjectClasses::VesEvent::nfcNamingCode + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfNamingCode String 0..1 Preliminary Network function type: 4 characters (aligned with vnf and pnf naming standards) Ves::ObjectClasses::VesEvent::nfNamingCode + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nfVendorName String 1 Preliminary Network function vendor name Ves::ObjectClasses::VesEvent::nfVendorName + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +priority Priority 1 Preliminary Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' Ves::ObjectClasses::VesEvent::priority + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +reportingEntityId String 0..1 Preliminary UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See 'reportingEntityName' for more information. Ves::ObjectClasses::VesEvent::reportingEntityId + + OpenModelAttribute reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. + Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +reportingEntityName String 1 Preliminary reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. Ves::ObjectClasses::VesEvent::reportingEntityName + + OpenModelAttribute Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sequence Integer 1 Preliminary sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ves::ObjectClasses::VesEvent::sequence + + OpenModelAttribute Ordering of events communicated by an event source instance (or 0 if not needed) + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sourceId String 0..1 Preliminary UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See 'sourceName' for more information. Ves::ObjectClasses::VesEvent::sourceId + + OpenModelAttribute sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity + Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +sourceName String 1 Preliminary Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. Ves::ObjectClasses::VesEvent::sourceName + + OpenModelAttribute sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +startingEpochMicrosec Number 1 Preliminary startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). Ves::ObjectClasses::VesEvent::startingEpochMicrosec + For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). + OpenModelAttribute + the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +timeZoneOffset String 0..1 Preliminary Offset to GMT to indicate local time zone for device formatted as 'UTC+/-hh:mm'; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples Ves::ObjectClasses::VesEvent::timeZoneOffset + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +version String 1 Preliminary Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. Ves::ObjectClasses::VesEvent::version + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +vesEventListenerVersion String 1 Preliminary Version of the ves event listener api spec that this event is compliant with (as "#" or "#.#" or "#.#.#" where # is a digit; see section 1 for the correct digits to use). Ves::ObjectClasses::VesEvent::vesEventListenerVersion + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +name String 1 Preliminary Ves::ObjectClasses::VesEvent::name + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +Status String 0..1 Preliminary The current condition of an interaction, such as open, in research, closed, and so forth Common::Business Interaction::ObjectClasses::BusinessInteraction::Status + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +description String 0..1 Preliminary Defines a textual free-form description of the object. Common::Root::RootObjectClasses::RootEntity::description + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +id Identifier 1 Preliminary Identifier of this information element. This attribute shall be globally unique. Common::Root::RootObjectClasses::RootEntity::id + + OpenModelAttribute Unambiguously distinguishes different object instances. It is the naming attribute of the object. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +========================= ===================== ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== + +cmNotif +~~~~~~~ + +Applied stereotypes: -measInfoIdInteger class -^^^^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::measInfoIdInteger +- OpenModelClass -**Description:** +- **support: MANDATORY** + +- Experimental + +=================== ============= ========= ================================== ===================================================================================================================================================================================================== =========================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +notificationType String 0..1 OpenModelAttribute Type of notification. This is an enum (managedObjectCreation, managedObjectDeletion, managedObjectAttributeValueChanged) Ves::Diagrams::cmNotif::notificationType + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +dN String 0..1 OpenModelAttribute Managed Object Instance that is the subject of this notification. In 3GPP devices this is the Distinguished Name (DN) which is used to uniquely identify a MO within a name space as defined by ITU-T Ves::Diagrams::cmNotif::dN + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +objectIdentiferType String 0..1 OpenModelAttribute Type of object identifier (Ynag, or ....) Ves::Diagrams::cmNotif::objectIdentiferType + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +attributeList AttributeList 1..\* OpenModelAttribute [R1] Attribute Name and values (attributeName(string), newAttributeValue(any type), oldAttributeValue(any type) Ves::Diagrams::cmNotif::attributeList + [R2] This is Mandatory for notifyMOIAttributeValueChange. 3GPP defines it as options for Creation and Deletion. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +=================== ============= ========= ================================== ===================================================================================================================================================================================================== =========================================== + +measInfoIdInteger +~~~~~~~~~~~~~~~~~ The measInfoIdInteger datatype provides an integer measurement group identifier; -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class measInfoIdInteger** - -================== ======== ========= ==================================== ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -================== ======== ========= ==================================== ===================== -iMeasInfoId Integer 1 Integer measurement group Identifier OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -================== ======== ========= ==================================== ===================== - -measResultNull class -^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Ves::ObjectClasses::measResultNull - -**Description:** +================== ======== ========= ================================== ==================================== ================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +iMeasInfoId Integer 1 Preliminary Integer measurement group Identifier Ves::ObjectClasses::measInfoIdInteger::iMeasInfoId + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= ================================== ==================================== ================================================== + +measResultNull +~~~~~~~~~~~~~~ The measResultNull datatype provides a null 3GPP PM measurement result -**Applied Stereotypes:** +Applied stereotypes: - OpenModelClass -- support: MANDATORY +- **support: MANDATORY** - Preliminary -**Table** **Attributes for class measResultNull** - -================== ======== ========= ================================================ ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -================== ======== ========= ================================================ ===================== -p Integer 1 Integer reference to the counter OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -isNull Boolean 1 Enumeration: 'true' or 'false' OpenModelAttribute - - The VES 7.1 Spec has this attribute as a string. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -================== ======== ========= ================================================ ===================== +================== ======== ========= ================================== ================================================ ========================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** +p Integer 1 Preliminary Integer reference to the counter Ves::ObjectClasses::measResultNull::p + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +isNull Boolean 1 Preliminary Enumeration: 'true' or 'false' Ves::ObjectClasses::measResultNull::isNull + + OpenModelAttribute The VES 7.1 Spec has this attribute as a string. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= ================================== ================================================ ========================================== |