SOL005NSLifecycleManagement_def.yaml 157 KB
Newer Older
1001
          $ref: "#/definitions/IdentifierInVnf"
1002
1003
1004
1005
1006
1007
1008
1009
1010
      pnfExtCpIds:
        description: >
          Identifier(s) of the PNF CP(s) which form the pair.
          The presence of a single vnfExpCpId, pnfExtCpId, or sapId occurrence indicates 
          that the CP or SAP is used both as an ingress and egress port at a particular 
          NFP position.
        type: array
        maxItems: 2
        items:
1011
          $ref: "#/definitions/IdentifierInPnf"
1012
1013
1014
1015
1016
1017
1018
1019
1020
      sapIds:
        description: >
          Identifier(s) of the SAP(s) which form the pair.
          The presence of a single vnfExpCpId, pnfExtCpId, or sapId occurrence indicates 
          that the CP or SAP is used both as an ingress and egress port at a particular 
          NFP position.
        type: array
        maxItems: 2
        items:
1021
          $ref: "#/definitions/IdentifierInNs"
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
  ForwardingBehaviourInputParameters:
    description: >
      This type represents provides input parameters to configure the forwarding behaviour. 
      It shall comply with the provisions defined in Table 6.5.3.73-1.
    type: object
    properties:
      algortihmName:
        description: >
          May be included if forwarding behaviour is equal to LB. Shall not be included otherwise.
          Permitted values:
          * ROUND_ROBIN
          * LEAST_CONNECTION
          * LEAST_TRAFFIC
          * LEAST_RESPONSE_TIME
          * CHAINED_FAILOVER
          * SOURCE_IP_HASH
          * SOURCE_MAC_HASH
        type: string
        enum:
          - ROUND_ROBIN
          - LEAST_CONNECTION
          - LEAST_TRAFFIC
          - LEAST_RESPONSE_TIME
          - CHAINED_FAILOVER
          - SOURCE_IP_HASH
1048
          - SOURCE_MAC_HASH
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
      algorithmWeights:
        description: >
          Percentage of messages sent to a CP instance. May be included if applicable to 
          the algorithm.
          If applicable to the algorithm but not provided, default values determined by 
          the VIM or NFVI are expected to be used.
          Weight applies to the CP instances in the order they have been created.
        type: array
        items:
          type: integer

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
  CpProtocolInfo:
    description: >
      This type describes the protocol layer(s) that a CP or SAP uses together with protocol-related information, like
      addresses. It shall comply with the provisions defined in Table 6.5.3.58-1.
    type: object
    required:
      - layerProtocol
      - ipOverEthernet
    properties:
      layerProtocol:
        description: >
          The identifier of layer(s) and protocol(s)
          associated to the network address information.
          Permitted values: IP_OVER_ETHERNET See note.
        type: string
        enum:
          - IP_OVER_ETHERNET
      ipOverEthernet:
        description: >
          IP addresses over Ethernet to assign to the CP
          or SAP instance. Shall be present if
          layerProtocol is equal to "
          IP_OVER_ETHERNET", and shall be absent otherwise.
        $ref: "#/definitions/IpOverEthernetAddressInfo"

  IpOverEthernetAddressInfo:
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
    description: >
      This type represents information about a network address that has been assigned.
      It shall comply with the provisions defined in Table 6.5.3.18-1.
    type: object
    required:
      - macAddress
      - ipAddresses
      - subnetId
      - addresses
      - addressRange
    properties:
      macAddress:
        description: >
          Assigned MAC address.
1100
        $ref: "#/definitions/MacAddress"
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
      ipAddresses:
        description: >
          Addresses assigned to the CP instance. Each entry represents IP
          addresses assigned by fixed or dynamic IP address assignment per
          subnet.
        type: array
        items:
          type: object
          required:
            - type
          properties:
            type:
              description: >
                The type of the IP addresses.
                Permitted values: IPV4, IPV6.
              type: string
              enum:
                - IPV4
                - IPV6
            addresses:
              description: >
                Fixed addresses assigned (from the subnet defined by
                "subnetId" if provided).
              type: array
              items:
1126
                $ref: "#/definitions/IpAddress"
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
            isDynamic:
              description: >
                Indicates whether this set of addresses was assigned
                dynamically (true) or based on address information provided as
                input from the API consumer (false). Shall be present if
                "addresses" is present and shall be absent otherwise.
              type: boolean
            addressRange:
              description: >
                An IP address range used, e.g., in case of egress connections.
                Exactly one of "addresses" or "addressRange" shall be present.
              type: object
              required:
                - minAddress
                - maxAddress
              properties:
                minAddress:
                  description: >
                    Lowest IP address belonging to the range.
1146
                  $ref: "#/definitions/IpAddress"
1147
1148
1149
                maxAddress:
                  description: >
                    Highest IP address belonging to the range
1150
                  $ref: "#/definitions/IpAddress"
1151
1152
1153
1154
1155
1156
            subnetId:
              description: >
                Subnet defined by the identifier of the subnet resource in
                the VIM.
                In case this attribute is present, IP addresses are bound
                to that subnet.
1157
              $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVim"
Samir Medjiah's avatar
Samir Medjiah committed
1158
1159


1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
      type:
        description: >
          The type of the IP addresses
        type: string
        enum:
          - PV4
          - PV6
      addresses:
        description: >
          Fixed addresses assigned (from the subnet
          defined by "subnetId" if provided). See note.
        type: array
        items:
1173
        $ref: "#/definitions/IpAddress"
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
      isDynamic:
        description: >
          Indicates whether this set of addresses was
          assigned dynamically (true) or based on address
          information provided as input from the API
          consumer (false). Shall be present if "addresses"
          is present and shall be absent otherwise.
        type: boolean
      addressRange:
        description: >
          An IP address range used, e.g. in case of egress
          connections. See note.
        type: object
        required:
          - minAddress
          - maxAddress
        properties:
          minAddress:
            description: >
              Lowest IP address belonging to the range.
1194
            $ref: "#/definitions/IpAddress"
1195
1196
1197
          maxAddress:
            description: >
              Highest IP address belonging to the range
1198
            $ref: "#/definitions/IpAddress"
1199
1200
1201
      minAddress:
        description: >
          Lowest IP address belonging to the range
1202
        $ref: "#/definitions/IpAddress"
1203
1204
1205
      maxAddress:
        description: >
          Highest IP address belonging to the range.
1206
        $ref: "#/definitions/IpAddress"
1207
1208
1209
1210
1211
1212
      subnetId:
        description: >
          Subnet defined by the identifier of the subnet
          resource in the VIM.
          In case this attribute is present, IP addresses
          are bound to that subnet.
1213
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVim"
1214

1215
1216
1217
1218
1219
1220
1221
  ExtVirtualLinkInfo:
    type: object
    required:
      - id
      - resourceHandle
    properties:
      id:
1222
1223
1224
1225
1226
        description: >
          Identifier of the external VL and the related external VL
          information instance.
          The identifier is assigned by the NFV-MANO entity that manages this
          VL instance.
1227
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
1228
1229
1230
      resourceHandle:
        description: >
          Reference to the resource realizing this VL.
1231
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
      extLinkPorts:
        description: >
          Link ports of this VL.
        type: array
        items:
          $ref: "#/definitions/ExtLinkPortInfo"

  ExtLinkPortInfo:
    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: >
          Identifier of this link port as provided by the entity that has
          created the link port.
1252
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
1253
1254
1255
      resourceHandle:
        description: >
          Reference to the virtualised resource realizing this link port.
1256
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
1257
1258
1259
1260
1261
1262
      cpInstanceId:
        description: >
          Identifier of the external CP of the VNF connected to this link
          port. There shall be at most one link port associated with any
          external connection point instance. The value refers to an
          "extCpInfo" item in the VnfInstance.
1263
        $ref: "#/definitions/IdentifierInVnf"
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276

  ExtManagedVirtualLinkInfo:
    type: object
    required:
      - id
      - vnfVirtualLinkDescId
    properties:
      id:
        description: >
          Identifier of the externally-managed internal VL and the related
          externally-managed VL information instance.
          The identifier is assigned by the NFV-MANO entity that manages this
          VL instance.
1277
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
1278
1279
1280
      vnfVirtualLinkDescId:
        description: >
          Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.
1281
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
1282
1283
1284
      networkResource:
        description: >
          Reference to the VirtualNetwork resource.
1285
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
      vnfLinkPorts:
        description: >
          Link ports of this VL.
        type: array
        items:
          $ref: "#/definitions/VnfLinkPortInfo"

  VnfLinkPortInfo:
    type: object
    required:
      - id
      - resourceHandle
    properties:
      id:
        description: >
          Identifier of this link port as provided by the entity that has created the link port.
1302
        $ref: "#/definitions/IdentifierInVnf"
1303
1304
1305
      resourceHandle:
        description: >
          Reference to the virtualised network resource realizing this link port.
1306
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
      cpInstanceId:
        description: >
          When the link port is used for external connectivity by the VNF,
          this attribute represents the identifier of the external CP of the
          VNF to be connected to this link port.
          When the link port is used for internal connectivity in the VNF,
          this attribute represents the VNFC CP to be connected to this link
          port.
          Shall be present when the link port is used for external
          connectivity by the VNF.
          may be present if used to reference a VNFC CP instance.
          There shall be at most one link port associated with any external
          connection point instance or internal connection point
          (i.e. VNFC CP) instance.
          The value refers to an "extCpInfo" item in the VnfInstance or a
          "vnfcCpInfo" item of a "vnfcResouceInfo" item in the VnfInstance.
1323
        $ref: "#/definitions/IdentifierInVnf"
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
      cpInstanceType:
        description: >
          Type of the CP instance that is identified by cpInstanceId.
          Shall be present if "cpInstanceId" is present, and shall be
          absent otherwise.
          Permitted values:
          * VNFC_CP: The link port is connected to a VNFC CP
          * EXT_CP: The link port is associated to an external CP.
        type: string
        enum:
          - VNFC_CP
          - EXT_CP
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346

  MonitoringParameter:
    type: object
    required:
      - id
      - value
      - timeStamp
    properties:
      id:
        description: >
          Identifier of the monitoring parameter defined in the VNFD.
1347
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
1348
1349
1350
1351
1352
1353
1354
      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
1355
          for auto-scaling purposes).
1356
1357
1358
1359
          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.
        type: object
1360
1361
1362
1363
1364
1365
      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
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379

  VnfcResourceInfo:
    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
    properties:
      id:
        description: >
          Identifier of this VnfcResourceInfo instance.
1380
        $ref: "#/definitions/IdentifierInVnf"
1381
1382
1383
      vduId:
        description: >
          Reference to the applicable VDU in the VNFD.
1384
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
1385
1386
1387
      computeResource:
        description: >
          Reference to the VirtualCompute resource.
1388
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
1389
1390
1391
1392
1393
1394
      storageResourceIds:
        description: >
          References to the VirtualStorage resources. The value refers to a
          VirtualStorageResourceInfo item in the VnfInstance.
        type: array
        items:
1395
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
1396
1397
1398
1399
      reservationId:
        description: >
          The reservation identifier applicable to the resource. It shall be
          present when an applicable reservation exists.
1400
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
      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: >
                Identifier of this VNFC CP instance and the associated array
                entry.
1418
              $ref: "#/definitions/IdentifierInVnf"
1419
1420
1421
            cpdId:
              description: >
                Identifier of the VDU CPD, cpdId, in the VNFD.
1422
              $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
1423
1424
1425
1426
            vnfExtCpId:
              description: >
                When the VNFC CP is exposed as external CP of the VNF, the
                identifier of this external VNF CP.
1427
              $ref: "#/definitions/IdentifierInVnf"
1428
1429
1430
1431
1432
1433
1434
1435
1436
            cpProtocolInfo:
              description: >
                Network protocol information for this CP.
              type: array
              items:
                $ref: "#/definitions/CpProtocolInfo"
            vnfLinkPortId:
              description: >
                Identifier of the "vnfLinkPorts" structure in the
1437
                "VnfVirtualLinkResourceInfo" structure. Shall be present if
1438
                the CP is associated to a link port.
1439
              $ref: "#/definitions/IdentifierInVnf"
1440
1441
1442
            metadata:
              description: >
                Metadata about this CP.
1443
              $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
1444
1445
1446
      metadata:
        description: >
          Metadata about this resource.
1447
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
1448
1449

  VnfVirtualLinkResourceInfo:
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
    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
      - vnfVirtualLinkDescId
      - networkResource
    properties:
      id:
        description: >
          Identifier of this VnfVirtualLinkResourceInfo instance.
1462
        $ref: "#/definitions/IdentifierInVnf"
1463
1464
1465
      vnfVirtualLinkDescId:
        description: >
          Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.
1466
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
1467
1468
1469
      networkResource:
        description: >
          Reference to the VirtualNetwork resource.
1470
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
1471
1472
1473
1474
      reservationId:
        description: >
          The reservation identifier applicable to the resource. It shall be
          present when an applicable reservation exists.
1475
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
      vnfLinkPorts:
        description: >
          Links ports of this VL.
          Shall be present when the linkPort is used for external connectivity
          by the VNF (refer to VnfLinkPortInfo).
          May be present otherwise.
        type: array
        items:
          $ref: "#/definitions/VnfLinkPortInfo"
      metadata:
        description: >
          Metadata about this resource.
1488
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
1489

1490
  VirtualStorageResourceInfo:
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
    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: >
          Identifier of this VirtualStorageResourceInfo instance.
1503
        $ref: "#/definitions/IdentifierInVnf"
1504
1505
1506
      virtualStorageDescId:
        description: >
          Identifier of the VirtualStorageDesc in the VNFD.
1507
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
1508
1509
1510
      storageResource:
        description: >
          Reference to the VirtualStorage resource.
1511
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
1512
1513
1514
1515
      reservationId:
        description: >
          The reservation identifier applicable to the resource. It shall be
          present when an applicable reservation exists.
1516
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
1517
1518
1519
      metadata:
        description: >
          Metadata about this resource.
1520
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
1521

1522
  NsLinkPortInfo:
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
    description: >
      This type represents information about a link port of a VL instance.
      It shall comply with the provisions defined in Table 6.5.3.55-1.
    type: object
    required:
      - id
      - resourceHandle
    properties:
      id:
        description: >
          Identifier of this link port as provided by the entity that
          has created the link port.
1535
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
1536
1537
1538
1539
      resourceHandle:
        description: >
          Identifier of the virtualised network resource realizing
          this link port.
1540
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
      nsCpHandle:
        description: >
          Identifier of the CP/SAP instance to be connected to this
          link port. The value refers to a vnfExtCpInfo item in the
          VnfInstance, or a pnfExtCpInfo item in the PnfInfo, or a
          sapInfo item in the NS instance.
          There shall be at most one link port associated with any
          connection point instance.
        type: array
        items:
          $ref: "#/definitions/NsCpHandle"

1553
  AffinityOrAntiAffinityRule:
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
    description: >
      This type describes the additional affinity or anti-affinity rule
      applicable between the VNF instances to be instantiated
      in the NS instantiation operation request or between the VNF instances
      to be instantiated in the NS instantiation
      operation request and the existing VNF instances..
    type: object
    required:
      - affinityOrAntiAffiinty
      - scope
    properties:
      vnfdId:
        description: >
          Reference to a VNFD.
          When the VNFD which is not used to instantiate VNF, it
          presents all VNF instances of this type as the subjects
          of the affinity or anti-affinity rule. The VNF instance
          which the VNFD presents is not necessary as a part of
          the NS to be instantiated.
        type: array
        items:
1575
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
      vnfProfileId:
        description: >
          Reference to a vnfProfile defined in the NSD.
          At least one VnfProfile which is used to instantiate VNF
          for the NS to be instantiated as the subject of the affinity
          or anti-affinity rule shall be present. When the VnfProfile
          which is not used to instantiate VNF, it presents all VNF
          instances of this type as the subjects of the affinity or
          anti-affinity rule. The VNF instance which the VnfProfile
          presents is not necessary as a part of the NS to be instantiated.
        type: array
        items:
1588
          $ref: "#/definitions/IdentifierInNsd"
1589
1590
1591
1592
1593
1594
1595
      vnfInstanceId:
        description: >
          Reference to the existing VNF instance as the subject of
          the affinity or anti-affinity rule. The existing VNF instance
          is not necessary as a part of the NS to be instantiated.
        type: array
        items:
1596
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
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
      affinityOrAntiAffiinty:
        description: >
          The type of the constraint.
          Permitted values:
          AFFINITY
          ANTI_AFFINITY.
        type: string
        enum:
          - AFFINITY
          - ANTI_AFFINITY
      scope:
        description: >
          Specifies the scope of the rule where the placement
          constraint applies.
          Permitted values:
          NFVI_POP
          ZONE
          ZONE_GROUP
          NFVI_NODE.
        type: string
        enum:
          - NFVI_POP
          - ZONE
          - ZONE_GROUP
          - NFVI_NODE
1622
1623
1624
1625

  InstantiateNsRequest:
    type: object
    required:
1626
      - nsFlavourId
1627
1628
1629
1630
    properties:
      nsFlavourId:
        description: >
          Identifier of the NS deployment flavor to be instantiated.
1631
        $ref: "#/definitions/IdentifierInNsd"
1632
1633
      sapData:
        description: >
1634
          Create data concerning the SAPs of this NS.
1635
        type: array
1636
1637
        items:
          $ref: "#/definitions/SapData"
1638
1639
1640
1641
      addpnfData:
        description: >
          Information on the PNF(s) that are part of this NS.
        type: array
1642
1643
        items:
          $ref: "#/definitions/AddPnfData"
1644
1645
1646
1647
1648
      vnfInstanceData:
        description: >
          Specify an existing VNF instance to be used in the NS.
          If needed, the VNF Profile to be used for this VNF
          instance is also provided.
1649
1650
          The DF of the VNF instance shall match the VNF DF 
          present in the associated VNF Profile.
1651
        type: array
1652
        items:
1653
          $ref: "#/definitions/VnfInstanceData"
1654
      nestedNsInstanceData:
1655
1656
1657
        description: >
          Specify an existing NS instance to be used as a nested
          NS within the NS.
1658
1659
1660
1661
1662
1663
1664
1665
          If needed, the NS Profile to be used for this nested NS 
          instance is also provided.
          NOTE 2: The NS DF of each nested NS shall be one of the 
          allowed flavours in the associated NSD (as referenced in the
          nestedNsd attribute of the NSD of the NS to be instantiated).
          NOTE 3: The NSD of each referenced NSs (i.e. each 
          nestedInstanceId) shall match the one of the nested NSD in 
          the composite NSD.
1666
        type: array
1667
        items:
1668
          $ref: "#/definitions/NestedNsInstanceData"
1669
1670
1671
1672
1673
1674
1675
      localizationLanguage:
        description: >
          Defines the location constraints for the VNF to be
          instantiated as part of the NS instantiation.
          An example can be a constraint for the VNF to be in a
          specific geographic location..
        type: array
1676
1677
        items:
          $ref: "#/definitions/VnfLocationConstraint"
1678
1679
1680
      additionalParamsForNs:
        description: >
          Allows the OSS/BSS to provide additional parameter(s)
1681
1682
1683
1684
          at the composite NS level (as opposed to the VNF level, 
          which is covered in additionalParamsForVnf), and as 
          opposed to the nested NS level, which is covered in
          additionalParamForNestedNs.
1685
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
1686
      additionalParamForNestedNs:
1687
1688
        description: >
          Allows the OSS/BSS to provide additional parameter(s)
1689
1690
1691
1692
          per nested NS instance (as opposed to the composite NS
          level, which is covered in additionalParamForNs, and as
          opposed to the VNF level, which is covered in
          additionalParamForVnf). This is for nested NS instances
1693
          that are to be created by the NFVO as part of the NS
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
          instantiation and not for existing nested NS instances that
          are referenced for reuse.
        type: array
        items:
          $ref: "#/definitions/ParamsForNestedNs"
      additionalParamsForVnf:
        description: >
          Allows the OSS/BSS to provide additional parameter(s)
          per VNF instance (as opposed to the composite NS level, 
          which is covered in additionalParamsForNs and as opposed 
          to the nested NS level, which is covered in 
          additionalParamForNestedNs). This is for VNFs that are 
          to be created by the NFVO as part of the NS instantiation 
          and not for existing VNF that are referenced for reuse.
1708
        type: array
1709
1710
        items:
          $ref: "#/definitions/ParamsForVnf"
1711
1712
1713
1714
      startTime:
        description: >
          Timestamp indicating the earliest time to instantiate the NS. 
          Cardinality "0" indicates the NS instantiation takes place immediately.
1715
        $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
1716
1717
1718
1719
1720
1721
      nsInstantiationLevelId:
        description: >
          Identifies one of the NS instantiation levels declared in
          the DF applicable to this NS instance. If not present, the
          default NS instantiation level as declared in the NSD
          shall be used.
1722
        $ref: "#/definitions/IdentifierInNsd"
1723
      additionalAffinityOrAntiAffinityRule:
1724
        description: >
1725
1726
1727
1728
          Specifies additional affinity or anti-affinity constraint for
          the VNF instances to be instantiated as part of the NS
          instantiation.
          Shall not conflict with rules already specified in the NSD.
1729
        type: array
1730
        items:
1731
1732
          $ref: "#/definitions/AffinityOrAntiAffinityRule"

1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
  ParamsForNestedNs:
    description: >
      This type specifies additional parameters on a per-nested NS instance basis. 
      It shall comply with the provisions defined in Table 6.5.3.21a-1.
    type: object
    required:
      - nsProfileId
    properties:
      nsProfileId:
        description: >
          Identifier of a NsProfile to which the additional parameters apply.
1744
        $ref: "#/definitions/IdentifierInNsd"
1745
1746
1747
1748
1749
      additionalParam:
        description: >
          Additional parameters that are to be applied on a per nested NS instance.
        type: array
        items:
1750
          $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
1751

1752
  ParamsForVnf:
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
    description: >
      This type defines the additional parameters for the VNF instance
      to be created associated with an NS instance.
      It shall comply with the provisions defined in Table 6.5.3.22-1.
    type: object
    required:
      - vnfProfileId
    properties:
      vnfProfileId:
        description: >
          Identifier of (reference to) a vnfProfile to which the
          additional parameters apply.
1765
        $ref: "#/definitions/IdentifierInNsd"
1766
1767
1768
1769
      additionalParams:
        description: >
          Additional parameters that are applied for the VNF
          instance to be created.
1770
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
1771

1772
  LocationConstraints:
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
    description: >
      This type represents location constraints for a VNF to be instantiated.
      The location constraints shall be presented as a
      country code, optionally followed by a civic address based on
      the format defined by IETF RFC 4776 [13].
    type: object
    required:
      - countryCode
    properties:
      countryCode:
        description: >
          The two-letter ISO 3166 [29] country code in capital letters.
        type: string
      civicAddressElement:
        description: >
          Zero or more elements comprising the civic address.
        type: array
        items:
          type: object
          required:
            - caType
            - caValue
          properties:
            caType:
              description: >
                Describe the content type of caValue. The value of
                caType shall comply with Section 3.4 of IETF
                RFC 4776 [13].
              type: integer
            caValue:
              description: >
                Content of civic address element corresponding to the
                caType. The format caValue shall comply with
                Section 3.4 of IETF RFC 4776 [13].
              type: string

1809
  VnfLocationConstraint:
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
    description: >
      This type represents the association of location constraints to a VNF instance
      to be created according to a specific VNF profile.
      It shall comply with the provisions defined in Table 6.5.3.20-1.
    type: object
    required:
      - vnfProfileId
    properties:
      vnfProfileId:
        description: >
          Identifier of (reference to) a vnfProfile to which the
          additional parameters apply.
1822
        $ref: "#/definitions/IdentifierInNsd"
1823
1824
1825
1826
1827
      locationConstraints:
        description: >
          Defines the location constraints for the VNF instance to
          be created based on the VNF profile.
        $ref: "#/definitions/LocationConstraints"
1828
1829

  VnfInstanceData:
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
    description: >
      This type specifies an existing VNF instance to be used in the NS instance and
      if needed, the VNF Profile to use for this VNF instance.
      It shall comply with the provisions defined in Table 6.5.3.19-1.
    type: object
    required:
      - vnfInstanceId
      - vnfProfileId
    properties:
      vnfInstanceId:
        description: >
          Identifier of the existing VNF instance to be used in the NS.
1842
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
1843
1844
1845
1846
1847
1848
      vnfProfileId:
        description: >
          Identifier of (Reference to) a vnfProfile defined in the
          NSD which the existing VNF instance shall be matched
          with. If not present, the NFVO will select the VnfProfile
          matching the information in the VNF instance.
1849
        $ref: "#/definitions/IdentifierInNsd"
1850

1851
1852
1853
1854
1855
1856
1857
1858
1859
  NestedNsInstanceData:
    description: >
      This type specifies an existing nested NS instance to be used in the NS instance 
      and if needed, the NsProfile to use for this nested NS instance. 
      It shall comply with the provisions defined in Table 6.5.3.19a-1.
    type: object
    required:
      - nestedNsInstanceId
    properties:
1860
      nestedNsInstanceId:
1861
1862
        description: >
          Identifier of the existing nested NS instance to be used in the NS.
1863
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
1864
1865
1866
1867
1868
1869
      nsProfileId:
        description: >
          Identifier of an NsProfile defined in the NSD which the existing 
          nested NS instance shall be matched with.
          If not present, the NFVO will select the NsProfile matching the 
          information in the nested NS instance.
1870
        $ref: "#/definitions/IdentifierInNs"
1871

1872
  SapData:
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
    description: >
      This type represents the information related to a SAP of a NS.
      It shall comply with the provisions defined in Table 6.5.3.10-1.
    type: object
    required:
      - sapdId
      - sapName
      - description
    properties:
      sapdId:
        description: >
          Reference to the SAPD for this SAP.
1885
        $ref: "#/definitions/IdentifierInNsd"
1886
1887
1888
1889
1890
1891
1892
1893
1894
      sapName:
        description: >
          Human readable name for the SAP.
        type: string
      description:
        description: >
          Human readable description for the SAP.
        type: string
      sapProtocolData:
1895
1896
1897
        description: >
          Parameters for configuring the network protocols on the SAP.
        type: array
1898
        items:
1899
          $ref: "#/definitions/CpProtocolData"
1900
1901

  ScaleNsRequest:
1902
    description: >
1903
      This type represents a request for the scale NS operation.
1904
1905
    type: object
    required:
1906
      - scaleType
1907
    properties:
1908
      scaleType:
1909
        description: >
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
          Indicates the type of scaling to be performed.
          Possible values:
          - SCALE_NS
          - SCALE_VNF
        type: string
        enum:
          - SCALE_NS
          - SCALE_VNF
      scaleNsData:
        description: >
          The necessary information to scale the referenced NS instance.
          It shall be present when scaleType = SCALE_NS.
        $ref: "#/definitions/ScaleNsData"
      scaleVnfData:
        description: >
          The necessary information to scale the referenced NS instance.
          It shall be present when scaleType = SCALE_VNF.
        type: array
        items:
          $ref: "#/definitions/ScaleVnfData"
      scaleTime:
        description: >
          Timestamp indicating the scale time of the NS, i.e. the
          NS will be scaled at this timestamp. Cardinality "0"
          indicates the NS scaling takes place immediately".
1935
        $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950

  UpdateNsRequest:
    description: >
      This operation supports the update of a NS instance, 
      It shall comply with the provisions defined in Table 6.5.2.12-1.
    type: object
    required:
      - updateType
    properties:
      updateType:
        description: >
          The type of update. It determines also which one of the
          following parameters is present in the operation.
          Possible values include:
          * ADD_VNF: Adding existing VNF instance(s)
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
          * REMOVE_VNF: Removing VNF instance(s)
          * INSTANTIATE_VNF: Instantiating new VNF(s)
          * CHANGE_VNF_DF: Changing VNF DF
          * OPERATE_VNF: Changing VNF state,
          * MODIFY_VNF_INFORMATION: Modifying
          VNF information and/or the configurable
          properties of VNF instance(s)
          * CHANGE_EXTERNAL_VNF_CONNECTIVITY:
          Changing the external connectivity of VNF
          instance(s)ADD_SAP: Adding SAP(s)
          * REMOVE_SAP: Removing SAP(s)
          * ADD_NESTED_NS: Adding existing NS
          instance(s) as nested NS(s)
          * REMOVE_NESTED_NS: Removing existing
          nested NS instance(s)
          * ASSOC_NEW_NSD_VERSION: Associating a
          new NSD version to the NS instance
          * MOVE_VNF: Moving VNF instance(s) from one
          origin NS instance to another target NS
          instance
          * ADD_VNFFG: Adding VNFFG(s)
          * REMOVE_VNFFG: Removing VNFFG(s)
          * UPDATE_VNFFG: Updating VNFFG(s)
          * CHANGE_NS_DF: Changing NS DF
          * ADD_PNF: Adding PNF
          * MODIFY_PNF: Modifying PNF
          * REMOVE_PNF: Removing PNF
        type: string
1979
        enum:
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
          - ADD_VNF
          - REMOVE_VNF
          - INSTANTIATE_VNF
          - CHANGE_VNF_DF
          - OPERATE_VNF
          - MODIFY_VNF_INFORMATION
          - CHANGE_EXTERNAL_VNF_CONNECTIVITY
          - REMOVE_SAP
          - ADD_NESTED_NS
          - REMOVE_NESTED_NS
          - ASSOC_NEW_NSD_VERSION
          - MOVE_VNF
          - ADD_VNFFG
1993
1994
1995
1996
1997
1998
          - REMOVE_VNFFG
          - UPDATE_VNFFG
          - CHANGE_NS_DF
          - ADD_PNF
          - MODIFY_PNF
          - REMOVE_PNF
1999
2000
      addVnfIstance:
        description: >
For faster browsing, not all history is shown. View entire blame