summaryrefslogtreecommitdiffstats
path: root/docs/Chapter8
diff options
context:
space:
mode:
authorHagop Bozawglanian <hagop.bozawglanian@att.com>2020-03-05 17:08:05 +0000
committerGerrit Code Review <gerrit@onap.org>2020-03-05 17:08:05 +0000
commit3f887ee6a390473f24a679f215d40effb1c14ee3 (patch)
tree03d650254a605a899f34e14a773c9de3a7a412d1 /docs/Chapter8
parent3283a327949dad7df3b46a8a8493a9445b385270 (diff)
parentaf84eb43e1ca23d8573310825595c7de0436964f (diff)
Merge "Updated VES Event Listener Spec with 7.1.1 updates"
Diffstat (limited to 'docs/Chapter8')
-rw-r--r--docs/Chapter8/ves7_1spec.rst1171
1 files changed, 584 insertions, 587 deletions
diff --git a/docs/Chapter8/ves7_1spec.rst b/docs/Chapter8/ves7_1spec.rst
index 0b7cb17..2427c6f 100644
--- a/docs/Chapter8/ves7_1spec.rst
+++ b/docs/Chapter8/ves7_1spec.rst
@@ -5,8 +5,8 @@
.. _ves_event_listener_7_1:
-Service: VES Event Listener 7.1
--------------------------------
+Service: VES Event Listener 7.1.1
+---------------------------------
+-----------------------------------------------------------------------------+
| **Legal Disclaimer** |
@@ -25,9 +25,9 @@ Service: VES Event Listener 7.1
+-----------------------------------------------------------------------------+
-:Document: VES Event Listner
-:Revision: 7.1
-:Revision Date: December 10th, 2018
+:Document: VES Event Listener
+:Revision: 7.1.1
+:Revision Date: January 28th, 2020
:Author: Rich Erickson
+-----------------+-----------------------------+
@@ -76,11 +76,20 @@ well-structured packages of information to one or more instances of an
Event Listener service.
This document describes a RESTful connectionless push event listener
-that is capable of receiving single events or batches of events in the
+can receive single events or batches of events in the
Common Event Format. In future, additional documents may describe other
transports which make use of persistent TCP connections for high volumes
of streaming events.
+Compatibility with ONAP
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Unless otherwise stated, this version of the Event Listener specification is
+compatible with the release of ONAP the specification is released under. In
+other words, if the specification is released under the Frankfurt ONAP Release,
+then the VES Event Collectors provided by DCAE will also be compatible with
+the specification.
+
Event Registration
~~~~~~~~~~~~~~~~~~
@@ -198,16 +207,22 @@ below:
- Other\_So:WanBonding\_InstantiationPart1Complete
EventId Use Cases Examples
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
eventId Examples:
-Example 1: assumes a unique key for each domain consisting of domain
-followed by an integer domainnnnnnn e.g. fault000001, heartbeat000001,
-mfvs000005
+**NOTE**: Please note, the following are only *examples*, and other formats
+can be used provided they meet the requirement that the ``eventId`` is unique
+for all events or unique fault occurrence.
+
+**Example 1**: assumes a unique key for each domain consisting of domain
+followed by an integer domain<n> or domainId<n>, where <n> is a positive integer,
+e.g. fault000001, heartbeat000001, measurement000005,
+notification3gppPerfFileReady0005
-Example 2: assumes an integer key for all events nnnnnnnnn: 000000001,
-00000002, 000000003
+**Example 2**: assumes a unique integer key for all events across all domains
+<n>: 000000001, 00000002, 000000003
Rules:
@@ -220,35 +235,37 @@ Rules:
a. Most likely scenario
- i. The sourceName on each Fault event is the NF Instance Name
+ * The sourceName on each Fault event is the NF Instance Name
(pnf-name or vnf-name or vm-name) as entered in A&AI uniquely
identifying this instance of the NF.
- ii. The eventId on Fault events is the same every time a given
- fault is raised (onset), re-raised at fixed time interval,
- until it is cleared. Once the fault is cleared, a new eventId
- is used.
+ * The eventId on Fault events is the same every time a given
+ fault is raised (including onset and re-raise)
+
+ 1. The startEpochMicrosec value for the Fault event is the
+ timestamp for when the fault onset occurs. Subsequent
+ events for the same fault will keep the same startEpochMicrosec
+ value.
- iii. The startEpochMicrosec value for the Fault event is the
- timestamp for when that event is generated until a clear is
- sent.
+ 2. lastEpochMicrosec indicates the current event time. This value
+ will be updated for each subsequent event for a given fault.
- iv. lastEpochMicrosec indicates the current event time.
+ 3. The sequence number for each Fault event is set to 1 when the
+ fault is raised and increments each time the same
+ fault event is raised, until a clear is sent.
- v. The sequence number for each Fault event is set to 1 when the
- event is first raised, and increments each time the same
- Fault event is raised, until a clear is sent.
+ * After the fault is cleared, a new eventId is used.
.. image:: Use-Case-1.png
- b. Alternative scenario: for vNF when fault event status is not
- maintained.
+ b. **Alternative Scenario**: Network Function When Fault Event Status is Not
+ Maintained.
- i. The sourceName on each Fault event is the NF Instance Name
+ * The sourceName on each Fault event is the NF Instance Name
(pnf-name or vnf-name or vm-name) as entered in A&AI uniquely
identifying this instance of the NF.
- ii. The eventId on Fault events is the same every time a given
+ * The eventId on Fault events is the same every time a given
fault is raised or cleared, even if it is re-raised after it
had previously cleared. So, for example, if EMS loses
contact with a particular device then a Fault event might be
@@ -258,20 +275,26 @@ Rules:
(because EMS has lost contact with the device again). The
same eventId is used for all 4 of those Fault events.
- iii. The startEpochMicrosec value for each Fault event is the
+ * The startEpochMicrosec value for each Fault event is the
timestamp for when that event is generated, not when the
fault first occurred. So all 4 of the Fault events in the
previous bullet point would have a different timestamp.
- iv. lastEpochMicrosec indicates the current event time.
+ * lastEpochMicrosec indicates the current event time.
- v. The sequence number for each Fault event is currently set to
+ * The sequence number for each Fault event is currently set to
0 on a raise and 1 on a clear. We could change that so that
each Fault event is given a new monotonically increasing
sequence number whether it is a raise or a clear if that is
helpful (which is reset to 0 if the VM restarts) but they
won’t be consecutive.
+ * Normally, a clear is expected for each fault to be sent from a
+ network function. However a few fault notification types will never
+ be re-raised or cleared. In this case, general rules for VES events
+ shall be followed with a new eventId for each event and sequence
+ number set to 0.
+
.. image:: Use-Case-2.png
Measurement Expansion Fields
@@ -318,6 +341,104 @@ JSON content-type.
Alternative API specifications may be provided in future using Google
Protobuf, websockets, or Apache Avro.
+Configuration Requirements
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+This section provides network function configuration requirements for
+connectivity to a VES Event Listener via a RESTful API, using a VES JSON event.
+
+There are several methods available to provide configuration settings to a
+network function. This document does not specify the exact manner in which
+the configuration elements described below must be required. The
+configuration can be provided during instantiation (e.g. preload), provided by
+an ONAP controller action, or provided manually.
+
+* **VES Event Listener IP Addresses or FQDNs resolved via DNS**: Two FQDNs
+ and/or IP Addresses are required. NF shall select one of the 2 FQDNs/IP
+ Addresses for sending events and if the NF is unable to get an
+ acknowledgement within predefined configurable time interval
+ or unable to establish a TCP connection due inability to resolve DNS query or
+ if the VES Event Listener is unresponsive, then the NF shall attempt to use
+ the other FQDN/IP Address to connect to VES Event Listener to deliver the
+ VES Events. The events shall only be sent to one VES Event Listener at a time.
+ Please note: If a FQDN is used, the DNS query would return a single IP
+ address.
+* A single VES Event Listener may handle more than one type of VES event
+ (different domains); i.e. same VES Event Listener can receive and process
+ heartbeat, fault, measurement, syslog, etc. events.
+* **VES Credentials**: If the NF is using Basic Authentication, then the NF
+ must support the provisioning of security and authentication parameters
+ (HTTP username and password) in order to be able to authenticate with the
+ VES Event Listener. The Username and Password should be set unique per NF
+ instance and should be configured during the NF deployment through a
+ Controller or other means. The same password must also be configured into VES
+ Event Listener instance for successful handshake.
+* **VES Heartbeat Interval**: This must be a configurable parameter; current
+ default is 60 seconds. Note: the heartbeat interval should be greater than
+ the ack timeout value.
+* **Measurement Interval**: For measurement events, the measurement interval
+ must be configurable and a default of 300 seconds.
+* **ACK Timeout Interval**: Configurable, default 5 seconds.
+
+Event Domain Requirements/Expectations
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* **Heartbeat**: Heartbeat events must be sent to VES Event Listener based on
+ configurable parameter.
+* **Faults**: Fault events must be sent to the VES Event Listener as soon as
+ they occur.
+* **Measurements**: All measurement events must be sent at the configured
+ measurementInterval. If the NF provides both application and GuestOS
+ metrics, then they must both use the same measurementInterval.
+* **Syslogs**: Syslog events should be sent to the VES Event Listener as soon as
+ created, unless the NF is in debug mode (verbose logging enabled to get
+ additional data to diagnose a problem), in which case the syslogs must be
+ stored locally in the NF, for later access and possible secure transfer.
+* **Pre-defined Events Formats (Domain: Mobile Flow, TCA, State Chang, etc)**:
+ Other events (State change, TCA, Mobile Flow, etc) may use other pre-defined
+ VES domains from the VES Common Event Format specification based on the role
+ of the NF.
+* **otherFields**: The otherFields Record defines fields for events belonging
+ to the otherFields domain of the Technology Independent domain enumeration.
+ This record provides a mechanism to convey a complex set of fields
+ and is purely intended to address miscellaneous needs such as addressing
+ time-to-market considerations or other proof-of-concept evaluations. Hence,
+ use of this record type is discouraged and should be minimized.
+
+Use of Collector FQDNs and/or IP Address
+++++++++++++++++++++++++++++++++++++++++
+
+* The NF must support two configurable endpoints for the VES Event Listener.
+ One will be the active, primary event listener endpoint. The other
+ will be a standby event listener in the event the active endpoint is
+ unavailable.
+* When sending an event (FM, PM, Syslog, HB), the NF shall establish an HTTPS
+ connection to one VES Event Listener FQDN/IP Address (if not already
+ established) and send a VES event to it. Note that connections are not
+ persistent. The events shall only be sent to only one VES Event Listener at a
+ time.
+* The NF must be able to detect that a VES Event Listener endpoint is
+ unavailable, and trigger the fail-over to the backup endpoint. The mechanism
+ for detecting unavailability must be configurable by the Service Operator
+ (e.g. number of attempts, timeout value).
+* If the NF is sending events to the VES Event Listener backup endpoint, then
+ the NF must poll the primary endpoint on a configurable interval to check
+ if the primary endpoint is now available. The NF may use the Heartbeat
+ event or another mechanism to test availability. If the primary endpoint
+ becomes available, then the NF must fallback to the primary endpoint.
+* A NF must only send a unique event to a single VES Event Listener endpoint
+ at a time. In other words, the NF must not send a duplicate event to the
+ secondary endpoint unless the delivery to the primary endpoint failed.
+* If both Primary and Secondary endpoints are not available, then the NF shall
+ buffer the events locally. Refer to the Buffering of Events section for full
+ details.
+* If a NF is unable to establish a connection with a VES Event Listener or does
+ not get an acknowledgement within a specified time, then it should log this
+ failure and, optionally, send a fault event indicating
+ connection/acknowledgement failure via the alternate FQDN/IP Address. The
+ intent of this fault is to inform the Service Operator that the VES Event
+ Listener endpoint has become unreachable by the NF.
+
+
Versioning
~~~~~~~~~~~
@@ -393,29 +514,30 @@ Security
Event sources must identify themselves to the VES Event Listener.
-In the future, support for 2-way SSL certificate authentication (aka
-mutual SSL) may be provided (see the end of this Security section for
-additional information) otherwise, event source credentials must be
-passed using HTTP `Basic
-Authentication <http://tools.ietf.org/html/rfc2617>`__.
+There are 2 methods of HTTP authentication supported: Certificate Authentication
+and Basic Authentication.
-Credentials must not be passed on the query string. Credentials must be
-sent in an Authorization header as follows:
+Basic authentication is supported in VES Event Listener for backward
+compatibility for existing NFs that are already managed by ONAP. New NFs should
+support Certificate Authentication. Because the security is better, NFs may
+choose to only support Certificate Authentication and not support Basic
+Authentication.
-1. The username and password are formed into one string as
- “username:password”
+Basic Authentication
+~~~~~~~~~~~~~~~~~~~~
-2. The resulting string is Base64 encoded to produce the encoded
- credential.
+When using Basic Authentication, the event source must not pass credentials on
+the query string. Credentials must be sent in an Authorization header as
+follows:
+1. The username and password are formed into one string as
+ ``username:password``
+2. The resulting string is Base64 encoded to produce the encoded credential.
3. The encoded credential is communicated in the header after the string
- “Authorization: Basic “
-
-Because the credentials are merely encoded but not encrypted, HTTPS
-(rather than HTTP) should be used. HTTPS will also encrypt and protect
-event contents. TLS 1.2 or higher must be used.
+ ``Authorization: Basic``
-Examples are provided below.
+Because the credentials are merely encoded but not encrypted, HTTPS (rather
+than HTTP) should be used. HTTPS will also encrypt and protect event contents.
Sample Request and Response
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -423,101 +545,76 @@ Sample Request and Response
Sample Request
++++++++++++++
-+-------------------------------------------------------------------------+
-| POST /eventListener/v7 HTTP/1.1 |
-| |
-| Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== |
-| |
-| content-type: application/json |
-| |
-| | content-length: 12345 |
-| | { |
-| |
-| "event": { |
-| |
-| "commonEventHeader": { |
-| |
-| "version": "4.1", |
-| |
-| "vesEventListenerVersion": "7.1", |
-| |
-| "domain": "heartbeat", |
-| |
-| "eventName": "Heartbeat_vIsbcMmc", |
-| |
-| "eventId": "heartbeat0000249", |
-| |
-| "sequence": 0, |
-| |
-| "priority": "Normal", |
-| |
-| "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234", |
-| |
-| "reportingEntityName": "ibcx0001vm002oam001", |
-| |
-| "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014", |
-| |
-| "sourceName": "ibcx0001vm002ssc001", |
-| |
-| "nfVendorName": "Ericsson", |
-| |
-| "nfNamingCode": "ibcx", |
-| |
-| "nfcNamingCode": "ssc", |
-| |
-| "startEpochMicrosec": 1413378172000000, |
-| |
-| "lastEpochMicrosec": 1413378172000000, |
-| |
-| "timeZoneOffset": "UTC-05:30" |
-| |
-| } |
-| |
-| } |
-| |
-| } |
-+-------------------------------------------------------------------------+
+.. code-block:: http
+
+ POST /eventListener/v7 HTTP/1.1
+ Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
+ content-type: application/json
+ content-length: 12345
+ {
+ "event": {
+ "commonEventHeader": {
+ "version": "4.1",
+ "vesEventListenerVersion": "7.1.1",
+ "domain": "heartbeat",
+ "eventName": "Heartbeat_vIsbcMmc",
+ "eventId": "heartbeat0000249",
+ "sequence": 0,
+ "priority": "Normal",
+ "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234",
+ "reportingEntityName": "ibcx0001vm002oam001",
+ "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014",
+ "sourceName": "ibcx0001vm002ssc001",
+ "nfVendorName": "Ericsson",
+ "nfNamingCode": "ibcx",
+ "nfcNamingCode": "ssc",
+ "startEpochMicrosec": 1413378172000000,
+ "lastEpochMicrosec": 1413378172000000,
+ "timeZoneOffset": "UTC-05:30"
+ }
+ }
+ }
+
Sample Success Response
++++++++++++++++++++++++
-+--------------------------+
-| HTTPS/1.1 202 Accepted |
-| |
-| X-MinorVersion: 0 |
-| |
-| X-PatchVersion: 0 |
-| |
-| X-LatestVersion: 7.1 |
-+--------------------------+
-
-Mutual SSL Certificate Authentication
+.. code-block:: http
+
+ HTTPS/1.1 202 Accepted
+ X-MinorVersion: 1
+ X-PatchVersion: 1
+ X-LatestVersion: 7.1
+
+
+Mutual TLS Certificate Authentication
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-If service provider VES Event Listener support for Mutual SSL
-Certification Authentication is available, event sources must initialize
-the HTTPS connection with TLS 1.2 or higher and execute mutual
-authentication procedures according to
-`RFC5246 <https://tools.ietf.org/html/rfc5246#section-7.4.6>`__. If
-event source certificates cannot be verified or if certificate subject
-(identity) is unknown to the VES Event Listener, then HTTP Basic
-Authentication must be used as described above.
+When using Certificate Authentication, the event source must initialize the
+HTTPS connection with TLS 1.2 or higher and execute mutual authentication
+procedures according to `RFC5246 <https://tools.ietf.org/html/rfc5246#section-7.4.6>`__.
+The event source must authenticate the VES Listener certificate and must
+provide its own X.509v3 end-entity certificate to the VES Listener for
+authentication. The Subject Name in the end-entity certificate must be used
+according to `RFC5280 <https://www.ietf.org/rfc/rfc5280.txt>`__. If a
+certificate is provided by the NF but it is invalid, the VES Listener is
+expected to reject the connection and not fall back to basic authentication.
Resource Structure
^^^^^^^^^^^^^^^^^^
REST resources are defined with respect to a ServerRoot:
-ServerRoot = /{optionalRoutingtPath}
+ServerRoot = https://{Domain|IP}:{Port}/{optionalRoutingPath}
The resource structure is provided below:
-.. image:: rest-resource.png
+.. figure:: rest-resource.png
+ :alt: REST Resource Structure
-Figure – REST Resource Structure
+ REST Resource Structure
-The {Domain} or FQDN above is typically provisioned into each
-eventsource when it is instantiated. The {Port} above is typically 8443.
+The {Port} above is typically 8443.
Common Event Format
^^^^^^^^^^^^^^^^^^^^
@@ -525,7 +622,7 @@ Common Event Format
A JSON schema describing the Common Event Format is provided below and
is reproduced in the tables that follow.
-:download:`JSON <CommonEventFormat_30.1_ONAP.json>`
+:download:`JSON <CommonEventFormat_30.1.1_ONAP.json>`
Note on optional fields:
@@ -609,6 +706,9 @@ The event datatype consists of the following fields which constitute the
| otherFields | otherFields | No | Fields specific to other types of |
| | | | events |
+--------------+--------------+-----------+-----------------------------------+
+| perf3gpp\ | perf3gpp\ | No | Fields specific to perf3gpp |
+| Fields | Fields | | events |
++--------------+--------------+-----------+-----------------------------------+
| pnf\ | pnf\ | No | Fields specific to pnfRegistration|
| Registration\| Registration\| | events |
| Fields | Fields | | |
@@ -644,7 +744,7 @@ Datatype: hashMap
+++++++++++++++++++
The hashMap datatype is an ‘associative array’, which is an unordered
-collection of key-value pairs of the form “key”: “value”, where each key
+collection of key-value pairs of the form "key": "value", where each key
and value are strings. Keys must use camel casing to separate words and
acronyms; only the first letter of each acronym shall be capitalized.
@@ -786,8 +886,8 @@ information:
| | | | the event |
+--------------+--------+-----------+----------------------------------------+
-‘Common Event Header’ Datatypes
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Common Event Header Data Types
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Datatype: commonEventHeader
++++++++++++++++++++++++++++
@@ -928,13 +1028,13 @@ to all events:
| | | | time_zone_abbreviations_ for UTC offset |
| | | | examples |
+-----------+----------+-----------+-----------------------------------------+
-| version | string | Yes | Version of the event header as “#.#” |
+| version | string | Yes | Version of the event header as "#.#" |
| | | | where # is a digit; see section 1 for |
| | | | the correct digits to use. |
+-----------+----------+-----------+-----------------------------------------+
| vesEvent\ | string | Yes | Version of the ves event listener api |
| Listener\ | | | spec that this event is compliant with |
-| Version | | | (as “#” or “#.#” or “#.#.#” where # is a|
+| Version | | | (as "#" or "#.#" or "#.#.#" where # is a|
| | | | digit; see section 1 for the correct |
| | | | digits to use). |
+-----------+----------+-----------+-----------------------------------------+
@@ -1011,7 +1111,7 @@ The faultFields datatype consists of the following fields:
| | | | be managed object class. |
+-----------------+---------+-----------+-------------------------------------+
| faultFields\ | string | Yes | Version of the faultFields block as |
-| Version | | | “#.#” where # is a digit; see |
+| Version | | | "#.#" where # is a digit; see |
| | | | section 1 for the correct digits to |
| | | | use. |
+-----------------+---------+-----------+-------------------------------------+
@@ -1043,7 +1143,7 @@ specific to heartbeat events; it consists of the following fields:
| Fields | | | |
+---------------+---------+-----------+---------------------------------------+
| heartbeat\ | string | Yes | Version of the heartbeatFields block |
-| FieldsVersion | | | as “#.#” where # is a digit; see |
+| FieldsVersion | | | as "#.#" where # is a digit; see |
| | | | section 1 for the correct digits to |
| | | | use. |
+---------------+---------+-----------+---------------------------------------+
@@ -1845,7 +1945,7 @@ The measurementFields datatype consists of the following fields:
| Latency | | | xNFC reporting the event is running |
+-------------+--------------+----------+-------------------------------------+
| measurement\| string | Yes | Version of the measurementFields |
-| Fields\ | | | block as “#.#” where # is a digit; |
+| Fields\ | | | block as "#.#" where # is a digit; |
| Version | | | see section 1 for the correct digits|
| | | | to use. |
+-------------+--------------+----------+-------------------------------------+
@@ -2215,7 +2315,7 @@ The notificationFields datatype consists of the following fields:
| | | | ‘outOfService’ |
+--------------+-----------+----------+---------------------------------------+
| notification\| string | Yes | Version of the notificationFields |
-| FieldsVersion| | | block as “#.#” where # is a digit; see|
+| FieldsVersion| | | block as "#.#" where # is a digit; see|
| | | | section 1 for the correct digits to |
| | | | use. |
+--------------+-----------+----------+---------------------------------------+
@@ -2235,17 +2335,17 @@ populated as follows:
in 3GPP TS 28.550. The array contains the following key value pairs:
- **location** in the form protocol://ipAddress:port/path/filename;
- e.g. “location” :
- “ftpes://135.3.1.44:21/pmfiles/A20180531.1030+0600-1045+0600\_5gBts213.bin.gz”
+ e.g. "location" :
+ "ftpes://135.3.1.44:21/pmfiles/A20180531.1030+0600-1045+0600\A20000626.2315+0200-2330+0200_NodeBId.gz"
- **compression** containing the compression type used for the PM file;
- e.g. “compression” : “gzip”
+ e.g. "compression" : "gzip"
- **fileFormatType** containing the format type of the PM file; e.g.
- “fileFormatType” : “org.3GPP.32.435#measCollec”
+ "fileFormatType" : "org.3GPP.32.435#measCollec"
- **fileFormatVersion** containing the format version of the PM file;
- e.g. “fileFormatVersion” : “V10”
+ e.g. "fileFormatVersion" : "V10"
- other vendor-defined key-value pairs as needed
@@ -2278,7 +2378,7 @@ of the following fields:
| | | | meta-information |
+-------------+-------------+----------+--------------------------------------+
| otherFields\| string | Yes | Version of the otherFields block as |
-| Version | | | “#.#” where # is a digit; see section|
+| Version | | | "#.#" where # is a digit; see section|
| | | | 1 for the correct digits to use. |
+-------------+-------------+----------+--------------------------------------+
@@ -2537,7 +2637,7 @@ enumeration; it consists of the following fields:
| IpAddress | | | the manager to contact the PNF |
+-----------------+--------+----------+---------------------------------------+
| pnfRegistration\| string | Yes | Version of the pnfRegistrationFields |
-| FieldsVersion | | | block as “#.#” where # is a digit; see|
+| FieldsVersion | | | block as "#.#" where # is a digit; see|
| | | | section 1 for the correct digits to |
| | | | use. |
+-----------------+--------+----------+---------------------------------------+
@@ -2580,7 +2680,7 @@ The stateChangeFields datatype consists of the following fields:
| | | | , ‘maintenance’, ‘outOfService’ |
+--------------+--------+----------+------------------------------------------+
| stateChange\ | string | Yes | Version of the stateChangeFields block as|
-| FieldsVersion| | | “#.#” where # is a digit; see section 1 |
+| FieldsVersion| | | "#.#" where # is a digit; see section 1 |
| | | | for the correct digits to use. |
+--------------+--------+----------+------------------------------------------+
| state\ | string | Yes | Card or port name of the entity that |
@@ -2599,7 +2699,7 @@ The syslogFields datatype consists of the following fields:
| Field | Type | Required?| Description |
+============+========+==========+============================================+
| additional\| hashMap| No | Additional syslog fields if needed Ex: |
-| Fields | | | {“name1”: ”value1”, “name2: “value2” … } |
+| Fields | | | {"name1": "value1", "name2: "value2" … } |
+------------+--------+----------+--------------------------------------------+
| event\ | string | No | Hostname of the device |
| SourceHost | | | |
@@ -2660,7 +2760,7 @@ The syslogFields datatype consists of the following fields:
| | | | |
| | | | 23 local use 7 (local7 ) |
+------------+--------+----------+--------------------------------------------+
-| syslog\ | string | Yes | Version of the syslogFields block as “#.#” |
+| syslog\ | string | Yes | Version of the syslogFields block as "#.#" |
| Fields\ | | | where # is a digit; see section 1 for the |
| Version | | | correct digits to use. |
+------------+--------+----------+--------------------------------------------+
@@ -2679,7 +2779,7 @@ The syslogFields datatype consists of the following fields:
| syslog\ | number | No | The process number assigned by the OS when |
| ProcId | | | the application was started |
+------------+--------+----------+--------------------------------------------+
-| syslog\ | string | No | A <space> separated list of key=”value” |
+| syslog\ | string | No | A <space> separated list of key="value" |
| SData | | | pairs following the rfc5424 standard for |
| | | | SD-ELEMENT. |
| | | | |
@@ -2735,13 +2835,13 @@ Examples of syslogSData :
Preferred
- ts=”1985-04-12T23:20:50.52Z” tag=”BGP\_NEIGHBOR\_DOWN” msg=”The BGP
- session to neighbor 10.10.10.10 is down”
+ ts="1985-04-12T23:20:50.52Z" tag="BGP\_NEIGHBOR\_DOWN" msg="The BGP
+ session to neighbor 10.10.10.10 is down"
Deprecated
- [attinc@1234 ts=”1985-04-12T23:20:50.52Z” tag=”BGP\_NEIGHBOR\_DOWN”
- msg=”The BGP session to neighbor 10.10.10.10 is down”]
+ [attinc@1234 ts="1985-04-12T23:20:50.52Z" tag="BGP\_NEIGHBOR\_DOWN"
+ msg="The BGP session to neighbor 10.10.10.10 is down"]
Syslog references:
@@ -2830,7 +2930,7 @@ fields:
+------------+------------+----------+----------------------------------------+
| threshold\ | string | Yes | Version of the |
| Crossing | | | thresholdCrossingAlertFields block as |
-| Fields\ | | | “#.#” where # is a digit; see section 1|
+| Fields\ | | | "#.#" where # is a digit; see section 1|
| Version | | | for the correct digits to use. |
+------------+------------+----------+----------------------------------------+
@@ -3105,7 +3205,7 @@ The mobileFlowFields datatype consists of the following fields:
| mnc | string | No | Mobile network code |
+-------------+------------+----------+---------------------------------------+
| mobileFlow\ | string | Yes | Version of the mobileFlowFields block |
-| Fields\ | | | as “#.#” where # is a digit; see |
+| Fields\ | | | as "#.#" where # is a digit; see |
| Version | | | section 1 for the correct digits to |
| | | | use. |
+-------------+------------+----------+---------------------------------------+
@@ -3186,7 +3286,7 @@ following fields:
| remotePort | string | Yes | Port of peer endpoint |
+--------------+-----------+----------+---------------------------------------+
| sipSignaling\| string | Yes | Version of the sipSignalingFields |
-| FieldsVersion| | | block as “#.#” where # is a digit; see|
+| FieldsVersion| | | block as "#.#" where # is a digit; see|
| | | | section 1 for the correct digits to |
| | | | use. |
+--------------+-----------+----------+---------------------------------------+
@@ -3343,7 +3443,7 @@ facing voice products; consists of the following fields:
| NameFields | NameFields | | |
+--------------+-------------+----------+-------------------------------------+
| voiceQuality\| string | Yes | Version of the voiceQualityFields |
-| FieldsVersion| | | block as “#.#” where # is a digit; |
+| FieldsVersion| | | block as "#.#" where # is a digit; |
| | | | see section 1 for the correct digits|
| | | | to use. |
+--------------+-------------+----------+-------------------------------------+
@@ -3502,9 +3602,9 @@ REST Operation Summary
Table - REST Operation Summary
Api Versioning
-+++++++++++++++
+++++++++++++++
-apiVersion is used to describe the major version number of the event
+``apiVersion`` is used to describe the major version number of the event
listener API (which is the same as the major version number of this
specification). When this number changes, the implication is: the new
major version will break clients of older major versions in some way, if
@@ -3515,47 +3615,79 @@ The Event Listener shall provide the following HTTP headers in response
to all requests. Additionally, clients may populate these headers on
requests to indicate the specific version they are interested in.
-- X-MinorVersion: 0
+- X-MinorVersion: 1
-- X-PatchVersion: 0
+- X-PatchVersion: 1
- X-LatestVersion: 7.1
If a client requests major version 7 (per the REST resource URL) and
does not specify the above headers, then they will be provided with the
latest patch version of 7.0.x (which is 7.0.1). If the client wants a
-particular minor version of major version 7, then they need to supply
+minor version of major version 7, then they need to supply
the X-MinorVersion header with their request. For example, if they
request major version 7 with X-MinorVersion: 1, they will get the latest
-patch version of 7.1, which is 7.1.0.
+patch version of 7.1, which is 7.1.1.
Buffering of Events
-++++++++++++++++++++
++++++++++++++++++++
-{ServerRoot} is defined in section 3 of this document, which defines the
-REST resource URL. One or more FQDNs may be provisioned in an event
-source when it is instantiated or updated. If an event source is unable
-to reach any of the provisioned FQDNs, it should buffer the event data
-specified below, up to a maximum of 1 hour, until a connection can be
-established and the events can be successfully delivered to the VES
-Event Listener service.
+``{ServerRoot}`` is defined in section 3 of this document, which defines the
+REST resource URL. One or more FQDNs may be provisioned in an event source
+when it is instantiated or updated. If an event source is unable to reach any
+of the provisioned FQDNs, it should buffer the event data specified below, up
+to a maximum of 1 hour, and re-transmit them once a connection has been
+established.
+
+The following events should be buffered:
+
+* Faults with eventSeverity of ``MINOR``, ``MAJOR``, ``NORMAL``, or ``CRITICAL``
+ with following expected behavior:
+
+ * NF keeps a First-In-First-Out buffer.
+ * Until the collectors are working again, it is desired that the NF sends
+ the final state events only, and not intermediate ones. However, it is
+ acceptable to buffer all events and send them over to the collector in
+ the same order in which they were generated/received.
+
+* When one VES Event Listener connectivity is re-established, NF should first
+ send the buffered events and then start sending the new events.
+
+ * Syslog with syslogSev of ``Emergency``, ``Alert``, ``Critical``,
+ ``Error``, or ``Warning``
-xNFs acting as event sources should not send syslog events to the VES
-Event Listener during debug mode (which is controlled via the Netconf
-management interface), but should store syslog events locally for
-access, and possible FTP transfer, via the xNF console (e.g., command
-line interface).
+* All measurements events
-If the internal event source event buffer or local storage should
-overflow, then the event source should send a Fault event, and should
-discard events in a first-in, first-out (FIFO) manner (i.e., discard
-oldest events first).
+publishEventBatch Requirements
+******************************
+
+Buffered events can be sent in batch using ``publishEventBatch``. However, a
+NF vendor must only include multiple events for the same domain in the
+``publishEventBatch``. The ``publishEventBatch`` event must also conform to
+event size limits.
+
+``publishEventBatch`` events are handled similarly to a single event. The
+acknowledgement from the VES Event Listener is for the ``publishEventBatch`` and
+not individual events within the ``publishEventBatch``.
+
+Debug Mode
+**********
+
+NFs acting as event sources should not send syslog events to the
+VES Event Listener during debug mode, but should store syslog events locally
+for access, and possible FTP transfer, via the NF console (e.g., command line
+interface).
+
+.. _msg-size:
Message Size
-+++++++++++++++
+++++++++++++
-Message size should be limited to 2 megabytes of uncompressed text sent
-as application/json.
+The maximum allowed message size is 2 megabytes of uncompressed text.
+However,messages of this size have been known to cause performance and data
+loss. It is strongly recommended,that messages not exceed 1 megabyte.
+In a future version of the specification, a 1 megabyte limit will become
+a mandatory requirement.
Operation: publishAnyEvent
~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -3566,7 +3698,7 @@ Functional Behavior
Allows authorized clients to publish any single event to the VES event
listener.
-- Supports only secure HTTPS (one way SSL) access.
+- Supports only HTTPS access.
- Uses the HTTP verb POST
@@ -3578,9 +3710,10 @@ listener.
Call Flow
++++++++++
-.. image:: publish-event-flow.png
+.. figure:: publish-event-flow.png
+ :alt: publishAnyEvent Call Flow
-Figure - publishAnyEvent Call Flow
+ ``publishAnyEvent`` Call Flow
Input Parameters
+++++++++++++++++
@@ -3598,11 +3731,11 @@ case-insensitive):
+---------------+----------+----------+---------------------------------------+
| Authorization | string | Yes | The username and password are formed |
| | | | into one string as |
-| | | | “username:password”. This string is |
+| | | | ``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 |
+| | | | string "Authorization: Basic ". See |
| | | | examples below. If the Authorization |
| | | | header is missing, then an HTTP 400 |
| | | | Invalid Request message shall be |
@@ -3611,7 +3744,7 @@ case-insensitive):
| | | | message shall be returned. |
+---------------+----------+----------+---------------------------------------+
| Content-length| integer | No | Note that content length is limited to|
-| | | | 2Megabyte. |
+| | | | 2 Megabyte (see :ref:`msg-size`) |
+---------------+----------+----------+---------------------------------------+
| Content-type | string | Yes | Must be set to one of the following |
| | | | values: |
@@ -3714,99 +3847,60 @@ Sample Request and Response
Sample Request
***************
-+-----------------------------------------------------------------------------+
-| POST /eventListener/v7 HTTP/1.1 |
-| |
-| Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== |
-| |
-| content-type: application/json |
-| |
-| content-length: 12345 |
-| |
-| X-MinorVersion: 1 |
-| |
-| { |
-| |
-| "event": { |
-| |
-| "commonEventHeader": { |
-| |
-| "version": "4.1", |
-| |
-| "vesEventListenerVersion": "7.1", |
-| |
-| "domain": "fault", |
-| |
-| "eventName": "Fault\_Vscf:Acs-Ericcson\_PilotNumberPoolExhaustion", |
-| |
-| "eventId": "fault0000245", |
-| |
-| "sequence": 1, |
-| |
-| "priority": "High", |
-| |
-| "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234", |
-| |
-| "reportingEntityName": "ibcx0001vm002oam001", |
-| |
-| "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014", |
-| |
-| "sourceName": "scfx0001vm002cap001", |
-| |
-| "nfVendorName": "Ericsson", |
-| |
-| "nfNamingCode": "scfx", |
-| |
-| "nfcNamingCode": "ssc", |
-| |
-| "startEpochMicrosec": 1413378172000000, |
-| |
-| "lastEpochMicrosec": 1413378172000000, |
-| |
-| "timeZoneOffset": "UTC-05:30" |
-| |
-| }, |
-| |
-| "faultFields": { |
-| |
-| "faultFieldsVersion": 4.0, |
-| |
-| "alarmCondition": "PilotNumberPoolExhaustion", |
-| |
-| "eventSourceType": "other", |
-| |
-| "specificProblem": "Calls cannot complete - |
-| pilot numbers are unavailable", |
-| |
-| "eventSeverity": "CRITICAL", |
-| |
-| "vfStatus": "Active", |
-| |
-| "alarmAdditionalInformation": { |
-| |
-| "PilotNumberPoolSize": "1000" |
-| |
-| } |
-| |
-| } |
-| |
-| } |
-| |
-| } |
-+-----------------------------------------------------------------------------+
+.. code-block:: http
+
+ POST /eventListener/v7 HTTP/1.1
+ Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
+ content-type: application/json
+ content-length: 12345
+ X-MinorVersion: 1
+
+ {
+ "event": {
+ "commonEventHeader": {
+ "version": "4.1",
+ "vesEventListenerVersion": "7.1.1",
+ "domain": "fault",
+ "eventName": "Fault_Vscf:Acs-Ericcson_PilotNumberPoolExhaustion",
+ "eventId": "fault0000245",
+ "sequence": 1,
+ "priority": "High",
+ "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234",
+ "reportingEntityName": "ibcx0001vm002oam001",
+ "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014",
+ "sourceName": "scfx0001vm002cap001",
+ "nfVendorName": "Ericsson",
+ "nfNamingCode": "scfx",
+ "nfcNamingCode": "ssc",
+ "startEpochMicrosec": 1413378172000000,
+ "lastEpochMicrosec": 1413378172000000,
+ "timeZoneOffset": "UTC-05:30"
+ },
+ "faultFields": {
+ "faultFieldsVersion": 4.0,
+ "alarmCondition": "PilotNumberPoolExhaustion",
+ "eventSourceType": "other",
+ "specificProblem": "Calls cannot complete - pilot numbers are unavailable",
+ "eventSeverity": "CRITICAL",
+ "vfStatus": "Active",
+ "alarmAdditionalInformation": {
+ "PilotNumberPoolSize": "1000"
+ }
+ }
+ }
+ }
+
+
Sample Success Response
************************
-+--------------------------+
-| HTTPS/1.1 202 Accepted |
-| |
-| X-MinorVersion: 1 |
-| |
-| X-PatchVersion: 0 |
-| |
-| X-LatestVersion: 7.1 |
-+--------------------------+
+.. code-block:: http
+
+ HTTPS/1.1 202 Accepted
+ X-MinorVersion: 1
+ X-PatchVersion: 1
+ X-LatestVersion: 7.1.1
Sample Error Responses
************************
@@ -3814,80 +3908,51 @@ Sample Error Responses
Sample Policy Exception
""""""""""""""""""""""""
-+---------------------------------------------------------------------+
-| HTTPS/1.1 400 Bad Request |
-| |
-| content-type: application/json |
-| |
-| content-length: 12345 |
-| |
-| Date: Thu, 04 Jun 2009 02:51:59 GMT |
-| |
-| X-MinorVersion: 1 |
-| |
-| X-PatchVersion: 0 |
-| |
-| X-LatestVersion: 7.1 |
-| |
-| { |
-| |
-| “requestError”: { |
-| |
-| “policyException”: { |
-| |
-| “messageId”: “POL9003”, |
-| |
-| “text”: “Message content size exceeds the allowable limit”, |
-| |
-| } |
-| |
-| } |
-| |
-| } |
-+---------------------------------------------------------------------+
+.. code-block:: http
+
+ HTTPS/1.1 400 Bad Request
+ content-type: application/json
+ content-length: 12345
+ Date: Thu, 04 Jun 2009 02:51:59 GMT
+ X-MinorVersion: 1
+ X-PatchVersion: 1
+ X-LatestVersion: 7.1.1
+
+ {
+ "requestError": {
+ "policyException": {
+ "messageId": "POL9003",
+ "text": "Message content size exceeds the allowable limit",
+ }
+ }
+ }
+
Sample Service Exception
"""""""""""""""""""""""""
-+-----------------------------------------------------------+
-| HTTPS/1.1 400 Bad Request |
-| |
-| content-type: application/json |
-| |
-| content-length: 12345 |
-| |
-| Date: Thu, 04 Jun 2009 02:51:59 GMT |
-| |
-| X-MinorVersion: 1 |
-| |
-| X-PatchVersion: 0 |
-| |
-| X-LatestVersion: 7.1 |
-| |
-| { |
-| |
-| “requestError”: { |
-| |
-| “serviceException”: { |
-| |
-| “messageId”: “SVC2000”, |
-| |
-| “text”: “Missing Parameter: %1. Error code is %2” |
-| |
-| “variables”: [ |
-| |
-| “severity”, |
-| |
-| “400” |
-| |
-| ] |
-| |
-| } |
-| |
-| } |
-| |
-| } |
-+-----------------------------------------------------------+
+.. code-block:: http
+
+ HTTPS/1.1 400 Bad Request
+ content-type: application/json
+ content-length: 12345
+ Date: Thu, 04 Jun 2009 02:51:59 GMT
+ X-MinorVersion: 1
+ X-PatchVersion: 1
+ X-LatestVersion: 7.1.1
+
+ {
+ "requestError": {
+ "serviceException": {
+ "messageId": "SVC2000",
+ "text": "Missing Parameter: %1. Error code is %2"
+ "variables": [
+ "severity",
+ "400"
+ ]
+ }
+ }
+ }
Operation: publishEventBatch
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -3898,7 +3963,7 @@ Functional Behavior
Allows authorized clients to publish a batch of events to the VES event
listener.
-- Supports only secure HTTPS (one way SSL) access.
+- Supports only HTTPS access.
- Uses the HTTP verb POST
@@ -3910,9 +3975,10 @@ listener.
Call Flow
+++++++++++
-.. image:: publish-event-flow.png
+.. figure:: publish-event-flow.png
+ :alt: publishEvent Call Flow
-Figure – publishEventBatch Call Flow
+ ``publishEventBatch`` Call Flow
Input Parameters
+++++++++++++++++
@@ -3928,13 +3994,13 @@ case-insensitive):
| | | | |
| | | | - application/json |
+---------------+----------+----------+---------------------------------------+
-| Authorization | string | Yes | The username and password are formed |
-| | | | into one string as “username:password”|
+| Authorization | string | No | 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 |
+| | | | 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 |
@@ -3943,7 +4009,7 @@ case-insensitive):
| | | | returned. |
+---------------+----------+----------+---------------------------------------+
| Content-length| integer | No | Note that content length is limited to|
-| | | | 2Megabyte. |
+| | | | 2 megabyte (see :ref:`msg-size`). |
+---------------+----------+----------+---------------------------------------+
| Content-type | string | Yes | Must be set to one of the following |
| | | | values: |
@@ -4007,7 +4073,7 @@ Body Fields (for error responses):
+--------------+--------------+----------------+------------------------------+
HTTP Status Codes
-++++++++++++++++++
++++++++++++++++++
+-----+--------------+--------------------------------------------------------+
| Code| Reason Phrase| Description |
@@ -4046,160 +4112,89 @@ Sample Request and Response
Sample Request
****************
-+-----------------------------------------------------------------------------+
-| POST /eventListener/v7/eventBatch HTTP/1.1 |
-| |
-| Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== |
-| |
-| content-type: application/json |
-| |
-| content-length: 12345 |
-| X-MinorVersion: 1 |
-| |
-| { |
-| |
-| "eventList": [ |
-| |
-| { |
-| |
-| "commonEventHeader": { |
-| |
-| "version": "4.1", |
-| |
-| "vesEventListenerVersion": "7.1", |
-| |
-| "domain": "fault", |
-| |
-| "eventName": "Fault_Vscf:Acs-Ericcson_PilotNumberPoolExhaustion", |
-| |
-| "eventId": "fault0000250", |
-| |
-| "sequence": 1, |
-| |
-| "priority": "High", |
-| |
-| "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234", |
-| |
-| "reportingEntityName": "ibcx0001vm002oam0011234", |
-| |
-| "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014", |
-| |
-| "sourceName": "scfx0001vm002cap001", |
-| |
-| "nfVendorName": "Ericsson", |
-| |
-| "nfNamingCode": "scfx", |
-| |
-| "nfcNamingCode": "ssc", |
-| |
-| "startEpochMicrosec": 1413378172000000, |
-| |
-| "lastEpochMicrosec": 1413378172000000, |
-| |
-| "timeZoneOffset": "UTC-05:30" |
-| |
-| }, |
-| |
-| "faultFields": { |
-| |
-| "faultFieldsVersion": 4.0, |
-| |
-| "alarmCondition": "PilotNumberPoolExhaustion", |
-| |
-| "eventSourceType": "other", |
-| |
-| "specificProblem": "Calls cannot complete - pilot numbers are |
-| unavailable", |
-| |
-| "eventSeverity": "CRITICAL", |
-| |
-| "vfStatus": "Active", |
-| |
-| "alarmAdditionalInformation": { |
-| |
-| "PilotNumberPoolSize": "1000" |
-| |
-| } |
-| |
-| } |
-| |
-| }, |
-| |
-| { |
-| |
-| "commonEventHeader": { |
-| |
-| "version": "4.1", |
-| |
-| "vesEventListenerVersion": "7.1", |
-| |
-| "domain": "fault", |
-| |
-| "eventName": " Fault_Vscf:Acs-Ericcson_RecordingServerUnreachable",|
-| |
-| "eventId": "fault0000251", |
-| |
-| "sequence": 0, |
-| |
-| "priority": "High", |
-| |
-| "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234", |
-| |
-| "reportingEntityName": "ibcx0001vm002oam0011234", |
-| |
-| "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014", |
-| |
-| "sourceName": "scfx0001vm002cap001", |
-| |
-| "nfVendorName": "Ericsson", |
-| |
-| "nfNamingCode": "scfx", |
-| |
-| "nfcNamingCode": "ssc", |
-| |
-| "startEpochMicrosec": 1413378172000010, |
-| |
-| "lastEpochMicrosec": 1413378172000010, |
-| |
-| "timeZoneOffset": "UTC-05:30" |
-| |
-| }, |
-| |
-| "faultFields": { |
-| |
-| "faultFieldsVersion": 4.0, |
-| |
-| "alarmCondition": "RecordingServerUnreachable", |
-| |
-| "eventSourceType": "other", |
-| |
-| "specificProblem": "Recording server unreachable", |
-| |
-| "eventSeverity": "CRITICAL", |
-| |
-| "vfStatus": "Active" |
-| |
-| } |
-| |
-| } |
-| |
-| ] |
-| |
-| } |
-+-----------------------------------------------------------------------------+
+.. code-block:: http
+
+ POST /eventListener/v7/eventBatch HTTP/1.1
+ Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
+ content-type: application/json
+ content-length: 12345
+ X-MinorVersion: 1
+
+ {
+ "eventList": [
+ {
+ "commonEventHeader": {
+ "version": "4.1",
+ "vesEventListenerVersion": "7.1.1",
+ "domain": "fault",
+ "eventName": "Fault_Vscf:Acs-Ericcson_PilotNumberPoolExhaustion",
+ "eventId": "fault0000250",
+ "sequence": 1,
+ "priority": "High",
+ "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234",
+ "reportingEntityName": "ibcx0001vm002oam0011234",
+ "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014",
+ "sourceName": "scfx0001vm002cap001",
+ "nfVendorName": "Ericsson",
+ "nfNamingCode": "scfx",
+ "nfcNamingCode": "ssc",
+ "startEpochMicrosec": 1413378172000000,
+ "lastEpochMicrosec": 1413378172000000,
+ "timeZoneOffset": "UTC-05:30"
+ },
+ "faultFields": {
+ "faultFieldsVersion": 4.0,
+ "alarmCondition": "PilotNumberPoolExhaustion",
+ "eventSourceType": "other",
+ "specificProblem": "Calls cannot complete - pilot numbers are unavailable",
+ "eventSeverity": "CRITICAL",
+ "vfStatus": "Active",
+ "alarmAdditionalInformation": {
+ "PilotNumberPoolSize": "1000"
+ }
+ }
+ },
+ {
+ "commonEventHeader": {
+ "version": "4.1",
+ "vesEventListenerVersion": "7.1.1",
+ "domain": "fault",
+ "eventName": " Fault_Vscf:Acs-Ericcson_RecordingServerUnreachable",
+ "eventId": "fault0000251",
+ "sequence": 0,
+ "priority": "High",
+ "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234",
+ "reportingEntityName": "ibcx0001vm002oam0011234",
+ "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014",
+ "sourceName": "scfx0001vm002cap001",
+ "nfVendorName": "Ericsson",
+ "nfNamingCode": "scfx",
+ "nfcNamingCode": "ssc",
+ "startEpochMicrosec": 1413378172000010,
+ "lastEpochMicrosec": 1413378172000010,
+ "timeZoneOffset": "UTC-05:30"
+ },
+ "faultFields": {
+ "faultFieldsVersion": 4.0,
+ "alarmCondition": "RecordingServerUnreachable",
+ "eventSourceType": "other",
+ "specificProblem": "Recording server unreachable",
+ "eventSeverity": "CRITICAL",
+ "vfStatus": "Active"
+ }
+ }
+ ]
+ }
Sample Success Response
*************************
-+--------------------------+
-| HTTPS/1.1 202 Accepted |
-| |
-| X-MinorVersion: 1 |
-| |
-| X-PatchVersion: 0 |
-| |
-| X-LatestVersion: 7.1 |
-+--------------------------+
+.. code-block:: http
+
+ HTTPS/1.1 202 Accepted
+ X-MinorVersion: 1
+ X-PatchVersion: 1
+ X-LatestVersion: 7.1.1
Sample Error Responses
************************
@@ -4207,80 +4202,53 @@ Sample Error Responses
Sample Policy Exception
""""""""""""""""""""""""
-+-------------------------------------------------------------------+
-| HTTPS/1.1 400 Bad Request |
-| |
-| content-type: application/json |
-| |
-| content-length: 12345 |
-| |
-| Date: Thu, 04 Jun 2009 02:51:59 GMT |
-| |
-| X-MinorVersion: 1 |
-| |
-| X-PatchVersion: 0 |
-| |
-| X-LatestVersion: 7.1 |
-| |
-| { |
-| |
-| “requestError”: { |
-| |
-| “policyException”: { |
-| |
-| “messageId”: “POL9003”, |
-| |
-| “text”: “Message content size exceeds the allowable limit”, |
-| |
-| } |
-| |
-| } |
-| |
-| } |
-+-------------------------------------------------------------------+
+.. code-block:: http
+
+ HTTPS/1.1 400 Bad Request
+ content-type: application/json
+ content-length: 12345
+ Date: Thu, 04 Jun 2009 02:51:59 GMT
+ X-MinorVersion: 1
+ X-PatchVersion: 1
+ X-LatestVersion: 7.1.1
+
+ {
+ "requestError": {
+ "policyException": {
+ "messageId": "POL9003",
+ "text": "Message content size exceeds the allowable limit",
+ }
+ }
+ }
+
+
Sample Service Exception
"""""""""""""""""""""""""
-+-----------------------------------------------------------+
-| HTTPS/1.1 400 Bad Request |
-| |
-| content-type: application/json |
-| |
-| content-length: 12345 |
-| |
-| Date: Thu, 04 Jun 2009 02:51:59 GMT |
-| |
-| X-MinorVersion: 1 |
-| |
-| X-PatchVersion: 0 |
-| |
-| X-LatestVersion: 7.1 |
-| |
-| { |
-| |
-| “requestError”: { |
-| |
-| “serviceException”: { |
-| |
-| “messageId”: “SVC2000”, |
-| |
-| “text”: “Missing Parameter: %1. Error code is %2” |
-| |
-| “variables”: [ |
-| |
-| “severity”, |
-| |
-| “400” |
-| |
-| ] |
-| |
-| } |
-| |
-| } |
-| |
-| } |
-+-----------------------------------------------------------+
+.. code-block:: http
+
+ HTTPS/1.1 400 Bad Request
+ content-type: application/json
+ content-length: 12345
+ Date: Thu, 04 Jun 2009 02:51:59 GMT
+ X-MinorVersion: 1
+ X-PatchVersion: 1
+ X-LatestVersion: 7.1.1
+
+ {
+ "requestError": {
+ "serviceException": {
+ "messageId": "SVC2000",
+ "text": "Missing Parameter: %1. Error code is %2"
+ "variables": [
+ "severity",
+ "400"
+ ]
+ }
+ }
+ }
+
Terminology
^^^^^^^^^^^^
@@ -4606,7 +4574,7 @@ Contents.
| 9/16/2015 | v1.4 | JSON Schema rev’d to v10: |
| | | |
| | | - Fixed an error in the way that the top level |
-| | | “event” object was specified in the v9 json schema. |
+| | | "event" object was specified in the v9 json schema. |
| | | This was discovered when validating examples |
| | | against the schema using this site: |
| | | http://json-schema-validator.herokuapp.com/index.jsp|
@@ -4735,7 +4703,7 @@ Contents.
| | | |
| | | - Note: for the VendorEventListener: added new |
| | | licensing language on the back of the title page; |
-| | | added an “attCopyrightNotice” definition at the top|
+| | | added an "attCopyrightNotice" definition at the top|
| | | of the commonEventFormat\_Vendors.json file; also |
| | | removed all references to internalHeaderFields from|
| | | this file and from the VendorEventListener spec. |
@@ -5262,7 +5230,7 @@ Contents.
| | | removed the following statement near the end of |
| | | the schema file: |
| | | |
-| | | “required”: [ “event” ] |
+| | | "required": [ "event" ] |
| | | |
| | | - Fixed the characters used in some of the quotes |
| | | |
@@ -5516,7 +5484,7 @@ Contents.
| | | removed the following statement near the end of |
| | | the schema file: |
| | | |
-| | | “required”: [ “event” ] |
+| | | "required": [ "event" ] |
| | | |
| | | - Fixed the characters used in some of the quotes |
| | | |
@@ -5659,10 +5627,10 @@ Contents.
| | | - ‘Voice Quality’ Domain Datatypes |
| | | |
| | | - Section 6.1.3: Commands Toward Event Source |
-| | | Clients: Added a statement: “Note: Vendors are not |
+| | | Clients: Added a statement: "Note: Vendors are not |
| | | currently required to implement support for command|
| | | processing; in addition, command processing may be |
-| | | supported by an App-C interface in future.” |
+| | | supported by an App-C interface in future." |
+-----------+---------+-------------------------------------------------------+
| 6/22/2017 | v5.3 | - JSON Schema: created v28.3 by correcting an error |
| | | in the sipSignalingFields: changed |
@@ -5681,8 +5649,8 @@ Contents.
| | | addition to just events. |
| | | |
| | | - Moved the schema title to the top of the schema |
-| | | and changed the text from “Event Listener” to |
-| | | “VES Event Listener” |
+| | | and changed the text from "Event Listener" to |
+| | | "VES Event Listener" |
| | | |
| | | - Added a schema header block under the title to |
| | | clearly communicate the schema version, |
@@ -5742,10 +5710,10 @@ Contents.
| | | |
| | | - 4.1.1: Common Event Datatypes: |
| | | |
-| | | - removed "field" and added “hashMap” |
+| | | - removed "field" and added "hashMap" |
| | | |
-| | | - removed “namedArrayOfFields” and added |
-| | | “namedHashMap” |
+| | | - removed "namedArrayOfFields" and added |
+| | | "namedHashMap" |
| | | |
| | | - added arrayOfNamedHashMap |
| | | |
@@ -6017,7 +5985,7 @@ Contents.
| | | |
| | | - Section 4 embedded schema changed to v30: |
| | | |
-| | | - Added “ ‘additionalProperties’: false ” to |
+| | | - Added " ‘additionalProperties’: false " to |
| | | objects to reject events that attempt to send |
| | | properties that are not listed in the |
| | | ‘properties’ keyword. Note: does not affect |
@@ -6197,6 +6165,35 @@ Contents.
| | | - Changed the location of the doc to VNF |
| | | Requirements and changed the formatting |
+-----------+---------+-------------------------------------------------------+
+| 1/28/202 | v7.1.1 | - Changed event sizes from 2Mb to 1Mb |
+| | | - Configuration Requirement comments addressed |
+| | | - Changed DCAE Collector to VES Event Listener |
+| | | - Replaced VNF with NF where appropriate |
+| | | - Updated publishAnyEvent and publishBatchEvent to |
+| | | clarify both one way and mutual TLS are supported |
+| | | - Changed authorization for publishEventBatch |
+| | | because certification authorization is also |
+| | | supported |
+| | | - Updated fault use case in EventId Use Case |
+| | | Examples based on Ericsson feedback |
+| | | - Added new Configuration Requirements section |
+| | | - Added new Event Domain Requirements section |
+| | | - Updated security requirements based on agreements |
+| | | in ONAP Security Committee with details on 2-way |
+| | | certificate support |
+| | | - Provided clarifications on event buffering |
+| | | - Added Event Handling Requirements for |
+| | | publishEventFlow |
+| | | - Updated Field Block Versions to support existing |
+| | | clients of major version 7 |
+| | | - Updated sample request and response schemas |
+| | | - Updated embedded schema as follows: |
+| | | |
+| | | * Changed schema version to 30.1.1 |
+| | | * Changed measValues to measValuesList and similar |
+| | | changes throughout |
+| | | * Changed iMeasTypesList to sMeasTypesList |
++-----------+---------+-------------------------------------------------------+
.. _time_zone_abbreviations: https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations
.. _Common_definitions: 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