...
1.1.1 Event - High Level
1.1.2 Event Datatypes
1.1.3 Measurement Domain Entities
...
Attribute Name | Type | Mult. | Stereotypes | Description |
additionalFields | HashMap | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Additional stateChange fields if needed |
newState | invalid | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | New state of the entity: 'inService', 'maintenance', 'outOfService' |
OldState | invalid | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Previous state of the entity: 'inService', 'maintenance', 'outOfService' |
stateChangeFieldsVersion | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Version of the stateChangeFields block as "#.#" where # is a digit; see section 1 for the correct digits to use. |
stateInterface | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Card or port name of the entity that changed state |
domain | Domain | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Event domain enumeration: 'fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'stndDefined', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' |
eventType | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' |
lastEpochMicrosec | Number | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds |
nfcNamingCode | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Network function component type: 3 characters (aligned with vfc naming standards) |
nfNamingCode | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Network function type: 4 characters (aligned with vnf and pnf naming standards) |
nfVendorName | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Network function vendor name |
priority | Priority | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' |
reportingEntityId | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See 'reportingEntityName' for more information. reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. |
reportingEntityName | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. |
sequence | Integer | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Ordering of events communicated by an event source instance (or 0 if not needed) sequence - Ordering of events communicated by an event source instance (or 0 if not needed) |
sourceId | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See 'sourceName' for more information. |
sourceName | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. |
startingEpochMicrosec | Number | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) |
timeZoneOffset | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Offset to GMT to indicate local time zone for device formatted as 'UTC+/-hh:mm'; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples |
version | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. |
vesEventListenerVersion | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Version of the ves event listener api spec that this event is compliant with (as "#" or "#.#" or "#.#.#" where # is a digit; see section 1 for the correct digits to use). |
name | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | |
Status | String | 0..1 | Experimental OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | The current condition of an interaction, such as open, in research, closed, and so forth |
description | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Defines a textual free-form description of the object. |
id | Identifier | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Unambiguously distinguishes different object instances. It is the naming attribute of the object. Identifier of this information element. This attribute shall be globally unique. |
1.2.
...
44 StndDefined (New with R7 Release)
The stndDefined datatype defines fields for events belonging to the 'stndDefined' domain of the commonEventHeader domain enumeration; it consists of the following fields:
Parent class: VesEvent
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
- Preliminary
Attribute Name | Type | Mult. | Stereotypes | Description | additionalFields | HashMap||
stndDefined:: schemaReference | String | 0.. | *1 | Preliminary OpenModelAttribute · isInvariant: | falsetrue · valueRange: no range constraint · support: | MANDATORYAdditional syslog fields if needed Ex: {"name1": "
| An uri of a standards-defined JSON object schema; used to valide the stndDefinedFields.data property contents |
stndDefined:: | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | A native standards-defined JSON notification | |||
stndDefined:: stndDefinedFieldsVersion | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Version of the stndDefinedFields block as "#.#" where # is a digit; see section 1 for the correct digits to use. | |||
VesEvent:: domain | Domain | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Event domain enumeration: 'fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'stndDefined', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' | |||
VesEvent:: eventType | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' | |||
VesEvent:: lastEpochMicrosec | Number | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds | |||
VesEvent:: nfcNamingCode | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Network function component type: 3 characters (aligned with vfc naming standards) | |||
VesEvent:: nfNamingCode | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Network function type: 4 characters (aligned with vnf and pnf naming standards) | |||
VesEvent:: nfVendorName | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Network function vendor name | |||
VesEvent:: priority | Priority | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' | |||
VesEvent:: reportingEntityId | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See 'reportingEntityName' for more information. reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. | |||
VesEvent:: reportingEntityName | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. | |||
VesEvent:: sequence | Integer | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Ordering of events communicated by an event source instance (or 0 if not needed) sequence - Ordering of events communicated by an event source instance (or 0 if not needed) | |||
VesEvent:: sourceId | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See 'sourceName' for more information. | |||
VesEvent:: sourceName | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. | |||
VesEvent:: startingEpochMicrosec | Number | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) | |||
VesEvent:: stndDefinedNamespace | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Standards organization defined event namespace; expected usage includes event routing by the event listener | |||
VesEvent:: timeZoneOffset | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Offset to GMT to indicate local time zone for device formatted as 'UTC+/-hh:mm'; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples | |||
VesEvent:: version | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. | |||
VesEvent:: vesEventListenerVersion | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Version of the ves event listener api spec that this event is compliant with (as "#" or "#.#" or "#.#.#" where # is a digit; see section 1 for the correct digits to use). | |||
VesEvent:: name | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | ||||
VesEvent:: Status | String | 0..1 | Experimental OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | The current condition of an interaction, such as open, in research, closed, and so forth | |||
VesEvent:: description | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Defines a textual free-form description of the object. | |||
VesEvent:: id | Identifier | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Unambiguously distinguishes different object instances. It is the naming attribute of the object. Identifier of this information element. This attribute shall be globally unique. |
1.2.45 Syslog
Syslog's can be classified as either Control or Session/Traffic. They differ by message content and expected volume: • Control logs are generally free-form human-readable text used for reporting errors or warnings supporting the operation and troubleshooting of NFs. The volume of these logs is typically less than 2k per day. • Session logs use common structured fields to report normal NF processing such as DNS lookups or firewall rules processed. The volume of these logs is typically greater than 1k per hour (and sometimes as high as 10k per second). VES supports both classes of syslog, however VES is only recommended for control logs or for lower volume session logs, less than 60k per hour. High volume session logging should use a file-based transport solution.
Parent class: VesEvent
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
- Preliminary
Attribute Name | Type | Mult. | Stereotypes | Description |
additionalFields | HashMap | 0..* | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Additional syslog fields if needed Ex: {"name1": "value1", "name2: "value2" … } |
eventSourceHost | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Hostname of the device |
eventSourceType | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Examples: 'other', 'router', 'switch', 'host', 'card', 'port', 'slotThreshold', 'portThreshold', 'virtualMachine', 'virtualNetworkFunction' |
syslogSdId | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | 0-32 char in format name@number, i.e., ourSDID@32473 |
syslogFacilty | SyslogFacility | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Numeric code from 0 to 23 for facility: 0 kernel messages 1 user-level messages 2 mail system 3 system daemons 4 security/authorization messages 5 messages generated internally by syslogd 6 line printer subsystem 7 network news subsystem 8 UUCP subsystem 9 clock daemon 10 security/authorization messages 11 FTP daemon 12 NTP subsystem 13 log audit 14 log alert 15 clock daemon (note 2) 16 local use 0 (local0) 17 local use 1 (local1) 18 local use 2 (local2) 19 local use 3 (local3) 20 local use 4 (local4) 21 local use 5 (local5) 22 local use 6 (local6) 23 local use 7 (local7 ) |
syslogFieldVersion | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Version of the syslogFields block as "#.#" where # is a digit; see section 1 for the correct digits to use. |
syslogMsg | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Syslog message |
syslogMsgHost | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Hostname parsed from non-VES syslog message |
syslogPri | Integer | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | 0-192 Combined Severity and Facility (see rfc5424) |
syslogProc | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Identifies the application that originated the message |
syslogProcId | Number | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | The process number assigned by the OS when the application was started |
syslogSData | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | A <space> separated list of key="value" pairs following the rfc5424 standard for SD-ELEMENT. Deprecated The entire rfc5424 syslogSData object, including square brackets [ ], SD-ID and list of SD-PARAMs |
syslogSev | SyslogSev | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Level-of-severity text enumeration defined below: Text Sev Description Emergency 0 system is unusable Alert 1 action must be taken immediately Critical 2 critical conditions Error 3 error conditions Warning 4 warning conditions Notice 5 normal but significant condition Info 6 Informational messages Debug 7 debug-level messages |
syslogTag | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Also known as MsgId. Brief non-spaced text indicating the type of message such as 'TCPOUT' or 'BGP_STATUS_CHANGE'; 'NILVALUE' should be used when no other value can be provided |
syslogTs | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Timestamp parsed from non-VES syslog message |
syslogVer | Number | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | IANA assigned version of the syslog protocol specification: 0: VES 1: IANA RFC5424 |
domain | Domain | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Event domain enumeration: 'fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'stndDefined, 'syslog', 'thresholdCrossingAlert', 'voiceQuality' |
eventType | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' |
lastEpochMicrosec | Number | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds |
nfcNamingCode | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Network function component type: 3 characters (aligned with vfc naming standards) |
nfNamingCode | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Network function type: 4 characters (aligned with vnf and pnf naming standards) |
nfVendorName | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Network function vendor name |
priority | Priority | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' |
reportingEntityId | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See 'reportingEntityName' for more information. reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. |
reportingEntityName | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. |
sequence | Integer | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Ordering of events communicated by an event source instance (or 0 if not needed) sequence - Ordering of events communicated by an event source instance (or 0 if not needed) |
sourceId | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See 'sourceName' for more information. |
sourceName | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. |
startingEpochMicrosec | Number | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) |
timeZoneOffset | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Offset to GMT to indicate local time zone for device formatted as 'UTC+/-hh:mm'; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples |
version | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. |
vesEventListenerVersion | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Version of the ves event listener api spec that this event is compliant with (as "#" or "#.#" or "#.#.#" where # is a digit; see section 1 for the correct digits to use). |
name | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | |
Status | String | 0..1 | Experimental OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | The current condition of an interaction, such as open, in research, closed, and so forth |
description | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Defines a textual free-form description of the object. |
id | Identifier | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Unambiguously distinguishes different object instances. It is the naming attribute of the object. Identifier of this information element. This attribute shall be globally unique. |
1.2.
...
46 ThresholdCrossingAlert
The thresholdCrossingAlertFields datatype consists of the following fields:
...
Attribute Name | Type | Mult. | Stereotypes | Description |
additionalFields | HashMap | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | additionalFields - Additional pnfRegistration fields if needed. |
additionalParameters | ThresholdCrossingAlertCounter | 1..* | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Array of performance counters |
alertAction | AlertAction | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Enumeration: 'SET', 'CONT', 'CLEAR' |
alertDescription | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Unique short alert description (e.g., NE-CPUMEM) |
alertType | AlertType | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Enumeration: 'CARD-ANOMALY', 'INTERFACE-ANOMALY', ELEMENT-ANOMALY', 'SERVICE-ANOMALY' |
alertValue | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Calculated API value (if applicable) |
associatedAlertIdList | String | 0..* | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | List of eventIds associated with the event being reported |
collectionTimestamp | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Time when the performance collector picked up the data; with RFC 2822 compliant format: 'Sat, 13 Mar 2010 11:29:05 -0800' |
dataCollector | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Specific performance collector instance used |
elementType | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Type of network element (internal AT&T field) |
eventSeverity | EventSeverity | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Event severity or priority enumeration: 'CRITICAL', 'MAJOR', 'MINOR', 'WARNING', 'NORMAL' |
eventStartTimestamp | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Time closest to when the measurement was made; with RFC 2822 compliant format: 'Sat, 13 Mar 2010 11:29:05 -0800' |
interfaceName | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Physical or logical port or card (if applicable |
networkService | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Network name (internal AT&T field) |
possibleRootCause | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Reserved for future use |
thresholdCrossingFieldsVersion | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Version of the thresholdCrossingAlertFields block as "#.#" where # is a digit; see section 1 for the correct digits to use. |
domain | Domain | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Event domain enumeration: 'fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'stndDefined', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' |
eventType | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' |
lastEpochMicrosec | Number | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds |
nfcNamingCode | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Network function component type: 3 characters (aligned with vfc naming standards) |
nfNamingCode | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Network function type: 4 characters (aligned with vnf and pnf naming standards) |
nfVendorName | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Network function vendor name |
priority | Priority | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' |
reportingEntityId | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See 'reportingEntityName' for more information. reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. |
reportingEntityName | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. |
sequence | Integer | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Ordering of events communicated by an event source instance (or 0 if not needed) sequence - Ordering of events communicated by an event source instance (or 0 if not needed) |
sourceId | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See 'sourceName' for more information. |
sourceName | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. |
startingEpochMicrosec | Number | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) |
timeZoneOffset | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Offset to GMT to indicate local time zone for device formatted as 'UTC+/-hh:mm'; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples |
version | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. |
vesEventListenerVersion | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Version of the ves event listener api spec that this event is compliant with (as "#" or "#.#" or "#.#.#" where # is a digit; see section 1 for the correct digits to use). |
name | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | |
Status | String | 0..1 | Experimental OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | The current condition of an interaction, such as open, in research, closed, and so forth |
description | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Defines a textual free-form description of the object. |
id | Identifier | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Unambiguously distinguishes different object instances. It is the naming attribute of the object. Identifier of this information element. This attribute shall be globally unique. |
1.2.
...
47 VendorNfNameFields
vendorNfNameFields - The vendorNfNameFields provides vendor, nf and nfModule identifying information.
...
Attribute Name | Type | Mult. | Stereotypes | Description |
nfModuleName | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | nfModuleName - Name of the nfModule generating the event. |
nfName | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | nfName - Name of the network function generating the event |
vendorName | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | vendorName - Network function vendor name. |
1.2.
...
48 VesEvent
An ONAP event is an aggregation of a header and a message. Event messages may be published to a message broker by service instances, resource instances, or ONAP platform components. Service or resource instances may be in support of network infrastructure or customer services. Interested platforms may subscribe to events on the message broker (e.g. Centralized Testing Platform CTP) may see an event on a service VNF instance and perform an automated test as part of a closed loop management policy. Events are unique and distinguishable from one another. ONAP event messages are serialized as a unicode ASCII character string which may be formatted as JSON, XML, etc... Appropriate schemas will be supplied.
...
Attribute Name | Type | Mult. | Stereotypes | Description |
domain | Domain | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Event domain enumeration: 'fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'stndDefined', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' |
eventType | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' |
lastEpochMicrosec | Number | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds |
nfcNamingCode | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Network function component type: 3 characters (aligned with vfc naming standards) |
nfNamingCode | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Network function type: 4 characters (aligned with vnf and pnf naming standards) |
nfVendorName | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Network function vendor name |
priority | Priority | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' |
reportingEntityId | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See 'reportingEntityName' for more information. reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. |
reportingEntityName | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. |
sequence | Integer | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Ordering of events communicated by an event source instance (or 0 if not needed) sequence - Ordering of events communicated by an event source instance (or 0 if not needed) |
sourceId | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See 'sourceName' for more information. |
sourceName | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. |
startingEpochMicrosec | Number | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) |
timeZoneOffset | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Offset to GMT to indicate local time zone for device formatted as 'UTC+/-hh:mm'; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples |
version | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. |
vesEventListenerVersion | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Version of the ves event listener api spec that this event is compliant with (as "#" or "#.#" or "#.#.#" where # is a digit; see section 1 for the correct digits to use). |
name | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | |
Status | String | 0..1 | Experimental OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | The current condition of an interaction, such as open, in research, closed, and so forth |
description | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Defines a textual free-form description of the object. |
id | Identifier | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Unambiguously distinguishes different object instances. It is the naming attribute of the object. Identifier of this information element. This attribute shall be globally unique. |
1.2.
...
49 VoiceQuality
The voiceQuality class provides statistics related to customer facing voice products; consists of the following fields:
...
Attribute Name | Type | Mult. | Stereotypes | Description |
additionalInformation | HashMap | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Additional voice quality fields |
calleeSideCodec | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Callee codec for the call |
callerSideCodec | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Caller codec for the call |
correlator | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Constant across all events on this call |
phoneNumber | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Phone number associated with the correlator |
midCallRtcp | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Base64 encoding of the binary RTCP data (excluding Eth/IP/UDP headers) |
voiceQualityFieldsVersion | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Version of the voiceQualityFields block as "#.#" where # is a digit; see section 1 for the correct digits to use. |
_endofcallvqmsummaries | EndOfCallVqmSummaries | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | End of call voice quality metric summaries |
_vendornfnamefields | VendorNfNameFields | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Vendor, NF and nfModule names |
domain | Domain | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Event domain enumeration: 'fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'stndDefined', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' |
eventType | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' |
lastEpochMicrosec | Number | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds |
nfcNamingCode | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Network function component type: 3 characters (aligned with vfc naming standards) |
nfNamingCode | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Network function type: 4 characters (aligned with vnf and pnf naming standards) |
nfVendorName | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Network function vendor name |
priority | Priority | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' |
reportingEntityId | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See 'reportingEntityName' for more information. reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. |
reportingEntityName | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. |
sequence | Integer | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Ordering of events communicated by an event source instance (or 0 if not needed) sequence - Ordering of events communicated by an event source instance (or 0 if not needed) |
sourceId | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See 'sourceName' for more information. |
sourceName | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. |
startingEpochMicrosec | Number | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) |
timeZoneOffset | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Offset to GMT to indicate local time zone for device formatted as 'UTC+/-hh:mm'; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples |
version | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. |
vesEventListenerVersion | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Version of the ves event listener api spec that this event is compliant with (as "#" or "#.#" or "#.#.#" where # is a digit; see section 1 for the correct digits to use). |
name | String | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | |
Status | String | 0..1 | Experimental OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | The current condition of an interaction, such as open, in research, closed, and so forth |
description | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Defines a textual free-form description of the object. |
id | Identifier | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Unambiguously distinguishes different object instances. It is the naming attribute of the object. Identifier of this information element. This attribute shall be globally unique. |
1.2.
...
50 measInfoIdInteger
The measInfoIdInteger datatype provides an integer measurement group identifier;
...
Attribute Name | Type | Mult. | Stereotypes | Description |
iMeasInfoId | Integer | 1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | Integer measurement group Identifier |
1.2.
...
51 measResultNull
The measResultNull datatype provides a null 3GPP PM measurement result
...