SOL005_50 to SOL005_60

src/SOL005/NSLifecycleManagement/definitions/SOL005NSLifecycleManagement_def.yaml

@@ -123,6 +123,12 @@ definitions:
     description: >
       This type represents a NS termination request. 
       It shall comply with the provisions defined in Table 6.5.2.15-1.
+
+      NOTE 1:	Information needed for terminating specific VNF instances shall only be
+      specified in the "terminateVnfData" attribute, and not in the "terminateNsData" attribute.
+      NOTE 2: 	VNF instance(s) part of this NS instance is(are) terminated as part of Terminate
+      NS operation only if the instance(s) is(are) not used by any other NS instance.
+
     type: object
     properties:
       terminationTime:
@@ -134,16 +140,12 @@ definitions:
       terminateNsData:
         description: >
           Provides additional parameters to the termination process at the NS level.
-          Information needed for terminating specific VNF instances shall only be specified
-          in the "terminateVnfData" attribute, and not in the "terminateNsData" attribute.
+          See note 1.
         $ref: "#/definitions/TerminateNsData"
       terminateVnfData:
         description: >
           Provides the information to terminate VNF instance(s).
-          Information needed for terminating specific VNF instances
-          shall only be specified in the "terminateVnfData" attribute, and not in the "terminateNsData" attribute.
-          VNF instance(s) part of this NS instance is(are) terminated as part of Terminate NS operation
-          only if the instance(s) is(are) not used by any other NS instance.
+          See note 1 and 2.
         type: array
         items:
           $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
@@ -193,6 +195,9 @@ definitions:
     description: >
       This type represents a response for Query NS operation. 
       It shall comply with the provisions defined in Table 6.5.2.10-1.
+
+      NOTE:	If the "nsState" attribute is INSTANTIATED, at least either one
+      "vnfInstance" attribute or one "nestedNsInstanceId" attribute shall be present.
     type: object
     required:
       - id
@@ -233,6 +238,7 @@ definitions:
       vnfInstance:
         description: >
           Information on constituent VNF(s) of the NS instance.
+          See note.
         type: array
         items:
           $ref: "#/definitions/VnfInstance"
@@ -266,6 +272,7 @@ definitions:
       nestedNsInstanceId:
         description: >
           Identifier of the nested NS(s) of the NS instance.
+          See note.
         type: array
         items:
           $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
@@ -1891,6 +1898,18 @@ definitions:
 
   InstantiateNsRequest:
     type: object
+    description: >
+      This type represents request parameters for the "Instantiate NS" operation.
+
+      NOTE 1: The DF of the VNF instance shall match the VNF DF present in the associated VNF Profile.
+      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.
+      NOTE 4:	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.
     required:
       - nsFlavourId
     properties:
@@ -1915,8 +1934,7 @@ definitions:
           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.
-          The DF of the VNF instance shall match the VNF DF 
-          present in the associated VNF Profile.
+          See note 1.
         type: array
         items:
           $ref: "#/definitions/VnfInstanceData"
@@ -1926,12 +1944,7 @@ definitions:
           NS within the NS.
           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.
+          See note 2 and note 3.
         type: array
         items:
           $ref: "#/definitions/NestedNsInstanceData"
@@ -1999,10 +2012,7 @@ definitions:
       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.
+          See note 4.
         type: array
         items:
           $ref: "#/definitions/WanConnectionData"
@@ -2250,6 +2260,8 @@ definitions:
     description: >
       This type represents a request for the scale NS operation.
       Either the parameter scaleNsData or the parameter scaleVnfData, but not both shall be provided
+
+      NOTE:	Either the parameter scaleNsData or the parameter scaleVnfData, but not both shall be provided.
     type: object
     required:
       - scaleType
@@ -2273,11 +2285,13 @@ definitions:
         description: >
           The necessary information to scale the referenced NS instance.
           It shall be present when scaleType = SCALE_NS.
+          See note.
         $ref: "#/definitions/ScaleNsData"
       scaleVnfData:
         description: >
           The necessary information to scale the referenced NS instance.
           It shall be present when scaleType = SCALE_VNF.
+          See note.
         type: array
         items:
           $ref: "#/definitions/ScaleVnfData"
@@ -2290,8 +2304,17 @@ definitions:
 
   UpdateNsRequest:
     description: >
-      This operation supports the update of a NS instance, 
-      It shall comply with the provisions defined in Table 6.5.2.12-1.
+      This operation supports the update of a NS instance operation.
+
+      NOTE 1:	The DF of the VNF instance shall match the VNF DF present in the associated VNF Profile.
+      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.
+      NOTE 4:	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: object
     required:
       - updateType
@@ -2321,13 +2344,9 @@ definitions:
           * ADD_PNF: Adding PNF
           * MODIFY_PNF: Modifying PNF
           * REMOVE_PNF: Removing PNF
-          *	CREATE_VNF_SNAPSHOT: Creating VNF Snapshots of VNF instances belonging to the NS instance.
-            It depends on the VNF capabilities, and is declared in the VNFD whether the operation is supported for a particular VNF.
-          *	REVERT_VNF_TO_SNAPSHOT: Reverting a VNF instance belonging to the NS instance to a VNF Snapshot.
-            It depends on the VNF capabilities, and is declared in the VNFD whether the operation is supported for a particular VNF.
-            The operation might be service-disruptive.
-          *	DELETE_VNF_SNAPSHOT_INFO: Deleting available VNF Snapshot information for a VNF instance belonging to the NS instance.
-            It depends on the VNF capabilities, and is declared in the VNFD whether the operation is supported for a particular VNF.
+          *	CREATE_VNF_SNAPSHOT: Creating VNF Snapshots of VNF instances belonging to the NS instance. See note 2
+          * REVERT_VNF_TO_SNAPSHOT: Reverting a VNF instance belonging to the NS instance to a VNF Snapshot. See note 2 and note 3
+          * DELETE_VNF_SNAPSHOT_INFO: Deleting available VNF Snapshot information for a VNF instance belonging to the NS instance. See note 2
           *	MODIFY_WAN_CONNECTION_INFO: Modify WAN related connectivity information.
           *	CREATE_NS_VIRTUAL_LINK: Create an NsVirtualLink instance.
           *	DELETE_NS_VIRTUAL_LINK: Delete an NsVirtualLink instance.
@@ -2372,10 +2391,7 @@ definitions:
           Identifies an existing VNF instance to be removed from
           the NS instance. It contains the identifier(s) of the VNF
           instances to be removed. It shall be present only if
-          updateType = "REMOVE_VNF." Note: If a VNF instance
-          is removed from a NS and this NS was the last one for
-          which this VNF instance was a part, the VNF instance is
-          terminated by the NFVO.
+          updateType = "REMOVE_VNF.". See note 1.
         type: array
         items:
           $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
@@ -2393,11 +2409,7 @@ definitions:
           It shall be present only if updateType = "REMOVE_VNF"
           and if the VNF instance(s) is(are) to be terminated as
           part of this operation.
-          If a VNF instance is removed from an NS and this NS was the
-          last one for which this VNF instance was a part, the VNF instance
-          is terminated by the NFVO.
-          For each of the referred vnfInstanceId in the terminateVnfData,
-          there shall be a corresponding value in the removeVnfInstanceId.
+          See notes 1 and 4.
         type: array
         items:
           $ref: "#/definitions/TerminateVnfData"
@@ -3310,6 +3322,8 @@ definitions:
     description: >
       This type provides information about added, deleted, modified and
       temporary VLs.
+      NOTE:	The resource handles of the affected NS link ports can be
+      found by dereferencing the identifiers in the "linkPortIds" attribute.
     type: object
     required:
       - nsVirtualLinkInstanceId
@@ -3348,11 +3362,14 @@ definitions:
       linkPortIds:
         description: >
           Identifiers of the link ports of the affected VL related to the change. Each identifier references an
-          "NsLinkPortInfo" structure. Shall be set when changeType is equal to "ADD_LINK_PORT" or "REMOVE_LINK_PORT",
-          and the related "NsLinkPortInfo" structures are present (case "add") or have been present (case "remove") in
-          the "NsVirtualLinkInfo" structure that is represented by the "virtualLinkInfo" attribute in the "NsInstance"
-          structure. The resource handles of the affected NS link ports can be found by dereferencing the identifiers
-          in the "linkPortIds" attribute.
+          "NsLinkPortInfo" structure.
+
+          Shall be set when changeType is equal to "ADD_LINK_PORT" or "REMOVE_LINK_PORT", and the related
+          "NsLinkPortInfo" structures are present (case "add") or have been present (case "remove") in
+          the "NsVirtualLinkInfo" structure that is represented by the "virtualLink¬Info" attribute
+          in the "NsInstance" structure.
+          See note.
+
         type: array
         items:
           $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNs"
@@ -3421,7 +3438,10 @@ definitions:
   AffectedVnf:
     description: >
       This type provides information about added, deleted and modified VNFs.
-      It shall comply with the provisions in Table 6.5.3.2-1.
+
+      NOTE:	At least one of the attributes "changedVnfInfo", "changedExtConnectivity"
+      or "modificationsTriggeredByVnfPkgChange" shall be present. Not more than one
+      of "changedVnfInfo" and "modificationsTriggeredByVnfPkgChange" shall be present.
     type: object
     required:
       - vnfInstanceId
@@ -3522,20 +3542,22 @@ definitions:
               Information about the changed VNF instance
               information, including configurable properties, 
               if applicable.
+              See note.
             $ref: "#/definitions/ModifyVnfInfoData"
           changedExtConnectivity:
             description: >
-              Information about changed external connectivity,
-              if applicable.
+              Information about changed external connectivity, if applicable.
+              Only information about external VL instances that have been
+              added or modified shall be provided. See note.
             type: array
             items:
               $ref: "#/definitions/ExtVirtualLinkInfo"
           modificationsTriggeredByVnfPkgChange:
             description: >
-              Information about performed changes of "VnfInstance" attributes triggered by changing the current
-              VNF package, if applicable. Shall be absent if the "operation" attribute is different from "CHANGE_VNFPKG".
-              At least one of the attributes "changedVnfInfo", "changedExtConnectivity" or "modificationsTriggeredByVnfPkgChange"
-              shall be present. Not more than one of "changedVnfInfo" and "modificationsTriggeredByVnfPkgChange" shall be present.
+              Information about performed changes of "VnfInstance" attributes
+              triggered by changing the current VNF package, if applicable.
+              Shall be absent if the "operation" attribute is different from "CHANGE_VNFPKG".
+              See note.
             $ref: "#/definitions/ModificationsTriggeredByVnfPkgChange"
 
   AffectedPnf:
@@ -3931,6 +3953,9 @@ definitions:
       to match (logical "and" between different filter attributes). 
       If an attribute is an array, the attribute shall match if at least
       one of the values in the array matches (logical "or" between the values of one filter attribute).
+
+      NOTE:	The permitted values of the "notificationTypes" attribute are spelled exactly as the names
+      of the notification types to facilitate automated code generation systems.
     type: object
     properties:
       nsInstanceSubscriptionFilter:
@@ -3945,6 +3970,8 @@ definitions:
           - NsIdentifierCreationNotification
           - NsIdentifierDeletionNotification
           - NsChangeNotification
+
+          See note.
         type: array
         items:
           type: string
@@ -4348,6 +4375,14 @@ definitions:
     description: >
       This type represents a request a NS lifecycle operation occurrence.
       It shall comply with the provisions defined in Table 6.5.2.3-1.
+
+      NOTE 1:	This allows the OSS/BSS to obtain a copy of the latest "result" notification if it has not received
+      it due to an error. If the notification represents the successful result of a lifecycle operation, at least
+      an affectedVnf, or affectedPnf, or affectedVl, or affectedVnffg or affectedNs, or affectedSap shall be present.
+
+      NOTE 2:	A coordination action has timed out if the NFVO has not been able to read the "Individual coordination
+      action" resource within a timeout interval after requesting the coordination to be started or to be cancelled.
+      The length of the timeout interval is defined by means outside the scope of the present document
     type: object
     required:
       - id
@@ -4649,6 +4684,16 @@ definitions:
   IpOverEthernetAddressData:
     description: >
       This type represents network address data for IP over Ethernet.
+      NOTE 1:	At least one of "macAddress" or "ipAddresses" shall be present.
+      NOTE 2:	Exactly one of "fixedAddresses", "numDynamicAddresses" or "ipAddressRange" shall be present.
+      NOTE 3:	If the CP instance represents a subport in a trunk, "segmentationId" shall be present.
+      Otherwise it shall not be present.
+      NOTE 4:	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: object
     anyOf:
       - required:
@@ -4659,6 +4704,7 @@ definitions:
       macAddress:
         description: >
           MAC address. If this attribute is not present, it shall be chosen by the NFV MANO.
+          See note 1.
         $ref: "#/definitions/MacAddress"
       segmentationType:
         description: >
@@ -4674,21 +4720,14 @@ definitions:
          - INHERIT
       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.
+          Identification of the network segment to which the CP instance connects to. See note 3 and note 4.
         type: string
       ipAddresses:
         description: >
           List of IP addresses to assign to the CP instance. Each entry
           represents IP address data for fixed or dynamic IP address
           assignment per subnet.
-          If this attribute is not present, no IP address shall be assigned.
+          If this attribute is not present, no IP address shall be assigned. See note 1.
         type: array
         items:
           type: object
@@ -4725,8 +4764,7 @@ definitions:
               description: >
                 Number of dynamic addresses to assign (from the subnet defined
                 by "subnetId" if provided).
-                Exactly one of "fixedAddresses", "numDynamicAddresses" or
-                "ipAddressRange" shall be present.
+                See note 2.
               type: integer
             addressRange:
               description: >

src/SOL005/NSLifecycleManagementNotification/definitions/SOL005NSLifecycleManagementNotification_def.yaml

@@ -21,6 +21,13 @@ definitions:
           Identifier of this notification. If a notification is sent
           multiple times due to multiple subscriptions, the "id"
           attribute of all these notifications shall have the same value.
+
+          NOTE:	Shall be present if the "notificationStatus" is set to "RESULT",
+          the "verbosity" attribute is set to "FULL" and the operation has performed
+          any resource modification. Shall be absent otherwise. This attribute contains
+          information about the cumulative changes to virtualised resources that were
+          performed so far by the NS LCM operation occurrence and by any of the error
+          handling procedures for that operation occurrence.
         $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
       nsInstanceId:
         description: >
@@ -86,65 +93,41 @@ definitions:
       affectedVnf:
         description: >
           Information about the VNF instances that were affected
-          during the lifecycle operation.
-          Shall be present if the "notificationStatus" is set to "RESULT", the "verbosity" attribute is set to "FULL"
-          and the operation has performed any resource modification. Shall be absent otherwise. This attribute contains
-          information about the cumulative changes to virtualised resources that were performed so far by the NS LCM
-          operation occurrence and by any of the error handling procedures for that operation occurrence.
+          during the lifecycle operation. See note.
         type: array
         items:
           $ref: "../../NSLifecycleManagement/definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/AffectedVnf"
       affectedPnf:
         description: >
           Information about the PNF instances that were affected
-          during the lifecycle operation.
-          Shall be present if the "notificationStatus" is set to "RESULT", the "verbosity" attribute is set to "FULL"
-          and the operation has performed any resource modification. Shall be absent otherwise. This attribute contains
-          information about the cumulative changes to virtualised resources that were performed so far by the NS LCM
-          operation occurrence and by any of the error handling procedures for that operation occurrence.
+          during the lifecycle operation. See note.
         type: array
         items:
           $ref: "../../NSLifecycleManagement/definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/AffectedPnf"
       affectedVl:
         description: >
           Information about the VL instances that were affected
-          during the lifecycle operation.
-          Shall be present if the "notificationStatus" is set to "RESULT", the "verbosity" attribute is set to "FULL"
-          and the operation has performed any resource modification. Shall be absent otherwise. This attribute contains
-          information about the cumulative changes to virtualised resources that were performed so far by the NS LCM
-          operation occurrence and by any of the error handling procedures for that operation occurrence.
+          during the lifecycle operation. See note.
         type: array
         items:
           $ref: "../../NSLifecycleManagement/definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/AffectedVirtualLink"
       affectedVnffg:
         description: >
           Information about the VNFFG instances that were
-          affected during the lifecycle operation.
-          Shall be present if the "notificationStatus" is set to "RESULT", the "verbosity" attribute is set to "FULL"
-          and the operation has performed any resource modification. Shall be absent otherwise. This attribute contains
-          information about the cumulative changes to virtualised resources that were performed so far by the NS LCM
-          operation occurrence and by any of the error handling procedures for that operation occurrence.
+          affected during the lifecycle operation. See note.
         type: array
         items:
           $ref: "../../NSLifecycleManagement/definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/AffectedVnffg"
       affectedNs:
         description: >
           Information about the SAP instances that were affected
-          during the lifecycle operation.
-          Shall be present if the "notificationStatus" is set to "RESULT", the "verbosity" attribute is set to "FULL"
-          and the operation has performed any resource modification. Shall be absent otherwise. This attribute contains
-          information about the cumulative changes to virtualised resources that were performed so far by the NS LCM
-          operation occurrence and by any of the error handling procedures for that operation occurrence.
+          during the lifecycle operation.See note.