SOL005NSLifecycleManagement_def.yaml 233 KB
Newer Older
1001
1002
        description: >
          Identifier of the external CPD, VnfExtCpd, in the VNFD.
1003
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
1004
1005
1006
1007
1008
1009
      cpProtocolInfo:
        description: >
          Network protocol information for this CP.
        type: array
        minItems: 1
        items:
1010
          $ref: "#/definitions/CpProtocolInfo"
1011
1012
1013
1014
1015
1016
1017
1018
      extLinkPortId:
        description: >
          Identifier of the "extLinkPortInfo" structure inside the "extVirtualLinkInfo" 
          structure. Shall be present if the CP is associated to a link port.
        $ref: "#/definitions/CpProtocolInfo"
      metadata:
        description: >
          Metadata about this external CP.
1019
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
1020
1021
1022
1023
1024
1025
1026
      associatedVnfcCpId:
        description: >
          Identifier of the "vnfcCpInfo" structure in "VnfcResourceInfo" structure 
          that represents the VNFC CP which is exposed by this external CP instance. 
          Shall be present in case this CP instance maps to a VNFC CP(s).
          The attributes "associatedVnfcCpId" and "associatedVnfVirtualLinkId" are 
          mutually exclusive. One and only one shall be present.
1027
        $ref: "#/definitions/IdentifierInVnf"
1028
1029
1030
1031
1032
1033
1034
      associatedVnfVirtualLinkId:
        description: >
          Identifier of the "VnfVirtualLinkResourceInfo" structure that represents 
          the internal VL, which is exposed by this external CP instance. Shall be 
          present in case this CP instance maps to an internal VL.
          The attributes "associatedVnfcCpId" and "associatedVnfVirtualLinkId" are 
          mutually exclusive. One and only one shall be present.
1035
        $ref: "#/definitions/IdentifierInVnf"
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
  CpGroupInfo:
    description: >
      This type represents describes a group of CPs and/or SAPs pairs associated to 
      the same position in an NFP. It shall comply with the provisions defined in 
      Table 6.5.3.71-1.
    type: object
    properties:
      cpPairInfo:
        description: >
          One or more pair(s) of ingress and egress CPs or SAPs which the NFP passes by.
          All CP or SAP pairs in a group shall be instantiated from connection point 
          descriptors or service access point descriptors referenced in the corresponding 
          NfpPositionDesc.
        type: array
        minItems: 1
        items:
          $ref: "#/definitions/CpPairInfo"
      forwardingBehaviour:
        description: >
          Identifies a rule to apply to forward traffic to the ingress CPs or SAPs of 
          the group.
          Permitted values:
          * ALL = Traffic flows shall be forwarded simultaneously to all CPs or SAPs 
          of the group.
          * LB = Traffic flows shall be forwarded to one CP or SAP of the group selected 
          based on a loadbalancing algorithm.
        type: string
        enum:
          - ALL
          - LB
      forwardingBehaviourInputParameters:
        description: >
          Provides input parameters to configure the forwarding behaviour (e.g. identifies 
          a load balancing algorithm and criteria).
        $ref: "#/definitions/ForwardingBehaviourInputParameters"

1073
  CpPairInfo:
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
    description: >
      This type represents describes a pair of ingress and egress CPs or SAPs which 
      the NFP passes by. It shall comply with the provisions defined in Table 6.5.3.72-1.
    type: object
    properties:
      vnfExtCpIds:
        description: >
          Identifier(s) of the VNF 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:
1088
          $ref: "#/definitions/IdentifierInVnf"
1089
1090
1091
1092
1093
1094
1095
1096
1097
      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:
1098
          $ref: "#/definitions/IdentifierInPnf"
1099
1100
1101
1102
1103
1104
1105
1106
1107
      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:
1108
          $ref: "#/definitions/IdentifierInNs"
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
  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
1135
          - SOURCE_MAC_HASH
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
      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

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
  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:
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
    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
    properties:
      macAddress:
        description: >
          Assigned MAC address.
1184
        $ref: "#/definitions/MacAddress"
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
      segmentationId:
        description: >
          Identification of the network segment to which the Cp instance connects to.
          If the Cp instance represents a subport in a trunk, "segmentationId" shall be present.
          Otherwise it shall not be present.
          Depending on the NFVI networking infrastructure, the "segmentationId" may indicate the actual network segment
          value (e.g. vlan Id, Vxlan segmentation id, etc.) used in the transport header of the packets or it may be an
          identifier used between the application and the NFVI networking infrastructure to identify the network sub-interface
          of the trunk port in question. In the latter case the NFVI infrastructure will map this local "segmentationId"
          to whatever "segmentationId" is actually used by the NFVI’s transport technology.
        type: string
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
      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:
1221
                $ref: "#/definitions/IpAddress"
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
            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.
1241
                  $ref: "#/definitions/IpAddress"
1242
1243
1244
                maxAddress:
                  description: >
                    Highest IP address belonging to the range
1245
                  $ref: "#/definitions/IpAddress"
1246
1247
1248
1249
1250
1251
            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.
1252
              $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVim"
Samir Medjiah's avatar
Samir Medjiah committed
1253
1254


1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
      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:
1268
        $ref: "#/definitions/IpAddress"
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
      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.
1289
            $ref: "#/definitions/IpAddress"
1290
1291
1292
          maxAddress:
            description: >
              Highest IP address belonging to the range
1293
            $ref: "#/definitions/IpAddress"
1294
1295
1296
      minAddress:
        description: >
          Lowest IP address belonging to the range
1297
        $ref: "#/definitions/IpAddress"
1298
1299
1300
      maxAddress:
        description: >
          Highest IP address belonging to the range.
1301
        $ref: "#/definitions/IpAddress"
1302
1303
1304
1305
1306
1307
      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.
1308
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVim"
1309

1310
1311
1312
1313
1314
1315
1316
  ExtVirtualLinkInfo:
    type: object
    required:
      - id
      - resourceHandle
    properties:
      id:
1317
1318
1319
1320
1321
        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.
1322
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
1323
1324
1325
      resourceHandle:
        description: >
          Reference to the resource realizing this VL.
1326
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
      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.
1347
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
1348
1349
1350
      resourceHandle:
        description: >
          Reference to the virtualised resource realizing this link port.
1351
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
1352
1353
1354
1355
1356
1357
      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.
1358
        $ref: "#/definitions/IdentifierInVnf"
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371

  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.
1372
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
1373
1374
1375
1376
1377
1378
      vnfdId:
        description: >
          Identifier of the VNFD.
          Shall be present in case the value differs from the vnfdId attribute of the VnfInstance (e.g. during a
          "Change current VNF package" operation or due to its final failure).
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
1379
1380
1381
      vnfVirtualLinkDescId:
        description: >
          Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.
1382
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
1383
1384
      networkResource:
        description: >
1385
          Reference to the VirtualNetwork resource or multi-site connectivity service providing this VL.
1386
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
1387
1388
1389
1390
1391
1392
      vnfLinkPorts:
        description: >
          Link ports of this VL.
        type: array
        items:
          $ref: "#/definitions/VnfLinkPortInfo"
1393
1394
1395
1396
1397
1398
1399
1400
      extManagedMultisiteVirtualLinkId:
        description: >
          Identifier of the externally-managed multi-site VL instance. The identifier is assigned by the NFV-MANO entity
          that manages the externally managed multi-site VL instance. It shall be present when the present externally-managed
          internal VL is part of a multi-site VL, e.g., in support of multi-site VNF spanning several VIMs.
          All externally-managed internal VL instances corresponding to an internal VL created based on the same virtualLinkDescId
          shall refer to the same extManagedMultisiteVirtualLinkId.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410

  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.
1411
        $ref: "#/definitions/IdentifierInVnf"
1412
1413
      resourceHandle:
        description: >
1414
          Reference to the virtualised resource realizing this link port.
1415
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
      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.
1432
        $ref: "#/definitions/IdentifierInVnf"
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
      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
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455

  MonitoringParameter:
    type: object
    required:
      - id
      - value
      - timeStamp
    properties:
      id:
        description: >
          Identifier of the monitoring parameter defined in the VNFD.
1456
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
1457
1458
1459
1460
1461
1462
1463
      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
1464
          for auto-scaling purposes).
1465
1466
1467
1468
          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
1469
1470
1471
1472
1473
1474
      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
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488

  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.
1489
        $ref: "#/definitions/IdentifierInVnf"
1490
1491
1492
1493
1494
1495
      vnfdId:
        description: >
          Identifier of the VNFD.
          Shall be present in case the value differs from the vnfdId attribute of the VnfInstance (e.g. during a
          "Change current VNF package" operation or due to its final failure).
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
1496
1497
1498
      vduId:
        description: >
          Reference to the applicable VDU in the VNFD.
1499
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
1500
1501
1502
      computeResource:
        description: >
          Reference to the VirtualCompute resource.
1503
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
1504
1505
1506
1507
1508
1509
      storageResourceIds:
        description: >
          References to the VirtualStorage resources. The value refers to a
          VirtualStorageResourceInfo item in the VnfInstance.
        type: array
        items:
1510
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
1511
1512
1513
1514
      reservationId:
        description: >
          The reservation identifier applicable to the resource. It shall be
          present when an applicable reservation exists.
1515
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
      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.
1533
              $ref: "#/definitions/IdentifierInVnf"
1534
1535
1536
            cpdId:
              description: >
                Identifier of the VDU CPD, cpdId, in the VNFD.
1537
              $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
1538
1539
1540
1541
            vnfExtCpId:
              description: >
                When the VNFC CP is exposed as external CP of the VNF, the
                identifier of this external VNF CP.
1542
              $ref: "#/definitions/IdentifierInVnf"
1543
1544
1545
1546
1547
1548
1549
1550
1551
            cpProtocolInfo:
              description: >
                Network protocol information for this CP.
              type: array
              items:
                $ref: "#/definitions/CpProtocolInfo"
            vnfLinkPortId:
              description: >
                Identifier of the "vnfLinkPorts" structure in the
1552
                "VnfVirtualLinkResourceInfo" structure. Shall be present if
1553
                the CP is associated to a link port.
1554
              $ref: "#/definitions/IdentifierInVnf"
1555
1556
1557
            metadata:
              description: >
                Metadata about this CP.
1558
              $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
1559
1560
1561
      metadata:
        description: >
          Metadata about this resource.
1562
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
1563
1564

  VnfVirtualLinkResourceInfo:
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
    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.
1577
        $ref: "#/definitions/IdentifierInVnf"
1578
1579
1580
1581
1582
1583
      vnfdId:
        description: >
          Identifier of the VNFD.
          Shall be present in case the value differs from the vnfdId attribute of the VnfInstance (e.g. during a
          "Change current VNF package" operation or due to its final failure).
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
1584
1585
1586
      vnfVirtualLinkDescId:
        description: >
          Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.
1587
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
1588
1589
1590
      networkResource:
        description: >
          Reference to the VirtualNetwork resource.
1591
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
1592
1593
1594
1595
      reservationId:
        description: >
          The reservation identifier applicable to the resource. It shall be
          present when an applicable reservation exists.
1596
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
      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.
1609
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
1610

1611
  VirtualStorageResourceInfo:
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
    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.
1624
        $ref: "#/definitions/IdentifierInVnf"
1625
1626
1627
      virtualStorageDescId:
        description: >
          Identifier of the VirtualStorageDesc in the VNFD.
1628
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
1629
1630
1631
      storageResource:
        description: >
          Reference to the VirtualStorage resource.
1632
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
1633
1634
1635
1636
      reservationId:
        description: >
          The reservation identifier applicable to the resource. It shall be
          present when an applicable reservation exists.
1637
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
1638
1639
1640
      metadata:
        description: >
          Metadata about this resource.
1641
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
1642

1643
  NsLinkPortInfo:
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
    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.
1656
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
1657
1658
      resourceHandle:
        description: >
1659
          Identifier of the virtualised resource realizing
1660
          this link port.
1661
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
      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"

1674
  AffinityOrAntiAffinityRule:
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
    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:
1696
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
      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:
1709
          $ref: "#/definitions/IdentifierInNsd"
1710
1711
1712
1713
1714
1715
1716
      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:
1717
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
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
      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
1743
1744
1745
1746

  InstantiateNsRequest:
    type: object
    required:
1747
      - nsFlavourId
1748
1749
1750
1751
    properties:
      nsFlavourId:
        description: >
          Identifier of the NS deployment flavor to be instantiated.
1752
        $ref: "#/definitions/IdentifierInNsd"
1753
1754
      sapData:
        description: >
1755
          Create data concerning the SAPs of this NS.
1756
        type: array
1757
1758
        items:
          $ref: "#/definitions/SapData"
1759
1760
1761
1762
      addpnfData:
        description: >
          Information on the PNF(s) that are part of this NS.
        type: array
1763
1764
        items:
          $ref: "#/definitions/AddPnfData"
1765
1766
1767
1768
1769
      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.
1770
1771
          The DF of the VNF instance shall match the VNF DF 
          present in the associated VNF Profile.
1772
        type: array
1773
        items:
1774
          $ref: "#/definitions/VnfInstanceData"
1775
      nestedNsInstanceData:
1776
1777
1778
        description: >
          Specify an existing NS instance to be used as a nested
          NS within the NS.
1779
1780
1781
1782
1783
1784
1785
1786
          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.
1787
        type: array
1788
        items:
1789
          $ref: "#/definitions/NestedNsInstanceData"
1790
      locationConstraints:
1791
1792
1793
1794
1795
1796
        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
1797
1798
        items:
          $ref: "#/definitions/VnfLocationConstraint"
1799
1800
1801
1802
1803
1804
1805
      nestedNslocationConstraints:
        description: >
          Defines the location constraints for the nested NS to be instantiated as part of the NS instantiation.
          An example can be a constraint for the nested NS to be in a specific geographic location.
        type: array
        items:
          $ref: "#/definitions/NsLocationConstraint"
1806
1807
1808
      additionalParamsForNs:
        description: >
          Allows the OSS/BSS to provide additional parameter(s)
1809
1810
1811
1812
          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.
1813
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
1814
      additionalParamForNestedNs:
1815
1816
        description: >
          Allows the OSS/BSS to provide additional parameter(s)
1817
1818
1819
1820
          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
1821
          that are to be created by the NFVO as part of the NS
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
          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.
1836
        type: array
1837
1838
        items:
          $ref: "#/definitions/ParamsForVnf"
1839
1840
1841
1842
      startTime:
        description: >
          Timestamp indicating the earliest time to instantiate the NS. 
          Cardinality "0" indicates the NS instantiation takes place immediately.
1843
        $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
1844
1845
1846
1847
1848
1849
      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.
1850
        $ref: "#/definitions/IdentifierInNsd"
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
      wanConnectionData:
        description: >
          Information for connecting VNs to the WAN when VLs are deployed across a WAN.
          When the NS is deployed over several sites, the VLs of this NS will include VNs in each site connected over
          the WAN. In this case, the "wanConnectionData" provides the needed information required to connect each VN
          to the WAN. Annex E provides additional information and guidelines about the usage of the "wanConnectionData"
          attribute.
        type: array
        items:
          $ref: "#/definitions/WanConnectionData"
1861
      additionalAffinityOrAntiAffinityRule:
1862
        description: >
1863
1864
1865
1866
          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.
1867
        type: array
1868
        items:
1869
1870
          $ref: "#/definitions/AffinityOrAntiAffinityRule"

1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
  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.
1882
        $ref: "#/definitions/IdentifierInNsd"
1883
1884
1885
1886
1887
      additionalParam:
        description: >
          Additional parameters that are to be applied on a per nested NS instance.
        type: array
        items:
1888
          $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
1889

1890
  ParamsForVnf:
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
    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.
1903
        $ref: "#/definitions/IdentifierInNsd"
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
      vnfInstanceName:
        description: >
          Human-readable name of the VNF instance to be created.
        type: string
      vnfInstanceDescription:
        description: >
          Human-readable description of the VNF instance to be created.
        type: string
      vnfConfigurableProperties:
        description: >
          Values for the "vnfConfigurableProperties" input
          parameter of the Instantiate VNF operation defined in
          ETSI GS NFV-SOL 003 [4].
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
      metadata:
        description: >
          Values for the "metadata" input parameter of the Create
          VNF Identifier operation defined in ETSI
          GS NFV-SOL 003 [4].
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
      extensions:
        description: >
          Values for the "extensions" attribute of the Instantiate
          VNF operation defined in ETSI GS NFV-SOL 003 [4].
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
1929
1930
      additionalParams:
        description: >
1931
1932
1933
          Additional input parameters for the instantiation process,
          specific to the VNF being instantiated, as declared in the
          VNFD as part of "InstantiateVnfOpConfig".
1934
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
1935

1936
  LocationConstraints:
1937
1938
    description: >
      This type represents location constraints for a VNF to be instantiated.
1939
1940
1941
1942
1943
      The location constraints can be represented as follows:
      •	as a country code
      •	as a civic address combined with a country code
      •	as an area, conditionally combined with a country code
      The LocationConstraints data type shall comply with the provisions defined in Table 6.5.3.21-1.
1944
1945
1946
1947
1948
    type: object
    properties:
      countryCode:
        description: >
          The two-letter ISO 3166 [29] country code in capital letters.
1949
1950
1951
1952
1953
          Shall be present in case the "area" attribute is absent. May be absent if the "area" attribute is present.
          If both "countryCode" and "area" are present, no conflicts should exist between the values of these two attributes.
          In case of conflicts, the API producer (i.e. the NFVO) shall disregard parts of the geographic area signalled
          by "area" that are outside the boundaries of the country signalled by "countryCode". If "countryCode" is absent,
          it is solely the "area" attribute that defines the location constraint.
1954
1955
1956
1957
        type: string
      civicAddressElement:
        description: >
          Zero or more elements comprising the civic address.
1958
          Shall be absent if the "area" attribute is present.
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
        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
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
      area:
        description: >
          Geographic area. Shall be absent if the "civicAddressElement" attribute is present.
          The content of this attribute shall follow the provisions for the "Polygon" geometry object as defined in
          IETF RFC 7946, for which the "type" member shall be set to the value "Polygon".
          If both "countryCode" and "area" are present, no conflicts should exist between the values of these two attributes.
          In case of conflicts, the API producer (i.e. the NFVO) shall disregard parts of the geographic area signalled
          by "area" that are outside the boundaries of the country signalled by "countryCode". If "countryCode" is absent,
          it is solely the "area" attribute that defines the location constraint.
        type: object
1988

1989
  VnfLocationConstraint:
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
    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
For faster browsing, not all history is shown. View entire blame