SOL005NSLifecycleManagement_def.yaml 267 KB
Newer Older
              -	BGP: used for dynamic routing BGPv4.
              -	RIP: used for dynamic routing RIPv2.
              -	OSPF: used for dynamic routing (OSPF version 2 for IPv4; and OSPF version 3 for IPv6).
              -	STATIC: used for static routing.
              -	DIRECT: used when the NFVI-PoP network is directly connected to the WAN provider network.
              -	VRRP: used when the NFVI-PoP network is directly connected to the WAN provider network with virtual
                router redundancy protocol support (VRRP).
            type: string
            enum:
              - BGP
              - RIP
              - OSPF
              - STATIC
              - DIRECT
              - VRRP
          staticRouting:
            description: >
              Defines a static route. It shall only be present if the routingProtocol="STATIC".
            type: object
            required:
              - ipVersion
              - ipPrefix
              - prefixSize
              - nextHop
            properties:
              ipVersion:
                description: >
                  The IP version applicable to the routing entry.
                  Permitted values:
                  -	IPV4
                  -	IPV6
                type: string
                enum:
                  - IPV4
                  - IPV6
              ipPrefix:
                description: >
                  The IP network prefix.
                $ref: '#/definitions/IpAddress'
              prefixSize:
                description: >
                  The IP prefix size.
                type: number
              nextHop:
                description: >
                  The next hop’s IP address.
                $ref: '#/definitions/IpAddress'
          routingAddressFamily:
            description: >
              The IP version applicable to the dynamic routing protocol. Shall be present for dynamic routing protocols.
              Permitted values:
              -	IPV4
              -	IPV6
            type: string
            enum:
              - IPV4
              - IPv6
          ospfRouting:
            description: >
              Defines parameters for OSPF routing. It shall only be present if the routingProtocol="OSPF".
            type: object
            required:
              - areaId
            properties:
              areaId:
                description: >
                  The routing area identifier, e.g., a number or an IP address.
                type: string
          bgpRouting:
            description: >
              Defines parameters for BGP routing. It shall only be present if the routingProtocol="BGP".
            type: object
            required:
              - bgpAs
            properties:
              bgpAs:
                description: >
                  The Autonomous System (AS) identification applicable to the BGP routing info entry.
                type: object
              bgpNeighbour:
                description: >
                  The IP address of the BGP neighbour.
                $ref: '#/definitions/IpAddress'
              bgpAdditionalParam:
                description: >
                  Additional parameters for setting up the BGP neighbour, such as information about the remote AS.
                $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
          routeMapsDistribution:
            description: >
              Maps of routes that are permitted or denied for redistribution.
            type: object
            required:
              - policy
              - sequence
              - matchAndSetRule
            properties:
              policy:
                description: >
                  The policy to apply to the route distribution.

                  Permitted values:
                  -	PERMIT
                  -	DENY
                type: string
                enum:
                  - PERMIT
                  - DENY
              sequence:
                description: >
                  Sequence or index number assigned to the route-map.
                type: number
              matchAndSetRule:
                description: >
                  Set of "match" and "set" rules for the distribution of routing information. "Match" key entries define
                  the routes that are selected. "Set" key entries define what information to modify when distributing the
                  routing information.
                $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
      mtuL3:
        description: >
          Maximum Transmission Unit (MTU) that can be forwarded at layer 3 (in bytes). Default value is "1500" (bytes).
        type: number
      virtualRoutingAndForwarding:
        description: >
          Configuration related to the virtual routing and forwarding (VRF).
        type: object
        required:
          - vrfName
        properties:
          vrfName:
            description: >
              Name (or identifier) of the VRF instance.
            type: string
      bfdConfig:
        description: >
          Configuration related to bidirectional forwarding detection (BFD).
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"

  MscsConfigData:
    description: >
      This type provides configuration data for the creation of an MSCS. It shall comply with the provisions defined in
      Table 6.5.3.87-1.
    type: object
    required:
      - mscsType
    properties:
      mscsType:
        description: >
          The type of connectivity that is requested to be provided to the virtualized networks in the NFVI-PoP and
          characterizes the connectivity service across the WAN.
          Permitted values:
      siteAccessProtectionSchemes:
        description: >
          Information to determine the proper MSCS endpoints configuration to fulfil certain resiliency/protection
          requirements, e.g., by considering certain availability and redundancy of connectivity service endpoints in
          between NFVI-PoP and WAN.
        type: array
        items:
          type: object
          required:
            - locationConstraints
            - protectionScheme
          properties:
            locationConstraints:
              description: >
                Defines the location constraints according to an NFVI-PoP (site).
              $ref: '#/definitions/LocationConstraints'
            protectionScheme:
              description: >
                Defines the protection scheme.
                Permitted values:
                -	UNPROTECTED
                -	ONE_TO_ONE
                -	ONE_PLUS_ONE
                -	ONE_TO_N
              type: string
              enum:
                - UNPROTECTED
                - ONE_TO_ONE
                - ONE_PLUS_ONE
                - ONE_TO_N
      mtuMscs:
        description: >
          Maximum Transmission Unit (MTU) that can be forwarded over the MSCS (in bytes). Default value is "1500" (bytes).
        type: number
      wanLayer2ProtocolData:
        description: >
          Layer 2 protocol specific information for the configuration of the multi-site connectivity service over the WAN.
        $ref: '#/definitions/WanLayer2ProtocolData'
      wanLayer3ProtocolData:
        description: >
          Layer 3 protocol specific information for the configuration of the multi-site connectivity service over the WAN.
        $ref: '#/definitions/WanLayer3ProtocolData'

  WanLayer2ProtocolData:
    description: >
      This type provides information about Layer 2 protocol specific information for the configuration of the MSCS over
      the WAN. It shall comply with the provisions defined in Table 6.5.3.88-1.
    type: object
    required:
      - isSegmentPreservation
      - isSegmentCosPreservation
    properties:
      mscsLayer2Protocol:
        description: >
          Type of underlying connectivity service and protocol associated to the type of MSCS.
          Permitted values are as listed below and restricted by the type of MSCS:
          -	EVPN_BGP_MPLS: as specified in IETF RFC 7432.
          - EVPN_VPWS: as specified in IETF RFC 8214.
          -	VPLS_BGP: as specified in IETF RFC 4761 and IETF RFC 6624.
          -	VPLS_LDP_L2TP: as specified in IETF RFC 4762 and IETF RFC 6074.
          -	VPWS_LDP_L2TP: as specified in IETF RFC 6074.
          - EVPN_BGP_MPLS
          - EVPN_VPWS
          - VPLS_LDP_L2TP
          - VPWS_LDP_L2TP
      isSegmentPreservation:
        description: >
          Indicates the requirement of whether to ensure network segment (e.g., VLAN id) preservation across the MSCS
          endpoints (i.e., from/to the NFVI-PoPs). If "TRUE", segment identifiers shall be preserved, "FALSE" otherwise.
          Default value is "FALSE".
        type: boolean
      isSegmentCosPreservation:
        description: >
          Indicates the requirement of whether to ensure network segment class of service preservation across the MSCS
          endpoints (i.e., from/to the NFVI-PoPs). If "TRUE", segment class of service shall be preserved, "FALSE" otherwise.
          Default value is "FALSE".
        type: boolean

  WanLayer3ProtocolData:
    description: >
      Type of underlying connectivity service and protocol associated to the type of MSCS.
      Permitted values are as listed below and restricted by the type of MSCS:
      -	BGP_IP_VPN: BGP/MPLS based IP VPN as specified in IETF RFC 4364.
    type: string
    enum:
      - BGP_IP_VPN

  ModifyWanConnectionInfoData:
    description: >
      This type represents attribute modifications for WAN connection information. The attributes of the "WanConnectionInfo"
      that can be modified according to the provisions of the "UpdateNsRequest" in clause 6.5.2.12 related to WAN connection
      information are included in the "ModifyWanConnectionInfoData" data type. It shall comply with the provisions defined
      in table 6.5.3.92-1.
    type: object
    required:
      - wanConnectionInfoId
    properties:
      wanConnectionInfoId:
        description: >
          Identifier of the WAN connection information to modify.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      mscsName:
        description: >
          New value of the "mscsName" attribute in "MscsInfo", or "null" to remove the attribute.
        type: string
      mscsDescription:
        description: >
          New value of the "mscsDescription" attribute in "MscsInfo", or "null" to remove the attribute.
        type: string
      mscsEndpoints:
        description: >
          New content of certain entries of MSCS endpoints in the "mscsEndpoints" attribute in "MscsInfo",
          as defined below this table.
        type: array
        items:
          $ref: "#/definitions/MscsEndpointInfo"
      removeMscsEndpointIds:
        description: >
          List of identifier entries to be deleted from the "mscsEndpoints" attribute array in "MscsInfo", to be used
          as "deleteIdList" as defined below this table.
        type: array
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      connectivityServiceEndpoints:
        description: >
          New content of certain entries of connectivity service endpoints in the "connectivityServiceEndpointInfos"
          attribute in "WanConnectionProtocolInfo", as defined below this table.
        type: array
        items:
          $ref: "#/definitions/ConnectivityServiceEndpointInfo"
      removeConnectivityServiceEndpoints:
        description: >
          List of identifier entries to be deleted from the "connectivityServiceEndpointInfos" attribute array in
          "WanConnectionProtocolInfo", to be used as "deleteIdList" as defined below this table.
        type: array
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"

  WanConnectionInfoModification :
    description: >
      This type represents attribute modifications that were performed on WAN connection information.
      The attributes that can be included consist of those requested to be modified explicitly with the "UpdateNsRequest"
      data structure. It shall comply with the provisions defined in table 6.5.3.93-1.
    type: object
    required:
      - wanConnectionInfoId
    properties:
      wanConnectionInfoId:
        description: >
          Identifier of the WAN connection information that has been modified.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      mscsName:
        description: >
          If present, this attribute signals modifications of the "mscsName" attribute in "MscsInfo" as defined in
          clause 6.5.3.82.
        type: string
      mscsDescription:
        description: >
          If present, this attribute signals modifications of the "mscsDescription" attribute in "MscsInfo" as defined
          in clause 6.5.3.82.
        type: string
      mscsEndpoints:
        description: >
          If present, this attribute signals modifications of certain entries in the "mscsEndpoints" attribute array in
          "MscsInfo", as defined in clause 6.5.3.82.
        type: array
        items:
          $ref: "#/definitions/MscsEndpointInfo"
      removeMscsEndpointIds:
        description: >
          If present, this attribute signals the deletion of certain entries in the "mscsEndpoints" attribute array in
          "MscsInfo", as defined in clause 6.5.3.82.
        type: array
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      connectivityServiceEndpoints:
        description: >
          If present, this attribute signals modifications of certain entries in the "connectivityServiceEndpoints"
          attribute array in "WanConnectionProtocolInfo", as defined in clause 6.5.3.91.
        type: array
        items:
          $ref: "#/definitions/ConnectivityServiceEndpointInfo"
      removeConnectivityServiceEndpoints:
        description: >
          If present, this attribute signals the deletion of certain entries in the "connectivityServiceEndpoints"
          attribute array in "WanConnectionProtocolInfo", as defined in clause 6.5.3.91.
        type: array
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"

  AddNsVirtualLinkData:
    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.
    type: object
    required:
      - nsVirtualLinkProfileId
    properties:
      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".
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"

  NestedNsLocationConstraint:
    description: >
      This type represents the association of location constraints to a nested NS instance to be created according to a
      specific NS profile. It shall comply with the provisions defined in Table 6.5.3.96-1.

      NOTE: These constraints are typically determined by the OSS/BSS from service requirements (e.g. latency requirements,
      regulatory requirements). The NFVO can map such location constraints to eligible NFVI-PoPs/resource zones where
      the VNF instances as part of the nested NS are to be created.
    type: object
    required:
      - nsProfileId
      - locationConstraints
    properties:
      nsProfileId:
        description: >
          Identifier of an NsProfile defined in the NSD which the existing nested NS instance shall be matched with.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNs"
      locationConstraints:
        description: >
          Defines the location constraints for the nested NS instance to be created based on the NS profile.
        $ref: "#/definitions/LocationConstraints"

  LcmOpOccNotificationVerbosityType:
    description: >
      The enumeration LcmOpOccNotificationVerbosityType provides values to control the verbosity of LCM operation
      occurrence notifications. It shall comply with the provisions defined in table 6.5.4.11-1.
      * FULL: This signals a full notification which contains all change details.
      * SHORT: This signals a short notification which omits large-volume change details to reduce the size of data to
               be sent via the notification mechanism.
    type: string
    enum:
      - FULL
      - SHORT

  TerminateVnfData:
    description: >
      This type represents the information to terminate a VNF that is part of an NS.
    type: object
    required:
      - vnfInstanceId
    properties:
      vnfInstanceId:
        description: >
          Identifies the VNF instance, part of the NS, to be terminated.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      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.
          Permitted values:
          -	FORCEFUL
          -	GRACEFUL
        type: string
        enum:
          - FORCEFUL
          - GRACEFUL
      gracefulTerminationTimeout:
        description: >
          The attribute is only applicable in case of graceful termination.
          It defines the time to wait for the VNF to be taken out of service before
          shutting down the VNF and releasing the resources.
          The unit is seconds.
        type: integer
      additionalParams:
        description: >
          Additional parameters passed by the OSS/BSS as input to the termination process, specific to the VNF being terminated.
          EXAMPLE:	Input parameters to VNF-specific termination procedures.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"

  TerminateNsData:
    type: object
    properties:
      additionalParamsforNs:
        description: >
          Allows the OSS/BSS to provide additional parameter(s) to the termination process at the NS level.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"

  VipCpInfo:
    type: object
    required:
      - cpInstanceId
      - cpdId
    properties:
      cpInstanceId:
        description: >
          Identifier of this VIP CP instance and of this VipCpInfo information element.
        $ref: "#/definitions/IdentifierInVnf"
      cpdId:
          description: >
            Identifier of the VIP Connection Point Descriptor, VipCpd, in the VNFD.
          $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
      vnfExtCpId:
        description: >
          When the VIP CP is exposed as external CP of the VNF, the identifier of this external VNF CP instance.
        $ref: "#/definitions/IdentifierInVnf"
      cpProtocolInfo:
        description: >
          Protocol information for this CP. There shall be one cpProtocolInfo for layer 3. There may be one cpProtocolInfo for layer 2.
        type: array
        items:
          $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.
        type: array
        items:
          $ref: "#/definitions/IdentifierInVnf"
      vnfLinkPortId:
        description: >
          Identifier of the "VnfLinkPortInfo" structure in the "VnfVirtualLinkResourceInfo" or "ExtManagedVirtual-Link¬Info" structure.
          Shall be present if the CP is associated to a link port on an internal VL (including externally-managed internal VL).
        $ref: "#/definitions/IdentifierInVnf"
      metadata:
        description: >
          Allows the OSS/BSS to provide additional parameter(s) to the termination process at the NS level.
        type: array
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"