Newer
Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
components:
schemas:
Link:
description: >
This type represents a link to a resource using an absolute URI.
type: object
required:
- href
properties:
href:
description: >
URI of another resource referenced from a resource.
Shall be an absolute URI (i.e. a UTI that contains {apiRoot}).
$ref: "#/components/schemas/Uri"
NotificationLink:
description: >
This type represents a link to a resource in a notification, using an absolute or relative URI.
type: object
required:
- href
properties:
href:
description: >
URI of a resource referenced from a notification.
Should be an absolute URI (i.e. a URI that contains
{apiRoot}), however, may be a relative URI (i.e. a URI
where the {apiRoot} part is omitted) if the {apiRoot}
information is not available.
$ref: "#/components/schemas/Uri"
IpAddress:
description: >
An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal
integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that
consists of groups of zero to four hexadecimal digits, separated by colons.
type: string
format: IP
KeyValuePairs:
description: >
This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON,
a set of keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4
of IETF RFC 8259. In the following example, a list of key-value pairs with four keys ("aString", "aNumber",
"anArray" and "anObject") is provided to illustrate that the values associated with different keys can be of
different type.
type: object
ApiVersionInformation:
description: >
This type represents API version information.
type: object
required:
- uriPrefix
- apiVersions
properties:
uriPrefix:
description: >
Specifies the URI prefix for the API, in the following
form {apiRoot}/{apiName}/{apiMajorVersion}/.
type: string
apiVersions:
description: >
Version(s) supported for the API signaled by the
uriPrefix attribute.
type: array
items:
type: object
required:
- version
properties:
version:
description: >
Identifies a supported version. The value of the
version attribute shall be a version identifier as
specified in clause 9.1 (SOL013).
type: string
isDeprecated:
description: >
If such information is available, this attribute indicates
whether use of the version signaled by the version
attribute is deprecated (true) or not (false).
A deprecated version is still supported by the API producer but is recommended
not to be used any longer.
When a version is no longer supported, it does not appear in the response body.
type: boolean
retirementDate:
description: >
The date and time after which the API version will no
longer be supported.
This attribute may be included if the value of the
isDeprecated attribute is set to true and shall be
absent otherwise.
$ref: "#/components/schemas/DateTime"
Identifier:
description: >
An identifier with the intention of being globally unique.
type: string
IdentifierInManoEntity:
description: >
An identifier that is unique for the respective type within a NFV-MANO functional entity,
but that need not be globally unique. Representation: string of variable length..
type: string
IdentifierLocal:
description: >
An identifier that is unique within a limited local scope other than above listed identifiers,
such as within a complex data structure or within a request-response pair.
Representation: string of variable length.
type: string
DateTime:
description: >
Date-time stamp.
Representation: String formatted according to IETF RFC 3339.
type: string
format: date-time
Uri:
description: >
String formatted according to IETF RFC 3986.
type: string
Boolean:
description: >
The Boolean is a data type having two values (true and false).
type: boolean
Version:
description: >
A version.
type: string
String:
description: >
A string defined in IETF RFC 8259.
type: string
Number:
description: >
A number defined in IETF RFC 8259.
type: number
UnsignedInt:
description: >
Unsigned integer
type: number
ManoManagedObjectReference:
description: >
This type represents the identifier to reference a managed object of a
particular type.
type: object
properties:
type:
description: >
Indicates the type of managed object.
Permitted values:
- MANO_ENTITY
- MANO_SERVICE
- MANO_SERVICE_IF
- CONSUMED_MANO_IF
- MANO_ENTITY_COMPONENT
The "MANO_ENTITY COMPONENT" is only applicable if attribute
"manoEntityComponents" in "ManoEntity" is supported by the API producer.
type: string
enum:
- MANO_ENTITY
- MANO_SERVICE
- MANO_SERVICE_IF
- CONSUMED_MANO_IF
- MANO_ENTITY_COMPONENT
objectId:
description: >
Identifier of the managed object.
- If type="MANO_ENTITY", it corresponds to the value of the attribute "id"
of the "ManoEntity" representing an NFV-MANO functional entity.
- If type="MANO_SERVICE", it corresponds to the value of the attribute "id"
of the "ManoEntity" representing the NFV-MANO functional entity that contains
the "ManoService" sub-object.
- If type="MANO_SERVICE_IF", it corresponds to the value of the attribute "id"
of the "ManoServiceInterface" representing the NFV-MANO functional entity that
contains the "ManoServiceInterface" sub-object.
- If type="CONSUMED_MANO_IF", the value corresponds to the value of the attribute
"id" of the "ConsumedManoInterfaceInfo" representing a consumed NFV-MANO service
interface from a peer functional entity.
- If type="MANO_ENTITY_COMPONENT", the value corresponds to the value of
the attribute "id" of the "ManoEntity" representing the NFV-MANO functional
entity that contains the "ManoEntityComponent" sub-object.
The "MANO_ENTITY COMPONENT" is only applicable if attribute
"manoEntityComponents" in "ManoEntity" is supported by the API producer.
$ref: "#/components/schemas/Identifier"
subObjectId:
description: >
Identifier of the managed sub-object. It shall be present if type equals to
"MANO_SERVICE" or "MANO_SERVICE_IF" or "MANO_ENTITY_COMPONENT".
- If type="MANO_SERVICE", it corresponds to the value of the attribute "id"
of the "ManoService" representing an individual NFV-MANO service.
- If type="MANO_SERVICE_IF", it corresponds to the value of the attribute "id"
of the "ManoServiceInterface" representing an individual NFV-MANO service
interface.
- If type="MANO_ENTITY_COMPONENT", it corresponds to the value of the attribute
"id" of the "ManoEntityComponent" representing an NFV-MANO functional entity
component.
The "MANO_ENTITY COMPONENT" is only applicable if attribute
"manoEntityComponents" in "ManoEntity" is supported by the API producer.
$ref: "#/components/schemas/IdentifierInManoEntity"
required:
- type
- objectId
SubscriptionAuthentication:
type: object
required:
- authType
properties:
authType:
description: >
Defines the types of Authentication / Authorization which the API
consumer is willing to accept when receiving a notification.
Permitted values:
* BASIC: In every HTTP request to the notification endpoint, use
HTTP Basic authentication with the client credentials.
* OAUTH2_CLIENT_CREDENTIALS: In every HTTP request to the
notification endpoint, use an OAuth 2.0 Bearer token, obtained
using the client credentials grant type.
* TLS_CERT: Every HTTP request to the notification endpoint is sent
over a mutually authenticated TLS session, i.e. not only the
server is authenticated, but also the client is authenticated
during the TLS tunnel setup.
type: array
items:
type: string
enum:
- BASIC
- OAUTH2_CLIENT_CREDENTIALS
- TLS_CERT
paramsBasic:
description: >
Parameters for authentication/authorization using BASIC.
Shall be present if authType is "BASIC" and the contained
information has not been provisioned out of band.
Shall be absent otherwise.
type: object
properties:
userName:
description: >
Username to be used in HTTP Basic authentication. Shall be
present if it has not been provisioned out of band.
type: string
password:
description: >
Password to be used in HTTP Basic authentication. Shall be
present if it has not been provisioned out of band.
type: string
paramsOauth2ClientCredentials:
description: >
Parameters for authentication/authorization using
OAUTH2_CLIENT_CREDENTIALS.
Shall be present if authType is "OAUTH2_CLIENT_CREDENTIALS" and the
contained information has not been provisioned out of band.
Shall be absent otherwise.
type: object
properties:
clientId:
description: >
Client identifier to be used in the access token request of the
OAuth 2.0 client credentials grant type.
Shall be present if it has not been provisioned out of band.
The clientId and clientPassword passed in a subscription shall
not be the same as the clientId and clientPassword that are used
to obtain authorization for API requests. Client credentials may
differ between subscriptions. The value of clientPassword should
be generated by a random process.
type: string
clientPassword:
description: >
Client password to be used in the access token request of the
OAuth 2.0 client credentials grant type.
Shall be present if it has not been provisioned out of band.
The clientId and clientPassword passed in a subscription shall
not be the same as the clientId and clientPassword that are used
to obtain authorization for API requests. Client credentials may
differ between subscriptions. The value of clientPassword should
be generated by a random process.
type: string
tokenEndpoint:
description: >
The token endpoint from which the access token can be obtained.
Shall be present if it has not been provisioned out of band.
$ref: "#/components/schemas/Uri"
ManoEntitySubscriptionFilter:
description: >
This type represents subscription filter criteria to match NFV-MANO functional
entities and their associated managed objects.
type: object
properties:
manoEntityId:
description: >
If present, match the NFV-MANO functional entity with an
instance identifier listed in this attribute.
$ref: "#/components/schemas/Identifier"
manoServiceIds:
description: >
manoServiceIds IdentifierInManoEntity 0..N If present, match NFV-MANO
services with an instance identifier listed in this attribute.
The attributes "manoServiceIds" and "manoServiceNames" are alternatives
to reference to NFV-MANO services in a filter. They should not be used
together in the same filter instance, but one alternative should be chosen.
type: array
items:
$ref: "#/components/schemas/IdentifierInManoEntity"
manoServiceNames:
description: >
If present, match NFV-MANO services with an NFV-MANO service name listed
in this attribute.
The attributes "manoServiceIds" and "manoServiceNames" are alternatives
to reference to NFV-MANO services in a filter. They should not be used
together in the same filter instance, but one alternative should be chosen.
type: array
items:
type: string
manoServiceInterfaceIds:
description: >
If present, match NFV-MANO functional entity produced interfaces with an
instance identifier listed in this attribute.
The attributes "manoServiceInterfaceIds" and "manoServiceInterfaceNames"
are alternatives to reference to NFV-MANO functional entity produced
interfaces in a filter. They should not be used both in the same filter
instance, but one alternative should be chosen.
type: array
items:
$ref: "#/components/schemas/IdentifierInManoEntity"
manoServiceInterfaceNames:
description: >
If present, match NFV-MANO functional entity produced interfaces with an
instance Name listed in this attribute.
The attributes "manoServiceInterfaceIds" and "manoServiceInterfaceNames"
are alternatives to reference to NFV-MANO functional entity produced
interfaces in a filter. They should not be used both in the same filter
instance, but one alternative should be chosen.
type: array
items:
type: string
consumedManoInterfaceIds:
description: >
If present, match NFV-MANO functional entity consumed interfaces with an
instance identifier listed in this attribute.
The attributes "consumedManoInterfaceIds" and "consumedManoInterfaceNames"
are alternatives to reference to NFV-MANO functional entity consumed
interfaces in a filter. They should not be used both in the same filter
instance, but one alternative should be chosen.
type: array
items:
$ref: "#/components/schemas/Identifier"
consumedManoInterfaceNames:
description: >
If present, match NFV-MANO functional entity consumed interfaces with an
instance Name listed in this attribute.
The attributes "consumedManoInterfaceIds" and "consumedManoInterfaceNames"
are alternatives to reference to NFV-MANO functional entity consumed
interfaces in a filter. They should not be used both in the same filter
instance, but one alternative should be chosen.
type: array
items:
type: string
CrossingDirectionType:
description: >
CrossingDirectionType enumeration.
Permited values:
- UP: The threshold was crossed in upward direction.
- DOWN : The threshold was crossed in downward direction.
type: string
enum:
- UP
- DOWN
ProblemDetails:
description: >
The definition of the general "ProblemDetails" data structure from
IETF RFC 7807 [19] is reproduced inthis structure. Compared to the
general framework defined in IETF RFC 7807 [19], the "status" and
"detail" attributes are mandated to be included by the present document,
to ensure that the response contains additional textual information about
an error. IETF RFC 7807 [19] foresees extensibility of the
"ProblemDetails" type. It is possible that particular APIs in the present
document, or particular implementations, define extensions to define
additional attributes that provide more information about the error.
The description column only provides some explanation of the meaning to
Facilitate understanding of the design. For a full description, see
IETF RFC 7807 [19].
type: object
required:
- status
- detail
properties:
type:
description: >
A URI reference according to IETF RFC 3986 [5] that identifies the
problem type. It is encouraged that the URI provides human-readable
documentation for the problem (e.g. using HTML) when dereferenced.
When this member is not present, its value is assumed to be
"about:blank".
type: string
format: URI
title:
description: >
A short, human-readable summary of the problem type. It should not
change from occurrence to occurrence of the problem, except for
purposes of localization. If type is given and other than
"about:blank", this attribute shall also be provided.
A short, human-readable summary of the problem
type. It SHOULD NOT change from occurrence to occurrence of the
problem, except for purposes of localization (e.g., using
proactive content negotiation; see [RFC7231], Section 3.4).
type: string
status:
description: >
The HTTP status code for this occurrence of the problem.
The HTTP status code ([RFC7231], Section 6) generated by the origin
server for this occurrence of the problem.
type: integer
detail:
description: >
A human-readable explanation specific to this occurrence of the
problem.
type: string
instance:
description: >
A URI reference that identifies the specific occurrence of the
problem. It may yield further information if dereferenced.
type: string
format: URI
#TODO: How to express "any additional attributes"?
Alarm:
description: >
The alarm data type encapsulates information about an alarm.
type: object
required:
- id
- managedObjectId
- alarmRaisedTime
- ackState
- perceivedSeverity
- eventTime
- eventType
- probableCause
- isRootCause
- _links
properties:
id:
description: >
Identifier of this Alarm information element.
$ref: "#/components/schemas/Identifier"
managedObjectId:
description: >
Identifier of the affected NFV-MANO instance.
$ref: "#/components/schemas/Identifier"
associatedFaultyInstanceId:
description: >
The resources that are causing the fault.
$ref: "#/components/schemas/ManoManagedObjectReference"
alarmRaisedTime:
description: >
Time stamp indicating when the alarm is raised by the managed
object.
$ref: "#/components/schemas/DateTime"
alarmChangedTime:
description: >
Time stamp indicating when the alarm was last changed. It shall be
present if the alarm has been updated.
$ref: "#/components/schemas/DateTime"
alarmClearedTime:
description: >
Time stamp indicating when the alarm was cleared. It shall be
present if the alarm has been cleared.
$ref: "#/components/schemas/DateTime"
ackState:
description: >
Acknowledgement state of the alarm.
Permitted values:
* UNACKNOWLEDGED
* ACKNOWLEDGED.
type: string
enum:
- UNACKNOWLEDGED
- ACKNOWLEDGED
perceivedSeverity:
description: >
Perceived severity of the managed object failure.
$ref: "#/components/schemas/PerceivedSeverityType"
eventTime:
description: >
Time stamp indicating when the fault was observed.
$ref: "#/components/schemas/DateTime"
eventType:
description: >
Type of event.
$ref: "#/components/schemas/EventType"
faultType:
description: >
Additional information to clarify the type of the fault.
type: string
probableCause:
description: >
Information about the probable cause of the fault.
type: string
isRootCause:
description: >
Attribute indicating if this fault is the root for other correlated
alarms. If true, then the alarms listed in the attribute
CorrelatedAlarmId are caused by this fault.
type: boolean
correlatedAlarmIds:
description: >
List of identifiers of other alarms correlated to this fault.
type: array
items:
$ref: "#/components/schemas/Identifier"
faultDetails:
description: >
Provides additional information about the fault.
type: array
items:
type: string
_links:
description: >
Links for this resource.
type: object
required:
- self
properties:
self:
description: >
URI of this resource.
$ref: "#/components/schemas/Link"
objectInstance:
description: >
Link to the resource representing the VNF instance to which the
notified alarm is correlated. Shall be present if the VNF
instance information is accessible as a resource.
$ref: "#/components/schemas/Link"
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
EventType:
description: >
The enumeration EventType represents those types of events that trigger
an alarm.
* COMMUNICATIONS_ALARM: An alarm of this type is associated with the
procedure and/or process required conveying information from one point
to another (ITU-T Recommendation X.733).
* PROCESSING_ERROR_ALARM: An alarm of this type is associated with a
software or processing fault (ITU-T Recommendation X.733).
* ENVIRONMENTAL_ALARM: An alarm of this type is associated with a
condition related to an enclosure in which the equipment resides
(ITU-T Recommendation X.733).
* QOS_ALARM: An alarm of this type is associated with degradation in the
quality of a service (ITU-T Recommendation X.733).
* EQUIPMENT_ALARM: An alarm of this type is associated with an equipment
fault (ITU-T Recommendation X.733).
type: string
enum:
- COMMUNICATIONS_ALARM
- PROCESSING_ERROR_ALARM
- ENVIRONMENTAL_ALARM
- QOS_ALARM
- EQUIPMENT_ALARM
PerceivedSeverityType:
description: >
Indicates the relative level of urgency for operator attention.
* CRITICAL: The Critical severity level indicates that a service
affecting condition has occurred and an immediate corrective action
is required. Such a severity can be reported, for example, when a
managed object becomes totally out of service and its capability needs
to be restored (ITU-T Recommendation X.733).
* MAJOR: The Major severity level indicates that a service affecting
condition has developed and an urgent corrective action is required.
Such a severity can be reported, for example, when there is a severe
degradation in the capability of the managed object and its full
capability needs to be restored (ITU-T Recommendation X.733).
* MINOR: The Minor severity level indicates the existence of a
non-service affecting fault condition and that corrective action
should be taken in order to prevent a more serious (for example,
service affecting) fault. Such a severity can be reported, for
example, when the detected alarm condition is not currently degrading
the capacity of the managed object (ITU-T Recommendation X.733).
* WARNING: The Warning severity level indicates the detection of a
potential or impending service affecting fault, before any significant
effects have been felt. Action should be taken to further diagnose (if
necessary) and correct the problem in order to prevent it from
becoming a more serious service affecting fault (ITU-T Recommendation
X.733).
* INDETERMINATE: The Indeterminate severity level indicates that the
severity level cannot be determined (ITU-T Recommendation X.733).
* CLEARED: The Cleared severity level indicates the clearing of one or
more previously reported alarms. This alarm clears all alarms for this
managed object that have the same Alarm type, Probable cause and
Specific problems (if given) (ITU-T Recommendation X.733).
type: string
enum:
- CRITICAL
- MAJOR
- MINOR
- WARNING
- INDETERMINATE
- CLEARED