Newer
Older
13001
13002
13003
13004
13005
13006
13007
13008
13009
13010
13011
13012
13013
13014
13015
13016
13017
13018
13019
13020
13021
13022
13023
13024
13025
13026
13027
13028
13029
13030
13031
13032
13033
13034
13035
13036
13037
13038
13039
13040
13041
13042
13043
13044
13045
13046
13047
13048
13049
13050
13051
13052
13053
13054
13055
13056
13057
13058
13059
13060
13061
13062
13063
13064
13065
13066
13067
13068
13069
13070
13071
13072
13073
13074
13075
13076
13077
13078
13079
13080
13081
13082
13083
13084
13085
13086
13087
13088
13089
13090
13091
13092
13093
13094
13095
13096
13097
13098
13099
13100
13101
13102
13103
13104
13105
13106
13107
13108
13109
13110
13111
13112
13113
13114
13115
13116
13117
13118
13119
13120
13121
13122
13123
13124
13125
13126
13127
13128
13129
13130
13131
13132
13133
13134
13135
13136
13137
13138
13139
13140
13141
13142
13143
13144
13145
13146
13147
13148
13149
13150
13151
13152
13153
13154
13155
13156
13157
13158
13159
13160
13161
13162
13163
13164
13165
13166
13167
13168
13169
13170
13171
13172
13173
13174
13175
13176
13177
13178
13179
13180
13181
13182
13183
13184
13185
13186
13187
13188
13189
13190
13191
13192
13193
13194
13195
13196
13197
13198
13199
13200
13201
13202
13203
13204
13205
13206
13207
13208
13209
13210
13211
13212
13213
13214
13215
13216
13217
13218
13219
13220
13221
13222
13223
13224
13225
13226
13227
13228
13229
13230
13231
13232
13233
13234
13235
13236
13237
13238
13239
13240
13241
13242
13243
13244
13245
13246
13247
13248
13249
13250
13251
13252
13253
13254
13255
13256
13257
13258
13259
13260
13261
13262
13263
13264
13265
13266
13267
13268
13269
13270
13271
13272
13273
13274
13275
13276
13277
13278
13279
13280
13281
13282
13283
13284
13285
13286
13287
13288
13289
13290
13291
13292
13293
13294
13295
13296
13297
13298
13299
13300
13301
13302
13303
13304
13305
13306
13307
13308
13309
13310
13311
13312
13313
13314
13315
13316
13317
13318
13319
13320
13321
13322
13323
13324
13325
13326
13327
13328
13329
13330
13331
13332
13333
13334
13335
13336
13337
13338
13339
13340
13341
13342
13343
13344
13345
13346
13347
13348
13349
13350
13351
13352
13353
13354
13355
13356
13357
13358
13359
13360
13361
13362
13363
13364
13365
13366
13367
13368
13369
13370
13371
13372
13373
13374
13375
13376
13377
13378
13379
13380
13381
13382
13383
13384
13385
13386
13387
13388
13389
13390
13391
13392
13393
13394
13395
13396
13397
13398
13399
13400
13401
13402
13403
13404
13405
13406
13407
13408
13409
13410
13411
13412
13413
13414
13415
13416
13417
13418
13419
13420
13421
13422
13423
13424
13425
13426
13427
13428
13429
13430
13431
13432
13433
13434
13435
13436
13437
13438
13439
13440
13441
13442
13443
13444
13445
13446
13447
13448
13449
13450
13451
13452
13453
13454
13455
13456
13457
13458
13459
13460
13461
13462
13463
13464
13465
13466
13467
13468
13469
13470
13471
13472
13473
13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
13553
13554
13555
13556
13557
13558
13559
13560
13561
13562
13563
13564
13565
13566
13567
13568
13569
13570
13571
13572
13573
13574
13575
13576
13577
13578
13579
13580
13581
13582
13583
13584
13585
13586
13587
13588
13589
13590
13591
13592
13593
13594
13595
13596
13597
13598
13599
13600
13601
13602
13603
13604
13605
13606
13607
13608
13609
13610
13611
13612
13613
13614
13615
13616
13617
13618
13619
13620
13621
13622
13623
13624
13625
13626
13627
13628
13629
13630
13631
13632
13633
13634
13635
13636
13637
13638
13639
13640
13641
13642
13643
13644
13645
13646
13647
13648
13649
13650
13651
13652
13653
13654
13655
13656
13657
13658
13659
13660
13661
13662
13663
13664
13665
13666
13667
13668
13669
13670
13671
13672
13673
13674
13675
13676
13677
13678
13679
13680
13681
13682
13683
13684
13685
13686
13687
13688
13689
13690
13691
13692
13693
13694
13695
13696
13697
13698
13699
13700
13701
13702
13703
13704
13705
13706
13707
13708
13709
13710
13711
13712
13713
13714
13715
13716
13717
13718
13719
13720
13721
13722
13723
13724
13725
13726
13727
13728
13729
13730
13731
13732
13733
13734
13735
13736
13737
13738
13739
13740
13741
13742
13743
13744
13745
13746
13747
13748
13749
13750
13751
13752
13753
13754
13755
13756
13757
13758
13759
13760
13761
13762
13763
13764
13765
13766
13767
13768
13769
13770
13771
13772
13773
13774
13775
13776
13777
13778
13779
13780
13781
13782
13783
13784
13785
13786
13787
13788
13789
13790
13791
13792
13793
13794
13795
13796
13797
13798
13799
13800
13801
13802
13803
13804
13805
13806
13807
13808
13809
13810
13811
13812
13813
13814
13815
13816
13817
13818
13819
13820
13821
13822
13823
13824
13825
13826
13827
13828
13829
13830
13831
13832
13833
13834
13835
13836
13837
13838
13839
13840
13841
13842
13843
13844
13845
13846
13847
13848
13849
13850
13851
13852
13853
13854
13855
13856
13857
13858
13859
13860
13861
13862
13863
13864
13865
13866
13867
13868
13869
13870
13871
13872
13873
13874
13875
13876
13877
13878
13879
13880
13881
13882
13883
13884
13885
13886
13887
13888
13889
13890
13891
13892
13893
13894
13895
13896
13897
13898
13899
13900
13901
13902
13903
13904
13905
13906
13907
13908
13909
13910
13911
13912
13913
13914
13915
13916
13917
13918
13919
13920
13921
13922
13923
13924
13925
13926
13927
13928
13929
13930
13931
13932
13933
13934
13935
13936
13937
13938
13939
13940
13941
13942
13943
13944
13945
13946
13947
13948
13949
13950
13951
13952
13953
13954
13955
13956
13957
13958
13959
13960
13961
13962
13963
13964
13965
13966
13967
13968
13969
13970
13971
13972
13973
13974
13975
13976
13977
13978
13979
13980
13981
13982
13983
13984
13985
13986
13987
13988
13989
13990
13991
13992
13993
13994
13995
13996
13997
13998
13999
14000
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}/change_flavour':
parameters:
- name: vnfInstanceId
description: >
The identifier of the VNF instance of which the deployment flavour is
requested to be changed. 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: |
Change VNF Flavour
The POST method changes the deployment flavour of a VNF instance.
parameters:
- name: ChangeVnfFlavourRequest
description: Parameters for the Change VNF Flavour operation.
in: body
required: true
schema:
description: >
This type represents request parameters for the "Change VNF
flavour" operation.
type: object
required:
- newFlavourId
properties:
newFlavourId:
description: |
An identifier that is unique within a VNF descriptor.
type: string
instantiationLevelId:
description: |
An identifier that is unique within a VNF descriptor.
type: string
extVirtualLinks:
description: |
Information about external VLs to connect the VNF to.
type: array
items:
description: |
This type represents an external VL.
type: object
required:
- id
- resourceId
- extCps
properties:
id:
description: >
An identifier with the intention of being globally
unique.
type: string
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
extCps:
description: >
External CPs of the VNF to be connected to this external
VL.
type: array
items:
description: >
This type represents configuration information for
external CPs created from a CPD.
type: object
required:
- cpdId
properties:
cpdId:
description: >
An identifier that is unique within a VNF
descriptor.
type: string
cpConfig:
description: >
List of instance data that need to be configured
on the CP instances created from the respective
CPD.
type: array
items:
description: >
This type represents an externally provided link
port or network address information per instance
of an external connection point. In case a link
port is provided, the VNFM shall use that link
port when connecting the external CP to the
external VL. In a link port is not provided, the
VNFM shall create a link port on the external
VL, and use that link port to connect the
external CP to the external VL.
type: object
properties:
cpInstanceId:
description: >
An identifier that is unique for the
respective type within a VNF instance, but
may not be globally unique.
type: string
linkPortId:
description: >
An identifier with the intention of being
globally unique.
type: string
cpProtocolData:
description: >
Parameters for configuring the network
protocols on the link port that connects the
CP to a VL. The following conditions apply
to the attributes "linkPortId" and
"cpProtocolData": * The "linkPortId" and
"cpProtocolData" attributes shall both be
absent for the deletion of an existing external CP instance
addressed by cpInstanceId.
* At least one of these attributes shall be
present for a
to-be-created external CP instance or an existing external
CP instance.
* If the "linkPortId" attribute is absent,
the VNFM shall create a
link port.
* If the "cpProtocolData" attribute is
absent, the "linkPortId"
attribute shall be provided referencing a pre-created link port,
and the VNFM can use means outside the scope of the present
document to obtain the pre-configured address information for the
connection point from the resource representing the link port.
* If both "cpProtocolData" and "linkportId"
are provided, the API
consumer shall ensure that the cpProtocolData can be used with the
pre-created link port referenced by "linkPortId".
type: array
items:
description: >
This type represents network protocol
data.
type: object
required:
- layerProtocol
properties:
layerProtocol:
description: >
Identifier of layer(s) and protocol(s).
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 network address
data for IP over Ethernet.
type: object
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: >
List of IP addresses to assign to the CP
instance. Each entry represents IP
address data for fixed or dynamic IP
address assignment per subnet. If this
attribute is not present, no IP address
shall be assigned.
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
fixedAddresses:
description: >
Fixed addresses to assign (from the
subnet defined by "subnetId" if
provided). Exactly one of
"fixedAddresses", "numDynamicAddresses"
or "ipAddressRange" shall be present.
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
numDynamicAddresses:
description: >
Number of dynamic addresses to assign
(from the subnet defined by "subnetId"
if provided). Exactly one of
"fixedAddresses", "numDynamicAddresses"
or "ipAddressRange" shall be present.
type: integer
addressRange:
description: >
An IP address range to be used, e.g. in
case of egress connections. In case this
attribute is present, IP addresses from
the range will be used.
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 identifier maintained by the VIM or
other resource provider. It is expected
to be unique within the VIM instance.
type: string
extLinkPorts:
description: >
Externally provided link ports to be used to connect
external connection points to this external VL. If this
attribute is not present, the VNFM shall create the link
ports on the external VL.
type: array
items:
description: >
This type represents an externally provided link port
to be used to connect an external connection point to
an external 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
extManagedVirtualLinks:
description: |
Information about internal VLs that are managed by the NFVO.
type: array
items:
type: object
required:
- id
- virtualLinkDescId
- resourceId
properties:
id:
description: >
An identifier with the intention of being globally
unique.
type: string
virtualLinkDescId:
description: |
An identifier that is unique within a VNF descriptor.
type: string
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
vimConnectionInfo:
description: >
Information about VIM connections to be used for managing the
resources for the VNF instance, or refer to external /
externally-managed virtual links. This attribute shall only be
supported and may be present if VNF-related resource
management in direct mode is applicable.
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
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