...
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 pnfRegistrationFields stndDefined datatype defines fields for events belonging to the 'pnfRegistrationstndDefined' 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
stndDefined:: schemaReference | String | 0..1 | Preliminary OpenModelAttribute · isInvariant: |
lastServiceDate
String
true · valueRange: no range constraint · support: |
Additional pnfRegistration fields if needed
macAddress
| 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 |
TS 32.692 dateOfLastService = date of last service; e.g. 15022017
A native standards-defined JSON notification | |
stndDefined:: stndDefinedFieldsVersion | String |
manufactureDate
String
1 | Preliminary OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY |
MAC address of OAM interface of the unit
modelNumberVersion 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 |
TS 32.692 dateOfManufacture = manufacture date of the unit; 24032016
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 |
TS 32.692 versionNumber = version of the unit from vendor; e.g. AJ02. Maps to AAI equip-model
oamV4lpAddress
String
0..1
Preliminary
OpenModelAttribute
· isInvariant: false
· valueRange: no range constraint
· support: MANDATORY
IPv4 m-plane IP address to be used by the manager to contact the PNF
oamV6lpAddress
String
0..1
Preliminary
OpenModelAttribute
· isInvariant: false
· valueRange: no range constraint
· support: MANDATORY
IPv6 m-plane IP address to be used by the manager to contact the PNF
pnfRegistrationFieldsVersion
String
1
Preliminary
OpenModelAttribute
· isInvariant: false
· valueRange: no range constraint
· support: MANDATORY
Version of the registrationFields block as "#.#" where # is a digit; see section 1 for the correct digits to use.
serialNumber
String
0..1
Preliminary
OpenModelAttribute
· isInvariant: false
· valueRange: no range constraint
· support: MANDATORY
TS 32.692 serialNumber = serial number of the unit; e.g. 6061ZW3
softwareVersion
String
0..1
Preliminary
OpenModelAttribute
· isInvariant: false
· valueRange: no range constraint
· support: MANDATORY
TS 32.692 swName = active SW running on the unit; e.g. 5gDUv18.05.201
unitFamily
String
0..1
Preliminary
OpenModelAttribute
· isInvariant: false
· valueRange: no range constraint
· support: MANDATORY
TS 32.692 vendorUnitFamilyType = general type of HW unit; e.g. BBU
unitType
String
0..1
Preliminary
OpenModelAttribute
· isInvariant: false
· valueRange: no range constraint
· support: MANDATORY
TS 32.692 vendorUnitTypeNumber = vendor name for the unit; e.g. Airscale
vendorName
String
0..1
Preliminary
OpenModelAttribute
· isInvariant: false
· valueRange: no range constraint
· support: MANDATORY
TS 32.692 vendorName = name of manufacturer; e.g. Nokia. Maps to AAI equip-vendor
domain
Domain
1
Preliminary
OpenModelAttribute
· isInvariant: false
· valueRange: no range constraint
· support: MANDATORY
Event domain enumeration: 'fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'stndDefined', 'syslog', 'thresholdCrossingAlert', 'voiceQuality'
eventType
String
0..1
Preliminary
OpenModelAttribute
· isInvariant: false
· valueRange: no range constraint
· support: MANDATORY
For example: 'applicationNf', 'guestOS', 'hostOS', 'platform'
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
...