Newer
Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
swagger: '2.0'
info:
version: 1.1.1
title: SOL002 - VNF Configuration interface
description: >
VNF Configuration interface of ETSI NFV SOL002
IMPORTANT: Please note that this file might be not aligned to the current
version of the ETSI Group Specification it refers to. In case of
discrepancies the published ETSI Group Specification takes precedence.
Please report bugs to
https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution=---
license:
name: ETSI Forge copyright notice
url: 'https://forge.etsi.org/etsi-forge-copyright-notice.txt'
externalDocs:
description: ETSI GS NFV-SOL 002 V2.4.1
url: >-
http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.04.01_60/gs_NFV-SOL002v020401p.pdf
basePath: /vnfconfig/v1
schemes:
- http
- https
consumes:
- application/json
produces:
- application/json
paths:
/vnf_instances:
post:
description: The POST method creates a new VNF instance resource.
parameters:
- name: createVnfRequest
description: The VNF creation parameters
in: body
required: true
schema:
type: object
required:
- vnfdId
properties:
vnfdId:
description: |
An identifier with the intention of being globally unique.
type: string
vnfInstanceName:
description: |
Human-readable name of the VNF instance to be created.
type: string
vnfInstanceDescription:
description: |
Human-readable description of the VNF instance to be created.
type: string
- 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: true
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:
'201':
description: A VNF Instance identifier was created successfully
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: >
Created
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
- onboardedVnfPkgInfoId
- 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
onboardedVnfPkgInfoId:
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
instantiationState:
description: |
The instantiation state of the VNF.
type: string
enum:
- NOT_INSTANTIATED
- INSTANTIATED
instantiatedVnfInfo:
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
addresses:
description: >
List of network addresses that have been configured
(statically or dynamically) on the CP.
type: array
items:
description: >
This type represents information about a network
address that has been assigned.
type: object
required:
- macAddress
properties:
macAddress:
description: |
Assigned MAC address.
type: string
ipAddress:
description: >
IP address. Present if an IP address was
assigned.
type: string
subnetIpRanges:
description: >
IP address ranges defining the subnet in which
the IP address was assigned. May be present if
the "ipAddress" attribute is present, and
shall be absent if the "ipAddress" attribute
is not present.
type: array
items:
type: object
required:
- minIpAddress
- maxIpAddress
properties:
minIpAddress:
description: >
Lowest IP address belonging to the
range.
type: string
format: ipaddress
maxIpAddress:
description: >
Highest IP address belonging to the
range.
type: string
format: ipaddress
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:
description: >
An identifier that is unique for the respective type
within a VNF instance, but may not be globally
unique.
type: string
networkResource:
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
vnfLinkPorts:
description: |
Link ports of this VL.
type: array
items:
type: object
required:
- id
- resourceHandle
properties:
id:
description: >
An identifier that is unique for the
respective type within a VNF instance, but may
not be 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
monitoringParameters:
description: |
Active monitoring parameters.
type: array
items:
type: object
required:
- id
- value
- timeStamp
properties:
id:
description: >
An identifier that is unique within a VNF
descriptor.
type: string
name:
description: >
Human readable name of the monitoring parameter, as
defined in the VNFD.
type: string
value:
description: >
Value of the monitoring parameter known to the VNFM
(e.g. obtained for autoscaling purposes). The type
of the "value" attribute (i.e. scalar, structure
(Object in JSON), or array (of scalars, arrays or
structures/Objects)) is assumed to be defined in an
external measurement specification outside the scope
of the present document.
type: object
timeStamp:
description: >
Represents the point in time when the measurement
has been performed, as known to the VNFM. Should be
formatted according to ETF RFC 3339.
type: string
localizationLanguage:
description: >
Information about localization language of the VNF
(includes e.g. strings in the VNFD). The localization
languages supported by a VNF can be declared in the VNFD,
and localization language selection can take place at
instantiation time. The value shall comply with the format
defined in IETF RFC 5646.
type: string
vnfcResourceInfo:
description: >
Information about the virtualised compute and storage
resources used by the VNFCs of the VNF instance.
type: array
items:
description: >
This type represents the information on virtualised
compute and storage resources used by a VNFC in a VNF
instance.
type: object
required:
- id
- vduId
- computeResource
- vnfcCpInfo
properties:
id:
description: >
An identifier that is unique for the respective type
within a VNF instance, but may not be globally
unique.
type: string
vduId:
description: >
An identifier that is unique within a VNF
descriptor.
type: string
computeResource:
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
storageResourceIds:
description: >
References to the VirtualStorage resources. The
value refers to a VirtualStorageResourceInfo item in
the VnfInstance.
type: array
items:
description: >
An identifier that is unique for the respective
type within a VNF instance, but may not be
globally unique.
type: string
reservationId:
description: >
An identifier with the intention of being globally
unique.
type: string
vnfcCpInfo:
description: >
CPs of the VNFC instance. Shall be present when that
particular CP of the VNFC instance is associated to
an external CP of the VNF instance. May be present
otherwise.
type: array
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
vnfExtCpId:
description: >
An identifier that is unique for the
respective type within a VNF instance, but may
not be globally unique.
type: string
addresses:
description: >
This type represents information about a
network address that has been assigned.
type: object
required:
- macAddress
properties:
macAddress:
description: |
Assigned MAC address.
type: string
ipAddress:
description: >
IP address. Present if an IP address was
assigned.
type: string
subnetIpRanges:
description: >
IP address ranges defining the subnet in
which the IP address was assigned. May be
present if the "ipAddress" attribute is
present, and shall be absent if the
"ipAddress" attribute is not present.
type: array
items:
type: object
required:
- minIpAddress
- maxIpAddress
properties:
minIpAddress:
description: >
Lowest IP address belonging to the
range.
type: string
format: ipaddress
maxIpAddress:
description: >
Highest IP address belonging to the
range.
type: string
format: ipaddress
metadata:
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
virtualLinkResourceInfo:
description: >
Information about the virtualised network resources used
by the VLs of the VNF instance.
type: array
items:
description: >
This type represents the information that allows
addressing a virtualised resource that is used by an
internal VL instance in a VNF instance.
type: object
required:
- id
- virtualLinkDescId
- networkResource
- vnfLinkPorts
properties:
id:
description: >
An identifier that is unique for the respective type
within a VNF instance, but may not be globally
unique.
type: string
virtualLinkDescId:
description: >
An identifier that is unique within a VNF
descriptor.
type: string
networkResource:
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
reservationId:
description: >
An identifier with the intention of being globally
unique.
type: string
vnfLinkPorts:
description: >
Links ports of this VL. Shall be present when the
linkPort is used for external connectivity by the
VNF (refer to VnfLinkPort). May be present
otherwise.
type: array
items:
type: object
required:
- id
- resourceHandle
properties:
id:
description: >
An identifier that is unique for the
respective type within a VNF instance, but may
not be 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
metadata:
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
virtualStorageResourceInfo:
description: >
Information on the virtualised storage resource(s) used as
storage for the VNF instance.
type: array
items:
description: >
This type represents the information that allows
addressing a virtualised resource that is used by a VNF
instance.
type: object
required:
- id
- virtualStorageDescId
- storageResource
properties:
id:
description: >
An identifier that is unique for the respective type
within a VNF instance, but may not be globally
unique.
type: string
virtualStorageDescId:
description: >
An identifier that is unique within a VNF
descriptor.
type: string
storageResource:
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
reservationId:
description: >
An identifier with the intention of being globally
unique.
type: string
metadata:
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
vnfcInfo:
description: TBD
type: string
metadata:
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
extensions:
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
_links:
description: |
Links to resources related to this resource.
type: object
required:
- self
properties:
self:
description: |
This type represents a link to a resource.
type: object
required:
- href
properties:
href:
description: |
URI of the referenced resource.
type: string
format: url
indicators:
description: |
This type represents a link to a resource.
type: object
required:
- href
properties:
href:
description: |
URI of the referenced resource.
type: string
format: url
instantiate:
description: |
This type represents a link to a resource.
type: object
required:
- href
properties:
href:
description: |
URI of the referenced resource.
type: string
format: url
terminate:
description: |
This type represents a link to a resource.
type: object
required:
- href
properties:
href:
description: |
URI of the referenced resource.
type: string
format: url
scale:
description: |
This type represents a link to a resource.
type: object
required:
- href
properties:
href:
description: |
URI of the referenced resource.
type: string
format: url
scaleToLevel:
description: |
This type represents a link to a resource.
type: object
required:
- href
properties:
href:
description: |
URI of the referenced resource.
type: string
format: url
changeFlavour:
description: |
This type represents a link to a resource.
type: object
required:
- href
properties:
href:
description: |