1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. Copyright 2020 AT&T Intellectual Property, All rights reserved
4 .. Copyright 2017-2018 Huawei Technologies Co., Ltd.
6 .. _ves_event_listener_5_4_1:
8 ===================================
9 Service: *VES Event Listener 5.4.1*
10 ===================================
12 .. contents:: Table of Contents
17 This document describes the RESTful interface for the VES (Virtual function
18 Event Streaming) Event Listener. The VES Event Listener is capable of receiving
19 any event sent in the VES Common Event Format. The Common Event Format is a
20 JSON structure consisting of a required Common Event Header Block accompanied
21 by zero or more event domain blocks. A JSON Schema of the VES Common Event
22 Format is provided in Section 4 of this document.
24 It should be understood that events are well structured packages of information,
25 identified by an eventName, which are asynchronously communicated to subscribers
26 who are interested in the eventName. Events can convey measurements, faults,
27 syslogs, threshold crossing alerts and others types of information. Events are
28 simply a way of communicating well-structured packages of information to one or
29 more instances of an Event Listener service.
31 This document describes a RESTful connectionless push event listener that is
32 capable of receiving single events or batches of events in the Common Event
33 Format. In future, additional documents may describe other transports which
34 make use of persistent TCP connections for high volumes of streaming events.
39 All events must be compliant with the common event format, but specific events
40 identified by their eventNames, may require that certain fields, which are
41 optional in the common event format, be present when they are published. For
42 example, a specific eventName may require that specific name-value pairs be
43 present in the extensible structures provided within the Common Event Format.
45 Events are registered using an extensible YAML format (defined in a separate
46 document), which specifies, for each eventName, the fields that are required,
47 what field values may be sent, and any special handling that should be
48 performed on those eventNames.
50 Naming Standards for eventName
51 ------------------------------
53 To prevent naming collisions, eventNames sent as part of the
54 commonEventHeader, should conform to the following naming convention designed
55 to summarize the purpose and type of the event, and to ensure the uniqueness of
58 {DomainAbbreviation}\_{SdcModel or
59 ApplicationPlatform}\_{DescriptionOfInfoBeingConveyed}
61 Domain abbreviations are derived from the 'domain' field in the
62 commonEventHeader, as specified below:
63 - 'Fault'for the fault domain
64 - 'Heartbeat'for the heartbeat domain
65 - 'Mfvs'for the measurementsForVfScaling domain
66 - 'MobileFlow'for the mobileFlow domain
67 - 'Other'for the other domain
68 - 'SipSignaling'for the sipSignaling domain
69 - 'StateChange'for the stateChange domain
70 - 'Syslog'for the syslog domain
71 - 'Tca'for the thresholdCrossingAlert domain
72 - 'voiceQuality'for the voiceQuality domain
74 SDC (the ONAP Service Design and Creation environment) defines and catalogs
75 specific services, VNFs, VF modules and other entities, which are generically
76 referred to as 'SDC models'. The SDC model that an event is associated with
77 should be indicated in the second subfield within the eventName. If the event
78 is not associated with an Sdc model but is instead being generated by an
79 application platform like SO, then a string identifying the Application
80 Platform may be used instead. In either case, all subfield names should be
81 converted to camel case format (with no spaces, hyphens or underscores).
83 The final subfield of the eventName name should describe, in a compact camel
84 case format (with no spaces, hyphens or underscores), the specific information
85 being conveyed by the event. In some cases, this final subfield will not be
86 required (e.g., in the case of Heartbeats or in the case of an event source
87 which, for a domain like syslog, defines only one eventName to support it):
89 Examples of eventNames following the naming standards are provided below:
91 - Fault\_MobileCallRecording\_PilotNumberPoolExhaustion
93 - Other\_WanBonding\_InstantiationPart1Complete
95 - Tca\_vDbe\_CpuThresholdExceeded
96 - Other\_SO\_InstantiationPhase1Complete
98 Any questions about the naming of eventNames should be resolved as part of
99 service and resource onboarding to the ONAP Service Design and Creation
100 environment (i.e., SDC).
102 Support for Protocols Other Than HTTPS
103 --------------------------------------
105 This API specification describes an HTTPS RESTful interface using the JSON
108 Alternative specifications may be provided in future using Websockets, which
109 would establish a permanent TCP socket, or Apache Avro which provides a binary
110 format over an RPC protocol to be defined. Both would leverage the JSON schema
111 provided in this document.
116 Three types of version numbers supported by this specification:
118 - The API specification itself is versioned. Going forward, the major number
119 of the specification version will be incremented whenever any change could
120 break an existing client (e.g., a field name is deleted or changed). All
121 other changes to the spec (e.g., a field name is added or text changes are
122 made to the specification itself) will increment only the minor number. Note
123 that the major number appears in REST resource URLs as v# (where '#'is the
126 - The JSON schema is versioned. Going forward, the major number of the JSON
127 schema will be incremented whenever any change could break an existing
128 client (e.g., a field name is deleted or changed). All other changes to the
129 schema (e.g., a field name is added or text changes are made to the field
130 descriptions) will increment only the minor number.
132 - The field blocks are versioned. Field blocks include the commonEventHeader
133 and the domain blocks (e.g., the faultFields block). Going forward, the
134 major number of each field block will be incremented whenever any change to
135 that block could break an existing client (e.g., a field name is deleted or
136 changed). All other changes to that block (e.g., a field name is added or
137 text changes are made to the field descriptions) will increment only the
143 Event sources must identify themselves to the VES Event Listener.
145 Event source credentials are passed using HTTP `Basic Authentication <http://tools.ietf.org/html/rfc2617>`__.
147 Credentials must not be passed on the query string. Credentials must be sent in
148 an Authorization header as follows:
150 1. The username and password are formed into one string as "username:password"
152 2. The resulting string is Base64 encoded to produce the encoded credential.
154 3. The encoded credential is communicated in the header after the string
155 "Authorization: Basic "
157 Because the credentials are merely encoded but not encrypted, HTTPS (rather
158 than HTTP) should be used. HTTPS will also encrypt and protect event contents.
160 Examples are provided below.
162 Sample Request and Response
163 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
170 POST /eventListener/v5 HTTPS/1.1
171 Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
172 content-type: application/json
173 content-length: 12345
176 "commonEventHeader": {
178 "domain": "heartbeat",
179 "eventName": "Heartbeat\_vIsbcMmc",
180 "eventId": "ab305d54-85b4-a31b-7db2fb6b9e546015",
182 "priority": "Normal",
183 "reportingEntityId": "cc305d54-75b4-431badb2eb6b9e541234",
184 "reportingEntityName": "EricssonOamVf",
185 "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014",
186 "sourceName": "ibcx0001vm002ssc001",
187 "nfNamingCode": "ibcx",
188 "nfcNamingCode": "ssc",
189 "startEpochMicrosec": 1413378172000000,
190 "lastEpochMicrosec": 1413378172000000
195 Sample Success Response
196 ^^^^^^^^^^^^^^^^^^^^^^^
200 HTTPS/1.1 202 Accepted
205 REST resources are defined with respect to a ServerRoot:
207 ServerRoot = /{optionalRoutingPath}
209 The resource structure is provided below::
213 |--- /eventListener/v{apiVersion}
217 **Figure 1**: REST Resource Structure
219 The {Domain} or FQDN above is typically provisioned into each
220 eventsource when it is instantiated. The {Port} above is typically 8443.
225 A JSON schema describing the Common Event Format is provided below and is
226 reproduced in the tables that follow.
228 Common Event Datatypes
229 ----------------------
231 Common Event Datatypes
232 ~~~~~~~~~~~~~~~~~~~~~~
237 The event datatype consists of the following fields which constitute the
238 'root level'of the common event format:
240 +----------------------------------+----------------------------------+-------------+------------------------------------------------------+
241 | Field | Type | Required? | Description |
242 +==================================+==================================+=============+======================================================+
243 | commonEventHeader | commonEventHeader | Yes | Fields common to all events |
244 +----------------------------------+----------------------------------+-------------+------------------------------------------------------+
245 | faultFields | faultFields | No | Fields specific to fault events |
246 +----------------------------------+----------------------------------+-------------+------------------------------------------------------+
247 | heartbeatFields | heartbeatFields | No | Fields specific to heartbeat events |
248 +----------------------------------+----------------------------------+-------------+------------------------------------------------------+
249 | measurementsForVfScalingFields | measurementsForVfScalingFields | No | Fields specific to measurementsForVfScaling events |
250 +----------------------------------+----------------------------------+-------------+------------------------------------------------------+
251 | mobileFlowFields | mobileFlowFields | No | Fields specific to mobility flow events |
252 +----------------------------------+----------------------------------+-------------+------------------------------------------------------+
253 | otherFields | otherFields | No | Fields specific to other types of events |
254 +----------------------------------+----------------------------------+-------------+------------------------------------------------------+
255 | sipSignalingFields | sipSignalingFields | No | Fields specific to sipSignaling events |
256 +----------------------------------+----------------------------------+-------------+------------------------------------------------------+
257 | stateChangeFields | stateChangeFields | No | Fields specific to state change events |
258 +----------------------------------+----------------------------------+-------------+------------------------------------------------------+
259 | syslogFields | syslogFields | No | Fields specific to syslog events |
260 +----------------------------------+----------------------------------+-------------+------------------------------------------------------+
261 | thresholdCrossingAlertFields | thresholdCrossingAlertFields | No | Fields specific to threshold crossing alert events |
262 +----------------------------------+----------------------------------+-------------+------------------------------------------------------+
263 | voiceQualityFields | voiceQualityFields | No | Fields specific to voiceQuality events |
264 +----------------------------------+----------------------------------+-------------+------------------------------------------------------+
269 The eventList datatype consists of the following fields:
271 +-------------+-------------+-------------+-------------------+
272 | Field | Type | Required? | Description |
273 +=============+=============+=============+===================+
274 | eventList | event [ ] | Yes | Array of events |
275 +-------------+-------------+-------------+-------------------+
280 The field datatype consists of the following fields:
282 +---------+----------+-------------+----------------------------+
283 | Field | Type | Required? | Description |
284 +=========+==========+=============+============================+
285 | name | string | Yes | Name of the field |
286 +---------+----------+-------------+----------------------------+
287 | value | string | Yes | Value of the named field |
288 +---------+----------+-------------+----------------------------+
293 The jsonObject datatype provides a json object schema, name and other
294 meta-information along with one or more object instances that conform to the
297 +--------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
298 | Field | Type | Required? | Description |
299 +==========================+==========================+=============+===========================================================================================================================================================================+
300 | objectInstances | JsonObjectInstance [ ] | Yes | Contains one or more instances of the json object |
301 +--------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
302 | objectName | string | Yes | Name of the json object |
303 +--------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
304 | objectSchema | string | No | json schema for the object |
305 +--------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
306 | objectSchemaUrl | string | No | URL to the json schema for the object |
307 +--------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
308 | nfSubscribedObjectName | string | No | Name of the object associated with the nfSubscriptionId |
309 +--------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
310 | nfSubscriptionId | string | No | Identifies an openConfig telemetry subscription on a network function, which configures the network function to send complex object data associated with the jsonObject |
311 +--------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
313 Datatype: jsonObjectInstance
314 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
316 The jsonObjectInstance datatype provides meta-information about an
317 instance of a jsonObject along with the actual object instance:
319 +-------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------+
320 | Field | Type | Required? | Description |
321 +===============================+===========+=============+===========================================================================================================================================+
322 | objectInstance | object | Yes | Contains an instance conforming to the jsonObject schema |
323 +-------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------+
324 | objectInstanceEpochMicrosec | number | No | the unix time, aka epoch time, associated with this objectInstance--as microseconds elapsed since 1 Jan 1970 not including leap seconds |
325 +-------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------+
326 | objectKeys | key [ ] | No | An ordered set of keys that identifies this particular instance of jsonObject (e.g., that places it in a hierarchy) |
327 +-------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------+
332 The key datatype is a tuple which provides the name of a key along with
333 its value and relative order; it consists of the following fields:
335 +------------+-----------+-------------+----------------------------------------------------------------------+
336 | Field | Type | Required? | Description |
337 +============+===========+=============+======================================================================+
338 | keyName | string | Yes | Name of the key |
339 +------------+-----------+-------------+----------------------------------------------------------------------+
340 | keyOrder | Integer | No | Relative sequence or order of the key (with respect to other keys) |
341 +------------+-----------+-------------+----------------------------------------------------------------------+
342 | keyValue | string | No | Value of the key |
343 +------------+-----------+-------------+----------------------------------------------------------------------+
345 Datatype: namedArrayOfFields
346 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
348 The namedArrayOfFields datatype is an array of name value pairs along with a
349 name for the array; it consists of the following fields:
351 +-----------------+-------------+-------------+------------------------------------------+
352 | Field | Type | Required? | Description |
353 +=================+=============+=============+==========================================+
354 | name | string | Yes | Name for the array of name-value pairs |
355 +-----------------+-------------+-------------+------------------------------------------+
356 | arrayOfFields | field [ ] | Yes | Name-value pairs |
357 +-----------------+-------------+-------------+------------------------------------------+
359 Datatype: requestError
360 ^^^^^^^^^^^^^^^^^^^^^^
362 The requestError datatype defines the standard request error data
365 +-------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
366 | Field | Type | Required? | Description |
367 +=============+==========+=============+================================================================================================================================================================================================================================================================================================+
368 | messageId | string | Yes | Unique message identifier of the format 'ABCnnnn'where 'ABC'is either 'SVC'for Service Exceptions or 'POL'for Policy Exception. Exception numbers may be in the range of 0001 to 9999 where 0001 to 2999 are defined by OMA (see section 5.1) and 3000-9999 are available and undefined. |
369 +-------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
370 | text | string | Yes | Message text, with replacement variables marked with %n, where n is an index into the list of <variables> elements, starting at 1 |
371 +-------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
372 | url | string | No | Hyperlink to a detailed error resource e.g., an HTML page for browser user agents |
373 +-------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
374 | variables | string | No | List of zero or more strings that represent the contents of the variables used by the message text |
375 +-------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
377 Datatype: vendorVnfNameFields
378 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
380 The vendorVnfNameFields provides vendor, vnf and vfModule identifying
383 +----------------+----------+-------------+---------------------------------------------------------------+
384 | Field | Type | Required? | Description |
385 +================+==========+=============+===============================================================+
386 | vendorName | string | Yes | VNF vendor name |
387 +----------------+----------+-------------+---------------------------------------------------------------+
388 | vfModuleName | string | No | The Sdc vfModuleName for the vfModule generating the event |
389 +----------------+----------+-------------+---------------------------------------------------------------+
390 | vnfName | string | No | The Sdc modelName for the VNF generating the event |
391 +----------------+----------+-------------+---------------------------------------------------------------+
393 'Common Event Header'Datatypes
394 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
396 Datatype: commonEventHeader
397 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
399 The commonEventHeader datatype consists of the following fields common to all
402 +-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
403 | Field | Type | Required? | Description |
404 +=========================+=========================+=============+================================================================================================================================================================================================================================================================================+
405 | version | number | Yes | Version of the event header (currently: 3.0) |
406 +-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
407 | eventName | string | Yes | Unique event name (see section 1 for more information) |
408 +-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
409 | domain | string | Yes | Event domain enumeration: 'fault', 'heartbeat', 'measurementsForVfScaling', 'mobileFlow', 'other', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' |
410 +-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
411 | eventId | string | Yes | Event key that is unique to the event source |
412 +-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
413 | eventType | string | No | For example: 'applicationVnf', 'guestOS', 'hostOS', 'platform' |
414 +-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
415 | nfcNamingCode | string | No | Network function component type: 3 characters (aligned with vfc naming standards) |
416 +-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
417 | nfNamingCode | string | No | Network function type: 4 characters (aligned with vnf naming standards) |
418 +-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
419 | sourceId | string | No | UUID identifying the entity experiencing the event issue (note: the AT&T internal enrichment process shall ensure that this field is populated) |
420 +-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
421 | sourceName | string | Yes | Name of the entity experiencing the event issue |
422 +-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
423 | reportingEntityId | string | No | UUID identifying the entity reporting the event, for example an OAM VM (note: the AT&T internal enrichment process shall ensure that this field is populated) |
424 +-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
425 | reportingEntityName | string | Yes | Name of the entity reporting the event, for example, an EMS name. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. |
426 +-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
427 | priority | string | Yes | Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' |
428 +-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
429 | startEpochMicrosec | number | Yes | 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 |
430 +-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
431 | lastEpochMicrosec | number | Yes | 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 |
432 +-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
433 | sequence | integer | Yes | Ordering of events communicated by an event source instance (or 0 if not needed) |
434 +-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
435 | internalHeader Fields | internalHeader Fields | No | Fields (not supplied by event sources) that the VES Event Listener service can use to enrich the event if needed for efficient internal processing. This is an empty object which is intended to be defined separately by each provider implementing the VES Event Listener. |
436 +-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
438 Datatype: internalHeaderFields
439 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
441 The internalHeaderFields datatype is an undefined object which can contain
442 arbitrarily complex JSON structures. It is intended to be defined separately by
443 each provider implementing the VES Event Listener.
445 The fields in internalHeaderFields are not provided by any event source but
446 instead are added by the VES Event Listener service itself as part of an event
447 enrichment process necessary for efficient internal processing of events
448 received by the VES Event Listener:
450 Technology Independent Datatypes
451 --------------------------------
453 'Fault'Domain Datatypes
454 ~~~~~~~~~~~~~~~~~~~~~~~~
456 Datatype: faultFields
457 ^^^^^^^^^^^^^^^^^^^^^
459 The faultFields datatype consists of the following fields:
461 +-------------------------------+-------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
462 | Field | Type | Required? | Description |
463 +===============================+=============+=============+================================================================================================================================================================+
464 | faultFieldsVersion | number | Yes | Version of the faultFields block (currently: 2.0) |
465 +-------------------------------+-------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
466 | eventSeverity | string | Yes | Event severity enumeration: 'CRITICAL', 'MAJOR', 'MINOR', 'WARNING', 'NORMAL' |
467 +-------------------------------+-------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
468 | eventSourceType | string | Yes | Examples: 'card', 'host', 'other', 'port', 'portThreshold', 'router', 'slotThreshold', 'switch', 'virtualMachine', 'virtualNetworkFunction' |
469 +-------------------------------+-------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
470 | eventCategory | string | No | Event category, for example: 'license', 'link', 'routing', 'security', 'signaling' |
471 +-------------------------------+-------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
472 | alarmCondition | string | Yes | Alarm condition reported by the device (e.g., 'tpLgCgiNotInConfig') |
473 +-------------------------------+-------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
474 | specificProblem | string | Yes | Short description of the alarm or problem (e.g., 'This event is sent when the LG is asked to perform a location for a CGI that is not in its configuration') |
475 +-------------------------------+-------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
476 | vfStatus | string | Yes | Virtual function status enumeration: 'Active', 'Idle', 'Preparing to terminate', 'Ready to terminate', 'Requesting Termination' |
477 +-------------------------------+-------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
478 | alarmInterfaceA | string | No | Card, port, channel or interface name of the device generating the alarm |
479 +-------------------------------+-------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
480 | alarmAdditional Information | field [ ] | No | Additional alarm information (note: for SNMP mapping to VES, for name use OID of varbind, for value use incoming data for that varbind) |
481 +-------------------------------+-------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
483 'Heartbeat'Domain Datatypes
484 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
486 Datatype: heartbeatFields
487 ^^^^^^^^^^^^^^^^^^^^^^^^^
489 The heartbeatFields datatype is an optional field block for fields specific to
490 heartbeat events; it consists of the following fields:
492 +--------------------------+-------------+-------------+---------------------------------------------------------+
493 | Field | Type | Required? | Description |
494 +==========================+=============+=============+=========================================================+
495 | heartbeatFieldsVersion | number | Yes | Version of the heartbeatFields block (currently: 1.0) |
496 +--------------------------+-------------+-------------+---------------------------------------------------------+
497 | additionalFields | field [ ] | No | Additional expansion fields if needed |
498 +--------------------------+-------------+-------------+---------------------------------------------------------+
499 | heartbeatInterval | Integer | Yes | Current heartbeatInterval in seconds |
500 +--------------------------+-------------+-------------+---------------------------------------------------------+
502 Measurements For VF Scaling'Domain Datatypes
503 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
505 Datatype: codecsInUse
506 ^^^^^^^^^^^^^^^^^^^^^
508 The codecsInUse datatype consists of the following fields describing the number
509 of times an identified codec was used over the measurementInterval:
511 +------------------+-----------+-------------+--------------------------------+
512 | Field | Type | Required? | Description |
513 +==================+===========+=============+================================+
514 | codecIdentifer | string | Yes | Description of the codec |
515 +------------------+-----------+-------------+--------------------------------+
516 | numberInUse | integer | Yes | Number of such codecs in use |
517 +------------------+-----------+-------------+--------------------------------+
522 The cpuUsage datatype defines the usage of an identifier CPU and
523 consists of the following fields:
525 +---------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
526 | Field | Type | Required? | Description |
527 +=====================+==========+=============+=====================================================================================================================================+
528 | cpuIdentifier | string | Yes | CPU Identifier |
529 +---------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
530 | cpuIdle | number | No | Percentage of CPU time spent in the idle task |
531 +---------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
532 | cpuUsageInterrupt | number | No | Percentage of time spent servicing interrupts |
533 +---------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
534 | cpuUsageNice | number | No | Percentage of time spent running user space processes that have been niced |
535 +---------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
536 | cpuUsageSoftIrq | number | No | Percentage of time spent handling soft irq interrupts |
537 +---------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
538 | cpuUsageSteal | number | No | Percentage of time spent in involuntary wait which is neither user, system or idle time and is effectively time that went missing |
539 +---------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
540 | cpuUsageSystem | number | No | Percentage of time spent on system tasks running the kernel |
541 +---------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
542 | cpuUsageUser | number | No | Percentage of time spent running un-niced user space processes |
543 +---------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
544 | cpuWait | number | No | Percentage of CPU time spent waiting for I/O operations to complete |
545 +---------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
546 | percentUsage | number | Yes | Aggregate cpu usage of the virtual machine on which the VNFC reporting the event is running |
547 +---------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
552 The diskUsage datatype defines the usage of a disk and consists of the following
555 +-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
556 | Field | Type | Required? | Description |
557 +=============================+==========+=============+===============================================================================================================================================================================================================================+
558 | diskIdentifier | string | Yes | Disk Identifier |
559 +-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
560 | diskIoTimeAvg | number | No | 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 |
561 +-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
562 | diskIoTimeLast | number | No | 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 |
563 +-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
564 | diskIoTimeMax | number | No | 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 |
565 +-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
566 | diskIoTimeMin | number | No | 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 |
567 +-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
568 | diskMergedReadAvg | number | No | 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 |
569 +-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
570 | diskMergedReadLast | number | No | 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 |
571 +-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
572 | diskMergedReadMax | number | No | 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 |
573 +-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
574 | diskMergedReadMin | number | No | 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 |
575 +-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
576 | diskMergedWriteAvg | number | No | 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 |
577 +-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
578 | diskMergedWriteLast | number | No | 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 |
579 +-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
580 | diskMergedWriteMax | number | No | 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 |
581 +-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
582 | diskMergedWriteMin | number | No | 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 |
583 +-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
584 | diskOctetsRead Avg | number | No | Number of octets per second read from a disk or partition; provide the average measurement within the measurement interval |
585 +-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
586 | diskOctetsRead Last | number | No | Number of octets per second read from a disk or partition; provide the last measurement within the measurement interval |
587 +-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
588 | diskOctetsRead Max | number | No | Number of octets per second read from a disk or partition; provide the maximum measurement within the measurement interval |
589 +-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
590 | diskOctetsRead Min | number | No | Number of octets per second read from a disk or partition; provide the minimum measurement within the measurement interval |
591 +-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
592 | diskOctetsWrite Avg | number | No | Number of octets per second written to a disk or partition; provide the average measurement within the measurement interval |
593 +-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
594 | diskOctetsWrite Last | number | No | Number of octets per second written to a disk or partition; provide the last measurement within the measurement interval |
595 +-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
596 | diskOctetsWriteMax | number | No | Number of octets per second written to a disk or partition; provide the maximum measurement within the measurement interval |
597 +-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
598 | diskOctetsWriteMin | number | No | Number of octets per second written to a disk or partition; provide the minimum measurement within the measurement interval |
599 +-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
600 | diskOpsReadAvg | number | No | Number of read operations per second issued to the disk; provide the average measurement within the measurement interval |
601 +-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
602 | diskOpsReadLast | number | No | Number of read operations per second issued to the disk; provide the last measurement within the measurement interval |
603 +-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
604 | diskOpsReadMax | number | No | Number of read operations per second issued to the disk; provide the maximum measurement within the measurement interval |
605 +-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
606 | diskOpsReadMin | number | No | Number of read operations per second issued to the disk; provide the minimum measurement within the measurement interval |
607 +-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
608 | diskOpsWriteAvg | number | No | Number of write operations per second issued to the disk; provide the average measurement within the measurement interval |
609 +-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
610 | diskOpsWriteLast | number | No | Number of write operations per second issued to the disk; provide the last measurement within the measurement interval |
611 +-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
612 | diskOpsWrite Max | number | No | Number of write operations per second issued to the disk; provide the maximum measurement within the measurement interval |
613 +-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
614 | diskOpsWriteMin | number | No | Number of write operations per second issued to the disk; provide the minimum measurement within the measurement interval |
615 +-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
616 | diskPendingOperationsAvg | number | No | Queue size of pending I/O operations per second; provide the average measurement within the measurement interval |
617 +-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
618 | diskPendingOperationsLast | number | No | Queue size of pending I/O operations per second; provide the last measurement within the measurement interval |
619 +-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
620 | diskPendingOperationsMax | number | No | Queue size of pending I/O operations per second; provide the maximum measurement within the measurement interval |
621 +-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
622 | diskPendingOperationsMin | number | No | Queue size of pending I/O operations per second; provide the minimum measurement within the measurement interval |
623 +-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
624 | diskTimeReadAvg | number | No | Milliseconds a read operation took to complete; provide the average measurement within the measurement interval |
625 +-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
626 | diskTimeRead Last | number | No | Milliseconds a read operation took to complete; provide the last measurement within the measurement interval |
627 +-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
628 | diskTimeRead Max | number | No | Milliseconds a read operation took to complete; provide the maximum measurement within the measurement interval |
629 +-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
630 | diskTimeRead Min | number | No | Milliseconds a read operation took to complete; provide the minimum measurement within the measurement interval |
631 +-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
632 | diskTimeWrite Avg | number | No | Milliseconds a write operation took to complete; provide the average measurement within the measurement interval |
633 +-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
634 | diskTimeWrite Last | number | No | Milliseconds a write operation took to complete; provide the last measurement within the measurement interval |
635 +-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
636 | diskTimeWrite Max | number | No | Milliseconds a write operation took to complete; provide the maximum measurement within the measurement interval |
637 +-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
638 | diskTimeWrite Min | number | No | Milliseconds a write operation took to complete; provide the minimum measurement within the measurement interval |
639 +-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
641 Datatype: featuresInUse
642 ^^^^^^^^^^^^^^^^^^^^^^^
644 The featuresInUse datatype consists of the following fields which
645 describe the number of times an identified feature was used over the
648 +----------------------+-----------+-------------+---------------------------------------------------+
649 | Field | Type | Required? | Description |
650 +======================+===========+=============+===================================================+
651 | featureIdentifer | string | Yes | Description of the feature |
652 +----------------------+-----------+-------------+---------------------------------------------------+
653 | featureUtilization | integer | Yes | Number of times the identified feature was used |
654 +----------------------+-----------+-------------+---------------------------------------------------+
656 Datatype: filesystemUsage
657 ^^^^^^^^^^^^^^^^^^^^^^^^^
659 The filesystemUsage datatype consists of the following fields:
661 +-----------------------+----------+-------------+--------------------------------------------------------+
662 | Field | Type | Required? | Description |
663 +=======================+==========+=============+========================================================+
664 | filesystemName | string | Yes | File system name |
665 +-----------------------+----------+-------------+--------------------------------------------------------+
666 | blockConfigured | number | Yes | Configured block storage capacity in GB |
667 +-----------------------+----------+-------------+--------------------------------------------------------+
668 | blockIops | number | Yes | Block storage input-output operations per second |
669 +-----------------------+----------+-------------+--------------------------------------------------------+
670 | blockUsed | number | Yes | Used block storage capacity in GB |
671 +-----------------------+----------+-------------+--------------------------------------------------------+
672 | ephemeralConfigured | number | Yes | Configured ephemeral storage capacity in GB |
673 +-----------------------+----------+-------------+--------------------------------------------------------+
674 | ephemeralIops | number | Yes | Ephemeral storage input-output operations per second |
675 +-----------------------+----------+-------------+--------------------------------------------------------+
676 | ephemeralUsed | number | Yes | Used ephemeral storage capacity in GB |
677 +-----------------------+----------+-------------+--------------------------------------------------------+
679 Datatype: latencyBucketMeasure
680 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
682 The latencyBucketMeasure datatype consists of the following fields which
683 describe the number of counts falling within a defined latency bucket:
685 +--------------------------+----------+-------------+------------------------------------------------------------+
686 | Field | Type | Required? | Description |
687 +==========================+==========+=============+============================================================+
688 | countsInTheBucket | number | Yes | Number of counts falling within a defined latency bucket |
689 +--------------------------+----------+-------------+------------------------------------------------------------+
690 | highEndOfLatencyBucket | number | No | High end of bucket range (typically in ms) |
691 +--------------------------+----------+-------------+------------------------------------------------------------+
692 | lowEndOfLatencyBucket | number | No | Low end of bucket range (typically in ms) |
693 +--------------------------+----------+-------------+------------------------------------------------------------+
695 Datatype: measurementsForVfScalingFields
696 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
698 The measurementsForVfScalingFields datatype consists of the following fields:
700 +-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
701 | Field | Type | Required? | Description |
702 +===================================+============================+=============+===========================================================================================================================================================================================================+
703 | measurementsForVfScalingVersion | number | Yes | Version of the measurementsForVfScalingFields block (currently: 2.0) |
704 +-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
705 | additionalFields | field [ ] | No | Additional measurement fields if needed |
706 +-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
707 | additionalMeasurements | namedArrayOfFields [ ] | No | Array of named name-value-pair arrays if needed |
708 +-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
709 | additionalObjects | jsonObject [ ] | No | Array of JSON objects described by name, schema and other meta-information, if needed |
710 +-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
711 | codecUsageArray | codecsInUse [] | No | Array of codecs in use |
712 +-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
713 | concurrentSessions | integer | No | Peak concurrent sessions for the VM or VNF (depending on the context) over the measurementInterval |
714 +-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
715 | configuredEntities | integer | No | 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 |
716 +-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
717 | cpuUsageArray | cpuUsage [] | No | Usage of an array of CPUs |
718 +-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
719 | diskUsageArray | diskUsage [] | No | Usage of an array of disks |
720 +-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
721 | featureUsageArray | featuresInUse [] | No | Array of features in use |
722 +-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
723 | filesystemUsageArray | filesystemUsage [] | No | Filesystem usage of the VM on which the VNFC reporting the event is running |
724 +-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
725 | latencyDistribution | latencyBucketMeasure [ ] | No | Array of integers representing counts of requests whose latency in milliseconds falls within per-VNF configured ranges; where latency is the duration between a service request and its fulfillment. |
726 +-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
727 | meanRequestLatency | number | No | Mean seconds required to respond to each request for the VM on which the VNFC reporting the event is running |
728 +-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
729 | measurementInterval | number | Yes | Interval over which measurements are being reported in seconds |
730 +-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
731 | memoryUsageArray | memoryUsage [] | No | Memory usage of an array of VMs |
732 +-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
733 | numberOfMediaPortsInUse | integer | No | Number of media ports in use |
734 +-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
735 | requestRate | number | No | Peak rate of service requests per second to the VNF over the measurementInterval |
736 +-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
737 | vnfcScalingMetric | integer | No | Represents busy-ness of the VNF from 0 to 100 as reported by the VNFC |
738 +-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
739 | vNicPerformanceArray | vNicPerformance [ ] | No | Performance metrics of an array of virtual network interface cards |
740 +-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
742 Datatype: memoryUsage
743 ^^^^^^^^^^^^^^^^^^^^^
745 The memoryUsage datatype defines the memory usage of a virtual machine and
746 consists of the following fields:
748 +--------------------+----------+-------------+----------------------------------------------------------------------------------------------------------+
749 | Field | Type | Required? | Description |
750 +====================+==========+=============+==========================================================================================================+
751 | memoryBuffered | number | No | Kibibytes of temporary storage for raw disk blocks |
752 +--------------------+----------+-------------+----------------------------------------------------------------------------------------------------------+
753 | memoryCached | number | No | Kibibytes of memory used for cache |
754 +--------------------+----------+-------------+----------------------------------------------------------------------------------------------------------+
755 | memoryConfigured | number | No | Kibibytes of memory configured in the virtual machine on which the VNFC reporting the event is running |
756 +--------------------+----------+-------------+----------------------------------------------------------------------------------------------------------+
757 | memoryFree | number | Yes | Kibibytes of physical RAM left unused by the system |
758 +--------------------+----------+-------------+----------------------------------------------------------------------------------------------------------+
759 | memorySlabRecl | number | No | The part of the slab that can be reclaimed such as caches measured in kibibytes |
760 +--------------------+----------+-------------+----------------------------------------------------------------------------------------------------------+
761 | memorySlabUnrecl | number | No | The part of the slab that cannot be reclaimed even when lacking memory measure in kibibytes |
762 +--------------------+----------+-------------+----------------------------------------------------------------------------------------------------------+
763 | memoryUsed | number | Yes | Total memory minus the sum of free, buffered, cached and slab memory measured in kibibytes |
764 +--------------------+----------+-------------+----------------------------------------------------------------------------------------------------------+
765 | vmIdentifier | string | Yes | Virtual Machine identifier associated with the memory metrics |
766 +--------------------+----------+-------------+----------------------------------------------------------------------------------------------------------+
768 Datatype: vNicPerformance
769 ^^^^^^^^^^^^^^^^^^^^^^^^^
771 The vNicPerformance datatype consists of the following fields which describe
772 the performance and errors of an of an identified virtual network interface
775 +------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
776 | Field | Type | Required? | Description |
777 +==========================================+==========+=============+===============================================================================================================================================+
778 | receivedBroadcastPacketsAccumulated | number | No | Cumulative count of broadcast packets received as read at the end of the measurement interval |
779 +------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
780 | receivedBroadcastPacketsDelta | number | No | Count of broadcast packets received within the measurement interval |
781 +------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
782 | receivedDiscardedPacketsAccumulated | number | No | Cumulative count of discarded packets received as read at the end of the measurement interval |
783 +------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
784 | receivedDiscardedPacketsDelta | number | No | Count of discarded packets received within the measurement interval |
785 +------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
786 | receivedErrorPacketsAccumulated | number | No | Cumulative count of error packets received as read at the end of the measurement interval |
787 +------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
788 | receivedErrorPacketsDelta | number | No | Count of error packets received within the measurement interval |
789 +------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
790 | receivedMulticastPacketsAccumulated | number | No | Cumulative count of multicast packets received as read at the end of the measurement interval |
791 +------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
792 | receivedMulticastPacketsDelta | number | No | Count of multicast packets received within the measurement interval |
793 +------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
794 | receivedOctetsAccumulated | number | No | Cumulative count of octets received as read at the end of the measurement interval |
795 +------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
796 | receivedOctetsDelta | number | No | Count of octets received within the measurement interval |
797 +------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
798 | receivedTotalPacketsAccumulated | number | No | Cumulative count of all packets received as read at the end of the measurement interval |
799 +------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
800 | receivedTotalPacketsDelta | number | No | Count of all packets received within the measurement interval |
801 +------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
802 | receivedUnicastPacketsAccumulated | number | No | Cumulative count of unicast packets received as read at the end of the measurement interval |
803 +------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
804 | receivedUnicastPacketsDelta | number | No | Count of unicast packets received within the measurement interval |
805 +------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
806 | transmittedBroadcastPacketsAccumulated | number | No | Cumulative count of broadcast packets transmitted as read at the end of the measurement interval |
807 +------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
808 | transmittedBroadcastPacketsDelta | number | No | Count of broadcast packets transmitted within the measurement interval |
809 +------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
810 | transmittedDiscardedPacketsAccumulated | number | No | Cumulative count of discarded packets transmitted as read at the end of the measurement interval |
811 +------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
812 | transmittedDiscardedPacketsDelta | number | No | Count of discarded packets transmitted within the measurement interval |
813 +------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
814 | transmittedErrorPacketsAccumulated | number | No | Cumulative count of error packets transmitted as read at the end of the measurement interval |
815 +------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
816 | transmittedErrorPacketsDelta | number | No | Count of error packets transmitted within the measurement interval |
817 +------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
818 | transmittedMulticastPacketsAccumulated | number | No | Cumulative count of multicast packets transmitted as read at the end of the measurement interval |
819 +------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
820 | transmittedMulticastPacketsDelta | number | No | Count of multicast packets transmitted within the measurement interval |
821 +------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
822 | transmittedOctetsAccumulated | number | No | Cumulative count of octets transmitted as read at the end of the measurement interval |
823 +------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
824 | transmittedOctetsDelta | number | No | Count of octets transmitted within the measurement interval |
825 +------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
826 | transmittedTotalPacketsAccumulated | number | No | Cumulative count of all packets transmitted as read at the end of the measurement interval |
827 +------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
828 | transmittedTotalPacketsDelta | number | No | Count of all packets transmitted within the measurement interval |
829 +------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
830 | transmittedUnicastPacketsAccumulated | number | No | Cumulative count of unicast packets transmitted as read at the end of the measurement interval |
831 +------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
832 | transmittedUnicastPacketsDelta | number | No | Count of unicast packets transmitted within the measurement interval |
833 +------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
834 | valuesAreSuspect | string | Yes | Enumeration: 'true'or 'false'. If 'true'then the vNicPerformance values are likely inaccurate due to counter overflow or other condtions. |
835 +------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
836 | vNicIdentifier | string | Yes | vNic identification |
837 +------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
839 'Other'Domain Datatypes
840 ~~~~~~~~~~~~~~~~~~~~~~~~
842 Datatype: otherFields
843 ^^^^^^^^^^^^^^^^^^^^^
845 The otherFields datatype defines fields for events belonging to the 'other'
846 domain of the commonEventHeader domain enumeration; it consists of the
849 +-----------------------------+--------------------------+-------------+------------------------------------------------------------------------------+
850 | Field | Type | Required? | Description |
851 +=============================+==========================+=============+==============================================================================+
852 | otherFieldsVersion | number | Yes | Version of the otherFields block (currently: 1.1) |
853 +-----------------------------+--------------------------+-------------+------------------------------------------------------------------------------+
854 | hashOfNameValuePairArrays | namedArrayOfFields [ ] | No | Array of named name-value-pair arrays |
855 +-----------------------------+--------------------------+-------------+------------------------------------------------------------------------------+
856 | jsonObjects | jsonObject [ ] | No | Array of JSON objects described by name, schema and other meta-information |
857 +-----------------------------+--------------------------+-------------+------------------------------------------------------------------------------+
858 | nameValuePairs | field [ ] | No | Array of name-value pairs |
859 +-----------------------------+--------------------------+-------------+------------------------------------------------------------------------------+
861 'State Change'Domain Datatypes
862 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
864 Datatype: stateChangeFields
865 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
867 The stateChangeFields datatype consists of the following fields:
869 +----------------------------+-------------+-------------+----------------------------------------------------------------------------+
870 | Field | Type | Required? | Description |
871 +============================+=============+=============+============================================================================+
872 | stateChangeFieldsVersion | number | Yes | Version of the stateChangeFields block (currently: 2.0) |
873 +----------------------------+-------------+-------------+----------------------------------------------------------------------------+
874 | additionalFields | field [ ] | No | Additional stateChange fields if needed |
875 +----------------------------+-------------+-------------+----------------------------------------------------------------------------+
876 | newState | string | Yes | New state of the entity: 'inService', 'maintenance', 'outOfService' |
877 +----------------------------+-------------+-------------+----------------------------------------------------------------------------+
878 | oldState | string | Yes | Previous state of the entity: 'inService', 'maintenance', 'outOfService' |
879 +----------------------------+-------------+-------------+----------------------------------------------------------------------------+
880 | stateInterface | string | Yes | Card or port name of the entity that changed state |
881 +----------------------------+-------------+-------------+----------------------------------------------------------------------------+
883 'Syslog'Domain Datatypes
884 ~~~~~~~~~~~~~~~~~~~~~~~~~
886 Datatype: syslogFields
887 ^^^^^^^^^^^^^^^^^^^^^^
889 The syslogFields datatype consists of the following fields:
891 +-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
892 | Field | Type | Required? | Description |
893 +=======================+===========+=============+===============================================================================================================================================+
894 | syslogFieldsVersion | number | Yes | Version of the syslogFields block (currently: 3.0) |
895 +-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
896 | additionalFields | string | No | Additional syslog fields if needed, provided as name=value delimited by a pipe ``|`` symbol, for example: ``"name1=value1|name2=value2|"`` |
897 +-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
898 | eventSourceHost | string | No | Hostname of the device |
899 +-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
900 | eventSourceType | string | Yes | Examples: 'other', 'router', 'switch', 'host', 'card', 'port', 'slotThreshold', 'portThreshold', 'virtualMachine', 'virtualNetworkFunction' |
901 +-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
902 | syslogFacility | integer | No | Numeric code from 0 to 23 for facility: |
904 | | | | 0 kernel messages |
906 | | | | 1 user-level messages |
908 | | | | 2 mail system |
910 | | | | 3 system daemons |
912 | | | | 4 security/authorization messages |
914 | | | | 5 messages generated internally by syslogd |
916 | | | | 6 line printer subsystem |
918 | | | | 7 network news subsystem |
920 | | | | 8 UUCP subsystem |
922 | | | | 9 clock daemon |
924 | | | | 10 security/authorization messages |
926 | | | | 11 FTP daemon |
928 | | | | 12 NTP subsystem |
930 | | | | 13 log audit |
932 | | | | 14 log alert |
934 | | | | 15 clock daemon (note 2) |
936 | | | | 16 local use 0 (local0) |
938 | | | | 17 local use 1 (local1) |
940 | | | | 18 local use 2 (local2) |
942 | | | | 19 local use 3 (local3) |
944 | | | | 20 local use 4 (local4) |
946 | | | | 21 local use 5 (local5) |
948 | | | | 22 local use 6 (local6) |
950 | | | | 23 local use 7 (local7 ) |
951 +-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
952 | syslogMsg | string | Yes | Syslog message |
953 +-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
954 | syslogPri | integer | No | 0-192 |
956 | | | | Combined Severity and Facility |
957 +-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
958 | syslogProc | string | No | Identifies the application that originated the message |
959 +-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
960 | syslogProcId | number | No | A change in the value of this field indicates a discontinuity in syslog reporting |
961 +-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
962 | syslogSData | string | No | Syslog structured data consisting of a structured data Id followed by a set of key value pairs (see below for an example) |
964 | | | | \*\*Note: SD-ID may not be present if syslogSdId is populated |
965 +-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
966 | syslogSdId | string | No | 0-32 char in format name@number, |
968 | | | | i.e., ourSDID@32473 |
969 +-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
970 | syslogSev | string | No | Level-of-severity enumeration in quotes below: |
972 | | | | 'Emergency': system is unusable |
974 | | | | 'Alert': action must be taken immediately |
976 | | | | 'Critical': critical conditions |
978 | | | | 'Error': error conditions |
980 | | | | 'Warning': warning conditions |
982 | | | | 'Notice': normal but significant condition |
984 | | | | 'Info': Informational: informational messages |
986 | | | | 'Debug': debug-level messages |
987 +-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
988 | syslogTag | string | Yes | MsgId indicating the type of message such as 'TCPOUT'or 'TCPIN'; 'NILVALUE'should be used when no other value can be provided |
989 +-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
990 | syslogVer | number | No | IANA assigned version of the syslog protocol specification (typically '1') |
991 +-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
993 Example of syslogSData:
995 STRUCTURED-DATA = NILVALUE / 1\*SD-ELEMENT
997 SD-ELEMENT = "[" SD-ID \*(SP SD-PARAM) "]"
999 SD-PARAM = PARAM-NAME "=" %d34 PARAM-VALUE %d34
1003 PARAM-NAME = SD-NAME
1005 PARAM-VALUE = UTF-8-STRING ; characters '"', '\\' and
1007 ; ']' MUST be escaped.
1009 SD-NAME = 1\*32PRINTUSASCII
1011 ; except '=', SP, ']', %d34 (")
1013 'Threshold Crossing Alert'Domain Datatypes
1014 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1019 The counter datatype consists of the following fields:
1021 +---------------------+----------+-------------+-----------------------------------+
1022 | Field | Type | Required? | Description |
1023 +=====================+==========+=============+===================================+
1024 | name | string | Yes | Name of the counter |
1025 +---------------------+----------+-------------+-----------------------------------+
1026 | value | string | Yes | Current value of the counter |
1027 +---------------------+----------+-------------+-----------------------------------+
1028 | threshholdCrossed | string | Yes | Last threshold that was crossed |
1029 +---------------------+----------+-------------+-----------------------------------+
1030 | criticality | string | Yes | Enumeration: 'CRIT', 'MAJ' |
1031 +---------------------+----------+-------------+-----------------------------------+
1033 Datatype: thresholdCrossingAlertFields
1034 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1036 The thresholdCrossingAlertFields datatype consists of the following
1039 +-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+
1040 | Field | Type | Required? | Description |
1041 +===================================+===============+=============+=============================================================================================================================+
1042 | thresholdCrossing FieldsVersion | number | Yes | Version of the thresholdCrossingAlertFields block (currently: 2.0) |
1043 +-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+
1044 | additionalFields | field [ ] | No | Additional threshold crossing alert fields if needed |
1045 +-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+
1046 | additionalParameters | counter [ ] | Yes | Array of performance counters |
1047 +-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+
1048 | alertAction | string | Yes | Enumeration: 'SET', 'CONT', 'CLEAR' |
1049 +-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+
1050 | alertDescription | string | Yes | Unique short alert description (e.g., NE-CPUMEM) |
1051 +-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+
1052 | alertType | string | Yes | Enumeration: 'CARD-ANOMALY', 'INTERFACE-ANOMALY', ELEMENT-ANOMALY', 'SERVICE-ANOMALY' |
1053 +-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+
1054 | alertValue | string | No | Calculated API value (if applicable) |
1055 +-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+
1056 | associatedAlertIdList | string [ ] | No | List of eventIds associated with the event being reported |
1057 +-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+
1058 | collectionTimestamp | string | Yes | Time when the performance collector picked up the data; with RFC 2822 compliant format: 'Sat, 13 Mar 2010 11:29:05 -0800' |
1059 +-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+
1060 | dataCollector | string | No | Specific performance collector instance used |
1061 +-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+
1062 | elementType | string | No | Type of network element (internal AT&T field) |
1063 +-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+
1064 | eventSeverity | string | Yes | Event severity or priority enumeration: 'CRITICAL', 'MAJOR', 'MINOR', 'WARNING', 'NORMAL' |
1065 +-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+
1066 | eventStartTimestamp | string | Yes | Time closest to when the measurement was made; with RFC 2822 compliant format: 'Sat, 13 Mar 2010 11:29:05 -0800' |
1067 +-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+
1068 | interfaceName | string | No | Physical or logical port or card (if applicable) |
1069 +-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+
1070 | networkService | string | No | Network name (internal AT&T field) |
1071 +-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+
1072 | possibleRootCause | string | No | Reserved for future use |
1073 +-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+
1075 Technology Specific Datatypes
1076 -----------------------------
1078 'Mobile Flow' Domain Datatypes
1079 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1081 Datatype: gtpPerFlowMetrics
1082 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1084 The gtpPerFlowMetrics datatype consists of the following fields:
1086 +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1087 | Field | Type | Required? | Description |
1088 +====================================+=====================+=============+===================================================================================================================================================================================================================+
1089 | avgBitErrorRate | number | Yes | Average bit error rate |
1090 +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1091 | avgPacketDelayVariation | number | Yes | Average packet delay variation or jitter in milliseconds for received packets: Average difference between the packet timestamp and time received for all pairs of consecutive packets |
1092 +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1093 | avgPacketLatency | number | Yes | Average delivery latency |
1094 +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1095 | avgReceiveThroughput | number | Yes | Average receive throughput |
1096 +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1097 | avgTransmitThroughput | number | Yes | Average transmit throughput |
1098 +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1099 | durConnectionFailedStatus | number | No | Duration of failed state in milliseconds, computed as the cumulative time between a failed echo request and the next following successful error request, over this reporting interval |
1100 +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1101 | durTunnelFailedStatus | number | No | Duration of errored state, computed as the cumulative time between a tunnel error indicator and the next following non-errored indicator, over this reporting interval |
1102 +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1103 | flowActivatedBy | string | No | Endpoint activating the flow |
1104 +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1105 | flowActivationEpoch | number | Yes | Time the connection is activated in the flow (connection) being reported on, or transmission time of the first packet if activation time is not available |
1106 +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1107 | flowActivationMicrosec | number | Yes | Integer microseconds for the start of the flow connection |
1108 +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1109 | flowActivationTime | string | No | Time the connection is activated in the flow being reported on, or transmission time of the first packet if activation time is not available; with RFC 2822 compliant format: 'Sat, 13 Mar 2010 11:29:05 -0800' |
1110 +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1111 | flowDeactivatedBy | string | No | Endpoint deactivating the flow |
1112 +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1113 | flowDeactivationEpoch | number | Yes | Time for the start of the flow connection, in integer UTC epoch time aka UNIX time |
1114 +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1115 | flowDeactivationMicrosec | number | Yes | Integer microseconds for the start of the flow connection |
1116 +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1117 | flowDeactivationTime | string | Yes | Transmission time of the first packet in the flow connection being reported on; with RFC 2822 compliant format: 'Sat, 13 Mar 2010 11:29:05 -0800' |
1118 +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1119 | flowStatus | string | Yes | Connection status at reporting time as a working / inactive / failed indicator value |
1120 +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1121 | gtpConnectionStatus | string | No | Current connection state at reporting time |
1122 +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1123 | gtpTunnelStatus | string | No | Current tunnel state at reporting time |
1124 +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1125 | ipTosCountList | associative array | No | Array of key: value pairs where the keys are drawn from the IP Type-of-Service identifiers which range from '0' to '255', and the values are the count of packets that had those ToS identifiers in the flow |
1126 +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1127 | ipTosList | string | No | Array of unique IP Type-of-Service values observed in the flow where values range from '0' to '255' |
1128 +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1129 | largePacketRtt | number | No | large packet round trip time |
1130 +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1131 | largePacketThreshold | number | No | large packet threshold being applied |
1132 +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1133 | maxPacketDelayVariation | number | Yes | Maximum packet delay variation or jitter in milliseconds for received packets: Maximum of the difference between the packet timestamp and time received for all pairs of consecutive packets |
1134 +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1135 | maxReceiveBitRate | number | No | maximum receive bit rate" |
1136 +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1137 | maxTransmitBitRate | number | No | maximum transmit bit rate |
1138 +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1139 | mobileQciCosCountList | associative array | No | array of key: value pairs where the keys are drawn from LTE QCI or UMTS class of service strings, and the values are the count of packets that had those strings in the flow |
1140 +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1141 | mobileQciCosList | string | No | Array of unique LTE QCI or UMTS class-of-service values observed in the flow |
1142 +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1143 | numActivationFailures | number | Yes | Number of failed activation requests, as observed by the reporting node |
1144 +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1145 | numBitErrors | number | Yes | number of errored bits |
1146 +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1147 | numBytesReceived | number | Yes | number of bytes received, including retransmissions |
1148 +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1149 | numBytesTransmitted | number | Yes | number of bytes transmitted, including retransmissions |
1150 +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1151 | numDroppedPackets | number | Yes | number of received packets dropped due to errors per virtual interface |
1152 +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1153 | numGtpEchoFailures | number | No | Number of Echo request path failures where failed paths are defined in 3GPP TS 29.281 sec 7.2.1 and 3GPP TS 29.060 sec. 11.2 |
1154 +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1155 | numGtpTunnelErrors | number | No | Number of tunnel error indications where errors are defined in 3GPP TS 29.281 sec 7.3.1 and 3GPP TS 29.060 sec. 11.1 |
1156 +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1157 | numHttpErrors | number | No | Http error count |
1158 +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1159 | numL7BytesReceived | number | Yes | number of tunneled layer 7 bytes received, including retransmissions |
1160 +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1161 | numL7BytesTransmitted | number | Yes | number of tunneled layer 7 bytes transmitted, excluding retransmissions |
1162 +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1163 | numLostPackets | number | Yes | number of lost packets |
1164 +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1165 | numOutOfOrderPackets | number | Yes | number of out-of-order packets |
1166 +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1167 | numPacketErrors | number | Yes | number of errored packets |
1168 +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1169 | numPacketsReceivedExclRetrans | number | Yes | number of packets received, excluding retransmission |
1170 +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1171 | numPacketsReceivedInclRetrans | number | Yes | number of packets received, including retransmission |
1172 +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1173 | numPacketsTransmittedInclRetrans | number | Yes | number of packets transmitted, including retransmissions |
1174 +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1175 | numRetries | number | Yes | number of packet retries |
1176 +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1177 | numTimeouts | number | Yes | number of packet timeouts |
1178 +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1179 | numTunneledL7BytesReceived | number | Yes | number of tunneled layer 7 bytes received, excluding retransmissions |
1180 +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1181 | roundTripTime | number | Yes | Round Trip time |
1182 +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1183 | tcpFlagCountList | associative array | No | Array of key: value pairs where the keys are drawn from TCP Flags and the values are the count of packets that had that TCP Flag in the flow |
1184 +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1185 | tcpFlagList | string | No | Array of unique TCP Flags observed in the flow |
1186 +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1187 | timeToFirstByte | number | Yes | Time in milliseconds between the connection activation and first byte received |
1188 +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1190 Datatype: mobileFlowFields
1191 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1193 The mobileFlowFields datatype consists of the following fields:
1195 +---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1196 | Field | Type | Required? | Description |
1197 +===========================+======================+=============+==============================================================================================================================================================================================+
1198 | mobileFlowFieldsVersion | number | Yes | Version of the mobileFlowFields block (currently: 2.0) |
1199 +---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1200 | additionalFields | field [ ] | No | Additional mobileFlow fields if needed |
1201 +---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1202 | applicationType | string | No | Application type inferred |
1203 +---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1204 | appProtocolType | string | No | Application protocol |
1205 +---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1206 | appProtocolVersion | string | No | Application version |
1207 +---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1208 | cid | string | No | Cell Id |
1209 +---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1210 | connectionType | string | No | Abbreviation referencing a 3GPP reference point e.g., S1-U, S11, etc |
1211 +---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1212 | ecgi | string | No | Evolved Cell Global Id |
1213 +---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1214 | flowDirection | string | Yes | Flow direction, indicating if the reporting node is the source of the flow or destination for the flow |
1215 +---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1216 | gtpPerFlowMetrics | gtpPer FlowMetrics | Yes | Mobility GTP Protocol per flow metrics |
1217 +---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1218 | gtpProtocolType | string | No | GTP protocol |
1219 +---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1220 | gtpVersion | string | No | GTP protocol version |
1221 +---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1222 | httpHeader | string | No | HTTP request header, if the flow connects to a node referenced by HTTP |
1223 +---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1224 | imei | string | No | IMEI for the subscriber UE used in this flow, if the flow connects to a mobile device |
1225 +---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1226 | imsi | string | No | IMSI for the subscriber UE used in this flow, if the flow connects to a mobile device |
1227 +---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1228 | ipProtocolType | string | Yes | IP protocol type e.g., TCP, UDP, RTP... |
1229 +---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1230 | ipVersion | string | Yes | IP protocol version e.g., IPv4, IPv6 |
1231 +---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1232 | lac | string | No | Location area code |
1233 +---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1234 | mcc | string | No | Mobile country code |
1235 +---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1236 | mnc | string | No | Mobile network code |
1237 +---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1238 | msisdn | string | No | MSISDN for the subscriber UE used in this flow, as an integer, if the flow connects to a mobile device |
1239 +---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1240 | otherEndpointIpAddress | string | Yes | IP address for the other endpoint, as used for the flow being reported on |
1241 +---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1242 | otherEndpointPort | integer | Yes | IP Port for the reporting entity, as used for the flow being reported on |
1243 +---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1244 | otherFunctionalRole | string | No | Functional role of the other endpoint for the flow being reported on e.g., MME, S-GW, P-GW, PCRF... |
1245 +---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1246 | rac | string | No | Routing area code |
1247 +---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1248 | radioAccessTechnology | string | No | Radio Access Technology e.g., 2G, 3G, LTE |
1249 +---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1250 | reportingEndpointIpAddr | string | Yes | IP address for the reporting entity, as used for the flow being reported on |
1251 +---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1252 | reportingEndpointPort | integer | Yes | IP port for the reporting entity, as used for the flow being reported on |
1253 +---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1254 | sac | string | No | Service area code |
1255 +---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1256 | samplingAlgorithm | integer | No | 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 |
1257 +---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1258 | tac | string | No | Transport area code |
1259 +---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1260 | tunnelId | string | No | Tunnel identifier |
1261 +---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1262 | vlanId | string | No | VLAN identifier used by this flow |
1263 +---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1265 'SipSignaling'Domain Datatypes
1266 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1268 Datatype: sipSignalingFields
1269 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1271 The sipSignalingFields datatype communicates information about sip
1272 signaling messages, parameters and signaling state; it consists of the
1275 +-----------------------------+-----------------------+-------------+---------------------------------------------------------------+
1276 | Field | Type | Required? | Description |
1277 +=============================+=======================+=============+===============================================================+
1278 | sipSignalingFieldsVersion | number | Yes | Version of the sipSignalingFields block (currently: 1.0) |
1279 +-----------------------------+-----------------------+-------------+---------------------------------------------------------------+
1280 | additionalInformation | field [ ] | No | Additional sipSignaling fields |
1281 +-----------------------------+-----------------------+-------------+---------------------------------------------------------------+
1282 | compressedSip | string | No | The full SIP request/response including headers and bodies |
1283 +-----------------------------+-----------------------+-------------+---------------------------------------------------------------+
1284 | correlator | string | Yes | Constant across all events on this call |
1285 +-----------------------------+-----------------------+-------------+---------------------------------------------------------------+
1286 | localIpAddress | string | Yes | IP address on VNF |
1287 +-----------------------------+-----------------------+-------------+---------------------------------------------------------------+
1288 | localPort | string | Yes | Port on VNF |
1289 +-----------------------------+-----------------------+-------------+---------------------------------------------------------------+
1290 | remoteIpAddress | string | Yes | IP address of peer endpoint |
1291 +-----------------------------+-----------------------+-------------+---------------------------------------------------------------+
1292 | remotePort | string | Yes | Port of peer endpoint |
1293 +-----------------------------+-----------------------+-------------+---------------------------------------------------------------+
1294 | summarySip | string | No | The SIP Method or Response ('INVITE', '200 OK', 'BYE', etc) |
1295 +-----------------------------+-----------------------+-------------+---------------------------------------------------------------+
1296 | vendorVnfNameFields | vendorVnfNameFields | Yes | Vendor, VNF and VfModule names |
1297 +-----------------------------+-----------------------+-------------+---------------------------------------------------------------+
1299 'Voice Quality'Domain Datatypes
1300 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1302 Datatype: endOfCallVqmSummaries
1303 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1305 The endOfCallVqmSummaries datatype provides end of call voice quality
1306 metrics; it consists of the following fields:
1308 +-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1309 | Field | Type | Required? | Description |
1310 +===============================+==========+=============+==================================================================================================================================================================================================================+
1311 | adjacencyName | string | Yes | Adjacency name |
1312 +-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1313 | endpointDescription | string | Yes | Enumeration: 'Caller', 'Callee' |
1314 +-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1315 | endpointJitter | number | No | Endpoint jitter |
1316 +-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1317 | endpointRtpOctetsDiscarded | number | No | Endpoint RTP octets discarded |
1318 +-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1319 | endpointRtpOctetsReceived | number | No | Endpoint RTP octets received |
1320 +-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1321 | endpointRtpOctetsSent | number | No | Endpoint RTP octets sent |
1322 +-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1323 | endpointRtpPacketsDiscarded | number | No | Endpoint RTP packets discarded |
1324 +-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1325 | endpointRtpPacketsReceived | number | No | Endpoint RTP packets received |
1326 +-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1327 | endpointRtpPacketsSent | number | No | Endpoint RTP packets sent |
1328 +-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1329 | localJitter | number | No | Local jitter |
1330 +-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1331 | localRtpOctetsDiscarded | number | No | Local RTP octets discarded |
1332 +-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1333 | localRtpOctetsReceived | number | No | Local RTP octets received |
1334 +-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1335 | localRtpOctetsSent | number | No | Local RTP octets sent |
1336 +-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1337 | localRtpPacketsDiscarded | number | No | Local RTP packets discarded |
1338 +-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1339 | localRtpPacketsReceived | number | No | Local RTP packets received |
1340 +-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1341 | localRtpPacketsSent | number | No | Local RTP packets sent |
1342 +-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1343 | mosCqe | number | No | Decimal range from 1 to 5 (1 decimal place) |
1344 +-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1345 | packetsLost | number | No | Packets lost |
1346 +-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1347 | packetLossPercent | number | No | Calculated percentage packet loss based on endpoint RTP packets lost (as reported in RTCP) and local RTP packets sent. Direction is based on endpoint description (Caller, Callee). Decimal (2 decimal places) |
1348 +-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1349 | rFactor | number | No | rFactor from 0 to 100 |
1350 +-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1351 | roundTripDelay | number | No | Round trip delay in milliseconds |
1352 +-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1354 Datatype: voiceQualityFields
1355 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1357 The voiceQualityFields datatype provides statistics related to customer
1358 facing voice products; consists of the following fields:
1360 +-----------------------------+--------------------------+-------------+--------------------------------------------------------------------------+
1361 | Field | Type | Required? | Description |
1362 +=============================+==========================+=============+==========================================================================+
1363 | voiceQualityFieldsVersion | number | Yes | Version of the voiceQualityFields block (currently: 1.0) |
1364 +-----------------------------+--------------------------+-------------+--------------------------------------------------------------------------+
1365 | additionalInformation | field [ ] | No | Additional voice quality fields |
1366 +-----------------------------+--------------------------+-------------+--------------------------------------------------------------------------+
1367 | calleeSideCodec | string | Yes | Callee codec for the call |
1368 +-----------------------------+--------------------------+-------------+--------------------------------------------------------------------------+
1369 | callerSideCodec | string | Yes | Caller codec for the call |
1370 +-----------------------------+--------------------------+-------------+--------------------------------------------------------------------------+
1371 | correlator | string | Yes | Constant across all events on this call |
1372 +-----------------------------+--------------------------+-------------+--------------------------------------------------------------------------+
1373 | endOfCallVqmSummaries | endOfCallVqm Summaries | No | End of call voice quality metric summaries |
1374 +-----------------------------+--------------------------+-------------+--------------------------------------------------------------------------+
1375 | phoneNumber | string | No | Phone number associated with the correlator |
1376 +-----------------------------+--------------------------+-------------+--------------------------------------------------------------------------+
1377 | midCallRtcp | string | Yes | Base64 encoding of the binary RTCP data (excluding Eth/IP/UDP headers) |
1378 +-----------------------------+--------------------------+-------------+--------------------------------------------------------------------------+
1379 | vendorVnfNameFields | vendorVnfNameFields | Yes | Vendor, VNF and VfModule names |
1380 +-----------------------------+--------------------------+-------------+--------------------------------------------------------------------------+
1385 RESTful Web Services Exceptions
1386 -------------------------------
1388 RESTful services generate and send exceptions to clients in response to
1389 invocation errors. Exceptions send HTTP status codes (specified later in
1390 this document for each operation). HTTP status codes may be followed by
1391 an optional JSON exception structure described below. Two types of
1392 exceptions may be defined: service exceptions and policy exceptions.
1394 +------------------+----------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1395 | **Field Name** | **Data Type** | **Required?** | **Description** |
1396 +==================+============================+=================+========================================================================================================================================================================================================================================================================+
1397 | messageId | xs:string | Yes | Unique message identifier of the format 'ABCnnnn'where 'ABC'is either 'SVC'for Service Exceptions or 'POL'for Policy Exception. |
1399 | | | | Exception numbers may be in the range of 0001 to 9999 where : |
1401 | | | | - 0001 to 2999 are defined by OMA (see OMA's `Common definitions for RESTful Network APIs <http://technical.openmobilealliance.org/Technical/release_program/docs/REST_NetAPI_Common/V1_0-20120417-C/OMA-TS-REST_NetAPI_Common-V1_0-20120417-C.pdf>`__ for details) |
1403 | | | | - 3000-9999 are available and undefined |
1404 +------------------+----------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1405 | text | xs:string | Yes | Message text, with replacement variables marked with %n, where n is an index into the list of <variables> elements, starting at 1 |
1406 +------------------+----------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1407 | variables | xs:string [0..unbounded] | No | List of zero or more strings that represent the contents of the variables used by the message text. |
1408 +------------------+----------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1409 | url | xs:anyUrl | No | Hyperlink to a detailed error resource (e.g., an HTML page for browser user agents). |
1410 +------------------+----------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1415 When a service is not able to process a request, and retrying the
1416 request with the same information will also result in a failure, and the
1417 issue is not related to a service policy issue, then the service will
1418 issue a fault using the service exception fault message. Examples of
1419 service exceptions include invalid input, lack of availability of a
1420 required resource or a processing error.
1422 A service exception uses the letters 'SVC' at the beginning of the
1423 message identifier. 'SVC'service exceptions used by the VES Event
1424 Listener API are defined below.
1426 +---------------+---------------------------------------+---------------------------------------------------------------+-----------------------------------------------+----------------------+
1427 | *MessageId* | *Description / Comment* | *Text* | *Variables* | *Parent HTTP Code* |
1428 +===============+=======================================+===============================================================+===============================================+======================+
1429 | SVC0001 | General service error (see SVC2000) | <custom error message> | None | 400 |
1430 +---------------+---------------------------------------+---------------------------------------------------------------+-----------------------------------------------+----------------------+
1431 | SVC0002 | Bad parameter | Invalid input value for message part %1 | %1: message part | 400 |
1432 +---------------+---------------------------------------+---------------------------------------------------------------+-----------------------------------------------+----------------------+
1433 | SVC1000 | No server resources | No server resources available to process the request | None | 500 |
1434 +---------------+---------------------------------------+---------------------------------------------------------------+-----------------------------------------------+----------------------+
1435 | SVC2000 | More elaborate version of SVC0001 | The following service error occurred: %1. Error code is %2. | %1: human readable description of the error | 400 |
1437 | | | | %2: error code | |
1438 +---------------+---------------------------------------+---------------------------------------------------------------+-----------------------------------------------+----------------------+
1440 Table - Service Exceptions
1445 When a service is not able to complete because the request fails to meet
1446 a policy criteria, then the service will issue a fault using the policy
1447 exception fault message. To clarify how a policy exception differs from
1448 a service exception, consider that all the input to an operation may be
1449 valid as meeting the required input for the operation (thus no service
1450 exception), but using that input in the execution of the service may
1451 result in conditions that require the service not to complete. Examples
1452 of policy exceptions include privacy violations, requests not permitted
1453 under a governing service agreement or input content not acceptable to
1454 the service provider.
1456 A Policy Exception uses the letters 'POL' at the beginning of the
1457 message identifier. 'POL'policy exceptions used by the VES Event
1458 Listener API are defined below.
1460 +---------------+--------------------------------------+--------------------------------------------------------------+-----------------------------------------------+----------------------+
1461 | *MessageId* | *Description / Comment* | *Text* | *Variables* | *Parent HTTP Code* |
1462 +===============+======================================+==============================================================+===============================================+======================+
1463 | POL0001 | General policy error (see POL2000) | A policy error occurred. | None | 401 |
1464 +---------------+--------------------------------------+--------------------------------------------------------------+-----------------------------------------------+----------------------+
1465 | POL1009 | User not provisioned for service | User has not been provisioned for service | None | 401 |
1466 +---------------+--------------------------------------+--------------------------------------------------------------+-----------------------------------------------+----------------------+
1467 | POL1010 | User suspended from service | User has been suspended from service | None | 401 |
1468 +---------------+--------------------------------------+--------------------------------------------------------------+-----------------------------------------------+----------------------+
1469 | POL2000 | More elaborate version of POL0001 | The following policy error occurred: %1. Error code is %2. | %1: human readable description of the error | 401 |
1471 | | | | %2: error code | |
1472 +---------------+--------------------------------------+--------------------------------------------------------------+-----------------------------------------------+----------------------+
1473 | POL9003 | Message size exceeds limit | Message content size exceeds the allowable limit | None | 400 |
1474 +---------------+--------------------------------------+--------------------------------------------------------------+-----------------------------------------------+----------------------+
1476 Table - Policy Exceptions
1478 RESTful Web Services Definition
1479 ===============================
1481 REST Operation Overview
1482 -----------------------
1484 REST Operation Summary
1485 ~~~~~~~~~~~~~~~~~~~~~~~
1487 +--------------------------------+------------+----------------------------------------------------------------------------+
1488 | **Operation Action** | **HTTP** | **Resource URL relative to {ServerRoot}, which is defined in section 3** |
1491 +--------------------------------+------------+----------------------------------------------------------------------------+
1492 | publishAnyEvent | POST | /eventListener/v{apiVersion} |
1493 +--------------------------------+------------+----------------------------------------------------------------------------+
1494 | publishEventBatch | POST | /eventListener/v{apiVersion}/eventBatch |
1495 +--------------------------------+------------+----------------------------------------------------------------------------+
1497 Table - REST Operation Summary
1502 apiVersion is used to describe the major version number of the event
1503 listener API (which is the same as the major version number of this
1504 specification). When this number changes, the implication is: clients of
1505 older versions will break in some way, if they try to use the new API
1506 without modification (e.g., unmodified v1 clients would not be able to
1507 use v2 without error).
1510 ~~~~~~~~~~~~~~~~~~~~
1512 {ServerRoot} is defined in section 3 of this document, which defines the
1513 REST resource URL. One or more FQDNs may be provisioned in an event
1514 source when it is instantiated or updated. If an event source is unable
1515 to reach any of the provisioned FQDNs, it should buffer the event data
1516 specified below, up to a maximum of 1 hour, until a connection can be
1517 established and the events can be successfully delivered to the VES
1518 Event Listener service.
1520 During such an outage, only the following events should be buffered:
1522 - Faults with eventSeverity of "MINOR", "MAJOR" or "CRITICAL"
1524 - Syslogs with syslogSev of 0-5
1526 - All MeasurementsForVfScaling events
1528 VNFs acting as event sources should not send syslog events to the VES
1529 Event Listener during debug mode (which is controlled via the Netconf
1530 management interface), but should store syslog events locally for
1531 access, and possible FTP transfer, via the VNF console (e.g., command
1534 If the internal event source event buffer or local storage should
1535 overflow, then the event source should send a Fault event, and should
1536 discard events in a first-in, first-out (FIFO) manner (i.e., discard
1537 oldest events first).
1539 Operation: publishAnyEvent
1540 --------------------------
1545 Allows authorized clients to publish any single event to the VES event
1548 - Supports only secure HTTPS (one way SSL) access.
1550 - Uses the HTTP verb POST
1552 - Supports JSON content types
1554 - Provides HTTP response codes as well as Service and Policy error
1562 Figure 2 - publishAnyEvent Call Flow
1567 Header Fields (note: all parameter names shall be treated as
1570 +------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1571 | **Parameter** | **Data Type** | **Required?** | **Brief description** |
1572 +------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1573 | Accept | string | No | Determines the format of the body of the response. Valid values are: |
1575 | | | | - application/json |
1576 +------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1577 | Authorization | string | Yes | The username and password are formed into one string as "username:password". This string is then Base64 encoded to produce the encoded credential which is communicated in the header after the string "Authorization: Basic ". See examples below. If the Authorization header is missing, then an HTTP 400 Invalid Request message shall be returned. If the string supplied is invalid, then an HTTP 401 Unauthorized message shall be returned. |
1578 +------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1579 | Content-length | integer | No | Note that content length is limited to 1Megabyte. |
1580 +------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1581 | Content-type | string | Yes | Must be set to one of the following values: |
1583 | | | | - application/json |
1584 +------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1588 +-----------------+-----------------+-----------------+-----------------------------------------------------------+
1589 | **Parameter** | **Data Type** | **Required?** | **Brief description** |
1590 +-----------------+-----------------+-----------------+-----------------------------------------------------------+
1591 | Event | event | Yes | Contains the JSON structure of the common event format. |
1592 +-----------------+-----------------+-----------------+-----------------------------------------------------------+
1599 +------------------+-----------------+-----------------+------------------------------------+
1600 | **Parameter** | **Data Type** | **Required?** | **Brief description** |
1601 +------------------+-----------------+-----------------+------------------------------------+
1602 | Content-length | integer | No | Used only in error conditions. |
1603 +------------------+-----------------+-----------------+------------------------------------+
1604 | Content-type | string | No | Used only in error conditions |
1605 +------------------+-----------------+-----------------+------------------------------------+
1606 | Date | datetime | Yes | Date time of the response in GMT |
1607 +------------------+-----------------+-----------------+------------------------------------+
1609 Body Fields (for success responses): no content is provided and the header
1610 fields are not required.
1612 Body Fields (for error Responses):
1614 +-----------------+-----------------+--------------------+----------------------------------+
1615 | **Parameter** | **Data Type** | **Required?** | **Brief description** |
1616 +-----------------+-----------------+--------------------+----------------------------------+
1617 | requestError | requestError | Yes (for errors) | Used only in error conditions. |
1618 +-----------------+-----------------+--------------------+----------------------------------+
1623 +----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1624 | *Code* | *Reason Phrase* | *Description* |
1625 +==========+=========================+==========================================================================================================================================================================================================================================================================================================================================================================================+
1626 | 202 | Accepted | The request has been accepted for processing |
1627 +----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1628 | 400 | Bad Request | Many possible reasons not specified by the other codes (e.g., missing required parameters or incorrect format). The response body may include a further exception code and text. HTTP 400 errors may be mapped to SVC0001 (general service error), SVC0002 (bad parameter), SVC2000 (general service error with details) or PO9003 (message content size exceeds the allowable limit). |
1629 +----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1630 | 401 | Unauthorized | Authentication failed or was not provided. HTTP 401 errors may be mapped to POL0001 (general policy error) or POL2000 (general policy error with details). |
1631 +----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1632 | 404 | Not Found | The server has not found anything matching the Request-URI. No indication is given of whether the condition is temporary or permanent. |
1633 +----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1634 | 405 | Method Not Allowed | A request was made of a resource using a request method not supported by that resource (e.g., using PUT on a REST resource that only supports POST). |
1635 +----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1636 | 500 | Internal Server Error | The server encountered an internal error or timed out; please retry (general catch-all server-side error).HTTP 500 errors may be mapped to SVC1000 (no server resources). |
1637 +----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1639 Sample Request and Response
1640 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
1647 POST /eventListener/v5 HTTPS/1.1
1648 Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
1649 content-type: application/json
1650 content-length: 12345
1653 "commonEventHeader": {
1656 "eventName": Fault\_MobileCallRecording\_PilotNumberPoolExhaustion",
1657 "eventId": "ab305d54-85b4-a31b-7db2-fb6b9e546015",
1660 "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234",
1661 "reportingEntityName": "EricssonOamVf",
1662 "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014",
1663 "sourceName": "scfx0001vm002cap001",
1664 "nfNamingCode": "scfx",
1665 "nfcNamingCode": "ssc",
1666 "startEpochMicrosec": 1413378172000000,
1667 "lastEpochMicrosec": 1413378172000000
1670 "faultFieldsVersion": 2.0,
1671 "alarmCondition": "PilotNumberPoolExhaustion",
1672 "eventSourceType": "other",
1673 "specificProblem": "Calls cannot complete - pilot numbers are unavailable",
1674 "eventSeverity": "CRITICAL",
1675 "vfStatus": "Active",
1676 "alarmAdditionalInformation": [
1678 "name": "PilotNumberPoolSize",
1686 Sample Success Response #1
1687 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1691 HTTPS/1.1 202 Accepted
1693 **Sample Policy Exception**
1697 HTTPS/1.1 400 Bad Request
1698 content-type: application/json
1699 content-length: 12345
1700 Date: Thu, 04 Jun 2009 02:51:59 GMT
1703 "policyException": {
1704 "messageId": "POL9003",
1705 "text": "Message content size exceeds the allowable limit",
1710 Sample Service Exception
1711 ''''''''''''''''''''''''
1715 HTTPS/1.1 400 Bad Request
1716 content-type: application/json
1717 content-length: 12345
1718 Date: Thu, 04 Jun 2009 02:51:59 GMT
1721 "serviceException": {
1722 "messageId": "SVC2000",
1723 "text": "Missing Parameter: %1. Error code is %2"
1732 Operation: publishEventBatch
1733 ----------------------------
1738 Allows authorized clients to publish any single event to the VES event
1741 - Supports only secure HTTPS (one way SSL) access.
1743 - Uses the HTTP verb POST
1745 - Supports JSON content types
1747 - Provides HTTP response codes as well as Service and Policy error
1755 Figure 3 publishEventBatch Call Flow
1760 Header Fields (note: all parameter names shall be treated as
1763 +------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1764 | **Parameter** | **Data Type** | **Required?** | **Brief description** |
1765 +------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1766 | Accept | string | No | Determines the format of the body of the response. Valid values are: |
1768 | | | | - application/json |
1769 +------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1770 | Authorization | string | Yes | The username and password are formed into one string as "username:password". This string is then Base64 encoded to produce the encoded credential which is communicated in the header after the string "Authorization: Basic ". See examples below. If the Authorization header is missing, then an HTTP 400 Invalid Request message shall be returned. If the string supplied is invalid, then an HTTP 401 Unauthorized message shall be returned. |
1771 +------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1772 | Content-length | integer | No | Note that content length is limited to 1Megabyte. |
1773 +------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1774 | Content-type | string | Yes | Must be set to one of the following values: |
1776 | | | | - application/json |
1777 +------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1781 +-----------------+-----------------+-----------------+----------------------------------------------------------+
1782 | **Parameter** | **Data Type** | **Required?** | **Brief description** |
1783 +-----------------+-----------------+-----------------+----------------------------------------------------------+
1784 | eventList | eventList | Yes | Array of events conforming to the common event format. |
1785 +-----------------+-----------------+-----------------+----------------------------------------------------------+
1792 +------------------+-----------------+-----------------+------------------------------------+
1793 | **Parameter** | **Data Type** | **Required?** | **Brief description** |
1794 +------------------+-----------------+-----------------+------------------------------------+
1795 | Content-length | integer | No | Used only in error conditions. |
1796 +------------------+-----------------+-----------------+------------------------------------+
1797 | Content-type | string | No | Used only in error conditions |
1798 +------------------+-----------------+-----------------+------------------------------------+
1799 | Date | datetime | Yes | Date time of the response in GMT |
1800 +------------------+-----------------+-----------------+------------------------------------+
1802 Body Fields (for success responses): no content is provided and the header
1803 fields are not required.
1805 Body Fields (for error Responses):
1807 +-----------------+-----------------+--------------------+----------------------------------+
1808 | **Parameter** | **Data Type** | **Required?** | **Brief description** |
1809 +-----------------+-----------------+--------------------+----------------------------------+
1810 | requestError | requestError | Yes (for errors) | Used only in error conditions. |
1811 +-----------------+-----------------+--------------------+----------------------------------+
1816 +----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1817 | *Code* | *Reason Phrase* | *Description* |
1818 +==========+=========================+==========================================================================================================================================================================================================================================================================================================================================================================================+
1819 | 202 | Accepted | The request has been accepted for processing |
1820 +----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1821 | 400 | Bad Request | Many possible reasons not specified by the other codes (e.g., missing required parameters or incorrect format). The response body may include a further exception code and text. HTTP 400 errors may be mapped to SVC0001 (general service error), SVC0002 (bad parameter), SVC2000 (general service error with details) or PO9003 (message content size exceeds the allowable limit). |
1822 +----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1823 | 401 | Unauthorized | Authentication failed or was not provided. HTTP 401 errors may be mapped to POL0001 (general policy error) or POL2000 (general policy error with details). |
1824 +----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1825 | 404 | Not Found | The server has not found anything matching the Request-URI. No indication is given of whether the condition is temporary or permanent. |
1826 +----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1827 | 405 | Method Not Allowed | A request was made of a resource using a request method not supported by that resource (e.g., using PUT on a REST resource that only supports POST). |
1828 +----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1829 | 500 | Internal Server Error | The server encountered an internal error or timed out; please retry (general catch-all server-side error).HTTP 500 errors may be mapped to SVC1000 (no server resources). |
1830 +----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1832 Sample Request and Response
1833 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
1840 POST /eventListener/v5/eventBatch HTTPS/1.1
1841 Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
1842 content-type: application/json
1843 content-length: 12345
1847 "commonEventHeader": {
1850 "eventName": "Fault\_MobileCallRecording\_PilotNumberPoolExhaustion",
1851 "eventId": "ab305d54-85b4-a31b-7db2-fb6b9e546015",
1854 "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234",
1855 "reportingEntityName": "EricssonOamVf",
1856 "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014",
1857 "sourceName": "scfx0001vm002cap001",
1858 "nfNamingCode": "scfx",
1859 "nfcNamingCode": "ssc",
1860 "startEpochMicrosec": 1413378172000000,
1861 "lastEpochMicrosec": 1413378172000000
1864 "faultFieldsVersion": 2.0,
1865 "alarmCondition": "PilotNumberPoolExhaustion",
1866 "eventSourceType": "other",
1867 "specificProblem": "Calls cannot complete - pilot numbers are unavailable",
1868 "eventSeverity": "CRITICAL",
1869 "vfStatus": "Active",
1870 "alarmAdditionalInformation": [
1872 "name": "PilotNumberPoolSize",
1879 "commonEventHeader": {
1882 "eventName": "Fault\_MobileCallRecording\_RecordingServerUnreachable",
1883 "eventId": "ab305d54-85b4-a31b-7db2-fb6b9e546025",
1886 "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234",
1887 "reportingEntityName": "EricssonOamVf",
1888 "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014",
1889 "sourceName": "scfx0001vm002cap001",
1890 "nfNamingCode": "scfx",
1891 "nfcNamingCode": "ssc",
1892 "startEpochMicrosec": 1413378172000010,
1893 "lastEpochMicrosec": 1413378172000010
1896 "faultFieldsVersion": 2.0,
1897 "alarmCondition": "RecordingServerUnreachable",
1898 "eventSourceType": "other",
1899 "specificProblem": "Recording server unreachable",
1900 "eventSeverity": "CRITICAL",
1901 "vfStatus": "Active"
1907 Sample Success Response #1
1908 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1912 HTTPS/1.1 202 Accepted
1914 **Sample Policy Exception**
1918 HTTPS/1.1 400 Bad Request
1919 content-type: application/json
1920 content-length: 12345
1921 Date: Thu, 04 Jun 2009 02:51:59 GMT
1924 "policyException": {
1925 "messageId": "POL9003",
1926 "text": "Message content size exceeds the allowable limit",
1931 Sample Service Exception
1932 ''''''''''''''''''''''''
1936 HTTPS/1.1 400 Bad Request
1937 content-type: application/json
1938 content-length: 12345
1939 Date: Thu, 04 Jun 2009 02:51:59 GMT
1942 "serviceException": {
1943 "messageId": "SVC2000",
1944 "text": "Missing Parameter: %1. Error code is %2"
1953 .. |image1| image:: ves-publishanyevent.png
1956 .. |image2| image:: ves-publisheventbatch.png
Code Review / vnfrqts / requirements.git / blob