SOL005NSLifecycleManagement_def.yaml 267 KB
Newer Older
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
    properties:
      logicalInterfaceIpAddress:
        description: >
          IP addressing information associated to a logical interface. Shall be present if the "interfaceType" of the
          SiteToWanLayer2ProtocolData is equal to "LOGICAL".
        type: object
        required:
          - ipAddress
          - associatedSegmentId
        properties:
          ipAddress:
            description: >
              The IP address to be assigned to the interface.
            $ref: "#/definitions/IpAddress"
          associatedSegmentId:
            description: >
              The associated segment identifier that has triggered the creation of the logical interface.
              The value shall be one of the values listed in the "wanSegmentIds" of the "siteToWanLayer2ProtocolData".
            type: string
      routingInfo:
        description: >
          The routing information that is activated on the connectivity service endpoint. More than one "routingInfo" is
          allowed to enable stacking different routing protocols (e.g., one routing protocol for IPv4 and another one for IPv6).
        type: object
        required:
          - routingProtocol
6027
          - routingAddressFamily
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
        properties:
          routingProtocol:
            description: >
              The routing protocol that is activated on the connectivity service endpoint.
              Permitted values:
              -	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:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
6098
                description: >
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
                  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
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
            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"
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
      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:
6183
6184
          -	L2
          -	L3
6185
6186
        type: string
        enum:
6187
6188
          - L2
          - L3
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
      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:
6245
6246
          -	EVPN_BGP_MPLS: as specified in IETF RFC 7432.
          - EVPN_VPWS: as specified in IETF RFC 8214.
6247
          -	VPLS_BGP: as specified in IETF RFC 4761 and IETF RFC 6624.
6248
6249
          -	VPLS_LDP_L2TP: as specified in IETF RFC 4762 and IETF RFC 6074.
          -	VPWS_LDP_L2TP: as specified in IETF RFC 6074.
6250
6251
        type: string
        enum:
6252
6253
          - EVPN_BGP_MPLS
          - EVPN_VPWS
6254
          - VPLS_BGP
6255
6256
          - VPLS_LDP_L2TP
          - VPWS_LDP_L2TP
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
      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.
6401
6402
6403
6404

      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.
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
    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.
6417
          See note.
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
        $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
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
      - 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"

6468
6469
6470
6471
6472
6473
  TerminateNsData:
    type: object
    properties:
      additionalParamsforNs:
        description: >
          Allows the OSS/BSS to provide additional parameter(s) to the termination process at the NS level.
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
        $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"
For faster browsing, not all history is shown. View entire blame