Newer
Older
title: SOL003 - VNF Fault Management interface
SOL003 - VNF Fault Management interface
IMPORTANT: Please note that this file might be not aligned to the current
version of the ETSI Group Specification it refers to. In case of
discrepancies the published ETSI Group Specification takes precedence.
Giacomo Bernini
committed
Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
version: "1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
Michele Carignani
committed
externalDocs:
description: ETSI GS NFV-SOL 003 V3.5.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.05.01_60/gs_NFV-SOL003v030501p.pdf
Michele Carignani
committed
servers:
- url: http://127.0.0.1/vnffm/v1
- url: https://127.0.0.1/vnffm/v1
Giacomo Bernini
committed
###############################################################################
# API Versions #
###############################################################################
/api_versions:
$ref: ../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions
###############################################################################
# Alarms #
###############################################################################
The API consumer can use this method to retrieve information about the alarm list. See clause 7.4.2.3.2.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker
$ref: '#/components/responses/Alarms.Get.200'
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504
###############################################################################
# Individual alarm #
###############################################################################
- $ref: '#/components/parameters/AlarmId'
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
The API consumer can use this method to read an individual alarm. See clause 7.4.3.3.2.
$ref: '#/components/responses/IndividualAlarm.Get.200'
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
404:
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
422:
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
504:
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504
This method modifies an "Individual alarm" resource. See clause 7.4.3.3.4.
requestBody:
$ref: '#/components/requestBodies/IndividualAlarmRequest'
$ref: '#/components/responses/IndividualAlarm.Patch.200'
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
404:
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
# description: |
# 409 CONFLICT
#
# Shall be returned upon the following error: The operation cannot be executed currently,
# due to a conflict with the state of the "Individual alarm" resource.
# Typically, this is due to the fact that the alarm is already in the state that is
# requested to be set (such as trying to acknowledge an already-acknowledged alarm).
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/412
422:
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
504:
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504
###############################################################################
# Subscriptions #
###############################################################################
parameters:
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
The POST method creates a new subscription. See clause 7.4.4.3.1.
requestBody:
$ref: '#/components/requestBodies/FmSubscriptionRequest'
$ref: '#/components/responses/Subscriptions.Post.200'
# description: |
# 303 SEE OTHER
#
# Shall be returned when a subscription with the
# same callback URI and the same filter already exists
# and the policy of the VNFM is to not create
# redundant subscriptions.
# The HTTP response shall include a "Location"
# HTTP header that contains the resource URI of the
# existing "Individual subscription" resource.
# The response body shall be empty.
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/303
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
404:
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
422:
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
504:
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504
The API consumer can use this method to retrieve the list of active subscriptions for VNF alarms subscribed
by the API consumer. It can be used e.g. for resynchronization after error situations. See clause 7.4.4.3.2.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker
$ref: '#/components/responses/Subscriptions.Get.200'
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
404:
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
422:
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
504:
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504
###############################################################################
# Individual subscription #
###############################################################################
- $ref: '#/components/parameters/SubscriptionId'
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
The API consumer can use this method for reading an individual subscription for VNF
alarms subscribed by the API consumer. See clause 7.4.5.3.2.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType
$ref: '#/components/responses/IndividualSubscription.Get.200'
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
404:
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
422:
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
504:
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504
This method terminates an individual subscription. See clause 7.4.5.3.5.
$ref: '#/components/responses/IndividualSubscription.Delete.204'
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
404:
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
422:
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
504:
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
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504
components:
parameters:
AlarmId:
name: alarmId
in: path
description: |
Identifier of the alarm.
This identifier can be retrieved from the "id" attribute of the "alarm" attribute in the AlarmNotification or
AlarmClearedNotification. It can also be retrieved from the "id" attribute of the applicable array element in
the payload body of the response to a GET request to the "Alarms" resource.
required: true
style: simple
explode: false
schema:
type: string
SubscriptionId:
name: subscriptionId
in: path
description: |
Identifier of this subscription.
This identifier can be retrieved from the resource referenced by the
"Location" HTTP header in the response to a POST request creating a
new "Individual subscription" resource. It can also be retrieved from the "id"
attribute in the payload body of that response.
required: true
style: simple
explode: false
schema:
type: string
requestBodies:
IndividualAlarmRequest:
description: The VNF creation parameters
content:
application/json:
schema:
$ref: ../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmModifications
required: true
FmSubscriptionRequest:
description: The VNF creation parameters
content:
application/json:
schema:
$ref: ../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FmSubscriptionRequest
required: true
responses:
Alarms.Get.200:
description: |
200 OK
Shall be returned when information about zero or more alarms has been queried successfully.
The response body shall contain in an array the representations of zero or more alarms as
defined in clause 7.5.2.4.
If the "filter" URI parameter was supplied in the request, the data in the response body
shall have been transformed according to the rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013.
If the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013
for this resource, inclusion of the Link HTTP header in this response shall follow the provisions
in clause 5.4.2.3 of ETSI GS NFV-SOL 013.
headers:
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Link:
description: |
Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
style: simple
explode: false
schema:
type: string
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "./definitions/SOL003VNFFaultManagement_def.yaml#/definitions/Alarm"
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
IndividualAlarm.Get.200:
description: |
200 OK
Shall be returned when information about an individual alarm has been read successfully.
The response body shall contain a representation of the individual alarm
headers:
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "./definitions/SOL003VNFFaultManagement_def.yaml#/definitions/Alarm"
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
448
449
450
451
452
453
454
455
456
IndividualAlarm.Patch.200:
description: |
200 OK
Shall be returned when the request has been accepted and completed.
The response body shall contain attribute modifications for an "Individual alarm"
resource (see clause 7.5.2.4).
headers:
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmModifications"
Subscriptions.Get.200:
description: |
200 OK
Samir Medjiah
committed
Shall be returned when the list of subscriptions has been queried successfully.
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
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
The response body shall contain in an array the representations of all active subscriptions
of the functional block that invokes the method, i.e. zero or more representations of
FM subscriptions as defined in clause 7.5.2.3.
If the "filter" URI parameter was supplied in the request, the data in the response body shall
have been transformed according to the rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013.
If the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013
for this resource, inclusion of the Link HTTP header in this response shall follow the provisions
in clause 5.4.2.3 of ETSI GS NFV-SOL 013.
headers:
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Link:
description: |
Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
style: simple
explode: false
schema:
type: string
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FmSubscription"
Subscriptions.Post.200:
description: |
201 CREATED
Shall be returned when the subscription has been created successfully.
The response body shall contain a representation of the created "Individual subscription" resource.
The HTTP response shall include a "Location:"" HTTP header that points to the created
"Individual subscription" resource.
headers:
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
Location:
description: |
The resource URI of the created subscription resource.
style: simple
explode: false
schema:
type: string
format: url
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FmSubscription"
IndividualSubscription.Get.200:
description: |
200 OK
The operation has completed successfully.
The response body shall contain a representation of the
subscription resource.
headers:
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FmSubscription"
IndividualSubscription.Delete.204:
description: |
204 NO CONTENT
Shall be returned when the "Individual subscription" resource has been deleted successfully.
The response body shall be empty.
headers:
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
content: {}