SOL005_91 to SOL005_101

src/SOL005/NSLifecycleManagement/definitions/SOL005NSLifecycleManagement_def.yaml

@@ -1139,6 +1139,9 @@ definitions:
       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.
+      NOTE:	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: object
     properties:
       cpPairInfo:
@@ -1147,6 +1150,8 @@ definitions:
           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.
+
+          See note.
         type: array
         minItems: 1
         items:
@@ -1174,14 +1179,16 @@ definitions:
     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.
+
+      NOTE 1:	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.
+      NOTE 2:	Only one of these three attributes shall be present.
     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.
+
+          See note 1 and note 2.
         type: array
         maxItems: 2
         items:
@@ -1189,9 +1196,8 @@ definitions:
       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.
+
+          See note 1 and note 2.
         type: array
         maxItems: 2
         items:
@@ -1199,9 +1205,8 @@ definitions:
       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.
+
+          See note 1 and note 2.
         type: array
         maxItems: 2
         items:
@@ -1211,6 +1216,8 @@ definitions:
     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.
+      NOTE 1:	If applicable to the algorithm but not provided, default values determined by the VIM or NFVI are expected to be used.
+      NOTE 2:	Weight applies to the CP instances in the order they have been created.
     type: object
     properties:
       algortihmName:
@@ -1237,9 +1244,7 @@ definitions:
         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.
+          See note 1 and note 2.
         type: array
         items:
           type: integer
@@ -5274,6 +5279,7 @@ definitions:
     description: |
       This type provides information about the connectivity to the WAN of network resources realizing a VL, e.g.,
       when the VL is deployed on several sites across a WAN. It shall comply with the provisions defined in table 6.5.3.90-1.
+      NOTE:	Either a "nsVirtualLinkInfoId" or a "vnfVirtualLinkResourceInfoId" shall be provided, but not both.
     type: object
     required:
       - wanConnectionInfoId
@@ -5291,13 +5297,13 @@ definitions:
         description: >
           References the NS VL instance to which the connection information is associated. Shall be present if a
           corresponding NS VL instance has been created.
-          Either a "nsVirtualLinkInfoId" or a "vnfVirtualLinkResourceInfoId" shall be provided, but not both.
+          See note.
         $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNs"
       vnfVirtualLinkResourceInfoId:
         description: >
           References the VNF VL instance to which the connection information is associated. Shall be present if a
           corresponding VNF VL instance has been created.
-          Either a "nsVirtualLinkInfoId" or a "vnfVirtualLinkResourceInfoId" shall be provided, but not both.
+          See note.
         $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNs"
       protocolInfo:
         description: >
@@ -5329,6 +5335,7 @@ definitions:
     description: |
       This type provides information used to connect the comprising network resources realizing a VL, e.g., when the VL
       is deployed on several sites and across a WAN. It shall comply with the provisions defined in table 6.5.3.80-1.
+      NOTE:	Either a "nsVirtualLink" or a "vnfVirtualLink" shall be provided, but not both.
     type: object
     required:
       - protocolData
@@ -5341,7 +5348,7 @@ definitions:
       nsVirtualLink:
         description: >
           Information used to identify the NS VL for which the WAN connectivity data is applicable.
-          Either a "nsVirtualLink" or a "vnfVirtualLink" shall be provided, but not both.
+          See note.
         type: object
         required:
           - nsVirtualLinkDescId
@@ -5350,6 +5357,7 @@ definitions:
           nsVirtualLinkDescId:
             description: >
               Identifier of the VLD in the NSD from which the VL is created in the case of a multi-site NS VL.
+              See note.
             $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd"
           nsVirtualLinkProfileId:
             description: >
@@ -5516,6 +5524,14 @@ definitions:
   VnfcSnapshotInfo:
     description: >
       This type represents a VNFC Snapshot. It shall comply with the provisions defined in table 6.5.3.77-1.
+      NOTE 1:	The identifier of the compute snapshot resource is assigned during creation of a VNFC
+      Snapshot being returned from the VIM as output data in the response message of the individual resource
+      operations. This attribute shall only be present for a VNFC snapshot that has been newly created by the
+      VNFM as a result of the "Create VNF snapshot task".
+      NOTE 2:	The identifier of the storage snapshot resource is assigned during creation of a VNFC snapshot
+      being returned from the VIM as output data in the response message of the individual resource operations.
+      This attribute shall only be present for a VNFC snapshot with an associated storage resource and that
+      has been newly created by the VNFM as a result of the "Create VNF snapshot task".
     type: object
     required:
       - id
@@ -5550,15 +5566,12 @@ definitions:
       computeSnapshotResource:
         description: >
           Reference to a compute snapshot resource.
-          The identifier of the compute snapshot resource is assigned during creation of a VNFC Snapshot being returned
-          from the VIM as output data in the response message of the individual resource operations.
-          This attribute shall only be present for a VNFC snapshot that has been newly created by the VNFM as a result
-          of the "Create VNF snapshot task".
+          See note 1.
         $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
       storageSnapshotResources:
         description: >
           Reference to the "VirtualStorageResourceInfo" structure in the "VnfInstance" structure that represents
-          the virtual storage resource.
+          the virtual storage resource. See note 2.
         type: array
         items:
           type: object
@@ -5674,6 +5687,8 @@ definitions:
       about both pre-provisioned WAN connectivity realized by external entities to NFV-MANO, as well as for the creation
       of MSCS under NFV-MANO responsibility (i.e., when connectivity is realized when NFVO communicates with the WIM).
       It shall comply with the provisions defined in table 6.5.3.81-1.
+      NOTE: At least one of these attributes shall be present. Annex E documents the applicability of certain attributes
+      depending on the WAN and NFVI-PoP network management and the responsibilities of NFV-MANO in its provisioning.
     type: object
     anyOf:
       - required:
@@ -5686,22 +5701,19 @@ definitions:
       mscsInfo:
         description: >
           Information about the pre-provisioned multi-site connectivity service (MSCS), if already available.
-          At least one of these attributes shall be present. Annex E documents the applicability of certain attributes
-          depending on the WAN and NFVI-PoP network management and the responsibilities of NFV-MANO in its provisioning.
+          See note.
         $ref: "#/definitions/MscsInfo"
       connectivityServiceEndpointConfigDatas:
         description: >
           Configuration data for the network resources in the NFVI-PoP.
-          At least one of these attributes shall be present. Annex E documents the applicability of certain attributes
-          depending on the WAN and NFVI-PoP network management and the responsibilities of NFV-MANO in its provisioning.
+          See note.
         type: array
         items:
           $ref: "#/definitions/ConnectivityServiceEndpointInfo"
       mscsConfigData:
         description: >
           Configuration data for the provisioning of the MSCS, if such MSCS is to be created by NFV-MANO.
-          At least one of these attributes shall be present. Annex E documents the applicability of certain attributes
-          depending on the WAN and NFVI-PoP network management and the responsibilities of NFV-MANO in its provisioning.
+          See note.
         $ref: "#/definitions/MscsConfigData"
 
   MscsInfo:
@@ -5862,6 +5874,7 @@ definitions:
       This type provides information about Layer 2 protocol specific information for the configuration of the NFVI-PoP
       network gateway to enable the stitching of the intra-site VN to the MSCS over the WAN. It shall comply with the
       provisions defined in Table 6.5.3.85-1.
+      NOTE:	Either "networkResources" or "vnSegmentsIds" shall be provided, but not both.
     type: object
     required:
       - layer2ConnectionInfo
@@ -6035,7 +6048,7 @@ definitions:
           networkResources:
             description: >
               Reference to the VN resource to be forwarded into/from the MSCS.
-              Either "networkResources" or "vnSegmentsIds" shall be provided, but not both.
+              See note.
             type: array
             items:
               $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
@@ -6447,6 +6460,8 @@ definitions:
     description: >
       This type specifies the parameters used for the creation of a new NsVirtualLink instance.
       It shall comply with the provisions defined in table 6.5.3.95-1.
+      NOTE:	All NsVirtualLink instances of a particular NS DF based on a specific "NsVirtualLinkDesc"
+      have the same characteristics as they use the same "VirtualLinkProfile".
     type: object
     required:
       - nsVirtualLinkProfileId
@@ -6454,8 +6469,7 @@ definitions:
       nsVirtualLinkProfileId:
         description: >
           Identifier of the virtual link profile to be used to create a new NsVirtualLink instance.
-          All NsVirtualLink instances of a particular NS DF based on a specific "NsVirtualLinkDesc"
-          have the same characteristics as they use the same "VirtualLinkProfile".
+          See note.
         $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
 
   NestedNsLocationConstraint:
@@ -6496,6 +6510,7 @@ definitions:
   TerminateVnfData:
     description: >
       This type represents the information to terminate a VNF that is part of an NS.
+      NOTE:	If the VNF is still in service, requesting forceful termination can adversely impact network service.
     type: object
     required:
       - vnfInstanceId
@@ -6507,8 +6522,7 @@ definitions:
       terminationType:
         description: >
           Indicates whether forceful or graceful termination is requested.
-          If the VNF is still in service, requesting forceful termination can
-          adversely impact network service.
+          See note.
           Permitted values:
           -	FORCEFUL
           -	GRACEFUL
@@ -6538,6 +6552,11 @@ definitions:
         $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
 
   VipCpInfo:
+    description: >
+      This type provides information related to virtual IP (VIP) CP. It shall comply with the provisions
+      defined in table 6.5.3.97 1.
+      NOTE:   It is possible that there is no associated VnfcCp because the VIP CP is available
+      but not associated yet.
     type: object
     required:
       - cpInstanceId
@@ -6563,9 +6582,7 @@ definitions:
           $ref: "#/definitions/CpProtocolInfo"
       associatedVnfcCpIds:
         description: >
-          Identifiers of the VnfcCps that share the virtual IP addresse allocated to the VIP CP instance.
-
-          It is possible that there is no associated VnfcCp because the VIP CP is available but not associated yet.
+          Identifiers of the VnfcCps that share the virtual IP addresse allocated to the VIP CP instance. See note.
         type: array
         items:
           $ref: "#/definitions/IdentifierInVnf"