diff options
| author |   yxpoke <yangxu5@huawei.com> | 2019-10-16 22:24:55 +0800 |
|---|---|---|
| committer | yxpoke <yangxu5@huawei.com> | 2019-10-16 22:24:55 +0800 |
| commit | 67d6b91e3d818a3bcd0a2c4b2c875bfda3321753 (patch) | |
| tree | e9e4583d6bff4e97d9ed943e814e6bac091770de /docs/ONAP Model Spec/im | |
| parent | 068af444e9f2cc66b096462310fc2c19fef473ed (diff) | |
add new model spec for ves - part 2
Issue-ID: MODELING-228
Signed-off-by: yxpoke <yangxu5@huawei.com>
Change-Id: I305e5bcd274eafe4ba92182f7f1417ef7e29df43
Diffstat (limited to 'docs/ONAP Model Spec/im')
| -rw-r--r-- | docs/ONAP Model Spec/im/VES/VES-class-2.rst | 4919 | ||||
| -rw-r--r-- | docs/ONAP Model Spec/im/VES/VES-datatype.rst | 319 | ||||
| -rw-r--r-- | docs/ONAP Model Spec/im/VES/VES-enumeration.rst | 451 |
3 files changed, 5689 insertions, 0 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 new file mode 100644 index 0000000..9711f8b --- /dev/null +++ b/docs/ONAP Model Spec/im/VES/VES-class-2.rst @@ -0,0 +1,4919 @@ +.. Copyright 2019 +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +VES Class Definition - part 2 +----------------------------- + +.. contents:: + :depth: 3 +.. + +Notification class +^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Ves::ObjectClasses::Notification + +**Description:** + +Fields specific to notification events + +**Parent class:** VesEvent + +**Applied Stereotypes:** + +- OpenModelClass + +- 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:** + +The otherFields datatype defines fields for events belonging to the 'other' domain of the commonEventHeader domain enumeration. + +**Parent class:** VesEvent + +**Applied Stereotypes:** + +- OpenModelClass + +- support: MANDATORY + +- Preliminary + +**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 + +**Parent class:** VesEvent + +**Applied Stereotypes:** + +- OpenModelClass + +- 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:** + +The pnfRegistrationFields datatype defines fields for events belonging to the 'pnfRegistration' domain of the commonEventHeader domain enumeration; it consists of the following fields: + +**Parent class:** VesEvent + +**Applied Stereotypes:** + +- OpenModelClass + +- support: MANDATORY + +- Preliminary + +**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:** + +The processStats datatype provides metrics on system processes; it consists of the following fields: + +**Applied Stereotypes:** + +- OpenModelClass + +- 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:** + +The processorDimmAggregateThermalMargin datatype provides intelligent platform management interface (ipmi) processor dual inline memory module aggregate thermal margin metrics; it consists of the following fields: + +**Applied Stereotypes:** + +- OpenModelClass + +- support: MANDATORY + +- Preliminary + +**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:** + +sipSignalingFields - The sipSignalingFields datatype communicates information about SIP signaling messages, parameters and signaling state. + +**Parent class:** VesEvent + +**Applied Stereotypes:** + +- OpenModelClass + +- 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:** + +Fields specific to state change events. + +**Parent class:** VesEvent + +**Applied Stereotypes:** + +- OpenModelClass + +- 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 +======================== ========== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== + +Syslog class +^^^^^^^^^^^^ + +**Qualified Name:** Ves::ObjectClasses::Syslog + +**Description:** + +Syslog's can be classified as either Control or Session/Traffic. They differ by message content and expected volume: + +• Control logs are generally free-form human-readable text used for reporting errors or warnings supporting the operation and troubleshooting of NFs. The volume of these logs is typically less than 2k per day. + +• Session logs use common structured fields to report normal NF processing such as DNS lookups or firewall rules processed. The volume of these logs is typically greater than 1k per hour (and sometimes as high as 10k per second). + +VES supports both classes of syslog, however VES is only recommended for control logs or for lower volume session logs, less than 60k per hour. High volume session logging should use a file-based transport solution. + +**Parent class:** VesEvent + +**Applied Stereotypes:** + +- OpenModelClass + +- support: MANDATORY + +- Preliminary + +**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:** + +The thresholdCrossingAlertFields datatype consists of the following fields: + +**Parent class:** VesEvent + +**Applied Stereotypes:** + +- OpenModelClass + +- 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:** + +vendorNfNameFields - The vendorNfNameFields provides vendor, nf and nfModule identifying information. + +**Applied Stereotypes:** + +- OpenModelClass + +- 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:** + +An ONAP event is an aggregation of a header and a message. Event messages may be published to a message broker by service instances, resource instances, or ONAP platform components. Service or resource instances may be in support of network infrastructure or customer services. Interested platforms may subscribe to events on the message broker (e.g. Centralized Testing Platform CTP) may see an event on a service VNF instance and perform an automated test as part of a closed loop management policy. Events are unique and distinguishable from one another. + +ONAP event messages are serialized as a unicode ASCII character string which may be formatted as JSON, XML, etc... Appropriate schemas will be supplied. + +**Parent class:** Notification + +**Applied Stereotypes:** + +- OpenModelClass + +- support: MANDATORY + +- Preliminary + +**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:** + +The voiceQuality class provides statistics related to customer facing voice products; consists of the following fields: + +**Parent class:** VesEvent + +**Applied Stereotypes:** + +- OpenModelClass + +- support: MANDATORY + +- Preliminary + +**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 +========================= ===================== ========= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ===================== + +measInfoIdInteger class +^^^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Ves::ObjectClasses::measInfoIdInteger + +**Description:** + +The measInfoIdInteger datatype provides an integer measurement group identifier; + +**Applied Stereotypes:** + +- OpenModelClass + +- 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:** + +The measResultNull datatype provides a null 3GPP PM measurement result + +**Applied Stereotypes:** + +- OpenModelClass + +- 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 +================== ======== ========= ================================================ ===================== diff --git a/docs/ONAP Model Spec/im/VES/VES-datatype.rst b/docs/ONAP Model Spec/im/VES/VES-datatype.rst new file mode 100644 index 0000000..f8ff20a --- /dev/null +++ b/docs/ONAP Model Spec/im/VES/VES-datatype.rst @@ -0,0 +1,319 @@ +.. Copyright 2019 +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +VES Datatype Definition +----------------------- + +.. contents:: + :depth: 3 +.. + +ArrayOfSchemaObject datatype +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Ves::TypeDefinitions::ArrayOfSchemaObject + +**Description:** + +arrayOfSchemaObject - The arrayOfSchemaObject datatype provides an array of json objects, each of which is described by name, schema and other meta-information. + +Note: The VES Spec has this as a Json based object. + +**Applied Stereotypes:** + +- Preliminary + +**Table** **Attributes for Data Type ArrayOfSchemaObject** + +=================== ============ ========= ============================================================================================================================================================= ================================== +**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** +=================== ============ ========= ============================================================================================================================================================= ================================== +arrayOfSchemaObject SchemaObject 1..\* arrayOfSchemaObject - arrayOfSchemaObject datatype provides an array of SchemaObjects, each of which is described by name, schema and other meta-information. OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +=================== ============ ========= ============================================================================================================================================================= ================================== + +ArrayofNamedHashMap datatype +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Ves::TypeDefinitions::ArrayofNamedHashMap + +**Description:** + +Array of named hashMaps + +**Applied Stereotypes:** + +- Preliminary + +**Table** **Attributes for Data Type ArrayofNamedHashMap** + +=================== ============ ========= ======================= ================================== +**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** +=================== ============ ========= ======================= ================================== +arrayOfNamedHashmap NamedHashMap 1..\* Array of named hashMaps OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +=================== ============ ========= ======================= ================================== + +HashMap datatype +^^^^^^^^^^^^^^^^ + +**Qualified Name:** Ves::TypeDefinitions::HashMap + +**Description:** + +The hashMap datatype is an 'associative array', which is an unordered collection of key-value pairs of the form "key": "value", where each key and value are strings. Keys must use camel casing to separate words and acronyms; only the first letter of each acronym shall be capitalized. + +**Applied Stereotypes:** + +- Preliminary + +**Table** **Attributes for Data Type HashMap** + +================== ============ ========= ======================================================== ================================== +**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** +================== ============ ========= ======================================================== ================================== +hashmapEntry KeyValuePair 0..\* A given entry in the hashmap, which is a key/value pair. OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +================== ============ ========= ======================================================== ================================== + +NamedHashMap datatype +^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Ves::TypeDefinitions::NamedHashMap + +**Description:** + +namedHashMap [ ] - The namedHashmap datatype is a hashMap which is associated with and described by a name. + +**Applied Stereotypes:** + +- Preliminary + +**Table** **Attributes for Data Type NamedHashMap** + +================== ======== ========= =========================================================================== ================================== +**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** +================== ======== ========= =========================================================================== ================================== +name String 1 name - Name for the array of name-value pairs. OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +hashMap HashMap 1 hashMap - One or more key:value pairs. OpenModelAttribute + Note: in ATTServiceSpecification - VesEventListener v5.4.1 type = field []. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +================== ======== ========= =========================================================================== ================================== + +ProcessStats datatype +^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Ves::TypeDefinitions::ProcessStats + +SchemaObject datatype +^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Ves::TypeDefinitions::SchemaObject + +**Description:** + +SchemaObject - The SchemaObject datatype provides an object schema, name and other meta-information along with one or more object instances that conform to the schema. + +Note: The VES Spec has this as a Json based object. + +**Applied Stereotypes:** + +- Preliminary + +**Table** **Attributes for Data Type SchemaObject** + +===================== ==================== ========= ============================================================================================================================================================================================= ================================== +**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** +===================== ==================== ========= ============================================================================================================================================================================================= ================================== +objectInstances SchemaObjectInstance 1..\* objectInstances - Contains one or more instances of the SchemaObjectInstance object. OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +objectName String 1 objectName - Name of the object. OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +objectSchema String 0..1 objectSchema - schema for the object. OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +objectSchemaUrl String 0..1 objectSchemaUrl - URL to the schema for the object. OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +nfSubcribedObjectName String 0..1 nfSubscribedObjectName - Name of the object associated with the nfSubscriptionId. OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +nfSubcriptionId String 0..1 nfSubscriptionId - Identifies an OpenConfig telemetry subscription on a network function, which configures the network function to send complex object data associated with the SchemaObject. OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +===================== ==================== ========= ============================================================================================================================================================================================= ================================== + +SchemaObjectInstance datatype +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Ves::TypeDefinitions::SchemaObjectInstance + +**Description:** + +SchemaObjectInstance [ ] - The SchemabjectInstance datatype provides meta-information about an instance of a SchemaObject along with the actual object instance. + +Note: The VES Spec has this as a Json based object. + +**Applied Stereotypes:** + +- Preliminary + +**Table** **Attributes for Data Type SchemaObjectInstance** + +=========================== ============ ========= ====================================================================================================================================================================== ================================== +**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** +=========================== ============ ========= ====================================================================================================================================================================== ================================== +schemaObject SchemaObject 0..\* SchemaObject - Optional recursive specification on SchemaObject OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +objectInstance Object 0..1 objectInstance - Contains an instance conforming to the SchemaObject schema OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +objectInstanceEpochMicrosec UnixEpoch 0..1 objectInstanceEpochMicrosec - the unix time, aka epoch time, associated with this objectInstance--as microseconds elapsed since 1 Jan 1970 not including leap seconds. OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +objectKeys Key 0..\* objectKeys - An ordered set of keys that identifies this particular instance of SchemaObject (e.g., that places it in a hierarchy). OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +=========================== ============ ========= ====================================================================================================================================================================== ================================== + +ThresholdCrossingAlertCounter datatype +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Ves::TypeDefinitions::ThresholdCrossingAlertCounter + +**Applied Stereotypes:** + +- Preliminary + +**Table** **Attributes for Data Type ThresholdCrossingAlertCounter** + +================== ============== ========= ============================================================================ ================================== +**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** +================== ============== ========= ============================================================================ ================================== +criticality TCACriticality 1 Enumeration: 'CRIT', 'MAJ' OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +hashMap HashMap 1 Key is the name of the counter and value is the current value of the counter OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +thresholdCrossed String 1 Last threshold that was crossed OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +================== ============== ========= ============================================================================ ================================== diff --git a/docs/ONAP Model Spec/im/VES/VES-enumeration.rst b/docs/ONAP Model Spec/im/VES/VES-enumeration.rst new file mode 100644 index 0000000..b4b08db --- /dev/null +++ b/docs/ONAP Model Spec/im/VES/VES-enumeration.rst @@ -0,0 +1,451 @@ +.. Copyright 2019 +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +VES Enumeration definition +-------------------------- + +.. contents:: + :depth: 3 +.. + +AlertAction enumeration +^^^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Ves::TypeDefinitions::AlertAction + +**Description:** + +Possible alertActions within thresholdCrossingAlertFields + +**Applied Stereotypes:** + +- Preliminary + +**Contains Enumeration Literals:** + +- SET + +- CONT + +- CLEAR + +AlertType enumeration +^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Ves::TypeDefinitions::AlertType + +**Description:** + +Possible values for ThresholdCrossingAlertFIelds alertType attribute. + +**Applied Stereotypes:** + +- Preliminary + +**Contains Enumeration Literals:** + +- CARD_ANOMALY + +- INTERFACE_ANOMALY + +- ELEMENT_ANOMALY + +- SERVICE_ANOMALY + +Domain enumeration +^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Ves::TypeDefinitions::Domain + +**Description:** + +domain - Event domain enumeration: + +'fault', 'heartbeat', 'measurementsForVfScaling', 'mobileFlow', 'other', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' + +**Applied Stereotypes:** + +- Preliminary + +**Contains Enumeration Literals:** + +- FAULT + +- HEARTBEAT + +- MEASUREMENT + +- MOBILEFLOW + +- NOTIFICATION + +- OTHER + +- PERF3GPP + +- PNFREGISTRATION + +- SIPSIGNALING + +- STATECHANGE + +- SYSLOG + +- THRESHOLDCROSSINGALERT + +- VOICEQUALITY + +EndpointDescription enumeration +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Ves::TypeDefinitions::EndpointDescription + +**Applied Stereotypes:** + +- Preliminary + +**Contains Enumeration Literals:** + +- CALLER + +- CALLEE + +EventSeverity enumeration +^^^^^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Ves::TypeDefinitions::EventSeverity + +**Description:** + +Event severity enumeration: 'CRITICAL', 'MAJOR', 'MINOR', 'WARNING', 'NORMAL'. NORMAL is used to represent clear. + +**Applied Stereotypes:** + +- Preliminary + +**Contains Enumeration Literals:** + +- CRITICAL + +- MAJOR + +- MINOR + +- WARNING + +- NORMAL + +NicAdminState enumeration +^^^^^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Ves::TypeDefinitions::NicAdminState + +**Applied Stereotypes:** + +- Preliminary + +**Contains Enumeration Literals:** + +- IN_SERVICE + +- OUT_OF_SERVICE + +NicOpsState enumeration +^^^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Ves::TypeDefinitions::NicOpsState + +**Applied Stereotypes:** + +- Preliminary + +**Contains Enumeration Literals:** + +- IN_SERVICE + +- OUT_OF_SERVICE + +SyslogFacility enumeration +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Ves::TypeDefinitions::SyslogFacility + +**Description:** + +Numeric code from 0 to 23 for facility: + +0 kernel messages + +1 user-level messages + +2 mail system + +3 system daemons + +4 security/authorization messages + +5 messages generated internally by syslogd + +6 line printer subsystem + +7 network news subsystem + +8 UUCP subsystem + +9 clock daemon + +10 security/authorization messages + +11 FTP daemon + +12 NTP subsystem + +13 log audit + +14 log alert + +15 clock daemon (note 2) + +16 local use 0 (local0) + +17 local use 1 (local1) + +18 local use 2 (local2) + +19 local use 3 (local3) + +20 local use 4 (local4) + +21 local use 5 (local5) + +22 local use 6 (local6) + +23 local use 7 (local7) + +**Applied Stereotypes:** + +- Preliminary + +**Contains Enumeration Literals:** + +- 0 + + - kernel messages + +- 1 + + - user-level messages + +- 2 + + - mail system + +- 3 + + - system daemons + +- 4 + + - security/authorization messages + +- 5 + + - messages generated internally by syslogd + +- 6 + + - line printer subsystem + +- 7 + + - network news subsystem + +- 8 + + - UUCP subsystem + +- 9 + + - clock daemon + +- 10 + + - security/authorization messages + +- 11 + + - FTP daemon + +- 12 + + - NTP subsystem + +- 13 + + - log audit + +- 14 + + - log alert + +- 15 + + - clock daemon + +- 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 ) + +SyslogSev enumeration +^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Ves::TypeDefinitions::SyslogSev + +**Description:** + +Level-of-severity text enumeration defined below: + +Text Sev Description + +Emergency 0 system is unusable + +Alert 1 action must be taken immediately + +Critical 2 critical conditions + +Error 3 error conditions + +Warning 4 warning conditions + +Notice 5 normal but significant condition + +Info 6 Informational messages + +Debug 7 debug-level messages + +**Applied Stereotypes:** + +- Preliminary + +**Contains Enumeration Literals:** + +- EMERGENCY + + - 0 + + - system is unusable + +- ALERT + + - action must be taken immediately + + - 1 + +- CRITICAL + + - 2 + + - critical conditions + +- ERROR + + - error conditions + + - 3 + +- WARNING + + - 4 + + - warning conditions + +- NOTICE + + - 5 + + - normal but significant condition + +- INFO + + - 6 + + - Informational messages + +- DEBUG + + - 7 + + - debug-level messages + +TCACriticality enumeration +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Ves::TypeDefinitions::TCACriticality + +**Description:** + +Threshold Crossing Alert counter criticality - possible values of CRIT and MAJ. + +**Applied Stereotypes:** + +- Preliminary + +**Contains Enumeration Literals:** + +- CRIT + +- MAJ + +VfStatus enumeration +^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Ves::TypeDefinitions::VfStatus + +**Description:** + +Virtual function status enumeration: 'Active', 'Idle', 'Preparing to terminate', 'Ready to terminate', 'Requesting Termination' + +**Applied Stereotypes:** + +- Preliminary + +**Contains Enumeration Literals:** + +- ACTIVE + +- IDLE + +- PREPARING_TO_TERMINATE + +- READY_TO_TERMINATE + +- REQUESTING_TERMINATION |