SOL005NSLifecycleManagement_def.yaml 233 KB
Newer Older
2001
          additional parameters apply.
2002
        $ref: "#/definitions/IdentifierInNsd"
2003
2004
2005
2006
2007
      locationConstraints:
        description: >
          Defines the location constraints for the VNF instance to
          be created based on the VNF profile.
        $ref: "#/definitions/LocationConstraints"
2008
2009

  VnfInstanceData:
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
    description: >
      This type specifies an existing VNF instance to be used in the NS instance and
      if needed, the VNF Profile to use for this VNF instance.
      It shall comply with the provisions defined in Table 6.5.3.19-1.
    type: object
    required:
      - vnfInstanceId
      - vnfProfileId
    properties:
      vnfInstanceId:
        description: >
          Identifier of the existing VNF instance to be used in the NS.
2022
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
2023
2024
2025
2026
2027
2028
      vnfProfileId:
        description: >
          Identifier of (Reference to) a vnfProfile defined in the
          NSD which the existing VNF instance shall be matched
          with. If not present, the NFVO will select the VnfProfile
          matching the information in the VNF instance.
2029
        $ref: "#/definitions/IdentifierInNsd"
2030

2031
2032
2033
2034
2035
2036
2037
2038
2039
  NestedNsInstanceData:
    description: >
      This type specifies an existing nested NS instance to be used in the NS instance 
      and if needed, the NsProfile to use for this nested NS instance. 
      It shall comply with the provisions defined in Table 6.5.3.19a-1.
    type: object
    required:
      - nestedNsInstanceId
    properties:
2040
      nestedNsInstanceId:
2041
2042
        description: >
          Identifier of the existing nested NS instance to be used in the NS.
2043
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
2044
2045
2046
2047
2048
2049
      nsProfileId:
        description: >
          Identifier of an NsProfile defined in the NSD which the existing 
          nested NS instance shall be matched with.
          If not present, the NFVO will select the NsProfile matching the 
          information in the nested NS instance.
2050
        $ref: "#/definitions/IdentifierInNs"
2051

2052
  SapData:
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
    description: >
      This type represents the information related to a SAP of a NS.
      It shall comply with the provisions defined in Table 6.5.3.10-1.
    type: object
    required:
      - sapdId
      - sapName
      - description
    properties:
      sapdId:
        description: >
          Reference to the SAPD for this SAP.
2065
        $ref: "#/definitions/IdentifierInNsd"
2066
2067
2068
2069
2070
2071
2072
2073
2074
      sapName:
        description: >
          Human readable name for the SAP.
        type: string
      description:
        description: >
          Human readable description for the SAP.
        type: string
      sapProtocolData:
2075
2076
2077
        description: >
          Parameters for configuring the network protocols on the SAP.
        type: array
2078
        items:
2079
          $ref: "#/definitions/CpProtocolData"
2080
2081

  ScaleNsRequest:
2082
    description: >
2083
      This type represents a request for the scale NS operation.
2084
      Either the parameter scaleNsData or the parameter scaleVnfData, but not both shall be provided
2085
2086
    type: object
    required:
2087
      - scaleType
2088
    properties:
2089
      scaleType:
2090
        description: >
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
          Indicates the type of scaling to be performed.
          Possible values:
          - SCALE_NS
          - SCALE_VNF
        type: string
        enum:
          - SCALE_NS
          - SCALE_VNF
      scaleNsData:
        description: >
          The necessary information to scale the referenced NS instance.
          It shall be present when scaleType = SCALE_NS.
        $ref: "#/definitions/ScaleNsData"
      scaleVnfData:
        description: >
          The necessary information to scale the referenced NS instance.
          It shall be present when scaleType = SCALE_VNF.
        type: array
        items:
          $ref: "#/definitions/ScaleVnfData"
      scaleTime:
        description: >
          Timestamp indicating the scale time of the NS, i.e. the
          NS will be scaled at this timestamp. Cardinality "0"
          indicates the NS scaling takes place immediately".
2116
        $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127

  UpdateNsRequest:
    description: >
      This operation supports the update of a NS instance, 
      It shall comply with the provisions defined in Table 6.5.2.12-1.
    type: object
    required:
      - updateType
    properties:
      updateType:
        description: >
2128
          The type of update. It determines also which one of the following parameters is present in the operation.
2129
2130
          Possible values include:
          * ADD_VNF: Adding existing VNF instance(s)
2131
2132
2133
2134
          * REMOVE_VNF: Removing VNF instance(s)
          * INSTANTIATE_VNF: Instantiating new VNF(s)
          * CHANGE_VNF_DF: Changing VNF DF
          * OPERATE_VNF: Changing VNF state,
2135
2136
2137
          * MODIFY_VNF_INFORMATION: Modifying VNF information and/or the configurable properties of VNF instance(s)
          * CHANGE_EXTERNAL_VNF_CONNECTIVITY: Changing the external connectivity of VNF instance(s)
          * CHANGE_VNFPKG: Changing the VNF package(s) on which (a) VNF instance(s) is/are based
2138
          * ADD_SAP: Adding SAP(s)
2139
          * REMOVE_SAP: Removing SAP(s)
2140
2141
2142
2143
          * ADD_NESTED_NS: Adding existing NS instance(s) as nested NS(s)
          * REMOVE_NESTED_NS: Removing existing nested NS instance(s)
          * ASSOC_NEW_NSD_VERSION: Associating a new NSD version to the NS instance
          * MOVE_VNF: Moving VNF instance(s) from one origin NS instance to another target NS instance
2144
2145
2146
2147
2148
2149
2150
          * ADD_VNFFG: Adding VNFFG(s)
          * REMOVE_VNFFG: Removing VNFFG(s)
          * UPDATE_VNFFG: Updating VNFFG(s)
          * CHANGE_NS_DF: Changing NS DF
          * ADD_PNF: Adding PNF
          * MODIFY_PNF: Modifying PNF
          * REMOVE_PNF: Removing PNF
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
          *	CREATE_VNF_SNAPSHOT: Creating VNF Snapshots of VNF instances belonging to the NS instance.
            It depends on the VNF capabilities, and is declared in the VNFD whether the operation is supported for a particular VNF.
          *	REVERT_VNF_TO_SNAPSHOT: Reverting a VNF instance belonging to the NS instance to a VNF Snapshot.
            It depends on the VNF capabilities, and is declared in the VNFD whether the operation is supported for a particular VNF.
            The operation might be service-disruptive.
          *	DELETE_VNF_SNAPSHOT_INFO: Deleting available VNF Snapshot information for a VNF instance belonging to the NS instance.
            It depends on the VNF capabilities, and is declared in the VNFD whether the operation is supported for a particular VNF.
          *	MODIFY_WAN_CONNECTION_INFO: Modify WAN related connectivity information.
          *	CREATE_NS_VIRTUAL_LINK: Create an NsVirtualLink instance.
          *	DELETE_NS_VIRTUAL_LINK: Delete an NsVirtualLink instance.
2161
        type: string
2162
        enum:
2163
2164
2165
2166
2167
2168
2169
          - ADD_VNF
          - REMOVE_VNF
          - INSTANTIATE_VNF
          - CHANGE_VNF_DF
          - OPERATE_VNF
          - MODIFY_VNF_INFORMATION
          - CHANGE_EXTERNAL_VNF_CONNECTIVITY
2170
          - CHANGE_VNFPKG
2171
          - ADD SAP
2172
2173
2174
2175
2176
2177
          - REMOVE_SAP
          - ADD_NESTED_NS
          - REMOVE_NESTED_NS
          - ASSOC_NEW_NSD_VERSION
          - MOVE_VNF
          - ADD_VNFFG
2178
2179
2180
2181
2182
2183
          - REMOVE_VNFFG
          - UPDATE_VNFFG
          - CHANGE_NS_DF
          - ADD_PNF
          - MODIFY_PNF
          - REMOVE_PNF
2184
2185
2186
2187
2188
2189
          - CREATE_VNF_SNAPSHOT
          - REVERT_VNF_TO_SNAPSHOT
          - DELETE_VNF_SNAPSHOT_INFO
          - MODIFY_WAN_CONNECTION_INFO
          - CREATE_NS_VIRTUAL_LINK
          - DELETE_NS_VIRTUAL_LINK
2190
2191
2192
2193
2194
      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
2195
        items:
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
          $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
2207
        items:
2208
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
2209
2210
2211
2212
2213
2214
      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
2215
2216
        items:
          $ref: "#/definitions/InstantiateVnfData"
2217
2218
2219
2220
2221
      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
2222
2223
        items:
          $ref: "#/definitions/ChangeVnfFlavourData"
2224
2225
2226
2227
2228
      operateVnfData:
        description: >
          Identifies the state of the VNF instance to be changed. 
          It shall be present only if updateType = "OPERATE_VNF".
        type: array
2229
2230
        items:
          $ref: "#/definitions/OperateVnfData"
2231
2232
2233
2234
2235
2236
      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
2237
        items:
2238
2239
2240
2241
2242
2243
2244
          $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
2245
2246
        items:
          $ref: "#/definitions/ChangeExtVnfConnectivityData"
2247
2248
2249
2250
2251
2252
2253
      changeVnfPackageData:
        description: >
          Specifies the details to change the VNF package on which the VNF instance is based.
          It shall be present only if updateType = "CHANGE_VNFPKG".
        type: array
          items:
            $ref: "#/definitions/ChangeVnfPackageData"
2254
2255
2256
2257
2258
      addSap:
        description: >
          Identifies a new SAP to be added to the NS instance.
          It shall be present only if updateType = "ADD_SAP."
        type: array
2259
2260
        items:
          $ref: "#/definitions/SapData"
2261
2262
2263
2264
2265
      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
2266
        items:
2267
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
2268
      addNestedNsData:
2269
2270
2271
2272
2273
        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
2274
        items:
2275
          $ref: "#/definitions/NestedNsInstanceData"
2276
      removeNestedNsId:
2277
2278
2279
2280
2281
2282
        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:
2283
          $ref: "#/definitions/IdentifierInNs"
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
      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
2296
2297
        items:
          $ref: "#/definitions/MoveVnfInstanceData"
2298
2299
2300
2301
2302
2303
      addVnffg:
        description: >
          Specify the new VNFFG to be created to the NS
          Instance. It shall be present only if updateType =
          "ADD_VNFFG".
        type: array
2304
2305
        items:
          $ref: "#/definitions/AddVnffgData"
2306
2307
2308
2309
2310
2311
      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
2312
        items:
2313
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
2314
2315
2316
2317
2318
2319
      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
2320
2321
        items:
          $ref: "#/definitions/UpdateVnffgData"
2322
2323
2324
2325
2326
      changeNsFlavourData:
        description: >
          Specifies the new DF to be applied to the NS instance. It
          shall be present only if updateType =
          "CHANGE_NS_DF".
2327
        $ref: "#/definitions/ChangeNsFlavourData"
2328
2329
2330
2331
2332
      addPnfData:
        description: >
          specifies the PNF to be added into the NS instance. 
          It shall be present only if updateType = "ADD_PNF".
        type: array
2333
2334
        items:
          $ref: "#/definitions/AddPnfData"
2335
2336
2337
2338
2339
      modifyPnfData:
        description: >
          Specifies the PNF to be modified in the NS instance. 
          It shall be present only if updateType = "MODIFY_PNF".
        type: array
2340
2341
        items:
          $ref: "#/definitions/ModifyPnfData"
2342
2343
2344
2345
2346
      removePnfId:
        description: >
          Identifier of the PNF to be deleted from the NS instance.
          It shall be present only if updateType = "REMOVE_PNF".
        type: array
2347
        items:
2348
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
2349
2350
2351
2352
2353
2354
2355
      modifyWanConnectionInfoData:
        description: >
          Specifies the data to modify about WAN related connectivity information.
          It shall be present only if updateType = "MODIFY_WAN_CONNECTION_INFO".
        type: array
        items:
          $ref: "#/definitions/ModifyWanConnectionInfoData"
2356
2357
2358
2359
2360
      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.
2361
        $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
      createSnapshotData:
        description: >
          Specify the VNF instance to be snapshotted. It shall be present only if updateType = "CREATE_VNF_SNAPSHOT".
        $ref: '#/definitions/CreateVnfSnapshotData'
      revertVnfToSnapshotData:
        description: >
          Specify the VNF instance to be reverted and the VNF Snapshot to be reverted to. It shall be present only if
          updateType = "REVERT_VNF_TO_SNAPSHOT".
          $ref: '#/definitions/CreateVnfSnapshotData'
        $ref: '#/definitions/RevertVnfToSnapshotData'
      deleteVnfSnapshotData:
        description: >
          Specify the VNF Snapshot info to be deleted and the related VNF instance. It shall be present only if
          updateType = "DELETE_VNF_SNAPSHOT_INFO".
        $ref: '#/definitions/DeleteVnfSnapshotData'
      addNsVirtualLinkData:
        description: >
          Specify data to be used to create a new NsVirtualLink instance. This parameter shall be present only if
          updateType = “CREATE_NS_VIRTUAL_LINK”.
        type: array
        items:
          $ref: '#/definitions/AddNsVirtualLinkData'
      deleteNsVirtualLinkId:
        description: >
          Identify an existing NsVirtualLink instance to be deleted. The parameter shall be present only if
          updateType = “DELETE_NS_VIRTUAL_LINK”.
        type: array
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
2391

2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
  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
2402
      - vnfFlavourId
2403
2404
2405
2406
2407
    properties:
      vnfdId:
        description: >
          Information sufficient to identify the VNFD which defines
          the VNF to be instantiated.
2408
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
2409
2410
2411
      vnfFlavourId:
        description: >
          Identifier of the VNF deployment flavor to be instantiated.
2412
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
2413
2414
2415
2416
2417
2418
      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.
2419
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
      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
2432
        items:
2433
          $ref: "#/definitions/ExtVirtualLinkData"
2434
2435
2436
      extManagedVirtualLinks:
        description: >
          Information about internal VLs that are managed by other entities than the VNFM.
2437
2438
2439
2440
          It is possible to have several ExtManagedVirtualLinkData for the same VNF internal VL in case of a multi-site
          VNF spanning several VIMs. The set of ExtManagedVirtualLinkData corresponding to the same VNF internal VL shall
          indicate so by referencing to the same VnfVirtualLinkDesc and externally-managed multi-site VL instance
          (refer to clause 6.5.3.27).
2441
        type: array
2442
        items:
2443
          $ref: "#/definitions/ExtManagedVirtualLinkData"
2444
2445
      localizationLanguage:
        description: >
2446
          Localization language of the VNF to be instantiated.
2447
          The value shall comply with the format defined in IETF RFC 5646.
2448
        type: string
2449
2450
2451
2452
2453
2454
      vnfConfigurableProperties:
        description: >
          Values for the "vnfConfigurableProperties" input
          parameter of the Instantiate VNF operation
          defined in ETSI GS NFV-SOL 003 [4].
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
2455
2456
2457
2458
      additionalParams:
        description: >
          Additional input parameters for the instantiation process,
          specific to the VNF being instantiated.
2459
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
      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"
2470
2471
2472
2473
2474
2475
2476
      locationConstraints:
        description: >
          Defines the location constraints for the VNF to be
          instantiated as part of the NS Update.
          An example can be a constraint for the VNF to be
          in a specific geographic location.
        $ref: "#/definitions/VnfLocationConstraint"
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490

  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.
2491
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
2492
2493
2494
      newFlavourId:
        description: >
          Identifier of the VNF deployment flavor to be instantiated.
2495
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
2496
2497
2498
2499
2500
2501
      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.
2502
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
2503
2504
2505
2506
2507
      extVirtualLinks:
        description: >
          Information about external VLs to connect the VNF to.
        type: array
        items:
2508
          $ref: "#/definitions/ExtVirtualLinkData"
2509
2510
2511
      extManagedVirtualLinks:
        description: >
          information about internal VLs that are managed by NFVO.
2512
2513
2514
2515
          It is possible to have several ExtManagedVirtualLinkData for the same VNF internal VL in case of a multi-site
          VNF spanning several VIMs. The set of ExtManagedVirtualLinkData corresponding to the same VNF internal VL shall
          indicate so by referencing to the same VnfVirtualLinkDesc and externally-managed multi-site VL instance
          (refer to clause 6.5.3.27).
2516
2517
        type: array
        items:
2518
          $ref: "#/definitions/ExtManagedVirtualLinkData"
2519
2520
2521
2522
2523
      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".
2524
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
      extensions:
        description: >
          This attribute provides values for the "vnfConfigurableProperties" input parameter of the Change VNF Flavour
          operation defined in ETSI GS NFV-SOL 003.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
      vnfConfigurableProperties:
        description: >
          This attribute provides values for the "extensions" input parameter of the Change VNF Flavour operation defined
          in ETSI GS NFV-SOL 003.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548

  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.
2549
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
      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
2565
2566
2567
2568
2569
2570
      additionalParam:
        description: >
          Additional parameters passed by the OSS/BSS as input
          to the Operate VNF operation, specific to the VNF being
          operated.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
2571
2572
2573
2574
2575
2576
2577
2578
2579

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

2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
  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.
2607
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
      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
2618
      vnfdId:
2619
        description: >
2620
          New value of the "vnfdId" attribute in "VnfInstance".
2621
          The value "null" is not permitted
2622
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
2623
2624
2625
      vnfConfigurableProperties:
        description: >
          Modifications to entries in the
2626
          "vnfConfigurableProperties" attribute in "VnfInstance", as defined below in clause 6.5.3.57.
2627
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
2628
      metadata:
2629
        description: >
2630
          Modifications to entries in the "metadata" attribute in "VnfInstance", as defined below in clause 6.5.3.57.
2631
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
2632
      extensions:
2633
        description: >
2634
          Modifications to entries in the "extensions" attribute in "VnfInstance", as defined below in clause 6.5.3.57.
2635
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
2636
2637
2638
2639
2640
2641

  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
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
         external VL.
      2) Disconnect and delete external CPs that are connected to a particular external VL and that represent subports
         in a trunk, i.e. CP instances that are created from external CPDs that have trunk mode configured according to
         clause 7.1.6.3 in ETSI GS NFV-IFA 011. If the parent port is exposed as an "extCp", the VNFM shall ensure that
         the parent port is not deleted. If the parent port is exposed as an "extCp" and there are other subports connected,
         the VNFM shall ensure that the parent port is not disconnected, unless it is reconnected to a different external
         VL in the same operation.
      3) 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.

      4) Create new CPs that represent supports in a trunk, i.e. CP instances that are created from external CPDs that
         have trunk mode configured according to clause 7.1.6.3 in ETSI GS NFV-IFA 011, and connect them to a particular
         external VL. Creation of the parent port with this operation is not supported. This type shall comply with the
         provisions defined in Table 6.5.3.33-1.
2659
2660
2661
    type: object
    required:
      - vnfInstanceId
2662
      - extVirtualLinks
2663
2664
2665
2666
    properties:
      vnfInstanceId:
        description: >
          Identifier of the VNF instance.
2667
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
2668
      extVirtualLinks:
2669
2670
2671
2672
        description: >
          Information about external VLs to change (e.g. connect the VNF to).
        type: array
        items:
2673
          $ref: "#/definitions/ExtVirtualLinkData"
2674
2675
2676
2677
2678
      additionalParams:
        description: >
          Additional parameters passed by the OSS as input to
          the external connectivity change process, specific to the
          VNF instance being changed.
2679
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696

  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.
2697
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
      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.
2733
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
2734
2735
2736
2737
2738
      vnfInstanceId:
        description: >
          Specify the VNF instance that is moved.
        type: array
        items:
2739
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754

  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.
2755
        $ref: "#/definitions/IdentifierInNsd"
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
      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.
2776
        $ref: "#/definitions/IdentifierInNs"
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
      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:
2792
          $ref: "#/definitions/IdentifierInNs"
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804

  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.
2805
2806
          It shall be present for modified NFPs and shall be absent 
          for the new NFP.
2807
        $ref: "#/definitions/IdentifierInNs"
2808
2809
2810
2811
      nfpName:
        description: >
          Human readable name for the NFP. It shall be present
          for the new NFP, and it may be present otherwise.
2812
2813
          It shall be present for the new NFP, and it may be 
          present otherwise.
2814
2815
2816
2817
2818
        type: string
      description:
        description: >
          Human readable description for the NFP. It shall be
          present for the new NFP, and it may be present otherwise.
2819
2820
          It shall be present for the new NFP, and it may be 
          present otherwise.
2821
        type: string
2822
      cpGroup:
2823
        description: >
2824
          Group(s) of CPs and/or SAPs which the NFP passes by.
2825
2826
2827
          Cardinality can be 0 if only updated or newly created
          NFP classification and selection rule which applied to an
          existing NFP is provided.
2828
2829
2830
2831
          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.
2832
2833
        type: array
        items:
2834
          $ref: "#/definitions/CpGroupInfo"
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
      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.
2851
        $ref: "#/definitions/MacAddress"
2852
2853
2854
      etherSourceAddress:
        description: >
          Indicates a source Mac address.
2855
        $ref: "#/definitions/MacAddress"
2856
2857
2858
2859
2860
2861
2862
2863
2864
      etherType:
        description: >
          Human readable description for the VNFFG.
        type: string
        enum:
          - IPV4
          - IPV6
      vlanTag:
        description: >
2865
          Indicates a VLAN identifier in an IEEE 802.1Q-2018
2866
2867
2868
          tag [6] Multiple tags can be included for QinQ stacking. See note.
        type: array
        items:
2869
          $ref: "../../definitions/SOL005_def.yaml#/definitions/String"
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
      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
2898
        $ref: "#/definitions/PortRange"
2899
2900
2901
      destinationPortRange:
        description: >
          Indicates a range of destination ports.
2902
        $ref: "#/definitions/PortRange"
2903
2904
2905
      sourceIpAddressPrefix:
        description: >
          Indicates the source IP address range in CIDR format.
2906
        $ref: "#/definitions/IpAddressPrefix"
2907
2908
2909
      destinationIpAddressPrefix:
        description: >
          Indicates the destination IP address range in CIDR format.
2910
        $ref: "#/definitions/IpAddressPrefix"
2911
2912
2913
2914
2915
      extendedCriteria:
        description: >
          Indicates values of specific bits in a frame.
        type: array
        items:
2916
          $ref: "#/definitions/Mask"
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929

  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: >
2930
          Identifier of the new NS DF to apply to this NS instance.
2931
        $ref: "#/definitions/IdentifierInNsd"
2932
2933
2934
2935
      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.
2936
        $ref: "#/definitions/IdentifierInNsd"
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951

  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.
2952
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
2953
2954
2955
2956
2957
2958
2959
      pnfName:
        description: >
          Name of the PNF
        type: string
      pnfdId:
        description: >
          Identifier of the PNFD on which the PNF is based.
2960
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
2961
2962
2963
      pnfProfileId:
        description: >
          Identifier of related PnfProfile in the NSD on which the PNF is based.
2964
        $ref: "#/definitions/IdentifierInNsd"
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
      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:
2981
      cpInstanceId:
2982
2983
        description: >
          Identifier of the CP. Shall be present for existing CP.
2984
        $ref: "#/definitions/IdentifierInPnf"
2985
2986
2987
      cpdId:
        description: >
          Identifier of the Connection Point Descriptor (CPD) for this CP. Shall be present for new CP.
2988
        $ref: "#/definitions/IdentifierInNsd"
2989
2990
2991
2992
2993
      cpProtocolData:
        description: >
          Address assigned for this CP.
        type: array
        items:
2994
          $ref: "#/definitions/CpProtocolData"
2995
2996
2997
2998
2999
3000

  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.
For faster browsing, not all history is shown. View entire blame