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
{
"info": {
"_postman_id": "3ec71b17-e183-4c00-a9f0-cb267f61258d",
"name": "SOL003 - VNF Package Management interface",
"description": "SOL003 - VNF Package Management interface\n\nIMPORTANT: 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.\n\nIn clause 4.3.2 of ETSI GS NFV-SOL 003 v2.4.1, an attribute-based filtering mechanism is defined. This mechanism is currently not included in the corresponding OpenAPI design for this GS version. Changes to the attribute-based filtering mechanism are being considered in v2.5.1 of this GS for inclusion in the corresponding future ETSI NFV OpenAPI design.\nPlease report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution=\n",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"name": "subscriptions",
"description": "Folder for subscriptions",
"item": [
{
"name": "get single subscription",
"event": [
{
"listen": "test",
"script": {
"id": "cf67f3df-72a3-442f-8b8d-2e79183906e0",
"type": "text/javascript",
"exec": [
"pm.test(\"Status code is 200\", function () {",
" pm.response.to.have.status(200);",
"});",
"",
"var res_schema = {\"description\":\"This type represents a subscription related to notifications about VNF package management. \",\"type\":\"object\",\"required\":[\"id\",\"callbackUri\",\"_links\"],\"properties\":{\"id\":{\"description\":\"An identifier with the intention of being globally unique. \",\"type\":\"string\"},\"filter\":{\"description\":\"This type represents a subscription filter related to notifications related to VNF package management. At a particular nesting level in the filter structure, the following applies: All attributes shall match in order for the filter to match (logical \\\"and\\\" between different filter attributes). If an attribute is an array, the attribute shall match if at least one of the values in the array matches (logical \\\"or\\\" between the values of one filter attribute). \",\"type\":\"object\",\"properties\":{\"notificationTypes\":{\"description\":\"Match particular notification types. Permitted values: - VnfPackageOnboardingNotification - VnfPackageChangeNotification The permitted values of the \\\"notificationTypes\\\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems. \",\"type\":\"array\",\"items\":{\"type\":\"string\",\"enum\":[\"VnfPackageOnboardingNotification\",\"VnfPackageChangeNotification\"]}},\"vnfProductsFromProviders\":{\"description\":\"If present, match VNF packages that contain VNF products from certain providers. The attributes \\\"vnfProductsFromProviders\\\", \\\"vnfdId\\\" and \\\"vnfPkgId\\\" are alternatives to reference to particular VNF packages in a filter. They should not be used both in the same filter instance, but one alternative should be chosen. \",\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"vnfProvider\"],\"properties\":{\"vnfProvider\":{\"description\":\"Name of the VNF provider to match. \",\"type\":\"string\"},\"vnfProducts\":{\"description\":\"If present, match VNF packages that contain VNF products with certain product names, from one particular provider. \",\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"vnfProductName\"],\"properties\":{\"vnfProductName\":{\"description\":\"Name of the VNF product to match. \",\"type\":\"string\"},\"versions\":{\"description\":\"If present, match VNF packages that contain VNF products with certain versions and a certain product name, from one particular provider. \",\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"vnfSoftwareVersion\"],\"properties\":{\"vnfSoftwareVersion\":{\"description\":\"A Version. \",\"type\":\"string\"},\"vnfdVersions\":{\"description\":\"If present, match VNF packages that contain VNF products with certain VNFD versions, a certain software version and a certain product name, from one particular provider. \",\"type\":\"array\",\"items\":{\"description\":\"A Version. \",\"type\":\"string\"}}}}}}}}}}},\"vnfdId\":{\"description\":\"Match VNF packages with a VNFD identifier listed in the attribute. The attributes \\\"vnfProductsFromProviders\\\", \\\"vnfdId\\\" and \\\"vnfPkgId\\\" are alternatives to reference to particular VNF packages in a filter. They should not be used both in the same filter instance, but one alternative should be chosen. \",\"type\":\"array\",\"items\":{\"description\":\"An identifier with the intention of being globally unique. \",\"type\":\"string\"}},\"vnfPkgId\":{\"description\":\"Match VNF packages with a package identifier listed in the attribute. May be present if the \\\"notificationTypes\\\" attribute contains the value \\\"VnfPackageChangeNotification\\\", and shall be absent otherwise. The attributes \\\"vnfProductsFromProviders\\\", \\\"vnfdId\\\" and \\\"vnfPkgId\\\" are alternatives to reference to particular VNF packages in a filter. They should not be used both in the same filter instance, but one alternative should be chosen. \",\"type\":\"array\",\"items\":{\"description\":\"An identifier with the intention of being globally unique. \",\"type\":\"string\"}},\"operationalState\":{\"description\":\"- ENABLED: The VNF package is enabled, i.e. it can be used for instantiation of new VNF instances. - DISABLED: The VNF package is disabled, i.e. it cannot be used for further VNF instantiation requests (unless and until the VNF package is re-enabled). \",\"type\":\"string\",\"enum\":[\"ENABLED\",\"DISABLED\"]},\"usageState\":{\"description\":\"- IN_USE: VNF instances instantiated from this VNF package exist. - NOT_IN_USE: No existing VNF instance is instantiated from this VNF package. \"}}},\"callbackUri\":{\"description\":\"String formatted according to IETF RFC 3986. \",\"type\":\"string\"},\"_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\"}}}}}}};",
"",
"pm.test('Schema is valid', function() {",
" pm.expect(tv4.validate(pm.response.json(), res_schema)).to.be.true;",
"});",
""
]
}
}
],
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "{{Accept}}"
},
{
"key": "Authorization",
"value": "{{Authorization}}"
}
],
"body": {},
"url": {
"raw": "{{scheme}}://{{host}}{{port}}/{{uri_prefix}}vnfpkgm/v1/subscriptions/{{subscriptionId}}",
"protocol": "{{scheme}}",
"host": [
"{{host}}{{port}}"
],
"path": [
"{{uri_prefix}}vnfpkgm",
"v1",
"subscriptions",
"{{subscriptionId}}"
]
},
"description": "The GET method reads an individual subscription.\n"
},
"response": []
},
{
"name": "delete subscription",
"event": [
{
"listen": "test",
"script": {
"id": "1dc0a771-37e3-4013-938e-91ccd6da1d4a",
"type": "text/javascript",
"exec": [
"pm.test(\"Status code is 204\", function () {",
" pm.response.to.have.status(204);",
"});"
]
}
}
],
"request": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Authorization",
"value": "{{Authorization}}"
}
],
"body": {},
"url": {
"raw": "{{scheme}}://{{host}}{{port}}/{{uri_prefix}}vnfpkgm/v1/subscriptions/{{subscriptionId}}",
"protocol": "{{scheme}}",
"host": [
"{{host}}{{port}}"
],
"path": [
"{{uri_prefix}}vnfpkgm",
"v1",
"subscriptions",
"{{subscriptionId}}"
]
},
"description": "The DELETE method terminates an individual subscription.\n"
},
"response": []
},
{
"name": "create subscription",
"event": [
{
"listen": "test",
"script": {
"id": "1f636ad7-60ae-474e-83cf-5de8865b0ed4",
"type": "text/javascript",
"exec": [
"pm.test(\"Status code is 201\", function () {",
" pm.response.to.have.status(201);",
"});",
"",
"var res_schema = {\"type\":\"array\",\"items\":{\"description\":\"This type represents a subscription related to notifications about VNF package management. \",\"type\":\"object\",\"required\":[\"id\",\"callbackUri\",\"_links\"],\"properties\":{\"id\":{\"description\":\"An identifier with the intention of being globally unique. \",\"type\":\"string\"},\"filter\":{\"description\":\"This type represents a subscription filter related to notifications related to VNF package management. At a particular nesting level in the filter structure, the following applies: All attributes shall match in order for the filter to match (logical \\\"and\\\" between different filter attributes). If an attribute is an array, the attribute shall match if at least one of the values in the array matches (logical \\\"or\\\" between the values of one filter attribute). \",\"type\":\"object\",\"properties\":{\"notificationTypes\":{\"description\":\"Match particular notification types. Permitted values: - VnfPackageOnboardingNotification - VnfPackageChangeNotification The permitted values of the \\\"notificationTypes\\\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems. \",\"type\":\"array\",\"items\":{\"type\":\"string\",\"enum\":[\"VnfPackageOnboardingNotification\",\"VnfPackageChangeNotification\"]}},\"vnfProductsFromProviders\":{\"description\":\"If present, match VNF packages that contain VNF products from certain providers. The attributes \\\"vnfProductsFromProviders\\\", \\\"vnfdId\\\" and \\\"vnfPkgId\\\" are alternatives to reference to particular VNF packages in a filter. They should not be used both in the same filter instance, but one alternative should be chosen. \",\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"vnfProvider\"],\"properties\":{\"vnfProvider\":{\"description\":\"Name of the VNF provider to match. \",\"type\":\"string\"},\"vnfProducts\":{\"description\":\"If present, match VNF packages that contain VNF products with certain product names, from one particular provider. \",\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"vnfProductName\"],\"properties\":{\"vnfProductName\":{\"description\":\"Name of the VNF product to match. \",\"type\":\"string\"},\"versions\":{\"description\":\"If present, match VNF packages that contain VNF products with certain versions and a certain product name, from one particular provider. \",\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"vnfSoftwareVersion\"],\"properties\":{\"vnfSoftwareVersion\":{\"description\":\"A Version. \",\"type\":\"string\"},\"vnfdVersions\":{\"description\":\"If present, match VNF packages that contain VNF products with certain VNFD versions, a certain software version and a certain product name, from one particular provider. \",\"type\":\"array\",\"items\":{\"description\":\"A Version. \",\"type\":\"string\"}}}}}}}}}}},\"vnfdId\":{\"description\":\"Match VNF packages with a VNFD identifier listed in the attribute. The attributes \\\"vnfProductsFromProviders\\\", \\\"vnfdId\\\" and \\\"vnfPkgId\\\" are alternatives to reference to particular VNF packages in a filter. They should not be used both in the same filter instance, but one alternative should be chosen. \",\"type\":\"array\",\"items\":{\"description\":\"An identifier with the intention of being globally unique. \",\"type\":\"string\"}},\"vnfPkgId\":{\"description\":\"Match VNF packages with a package identifier listed in the attribute. May be present if the \\\"notificationTypes\\\" attribute contains the value \\\"VnfPackageChangeNotification\\\", and shall be absent otherwise. The attributes \\\"vnfProductsFromProviders\\\", \\\"vnfdId\\\" and \\\"vnfPkgId\\\" are alternatives to reference to particular VNF packages in a filter. They should not be used both in the same filter instance, but one alternative should be chosen. \",\"type\":\"array\",\"items\":{\"description\":\"An identifier with the intention of being globally unique. \",\"type\":\"string\"}},\"operationalState\":{\"description\":\"- ENABLED: The VNF package is enabled, i.e. it can be used for instantiation of new VNF instances. - DISABLED: The VNF package is disabled, i.e. it cannot be used for further VNF instantiation requests (unless and until the VNF package is re-enabled). \",\"type\":\"string\",\"enum\":[\"ENABLED\",\"DISABLED\"]},\"usageState\":{\"description\":\"- IN_USE: VNF instances instantiated from this VNF package exist. - NOT_IN_USE: No existing VNF instance is instantiated from this VNF package. \"}}},\"callbackUri\":{\"description\":\"String formatted according to IETF RFC 3986. \",\"type\":\"string\"},\"_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\"}}}}}}}};",
"",
"pm.test('Schema is valid', function() {",
" pm.expect(tv4.validate(pm.response.json(), res_schema)).to.be.true;",
"});",
""
]
}
}
],
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "{{Accept}}"
},
{
"key": "Authorization",
"value": "{{Authorization}}"
},
{
"key": "Content-Type",
"value": "{{Content-Type}}"
}
],
"body": {
"mode": "raw",
"raw": "Representation of the created subscription resource. The HTTP response shall include a \"Location\" HTTP header that points to the created subscription resource.\n"
},
"url": {
"raw": "{{scheme}}://{{host}}{{port}}/{{uri_prefix}}vnfpkgm/v1/subscriptions",
"protocol": "{{scheme}}",
"host": [
"{{host}}{{port}}"
],
"path": [
"{{uri_prefix}}vnfpkgm",
"v1",
"subscriptions"
]
},
"description": "The POST method creates a new subscription. Creation of two subscription resources with the same callbackURI and the same filter can result in performance degradation and will provide duplicates of notifications to the VNFM, and might make sense only in very rare use cases. Consequently, the NFVO may either allow creating a subscription resource if another subscription resource with the same filter and callbackUri already exists (in which case it shall return the “201 Created” response code), or may decide to not create a duplicate subscription resource (in which case it shall return a “303 See Other” response code referencing the existing subscription resource with the same filter and callbackUri).\n"
},
"response": []
},
{
"name": "get subscriptions",
"event": [
{
"listen": "test",
"script": {
"id": "4e29d1a0-eddd-4608-a3b8-f971ca651702",
"type": "text/javascript",
"exec": [
"pm.test(\"Status code is 200\", function () {",
" pm.response.to.have.status(200);",
"});",
"",
"var res_schema = {\"type\":\"array\",\"items\":{\"description\":\"This type represents a subscription related to notifications about VNF package management. \",\"type\":\"object\",\"required\":[\"id\",\"callbackUri\",\"_links\"],\"properties\":{\"id\":{\"description\":\"An identifier with the intention of being globally unique. \",\"type\":\"string\"},\"filter\":{\"description\":\"This type represents a subscription filter related to notifications related to VNF package management. At a particular nesting level in the filter structure, the following applies: All attributes shall match in order for the filter to match (logical \\\"and\\\" between different filter attributes). If an attribute is an array, the attribute shall match if at least one of the values in the array matches (logical \\\"or\\\" between the values of one filter attribute). \",\"type\":\"object\",\"properties\":{\"notificationTypes\":{\"description\":\"Match particular notification types. Permitted values: - VnfPackageOnboardingNotification - VnfPackageChangeNotification The permitted values of the \\\"notificationTypes\\\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems. \",\"type\":\"array\",\"items\":{\"type\":\"string\",\"enum\":[\"VnfPackageOnboardingNotification\",\"VnfPackageChangeNotification\"]}},\"vnfProductsFromProviders\":{\"description\":\"If present, match VNF packages that contain VNF products from certain providers. The attributes \\\"vnfProductsFromProviders\\\", \\\"vnfdId\\\" and \\\"vnfPkgId\\\" are alternatives to reference to particular VNF packages in a filter. They should not be used both in the same filter instance, but one alternative should be chosen. \",\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"vnfProvider\"],\"properties\":{\"vnfProvider\":{\"description\":\"Name of the VNF provider to match. \",\"type\":\"string\"},\"vnfProducts\":{\"description\":\"If present, match VNF packages that contain VNF products with certain product names, from one particular provider. \",\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"vnfProductName\"],\"properties\":{\"vnfProductName\":{\"description\":\"Name of the VNF product to match. \",\"type\":\"string\"},\"versions\":{\"description\":\"If present, match VNF packages that contain VNF products with certain versions and a certain product name, from one particular provider. \",\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"vnfSoftwareVersion\"],\"properties\":{\"vnfSoftwareVersion\":{\"description\":\"A Version. \",\"type\":\"string\"},\"vnfdVersions\":{\"description\":\"If present, match VNF packages that contain VNF products with certain VNFD versions, a certain software version and a certain product name, from one particular provider. \",\"type\":\"array\",\"items\":{\"description\":\"A Version. \",\"type\":\"string\"}}}}}}}}}}},\"vnfdId\":{\"description\":\"Match VNF packages with a VNFD identifier listed in the attribute. The attributes \\\"vnfProductsFromProviders\\\", \\\"vnfdId\\\" and \\\"vnfPkgId\\\" are alternatives to reference to particular VNF packages in a filter. They should not be used both in the same filter instance, but one alternative should be chosen. \",\"type\":\"array\",\"items\":{\"description\":\"An identifier with the intention of being globally unique. \",\"type\":\"string\"}},\"vnfPkgId\":{\"description\":\"Match VNF packages with a package identifier listed in the attribute. May be present if the \\\"notificationTypes\\\" attribute contains the value \\\"VnfPackageChangeNotification\\\", and shall be absent otherwise. The attributes \\\"vnfProductsFromProviders\\\", \\\"vnfdId\\\" and \\\"vnfPkgId\\\" are alternatives to reference to particular VNF packages in a filter. They should not be used both in the same filter instance, but one alternative should be chosen. \",\"type\":\"array\",\"items\":{\"description\":\"An identifier with the intention of being globally unique. \",\"type\":\"string\"}},\"operationalState\":{\"description\":\"- ENABLED: The VNF package is enabled, i.e. it can be used for instantiation of new VNF instances. - DISABLED: The VNF package is disabled, i.e. it cannot be used for further VNF instantiation requests (unless and until the VNF package is re-enabled). \",\"type\":\"string\",\"enum\":[\"ENABLED\",\"DISABLED\"]},\"usageState\":{\"description\":\"- IN_USE: VNF instances instantiated from this VNF package exist. - NOT_IN_USE: No existing VNF instance is instantiated from this VNF package. \"}}},\"callbackUri\":{\"description\":\"String formatted according to IETF RFC 3986. \",\"type\":\"string\"},\"_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\"}}}}}}}};",
"",
"pm.test('Schema is valid', function() {",
" pm.expect(tv4.validate(pm.response.json(), res_schema)).to.be.true;",
"});",
""
]
}
}
],
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "{{Accept}}"
},
{
"key": "Authorization",
"value": "{{Authorization}}"
}
],
"body": {},
"url": {
"raw": "{{scheme}}://{{host}}{{port}}/{{uri_prefix}}vnfpkgm/v1/subscriptions",
"protocol": "{{scheme}}",
"host": [
"{{host}}{{port}}"
],
"path": [
"{{uri_prefix}}vnfpkgm",
"v1",
"subscriptions"
]
},
"description": "The GET method queries the list of active subscriptions of the functional block that invokes the method. It can be used e.g. for resynchronization after error situations.\n"
},
"response": []
}
]
},
{
"name": "vnf_packages",
"description": "Folder for vnf_packages",
"item": [
{
"name": "Fetch On-boarded VNF Package Artifacts",
"event": [
{
"listen": "test",
"script": {
"id": "9892ef77-e8e4-4cee-af70-9b92b152d923",
"type": "text/javascript",
"exec": [
"pm.test(\"Status code is 200\", function () {",
" pm.response.to.have.status(200);",
"});",
""
]
}
}
],
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "{{Accept}}"
},
{
"key": "Authorization",
"value": "{{Authorization}}"
},
{
"key": "Range",
"value": "{{Range}}"
}
],
"body": {},
"url": {
"raw": "{{scheme}}://{{host}}{{port}}/{{uri_prefix}}vnfpkgm/v1/vnf_packages/{{vnfPkgId}}/artifacts/{{artifactPath}}",
"protocol": "{{scheme}}",
"host": [
"{{host}}{{port}}"
],
"path": [
"{{uri_prefix}}vnfpkgm",
"v1",
"vnf_packages",
"{{vnfPkgId}}",
"artifacts",
"{{artifactPath}}"
]
},
"description": "The GET method fetches the content of an artifact within a VNF package.\n"
},
"response": []
},
{
"name": "Read on-boarded single VNF package information",
"event": [
{
"listen": "test",
"script": {
"id": "7ad41a8d-8b92-4cce-b810-450085c6139a",
"type": "text/javascript",
"exec": [
"pm.test(\"Status code is 200\", function () {",
" pm.response.to.have.status(200);",
"});",
"",
"var res_schema = {\"description\":\"This type represents the information of an VNF package. \",\"type\":\"object\",\"required\":[\"id\",\"operationalState\",\"usageState\",\"_links\"],\"properties\":{\"id\":{\"description\":\"An identifier with the intention of being globally unique. \",\"type\":\"string\"},\"vnfdId\":{\"description\":\"An identifier with the intention of being globally unique. \",\"type\":\"string\"},\"vnfProvider\":{\"description\":\"Provider of the VNF package and the VNFD. This information is copied from the VNFD. \",\"type\":\"string\"},\"vnfProductName\":{\"description\":\"Name to identify the VNF product. Invariant for the VNF product lifetime. This information is copied from the VNFD. It shall be present after the VNF package content has been on-boarded and absent otherwise. \",\"type\":\"string\"},\"vnfSoftwareVersion\":{\"description\":\"A Version. \",\"type\":\"string\"},\"vnfdVersion\":{\"description\":\"A Version. \",\"type\":\"string\"},\"checksum\":{\"description\":\"This type represents the checksum of a VNF package or an artifact file. \",\"type\":\"object\",\"required\":[\"algorithm\",\"hash\"],\"properties\":{\"algorithm\":{\"description\":\"Name of the algorithm used to generate the checksum, as defined in ETSI GS NFV-SOL 004. For example, SHA-256, SHA-512. \",\"type\":\"string\"},\"hash\":{\"description\":\"The hexadecimal value of the checksum. \",\"type\":\"string\"}}},\"softwareImages\":{\"description\":\"Information about VNF package artifacts that are software images. This attribute shall not be present before the VNF package content is on-boarded. Otherwise, this attribute shall be present unless it has been requested to be excluded per attribute selector. \",\"type\":\"array\",\"items\":{\"description\":\"This type represents an artifact contained in a VNF package which represents a software image. \",\"type\":\"object\",\"required\":[\"id\",\"name\",\"provider\",\"version\",\"checksum\",\"containerFormat\",\"diskFormat\",\"createdAt\",\"minDisk\",\"minRam\",\"size\",\"imagePath\"],\"properties\":{\"id\":{\"description\":\"An identifier that is unique within a VNF descriptor. \",\"type\":\"string\"},\"name\":{\"description\":\"Name of the software image. \",\"type\":\"string\"},\"provider\":{\"description\":\"Provider of the software image. \",\"type\":\"string\"},\"version\":{\"description\":\"A Version. \",\"type\":\"string\"},\"checksum\":{\"description\":\"This type represents the checksum of a VNF package or an artifact file. \",\"type\":\"object\",\"required\":[\"algorithm\",\"hash\"],\"properties\":{\"algorithm\":{\"description\":\"Name of the algorithm used to generate the checksum, as defined in ETSI GS NFV-SOL 004. For example, SHA-256, SHA-512. \",\"type\":\"string\"},\"hash\":{\"description\":\"The hexadecimal value of the checksum. \",\"type\":\"string\"}}},\"containerFormat\":{\"description\":\"Container format indicates whether the software image is in a file format that also contains metadata about the actual software. Permitted values: - AKI: a kernel image format - AMI: a machine image format - ARI: a ramdisk image format - BARE: the image does not have a container or metadata envelope - DOCKER: docker container format - OVA: OVF package in a tarfile - OVF: OVF container format The list of permitted values was taken from \\\"Container formats\\\" in http://docs.openstack.org/image-guide/image-formats.html \",\"type\":\"string\",\"enum\":[\"AKI\",\"AMI\",\"ARI\",\"BARE\",\"DOCKER\",\"OVA\",\"OVF\"]},\"diskFormat\":{\"description\":\"Disk format of a software image is the format of the underlying disk image. Permitted values: - AKI: a kernel image format - AMI: a machine image format - ARI: a ramdisk image format - ISO: an archive format for the data contents of an optical disc, such as CD-ROM - QCOW2: a common disk image format, which can expand dynamically and supports copy on write - RAW: an unstructured disk image format - VDI: a common disk image format - VHD: a common disk image format - VHDX: enhanced version of VHD format - VMDK: a common disk image format The list of permitted values was adapted from \\\"Disk formats\\\" in http://docs.openstack.org/image-guide/image-formats.html \",\"type\":\"string\",\"enum\":[\"AKI\",\"AMI\",\"ISO\",\"QCOW2\",\"RAW\",\"VDI\",\"VHD\",\"VHDX\",\"VMDK\"]},\"createdAt\":{\"description\":\"Date-time stamp. Representation: String formatted according to IETF RFC 3339. \",\"type\":\"string\",\"format\":\"date-time\"},\"minDisk\":{\"description\":\"The minimal disk for this software image in bytes. \",\"type\":\"integer\"},\"minRam\":{\"description\":\"The minimal RAM for this software image in bytes. \",\"type\":\"integer\"},\"size\":{\"description\":\"Size of this software image in bytes. \",\"type\":\"integer\"},\"userMetadata\":{\"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\"},\"imagePath\":{\"description\":\"Path in the VNF package, which identifies the image artifact and also allows to access a copy of the image artifact. \",\"type\":\"string\"}}}},\"additionalArtifacts\":{\"description\":\"Information about VNF package artifacts contained in the VNF package that are not software images. This attribute shall not be present before the VNF package content is on-boarded. Otherwise, this attribute shall be present if the VNF package contains additional artifacts. \",\"type\":\"array\",\"items\":{\"description\":\"This type represents an artifact other than a software image which is contained in a VNF package. \",\"type\":\"object\",\"required\":[\"artifactPath\",\"checksum\"],\"properties\":{\"artifactPath\":{\"description\":\"Path in the VNF package, which identifies the artifact and also allows to access a copy of the artifact. \",\"type\":\"string\"},\"checksum\":{\"description\":\"This type represents the checksum of a VNF package or an artifact file. \",\"type\":\"object\",\"required\":[\"algorithm\",\"hash\"],\"properties\":{\"algorithm\":{\"description\":\"Name of the algorithm used to generate the checksum, as defined in ETSI GS NFV-SOL 004. For example, SHA-256, SHA-512. \",\"type\":\"string\"},\"hash\":{\"description\":\"The hexadecimal value of the checksum. \",\"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\"}}}},\"onboardingState\":{\"description\":\"CREATED: The VNF package resource has been created. UPLOADING: The associated VNF package content is being uploaded. PROCESSING: The associated VNF package content is being processed, e.g., validation. ONBOARDED: The associated VNF package content has been successfully on-boarded. \",\"type\":\"string\",\"enum\":[\"CREATED\",\"UPLOADING\",\"PROCESSING\",\"ONBOARDED\"]},\"operationalState\":{\"description\":\"- ENABLED: The VNF package is enabled, i.e. it can be used for instantiation of new VNF instances. - DISABLED: The VNF package is disabled, i.e. it cannot be used for further VNF instantiation requests (unless and until the VNF package is re-enabled). \",\"type\":\"string\",\"enum\":[\"ENABLED\",\"DISABLED\"]},\"usageState\":{\"description\":\"- IN_USE: VNF instances instantiated from this VNF package exist. - NOT_IN_USE: No existing VNF instance is instantiated from this VNF package. \"},\"userDefinedData\":{\"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\",\"packageContent\"],\"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\"}}},\"vnfd\":{\"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\"}}},\"packageContent\":{\"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\"}}}}}}};",
"",
"pm.test('Schema is valid', function() {",
" pm.expect(tv4.validate(pm.response.json(), res_schema)).to.be.true;",
"});",
""
]
}
}
],
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "{{Accept}}"
},
{
"key": "Authorization",
"value": "{{Authorization}}"
}
],
"body": {},
"url": {
"raw": "{{scheme}}://{{host}}{{port}}/{{uri_prefix}}vnfpkgm/v1/vnf_packages/{{vnfPkgId}}",
"protocol": "{{scheme}}",
"host": [
"{{host}}{{port}}"
],
"path": [
"{{uri_prefix}}vnfpkgm",
"v1",
"vnf_packages",
"{{vnfPkgId}}"
]
},
"description": "The GET method reads the information of an individual VNF package.\n"
},
"response": []
},
{
"name": "Query On-boarded VNF Packages",
"event": [
{
"listen": "test",
"script": {
"id": "b5c38be6-04d6-4ef3-812f-4b76d8149528",
"type": "text/javascript",
"exec": [
"pm.test(\"Status code is 200\", function () {",
" pm.response.to.have.status(200);",
"});",
"",
"var res_schema = {\"type\":\"array\",\"items\":{\"description\":\"This type represents the information of an VNF package. \",\"type\":\"object\",\"required\":[\"id\",\"operationalState\",\"usageState\",\"_links\"],\"properties\":{\"id\":{\"description\":\"An identifier with the intention of being globally unique. \",\"type\":\"string\"},\"vnfdId\":{\"description\":\"An identifier with the intention of being globally unique. \",\"type\":\"string\"},\"vnfProvider\":{\"description\":\"Provider of the VNF package and the VNFD. This information is copied from the VNFD. \",\"type\":\"string\"},\"vnfProductName\":{\"description\":\"Name to identify the VNF product. Invariant for the VNF product lifetime. This information is copied from the VNFD. It shall be present after the VNF package content has been on-boarded and absent otherwise. \",\"type\":\"string\"},\"vnfSoftwareVersion\":{\"description\":\"A Version. \",\"type\":\"string\"},\"vnfdVersion\":{\"description\":\"A Version. \",\"type\":\"string\"},\"checksum\":{\"description\":\"This type represents the checksum of a VNF package or an artifact file. \",\"type\":\"object\",\"required\":[\"algorithm\",\"hash\"],\"properties\":{\"algorithm\":{\"description\":\"Name of the algorithm used to generate the checksum, as defined in ETSI GS NFV-SOL 004. For example, SHA-256, SHA-512. \",\"type\":\"string\"},\"hash\":{\"description\":\"The hexadecimal value of the checksum. \",\"type\":\"string\"}}},\"softwareImages\":{\"description\":\"Information about VNF package artifacts that are software images. This attribute shall not be present before the VNF package content is on-boarded. Otherwise, this attribute shall be present unless it has been requested to be excluded per attribute selector. \",\"type\":\"array\",\"items\":{\"description\":\"This type represents an artifact contained in a VNF package which represents a software image. \",\"type\":\"object\",\"required\":[\"id\",\"name\",\"provider\",\"version\",\"checksum\",\"containerFormat\",\"diskFormat\",\"createdAt\",\"minDisk\",\"minRam\",\"size\",\"imagePath\"],\"properties\":{\"id\":{\"description\":\"An identifier that is unique within a VNF descriptor. \",\"type\":\"string\"},\"name\":{\"description\":\"Name of the software image. \",\"type\":\"string\"},\"provider\":{\"description\":\"Provider of the software image. \",\"type\":\"string\"},\"version\":{\"description\":\"A Version. \",\"type\":\"string\"},\"checksum\":{\"description\":\"This type represents the checksum of a VNF package or an artifact file. \",\"type\":\"object\",\"required\":[\"algorithm\",\"hash\"],\"properties\":{\"algorithm\":{\"description\":\"Name of the algorithm used to generate the checksum, as defined in ETSI GS NFV-SOL 004. For example, SHA-256, SHA-512. \",\"type\":\"string\"},\"hash\":{\"description\":\"The hexadecimal value of the checksum. \",\"type\":\"string\"}}},\"containerFormat\":{\"description\":\"Container format indicates whether the software image is in a file format that also contains metadata about the actual software. Permitted values: - AKI: a kernel image format - AMI: a machine image format - ARI: a ramdisk image format - BARE: the image does not have a container or metadata envelope - DOCKER: docker container format - OVA: OVF package in a tarfile - OVF: OVF container format The list of permitted values was taken from \\\"Container formats\\\" in http://docs.openstack.org/image-guide/image-formats.html \",\"type\":\"string\",\"enum\":[\"AKI\",\"AMI\",\"ARI\",\"BARE\",\"DOCKER\",\"OVA\",\"OVF\"]},\"diskFormat\":{\"description\":\"Disk format of a software image is the format of the underlying disk image. Permitted values: - AKI: a kernel image format - AMI: a machine image format - ARI: a ramdisk image format - ISO: an archive format for the data contents of an optical disc, such as CD-ROM - QCOW2: a common disk image format, which can expand dynamically and supports copy on write - RAW: an unstructured disk image format - VDI: a common disk image format - VHD: a common disk image format - VHDX: enhanced version of VHD format - VMDK: a common disk image format The list of permitted values was adapted from \\\"Disk formats\\\" in http://docs.openstack.org/image-guide/image-formats.html \",\"type\":\"string\",\"enum\":[\"AKI\",\"AMI\",\"ISO\",\"QCOW2\",\"RAW\",\"VDI\",\"VHD\",\"VHDX\",\"VMDK\"]},\"createdAt\":{\"description\":\"Date-time stamp. Representation: String formatted according to IETF RFC 3339. \",\"type\":\"string\",\"format\":\"date-time\"},\"minDisk\":{\"description\":\"The minimal disk for this software image in bytes. \",\"type\":\"integer\"},\"minRam\":{\"description\":\"The minimal RAM for this software image in bytes. \",\"type\":\"integer\"},\"size\":{\"description\":\"Size of this software image in bytes. \",\"type\":\"integer\"},\"userMetadata\":{\"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\"},\"imagePath\":{\"description\":\"Path in the VNF package, which identifies the image artifact and also allows to access a copy of the image artifact. \",\"type\":\"string\"}}}},\"additionalArtifacts\":{\"description\":\"Information about VNF package artifacts contained in the VNF package that are not software images. This attribute shall not be present before the VNF package content is on-boarded. Otherwise, this attribute shall be present if the VNF package contains additional artifacts. \",\"type\":\"array\",\"items\":{\"description\":\"This type represents an artifact other than a software image which is contained in a VNF package. \",\"type\":\"object\",\"required\":[\"artifactPath\",\"checksum\"],\"properties\":{\"artifactPath\":{\"description\":\"Path in the VNF package, which identifies the artifact and also allows to access a copy of the artifact. \",\"type\":\"string\"},\"checksum\":{\"description\":\"This type represents the checksum of a VNF package or an artifact file. \",\"type\":\"object\",\"required\":[\"algorithm\",\"hash\"],\"properties\":{\"algorithm\":{\"description\":\"Name of the algorithm used to generate the checksum, as defined in ETSI GS NFV-SOL 004. For example, SHA-256, SHA-512. \",\"type\":\"string\"},\"hash\":{\"description\":\"The hexadecimal value of the checksum. \",\"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\"}}}},\"onboardingState\":{\"description\":\"CREATED: The VNF package resource has been created. UPLOADING: The associated VNF package content is being uploaded. PROCESSING: The associated VNF package content is being processed, e.g., validation. ONBOARDED: The associated VNF package content has been successfully on-boarded. \",\"type\":\"string\",\"enum\":[\"CREATED\",\"UPLOADING\",\"PROCESSING\",\"ONBOARDED\"]},\"operationalState\":{\"description\":\"- ENABLED: The VNF package is enabled, i.e. it can be used for instantiation of new VNF instances. - DISABLED: The VNF package is disabled, i.e. it cannot be used for further VNF instantiation requests (unless and until the VNF package is re-enabled). \",\"type\":\"string\",\"enum\":[\"ENABLED\",\"DISABLED\"]},\"usageState\":{\"description\":\"- IN_USE: VNF instances instantiated from this VNF package exist. - NOT_IN_USE: No existing VNF instance is instantiated from this VNF package. \"},\"userDefinedData\":{\"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\",\"packageContent\"],\"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\"}}},\"vnfd\":{\"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\"}}},\"packageContent\":{\"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\"}}}}}}}};",
"",
"pm.test('Schema is valid', function() {",
" pm.expect(tv4.validate(pm.response.json(), res_schema)).to.be.true;",
"});"
]
}
}
],
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "{{Accept}}"
},
{
"key": "Authorization",
"value": "{{Authorization}}"
}
],
"body": {},
"url": {
"raw": "{{scheme}}://{{host}}{{port}}/{{uri_prefix}}vnfpkgm/v1/vnf_packages",
"protocol": "{{scheme}}",
"host": [
"{{host}}{{port}}"
],
"path": [
"{{uri_prefix}}vnfpkgm",
"v1",
"vnf_packages"
]
},
"description": "The GET method queries the information of the VNF packages matching the filter.\n"
},
"response": []
},
{
"name": "Fetch On-boarded VNF Package content",
"event": [
{
"listen": "test",
"script": {
"id": "74ea2d52-1b22-4302-b718-391779763e96",
"type": "text/javascript",
"exec": [
"pm.test(\"Status code is 200\", function () {",
" pm.response.to.have.status(200);",
"});",
""
]
}
}
],
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "{{Accept}}"
},
{
"key": "Authorization",
"value": "{{Authorization}}"
},
{
"key": "Range",
"value": "{{Range}}"
}
],
"body": {},
"url": {
"raw": "{{scheme}}://{{host}}{{port}}/{{uri_prefix}}vnfpkgm/v1/vnf_packages/{{vnfPkgId}}/package_content",
"protocol": "{{scheme}}",
"host": [
"{{host}}{{port}}"
],
"path": [
"{{uri_prefix}}vnfpkgm",
"v1",
"vnf_packages",
"{{vnfPkgId}}",
"package_content"
]
},
"description": "The GET method fetches the content of a VNF package identified by the VNF package identifier allocated by the NFVO.\n"
},
"response": []
},
{
"name": "Reading the VNFD of an on-boarded VNF package",
"event": [
{
"listen": "test",
"script": {
"id": "08c9bab8-6c9a-4444-a6a1-28982e6f4746",
"type": "text/javascript",
"exec": [
"pm.test(\"Status code is 200\", function () {",
" pm.response.to.have.status(200);",
"});",
""
]
}
}
],
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "{{Accept}}"
},
{
"key": "Authorization",
"value": "{{Authorization}}"
}
],
"body": {},
"url": {
"raw": "{{scheme}}://{{host}}{{port}}/{{uri_prefix}}vnfpkgm/v1/vnf_packages/{{vnfPkgId}}/vnfd",
"protocol": "{{scheme}}",
"host": [
"{{host}}{{port}}"
],
"path": [
"{{uri_prefix}}vnfpkgm",
"v1",
"vnf_packages",
"{{vnfPkgId}}",
"vnfd"
]
},
"description": "The GET method reads the content of the VNFD within a VNF package. The VNFD can be implemented as a single file or as a collection of multiple files. If the VNFD is implemented in the form of multiple files, a ZIP file embedding these files shall be returned. If the VNFD is implemented as a single file, either that file or a ZIP file embedding that file shall be returned. The selection of the format is controlled by the \"Accept\" HTTP header passed in the GET request. * If the \"Accept\" header contains only \"text/plain\" and the VNFD is implemented as a single file, the file shall be returned;\n otherwise, an error message shall be returned.\n* If the \"Accept\" header contains only \"application/zip\", the single file or the multiple files that make up the VNFD shall be returned\n embedded in a ZIP file.\n* If the \"Accept\" header contains both \"text/plain\" and \"application/zip\", it is up to the NFVO to choose the format to\n return for a single-file VNFD; for a multi-file VNFD, a ZIP file\n shall be returned.\nThe default format of the ZIP file shall be the one specified in ETSI GS NFV-SOL 004 where only the YAML files representing the VNFD, and information needed to navigate the ZIP file and to identify the file that is the entry point for parsing the VNFD (such as TOSCA-meta or manifest files or naming conventions) are included.\n"
},
"response": []
}
]
}
]
}