Newer
Older
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
],
"summary": "Reads the content of the AppD of on-boarded individual application package resources.",
"description": "Reads the content of the AppD of on-boarded individual application package resources.",
"operationId": "appDGET",
"parameters": [{
"name": "appDId",
"in": "path",
"description": "Identifier of an application descriptor",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
},
{
"name": "filter",
"in": "query",
"description": "Attribute-based filtering parameters according to ETSI GS MEC 009",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "all_fields",
"in": "query",
"description": "Include all complex attributes in the response.",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "fields",
"in": "query",
"description": "Complex attributes of AppPkgInfo to be included into the response",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "exclude_fields",
"in": "query",
"description": "Complex attributes of AppPkgInfo to be excluded from the response.",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "exclude_default",
"in": "query",
"description": "Indicates to exclude the following complex attributes of AppPkgInfo from the response.",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Content of the AppD is returned.",
"headers": {},
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AppD",
"description": "Indicates the success of request, and the content of the AppD is returned.The response message content shall contain a copy of the file representing the AppD or a ZIP file that contains the file or multiple files representing the AppD.The \"Content-Type\" HTTP header shall be set according to the format of the returned file, which is selected according to \"Accept\" HTTP header options passed in the request."
}
},
"application/zip": {}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"429": {
"$ref": "#/components/responses/429"
}
},
"deprecated": false
},
"parameters": []
},
"/app_packages/{appPkgId}/package_content": {
"get": {
"tags": [
"app-pkgm"
],
"summary": "Fetch the onboarded application package content identified by appPkgId or appDId.",
"description": "Fetch the onboarded application package content identified by appPkgId or appDId.",
"operationId": "appPkgGET",
"parameters": [{
"name": "appPkgId",
"in": "path",
"description": "Identifier of an on-boarded individual application package",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}],
"responses": {
"200": {
"description": "The payload body shall contain a copy of the file representing the AppD or a ZIP file that contains the file or multiple files representing the AppD.",
"headers": {},
"content": {
"application/zip": {}
}
},
"206": {
"description": "On success, if the MEO or MEAO supports range requests, a single consecutive byte range from the content of the application package file shall be returned.",
"headers": {},
"content": {
"application/zip": {}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"429": {
"$ref": "#/components/responses/429"
}
},
"deprecated": false
},
"put": {
"tags": [
"app-pkgm"
],
"summary": "Uploads the content of application package.",
"description": "Uploads the content of application package.",
"operationId": "appPkgPUT",
"parameters": [{
"name": "appPkgId",
"in": "path",
"description": "Identifier of an on-boarded individual application package",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}],
"responses": {
"202": {
"description": "The application package has been accepted for uploading, but the processing has not been completed.",
"headers": {},
"content": {}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"429": {
"$ref": "#/components/responses/429"
}
},
"deprecated": false
},
"parameters": []
},
"/onboarded_app_packages/{appDId}/package_content": {
"get": {
"tags": [
"app-pkgm"
],
"summary": "Fetch the onboarded application package content identified by appPkgId or appDId.",
"description": "Fetch the onboarded application package content identified by appPkgId or appDId.",
"operationId": "appDIdGET",
"parameters": [{
"name": "appDId",
"in": "path",
"description": "Identifier of an application descriptor",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}],
"responses": {
"200": {
"description": "The payload body shall contain a copy of the file representing the AppD or a ZIP file that contains the file or multiple files representing the AppD.",
"headers": {},
"content": {}
},
"206": {
"description": "On success, if the MEO or MEAO supports range requests, a single consecutive byte range from the content of the application package file shall be returned.",
"headers": {},
"content": {}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"429": {
"$ref": "#/components/responses/429"
}
},
"deprecated": false
},
"put": {
"tags": [
"app-pkgm"
],
"summary": "Fetch the onboarded application package content identified by appPkgId or appDId.",
"description": "Uploads the content of application package.",
"operationId": "appDIdPUT",
"parameters": [{
"name": "appDId",
"in": "path",
"description": "Identifier of an application descriptor",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}],
"responses": {
"202": {
"description": "The application package has been accepted for uploading, but the processing has not been completed.",
"headers": {},
"content": {}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"429": {
"$ref": "#/components/responses/429"
}
},
"deprecated": false
},
"parameters": []
},
"/user_defined_notification": {
"post": {
"tags": [
"app-pkgm-notifications"
],
"summary": "Registers a notification endpoint to notify application package operations",
"description": "Registers a notification endpoint to notify application package operations",
"operationId": "app_pkg_notificationPOST",
"parameters": [],
"requestBody": {
"description": "Notification endpoint to be created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppPkgNotification"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "No Content",
"headers": {},
"content": {}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"429": {
"$ref": "#/components/responses/429"
}
},
"deprecated": false
},
"parameters": []
}
},
"components": {
"schemas": {
"AppD": {
"title": "AppD",
"required": [
"appDId",
"appDVersion",
"appDescription",
"appName",
"appProvider",
"appSoftVersion",
"mecVersion",
"swImageDescriptor",
"appExtCpd"
],
"type": "object",
"properties": {
"appDId": {
"type": "string",
"description": "Identifier of this MEC application descriptor. This attribute shall be globally unique. See note 1."
},
"appDNSRule": {
"type": "array",
"items": {
"$ref": "./definitions/MEC010p2_definitions.yaml#/definitions/DNSRuleDescriptor"
},
"description": "Describes DNS rules the MEC application requires."
},
"logicalNode": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LogicalNodeRequirements"
},
"description": "The logical node requirements. See note 6 and note 7."
},
"requestAdditionalCapabilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RequestedAdditionalCapabilityData"
},
"description": "Specifies requirements for additional capabilities. These can be for a range of purposes. One example is acceleration related capabilities. See note 6 and note 7."
},
"mcioConstraintParams": {
"type": "array",
"items": {
"$ref": "#/components/schemas/McioConstraintParams"
},
"description": "The parameter names for constraints expected to be assigned to MCIOs realizing this application. For the associated semantical context of the values, refer to the description under the table 7.1.6.2.2-1 of ETSI GS NFV IFA 011 [1]. See note 7."
},
"appDVersion": {
"type": "string",
"description": "Identifies the version of the application descriptor."
},
"appDescription": {
"type": "string",
"description": "Human readable description of the MEC application."
},
"appExtCpd": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AppExternalCpd"
},
"description": "Describes external interface(s) exposed by this MEC application. See note 4."
},
"appFeatureOptional": {
"type": "array",
"items": {
"$ref": "./definitions/MEC010p2_definitions.yaml#/definitions/FeatureDependency"
},
"description": "Describes features a MEC application may use if available."
},
"appFeatureRequired": {
"type": "array",
"items": {
"$ref": "./definitions/MEC010p2_definitions.yaml#/definitions/FeatureDependency"
},
"description": "Describes features a MEC application requires to run."
},
"appInfoName": {
"type": "string",
"description": "Human readable name for the MEC application."
},
"appLatency": {
"$ref": "./definitions/MEC010p2_definitions.yaml#/definitions/LatencyDescriptor"
},
"appName": {
"type": "string",
"description": "Name to identify the MEC application."
},
"appProvider": {
"type": "string",
"description": "Provider of the application and of the AppD."
},
"appServiceOptional": {
"type": "array",
"items": {
"$ref": "./definitions/MEC010p2_definitions.yaml#/definitions/ServiceDependency"
},
"description": "Describes services a MEC application may use if available."
},
"appServiceProduced": {
"type": "array",
"items": {
"$ref": "./definitions/MEC010p2_definitions.yaml#/definitions/ServiceDescriptor"
},
"description": "Describes services a MEC application is able to produce to the platform or other MEC applications. Only relevant for service-producing apps."
},
"appServiceRequired": {
"type": "array",
"items": {
"$ref": "./definitions/MEC010p2_definitions.yaml#/definitions/ServiceDependency"
},
"description": "Describes services a MEC application requires to run."
},
"appSoftVersion": {
"type": "string",
"description": "Identifies the version of software of the MEC application."
},
"mciopId": {
"type": "string",
"description": "Identifies the MCIOP in the application package, used in containerized workload management, when the application is realized by a set of OS containers. See note 7."
},
"mcioIdentificationData": {
"type": "string",
"description": "Name and type of the Managed Container Infrastructure Object (MCIO) that realizes this application. It allows the VNFM to identify the MCIO e.g. when querying the Container Infrastructure Service Management (CISM). See note 7.",
"items": {
"$ref": "#/components/schemas/McioIdentificationData"
}
},
"appTrafficRule": {
"type": "array",
"items": {
"$ref": "./definitions/MEC010p2_definitions.yaml#/definitions/TrafficRuleDescriptor"
},
"description": "Describes traffic rules the MEC application requires."
},
"changeAppInstanceStateOpConfig": {
"type": "string",
"$ref": "#/components/schemas/changeAppInstanceStateOpConfig"
},
"mecVersion": {
"type": "array",
"items": {
"type": "string"
},
"description": "Identifies version(s) of MEC system compatible with the MEC application described in this version of the AppD. The value shall be formatted as comma-separated list of strings. Each entry shall have the format <x>.<y>.<z> where <x>, <y> and <z> are decimal numbers representing the version of the present document. Whitespace between list entries shall be trimmed before validation."
},
"virtualStorageDescriptor": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualStorageDescriptor"
},
"description": "Defines descriptors of virtual storage resources to be used by the MEC application."
},
"userContextTransferCapability": {
"type": "string",
"$ref": "#/components/schemas/UserContextTransferCapability"
},
"appNetworkPolicy": {
"type": "string",
"$ref": "#/components/schemas/AppNetworkPolicy"
},
"swImageDescriptor": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SwImageDescriptor"
},
"description": "Describes the descriptors of the software image to be used by the virtualisation container used to realize this MEC application. See note 5."
},
"terminateAppInstanceOpConfig": {
"type": "string",
"$ref": "#/components/schemas/TerminateAppInstanceOpConfig"
},
"transportDependencies": {
"type": "object",
"items": {
"$ref": "./definitions/MEC010p2_definitions.yaml#/definitions/TransportDependency"
},
"description": "Transports, if any, that this application requires to be provided by the platform. These transports will be used by the application to deliver services provided by this application. Only relevant for service-producing apps. See note 2."
},
"virtualComputeDescriptor": {
"description": "Describes CPU and memory requirements, as well as optional additional requirements, such as disk and acceleration related capabilities, of the single VM used to realize this MEC application. See note 5.",
"type": "object",
"items": {
"$ref": "#/components/schemas/VirtualComputeDescriptor"
}
},
"osContainerDescriptor": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OsContainerDescriptor"
},
"description": "Describes CPU, memory requirements and limits, and software images of the OS Containers realizing this MEC application corresponding to OS Containers sharing the same host and same network namespace. See note 5 and note 7."
}
},
"description": "NOTE 1: The appDId shall be used as the unique identifier of the application package that contains this AppD.\nNOTE 2: This attribute indicates groups of transport bindings which a service-producing MEC application requires to \n be supported by the platform in order to be able to produce its services. At least one of the indicated groups \n needs to be supported to fulfil the requirements.\nNOTE 3: The support of application descriptor containing descriptions of multiple virtualisation containers and/or \n application software images is out of scope of the present document.\nNOTE 4: External interfaces are used to connect to e.g. other MEC applications, MEC services, UEs and also MEC \n platform and OSS.\nNOTE 5: Only one of virtualComputeDescriptor or osContainerDescriptor shall be present. If virtualComputeDescriptor \n presents, only a single swImageDescriptor shall be provided. \nNOTE 6: If the AppD includes virtualComputeDesc, then logicalNode and requestedAdditionalCapabilites shall not be \n present.\nNOTE 7: This attribute reflects the ETSI NFV interpretation of the cloud native workloads. \n"
},
"changeAppInstanceStateOpConfig": {
"type": "object",
"description": "This information element defines attributes that affect the invocation of the OperateVnf operation.\n",
"required": [
"minGracefulStopTimeout"
],
"properties": {
"minGracefulStopTimeout": {
"type": "number",
"description": "Minimum timeout value for graceful stop of a VNF instance."
},
"maxRecommendedGracefulStopTimeout": {
"type": "number",
"description": "Maximum recommended timeout value that can be needed to gracefully stop a VNF instance of a particular type under certain conditions, such as maximum load condition. This is provided by VNF provider as information for the operator facilitating the selection of optimal timeout value. This value is not used as constraint. \n"
},
"parameter": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of KVP requirements for VNF-specific parameters to be passed when invoking the OperateVnf operation. See note.\n"
}
}
},
"AppNetworkPolicy": {
"type": "object",
"properties": {
"steeredNetwork": {
"type": "object",
"properties": {
"cellularNetwork": {
"type": "boolean",
"description": "If present and the application prefers to use a cellular network, set to true. Otherwise, set to false."
},
"wi-fiNetwork": {
"type": "boolean",
"description": "If present and the application prefers to use a Wi-Fi network, set to true. Otherwise, set to false."
},
"fixedAccessNetwork": {
"type": "boolean",
"description": "If present and the application prefers to use a fixed access network, set to true. Otherwise, set to false."
}
},
"description": "Option for the application to specify a type of network to carry its traffic."
}
},
"required": [
"steeredNetwork"
],
"description": "Network policy in the application instantiation and operation."
},
"UserContextTransferCapability": {
"type": "object",
"properties": {
"statefulApplication": {
"type": "boolean",
"description": "If the application is stateful, this attribute shall be set to true. Otherwise, set to false."
},
"userContextTransferSupport": {
"type": "boolean",
"description": "This attribute shall be present if the application is stateful and absent otherwise. If the application supports user context transfer, set to true. Otherwise, set to false."
}
},
"required": [
"statefulApplication"
],
"description": "Information about user context transfer capability of the application."
},
"VirtualStorageDescriptor": {
"type": "object",
"description": "Defines descriptors of virtual storage resources to be used by the MEC application.",
"required": [
"id",
"typeOfStorage"
],
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of this VirtualStorageDesc in the VNFD."
},
"typeOfStorage": {
"type": "string",
"enum": [
"BLOCK",
"OBJECT",
"FILE"
],
"description": "Type of virtualized storage resource."
},
"blockStorageData": {
"$ref": "#/components/schemas/BlockStorageData",
"description": "Details of block storage. Required when typeOfStorage is set to \"BLOCK\"."
},
"objectStorageData": {
"$ref": "#/components/schemas/ObjectStorageData",
"description": "Details of object storage. Required when typeOfStorage is set to \"OBJECT\"."
},
"fileStorageData": {
"$ref": "#/components/schemas/FileStorageData",
"description": "Details of file storage. Required when typeOfStorage is set to \"FILE\"."
},
"nfviMaintenanceInfo": {
"$ref": "#/components/schemas/NfviMaintenanceInfo",
"description": "Information on NFVI operation and maintenance rules for instances based on this VirtualStorageDesc."
},
"perVnfcInstance": {
"type": "boolean",
"description": "Indicates whether the virtual storage resource should be instantiated per VNFC instance."
}
}
},
"NfviMaintenanceInfo": {
"type": "object",
"properties": {
"impactNotificationLeadTime": {
"type": "number",
"description": "The minimum notification lead time requested for upcoming impact of the virtualised resource or their group."
},
"isImpactMitigationRequested": {
"type": "boolean",
"description": "Indicates if it is requested to provide virtualised resource(s) of the same characteristics as the impacted ones to compensate for the impact."
},
"supportedMigrationType": {
"type": "array",
"items": {
"type": "string",
"enum": [
"NO_MIGRATION",
"OFFLINE_MIGRATION",
"LIVE_MIGRATION"
]
},
"description": "Specifies the allowed migration types in order of preference in case of an impact."
},
"maxUndetectableInterruptionTime": {
"type": "number",
"description": "Specifies the maximum interruption time that can go undetected at the VNF level during live migration."
},
"minRecoveryTimeBetweenImpacts": {
"type": "number",
"description": "Specifies the time required by the group to recover from an impact, indicating the minimum time between consecutive impacts of the group."
},
"maxNumberOfImpactedInstances": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MaxNumberOfImpactedInstances"
},
"description": "Specifies the maximum number of instances that can be impacted simultaneously within the group of virtualised resources for different group sizes."
},
"minNumberOfPreservedInstances": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MinNumberOfPreservedInstances"
},
"description": "Specifies the minimum number of instances which need to be preserved simultaneously within the group of virtualised resources for different group sizes."
}
}
},
"MaxNumberOfImpactedInstances": {
"type": "object",
"properties": {
"groupSize": {
"type": "integer",
"description": "Determines the size of the group for which the maxNumberOfImpactedInstances is specified."
},
"maxNumberOfImpactedInstances": {
"type": "integer",
"description": "The maximum number of instances that can be impacted simultaneously within the group of the specified size."
}
}
},
"MinNumberOfPreservedInstances": {
"type": "object",
"properties": {
"groupSize": {
"type": "integer",
"description": "Determines the size of the group for which the minNumberOfPreservedInstances is specified."
},
"minNumberOfPreservedInstances": {
"type": "integer",
"description": "The minimum number of instances which need to be preserved simultaneously within the group of the specified size."
}
}
},
"ObjectStorageData": {
"type": "object",
"properties": {
"maxSizeOfStorage": {
"type": "number",
"description": "Maximum size of virtualized storage resource in GB."
}
}
},
"FileStorageData": {
"type": "object",
"properties": {
"sizeOfStorage": {
"type": "number",
"description": "Size of virtualized storage resource in GB."
},
"fileSystemProtocol": {
"type": "string",
"description": "The shared file system protocol (e.g. NFS, CIFS)."
},
"intVirtualLinkDesc": {
"$ref": "#/components/schemas/VnfVirtualLinkDesc",
"description": "Reference of the internal VLD which this file storage connects to."
}
}
},
"VirtualLinkDescFlavour": {
"type": "object",
"properties": {
"flavourId": {
"type": "string",
"description": "Identifies a flavour within a VnfVirtualLinkDesc."
},
"qos": {
"$ref": "#/components/schemas/QoS",
"description": "QoS of the VL."
}
},
"required": [
"flavourId"
]
},
"QoS": {
"type": "object",
"properties": {
"latency": {
"type": "number",
"description": "Specifies the maximum latency in ms."
},
"packetDelayVariation": {
"type": "number",
"description": "Specifies the maximum jitter in ms."
},
"packetLossRatio": {
"type": "number",
"description": "Specifies the maximum packet loss ratio."
}
},
"required": [
"latency",
"packetDelayVariation"
]
},
"ConnectivityType": {
"type": "object",
"properties": {
"layerProtocol": {
"type": "array",
"description": "Specifies the protocols that the VL uses.",
"items": {
"type": "string",
"enum": [
"Ethernet",
"MPLS",
"ODU2",
"IPV4",
"IPV6",
"Pseudo-Wire",
"Etc"
]
},
"minItems": 1
},
"flowPattern": {
"type": "string",
"description": "Specifies the flow pattern of the connectivity (Line, Tree, Mesh, etc.)."
}
},
"required": [
"layerProtocol"
]
},
"VnfVirtualLinkDesc": {
"type": "object",
"properties": {
"virtualLinkDescId": {
"type": "string",
"description": "Unique identifier of this internal VLD in VNFD."
},
"virtualLinkDescFlavour": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualLinkDescFlavour"
},
"description": "Describes a specific flavour of the VL with specific bitrate requirements."
},
"connectivityType": {
"$ref": "#/components/schemas/ConnectivityType",
"description": "See clause 7.1.7.3."
},
"testAccess": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies test access facilities expected on the VL."
},
"description": {
"type": "string",
"description": "Provides human-readable information on the purpose of the VL."
},
"monitoringParameter": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MonitoringParameter"
},
"description": "Specifies the virtualised resource related performance metrics on VLD level to be tracked by the VNFM."
},
"nfviMaintenanceInfo": {
"$ref": "#/components/schemas/NfviMaintenanceInfo",
"description": "Provides information on the rules to be observed when an instance based on this VnfVirtualLinkDesc is impacted during NFVI operation and maintenance."
},
"externallyManaged": {
"type": "string",
"enum": [
"REQUIRED",
"ALLOWED"
],
"default": "ALLOWED",
"description": "Specifies the intent of the VNF designer with respect to the internal VL instances created from this descriptor being externally managed."
}
}
},
"TerminateAppInstanceOpConfig": {
"type": "object",
"description": "This information element defines attributes that affect the invocation of the TerminateVnf operation.\n",
"required": [
"minGracefulTerminationTimeout"
],
"properties": {
"minGracefulTerminationTimeout": {
"type": "number",
"description": "Minimum timeout value for graceful stop of a VNF instance."
},
"maxRecommendedGracefulTerminationTimeout": {
"type": "number",
"description": "Maximum recommended timeout value that can be needed to gracefully terminate a VNF instance of a particular type under certain conditions, such as maximum load condition. This is provided by VNF provider as information for the operator facilitating the selection of optimal timeout value. This value is not used as constraint. \n"
},
"parameter": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of KVP requirements for VNF-specific parameters to be passed when invoking the TerminateVnf operation. See note. \n"
}
}
},
"SwImageDescriptor": {
"type": "object",
"required": [
"id",
"name",
"version",
"containerFormat",
"swImage"
],
"properties": {
"id": {
"type": "string",
"description": "The identifier of this software image."
},
"name": {
"type": "string",
"description": "The name of this software image."
},
"version": {
"type": "string",
"items": {
"$ref": "#/components/schemas/Version"
},
"description": "The version of this software image."
},
"checksum": {
"$ref": "#/components/schemas/ChecksumData",
"description": "The checksum of the software image file. See note 3."
},
"containerFormat": {
"type": "string",
"description": "The container format describes the container file format in which software image is provided."
},
"diskFormat": {
"type": "string",
"description": "The disk format of a software image is the format of the underlying disk image. See note 1."
},
"minDisk": {
"type": "number",
"description": "The minimal disk size requirement for this software image. See note 1."
},
"minRam": {
"type": "number",
"description": "The minimal RAM requirement for this software image. See note 2."
},
"size": {
"type": "number",
"description": "The size of this software image file. See note 3."
},
"swImage": {
"type": "object",
"items": {
"$ref": "#/components/schemas/SwImageDesc"
},
"description": "A reference to the actual software image."
},
"operatingSystem": {
"type": "string",
"description": "Specifies the operating system used in the software image."
},
"supportedVirtualisationEnvironment": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the virtualisation environments (e.g. hypervisor) compatible with this software image."
}
},
"description": "NOTE 1: The attribute shall be present for VM-based software images referenced from a Vdu or from a VirtualStorageDesc, and shall be absent otherwise. \nNOTE 2: The attribute may be present for VM-based software images referenced from a Vdu or from a VirtualStorageDesc, and shall be absent otherwise. \nNOTE 3: The attribute shall be present for VM-based software images referenced from a Vdu or from a VirtualStorageDesc, and may be present otherwise. \n"
},
"Version": {
"type": "object",
"required": [
"srcVnfdId",
"dstVnfdId",
"srcFlavourId"
],
"properties": {
"srcVnfdId": {
"type": "string",
"description": "Identifier of the source VNFD and the source VNF package. See note 1."
},
"dstVnfdId": {
"type": "string",
"description": "Identifier of the destination VNFD and the destination VNF package. See note 1."
},
"srcFlavourId": {
"type": "string",
"description": "Identifier of the deployment flavour in the source VNF package for which this modification applies. See note 2."
}
},
"description": "NOTE 1: Either the srcVnfdId or the dstVnfdId shall be equal to the vnfdId of the VNFD containing this version selector. \nNOTE 2: It is up to protocol design stage to decide whether there is further optimization potential to apply one modification for multiple srcFlavourIds.\n"
},
"McioConstraintParams": {
"title": "McioConstraintParams",
"enum": [
"localAffinityCisNode",
"nodeAdditionalCapabilitySsd",
"nodeAdditionalCapabilityDpdk",
"nodeAdditionalCapabilitySriov",
"nodeAdditionalCapabilityGpu",
"nodeAdditionalCapabilityFpga",
"nodeAdditionalCapabilityCpuPin",
"nodeCapabilityLogicalNuma",