SOL003VNFLifecycleManagement_def.yaml 61.1 KB
Newer Older
        $ref: "#/definitions/VnfInfoModifications"
      changedExtConnectivity:
        description: >
          Information about changed external connectivity, if applicable.
          This allows the NFVO to obtain the information contained in the
          latest "result" notification if it has not received it due to an
          error or a wrongly configured subscription filter.
        type: array
        items:
          $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ExtVirtualLinkInfo"
      _links:
        description: >
          Links to resources related to this resource.
        type: object
        required:
          - self
          - vnfInstance
        properties:
          self:
            description: >
              URI of this resource.
            $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
          vnfInstance:
            description: >
              Link to the VNF instance that the operation applies to.
            $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
          grant:
            description: >
              Link to the grant for this operation, if one exists.
            $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
          cancel:
            description: >
              Link to the task resource that represents the "cancel" operation
              for this VNF LCM operation occurrence, if cancelling is
              currently allowed.
            $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
          retry:
            description: >
              Link to the task resource that represents the "retry" operation
              for this VNF LCM operation occurrence, if retrying is currently
              allowed.
            $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
          rollback:
            description: >
              Link to the task resource that represents the "rollback"
              operation for this VNF LCM operation occurrence, if rolling back
              is currently allowed.
            $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
          fail:
            description: >
              Link to the task resource that represents the "fail" operation
              for this VNF LCM operation occurrence, if declaring as failed is
              currently allowed.
            $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"

  AffectedVirtualLink:
    description: >
      This type provides information about added, deleted, modified and
      temporary VLs, and added or removed VNF link ports. 
      It shall comply with the provisions in table 5.5.3.14-1.
    type: object
    required:
      - id
      - vnfVirtualLinkDescId
      - changeType
      - networkResource
    properties:
      id:
        description: >
          Identifier of the virtual link instance, identifying the applicable
          "vnfVirtualLinkResourceInfo" entry in the "VnfInstance" data type.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
      vnfVirtualLinkDescId:
        description: >
          Identifier of the related VLD in the VNFD.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
      changeType:
        description: >
          Signals the type of change. Permitted values:
          * ADDED
          * REMOVED
          * MODIFIED
          * TEMPORARY
          * LINK_PORT_ADDED
          * LINK_PORT_REMOVED
          For a temporary resource, an AffectedVirtualLink structure exists as
          long as the temporary resource exists.

          NOTE 1:	When signalling the addition (LINK_PORT_ADDED) or removal (LINK_PORT_REMOVED) of VNF link 
          ports, the "networkResource" and "resourceDefinitionId" attributes refer to the affected virtual 
          link instance, not the link port instance. The resource handles of the affected VNF link ports can 
          be found by dereferencing the identifiers in the "vnfLinkPortIds" attribute.
        type: string
        enum:
          - ADDED
          - REMOVED
          - MODIFIED
          - TEMPORARY
          - LINK_PORT_ADDED
          - LINK_PORT_REMOVED
      networkResource:
        description: >
          Reference to the VirtualNetwork resource. Detailed information is
          (for new and modified resources) or has been (for removed
          resources) available from the VIM.

          NOTE 1:	When signalling the addition (LINK_PORT_ADDED) or removal (LINK_PORT_REMOVED) of VNF link 
          ports, the "networkResource" and "resourceDefinitionId" attributes refer to the affected virtual 
          link instance, not the link port instance. The resource handles of the affected VNF link ports can 
          be found by dereferencing the identifiers in the "vnfLinkPortIds" attribute.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ResourceHandle"
      virtualLinkPortIds:
        description: >
          Identifiers of the link ports of the affected VL related to the change. 
          Each identifier references a "VnfLinkPortInfo" structure.
          Shall be set when changeType is equal to "LINK_PORT_ADDED" or "LINK_PORT_REMOVED", 
          and the related "VnfLinkPortInfo" structures are present (case "added") or have 
          been present (case "removed") in the "VnfVirtualLinkResourceInfo" or "ExtManagedVirtualLinkInfo" 
          structures that are represented by the "vnfVirtualLinkResource¬Info" or "extManagedVirtualLinkInfo" 
          attribute in the "VnfInstance" structure. See note 1.

          NOTE 1:	When signalling the addition (LINK_PORT_ADDED) or removal (LINK_PORT_REMOVED) of VNF link 
          ports, the "networkResource" and "resourceDefinitionId" attributes refer to the affected virtual 
          link instance, not the link port instance. The resource handles of the affected VNF link ports can 
          be found by dereferencing the identifiers in the "vnfLinkPortIds" attribute.
        type: array
        items:
          $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
      resourceDefinitionId:
        description: >
          The identifier of the "ResourceDefinition" in the granting exchange
          related to the LCM operation occurrence. It shall be present when an
          applicable GrantInfo for the granted resource exists.
          The "resourceDefinitionId" attribute provides information to the API
          consumer (i.e. the NFVO) to assist in correlating the resource changes
          performed during the LCM operation with the granted resources in a
          specific Grant exchange, which is identified by the "grantId" available
          in the "Individual VNF lifecycle management operation occurrence" and
          the "id" in the "Individual Grant".

          NOTE 1:	When signalling the addition (LINK_PORT_ADDED) or removal (LINK_PORT_REMOVED) of VNF link 
          ports, the "networkResource" and "resourceDefinitionId" attributes refer to the affected virtual 
          link instance, not the link port instance. The resource handles of the affected VNF link ports can 
          be found by dereferencing the identifiers in the "vnfLinkPortIds" attribute.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierLocal"
      zoneId:
        description: >
          The identifier of the resource zone, as managed by the resource
          management layer (typically, the VIM), where the referenced VirtualNetwork
          resource is placed. Shall be provided if this information is available from the VIM.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
      metadata:
        description: >
          Metadata about this resource.
          The content of this attribute shall be a copy of the content of the
          "metadata" attribute of the VnfVirtualLinkResourceInfo structure.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"

  AffectedExtLinkPort:
    description: >
      This type provides information about added and deleted external link ports (link ports attached to external 
      virtual links). It shall comply with the provisions in table 5.5.3.14a-1.
    type: object
    required:
      - id
      - changeType
      - extCpInstanceId
      - resourceHandle
    properties:
      id:
        description: >
          Identifier of the link port, identifying the applicable "extLinkPorts" entry in the "ExtVirtualLinkInfo" 
          data type (see clause 5.5.3.2).
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
      changeType:
        description: >
          Signals the type of change.
          Permitted values:
          -	ADDED
          -	REMOVED
        type: string
        enum:
          - ADDED
          - REMOVED
      extCpInstanceId:
        description: >
          Identifier of the related external CP instance.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
      resourceHandle:
        description: >
          Reference to the link port resource. Detailed information is (for added resources) 
          or has been (for removed resources) available from the VIM.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ResourceHandle"
      resourceDefinitionId:
        description: >
          The identifier of the "ResourceDefinition" in the granting exchange related to the LCM 
          operation occurrence. It shall be present when an applicable GrantInfo for the granted 
          resource exists. See note.

          NOTE:	The "resourceDefinitionId" attribute provides information to the API consumer 
          (i.e. the NFVO) to assist in correlating the resource changes performed during the LCM 
          operation with the granted resources in a specific Grant exchange, which is identified 
          by the "grantId" available in the "Individual VNF lifecycle management operation occurrence" 
          and the "id" in the "Individual Grant".
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierLocal"