SOL005NSLifecycleManagement_def.yaml 267 KB
Newer Older
2001
          additionalParamsForNestedNs). This is for VNFs that are
2002
2003
          to be created by the NFVO as part of the NS instantiation 
          and not for existing VNF that are referenced for reuse.
2004
        type: array
2005
2006
        items:
          $ref: "#/definitions/ParamsForVnf"
2007
2008
2009
2010
      startTime:
        description: >
          Timestamp indicating the earliest time to instantiate the NS. 
          Cardinality "0" indicates the NS instantiation takes place immediately.
2011
        $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
2012
2013
2014
2015
2016
2017
      nsInstantiationLevelId:
        description: >
          Identifies one of the NS instantiation levels declared in
          the DF applicable to this NS instance. If not present, the
          default NS instantiation level as declared in the NSD
          shall be used.
2018
        $ref: "#/definitions/IdentifierInNsd"
2019
2020
2021
      wanConnectionData:
        description: >
          Information for connecting VNs to the WAN when VLs are deployed across a WAN.
piscione's avatar
piscione committed
2022
          See note 4.
2023
2024
2025
        type: array
        items:
          $ref: "#/definitions/WanConnectionData"
2026
      additionalAffinityOrAntiAffinityRule:
2027
        description: >
2028
2029
2030
2031
          Specifies additional affinity or anti-affinity constraint for
          the VNF instances to be instantiated as part of the NS
          instantiation.
          Shall not conflict with rules already specified in the NSD.
2032
        type: array
2033
        items:
2034
2035
          $ref: "#/definitions/AffinityOrAntiAffinityRule"

2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
  ParamsForNestedNs:
    description: >
      This type specifies additional parameters on a per-nested NS instance basis. 
      It shall comply with the provisions defined in Table 6.5.3.21a-1.
    type: object
    required:
      - nsProfileId
    properties:
      nsProfileId:
        description: >
          Identifier of a NsProfile to which the additional parameters apply.
2047
        $ref: "#/definitions/IdentifierInNsd"
2048
2049
2050
2051
2052
      additionalParam:
        description: >
          Additional parameters that are to be applied on a per nested NS instance.
        type: array
        items:
2053
          $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
2054

2055
  ParamsForVnf:
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
    description: >
      This type defines the additional parameters for the VNF instance
      to be created associated with an NS instance.
      It shall comply with the provisions defined in Table 6.5.3.22-1.
    type: object
    required:
      - vnfProfileId
    properties:
      vnfProfileId:
        description: >
          Identifier of (reference to) a vnfProfile to which the
          additional parameters apply.
2068
        $ref: "#/definitions/IdentifierInNsd"
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
      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
      vnfConfigurableProperties:
        description: >
2079
2080
2081
2082
          If present, this attribute provides values for the configurable properties declared in the VNFD.
          These values will override the default values if default values are also declared in the VNFD.

          It provides values  for the "vnfConfigurableProperties" input
2083
2084
2085
2086
2087
          parameter of the Instantiate VNF operation defined in
          ETSI GS NFV-SOL 003 [4].
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
      metadata:
        description: >
2088
2089
2090
2091
2092
2093
          If present, this attribute provides values for metadata.
          Metadata can but need not be declared in the VNFD.
          These values will override the default values if default
          values are also declared in the VNFD.

          It provides the values for the "metadata" input parameter of the Create
2094
2095
2096
2097
2098
          VNF Identifier operation defined in ETSI
          GS NFV-SOL 003 [4].
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
      extensions:
        description: >
2099
2100
2101
2102
2103
          If present, this attribute provides values for the extensions
          declared in the VNFD. These values will override the default
          values if default values are also declared in the VNFD.

          It provides the values for the "extensions" input parameter  of the Instantiate
2104
2105
          VNF operation defined in ETSI GS NFV-SOL 003 [4].
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
2106
2107
      additionalParams:
        description: >
2108
2109
2110
          Additional input parameters for the instantiation process,
          specific to the VNF being instantiated, as declared in the
          VNFD as part of "InstantiateVnfOpConfig".
2111
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
2112

2113
  LocationConstraints:
2114
2115
    description: >
      This type represents location constraints for a VNF to be instantiated.
2116
2117
2118
2119
      The location constraints can be represented as follows:
      •	as a country code
      •	as a civic address combined with a country code
      •	as an area, conditionally combined with a country code
piscione's avatar
piscione committed
2120
2121
2122
2123
2124
2125
2126

      NOTE:	If both "countryCode" and "area" are present, no conflicts should
      exist between the values of these two attributes. In case of conflicts,
      the API producer (i.e. the NFVO) shall disregard parts of the geographic
      area signalled by "area" that are outside the boundaries of the country
      signalled by "countryCode". If "countryCode" is absent, it is solely the "area"
      attribute that defines the location constraint.
2127
2128
2129
2130
    type: object
    properties:
      countryCode:
        description: >
piscione's avatar
piscione committed
2131
2132
2133
          The two-letter ISO 3166 country code in capital letters. Shall be present
          in case the "area" attribute is absent. May be absent if the "area"
          attribute is present (see note).
2134
2135
2136
2137
        type: string
      civicAddressElement:
        description: >
          Zero or more elements comprising the civic address.
2138
          Shall be absent if the "area" attribute is present.
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
        type: array
        items:
          type: object
          required:
            - caType
            - caValue
          properties:
            caType:
              description: >
                Describe the content type of caValue. The value of
                caType shall comply with Section 3.4 of IETF
                RFC 4776 [13].
              type: integer
            caValue:
              description: >
                Content of civic address element corresponding to the
                caType. The format caValue shall comply with
                Section 3.4 of IETF RFC 4776 [13].
              type: string
2158
2159
2160
2161
2162
      area:
        description: >
          Geographic area. Shall be absent if the "civicAddressElement" attribute is present.
          The content of this attribute shall follow the provisions for the "Polygon" geometry object as defined in
          IETF RFC 7946, for which the "type" member shall be set to the value "Polygon".
piscione's avatar
piscione committed
2163
          See note.
2164
        type: object
2165

2166
  VnfLocationConstraint:
2167
2168
2169
2170
    description: >
      This type represents the association of location constraints to a VNF instance
      to be created according to a specific VNF profile.
      It shall comply with the provisions defined in Table 6.5.3.20-1.
2171
2172
2173
2174
2175
2176

      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 instance is to be created.

2177
2178
2179
2180
2181
2182
2183
2184
    type: object
    required:
      - vnfProfileId
    properties:
      vnfProfileId:
        description: >
          Identifier of (reference to) a vnfProfile to which the
          additional parameters apply.
2185
        $ref: "#/definitions/IdentifierInNsd"
2186
2187
2188
2189
      locationConstraints:
        description: >
          Defines the location constraints for the VNF instance to
          be created based on the VNF profile.
2190
2191

          See note.
2192
        $ref: "#/definitions/LocationConstraints"
2193
2194

  VnfInstanceData:
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
    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.
2207
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
2208
2209
2210
2211
2212
2213
      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.
2214
        $ref: "#/definitions/IdentifierInNsd"
2215

2216
2217
2218
2219
2220
2221
2222
2223
2224
  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:
2225
      nestedNsInstanceId:
2226
2227
        description: >
          Identifier of the existing nested NS instance to be used in the NS.
2228
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
2229
2230
2231
2232
2233
2234
      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.
2235
        $ref: "#/definitions/IdentifierInNs"
2236

2237
  SapData:
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
    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.
2250
        $ref: "#/definitions/IdentifierInNsd"
2251
2252
2253
2254
2255
2256
2257
2258
2259
      sapName:
        description: >
          Human readable name for the SAP.
        type: string
      description:
        description: >
          Human readable description for the SAP.
        type: string
      sapProtocolData:
2260
2261
2262
        description: >
          Parameters for configuring the network protocols on the SAP.
        type: array
2263
        items:
2264
          $ref: "#/definitions/CpProtocolData"
2265
2266

  ScaleNsRequest:
2267
    description: >
2268
      This type represents a request for the scale NS operation.
2269
      Either the parameter scaleNsData or the parameter scaleVnfData, but not both shall be provided
piscione's avatar
piscione committed
2270
2271

      NOTE:	Either the parameter scaleNsData or the parameter scaleVnfData, but not both shall be provided.
2272
2273
    type: object
    required:
2274
      - scaleType
2275
2276
2277
2278
2279
    oneOf:
      - required:
          - scaleNsData
      - required:
          - scaleVnfData
2280
    properties:
2281
      scaleType:
2282
        description: >
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
          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.
piscione's avatar
piscione committed
2295
          See note.
2296
2297
2298
2299
2300
        $ref: "#/definitions/ScaleNsData"
      scaleVnfData:
        description: >
          The necessary information to scale the referenced NS instance.
          It shall be present when scaleType = SCALE_VNF.
piscione's avatar
piscione committed
2301
          See note.
2302
2303
2304
2305
2306
2307
2308
2309
        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".
2310
        $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
2311
2312
2313

  UpdateNsRequest:
    description: >
piscione's avatar
piscione committed
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
      This operation supports the update of a NS instance operation.

      NOTE 1:	The DF of the VNF instance shall match the VNF DF present in the associated VNF Profile.
      NOTE 2:	The NS DF of each nested NS shall be one of the allowed flavours in the associated NSD
      (as referenced in the nestedNsd attribute of the NSD of the NS to be instantiated).
      NOTE 3:	The NSD of each referenced NSs (i.e. each nestedInstanceId) shall match the one of
      the nested NSD in the composite NSD.
      NOTE 4:	When the NS is deployed over several sites, the VLs of this NS will include VNs
      in each site connected over the WAN. In this case, the "wanConnectionData" provides the needed
      information required to connect each VN to the WAN. Annex E provides additional information and
      guidelines about the usage of the "wanConnectionData" attribute.
2325
2326
2327
2328
2329
2330
    type: object
    required:
      - updateType
    properties:
      updateType:
        description: >
2331
          The type of update. It determines also which one of the following parameters is present in the operation.
2332
2333
          Possible values include:
          * ADD_VNF: Adding existing VNF instance(s)
2334
2335
2336
2337
          * REMOVE_VNF: Removing VNF instance(s)
          * INSTANTIATE_VNF: Instantiating new VNF(s)
          * CHANGE_VNF_DF: Changing VNF DF
          * OPERATE_VNF: Changing VNF state,
2338
2339
2340
          * 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
2341
          * ADD_SAP: Adding SAP(s)
2342
          * REMOVE_SAP: Removing SAP(s)
2343
2344
2345
2346
          * 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
2347
2348
2349
2350
2351
2352
2353
          * 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
piscione's avatar
piscione committed
2354
2355
2356
          *	CREATE_VNF_SNAPSHOT: Creating VNF Snapshots of VNF instances belonging to the NS instance. See note 2
          * REVERT_VNF_TO_SNAPSHOT: Reverting a VNF instance belonging to the NS instance to a VNF Snapshot. See note 2 and note 3
          * DELETE_VNF_SNAPSHOT_INFO: Deleting available VNF Snapshot information for a VNF instance belonging to the NS instance. See note 2
2357
2358
2359
          *	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.
2360
        type: string
2361
        enum:
2362
2363
2364
2365
2366
2367
2368
          - ADD_VNF
          - REMOVE_VNF
          - INSTANTIATE_VNF
          - CHANGE_VNF_DF
          - OPERATE_VNF
          - MODIFY_VNF_INFORMATION
          - CHANGE_EXTERNAL_VNF_CONNECTIVITY
2369
          - CHANGE_VNFPKG
2370
          - ADD SAP
2371
2372
2373
2374
2375
2376
          - REMOVE_SAP
          - ADD_NESTED_NS
          - REMOVE_NESTED_NS
          - ASSOC_NEW_NSD_VERSION
          - MOVE_VNF
          - ADD_VNFFG
2377
2378
2379
2380
2381
2382
          - REMOVE_VNFFG
          - UPDATE_VNFFG
          - CHANGE_NS_DF
          - ADD_PNF
          - MODIFY_PNF
          - REMOVE_PNF
2383
2384
2385
2386
2387
2388
          - CREATE_VNF_SNAPSHOT
          - REVERT_VNF_TO_SNAPSHOT
          - DELETE_VNF_SNAPSHOT_INFO
          - MODIFY_WAN_CONNECTION_INFO
          - CREATE_NS_VIRTUAL_LINK
          - DELETE_NS_VIRTUAL_LINK
2389
2390
2391
2392
2393
      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
2394
        items:
2395
2396
2397
2398
2399
2400
          $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
piscione's avatar
piscione committed
2401
          updateType = "REMOVE_VNF.". See note 1.
2402
        type: array
2403
        items:
2404
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
2405
2406
2407
2408
2409
2410
      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
2411
2412
        items:
          $ref: "#/definitions/InstantiateVnfData"
2413
2414
2415
2416
2417
2418
      terminateVnfData:
        description: >
          Specifies the details to terminate VNF instance(s).
          It shall be present only if updateType = "REMOVE_VNF"
          and if the VNF instance(s) is(are) to be terminated as
          part of this operation.
piscione's avatar
piscione committed
2419
          See notes 1 and 4.
2420
2421
2422
        type: array
        items:
          $ref: "#/definitions/TerminateVnfData"
2423
2424
2425
2426
2427
      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
2428
2429
        items:
          $ref: "#/definitions/ChangeVnfFlavourData"
2430
2431
2432
2433
2434
      operateVnfData:
        description: >
          Identifies the state of the VNF instance to be changed. 
          It shall be present only if updateType = "OPERATE_VNF".
        type: array
2435
2436
        items:
          $ref: "#/definitions/OperateVnfData"
2437
2438
2439
2440
2441
2442
      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
2443
        items:
2444
2445
2446
2447
2448
2449
2450
          $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
2451
2452
        items:
          $ref: "#/definitions/ChangeExtVnfConnectivityData"
2453
2454
2455
2456
2457
      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
Francesca Moscatelli's avatar
Francesca Moscatelli committed
2458
2459
        items:
          $ref: "#/definitions/ChangeVnfPackageData"
2460
2461
2462
2463
2464
      addSap:
        description: >
          Identifies a new SAP to be added to the NS instance.
          It shall be present only if updateType = "ADD_SAP."
        type: array
2465
2466
        items:
          $ref: "#/definitions/SapData"
2467
2468
2469
2470
2471
      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
2472
        items:
2473
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
2474
      addNestedNsData:
2475
2476
2477
2478
2479
        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
2480
        items:
2481
          $ref: "#/definitions/NestedNsInstanceData"
2482
      removeNestedNsId:
2483
2484
2485
2486
2487
2488
        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:
2489
          $ref: "#/definitions/IdentifierInNs"
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
      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
2502
2503
        items:
          $ref: "#/definitions/MoveVnfInstanceData"
2504
2505
2506
2507
2508
2509
      addVnffg:
        description: >
          Specify the new VNFFG to be created to the NS
          Instance. It shall be present only if updateType =
          "ADD_VNFFG".
        type: array
2510
2511
        items:
          $ref: "#/definitions/AddVnffgData"
2512
2513
2514
2515
2516
2517
      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
2518
        items:
2519
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
2520
2521
2522
2523
2524
2525
      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
2526
2527
        items:
          $ref: "#/definitions/UpdateVnffgData"
2528
2529
2530
2531
2532
      changeNsFlavourData:
        description: >
          Specifies the new DF to be applied to the NS instance. It
          shall be present only if updateType =
          "CHANGE_NS_DF".
2533
        $ref: "#/definitions/ChangeNsFlavourData"
2534
2535
2536
2537
2538
      addPnfData:
        description: >
          specifies the PNF to be added into the NS instance. 
          It shall be present only if updateType = "ADD_PNF".
        type: array
2539
2540
        items:
          $ref: "#/definitions/AddPnfData"
2541
2542
2543
2544
2545
      modifyPnfData:
        description: >
          Specifies the PNF to be modified in the NS instance. 
          It shall be present only if updateType = "MODIFY_PNF".
        type: array
2546
2547
        items:
          $ref: "#/definitions/ModifyPnfData"
2548
2549
2550
2551
2552
      removePnfId:
        description: >
          Identifier of the PNF to be deleted from the NS instance.
          It shall be present only if updateType = "REMOVE_PNF".
        type: array
2553
        items:
2554
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
2555
2556
2557
2558
2559
2560
2561
      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"
2562
2563
2564
2565
2566
      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.
2567
        $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
      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"
2597

2598
2599
2600
2601
2602
  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
piscione's avatar
piscione committed
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
      update operation, a set of these parameters are then passed by the NFVO to the VNFM.

      NOTE 1:	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).
      NOTE 2:	If vnfdId and vnfFlavourId (and vnfInstantiationLevelId, if provided) are present,
      there should be only one vnfProfile that matches the vnfdId and vnfFlavourId (and vnfInstantiationLevelId,
      if present) in the NS deployment flavour specified in the NSD associated to the NS instance to which
      the present operation is triggered. In the case there is more than one matching vnfProfile, the NFVO
      may select a matching vnfProfile based on other information, such as external VL.
      NOTE 3:	Either the attribute triple "vnfdId, vnfFlavourId and vnfInstantiationLevelId
      (if provided)" or the attribute "vnProfileId" shall be present, but not both.
2616
2617
2618
2619
2620
2621
    type: object
    properties:
      vnfdId:
        description: >
          Information sufficient to identify the VNFD which defines
          the VNF to be instantiated.
2622

piscione's avatar
piscione committed
2623
          See note 2 and 3.
2624
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
2625
2626
2627
      vnfFlavourId:
        description: >
          Identifier of the VNF deployment flavor to be instantiated.
2628

piscione's avatar
piscione committed
2629
          See note 2 and 3.
2630
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
2631
2632
2633
2634
2635
2636
      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.
2637

piscione's avatar
piscione committed
2638
          See note 2 and 3.
2639
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
2640
2641
2642
2643
      vnfProfileId:
        description: >
          Identifier of (Reference to) a vnfProfile defined in the NSD which is used for instantiating the VNF.

piscione's avatar
piscione committed
2644
          See note 3.
2645
        $ref: "#/definitions/IdentifierInNsd"
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
      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.
piscione's avatar
piscione committed
2657

2658
        type: array
2659
        items:
2660
          $ref: "#/definitions/ExtVirtualLinkData"
2661
2662
2663
      extManagedVirtualLinks:
        description: >
          Information about internal VLs that are managed by other entities than the VNFM.
piscione's avatar
piscione committed
2664
          See note 1.
2665
        type: array
2666
        items:
2667
          $ref: "#/definitions/ExtManagedVirtualLinkData"
2668
2669
      localizationLanguage:
        description: >
2670
          Localization language of the VNF to be instantiated.
2671
          The value shall comply with the format defined in IETF RFC 5646.
2672
        type: string
2673
2674
      vnfConfigurableProperties:
        description: >
2675
2676
2677
2678
2679
          If present, this attribute provides values for the configurable
          properties declared in the VNFD. These values will override
          the default values if default values are also declared in the VNFD.

          It provides values for the "vnfConfigurableProperties" input
2680
          parameter of the Instantiate VNF operation
piscione's avatar
piscione committed
2681
          defined in ETSI GS NFV-SOL 003.
2682
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
2683
2684
2685
2686
      additionalParams:
        description: >
          Additional input parameters for the instantiation process,
          specific to the VNF being instantiated.
2687
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
2688
2689
      metadata:
        description: >
2690
2691
2692
2693
          If present, this attribute provides values for metadata. Metadata
          can but need not be declared in the VNFD. These values will override
          the default values if default values are also declared in the VNFD.

2694
2695
2696
2697
2698
          This attribute provides values for the "metadata" input parameter of
          the Create VNF Identifier operation.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
      extensions:
        description: >
2699
2700
2701
2702
          If present, this attribute provides values for extensions declared
          in the VNFD. These values will override the default values if default
          values are also declared in the VNFD.

2703
2704
2705
          This attribute provides values for the "extensions" input parameter of
          the Instantiate VNF operation.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
2706
2707
2708
2709
2710
2711
2712
      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"
2713
2714
2715
2716
2717

  ChangeVnfFlavourData:
    description: >
      The type represents the information that is requested to be changed
      deployment flavor for an existing VNF instance.
piscione's avatar
piscione committed
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
      NOTE 1:	The indication of externally-managed internal VLs
      is needed in case networks have been pre-configured for use with certain VNFs,
      for instance to ensure that these networks have certain properties such as
      security or acceleration features, or to address particular network topologies.
      The present document assumes that externally-managed internal VLs are managed
      by the NFVO and created towards the VIM.
      NOTE 2:	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).
2729
2730
2731
2732
2733
2734
2735
2736
    type: object
    required:
      - vnfInstanceId
      - newFlavourId
    properties:
      vnfInstanceId:
        description: >
          Identifier of the VNF instance to be modified.
2737
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
2738
2739
2740
      newFlavourId:
        description: >
          Identifier of the VNF deployment flavor to be instantiated.
2741
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
2742
2743
2744
2745
2746
2747
      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.
2748
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
2749
2750
2751
2752
2753
      extVirtualLinks:
        description: >
          Information about external VLs to connect the VNF to.
        type: array
        items:
2754
          $ref: "#/definitions/ExtVirtualLinkData"
2755
2756
2757
      extManagedVirtualLinks:
        description: >
          information about internal VLs that are managed by NFVO.
piscione's avatar
piscione committed
2758
          See note 1 and note 2.
2759
2760
        type: array
        items:
2761
          $ref: "#/definitions/ExtManagedVirtualLinkData"
2762
2763
2764
2765
2766
      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".
2767
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
2768
2769
      extensions:
        description: >
2770
          This attribute provides values for the "extensions" input parameter of the Change VNF Flavour
2771
2772
2773
2774
          operation defined in ETSI GS NFV-SOL 003.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
      vnfConfigurableProperties:
        description: >
2775
2776
          This attribute provides values for the "vnfConfigurableProperties" input parameter of the Change VNF Flavour
          operation defined in ETSI GS NFV-SOL 003.
2777
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
2778
2779
2780
2781

  OperateVnfData:
    description: >
      This type represents a VNF instance for which the operational state 
piscione's avatar
piscione committed
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
      needs to be changed and the requested new state.
      NOTE:	The "stopType" and "gracefulStopTimeout" attributes shall be absent,
      when the "changeStateTo" attribute is equal to "STARTED". The "gracefulStopTimeout"
      attribute shall be present, when the "changeStateTo" attribute is equal to "STOPPED"
      and the "stopType" attribute is equal to "GRACEFUL". The "gracefulStopTimeout"
      attribute shall be absent, when the "changeStateTo" attribute is equal to
      "STOPPED" and the "stopType" attribute is equal to "FORCEFUL". The request
      shall be treated as if the "stopType" attribute was set to "FORCEFUL", when
      the "changeStateTo" attribute is equal to "STOPPED" and the "stopType" attribute
      is absent.
2792
2793
2794
2795
2796
2797
2798
2799
    type: object
    required:
      - vnfInstanceId
      - changeStateTo
    properties:
      vnfInstanceId:
        description: >
          Identifier of the VNF instance.
2800
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
2801
2802
2803
2804
2805
2806
2807
      changeStateTo:
        description: >
          The desired operational state (i.e. started or stopped)
          to change the VNF to.
        $ref: "#/definitions/OperationalStates"
      stopType:
        description: >
piscione's avatar
piscione committed
2808
2809
          It signals whether forceful or graceful stop is requested.
          See note.
2810
2811
2812
2813
2814
        $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
piscione's avatar
piscione committed
2815
          stopping the VNF. See note.
2816
        type: integer
2817
2818
2819
2820
2821
2822
      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"
2823
2824
2825
2826
2827
2828
2829
2830
2831

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

2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
  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.
2859
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
      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
2870
      vnfdId:
2871
        description: >
2872
          New value of the "vnfdId" attribute in "VnfInstance".
2873
          The value "null" is not permitted
2874
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
2875
2876
2877
      vnfConfigurableProperties:
        description: >
          Modifications to entries in the
2878
          "vnfConfigurableProperties" attribute in "VnfInstance", as defined below in clause 6.5.3.57.
2879
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
2880
      metadata:
2881
        description: >
2882
          Modifications to entries in the "metadata" attribute in "VnfInstance", as defined below in clause 6.5.3.57.
2883
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
2884
      extensions:
2885
        description: >
2886
          Modifications to entries in the "extensions" attribute in "VnfInstance", as defined below in clause 6.5.3.57.
2887
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
2888
2889
2890
2891
2892
2893

  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
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
         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.
2911
2912
2913
    type: object
    required:
      - vnfInstanceId
2914
      - extVirtualLinks
2915
2916
2917
2918
    properties:
      vnfInstanceId:
        description: >
          Identifier of the VNF instance.
2919
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
2920
      extVirtualLinks:
2921
2922
2923
2924
        description: >
          Information about external VLs to change (e.g. connect the VNF to).
        type: array
        items:
2925
          $ref: "#/definitions/ExtVirtualLinkData"
2926
2927
      additionalParams:
        description: >
2928
          Additional parameters passed by the OSS/BSS as input to
2929
2930
          the external connectivity change process, specific to the
          VNF instance being changed.
2931
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948

  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.
2949
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
      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.
2985
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
2986
2987
2988
2989
2990
      vnfInstanceId:
        description: >
          Specify the VNF instance that is moved.
        type: array
        items:
2991
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
2992
2993
2994
2995
2996
2997
2998
2999
3000

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