Please note that this is a work in progress.
1.1 Diagrams
Event - High Level
Measurement Domain
1.1 Classes
1.1.1 CommonEventHeader
commonEventHeader - Fields common to all events.
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
domain | Domain | 1 | OpenModelAttribute
| Event domain enumeration: 'fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality'
|
eventId | String | 1 | OpenModelAttribute
| Event key that is unique to the event source. The key must be unique within notification life cycle similar to EventID from 3GPP. It could be a sequential number, or a composite key formed from the event fields, such as domain_sequence. The eventId should not include whitespace. For fault events, eventId is the eventId of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, eventId must be the same as the initial alarm (along with the same startEpochMicrosec but with a different sequence number). Note: see section 1.3 for eventId use case examples.
|
eventName | String | 1 | OpenModelAttribute
| eventName - Unique event name. To prevent naming collisions, eventName sent as part of the commonEventHeader, should conform to the following naming convention designed to summarize the purpose and type of the event, and to ensure the uniqueness of the eventName: {DomainAbbreviation}_{NamingCode or ApplicationPlatform}_{DescriptionOfInfoBeingConveyed} Domain abbreviations are derived from the 'domain' field in the commonEventHeader, as specified below: 'Fault' for the fault domain 'Heartbeat' for the heartbeat domain 'Measurement' for the measurements domain 'MobileFlow' for the mobileFlow domain 'Other' for the other domain 'PnfReg' for the pnfRegistration domain 'SipSignaling' for the sipSignaling domain 'StateChange' for the stateChange domain 'Syslog' for the syslog domain 'Tca' for the thresholdCrossingAlert domain 'VoiceQuality' for the voiceQuality domain Unique event name
|
eventType | String | 0..1 | OpenModelAttribute
| For example: 'applicationNf', 'guestOS', 'hostOS', 'platform'
|
lastEpochMicrosec | Number | 1 | OpenModelAttribute
| the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds
|
nfcNamingCode | String | 0..1 | OpenModelAttribute
| Network function component type: 3 characters (aligned with vfc naming standards)
|
nfNamingCode | String | 0..1 | OpenModelAttribute
| Network function type: 4 characters (aligned with vnf and pnf naming standards)
|
nfVendorName | String | 1 | OpenModelAttribute
|
|
priority | Priority | 1 | OpenModelAttribute
| Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low'
|
reportingEntityId | String | 0..1 | OpenModelAttribute
| UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See 'reportingEntityName' for more information. reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information.
|
reportingEntityName | String | 1 | OpenModelAttribute
| Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. 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 | OpenModelAttribute
| 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 | OpenModelAttribute
| sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. 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 | OpenModelAttribute
| sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. 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 | OpenModelAttribute
| the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) 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).
|
timeZoneOffset | String | 0..1 | OpenModelAttribute
| Offset to GMT to indicate local time zone for device formatted as 'UTC+/-hh.mm'; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples
|
version | String | 1 | OpenModelAttribute
| Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use.
|
vesEventListenerVersion | String | 1 | OpenModelAttribute
| Version of the ves event listener api spec that this event is compliant with (as "#" or "#.#" or "#.#.#" where # is a digit; see section 1 for the correct digits to use).
|
1.1.2 CodecsInUse
The codecsInUse datatype consists of the following fields describing the number of times an identified codec was used over the measurementInterval
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
codecIdentifier | String | 1 | OpenModelAttribute
| Description of the codec.
|
numberInUse | Integer | 1 | OpenModelAttribute
| Number of such codecs in use.
|
1.1.3 CpuUsage
The cpuUsage datatype defines the usage of an identifier CPU and consists of the following fields:
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
cpuCapacityContention | Number | 0..1 | OpenModelAttribute
| The amount of time the CPU cannot run due to contention, in milliseconds over the measurementInterval
|
cpuDemandAvg | Number | 0..1 | OpenModelAttribute
| The total CPU time that the NF/NFC/VM could use if there was no contention, in milliseconds over the measurementInterval
|
cpuDemandMhz | Number | 0..1 | OpenModelAttribute
| CPU demand in MHz
|
cpuDemandPct | Number | 0..1 | OpenModelAttribute
| CPU demand as a percentage of the provisioned capacity
|
cpuIdentifier | String | 1 | OpenModelAttribute
| CPU Identifier
|
cpuIdle | Number | 0..1 | OpenModelAttribute
| Percentage of CPU time spent in the idle task
|
cpuLatencyAvg | Number | 0..1 | OpenModelAttribute
| cpuDemandAvg - The total CPU time that the VNF/VNFC/VM could use if there is no contention, in milliseconds.
|
cpuOverheadAvg | Number | 0..1 | OpenModelAttribute
| The overhead demand above available allocations and reservations, in milliseconds over the measurementInterval
|
cpuSwapWaitTime | Number | 0..1 | OpenModelAttribute
| Swap wait time, in milliseconds over the measurementInterval
|
cpuUsageInterrupt | Number | 0..1 | OpenModelAttribute
| Percentage of time spent servicing interrupts
|
cpuUsageNice | Number | 0..1 | OpenModelAttribute
| Percentage of time spent running user space processes that have been niced
|
cpuUsageSoftIrq | Number | 0..1 | OpenModelAttribute
| Percentage of time spent handling soft irq interrupts
|
cpuUsageSteal | Number | 0..1 | OpenModelAttribute
| Percentage of time spent in involuntary wait which is neither user, system or idle time and is effectively time that went missing
|
cpuUsageSystem | Number | 0..1 | OpenModelAttribute
| Percentage of time spent on system tasks running the kernel
|
cpuUsageUser | Number | 0..1 | OpenModelAttribute
| Percentage of time spent running un-niced user space processes
|
cpuWait | Number | 0..1 | OpenModelAttribute
| Percentage of CPU time spent waiting for I/O operations to complete
|
percentUsage | Number | 1 | OpenModelAttribute
| Aggregate cpu usage of the virtual machine on which the xNFC reporting the event is running
|
1.1.4 DiskUsage
The diskUsage datatype defines the usage of a disk device.
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
diskBusResets | Number | 0..1 | OpenModelAttribute
| The number of bus resets in the performance interval.
|
diskCommandsAborted | Number | 0..1 | OpenModelAttribute
| Number of disk commands aborted over the measurementInterval.
|
diskCommandsAvg | Number | 0..1 | OpenModelAttribute
| Average number of commands per second over the measurementInterval.
|
diskFlushRequests | Number | 0..1 | OpenModelAttribute
| Total flush requests of the disk cache over the measurementInterval.
|
diskFlushTime | Number | 0..1 | OpenModelAttribute
| Milliseconds spent on disk cache flushing over the measurementInterval.
|
diskIdentifier | String | 1 | OpenModelAttribute
| Disk Identifier.
|
diskIoTimeAvg | Number | 1 | OpenModelAttribute
| Milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the average over the measurement interval
|
diskIoTimeLast | Number | 0..1 | OpenModelAttribute
| Milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the last value measurement within the measurement interval.
|
diskIoTimeMax | Number | 0..1 | OpenModelAttribute
| Milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the maximum value measurement within the measurement interval
|
diskIoTimeMin | Number | 0..1 | OpenModelAttribute
| Milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the minimum value measurement within the measurement interval.
|
diskMergedReadAvg | Number | 0..1 | OpenModelAttribute
| Number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the average measurement within the measurement interval.
|
diskMergedReadLast | Number | 0..1 | OpenModelAttribute
| Number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the last value measurement within the measurement interval.
|
diskMergedReadMax | Number | 0..1 | OpenModelAttribute
| Number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the maximum value measurement within the measurement interval.
|
diskMergedReadMin | Number | 0..1 | OpenModelAttribute
| Number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the minimum value measurement within the measurement interval.
|
diskMergedWriteAvg | Number | 0..1 | OpenModelAttribute
| Number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the average measurement within the measurement interval
|
diskMergedWriteLast | Number | 0..1 | OpenModelAttribute
| Number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the last value measurement within the measurement interval.
|
diskMergedWriteMax | Number | 0..1 | OpenModelAttribute
| Number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the maximum value measurement within the measurement interval.
|
diskMergedWriteMin | Number | 0..1 | OpenModelAttribute
| Number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the minimum value measurement within the measurement interval.
|
diskOctetsReadAvg | Number | 0..1 | OpenModelAttribute
| Number of octets per second read from a disk or partition; provide the average measurement within the measurement interval.
|
diskOctetsReadLast | Number | 0..1 | OpenModelAttribute
| Number of octets per second read from a disk or partition; provide the last measurement within the measurement interval
|
diskOctetsReadMax | Number | 0..1 | OpenModelAttribute
| Number of octets per second read from a disk or partition; provide the maximum measurement within the measurement interval.
|
diskOctetsReadMin | Number | 0..1 | OpenModelAttribute
| Number of octets per second read from a disk or partition; provide the minimum measurement within the measurement interval.
|
diskOctetsWriteAvg | Number | 0..1 | OpenModelAttribute
| Number of octets per second written to a disk or partition; provide the average measurement within the measurement interval.
|
diskOctetsWriteLast | Number | 0..1 | OpenModelAttribute
| Number of octets per second written to a disk or partition; provide the last measurement within the measurement interval.
|
diskOctetsWriteMax | Number | 0..1 | OpenModelAttribute
| Number of octets per second written to a disk or partition; provide the maximum measurement within the measurement interval.
|
diskOctetsWriteMin | Number | 0..1 | OpenModelAttribute
| Number of octets per second written to a disk or partition; provide the minimum measurement within the measurement interval.
|
diskOpsReadAvg | Number | 0..1 | OpenModelAttribute
| Number of read operations per second issued to the disk; provide the average measurement within the measurement interval.
|
diskOpsReadLast | Number | 0..1 | OpenModelAttribute
| Number of read operations per second issued to the disk; provide the last measurement within the measurement interval.
|
diskOpsReadMax | Number | 0..1 | OpenModelAttribute
| Number of read operations per second issued to the disk; provide the maximum measurement within the measurement interval.
|
diskOpsReadMin | Number | 0..1 | OpenModelAttribute
| Number of read operations per second issued to the disk; provide the minimum measurement within the measurement interval.
|
diskOpsWriteAvg | Number | 0..1 | OpenModelAttribute
| Number of write operations per second issued to the disk; provide the average measurement within the measurement interval.
|
diskOpsWriteLast | Number | 0..1 | OpenModelAttribute
| Number of write operations per second issued to the disk; provide the last measurement within the measurement interval.
|
diskOpsWriteMax | Number | 0..1 | OpenModelAttribute
| Number of write operations per second issued to the disk; provide the maximum measurement within the measurement interval.
|
diskOpsWriteMin | Number | 0..1 | OpenModelAttribute
| Number of write operations per second issued to the disk; provide the minimum measurement within the measurement interval.
|
diskPendingOperationsAvg | Number | 0..1 | OpenModelAttribute
| Queue size of pending I/O operations per second; provide the average measurement within the measurement interval.
|
diskPendingOperationsLast | Number | 0..1 | OpenModelAttribute
| Queue size of pending I/O operations per second; provide the last measurement within the measurement interval.
|
diskPendingOperationsMax | Number | 0..1 | OpenModelAttribute
| Queue size of pending I/O operations per second; provide the maximum measurement within the measurement interval.
|
diskPendingOperationsMin | Number | 0..1 | OpenModelAttribute
| diskPendingOperationsMin - Queue size of pending I/O operations per second; provide the minimum measurement within the measurement interval.
|
diskReadCommandsAvg | Number | 0..1 | OpenModelAttribute
| Average number of read commands issued per second to the disk over the measurementInterval.
|
diskTime | Number | 0..1 | OpenModelAttribute
| Nanoseconds spent on disk cache reads/writes within the measurementInterval.
|
diskTimeReadAvg | Number | 0..1 | OpenModelAttribute
| Milliseconds a read operation took to complete; provide the average measurement within the measurement interval.
|
diskTimeReadLast | Number | 0..1 | OpenModelAttribute
| Milliseconds a read operation took to complete; provide the last measurement within the measurement interval.
|
diskTimeReadMax | Number | 0..1 | OpenModelAttribute
| Milliseconds a read operation took to complete; provide the maximum measurement within the measurement interval.
|
diskTimeReadMin | Number | 0..1 | OpenModelAttribute
| Milliseconds a read operation took to complete; provide the minimum measurement within the measurement interval.
|
diskTimeWriteAvg | Number | 0..1 | OpenModelAttribute
| Milliseconds a write operation took to complete; provide the average measurement within the measurement interval.
|
diskTimeWriteLast | Number | 0..1 | OpenModelAttribute
| Milliseconds a write operation took to complete; provide the last measurement within the measurement interval.
|
diskTimeWriteMax | Number | 0..1 | OpenModelAttribute
| Milliseconds a write operation took to complete; provide the maximum measurement within the measurement interval.
|
diskTimeWriteMin | Number | 0..1 | OpenModelAttribute
| Milliseconds a write operation took to complete; provide the minimum measurement within the measurement interval.
|
diskTotalReadLatencyAvg | Number | 0..1 | OpenModelAttribute
| The average amount of time taken for a read from the perspective of a Guest OS. This is the sum of Kernel Read Latency and Physical Device Read Latency in milliseconds over the measurement interval.
|
diskTotalWriteLatencyAvg | Number | 0..1 | OpenModelAttribute
| The average amount of time taken for a write from the perspective of a Guest OS. This is the sum of Kernel Write Latency and Physical Device Write Latency in milliseconds over the measurement interval.
|
diskWeightedIoTimeAvg | Number | 0..1 | OpenModelAttribute
| Measure in ms over 1 sec of both I/O completion time and the backlog that may be accumulating. Value is the average within the collection interval.
|
diskWeightedIoTimeLast | Number | 0..1 | OpenModelAttribute
| Measure in ms over 1 sec of both I/O completion time and the backlog that may be accumulating. Value is the last within the collection interval.
|
diskWeightedIoTimeMax | Number | 0..1 | OpenModelAttribute
| Measure in ms over 1 sec of both I/O completion time and the backlog that may be accumulating. Value is the maximum within the collection interval.
|
diskWeightedIoTimeMin | Number | 0..1 | OpenModelAttribute
| Measure in ms over 1 sec of both I/O completion time and the backlog that may be accumulating. Value is the minimum within the collection interval.
|
diskWriteCommandsAvg | Number | 0..1 | OpenModelAttribute
| Average number of write commands issued per second to the disk over the measurementInterval
|
diskWriteCommandsAvg | Number | 0..1 | OpenModelAttribute
| Average number of write commands issued per second to the disk during the collection interval.
|
1.1.5 Event
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.
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
_fault | Fault | 0..1 | OpenModelAttribute
|
|
_heartbeat | Heartbeat | 0..1 | OpenModelAttribute
|
|
_measurement | Measurement | 0..1 | OpenModelAttribute
|
|
_mobileflow | MobileFlow | 0..1 | OpenModelAttribute
|
|
_notification | Notification | 0..1 | OpenModelAttribute
|
|
_other | Other | 0..1 | OpenModelAttribute
|
|
_pnfregistration | PnfRegistration | 0..1 | OpenModelAttribute
|
|
_sipSignaling | SipSignaling | 0..1 | OpenModelAttribute
|
|
_statechange | StateChange | 0..1 | OpenModelAttribute
|
|
_syslog | SysLog | 0..1 | OpenModelAttribute
|
|
_thresholdCrossingAlert | ThresholdCrossingAlert | 0..1 | OpenModelAttribute
|
|
_voicequality | VoiceQuality | 0..1 | OpenModelAttribute
|
|
_commoneventheader | CommonEventHeader | 1 | OpenModelAttribute
|
|
1.1.6 Fault
Fields specific to fault events
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
alarmAdditionalInformation | HashMap | 0..* | OpenModelAttribute
| Additional alarm information. • Note1: for SNMP mapping to VES, for hash key use OID of varbind, for value use incoming data for that varbind). • Note2: Alarm ID for 3GPP should be included (if applicable) in alarmAdditonalInformation as 'alarmId':'alarmIdValue'. Could contain managed object instance as separate key:value; could add probable cause as separate key:value.
|
alarmCondition | String | 1 | OpenModelAttribute
| Short name of the alarm condition/problem, such as a trap name. Should not have white space (e.g., tpLgCgiNotInConfig, BfdSessionDown, linkDown, etc…)
|
alarmInterfaceA | String | 0..1 | OpenModelAttribute
| Card, port, channel or interface name of the device generating the alarm. This could reflect managed object.
|
eventCatagory | String | 0..1 | OpenModelAttribute
| Event category, for example: 'license', 'link', 'routing', 'security', 'signaling'
|
eventSeverity | EventSeverity | 1 | OpenModelAttribute
| Event severity enumeration: 'CRITICAL', 'MAJOR', 'MINOR', 'WARNING', 'NORMAL'. NORMAL is used to represent clear.
|
eventSourceType | String | 1 | OpenModelAttribute
| Examples: 'card', 'host', 'other', 'port', 'portThreshold', 'router', 'slotThreshold', 'switch', 'virtualMachine', 'virtualNetworkFunction'. This could be managed object class.
|
faultFieldsVersion | String | 1 | OpenModelAttribute
| Version of the faultFields block as "#.#" where # is a digit; see section 1 for the correct digits to use.
|
specificProblem | String | 1 | OpenModelAttribute
| Description of the alarm or problem (e.g., 'eNodeB 155197 in PLMN 310-410 with eNodeB name KYL05197 is lost'). 3GPP probable cause would be included in this field.
|
vfStatus | VfStatus | 1 | OpenModelAttribute
| Virtual function status enumeration: 'Active', 'Idle', 'Preparing to terminate', 'Ready to terminate', 'Requesting Termination'
|
1.1.7 FilesystemUsage
The filesystemUsage datatype consists of the following fields:
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
blockConfigured | Number | 1 | OpenModelAttribute
| Configured block storage capacity in GB.
|
blockops | Number | 1 | OpenModelAttribute
| Block storage input-output operations per second.
|
blockUsed | Number | 1 | OpenModelAttribute
| Used block storage capacity in GB.
|
ephemeralConfigured | Number | 1 | OpenModelAttribute
| Configured ephemeral storage capacity in GB.
|
ephemerallops | Number | 1 | OpenModelAttribute
| Ephemeral storage input-output operations per second.
|
ephemeralUsed | Number | 1 | OpenModelAttribute
| Used ephemeral storage capacity in GB.
|
filesysytemName | String | 1 | OpenModelAttribute
| File system name.
|
1.1.8 Heartbeat
The heartbeatFields datatype is an optional field block for fields specific to heartbeat events.
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
additionalFields | HashMap | 0..1 | OpenModelAttribute
| Additional expansion fields if needed.
|
heartbeatFieldVersion | String | 1 | OpenModelAttribute
| Version of the heartbeatFields block as "#.#" where # is a digit; see section 1 for the correct digits to use.
|
heartbeatInterval | Integer | 1 | OpenModelAttribute
| Current heartbeatInterval in seconds.
|
1.1.9 HugePages
The hugePages datatype provides metrics on system hugePages
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
bytesFree | Number | 0..1 | OpenModelAttribute
| Number of free hugePages in bytes.
|
bytesUsed | Number | 0..1 | OpenModelAttribute
| Number of used hugePages in bytes.
|
hugePagesIdentifier | String | 1 | OpenModelAttribute
| HugePages identifier
|
percentFree | Number | 0..1 | OpenModelAttribute
| Number of free hugePages in percent.
|
percentused | Number | 0..1 | OpenModelAttribute
| Number of used hugePages in percent.
|
vmPageNumberFree | Number | 0..1 | OpenModelAttribute
| Number of free hugePages in numbers.
|
vmPageNumberUsed | Number | 0..1 | OpenModelAttribute
| Number of used hugePages in numbers.
|
1.1.10 Ipmi
The ipmi (Intelligent Platform Management Interface) datatype provides intelligent platform management interface metrics; it consists of the following fields:
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
exitAirTemperature | Number | 0..1 | OpenModelAttribute
| System fan exit air flow temperature in Celsius
|
frontPanelTemperature | Number | 0..1 | OpenModelAttribute
| Front panel temp in Celsius
|
ioModuleTemperature | Number | 0..1 | OpenModelAttribute
| Io module temp in Celsius
|
ipmiBaseboardTemperatureArray | ipmiBaseboardTemperature | 0..1 | OpenModelAttribute
| Array of ipmiBaseboard Temperature objects
|
ipmiBaseboardVoltageRegulatorArray | ipmiBaseboardVoltageRegulator | 0..1 | OpenModelAttribute
| Array of ipmiBaseboard VoltageRegulator objects
|
ipmiBatteryArray | ipmiBattery | 0..1 | OpenModelAttribute
| Array of ipmiBattery objects
|
ipmiFanArray | ipmiFan | 0..1 | OpenModelAttribute
| Array of ipmiFan objects
|
ipmiGlobalAggregateTemperatureMarginArray | ipmiGlobalAggregateTemperatureMargin | 0..1 | OpenModelAttribute
| ipmi global aggregate temperature margin
|
ipmiHsbpArray | ipmiHsbp | 0..1 | OpenModelAttribute
| Array of ipmiHsbp objects
|
ipmiNicArray | ipmiNic | 0..1 | OpenModelAttribute
| Array of ipmiNic objects
|
ipmiPowerSupplyArray | ipmiPowerSupply | 0..1 | OpenModelAttribute
| Array of ipmiPowerSupply objects
|
ipmiProcessorArray | ipmiProcessor | 0..1 | OpenModelAttribute
| Array of ipmiProcessor objects
|
systemAirflow | Number | 0..1 | OpenModelAttribute
| Airflow in cubic feet per minute (cfm)
|
1.1.11 IpmiBaseboardTemperature
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
baseboardTemperature | Number | 1 | OpenModelAttribute
| Baseboard temperature in celsius
|
baseboardTemperature Identifier | String | 0..1 | OpenModelAttribute
| Identifier for the location where the temperature is taken
|
1.1.12 IpmiBaseboardVoltageRegulator
The ipmiBaseboardVoltageRegulator datatype consists of the following fields which describe ipmi baseboard voltage regulator metrics:
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
baseboaredVoltageRegulatorIdentifier | String | 1 | OpenModelAttribute
| Identifier for the baseboard voltage regulator
|
voltageRegulatorTemperature | Number | 0..1 | OpenModelAttribute
| Voltage regulator temperature in celsius
|
1.1.13 IpmiBattery
The ipmiBattery datatype consists of the following fields which describe ipmi battery metrics:
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
batteryIdentifier | String | 1 | OpenModelAttribute
| Identifier for the battery
|
batteryType | String | 0..1 | OpenModelAttribute
| Type of battery
|
batteryVoltageLevel | Number | 1 | OpenModelAttribute
| Battery voltage level
|
1.1.14 IpmiFan
The ipmiFan datatype consists of the following fields which describe ipmi fan metrics:
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
fanIdentifier | String | 1 | OpenModelAttribute
| Identifier for the fan
|
fanSpeed | Number | 0..1 | OpenModelAttribute
| Fan speed in revolutions per minute (rpm)
|
1.1.15 IpmiGlobalAggregateTemperatureMargin
The ipmiGlobalAggregateTemperatureMargin datatype consists of the following fields:
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
globalAggregateTemperatureMargin | Number | 0..1 | OpenModelAttribute
| Temperature margin in Celsius relative to a throttling thermal trip point
|
globalAggregateTemperatureMarginIdentifier | String | 1 | OpenModelAttribute
| Identifier for the ipmi global aggregate temperature margin metrics
|
1.1.16 IpmiHsbp
The ipmiHsbp datatype provides ipmi hot swap backplane power metrics; it consists of the following fields:
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
hsbpIdentifier | String | 1 | OpenModelAttribute
| Identifier for the hot swap backplane power unit
|
hsbpTemperature | Number | 0..1 | OpenModelAttribute
| Hot swap backplane power temperature in celsius
|
1.1.17 IpmiNic
The ipmiNic datatype provides network interface control care metrics; it consists of the following fields:
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
nicIdentifier | String | 1 | OpenModelAttribute
| Identifier for the network interface control card
|
nicTemperature | Number | 0..1 | OpenModelAttribute
| nic temperature in Celsius
|
1.1.18 IpmiPowerSupply
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
powerSupplyCurrentOutput Percent | Number | 0..1 | OpenModelAttribute
| Current output voltage as a percentage of the design specified level
|
powerSupplyIdentifier | String | 1 | OpenModelAttribute
| Identifier for the power supply
|
powerSupplyInputPower | Number | 0..1 | OpenModelAttribute
| Input power in watts
|
powerSupplyTemperature | Number | 0..1 | OpenModelAttribute
| Power supply temperature in Celsius
|
1.1.19 IpmiProcessor
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
pprocessorThermalControlPercent | Number | 0..1 | OpenModelAttribute
| Io module temperatue in celsius
|
processorDimmAggregateThermalMarginArray | processorDimmAggregateThermalMargin | 0..1 | OpenModelAttribute
| Array of processorDimmAggregate ThermalMargin objects
|
processorDtsThermalMargin | Number | 0..1 | OpenModelAttribute
| Front panel temperature in celsius
|
processorIdentifier | String | 1 | OpenModelAttribute
| Identifier for the power supply
|
1.1.20 LatencyBucketMeasure
The latencyBucketMeasure datatype consists of the following fields which describe the number of counts falling within a defined latency bucket
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
countsInTheBucket | Number | 1 | OpenModelAttribute
| Number of counts falling within a defined latency bucket
|
highEndOfLatencyBucket | Number | 0..1 | OpenModelAttribute
| High end of bucket range (typically in ms)
|
lowEndOfLatencyBucket | Number | 0..1 | OpenModelAttribute
| Low end of bucket range (typically in ms)
|
1.1.21 Load
The load datatype provides metrics on system cpu and io utilization obtained using /proc/loadavg
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
longTerm | Number | 0..1 | OpenModelAttribute
| number of jobs in the run queue (state R, cpu utilization) or waiting for disk I/O (state D, io utilization) averaged over 15 minutes using /proc/loadavg
|
midTerm | Number | 0..1 | OpenModelAttribute
| number of jobs in the run queue (state R, cpu utilization) or waiting for disk I/O (state D, io utilization) averaged over 5 minutes using /proc/loadavg
|
shortTerm | Number | 0..1 | OpenModelAttribute
| number of jobs in the run queue (state R, cpu utilization) or waiting for disk I/O (state D, io utilization) averaged over 1 minute using /proc/loadavg
|
1.1.22 MachineCheckException
The machineCheckException datatype describes machine check exceptions
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
correctedMemoryErrors | Number | 0..1 | OpenModelAttribute
| Total hardware errors that were corrected by the hardware (e.g. data corruption corrected via ECC) over the measurementInterval. These errors do not require immediate software actions, but are still reported for accounting and predictive failure analysis
|
correctedMemoryErrors In1Hr | Number | 0..1 | OpenModelAttribute
| Total hardware errors that were corrected by the hardware over the last one hour
|
processIdentifier | String | 1 | OpenModelAttribute
| processIdentifier
|
uncorrectedMemoryErrors | Number | 0..1 | OpenModelAttribute
| Total uncorrected hardware errors that were detected by the hardware (e.g., causing data corruption) over the measurementInterval. These errors require a software response.
|
uncorrectedMemoryErrors In1Hr | Number | 0..1 | OpenModelAttribute
| Total uncorrected hardware errors that were detected by the hardware over the last one hour
|
1.1.23 Measurement
Fields specific to measurement events
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
additionalFields | HashMap | 0..1 | OpenModelAttribute
| Additional measurement fields if needed.
|
additionalMeasurements | ArrayofNamedHashMap | 0..1 | OpenModelAttribute
| Array of named hashMap if needed.
|
additionalObjects | ArrayOfJsonObject | 0..1 | OpenModelAttribute
| Array of JSON objects described by name, schema and other meta-information, if needed.
|
concurrentSessions | Integer | 0..1 | OpenModelAttribute
| Peak concurrent sessions for the VM or VNF (depending on the context) over the measurementInterval.
|
configuredEntities | Integer | 0..1 | OpenModelAttribute
| Depending on the context over the measurementInterval: peak total number of users, subscribers, devices, adjacencies, etc., for the VM, or peak total number of subscribers, devices, etc., for the VNF
|
featureUsageArray | HashMap | 0..1 | OpenModelAttribute
| The hashMap key should identify the feature, while the value defines the number of times the identified feature was used.
|
meanRequestLatency | Number | 0..1 | OpenModelAttribute
| Mean seconds required to respond to each request for the VM on which the VNFC reporting the event is running.
|
measurementFieldsVersion | String | 1 | OpenModelAttribute
| Version of the measurementFields block as "#.#" where # is a digit; see section 1 for the correct digits to use.
|
measurementInterval | Number | 1 | OpenModelAttribute
| Interval over which measurements are being reported in seconds
|
nfcScalingMetric | Integer | 0..1 | OpenModelAttribute
| Represents busy-ness of the network function from 0 to 100 as reported by the nfc.
|
numberOfMediaPortsInUse | Integer | 1 | OpenModelAttribute
| Number of media ports in use.
|
requestRate | Number | 1 | OpenModelAttribute
| Peak request rate per second, for the VM over the measurementInterval
|
_Hugepages | HugePages | 0..1 | OpenModelAttribute
| Array of metrics on hugePages
|
_codecsinuse | CodecsInUse | 0..* | OpenModelAttribute
| Array of codecs in use
|
_cpuUsage | CpuUsage | 0..* | OpenModelAttribute
| Usage of an array of CPUs
|
_diskUsage | DiskUsage | 0..* | OpenModelAttribute
| Usage of an array of disks
|
_filesystemusage | FilesystemUsage | 0..* | OpenModelAttribute
| Filesystem usage of the VM on which the xNFC reporting the event is running
|
_ipmi | Ipmi | 0..1 | OpenModelAttribute
| Array of intelligent platform management interface metrics
|
_latencybucketmeasure | LatencyBucketMeasure | 0..1 | OpenModelAttribute
| Array of integers representing counts of requests whose latency in milliseconds falls within per-xNF configured ranges; where latency is the duration between a service request and its fulfillment.
|
_load | Load | 0..1 | OpenModelAttribute
| Array of system load metrics
|
_machinecheckexception | MachineCheckException | 0..1 | OpenModelAttribute
| Array of machine check exceptions
|
_memoryusage | MemoryUsage | 0..* | OpenModelAttribute
| Memory usage of an array of VMs
|
_nicperformance | NicPerformance | 0..* | OpenModelAttribute
| Performance metrics of an array of network interface cards
|
_processstats | ProcessStats | 0..* | OpenModelAttribute
| Array of metrics on system processes
|
1.1.24 MemoryUsage
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
memoryBuffered | Number | 0..1 | OpenModelAttribute
| Kibibytes of temporary storage for raw disk blocks
|
memoryCached | Number | 0..1 | OpenModelAttribute
| Kibibytes of memory used for cache
|
memoryConfigured | Number | 0..1 | OpenModelAttribute
| Kibibytes of memory configured in the virtual machine on which the xNFC reporting the event is running
|
memoryDemand | Number | 0..1 | OpenModelAttribute
| Host demand in kibibytes
|
memoryFree | Number | 1 | OpenModelAttribute
| Kibibytes of physical RAM left unused by the system
|
memoryLatencyAvg | Number | 0..1 | OpenModelAttribute
| Percentage of time the VM is waiting to access swapped or compressed memory
|
memorySharedAvg | Number | 0..1 | OpenModelAttribute
| Shared memory in kilobytes
|
memorySlabRecl | Number | 0..1 | OpenModelAttribute
| The part of the slab that can be reclaimed such as caches measured in kibibytes
|
memorySlabUnrecl | Number | 0..1 | OpenModelAttribute
| The part of the slab that cannot be reclaimed even when lacking memory measure in kibibytes
|
memorySwapInAvg | Number | 0..1 | OpenModelAttribute
| Amount of memory swapped-in from host cache in kibibytes
|
memorySwapInRateAvg | Number | 0..1 | OpenModelAttribute
| Rate at which memory is swapped from disk into active memory during the interval in kilobytes per second
|
memorySwapOutAvg | Number | 0..1 | OpenModelAttribute
| Amount of memory swapped-out to host cache in kibibytes
|
memorySwapOutRateAvg | Number | 0..1 | OpenModelAttribute
| Rate at which memory is being swapped from active memory to disk during the current interval in kilobytes per second
|
memorySwapUsedAvg | Number | 0..1 | OpenModelAttribute
| Space used for caching swapped pages in the host cache in kibibytes
|
memoryUsed | Number | 1 | OpenModelAttribute
| Total memory minus the sum of free, buffered, cached and slab memory measured in kibibytes
|
percentMemoryUsage | Number | 0..1 | OpenModelAttribute
| Percentage of memory usage; value = (memoryUsed / (memoryUsed + memoryFree) x 100 if denomintor is nonzero, or 0, if otherwise.
|
vmIdentifier | String | 1 | OpenModelAttribute
| Virtual Machine identifier associated with the memory metrics
|
1.1.25 MobileFlow
Fields specific to mobility flow events
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
additionalFields | HashMap | 0..1 | OpenModelAttribute
| additionalFields - Additional mobileFlow fields if needed.
|
applicationType | String | 0..1 | OpenModelAttribute
| applicationType - Application type inferred
|
applProtocolType | String | 0..1 | OpenModelAttribute
| applProtocolType - Application protocol.
|
applProtocolVersion | String | 0..1 | OpenModelAttribute
| applProtocolVersion - Application version.
|
cid | String | 0..1 | OpenModelAttribute
| cid - Cell Id.
|
connectionType | String | 0..1 | OpenModelAttribute
| connectionType - Abbreviation referencing a 3GPP reference point e.g., S1-U, S11, etc.
|
ecgi | String | 0..1 | OpenModelAttribute
| ecgi - Evolved Cell Global Id.
|
flowDirection | String | 0..1 | OpenModelAttribute
| flowDirection - Flow direction, indicating if the reporting node is the source of the flow or destination for the flow.
|
gtpPerFlowMetrics | invalid | 0..1 | OpenModelAttribute
| gtpPerFlowMetrics - Mobility GTP Protocol per flow metrics.
|
gtpProtocolType | String | 0..1 | OpenModelAttribute
| gtpProtocolType - GTP protocol
|
gtpVersion | String | 0..1 | OpenModelAttribute
| gtpVersion - GTP protocol version.
|
httpHeader | String | 0..1 | OpenModelAttribute
| httpHeader - HTTP request header, if the flow connects to a node referenced by HTTP.
|
iemi | String | 0..1 | OpenModelAttribute
| imei - IMEI for the subscriber UE used in this flow, if the flow connects to a mobile device.
|
imsi | String | 0..1 | OpenModelAttribute
| imsi - IMSI for the subscriber UE used in this flow, if the flow connects to a mobile device
|
ipProtocolType | String | 0..1 | OpenModelAttribute
| ipProtocolType - IP protocol type e.g., TCP, UDP, RTP...
|
ipVersion | String | 0..1 | OpenModelAttribute
| ipVersion - IP protocol version e.g., IPv4, IPv6
|
lac | String | 0..1 | OpenModelAttribute
| lac - Location area code.
|
mcc | String | 0..1 | OpenModelAttribute
| mcc - Mobile country code.
|
mnc | String | 0..1 | OpenModelAttribute
| mnc - Mobile network code.
|
mobileFlowFieldsVersion | Number | 0..1 | OpenModelAttribute
| mobileFlowFieldsVersion - Version of the mobileFlowFields block.
|
msisdn | String | 0..1 | OpenModelAttribute
| msisdn - MSISDN for the subscriber UE used in this flow, as an integer, if the flow connects to a mobile device.
|
otherEndpointlpAddress | String | 0..1 | OpenModelAttribute
| otherEndpointIpAddress - IP address for the other endpoint, as used for the flow being reported on. Note: current data type (String) may be changed to Common Resource Datatype L3AddressData. =[gh]=
|
otherEndpointPort | Number | 0..1 | OpenModelAttribute
| otherEndpointPort - IP Port for the reporting entity, as used for the flow being reported on
|
otherFunctionalRole | String | 0..1 | OpenModelAttribute
| otherFunctionalRole - Functional role of the other endpoint for the flow being reported on e.g., MME, S-GW, P-GW, PCRF...
|
rac | String | 0..1 | OpenModelAttribute
| rac - Routing area code
|
radioAccessTechnology | String | 0..1 | OpenModelAttribute
| radioAccessTechnology - Radio Access Technology e.g., 2G, 3G, 4G and 5G. (GSM, UMTS, LTE, 5G)
|
reportingEndpointlpAddr | String | 0..1 | OpenModelAttribute
| reportingEndpointIpAddr - IP address for the reporting entity, as used for the flow being reported on. Note: current data type (String) may be changed to Common Resource Datatype L3AddressData. =[gh]=
|
reportingEndpointPort | Number | 0..1 | OpenModelAttribute
| reportingEndpointPort - IP port for the reporting entity, as used for the flow being reported on.
|
sac | String | 0..1 | OpenModelAttribute
| sac - Service area code
|
samplingAlgorithm | Number | 0..1 | OpenModelAttribute
| samplingAlgorithm - Integer identifier for the sampling algorithm or rule being applied in calculating the flow metrics if metrics are calculated based on a sample of packets, or 0 if no sampling is applied.
|
tac | String | 0..1 | OpenModelAttribute
| tac - Transport area code
|
tunnelId | String | 0..1 | OpenModelAttribute
| tunnelId - Tunnel identifier
|
vlanId | String | 0..1 | OpenModelAttribute
| vlanId - VLAN identifier used by this flow
|
1.1.26 NicPerformance
The nicPerformance datatype consists of the following fields which describe the performance and errors of an of an identified virtual network interface card
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
administrativeState | NicAdminState | 1 | OpenModelAttribute
| Administrative state: enum: 'inService', 'outOfService'
|
nicIdentifier | String | 1 | OpenModelAttribute
| Network interface card identifier
|
operationalState | NicOpsState | 1 | OpenModelAttribute
| Operational state: enum: 'inService', 'outOfService'
|
receivedBroadcastPacketsAccumulated | Number | 0..1 | OpenModelAttribute
| Cumulative count of broadcast packets received as read at the end of the measurement interval
|
receivedBroadcastPacketsDelta | Number | 0..1 | OpenModelAttribute
| Count of broadcast packets received within the measurement interval
|
receivedDiscardedPacketsAccumulated | Number | 0..1 | OpenModelAttribute
| Cumulative count of discarded packets received as read at the end of the measurement interval
|
receivedDiscardedPacketsDelta | Number | 0..1 | OpenModelAttribute
| Count of discarded packets received within the measurement interval
|
receivedErrorPacketsAccumulated | Number | 0..1 | OpenModelAttribute
| Cumulative count of error packets received as read at the end of the measurement interval
|
receivedErrorPacketsDelta | Number | 0..1 | OpenModelAttribute
| Count of error packets received within the measurement interval
|
receivedMulticastPacketsAccumulated | Number | 0..1 | OpenModelAttribute
| Cumulative count of multicast packets received as read at the end of the measurement interval
|
receivedMulticastPacketsDelta | Number | 0..1 | OpenModelAttribute
| Count of multicast packets received within the measurement interval
|
receivedOctetsAccumulated | Number | 0..1 | OpenModelAttribute
| Cumulative count of octets received as read at the end of the measurement interval
|
receivedOctetsDelta | Number | 0..1 | OpenModelAttribute
| Count of octets received within the measurement interval
|
receivedPercentDiscard | Number | 0..1 | OpenModelAttribute
| Percentage of discarded packets received; value = (receivedDiscardedPacketsDelta / receivedTotalPacketsDelta) x 100, if denominator is nonzero, or 0, if otherwise.
|
receivedPercentError | Number | 0..1 | OpenModelAttribute
| Percentage of error packets received; value = (receivedErrorPacketsDelta / receivedTotalPacketsDelta) x 100, if denominator is nonzero, or 0, if otherwise.
|
receivedTotalPacketsAccumulated | Number | 1 | OpenModelAttribute
| Cumulative count of all packets received as read at the end of the measurement interval
|
receivedTotalPacketsDelta | Number | 1 | OpenModelAttribute
| Count of all packets received within the measurement interval
|
receivedUnicastPacketsAccumulated | Number | 1 | OpenModelAttribute
| Cumulative count of unicast packets received as read at the end of the measurement interval
|
receivedUnicastPacketsDelta | Number | 1 | OpenModelAttribute
| Count of unicast packets received within the measurement interval
|
receivedUtilization | Number | 1 | OpenModelAttribute
| Percentage of utilization received; value = (receivedOctetsDelta / (speed x (lastEpochMicrosec - startEpochMicrosec))) x 100, if denominator is nonzero, or 0, if otherwise.
|
speed | Number | 1 | OpenModelAttribute
| Speed configured in mbps.
|
transmittedBroadcastPacketsAccumulated | Number | 1 | OpenModelAttribute
| Cumulative count of broadcast packets transmitted as read at the end of the measurement interval
|
transmittedBroadcastPacketsDelta | Number | 1 | OpenModelAttribute
| Count of broadcast packets transmitted within the measurement interval
|
transmittedDiscardedPacketsAccumulated | Number | 1 | OpenModelAttribute
| Cumulative count of discarded packets transmitted as read at the end of the measurement interval
|
transmittedDiscardedPacketsDelta | Number | 1 | OpenModelAttribute
| Count of discarded packets transmitted within the measurement interval
|
transmittedErrorPacketsAccumulated | Number | 1 | OpenModelAttribute
| Cumulative count of error packets transmitted as read at the end of the measurement interval
|
transmittedErrorPacketsDelta | Number | 1 | OpenModelAttribute
| Count of error packets transmitted within the measurement interval
|
transmittedMulticastPacketsAccumulated | Number | 1 | OpenModelAttribute
| Cumulative count of multicast packets transmitted as read at the end of the measurement interval
|
transmittedMulticastPacketsDelta | Number | 1 | OpenModelAttribute
| Count of multicast packets transmitted within the measurement interval
|
transmittedOctetsAccumulated | Number | 0..1 | OpenModelAttribute
| Cumulative count of octets transmitted as read at the end of the measurement interval
|
transmittedOctetsDelta | Number | 0..1 | OpenModelAttribute
| Count of octets transmitted within the measurement interval
|
transmittedPercentDiscard | Number | 0..1 | OpenModelAttribute
| Percentage of discarded packets transmitted; value = (transmittedDiscardedPacketsDelta / transmittedTotalPacketsDelta) x 100, if denominator is nonzero, or 0, if otherwise.
|
transmittedPercentError | Number | 0..1 | OpenModelAttribute
| Percentage of error packets received; value = (transmittedErrorPacketsDelta / transmittedTotalPacketsDelta) x 100, if denominator is nonzero, or 0, if otherwise.
|
transmittedTotalPacketsAccumulated | Number | 0..1 | OpenModelAttribute
| Cumulative count of all packets transmitted as read at the end of the measurement interval
|
transmittedTotalPacketsDelta | Number | 0..1 | OpenModelAttribute
| Count of all packets transmitted within the measurement interval
|
transmittedUnicastPacketsAccumulated | Number | 0..1 | OpenModelAttribute
| Cumulative count of unicast packets transmitted as read at the end of the measurement interval
|
transmittedUnicastPacketsDelta | Number | 0..1 | OpenModelAttribute
| Count of unicast packets transmitted within the measurement interval
|
transmittedUtilization | Number | 0..1 | OpenModelAttribute
| Percentage of utilization transmitted; value = (transmittedOctetsDelta / (speed x (lastEpochMicrosec - startEpochMicrosec))) x 100, if denominator is nonzero, or 0, if otherwise.
|
valuesAreSuspect | String | 1 | OpenModelAttribute
| Enumeration: 'true' or 'false'. If 'true' then the vNicPerformance values are likely inaccurate due to counter overflow or other conditions.
|
1.1.27 Notification
Fields specific to notification events
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
additionalFields | HashMap | 0..1 | OpenModelAttribute
| Additional notification fields if needed.
|
arrayOfNamedHashMap | NamedHashMap | 0..1 | OpenModelAttribute
| arrayOfNamedHashMap - Array of named hashMaps
|
changeContact | String | 0..1 | OpenModelAttribute
| Identifier for a contact related to the change.
|
changeIdentifier | String | 1 | OpenModelAttribute
| System or session identifier associated with the change.
|
chnageType | String | 1 | OpenModelAttribute
| Describes what has changed for the entity, for example: configuration changed, capability added, capability removed…
|
newState | NotificationState | 0..1 | OpenModelAttribute
| New state of the entity, for example: 'inService', 'maintenance', 'outOfService'
|
notificationFieldsVersion | Number | 1 | OpenModelAttribute
| Version of the notificationFields block as "#.#" where # is a digit; see section 1 for the correct digits to use.
|
oldState | NotificationState | 0..1 | OpenModelAttribute
| Previous state of the entity. For example: "inService", "outOfService", "maintenance"
|
stateInterface | String | 0..* | OpenModelAttribute
| Card or port name of the entity that changed state.
|
1.1.28 Other
The otherFields datatype defines fields for events belonging to the 'other' domain of the commonEventHeader domain enumeration.
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
arrayofNamedHashMap | ArrayofNamedHashMap | 0..* | OpenModelAttribute
| Array of named hashMaps
|
hashMap | HashMap | 0..* | OpenModelAttribute
| Array of name-value pairs.
|
jsonObjects | ArrayOfJsonObject | 1 | OpenModelAttribute
| Array of JSON objects described by name, schema and other meta-information.
|
otherFieldsVersion | String | 1 | OpenModelAttribute
| Version of the otherFields block as "#.#" where # is a digit; see section 1 for the correct digits to use.
|
1.1.29 PnfRegistration
The pnfRegistrationFields datatype defines fields for events belonging to the 'pnfRegistration' domain of the commonEventHeader domain enumeration; it consists of the following fields:
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
additionalFields | HashMap | 0..1 | OpenModelAttribute
| Additional pnfRegistration fields if needed
|
lastServiceDate | String | 0..1 | OpenModelAttribute
| TS 32.692 dateOfLastService = date of last service; e.g. 15022017
|
macAddress | String | 0..1 | OpenModelAttribute
| MAC address of OAM interface of the unit
|
manufactureDate | String | 0..1 | OpenModelAttribute
| TS 32.692 dateOfManufacture = manufacture date of the unit; 24032016
|
modelNumber | String | 0..1 | OpenModelAttribute
| TS 32.692 versionNumber = version of the unit from vendor; e.g. AJ02. Maps to AAI equip-model
|
oamV4lpAddress | String | 0..1 | OpenModelAttribute
| IPv4 m-plane IP address to be used by the manager to contact the PNF
|
oamV6lpAddress | String | 0..1 | OpenModelAttribute
| IPv6 m-plane IP address to be used by the manager to contact the PNF
|
pnfRegistrationFieldsVersion | Number | 1 | OpenModelAttribute
| Version of the registrationFields block as "#.#" where # is a digit; see section 1 for the correct digits to use.
|
serialNumber | String | 0..1 | OpenModelAttribute
| TS 32.692 serialNumber = serial number of the unit; e.g. 6061ZW3
|
softwareVersion | String | 0..1 | OpenModelAttribute
| TS 32.692 swName = active SW running on the unit; e.g. 5gDUv18.05.201
|
unitFamily | String | 0..1 | OpenModelAttribute
| TS 32.692 vendorUnitFamilyType = general type of HW unit; e.g. BBU
|
unitType | String | 0..1 | OpenModelAttribute
| TS 32.692 vendorUnitTypeNumber = vendor name for the unit; e.g. Airscale
|
vendorName | String | 0..1 | OpenModelAttribute
| TS 32.692 vendorName = name of manufacturer; e.g. Nokia. Maps to AAI equip-vendor
|
1.1.30 ProcessStats
The processStats datatype provides metrics on system processes
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
forkRate | Number | 0..1 | OpenModelAttribute
| The number of threads created since the last reboot
|
processIdentifier | String | 1 | OpenModelAttribute
| processIdentifier
|
psStateBlocked | Number | 0..1 | OpenModelAttribute
| The number of processes in a blocked state
|
psStatePaging | Number | 0..1 | OpenModelAttribute
| The number of processes in a paging state
|
psStateRunning | Number | 0..1 | OpenModelAttribute
| The number of processes in a running state
|
psStateSleeping | Number | 0..1 | OpenModelAttribute
| The number of processes in a sleeping state
|
psStateStopped | Number | 0..1 | OpenModelAttribute
| The number of processes in a stopped state
|
psStateZombie | Number | 0..1 | OpenModelAttribute
| The number of processes in a zombie state
|
1.1.31 ProcessorDimmAggregateThermalMargin
The processorDimmAggregateThermalMargin datatype provides intelligent platform management interface (ipmi) processor dual inline memory module aggregate thermal margin metrics; it consists of the following fields:
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
processorDimmAggregateThermal MarginIdentifier | String | 1 | OpenModelAttribute
| identifier for the aggregate thermal margin metrics from the processor dual inline memory module
|
thermalMargin | Number | 1 | OpenModelAttribute
| the difference between the DIMM's current temperature, in celsius, and the DIMM's throttling thermal trip point
|
1.1.32 SipSignaling
sipSignalingFields - The sipSignalingFields datatype communicates information about SIP signaling messages, parameters and signaling state.
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
additionalInformation | HashMap | 0..* | OpenModelAttribute
| zdditionalInformation - Additional sipSignalling fields.
|
compressedSip | String | 0..1 | OpenModelAttribute
| compressedSip - The full SIP request/response including headers and bodies.
|
correlator | String | 1 | OpenModelAttribute
| correlator - Constant across all events on this call.
|
localipAddress | String | 1 | OpenModelAttribute
| localIpAddress - IP address on VNF. Note: current data type (String) may be changed to Common Resource Datatype L3AddressData. =[gh]=
|
localPort | String | 1 | OpenModelAttribute
| localPort - Port on VNF.
|
remoteipAddress | String | 1 | OpenModelAttribute
| remoteIpAddress - IP address of peer endpoint. Note: current data type (String) may be changed to Common Resource Datatype L3AddressData. =[gh]=
|
remotePort | String | 1 | OpenModelAttribute
| remotePort - Port of peer endpoint
|
sipSignaliingFieldsVersion | String | 1 | OpenModelAttribute
| sipSignalingFieldsVersion - Version of the sipSignalingFields block as "#.#" where # is a digit; see section 1 for the correct digits to use.
|
summarySip | String | 0..1 | OpenModelAttribute
| summarySip - The SIP Method or Response ('INVITE', '200 OK', 'BYE', etc).
|
vendorNfNameFields | VendorNfNameFields | 1 | OpenModelAttribute
| vendorNfNameFields - Vendor, NF and nfModule names.
|
1.1.33 StateChange
Fields specific to state change events.
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
additionalFields | HashMap | 0..1 | OpenModelAttribute
| Additional stateChange fields if needed
|
newState | NotificationState | 1 | OpenModelAttribute
| New state of the entity: 'inService', 'maintenance', 'outOfService'
|
OldState | NotificationState | 1 | OpenModelAttribute
| Previous state of the entity: 'inService', 'maintenance', 'outOfService'
|
stateChangeFieldsVersion | String | 1 | OpenModelAttribute
| Version of the stateChangeFields block as "#.#" where # is a digit; see section 1 for the correct digits to use.
|
stateInterface | String | 1 | OpenModelAttribute
| Card or port name of the entity that changed state
|
1.1.34 SysLog
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
1.1.35 ThresholdCrossingAlert
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
1.1.36 VoiceQuality
Applied stereotypes:
- OpenModelClass
- support: MANDATORY