Newer
Older
15001
15002
15003
15004
15005
15006
15007
15008
15009
15010
15011
15012
15013
15014
15015
15016
15017
15018
15019
15020
15021
15022
15023
15024
15025
15026
15027
15028
15029
15030
15031
15032
15033
15034
15035
15036
15037
15038
15039
15040
15041
15042
15043
15044
15045
15046
15047
15048
15049
15050
15051
15052
15053
15054
15055
15056
15057
15058
15059
15060
15061
15062
15063
15064
15065
15066
15067
15068
15069
15070
15071
15072
15073
15074
15075
15076
15077
15078
15079
15080
15081
15082
15083
15084
15085
15086
15087
15088
15089
15090
15091
15092
15093
15094
15095
15096
15097
15098
15099
15100
15101
15102
15103
15104
15105
15106
15107
15108
15109
15110
15111
15112
15113
15114
15115
15116
15117
15118
15119
15120
15121
15122
15123
15124
15125
15126
15127
15128
15129
15130
15131
15132
15133
15134
15135
15136
15137
15138
15139
15140
15141
15142
15143
15144
15145
15146
15147
15148
15149
15150
15151
15152
15153
15154
15155
15156
15157
15158
15159
15160
15161
15162
15163
15164
15165
15166
15167
15168
15169
15170
15171
15172
15173
15174
15175
15176
15177
15178
15179
15180
15181
15182
15183
15184
15185
15186
15187
15188
15189
15190
15191
15192
15193
15194
15195
15196
15197
15198
15199
15200
15201
15202
15203
15204
15205
15206
15207
15208
15209
15210
15211
15212
15213
15214
15215
15216
15217
15218
15219
15220
15221
15222
15223
15224
15225
15226
15227
15228
15229
15230
15231
15232
15233
15234
15235
15236
15237
15238
15239
15240
15241
15242
15243
15244
15245
15246
15247
15248
15249
15250
15251
15252
15253
15254
15255
15256
15257
15258
15259
15260
15261
15262
15263
15264
15265
15266
15267
15268
15269
15270
15271
15272
15273
15274
15275
15276
15277
15278
15279
15280
15281
15282
15283
15284
15285
15286
15287
15288
15289
15290
15291
15292
15293
15294
15295
15296
15297
15298
15299
15300
15301
15302
15303
15304
15305
15306
15307
15308
15309
15310
15311
15312
15313
15314
15315
15316
15317
15318
15319
15320
15321
15322
15323
15324
15325
15326
15327
15328
15329
15330
15331
15332
15333
15334
15335
15336
15337
15338
15339
15340
15341
15342
15343
15344
15345
15346
15347
15348
15349
15350
15351
15352
15353
15354
15355
15356
15357
15358
15359
15360
15361
15362
15363
15364
15365
15366
15367
15368
15369
15370
15371
15372
15373
15374
15375
15376
15377
15378
15379
15380
15381
15382
15383
15384
15385
15386
15387
15388
15389
15390
15391
15392
15393
15394
15395
15396
15397
15398
15399
15400
15401
15402
15403
15404
15405
15406
15407
15408
15409
15410
15411
15412
15413
15414
15415
15416
15417
15418
15419
15420
15421
15422
15423
15424
15425
15426
15427
15428
15429
15430
15431
15432
15433
15434
15435
15436
15437
15438
15439
15440
15441
15442
15443
15444
15445
15446
15447
15448
15449
15450
15451
15452
15453
15454
15455
15456
15457
15458
15459
15460
15461
15462
15463
15464
15465
15466
15467
15468
15469
15470
15471
15472
15473
15474
15475
15476
15477
15478
15479
15480
15481
15482
15483
15484
15485
15486
15487
15488
15489
15490
15491
15492
15493
15494
15495
15496
15497
15498
15499
15500
15501
15502
15503
15504
15505
15506
15507
15508
15509
15510
15511
15512
15513
15514
15515
15516
15517
15518
15519
15520
15521
15522
15523
15524
15525
15526
15527
15528
15529
15530
15531
15532
15533
15534
15535
15536
15537
15538
15539
15540
15541
15542
15543
15544
15545
15546
15547
15548
15549
15550
15551
15552
15553
15554
15555
15556
15557
15558
15559
15560
15561
15562
15563
15564
15565
15566
15567
15568
15569
15570
15571
15572
15573
15574
15575
15576
15577
15578
15579
15580
15581
15582
15583
15584
15585
15586
15587
15588
15589
15590
15591
15592
15593
15594
15595
15596
15597
15598
15599
15600
15601
15602
15603
15604
15605
15606
15607
15608
15609
15610
15611
15612
15613
15614
15615
15616
15617
15618
15619
15620
15621
15622
15623
15624
15625
15626
15627
15628
15629
15630
15631
15632
15633
15634
15635
15636
15637
15638
15639
15640
15641
15642
15643
15644
15645
15646
15647
15648
15649
15650
15651
15652
15653
15654
15655
15656
15657
15658
15659
15660
15661
15662
15663
15664
15665
15666
15667
15668
15669
15670
15671
15672
15673
15674
15675
15676
15677
15678
15679
15680
15681
15682
15683
15684
15685
15686
15687
15688
15689
15690
15691
15692
15693
15694
15695
15696
15697
15698
15699
15700
15701
15702
15703
15704
15705
15706
15707
15708
15709
15710
15711
15712
15713
15714
15715
15716
15717
15718
15719
15720
15721
15722
15723
15724
15725
15726
15727
15728
15729
15730
15731
15732
15733
15734
15735
15736
15737
15738
15739
15740
15741
15742
15743
15744
15745
15746
15747
15748
15749
15750
15751
15752
15753
15754
15755
15756
15757
15758
15759
15760
15761
15762
15763
15764
15765
15766
15767
15768
15769
15770
15771
15772
15773
15774
15775
15776
15777
15778
15779
15780
15781
15782
15783
15784
15785
15786
15787
15788
15789
15790
15791
15792
15793
15794
15795
15796
15797
15798
15799
15800
15801
15802
15803
15804
15805
15806
15807
15808
15809
15810
15811
15812
15813
15814
15815
15816
15817
15818
15819
15820
15821
15822
15823
15824
15825
15826
15827
15828
15829
15830
15831
15832
15833
15834
15835
15836
15837
15838
15839
15840
15841
15842
15843
15844
15845
15846
15847
15848
15849
15850
15851
15852
15853
15854
15855
15856
15857
15858
15859
15860
15861
15862
15863
15864
15865
15866
15867
15868
15869
15870
15871
15872
15873
15874
15875
15876
15877
15878
15879
15880
15881
15882
15883
15884
15885
15886
15887
15888
15889
15890
15891
15892
15893
15894
15895
15896
15897
15898
15899
15900
15901
15902
15903
15904
15905
15906
15907
15908
15909
15910
15911
15912
15913
15914
15915
15916
15917
15918
15919
15920
15921
15922
15923
15924
15925
15926
15927
15928
15929
15930
15931
15932
15933
15934
15935
15936
15937
15938
15939
15940
15941
15942
15943
15944
15945
15946
15947
15948
15949
15950
15951
15952
15953
15954
15955
15956
15957
15958
15959
15960
15961
15962
15963
15964
15965
15966
15967
15968
15969
15970
15971
15972
15973
15974
15975
15976
15977
15978
15979
15980
15981
15982
15983
15984
15985
15986
15987
15988
15989
15990
15991
15992
15993
15994
15995
15996
15997
15998
15999
16000
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
'404':
description: >
Not Found
Error: The API producer did not find a current representation for
the target resource or is not willing to disclose that one exists.
Specifically in case of this task resource, the response code 404
shall also returned if the task is not supported for the VNF
instance represented by the parent resource, which means that the
task resource consequently does not exist. In this case, the
response body shall be present, and shall contain a ProblemDetails
structure, in which the "detail" attribute shall 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
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}/terminate':
parameters:
- name: vnfInstanceId
description: >
The identifier of the VNF instance to be terminated. 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: |
Terminate VNF
The POST method terminates a VNF instance.
parameters:
- name: TerminateVnfRequest
description: Parameters for the VNF termination.
in: body
required: true
schema:
type: object
required:
- terminationType
properties:
terminationType:
description: >
Indicates whether forceful or graceful termination is
requested. Permitted values: * FORCEFUL: The VNFM will shut
down the VNF and release the
resources immediately after accepting the request.
* GRACEFUL: The VNFM will first arrange to take the VNF out of
service after accepting the request. Once the operation of
taking the VNF out of service finishes (irrespective of
whether it has succeeded or failed) or once the timer value
specified in the "gracefulTerminationTimeout" attribute
expires, the VNFM will shut down the VNF and release the
resources.
type: string
enum:
- FORCEFUL
- GRACEFUL
gracefulTerminationTimeout:
description: >
This attribute is only applicable in case of graceful
termination. It defines the time to wait for the VNF to be
taken out of service before shutting down the VNF and
releasing the resources. The unit is seconds. If not given and
the "terminationType" attribute is set to "GRACEFUL", it is
expected that the VNFM waits for the successful taking out of
service of the VNF, no matter how long it takes, before
shutting down the VNF and releasing the resources.
type: integer
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: >