SOL005NSLifecycleManagement_def.yaml 159 KB
Newer Older
2001
2002
2003
2004
          * ADD_PNF: Adding PNF
          * MODIFY_PNF: Modifying PNF
          * REMOVE_PNF: Removing PNF
        type: string
2005
        enum:
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
          - ADD_VNF
          - REMOVE_VNF
          - INSTANTIATE_VNF
          - CHANGE_VNF_DF
          - OPERATE_VNF
          - MODIFY_VNF_INFORMATION
          - CHANGE_EXTERNAL_VNF_CONNECTIVITY
          - REMOVE_SAP
          - ADD_NESTED_NS
          - REMOVE_NESTED_NS
          - ASSOC_NEW_NSD_VERSION
          - MOVE_VNF
          - ADD_VNFFG
2019
2020
2021
2022
2023
2024
          - REMOVE_VNFFG
          - UPDATE_VNFFG
          - CHANGE_NS_DF
          - ADD_PNF
          - MODIFY_PNF
          - REMOVE_PNF
2025
2026
2027
2028
2029
      addVnfIstance:
        description: >
          Identifies an existing VNF instance to be added to the
          NS instance. It shall be present only if updateType = "ADD_VNF".         
        type: array
2030
        items:
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
          $ref: "#/definitions/VnfInstanceData"
      removeVnfInstanceId:
        description: >
          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.
        type: array
2042
        items:
2043
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
2044
2045
2046
2047
2048
2049
      instantiateVnfData:
        description: >
          Identifies the new VNF to be instantiated. It can be used
          e.g. for the bottom-up NS creation. It shall be present
          only if updateType = "INSTANTIATE_VNF".
        type: array
2050
2051
        items:
          $ref: "#/definitions/InstantiateVnfData"
2052
2053
2054
2055
2056
      changeVnfFlavourData:
        description: >
          Identifies the new DF of the VNF instance to be
          changed to. It shall be present only if updateType = "CHANGE_VNF_DF".
        type: array
2057
2058
        items:
          $ref: "#/definitions/ChangeVnfFlavourData"
2059
2060
2061
2062
2063
      operateVnfData:
        description: >
          Identifies the state of the VNF instance to be changed. 
          It shall be present only if updateType = "OPERATE_VNF".
        type: array
2064
2065
        items:
          $ref: "#/definitions/OperateVnfData"
2066
2067
2068
2069
2070
2071
      modifyVnfInfoData:
        description: >
          Identifies the VNF information parameters and/or the
          configurable properties of VNF instance to be modified.
          It shall be present only if updateType = "MODIFY_VNF_INFORMATION".
        type: array
2072
        items:
2073
2074
2075
2076
2077
2078
2079
          $ref: "#/definitions/ModifyVnfInfoData"
      changeExtVnfConnectivityData:
        description: >
          Specifies the new external connectivity data of the VNF
          instance to be changed. It shall be present only if
          updateType = "CHANGE_EXTERNAL_VNF_CONNECTIVITY".
        type: array
2080
2081
        items:
          $ref: "#/definitions/ChangeExtVnfConnectivityData"
2082
2083
2084
2085
2086
      addSap:
        description: >
          Identifies a new SAP to be added to the NS instance.
          It shall be present only if updateType = "ADD_SAP."
        type: array
2087
2088
        items:
          $ref: "#/definitions/SapData"
2089
2090
2091
2092
2093
      removeSapId:
        description: >
          The identifier an existing SAP to be removed from the
          NS instance. It shall be present only if updateType = "REMOVE_SAP."
        type: array
2094
        items:
2095
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
2096
      addNestedNsData:
2097
2098
2099
2100
2101
        description: >
          The identifier of an existing nested NS instance to be
          added to (nested within) the NS instance. It shall be
          present only if updateType = "ADD_NESTED_NS".
        type: array
2102
        items:
2103
          $ref: "#/definitions/NestedNsInstanceData"
2104
      removeNestedNsId:
2105
2106
2107
2108
2109
2110
        description: >
          The identifier of an existing nested NS instance to be
          removed from the NS instance. It shall be present only if
          updateType = "REMOVE_NESTED_NS".
        type: array
        items:
2111
          $ref: "#/definitions/IdentifierInNs"
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
      assocNewNsdVersionData:
        description: >
          Specify the new NSD to be used for the NS instance. It
          shall be present only if updateType =
          ASSOC_NEW_NSD_VERSION".
        $ref: "#/definitions/AssocNewNsdVersionData"
      moveVnfInstanceData:
        description: >
          Specify existing VNF instance to be moved from one NS
          instance to another NS instance. It shall be present only
          if updateType = MOVE_VNF".
        type: array
2124
2125
        items:
          $ref: "#/definitions/MoveVnfInstanceData"
2126
2127
2128
2129
2130
2131
      addVnffg:
        description: >
          Specify the new VNFFG to be created to the NS
          Instance. It shall be present only if updateType =
          "ADD_VNFFG".
        type: array
2132
2133
        items:
          $ref: "#/definitions/AddVnffgData"
2134
2135
2136
2137
2138
2139
      removeVnffgId:
        description: >
          Identifier of an existing VNFFG to be removed from the
          NS Instance. It shall be present only if updateType =
          "REMOVE_VNFFG".
        type: array
2140
        items:
2141
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
2142
2143
2144
2145
2146
2147
      updateVnffg:
        description: >
          Specify the new VNFFG Information data to be updated
          for a VNFFG of the NS Instance. It shall be present only
          if updateType = "UPDATE_VNFFG".
        type: array
2148
2149
        items:
          $ref: "#/definitions/UpdateVnffgData"
2150
2151
2152
2153
2154
      changeNsFlavourData:
        description: >
          Specifies the new DF to be applied to the NS instance. It
          shall be present only if updateType =
          "CHANGE_NS_DF".
2155
        $ref: "#/definitions/ChangeNsFlavourData"
2156
2157
2158
2159
2160
      addPnfData:
        description: >
          specifies the PNF to be added into the NS instance. 
          It shall be present only if updateType = "ADD_PNF".
        type: array
2161
2162
        items:
          $ref: "#/definitions/AddPnfData"
2163
2164
2165
2166
2167
      modifyPnfData:
        description: >
          Specifies the PNF to be modified in the NS instance. 
          It shall be present only if updateType = "MODIFY_PNF".
        type: array
2168
2169
        items:
          $ref: "#/definitions/ModifyPnfData"
2170
2171
2172
2173
2174
      removePnfId:
        description: >
          Identifier of the PNF to be deleted from the NS instance.
          It shall be present only if updateType = "REMOVE_PNF".
        type: array
2175
        items:
2176
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
2177
2178
2179
2180
2181
      updateTime:
        description: >
          Timestamp indicating the update time of the NS, i.e. the
          NS will be updated at this timestamp. Cardinality "0"
          indicates the NS update takes place immediately.
2182
2183
        $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"

2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
  InstantiateVnfData:
    description: >
      This type represents the information related to a SAP of a NS. The InstantiateVnfData data type specifies the
      parameters that are needed for VNF instantiation. This information element is used for the bottom-up NS creation when
      the OSS/BSS explicitly requests VNF instantiation for a given NS. When the NFVO invokes the Instantiate VNF
      update operation, a set of these parameters are then passed by the NFVO to the VNFM. It shall comply with the
      provisions defined in Table 6.5.3.24-1.
    type: object
    required:
      - vnfdId
2194
      - vnfFlavourId
2195
2196
2197
2198
2199
    properties:
      vnfdId:
        description: >
          Information sufficient to identify the VNFD which defines
          the VNF to be instantiated.
2200
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
2201
2202
2203
      vnfFlavourId:
        description: >
          Identifier of the VNF deployment flavor to be instantiated.
2204
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
2205
2206
2207
2208
2209
2210
      vnfInstantiationLevelId:
        description: >
          Identifier of the instantiation level of the deployment
          flavor to be instantiated. If not present, the default
          instantiation level as declared in the VNFD is
          instantiated.
2211
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
      vnfInstanceName:
        description: >
          Human-readable name of the VNF instance to be created.
        type: string
      vnfInstanceDescription:
        description: >
          Human-readable description of the VNF instance to be created.
        type: string
      extVirtualLinks:
        description: >
          Information about external VLs to connect the VNF to.
        type: array
2224
        items:
2225
          $ref: "#/definitions/ExtVirtualLinkData"
2226
2227
2228
2229
      extManagedVirtualLinks:
        description: >
          Information about internal VLs that are managed by other entities than the VNFM.
        type: array
2230
        items:
2231
          $ref: "#/definitions/ExtManagedVirtualLinkData"
2232
2233
      localizationLanguage:
        description: >
2234
          Localization language of the VNF to be instantiated.
2235
          The value shall comply with the format defined in IETF RFC 5646.
2236
2237
2238
2239
2240
        type: string
      additionalParams:
        description: >
          Additional input parameters for the instantiation process,
          specific to the VNF being instantiated.
2241
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
      metadata:
        description: >
          This attribute provides values for the "metadata" input parameter of
          the Create VNF Identifier operation.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
      extensions:
        description: >
          This attribute provides values for the "extensions" input parameter of
          the Instantiate VNF operation.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265

  ChangeVnfFlavourData:
    description: >
      The type represents the information that is requested to be changed
      deployment flavor for an existing VNF instance.
      It shall comply with the provisions defined in Table 6.5.3.25-1.
    type: object
    required:
      - vnfInstanceId
      - newFlavourId
    properties:
      vnfInstanceId:
        description: >
          Identifier of the VNF instance to be modified.
2266
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
2267
2268
2269
      newFlavourId:
        description: >
          Identifier of the VNF deployment flavor to be instantiated.
2270
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
2271
2272
2273
2274
2275
2276
      instantiationLevelId:
        description: >
          Identifier of the instantiation level of the deployment
          flavor to be instantiated. If not present, the default
          instantiation level as declared in the VNFD is
          instantiated.
2277
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
2278
2279
2280
2281
2282
      extVirtualLinks:
        description: >
          Information about external VLs to connect the VNF to.
        type: array
        items:
2283
          $ref: "#/definitions/ExtVirtualLinkData"
2284
2285
2286
2287
2288
      extManagedVirtualLinks:
        description: >
          information about internal VLs that are managed by NFVO.
        type: array
        items:
2289
          $ref: "#/definitions/ExtManagedVirtualLinkData"
2290
2291
2292
2293
2294
      additionalParams:
        description: >
          Additional input parameters for the flavor change
          process, specific to the VNF being modified, as declared
          in the VNFD as part of "ChangeVnfFlavourOpConfig".
2295
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309

  OperateVnfData:
    description: >
      This type represents a VNF instance for which the operational state 
      needs to be changed and the requested new state. It
      shall comply with the provisions defined in Table 6.5.3.31-1.
    type: object
    required:
      - vnfInstanceId
      - changeStateTo
    properties:
      vnfInstanceId:
        description: >
          Identifier of the VNF instance.
2310
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
      changeStateTo:
        description: >
          The desired operational state (i.e. started or stopped)
          to change the VNF to.
        $ref: "#/definitions/OperationalStates"
      stopType:
        description: >
          It signals whether forceful or graceful stop is requested.           
        $ref: "#/definitions/StopType"
      gracefulStopTimeout:
        description: >
          The time interval (in seconds) to wait for the VNF to be
          taken out of service during graceful stop, before
          stopping the VNF.
        type: integer

  OperationalStates:
    description: >
      STARTED - The VNF instance is up and running.
      STOPPED - The VNF instance has been shut down.
    type: string
    enum:
      - STARTED
      - STOPPED
2335

2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
  StopType:
    description: >
      * FORCEFUL: The VNFM will stop the VNF immediately after accepting the
        request.
      * GRACEFUL: The VNFM will first arrange to take the VNF out of service
        after accepting the request. Once that operation is successful or once
        the timer value specified in the "gracefulStopTimeout" attribute
        expires, the VNFM will stop the VNF.
    type: string
    enum:
      - FORCEFUL
      - GRACEFUL

  ModifyVnfInfoData:
    description: >
      This type represents the information that is requested to be modified for a VNF instance. The information to be
      modified shall comply with the associated NSD.
      EXAMPLE. The vnfPkgId attribute value for a particular VNF instance can only be updated with a value that
      matches the identifier value of a VNF package whose vnfdId is present in the associated profile of the NSD.
    type: object
    required:
      - vnfInstanceId
    properties:
      vnfInstanceId:
        description: >
          Identifier of the VNF instance.
2362
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
      vnfInstanceName:
        description: >
          New value of the "vnfInstanceName" attribute in
          "VnfInstance", or "null" to remove the attribute.
        type: string
      vnfInstanceDescription:
        description: >
          New value of the "vnfInstanceDescription" attribute in "VnfInstance",
          or "null" to remove the attribute.
        type: string
2373
      vnfdId:
2374
        description: >
2375
          New value of the "vnfdId" attribute in "VnfInstance".
2376
          The value "null" is not permitted
2377
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
2378
2379
2380
      vnfConfigurableProperties:
        description: >
          Modifications to entries in the
2381
          "vnfConfigurableProperties" attribute in "VnfInstance", as defined below in clause 6.5.3.57.
2382
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
2383
      metadata:
2384
        description: >
2385
          Modifications to entries in the "metadata" attribute in "VnfInstance", as defined below in clause 6.5.3.57.
2386
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
2387
      extensions:
2388
        description: >
2389
          Modifications to entries in the "extensions" attribute in "VnfInstance", as defined below in clause 6.5.3.57.
2390
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410

  ChangeExtVnfConnectivityData:
    description: >
      This type describes the information invoked by the NFVO to change the external VNF connectivity information
      maintained by the VNFM. The types of changes that this operation supports are:
      1) Disconnect the external CPs that are connected to a particular external VL, and connect them to a different
      external VL.
      2) Change the connectivity parameters of the existing external CPs, including changing addresses.
      NOTE: Depending on the capabilities of the underlying VIM resources, certain changes (e.g. modifying the IP
      address assignment) might not be supported without deleting the resource and creating another one with
      the modified configuration.
      This type shall comply with the provisions defined in Table 6.5.3.33-1.
    type: object
    required:
      - vnfInstanceId
      - extVirtualLink
    properties:
      vnfInstanceId:
        description: >
          Identifier of the VNF instance.
2411
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
2412
2413
2414
2415
2416
      extVirtualLink:
        description: >
          Information about external VLs to change (e.g. connect the VNF to).
        type: array
        items:
2417
          $ref: "#/definitions/ExtVirtualLinkData"
2418
2419
2420
2421
2422
      additionalParams:
        description: >
          Additional parameters passed by the OSS as input to
          the external connectivity change process, specific to the
          VNF instance being changed.
2423
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440

  AssocNewNsdVersionData:
    description: >
      This type specifies a new NSD version that is associated to the NS instance. After issuing the Update NS operation with
      updateType = "AssocNewNsdVersion", the NFVO shall use the referred NSD as a basis for the given NS instance.
      Different versions of the same NSD have same nsdInvariantId, but different nsdId attributes, therefore if the
      nsdInvariantId of the NSD version that is to be associated to this NS instance is different from the one used before, the
      NFVO shall reject the request. Only new versions of the same NSD can be associated to an existing NS instance. This
      data type shall comply with the provisions defined in Table 6.5.3.34-1.
    type: object
    required:
      - newNsdId
    properties:
      newNsdId:
        description: >
          Identifier of the new NSD version that is to be
          associated to the NS instance.
2441
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
      sync:
        description: >
          Specify whether the NS instance shall be automatically
          synchronized to the new NSD by the NFVO (in case of
          true value) or the NFVO shall not do any action (in case
          of a false value) and wait for further guidance from
          OSS/BSS (i.e. waiting for OSS/BSS to issue NS
          lifecycle management operation to explicitly add/remove
          VNFs and modify information of VNF instances
          according to the new NSD).
          The synchronization to the new NSD means e.g.
          instantiating/adding those VNFs whose VNFD is
          referenced by the new NSD version but not referenced
          by the old one, terminating/removing those VNFs whose
          VNFD is referenced by the old NSD version but not
          referenced by the new NSD version, modifying
          information of VNF instances to the new applicable
          VNFD provided in the new NSD version.
          A cardinality of 0 indicates that synchronization shall not be done.
        type: boolean

  MoveVnfInstanceData:
    description: >
      This type specifies existing VNF instances to be moved from one NS instance (source) to another NS instance
      (destination). The NS instance defined in the Update NS operation indicates the source NS instance and the destination
      NS instance is specified in this data type (referred to targetNsInstanceId).
      It shall comply with the provisions defined in Table 6.5.3.35-1.
    type: object
    required:
      - targetNsInstanceId
    properties:
      targetNsInstanceId:
        description: >
          Specify the target NS instance where the VNF instances
          are moved to.
2477
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
2478
2479
2480
2481
2482
      vnfInstanceId:
        description: >
          Specify the VNF instance that is moved.
        type: array
        items:
2483
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498

  AddVnffgData:
    description: >
      This type specifies the parameters used for the creation of a new VNFFG instance.
      It shall comply with the provisions defined in Table 6.5.3.36-1.
    type: object
    required:
      - vnffgdId
      - vnffgName
      - description
    properties:
      targetNsInstanceId:
        description: >
          Identifier of the VNFFGD used to create this VNFFG
          instance.
2499
        $ref: "#/definitions/IdentifierInNsd"
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
      vnffgName:
        description: >
          Human readable name for the VNFFG.
        type: string
      description:
        description: >
          Human readable description for the VNFFG.
        type: string

  UpdateVnffgData:
    description: >
      This type specifies the parameters used for the update of an existing VNFFG instance.
      It shall comply with the provisions defined in Table 6.5.3.37-1.
    type: object
    required:
      - vnffgInfoId
    properties:
      vnffgInfoId:
        description: >
          Identifier of an existing VNFFG to be updated for the NS Instance.
2520
        $ref: "#/definitions/IdentifierInNs"
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
      nfp:
        description: >
          Indicate the desired new NFP(s) for a given VNFFG
          after the operations of addition/removal of NS
          components (e.g. VNFs, VLs, etc.) have been
          completed, or indicate the updated or newly created
          NFP classification and selection rule which applied to an existing NFP.
        type: array
        items:
          $ref: "#/definitions/NfpData"
      nfpInfoId:
        description: >
          Identifier(s) of the NFP to be deleted from a given VNFFG.
        type: array
        items:
2536
          $ref: "#/definitions/IdentifierInNs"
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548

  NfpData:
    description: >
      This type contains information used to create or modify NFP instance parameters
      for the update of an existing VNFFG instance.
      It shall comply with the provisions defined in Table 6.5.3.38-1.
    type: object
    properties:
      nfpInfoId:
        description: >
          Identifier of the NFP to be modified. It shall be present
          for modified NFPs and shall be absent for the new NFP.
2549
2550
          It shall be present for modified NFPs and shall be absent 
          for the new NFP.
2551
        $ref: "#/definitions/IdentifierInNs"
2552
2553
2554
2555
      nfpName:
        description: >
          Human readable name for the NFP. It shall be present
          for the new NFP, and it may be present otherwise.
2556
2557
          It shall be present for the new NFP, and it may be 
          present otherwise.
2558
2559
2560
2561
2562
        type: string
      description:
        description: >
          Human readable description for the NFP. It shall be
          present for the new NFP, and it may be present otherwise.
2563
2564
          It shall be present for the new NFP, and it may be 
          present otherwise.
2565
        type: string
2566
      cpGroup:
2567
        description: >
2568
          Group(s) of CPs and/or SAPs which the NFP passes by.
2569
2570
2571
          Cardinality can be 0 if only updated or newly created
          NFP classification and selection rule which applied to an
          existing NFP is provided.
2572
2573
2574
2575
          At least a CP or an nfpRule shall be present.
          When multiple identifiers are included, the position of 
          the identifier in the cpGroup value specifies the position 
          of the group in the path.
2576
2577
        type: array
        items:
2578
          $ref: "#/definitions/CpGroupInfo"
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
      nfpRule:
        description: >
          NFP classification and selection rule. See note 1.
        $ref: "#/definitions/NfpRule"

  NfpRule:
    description: >
      The NfpRule data type is an expression of the conditions that shall be met
      in order for the NFP to be applicable to the packet. The condition acts as a flow classifier and
      it is met only if all the values expressed in the condition are matched
      by those in the packet. It shall comply with the provisions defined in Table 6.5.3.40-1.
    type: object
    properties:
      etherDestinationAddress:
        description: >
          Indicates a destination Mac address.
2595
        $ref: "#/definitions/MacAddress"
2596
2597
2598
      etherSourceAddress:
        description: >
          Indicates a source Mac address.
2599
        $ref: "#/definitions/MacAddress"
2600
2601
2602
2603
2604
2605
2606
2607
2608
      etherType:
        description: >
          Human readable description for the VNFFG.
        type: string
        enum:
          - IPV4
          - IPV6
      vlanTag:
        description: >
2609
          Indicates a VLAN identifier in an IEEE 802.1Q-2018
2610
2611
2612
          tag [6] Multiple tags can be included for QinQ stacking. See note.
        type: array
        items:
2613
          $ref: "../../definitions/SOL005_def.yaml#/definitions/String"
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
      protocol:
        description: >
          Indicates the L4 protocol, For IPv4 [7] this
          corresponds to the field called "Protocol" to identify
          the next level protocol. For IPv6 [28] this
          corresponds to the field is called the "Next Header" field.
          Permitted values: Any keyword defined in the IANA
          protocol registry [1], e.g.:
          TCP
          UDP
          ICMP
        type: string
        enum:
          - TCP
          - UDP
          - ICMP
      dscp:
        description: >
          For IPv4 [7] a string of "0" and "1" digits that
          corresponds to the 6-bit Differentiated Services
          Code Point (DSCP) field of the IP header.
          For IPv6 [28] a string of "0" and "1" digits that
          corresponds to the 6 differentiated services bits of
          the traffic class header field
        type: string
      sourcePortRange:
        description: >
          Indicates a range of source ports
2642
        $ref: "#/definitions/PortRange"
2643
2644
2645
      destinationPortRange:
        description: >
          Indicates a range of destination ports.
2646
        $ref: "#/definitions/PortRange"
2647
2648
2649
      sourceIpAddressPrefix:
        description: >
          Indicates the source IP address range in CIDR format.
2650
        $ref: "#/definitions/IpAddressPrefix"
2651
2652
2653
      destinationIpAddressPrefix:
        description: >
          Indicates the destination IP address range in CIDR format.
2654
        $ref: "#/definitions/IpAddressPrefix"
2655
2656
2657
2658
2659
      extendedCriteria:
        description: >
          Indicates values of specific bits in a frame.
        type: array
        items:
2660
          $ref: "#/definitions/Mask"
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674

  ChangeNsFlavourData:
    description: >
      This type specifies an existing NS instance for which the DF needs to be changed.
      This specifies the new DF, the instantiationLevel of the new DF that may be used and
      the additional parameters as input for the flavour change.
      It shall comply with the provisions defined in Table 6.5.3.39-1.
    type: object
    required:
      - newNsFlavourId
    properties:
      newNsFlavourId:
        description: >
          Identifier of an existing VNFFG to be updated for the NS Instance.
2675
        $ref: "#/definitions/IdentifierInNsd"
2676
2677
2678
2679
      instantiationLevelId:
        description: >
          Identifier of the instantiation level of the deployment flavour to be instantiated.
          If not present, the default instantiation level as declared in the NSD is instantiated.
2680
        $ref: "#/definitions/IdentifierInNsd"
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695

  AddPnfData:
    description: >
      This type specifies an PNF to be added to the NS instance and the PNF Profile
      to use for this PNF. It shall comply with the provisions defined in Table 6.5.3.14-1.
    type: object
    required:
      - pnfId
      - pnfName
      - pnfdId
      - pnfProfileId
    properties:
      pnfId:
        description: >
          Identifier of the PNF. This identifier is allocated by the OSS/BSS.
2696
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
2697
2698
2699
2700
2701
2702
2703
      pnfName:
        description: >
          Name of the PNF
        type: string
      pnfdId:
        description: >
          Identifier of the PNFD on which the PNF is based.
2704
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
2705
2706
2707
      pnfProfileId:
        description: >
          Identifier of related PnfProfile in the NSD on which the PNF is based.
2708
        $ref: "#/definitions/IdentifierInNsd"
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
      cpData:
        description: >
          Address assigned for the PNF external CP(s).
        type: array
        items:
          $ref: "#/definitions/PnfExtCpData"

  PnfExtCpData:
    description: >
      This type represents the configuration data on the external CP of the PNF.
      It shall comply with the provisions defined in
      Table 6.5.3.16-1.
    type: object
    required:
      - cpProtocolData
    properties:
      cpInstanceI16:
        description: >
          Identifier of the CP. Shall be present for existing CP.
2728
        $ref: "#/definitions/IdentifierInPnf"
2729
2730
2731
      cpdId:
        description: >
          Identifier of the Connection Point Descriptor (CPD) for this CP. Shall be present for new CP.
2732
        $ref: "#/definitions/IdentifierInNsd"
2733
2734
2735
2736
2737
      cpProtocolData:
        description: >
          Address assigned for this CP.
        type: array
        items:
2738
          $ref: "#/definitions/CpProtocolData"
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751

  ModifyPnfData:
    description: >
      This type specifies an PNF to be modified in the NS instance.
      It shall comply with the provisions defined in
      Table 6.5.3.15-1.
    type: object
    required:
      - pnfId
    properties:
      pnfId:
        description: >
          Identifier of the PNF. This identifier is allocated by the OSS/BSS.
2752
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
      pnfName:
        description: >
          Name of the PNF.
        type: string
      cpData:
        description: >
          Address assigned for the PNF external CP(s).
        type: array
        items:
          $ref: "#/definitions/PnfExtCpData"

  AffectedVirtualLink:
    description: >
      This type provides information about added, deleted, modified and
      temporary VLs.
    type: object
    required:
      - id
      - virtualLinkDescId
      - changeType
      - networkResource
    properties:
      id:
        description: >
          Identifier of the virtual link instance, identifying the applicable
          "vnfVirtualLinkResourceInfo" entry in the "VnfInstance" data type.
2779
        $ref: "#/definitions/IdentifierInVnf"
2780
2781
2782
      virtualLinkDescId:
        description: >
          Identifier of the related VLD in the VNFD.
2783
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
      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.
2795
        type: string
2796
2797
2798
2799
2800
2801
2802
2803
        enum:
          - ADDED
          - REMOVED
          - MODIFIED
          - TEMPORARY
          - LINK_PORT_ADDED
          - LINK_PORT_REMOVED
      networkResource:
2804
        description: >
2805
2806
2807
          Reference to the VirtualNetwork resource. Detailed information is
          (for new and modified resources) or has been (for removed
          resources) available from the VIM.
2808
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
2809
2810
2811
2812
2813
      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.
2814
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
2815
2816

  AffectedVirtualStorage:
2817
    description: >
2818
2819
      This type provides information about added, deleted, modified and
      temporary virtual storage resources.
2820
2821
    type: object
    required:
2822
2823
2824
2825
      - id
      - virtualStorageDescId
      - changeType
      - storageResource
2826
    properties:
2827
      id:
2828
        description: >
2829
2830
          Identifier of the storage instance, identifying the applicable
          "virtualStorageResourceInfo" entry in the "VnfInstance" data type.
2831
        $ref: "#/definitions/IdentifierInVnf"
2832
      virtualStorageDescId:
2833
        description: >
2834
          Identifier of the related VirtualStorage descriptor in the VNFD.
2835
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
2836
      changeType:
2837
        description: >
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
          Signals the type of change. Permitted values:
          * ADDED
          * REMOVED
          * MODIFIED
          * TEMPORARY
          For a temporary resource, an AffectedVirtualStorage structure exists
          as long as the temporary resource exists.
        type: string
        enum:
          - ADDED
          - REMOVED
          - MODIFIED
          - TEMPORARY
      storageResource:
        description: >
          Reference to the VirtualStorage resource. Detailed information is
          (for new and modified resources) or has been (for removed
          resources) available from the VIM.
2856
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
2857
      metadata:
2858
        description: >
2859
2860
2861
          Metadata about this resource.
          The content of this attribute shall be a copy of the content of the
          "metadata" attribute of the VirtualStorageResourceInfo structure.
2862
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
2863
2864
2865
2866
2867
2868
2869
2870
2871

  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.
    type: object
    required:
      - vnfInstanceId
      - vnfdId
2872
      - vnfProfileId
2873
2874
2875
2876
    properties:
      vnfInstanceId:
        description: >
          Identifier of the VNF instance. 
2877
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
2878
2879
2880
      vnfdId:
        description: >
          Identifier of the VNFD of the VNF Instance.
2881
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
2882
2883
2884
      vnfProfileId:
        description: >
          Identifier of the VNF profile of the NSD.
2885
        $ref: "#/definitions/IdentifierInNsd"
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
      vnfName:
        description: >
          Name of the VNF Instance.
        type: string
      changeType:
        description: >
          Signals the type of change
          Permitted values:
          - ADD
          - REMOVE
          - INSTANTIATE
          - TERMINATE
          - SCALE
          - CHANGE_FLAVOUR
          - HEAL
          - OPERATE
          - MODIFY_INFORMATION
          - CHANGE_EXTERNAL_VNF_CONNECTIVITY
        type: string
        enum:
          - ADD
2907
          - REMOVE
2908
2909
2910
2911
2912
          - INSTANTIATE
          - TERMINATE
          - SCALE
          - CHANGE_FLAVOUR
          - HEAL
2913
          - OPERATE
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
          - MODIFY_INFORMATION
          - CHANGE_EXTERNAL_VNF_CONNECTIVITY
      changeResult:
        description: >
          Signals the result of change identified by the
          "changeType" attribute.
          Permitted values:
          - COMPLETED
          - ROLLED_BACK
          - FAILED
        type: string
        enum:
          - COMPLETED
2927
          - ROLLED_BACK
2928
2929
2930
2931
          - FAILED
      changedInfo:
        description: >
          Information about the changed VNF instance
2932
2933
2934
2935
          information, including VNF configurable properties,if applicable.
          When the "changedInfo" attribute is present, 
          either the "changedVnfInfo" attribute or the
          "changedExtConnectivity" attribute or both shall be present.
2936
2937
2938
2939
        type: object
        required:
          - self
        properties:
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
          changedVnfInfo:
            description: >
              Information about the changed VNF instance
              information, including configurable properties, 
              if applicable.
            $ref: "#/definitions/ModifyVnfInfoData"
          changedExtConnectivity:
            description: >
              Information about changed external connectivity,
              if applicable.
            $ref: "#/definitions/ExtVirtualLinkInfo"
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960

  AffectedPnf:
    description: >
      This type provides information about added, deleted and modified PNFs. 
      It shall comply with the provisions in Table 6.5.3.3-1.
    type: object
    required:
      - pnfId
      - pnfdId
      - pnfProfileId
2961
      - cpInstanceId
2962
2963
2964
2965
2966
    properties:
      pnfId:
        description: >
          Identifier of the affected PNF. This identifier is
          allocated by the OSS/BSS.
2967
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
2968
2969
2970
      pnfdId:
        description: >
          Identifier of the PNFD on which the PNF is based.
2971
        $ref: "#/definitions/IdentifierInNsd"
2972
2973
2974
      pnfProfileId:
        description: >
          Identifier of the VNF profile of the NSD.
2975
        $ref: "#/definitions/IdentifierInNsd"
2976
2977
2978
2979
2980
2981
2982
2983
      pnfName:
        description: >
          Name of the PNF.
        type: string
      cpInstanceId:
        description: >
          Identifier of the CP in the scope of the PNF.
        type: array
2984
        items:
2985
          $ref: "#/definitions/IdentifierInPnf"
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
      changeType:
        description: >
          Signals the type of change.
          Permitted values:
          - ADD
          - REMOVE
          - MODIFY
        type: string
        enum:
          - ADD
2996
2997
          - REMOVE
          - MODIFY
2998
2999
3000
      changeResult:
        description: >
          Signals the result of change identified by the
For faster browsing, not all history is shown. View entire blame