SOL005NSLifecycleManagement_def.yaml 259 KB
Newer Older
1001
1002
1003
1004
1005
1006
      - id
      - performanceMetric
    properties:
      id:
        description: >
          Identifier of the monitoring parameter defined in the VNFD.
1007
        $ref: "#/definitions/IdentifierInNsd"
1008
1009
1010
1011
1012
1013
      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"
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
      name:
        description: >
          Human readable name of the monitoring parameter, as defined in the VNFD.
        type: string
      performanceMetric:
        description: >
          Performance metric that is monitored. This attribute shall contain the related 
          "Measurement Name" value as defined in clause 7.2 of ETSI GS NFV-IFA 027.
        type: string

1024
1025
1026
1027
1028
1029
1030
1031
  VnfExtCpInfo:
    description: >
      This type represents information about an external CP of a VNF. It shall comply 
      with the provisions defined in Table 6.5.3.70-1.
    type: object
    required:
      - id
      - cpdId
1032
    oneOf:
1033
1034
1035
1036
      - required:
        - associatedVnfcCpId
      - required:
        - associatedVnfVirtualLinkId
1037
1038
1039
1040
    properties:
      id:
        description: >
          Identifier of the external CP instance and the related information instance.
1041
        $ref: "#/definitions/IdentifierInVnf"
1042
1043
1044
      cpdId:
        description: >
          Identifier of the external CPD, VnfExtCpd, in the VNFD.
1045
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
      cpConfigId:
        description: >
          Identifier that references the applied "VnfExtCpConfig" entry in the "cpConfig"
          map of the "currentVnfExtCpData" in the "ExtVirtualLinkInfo" structure.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
      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"
1058
1059
1060
1061
1062
1063
      cpProtocolInfo:
        description: >
          Network protocol information for this CP.
        type: array
        minItems: 1
        items:
1064
          $ref: "#/definitions/CpProtocolInfo"
1065
1066
1067
1068
      extLinkPortId:
        description: >
          Identifier of the "extLinkPortInfo" structure inside the "extVirtualLinkInfo" 
          structure. Shall be present if the CP is associated to a link port.
1069
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
1070
1071
1072
      metadata:
        description: >
          Metadata about this external CP.
1073
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
1074
1075
1076
1077
1078
1079
1080
      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.
1081
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
1082
1083
1084
1085
1086
1087
1088
      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.
1089
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
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
  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"

1127
  CpPairInfo:
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
    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:
1142
          $ref: "#/definitions/IdentifierInVnf"
1143
1144
1145
1146
1147
1148
1149
1150
1151
      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:
1152
          $ref: "#/definitions/IdentifierInPnf"
1153
1154
1155
1156
1157
1158
1159
1160
1161
      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:
1162
          $ref: "#/definitions/IdentifierInNs"
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
  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
1189
          - SOURCE_MAC_HASH
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
      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

1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
  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.
1214
1215
1216
1217
          Permitted values:
            - IP_OVER_ETHERNET

          See note.
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
        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:
1230
1231
1232
1233
    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
1234
1235
1236
1237
1238
    anyOf:
      - required:
        - macAddress
      - required:
        - ipAddresses
1239
1240
1241
1242
    properties:
      macAddress:
        description: >
          Assigned MAC address.
1243
        $ref: "#/definitions/MacAddress"
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
      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
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
      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
1265
1266
1267
1268
1269
          oneOf:
            - required:
                - addresses
            - required:
                - addressRange
1270
1271
1272
1273
          properties:
            type:
              description: >
                The type of the IP addresses.
1274
1275
1276
                Permitted values:
                - IPV4
                - IPV6
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
              type: string
              enum:
                - IPV4
                - IPV6
            addresses:
              description: >
                Fixed addresses assigned (from the subnet defined by
                "subnetId" if provided).
              type: array
              items:
1287
                $ref: "#/definitions/IpAddress"
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
            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.
1307
                  $ref: "#/definitions/IpAddress"
1308
1309
1310
                maxAddress:
                  description: >
                    Highest IP address belonging to the range
1311
                  $ref: "#/definitions/IpAddress"
1312
1313
1314
1315
1316
1317
            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.
1318
              $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVim"
Samir Medjiah's avatar
Samir Medjiah committed
1319
1320


1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
      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:
1334
        $ref: "#/definitions/IpAddress"
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
      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.
1355
            $ref: "#/definitions/IpAddress"
1356
1357
1358
          maxAddress:
            description: >
              Highest IP address belonging to the range
1359
            $ref: "#/definitions/IpAddress"
1360
1361
1362
      minAddress:
        description: >
          Lowest IP address belonging to the range
1363
        $ref: "#/definitions/IpAddress"
1364
1365
1366
      maxAddress:
        description: >
          Highest IP address belonging to the range.
1367
        $ref: "#/definitions/IpAddress"
1368
1369
1370
1371
1372
1373
      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.
1374
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVim"
1375

1376
1377
1378
1379
1380
1381
1382
  ExtVirtualLinkInfo:
    type: object
    required:
      - id
      - resourceHandle
    properties:
      id:
1383
1384
1385
1386
1387
        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.
1388
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
1389
1390
1391
      resourceHandle:
        description: >
          Reference to the resource realizing this VL.
1392
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
1393
1394
1395
1396
1397
1398
      extLinkPorts:
        description: >
          Link ports of this VL.
        type: array
        items:
          $ref: "#/definitions/ExtLinkPortInfo"
1399
1400
1401
1402
1403
1404
      currentVnfExtCpData:
        description: >
          Allows the API consumer to read the current CP configuration information
          for the connection of external CPs to the external virtual link, as
          specified in clause 5.5.3.2 of ETSI GS NFV-SOL 003.
        $ref: "#/definitions/VnfExtCpData"
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418

  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.
1419
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
1420
1421
1422
      resourceHandle:
        description: >
          Reference to the virtualised resource realizing this link port.
1423
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
1424
1425
1426
1427
1428
1429
      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.
1430
        $ref: "#/definitions/IdentifierInVnf"
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
      secondaryCpInstanceId:
        description: >
          Additional external CP of the VNF connected to this link port.
          If present, this attribute shall refer to a "secondary" ExtCpInfo item in the VNF instance that exposes
          a virtual IP CP instance which shares this linkport with the external CP instance referenced by the
          "cpInstanceId" attribute.
          The use cases UC#4 and UC#5 in Annex A.4 of ETSI GS NFV-IFA 007 provide examples for such a configuration.
        $ref: "#/definitions/IdentifierInVnf"
      trunkResourceId:
        description: >
          Identifier of the trunk resource in the VIM.
          Shall be present if the present link port corresponds to the parent port that the trunk resource is associated
          with.
          The value of "trunkResourceId" is scoped by the value of "vimConnectionId" in the "resourceHandle" attribute.
        $ref: "#/definitions/IdentifierInVim"
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458

  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.
1459
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
1460
1461
1462
1463
1464
1465
      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"
1466
1467
1468
      vnfVirtualLinkDescId:
        description: >
          Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.
1469
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
1470
1471
      networkResource:
        description: >
1472
          Reference to the VirtualNetwork resource or multi-site connectivity service providing this VL.
1473
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
1474
1475
1476
1477
1478
1479
      vnfLinkPorts:
        description: >
          Link ports of this VL.
        type: array
        items:
          $ref: "#/definitions/VnfLinkPortInfo"
1480
1481
1482
1483
1484
1485
1486
1487
      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"
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497

  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.
1498
        $ref: "#/definitions/IdentifierInVnf"
1499
1500
      resourceHandle:
        description: >
1501
          Reference to the virtualised resource realizing this link port.
1502
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
      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.
1519
        $ref: "#/definitions/IdentifierInVnf"
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
      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
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542

  MonitoringParameter:
    type: object
    required:
      - id
      - value
      - timeStamp
    properties:
      id:
        description: >
          Identifier of the monitoring parameter defined in the VNFD.
1543
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
1544
1545
1546
1547
1548
1549
1550
      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
1551
          for auto-scaling purposes).
1552
1553
1554
1555
          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
1556
1557
1558
1559
1560
1561
      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
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575

  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.
1576
        $ref: "#/definitions/IdentifierInVnf"
1577
1578
1579
1580
1581
1582
      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"
1583
1584
1585
      vduId:
        description: >
          Reference to the applicable VDU in the VNFD.
1586
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
1587
1588
1589
      computeResource:
        description: >
          Reference to the VirtualCompute resource.
1590
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
1591
1592
1593
1594
1595
1596
      storageResourceIds:
        description: >
          References to the VirtualStorage resources. The value refers to a
          VirtualStorageResourceInfo item in the VnfInstance.
        type: array
        items:
1597
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
1598
1599
1600
1601
      reservationId:
        description: >
          The reservation identifier applicable to the resource. It shall be
          present when an applicable reservation exists.
1602
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
1603
1604
1605
1606
      vnfcCpInfo:
        description: >
          CPs of the VNFC instance.
          Shall be present when that particular CP of the VNFC instance is
1607
1608
1609
1610
1611
1612
          exposed as an external CP of the VNF instance or is connected to
          an external CP of the VNF instance.
          A VNFC CP is "connected to" an external CP if the VNFC CP is
          connected to an internal VL that exposes an external CP. A VNFC
          CP is "exposed as" an external CP if it is connected directly to
          an external VL. May be present otherwise.
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
        type: array
        items:
          type: object
          required:
            - id
            - cpdId
          properties:
            id:
              description: >
                Identifier of this VNFC CP instance and the associated array
                entry.
1624
              $ref: "#/definitions/IdentifierInVnf"
1625
1626
1627
            cpdId:
              description: >
                Identifier of the VDU CPD, cpdId, in the VNFD.
1628
              $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
1629
1630
            vnfExtCpId:
              description: >
1631
1632
1633
1634
                Identifier of the related external CP. Shall be present when the VNFC CP is exposed as an external CP
                of the VNF instance or connected to an external CP of the VNF instance and shall be absent otherwise.
                A VNFC CP is "connected to" an external CP if the VNFC CP is connected to an internal VL that exposes
                an external CP. A VNFC CP is "exposed as" an external CP if it is connected directly to an external VL.
1635
              $ref: "#/definitions/IdentifierInVnf"
1636
1637
1638
            cpProtocolInfo:
              description: >
                Network protocol information for this CP.
1639
1640
                May be omitted if the VNFC CP is exposed as an external CP.
                The information can be omitted because it is already available as part of the external CP information.
1641
1642
1643
              type: array
              items:
                $ref: "#/definitions/CpProtocolInfo"
1644
1645
1646
1647
1648
1649
1650
            parentCpId:
              description: >
                Identifier of another VNFC CP instance that corresponds to the parent port of a trunk that the present VNFC
                CP instance participates in.
                Shall be provided if the present CP instance participates in a trunk as subport, and the referred VNFC
                CP instances are also present in the vnfcCpInfo attribute.
              $ref: "#/definitions/IdentifierInVnf"
1651
1652
            vnfLinkPortId:
              description: >
1653
1654
1655
                Identifier of the "vnfLinkPorts" structure in the "VnfVirtualLinkResourceInfo" or "ExtManagedVirtualLinkInfo"
                structure. Shall be present if the CP is associated to a link port on an internal VL (including
                externally-managed internal VL) of the VNF instance and shall be absent otherwise.
1656
              $ref: "#/definitions/IdentifierInVnf"
1657
1658
1659
            metadata:
              description: >
                Metadata about this CP.
1660
              $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
1661
1662
1663
      metadata:
        description: >
          Metadata about this resource.
1664
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
1665
1666

  VnfVirtualLinkResourceInfo:
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
    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.
1679
        $ref: "#/definitions/IdentifierInVnf"
1680
1681
1682
1683
1684
1685
      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"
1686
1687
1688
      vnfVirtualLinkDescId:
        description: >
          Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.
1689
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
1690
1691
1692
      networkResource:
        description: >
          Reference to the VirtualNetwork resource.
1693
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
1694
1695
1696
1697
      reservationId:
        description: >
          The reservation identifier applicable to the resource. It shall be
          present when an applicable reservation exists.
1698
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
      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.
1711
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
1712

1713
  VirtualStorageResourceInfo:
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
    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.
1726
        $ref: "#/definitions/IdentifierInVnf"
1727
1728
1729
      virtualStorageDescId:
        description: >
          Identifier of the VirtualStorageDesc in the VNFD.
1730
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
1731
1732
1733
1734
1735
1736
      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"
1737
1738
1739
      storageResource:
        description: >
          Reference to the VirtualStorage resource.
1740
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
1741
1742
1743
1744
      reservationId:
        description: >
          The reservation identifier applicable to the resource. It shall be
          present when an applicable reservation exists.
1745
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
1746
1747
1748
      metadata:
        description: >
          Metadata about this resource.
1749
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
1750

1751
  NsLinkPortInfo:
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
    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.
1764
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
1765
1766
      resourceHandle:
        description: >
1767
          Identifier of the virtualised resource realizing
1768
          this link port.
1769
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
1770
1771
1772
1773
1774
1775
1776
1777
      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.
Giacomo Bernini's avatar
Giacomo Bernini committed
1778
        $ref: "#/definitions/NsCpHandle"
1779

1780
  AffinityOrAntiAffinityRule:
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
    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:
1802
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
      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:
1815
          $ref: "#/definitions/IdentifierInNsd"
1816
1817
1818
1819
1820
1821
1822
      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:
1823
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
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
      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
1849
1850
1851
1852

  InstantiateNsRequest:
    type: object
    required:
1853
      - nsFlavourId
1854
1855
1856
1857
    properties:
      nsFlavourId:
        description: >
          Identifier of the NS deployment flavor to be instantiated.
1858
        $ref: "#/definitions/IdentifierInNsd"
1859
1860
      sapData:
        description: >
1861
          Create data concerning the SAPs of this NS.
1862
        type: array
1863
1864
        items:
          $ref: "#/definitions/SapData"
1865
1866
1867
1868
      addpnfData:
        description: >
          Information on the PNF(s) that are part of this NS.
        type: array
1869
1870
        items:
          $ref: "#/definitions/AddPnfData"
1871
1872
1873
1874
1875
      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.
1876
1877
          The DF of the VNF instance shall match the VNF DF 
          present in the associated VNF Profile.
1878
        type: array
1879
        items:
1880
          $ref: "#/definitions/VnfInstanceData"
1881
      nestedNsInstanceData:
1882
1883
1884
        description: >
          Specify an existing NS instance to be used as a nested
          NS within the NS.
1885
1886
1887
1888
1889
1890
1891
1892
          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.
1893
        type: array
1894
        items:
1895
          $ref: "#/definitions/NestedNsInstanceData"
1896
      locationConstraints:
1897
1898
1899
1900
1901
1902
        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
1903
1904
        items:
          $ref: "#/definitions/VnfLocationConstraint"
1905
1906
1907
1908
1909
1910
      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:
Giacomo Bernini's avatar
Giacomo Bernini committed
1911
          $ref: "#/definitions/NestedNsLocationConstraint"
1912
1913
1914
      additionalParamsForNs:
        description: >
          Allows the OSS/BSS to provide additional parameter(s)
1915
1916
1917
          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
1918
          additionalParamsForNestedNs.
1919
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
1920
      additionalParamsForNestedNs:
1921
1922
        description: >
          Allows the OSS/BSS to provide additional parameter(s)
1923
          per nested NS instance (as opposed to the composite NS
1924
          level, which is covered in additionalParamsForNs, and as
1925
          opposed to the VNF level, which is covered in
1926
          additionalParamsForVnf). This is for nested NS instances
1927
          that are to be created by the NFVO as part of the NS
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
          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 
1939
          additionalParamsForNestedNs). This is for VNFs that are
1940
1941
          to be created by the NFVO as part of the NS instantiation 
          and not for existing VNF that are referenced for reuse.
1942
        type: array
1943
1944
        items:
          $ref: "#/definitions/ParamsForVnf"
1945
1946
1947
1948
      startTime:
        description: >
          Timestamp indicating the earliest time to instantiate the NS. 
          Cardinality "0" indicates the NS instantiation takes place immediately.
1949
        $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
1950
1951
1952
1953
1954
1955
      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.
1956
        $ref: "#/definitions/IdentifierInNsd"
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
      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"
1967
      additionalAffinityOrAntiAffinityRule:
1968
        description: >
1969
1970
1971
1972
          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.
1973
        type: array
1974
        items:
1975
1976
          $ref: "#/definitions/AffinityOrAntiAffinityRule"

1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
  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.
1988
        $ref: "#/definitions/IdentifierInNsd"
1989
1990
1991
1992
1993
      additionalParam:
        description: >
          Additional parameters that are to be applied on a per nested NS instance.
        type: array
        items:
1994
          $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
1995

1996
  ParamsForVnf:
1997
1998
1999
2000
    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.
For faster browsing, not all history is shown. View entire blame