Newer
Older
17001
17002
17003
17004
17005
17006
17007
17008
17009
17010
17011
17012
17013
17014
17015
17016
17017
17018
17019
17020
17021
17022
17023
17024
17025
17026
17027
17028
17029
17030
17031
17032
17033
17034
17035
17036
17037
17038
17039
17040
17041
17042
17043
17044
17045
17046
17047
17048
17049
17050
17051
17052
17053
17054
17055
17056
17057
17058
17059
17060
17061
17062
17063
17064
17065
17066
17067
17068
17069
17070
17071
17072
17073
17074
17075
17076
17077
17078
17079
17080
17081
17082
17083
17084
17085
17086
17087
17088
17089
17090
17091
17092
17093
17094
17095
17096
17097
17098
17099
17100
17101
17102
17103
17104
17105
17106
17107
17108
17109
17110
17111
17112
17113
17114
17115
17116
17117
17118
17119
17120
17121
17122
17123
17124
17125
17126
17127
17128
17129
17130
17131
17132
17133
17134
17135
17136
17137
17138
17139
17140
17141
17142
17143
17144
17145
17146
17147
17148
17149
17150
17151
17152
17153
17154
17155
17156
17157
17158
17159
17160
17161
17162
17163
17164
17165
17166
17167
17168
17169
17170
17171
17172
17173
17174
17175
17176
17177
17178
17179
17180
17181
17182
17183
17184
17185
17186
17187
17188
17189
17190
17191
17192
17193
17194
17195
17196
17197
17198
17199
17200
17201
17202
17203
17204
17205
17206
17207
17208
17209
17210
17211
17212
17213
17214
17215
17216
17217
17218
17219
17220
17221
17222
17223
17224
17225
17226
17227
17228
17229
17230
17231
17232
17233
17234
17235
17236
17237
17238
17239
17240
17241
17242
17243
17244
17245
17246
17247
17248
17249
17250
17251
17252
17253
17254
17255
17256
17257
17258
17259
17260
17261
17262
17263
17264
17265
17266
17267
17268
17269
17270
17271
17272
17273
17274
17275
17276
17277
17278
17279
17280
17281
17282
17283
17284
17285
17286
17287
17288
17289
17290
17291
17292
17293
17294
17295
17296
17297
17298
17299
17300
17301
17302
17303
17304
17305
17306
17307
17308
17309
17310
17311
17312
17313
17314
17315
17316
17317
17318
17319
17320
17321
17322
17323
17324
17325
17326
17327
17328
17329
17330
17331
17332
17333
17334
17335
17336
17337
17338
17339
17340
17341
17342
17343
17344
17345
17346
17347
17348
17349
17350
17351
17352
17353
17354
17355
17356
17357
17358
17359
17360
17361
17362
17363
17364
17365
17366
17367
17368
17369
17370
17371
17372
17373
17374
17375
17376
17377
17378
17379
17380
17381
17382
17383
17384
17385
17386
17387
17388
17389
17390
17391
17392
17393
17394
17395
17396
17397
17398
17399
17400
17401
17402
17403
17404
17405
17406
17407
17408
17409
17410
17411
17412
17413
17414
17415
17416
17417
17418
17419
17420
17421
17422
17423
17424
17425
17426
17427
17428
17429
17430
17431
17432
17433
17434
17435
17436
17437
17438
17439
17440
17441
17442
17443
17444
17445
17446
17447
17448
17449
17450
17451
17452
17453
17454
17455
17456
17457
17458
17459
17460
17461
17462
17463
17464
17465
17466
17467
17468
17469
17470
17471
17472
17473
17474
17475
17476
17477
17478
17479
17480
17481
17482
17483
17484
17485
17486
17487
17488
17489
17490
17491
17492
17493
17494
17495
17496
17497
17498
17499
17500
17501
17502
17503
17504
17505
17506
17507
17508
17509
17510
17511
17512
17513
17514
17515
17516
17517
17518
17519
17520
17521
17522
17523
17524
17525
17526
17527
17528
17529
17530
17531
17532
17533
17534
17535
17536
17537
17538
17539
17540
17541
17542
17543
17544
17545
17546
17547
17548
17549
17550
17551
17552
17553
17554
17555
17556
17557
17558
17559
17560
17561
17562
17563
17564
17565
17566
17567
17568
17569
17570
17571
17572
17573
17574
17575
17576
17577
17578
17579
17580
17581
17582
17583
17584
17585
17586
17587
17588
17589
17590
17591
17592
17593
17594
17595
17596
17597
17598
17599
17600
17601
17602
17603
17604
17605
17606
17607
17608
17609
17610
17611
17612
17613
17614
17615
17616
17617
17618
17619
17620
17621
17622
17623
17624
17625
17626
17627
17628
17629
17630
17631
17632
17633
17634
17635
17636
17637
17638
17639
17640
17641
17642
17643
17644
17645
17646
17647
17648
17649
17650
17651
17652
17653
17654
17655
17656
17657
17658
17659
17660
17661
17662
17663
17664
17665
17666
17667
17668
17669
17670
17671
17672
17673
17674
17675
17676
17677
17678
17679
17680
17681
17682
17683
17684
17685
17686
17687
17688
17689
17690
17691
17692
17693
17694
17695
17696
17697
17698
17699
17700
17701
17702
17703
17704
17705
17706
17707
17708
17709
17710
17711
17712
17713
17714
17715
17716
17717
17718
17719
17720
17721
17722
17723
17724
17725
17726
17727
17728
17729
17730
17731
17732
17733
17734
17735
17736
17737
17738
17739
17740
17741
17742
17743
17744
17745
17746
17747
17748
17749
17750
17751
17752
17753
17754
17755
17756
17757
17758
17759
17760
17761
17762
17763
17764
17765
17766
17767
17768
17769
17770
17771
17772
17773
17774
17775
17776
17777
17778
17779
17780
17781
17782
17783
17784
17785
17786
17787
17788
17789
17790
17791
17792
17793
17794
17795
17796
17797
17798
17799
17800
17801
17802
17803
17804
17805
17806
17807
17808
17809
17810
17811
17812
17813
17814
17815
17816
17817
17818
17819
17820
17821
17822
17823
17824
17825
17826
17827
17828
17829
17830
17831
17832
17833
17834
17835
17836
17837
17838
17839
17840
17841
17842
17843
17844
17845
17846
17847
17848
17849
17850
17851
17852
17853
17854
17855
17856
17857
17858
17859
17860
17861
17862
17863
17864
17865
17866
17867
17868
17869
17870
17871
17872
17873
17874
17875
17876
17877
17878
17879
17880
17881
17882
17883
17884
17885
17886
17887
17888
17889
17890
17891
17892
17893
17894
17895
17896
17897
17898
17899
17900
17901
17902
17903
17904
17905
17906
17907
17908
17909
17910
17911
17912
17913
17914
17915
17916
17917
17918
17919
17920
17921
17922
17923
17924
17925
17926
17927
17928
17929
17930
17931
17932
17933
17934
17935
17936
17937
17938
17939
17940
17941
17942
17943
17944
17945
17946
17947
17948
17949
17950
17951
17952
17953
17954
17955
17956
17957
17958
17959
17960
17961
17962
17963
17964
17965
17966
17967
17968
17969
17970
17971
17972
17973
17974
17975
17976
17977
17978
17979
17980
17981
17982
17983
17984
17985
17986
17987
17988
17989
17990
17991
17992
17993
17994
17995
17996
17997
17998
17999
18000
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
'404':
description: >
Not Found
If the API producer did not find a current representation for the
resource addressed by the URI passed in the request, or is not
willing to disclose that one exists, it shall respond with this
response code. The "ProblemDetails" structure may be provided,
including in the "detail" attribute information about the source of
the problem, e.g. a wrong resource URI variable.
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
schema:
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
'405':
description: >
Not Found
If the API producer did not find a current representation for the
resource addressed by the URI passed in the request, or is not
willing to disclose that one exists, it shall respond with this
response code. The "ProblemDetails" structure may be provided,
including in the "detail" attribute information about the source of
the problem, e.g. a wrong resource URI variable.
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
schema:
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
'406':
description: >
Not Acceptable
If the "Accept" HTTP header does not contain at least one name of a
content type that is acceptable to the API producer, the API
producer shall respond with this response code. The "ProblemDetails"
structure may be omitted in that case.
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
schema:
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
'409':
description: >
Conflict
The operation cannot be executed currently, due to a conflict with
the state of the VNF instance resource. Typically, this is due to
the fact that the VNF instance resource is in NOT-INSTANTIATED
state, or that another lifecycle management operation is ongoing.
The response body shall contain a ProblemDetails structure, in which
the "detail" attribute should convey more information about the
error.
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
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.
type: string
maximum: 1
minimum: 0
schema:
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
'500':
description: >
Internal Server Error
If there is an application error not related to the client's input
that cannot be easily mapped to any other HTTP response code ("catch
all error"), the API producer shall respond withthis response code.
The "ProblemDetails" structure shall be provided, and shall include
in the "detail" attribute more information about the source of the
problem.
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
schema:
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
'503':
description: >
Service Unavailable
If the API producer encounters an internal overload situation of
itself or of a system it relies on, it should respond with this
response code, following the provisions in IETF RFC 7231 [13] for
the use of the "Retry-After" HTTP header and for the alternative to
refuse the connection. The "ProblemDetails" structure may be
omitted.
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
schema:
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
'/vnf_instances/{vnfInstanceId}/heal':
parameters:
- name: vnfInstanceId
description: >
Identifier of the VNF instance to be healed. This identifier can be
retrieved from the resource referenced by the "Location" HTTP header
in the response to a POST request creating a new VNF instance
resource. It can also be retrieved from the "id" attribute in the
payload body of that response.
in: path
type: string
required: true
post:
description: |
Heal VNF
The POST method requests to heal a VNF instance resource.
parameters:
- name: HealVnfRequest
description: Parameters for the Heal VNF operation.
in: body
required: true
schema:
type: object
properties:
cause:
description: |
Indicates the reason why a healing procedure is required.
type: string
additionalParams:
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
key- value pairs is represented as an object. It shall comply
with the provisions defined in clause 4 of IETF RFC 7159.
type: object
- name: Accept
description: >
Content-Types that are acceptable for the response. Reference: IETF
RFC 7231
in: header
required: true
type: string
- name: Authorization
description: |
The authorization token for the request. Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Content-Type
description: |
The MIME type of the body of the request. Reference: IETF RFC 7231
in: header
required: true
type: string
responses:
'202':
description: >
Accepted
The request was accepted for processing, but the processing has not
been completed. On success, the HTTP response shall include a
"Location" HTTP header that contains the URI of the newly-created
"VNF LCM operation occurrence" resource corresponding to the
operation.
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
Location:
description: The resource URI of the created VNF instance
type: string
format: url
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.
type: string
maximum: 1
minimum: 0
schema:
description: |
This type represents a VNF instance.
type: object
required:
- id
- vnfdId
- vnfProvider
- vnfProductName
- vnfSoftwareVersion
- vnfdVersion
- vnfPkgId
- instantiationState
properties:
id:
description: |
An identifier with the intention of being globally unique.
type: string
vnfInstanceName:
description: >
Name of the VNF instance. This attribute can be modified with
the PATCH method.
type: string
vnfInstanceDescription:
description: >
Human-readable description of the VNF instance. This attribute
can be modified with the PATCH method.
type: string
vnfdId:
description: |
An identifier with the intention of being globally unique.
type: string
vnfProvider:
description: >
Provider of the VNF and the VNFD. The value is copied from the
VNFD.
type: string
vnfProductName:
description: >
Name to identify the VNF Product. The value is copied from the
VNFD.
type: string
vnfSoftwareVersion:
description: |
A Version.
type: string
vnfdVersion:
description: |
A Version.
type: string
vnfPkgId:
description: |
An identifier with the intention of being globally unique.
type: string
vnfConfigurableProperties:
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
key- value pairs is represented as an object. It shall comply
with the provisions defined in clause 4 of IETF RFC 7159.
type: object
vimConnectionInfo:
description: >
Information about VIM connections to be used for managing the
resources for the VNF instance. This attribute shall only be
supported and present if VNF-related resource management in
direct mode is applicable. This attribute can be modified with
the PATCH method.
type: array
items:
description: >
This type represents parameters to connect to a VIM for
managing the resources of a VNF instance. This structure is
used to convey VIM-related parameters over the Or-Vnfm
interface. Additional parameters for a VIM may be configured
into the VNFM by means outside the scope of the present
document, and bound to the identifier of that VIM.
type: object
required:
- id
- vimType
properties:
id:
description: >
An identifier with the intention of being globally
unique.
type: string
vimId:
description: >
An identifier with the intention of being globally
unique.
type: string
vimType:
description: >
Discriminator for the different types of the VIM
information. The value of this attribute determines the
structure of the "interfaceInfo" and "accessInfo"
attributes, based on the type of the VIM. The set of
permitted values is expected to change over time as new
types or versions of VIMs become available. The ETSI NFV
registry of VIM-related information provides access to
information about VimConnectionInfo definitions for
various VIM types. The structure of the registry is
defined in Annex C of SOL003.
type: string
interfaceInfo:
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 key- value pairs is represented as an
object. It shall comply with the provisions defined in
clause 4 of IETF RFC 7159.
type: object
accessInfo:
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 key- value pairs is represented as an
object. It shall comply with the provisions defined in
clause 4 of IETF RFC 7159.
type: object
extra:
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 key- value pairs is represented as an
object. It shall comply with the provisions defined in
clause 4 of IETF RFC 7159.
type: object
instantiationState:
description: |
The instantiation state of the VNF.
type: string
enum:
- NOT_INSTANTIATED
- INSTANTIATED
instantiatedVnfInfo:
description: >
Information specific to an instantiated VNF instance. This
attribute shall be present if the instantiateState attribute
value is INSTANTIATED.
type: object
required:
- flavourId
- vnfState
properties:
flavourId:
description: |
An identifier that is unique within a VNF descriptor.
type: string
vnfState:
type: string
enum:
- STARTED
- STOPPED
scaleStatus:
description: >
Scale status of the VNF, one entry per aspect. Represents
for every scaling aspect how "big" the VNF has been scaled
w.r.t. that aspect.
type: array
items:
required:
- aspectId
- scaleLevel
type: object
properties:
aspectId:
description: >
An identifier that is unique within a VNF
descriptor.
type: string
scaleLevel:
description: >
Indicates the scale level. The minimum value shall
be 0 and the maximum value shall be <= maxScaleLevel
as described in the VNFD.
type: integer
extCpInfo:
description: >
Information about the external CPs exposed by the VNF
instance.
type: array
minItems: 1
items:
type: object
required:
- id
- cpdId
properties:
id:
description: >
An identifier that is unique for the respective type
within a VNF instance, but may not be globally
unique.
type: string
cpdId:
description: >
An identifier that is unique within a VNF
descriptor.
type: string
cpProtocolInfo:
description: |
Network protocol information for this CP.
type: array
items:
description: >
This type describes the protocol layer(s) that a
CP uses together with protocol-related
information, like addresses.
required:
- layerProtocol
properties:
layerProtocol:
description: >
The identifier of layer(s) and protocol(s)
associated to the network address
information. Permitted values:
IP_OVER_ETHERNET This attribute allows to
signal the addition of further types of layer
and protocol in future versions of the present
document in a backwards-compatible way. In the
current version of the present document, only
IP over Ethernet is supported.
type: string
enum:
- IP_OVER_ETHERNET
ipOverEthernet:
description: >
This type represents information about a
network address that has been assigned.
type: object
required:
- macAddress
properties:
macAddress:
description: >
A MAC address. Representation: string that
consists of groups of two hexadecimal
digits, separated by hyphens or colons.
type: string
format: MAC
ipAddresses:
description: >
Addresses assigned to the CP instance.
Each entry represents IP addresses
assigned by fixed or dynamic IP address
assignment per subnet.
type: array
items:
type: object
required:
- type
properties:
type:
description: >
The type of the IP addresses. Permitted
values: IPV4, IPV6.
type: string
enum:
- IPV4
- IPV6
addresses:
description: >
Fixed addresses assigned (from the
subnet defined by "subnetId" if
provided).
type: array
items:
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
isDynamic:
description: >
Indicates whether this set of addresses
was assigned dynamically (true) or based
on address information provided as input
from the API consumer (false). Shall be
present if "addresses" is present and
shall be absent otherwise.
type: boolean
addressRange:
description: >
An IP address range used, e.g., in case
of egress connections. Exactly one of
"addresses" or "addressRange" shall be
present.
type: object
required:
- minAddress
- maxAddress
properties:
minAddress:
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
maxAddress:
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
subnetId:
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
extLinkPortId:
description: >
An identifier with the intention of being globally
unique.
type: string
extVirtualLinkInfo:
description: >
Information about the external VLs the VNF instance is
connected to.
type: array
items:
type: object
required:
- id
- resourceHandle
properties:
id:
description: >
An identifier with the intention of being globally
unique.
type: string
resourceHandle:
required:
- vimConnectionId
- resourceId
type: object
description: >
This type represents the information that allows
addressing a virtualised resource that is used by a
VNF instance. Information about the resource is
available from the VIM.
properties:
vimConnectionId:
description: >
An identifier with the intention of being
globally unique.
type: string
resourceProviderId:
description: >
An identifier with the intention of being
globally unique.
type: string
resourceId:
description: >
An identifier maintained by the VIM or other
resource provider. It is expected to be unique
within the VIM instance.
type: string
vimLevelResourceType:
description: >
Type of the resource in the scope of the VIM or
the resource provider.
type: string
extLinkPorts:
description: |
Link ports of this VL.
type: array
items:
description: >
This type represents information about a link port
of an external VL, i.e. a port providing
connectivity for the VNF to an NS VL.
type: object
required:
- id
- resourceHandle
properties:
id:
description: >
An identifier with the intention of being
globally unique.
type: string
resourceHandle:
required:
- vimConnectionId
- resourceId
type: object
description: >
This type represents the information that
allows addressing a virtualised resource that
is used by a VNF instance. Information about
the resource is available from the VIM.
properties:
vimConnectionId:
description: >
An identifier with the intention of being
globally unique.
type: string
resourceProviderId:
description: >
An identifier with the intention of being
globally unique.
type: string
resourceId:
description: >
An identifier maintained by the VIM or
other resource provider. It is expected to
be unique within the VIM instance.
type: string
vimLevelResourceType:
description: >
Type of the resource in the scope of the
VIM or the resource provider.
type: string
cpInstanceId:
description: >
An identifier that is unique for the
respective type within a VNF instance, but may
not be globally unique.
type: string
extManagedVirtualLinkInfo:
description: |
External virtual links the VNF instance is connected to.
type: array
items:
type: object
required:
- id
- vnfVirtualLinkDescId
properties:
id:
description: >
An identifier with the intention of being globally
unique.
type: string
vnfVirtualLinkDescId: