etsi_nfv_sol001_vnfd_types.yaml 69.8 KB
Newer Older
1
tosca_definitions_version: tosca_simple_yaml_1_2
admin_forge's avatar
admin_forge committed
2
description: ETSI NFV SOL 001 vnfd types definitions version 2.7.1
3
4
5
metadata:
  template_name: etsi_nfv_sol001_vnfd_types
  template_author: ETSI_NFV
admin_forge's avatar
admin_forge committed
6
  template_version: 2.7.1
7

8
imports:
admin_forge's avatar
admin_forge committed
9
10
   - https://forge.etsi.org/rep/nfv/SOL001/raw/v2.7.1/etsi_nfv_sol001_common_types.yaml
   # editor's note: During the development of the SOL001ed271 GS, to enable this file to be verified by a TOSCA parser, the imports statement has to be replaced with a reference to a local copy of the common definitions YAML file
11
12
13

data_types:
  tosca.datatypes.nfv.VirtualNetworkInterfaceRequirements:
admin_forge's avatar
admin_forge committed
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
   derived_from: tosca.datatypes.Root
   description: Describes requirements on a virtual network interface 
   properties:
     name:
       type: string
       description: Provides a human readable name for the requirement.    
       required: false
     description:
       type: string
       description: Provides a human readable description of the requirement.
       required: false
     support_mandatory:
       type: boolean
       description: Indicates whether fulfilling the constraint is mandatory (TRUE) for successful operation or desirable (FALSE).
       required: true
     network_interface_requirements:
       type: map
       description: The network interface requirements. A map of strings that contain a set of key-value pairs that describes the hardware platform specific  network interface deployment requirements.
       required: true
       entry_schema:
         type: string 
     nic_io_requirements:
       type: tosca.datatypes.nfv.LogicalNodeData
       description: references (couples) the CP with any logical node I/O requirements (for network devices) that may have been created. Linking these attributes is necessary so that so that I/O requirements that need to be articulated at the logical node level can be associated with the network interface requirements associated with the CP.
       required: false
39
40

  tosca.datatypes.nfv.RequestedAdditionalCapability:
admin_forge's avatar
admin_forge committed
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
   derived_from: tosca.datatypes.Root
   description: describes requested additional capability for a particular VDU
   properties:
     requested_additional_capability_name:
       type: string
       description: Identifies a requested additional capability for the VDU.
       required: true
     support_mandatory:
       type: boolean
       description: Indicates whether the requested additional capability is mandatory for successful operation.
       required: true
     min_requested_additional_capability_version:
       type: string
       description: Identifies the minimum version of the requested additional capability.
       required: false
     preferred_requested_additional_capability_version:
       type: string
       description: Identifies the preferred version of the requested additional capability.
       required: false
     target_performance_parameters:
       type: map
       description: Identifies specific attributes, dependent on the requested additional capability type.
       required: true
       entry_schema:
         type: string
       
67
68

  tosca.datatypes.nfv.VirtualMemory:
admin_forge's avatar
admin_forge committed
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
     derived_from: tosca.datatypes.Root
     description: supports the specification of requirements related to virtual memory of a virtual compute resource
     properties:
       virtual_mem_size:
         type: scalar-unit.size 
         description: Amount of virtual memory.
         required: true
       virtual_mem_oversubscription_policy:
         type: string
         description: The memory core oversubscription policy in terms of virtual memory to physical memory on the platform.
         required: false
       vdu_mem_requirements:
         type: map
         description: The hardware platform specific VDU memory requirements. A map of strings that contains a set of key-value pairs that describes hardware platform specific VDU memory requirements.
         required: false
         entry_schema:
           type: string
       numa_enabled:
         type: boolean
         description: It specifies the memory allocation to be cognisant of the relevant process/core allocation.
         required: false
         default: false
91
92

  tosca.datatypes.nfv.VirtualCpu:
admin_forge's avatar
admin_forge committed
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
   derived_from: tosca.datatypes.Root
   description: Supports the specification of requirements related to virtual CPU(s) of a virtual compute resource
   properties:
     cpu_architecture:
       type: string
       description: CPU architecture type. Examples are x86, ARM
       required: false
     num_virtual_cpu:
       type: integer
       description: Number of virtual CPUs
       required: true
       constraints:
         - greater_than: 0
     virtual_cpu_clock:
       type: scalar-unit.frequency
       description: Minimum virtual CPU clock rate
       required: false
     virtual_cpu_oversubscription_policy:
       type: string
       description: CPU core oversubscription policy e.g. the relation of virtual CPU cores to physical CPU cores/threads.
       required: false
     vdu_cpu_requirements:
       type: map
       description: The hardware platform specific VDU CPU requirements. A map of strings that contains a set of key-value pairs describing VDU CPU specific hardware platform requirements.
       required: false
       entry_schema:
         type: string 
     virtual_cpu_pinning:
       type: tosca.datatypes.nfv.VirtualCpuPinning
       description: The virtual CPU pinning configuration for the virtualised compute resource.
       required: false
124
125

  tosca.datatypes.nfv.VirtualCpuPinning:
admin_forge's avatar
admin_forge committed
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
   derived_from: tosca.datatypes.Root
   description: Supports the specification of requirements related to the virtual CPU pinning configuration of a virtual compute resource 
   properties:
     virtual_cpu_pinning_policy:
       type: string 
       description: Indicates the policy for CPU pinning. The policy can take values of "static" or "dynamic". In case of "dynamic" the allocation of virtual CPU cores to logical CPU cores is decided by the VIM. (e.g. SMT (Simultaneous Multi-Threading) requirements). In case of "static" the allocation is requested to be according to the virtual_cpu_pinning_rule.
       required: false
       constraints:
         - valid_values: [ static, dynamic ]
     virtual_cpu_pinning_rule:
       type: list
       description: Provides the list of rules for allocating virtual CPU cores to logical  CPU cores/threads 
       required: false
       entry_schema:
         type: string
       
142
143

  tosca.datatypes.nfv.VnfcConfigurableProperties:
admin_forge's avatar
admin_forge committed
144
145
146
147
148
149
150
151
152
153
   derived_from: tosca.datatypes.Root
   description: Defines the configurable properties of a VNFC 
   #properties:
     # additional_vnfc_configurable_properties:
     #   type: tosca.datatypes.nfv.VnfcAdditionalConfigurableProperties  
     #   description: Describes additional configuration for VNFC that can be modified using the ModifyVnfInfo operation 
     #   required: false
     # derived types are expected to introduce
     # additional_vnfc_configurable_properties with its type derived from
     # tosca.datatypes.nfv.VnfcAdditionalConfigurableProperties
154
155

  tosca.datatypes.nfv.VnfcAdditionalConfigurableProperties:
admin_forge's avatar
admin_forge committed
156
157
   derived_from: tosca.datatypes.Root
   description: VnfcAdditionalConfigurableProperties type is an empty base type for deriving data types for describing additional configurable properties for a given VNFC.
158
159

  tosca.datatypes.nfv.VduProfile:
admin_forge's avatar
admin_forge committed
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
   derived_from: tosca.datatypes.Root
   description: describes additional instantiation data for a given Vdu.Compute used in a specific deployment flavour.
   properties:
     min_number_of_instances:
       type: integer
       description: Minimum number of instances of the VNFC based on this Vdu.Compute that is permitted to exist for a particular VNF deployment flavour.
       required: true
       constraints:
         - greater_or_equal: 0
     max_number_of_instances:
       type: integer
       description: Maximum number of instances of the VNFC based on this Vdu.Compute that is permitted to exist for a particular VNF deployment flavour. 
       required: true
       constraints:
         - greater_or_equal: 0
175
176

  tosca.datatypes.nfv.VlProfile:
admin_forge's avatar
admin_forge committed
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
   derived_from: tosca.datatypes.Root
   description: Describes additional instantiation data for a given VL used in a specific VNF deployment flavour.
   properties:
     max_bitrate_requirements:
       type: tosca.datatypes.nfv.LinkBitrateRequirements
       description: Specifies the maximum bitrate requirements for a VL instantiated according to this profile.
       required: true
     min_bitrate_requirements:
       type: tosca.datatypes.nfv.LinkBitrateRequirements
       description: Specifies the minimum bitrate requirements for a VL instantiated according to this profile.
       required: true
     qos:
       type: tosca.datatypes.nfv.Qos
       description: Specifies the QoS requirements of a VL instantiated according to this profile.
       required: false
     virtual_link_protocol_data:
       type: list
       description: Specifies the protocol data for a virtual link.
       required: false
       entry_schema:
         type: tosca.datatypes.nfv.VirtualLinkProtocolData
198
199

  tosca.datatypes.nfv.VirtualLinkProtocolData:
admin_forge's avatar
admin_forge committed
200
201
202
203
   derived_from: tosca.datatypes.Root
   description: describes one protocol layer and associated protocol data for a given virtual link used in a specific VNF deployment flavour
   properties:
     associated_layer_protocol:
204
        type: string
admin_forge's avatar
admin_forge committed
205
206
        description: Identifies one of the protocols a virtualLink gives access to (ethernet, mpls, odu2, ipv4, ipv6, pseudo-wire) as specified by the connectivity_type property.
        required: true
207
        constraints:
admin_forge's avatar
admin_forge committed
208
209
210
211
          - valid_values: [ ethernet, mpls, odu2, ipv4, ipv6, pseudo-wire ]
     l2_protocol_data:
        type: tosca.datatypes.nfv.L2ProtocolData
        description: Specifies the L2 protocol data for a virtual link. Shall be present when the associatedLayerProtocol attribute indicates a L2 protocol and shall be absent otherwise.
212
        required: false
admin_forge's avatar
admin_forge committed
213
214
215
     l3_protocol_data:
        type: tosca.datatypes.nfv.L3ProtocolData
        description: Specifies the L3 protocol data for this virtual link.  Shall be present when the associatedLayerProtocol attribute indicates a L3 protocol and shall be absent otherwise.
216
        required: false
admin_forge's avatar
admin_forge committed
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247

  tosca.datatypes.nfv.L2ProtocolData:
   derived_from: tosca.datatypes.Root
   description: describes L2 protocol data for a given virtual link used in a specific VNF deployment flavour.
   properties:
     name:
       type: string
       description: Identifies the network name associated with this L2 protocol.
       required: false
     network_type:
       type: string
       description: Specifies the network type for this L2 protocol. The value may be overridden at run-time.
       required: false
       constraints:
         - valid_values: [ flat, vlan, vxlan, gre ]
     vlan_transparent:
       type: boolean
       description: Specifies whether to support VLAN transparency for this L2 protocol or not.
       required: false
       default: false
     mtu:
       type: integer
       description: Specifies the maximum transmission unit (MTU) value for this L2 protocol.
       required: false
       constraints:
         - greater_than: 0 
     segmentation_id:
       type: string
       description: Specifies a specific virtualised network segment, which depends on the network type. For e.g., VLAN ID for VLAN network type and tunnel ID for GRE/VXLAN network types
       required: false

248
249

  tosca.datatypes.nfv.L3ProtocolData:
admin_forge's avatar
admin_forge committed
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
   derived_from: tosca.datatypes.Root
   description: describes L3 protocol data for a given virtual link used in a specific VNF deployment flavour.
   properties:
     name:
       type: string
       description: Identifies the network name associated with this L3 protocol.
       required: false
     ip_version:
       type: string
       description: Specifies IP version of this L3 protocol. The value of the ip_version property shall be consistent with the value of the layer_protocol in the connectivity_type property of the virtual link node.
       required: true
       constraints:
         - valid_values: [ ipv4, ipv6 ]
     cidr:
       type: string
       description: Specifies the CIDR (Classless Inter-Domain Routing) of this L3 protocol. The value may be overridden at run-time.
       required: true  
     ip_allocation_pools:
       type: list
       description: Specifies the allocation pools with start and end IP addresses for this L3 protocol. The value may be overridden at run-time.
       required: false
       entry_schema:
         type: tosca.datatypes.nfv.IpAllocationPool
     gateway_ip:
       type: string
       description: Specifies the gateway IP address for this L3 protocol. The value may be overridden at run-time.
       required: false
     dhcp_enabled:
       type: boolean
       description: Indicates whether DHCP (Dynamic Host Configuration Protocol) is enabled or disabled for this L3 protocol. The value may be overridden at run-time.
       required: false
     ipv6_address_mode:
       type: string
       description: Specifies IPv6 address mode. May be present when the value of the ipVersion attribute is "ipv6" and shall be absent otherwise. The value may be overridden at run-time.
       required: false
       constraints:
         - valid_values: [ slaac, dhcpv6-stateful, dhcpv6-stateless ] 
287
288

  tosca.datatypes.nfv.IpAllocationPool:
admin_forge's avatar
admin_forge committed
289
290
291
292
293
294
295
296
297
298
299
   derived_from: tosca.datatypes.Root
   description: Specifies a range of IP addresses
   properties:
     start_ip_address:
       type: string
       description: The IP address to be used as the first one in a pool of addresses derived from the cidr block full IP range
       required: true
     end_ip_address:
       type: string
       description: The IP address to be used as the last one in a pool of addresses derived from the cidr block full IP range
       required: true
300
301

  tosca.datatypes.nfv.InstantiationLevel:
admin_forge's avatar
admin_forge committed
302
303
304
305
306
307
308
309
310
311
312
313
314
   derived_from: tosca.datatypes.Root
   description: Describes the scale level for each aspect that corresponds to a given level of resources to be instantiated within a deployment flavour in term of the number VNFC instances 
   properties:
     description:
       type: string
       description: Human readable description of the level 
       required: true
     scale_info:
       type: map # key: aspectId
       description: Represents for each aspect the scale level that corresponds to this instantiation level. scale_info shall be present if the VNF supports scaling.
       required: false
       entry_schema:
         type: tosca.datatypes.nfv.ScaleInfo
315
316

  tosca.datatypes.nfv.VduLevel:
admin_forge's avatar
admin_forge committed
317
318
319
320
321
322
323
324
325
   derived_from: tosca.datatypes.Root
   description: Indicates for a given Vdu.Compute in a given level the number of instances to deploy 
   properties:
     number_of_instances:
       type: integer
       description: Number of instances of VNFC based on this VDU to deploy for this level.  
       required: true
       constraints:
         - greater_or_equal: 0
326
327

  tosca.datatypes.nfv.VnfLcmOperationsConfiguration:
admin_forge's avatar
admin_forge committed
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
   derived_from: tosca.datatypes.Root
   description: Represents information to configure lifecycle management operations  
   properties:
     instantiate:
       type: tosca.datatypes.nfv.VnfInstantiateOperationConfiguration
       description: Configuration parameters for the InstantiateVnf operation 
       required: false
     scale:
       type: tosca.datatypes.nfv.VnfScaleOperationConfiguration
       description: Configuration parameters for the ScaleVnf operation 
       required: false
     scale_to_level:
       type: tosca.datatypes.nfv.VnfScaleToLevelOperationConfiguration
       description: Configuration parameters for the ScaleVnfToLevel operation 
       required: false
     change_flavour:
       type: tosca.datatypes.nfv.VnfChangeFlavourOperationConfiguration
       description: Configuration parameters for the changeVnfFlavourOpConfig operation 
       required: false
     heal:
       type: tosca.datatypes.nfv.VnfHealOperationConfiguration
       description: Configuration parameters for the HealVnf operation 
       required: false
     terminate:
       type: tosca.datatypes.nfv.VnfTerminateOperationConfiguration
       description: Configuration parameters for the TerminateVnf operation 
       required: false
     operate:
       type: tosca.datatypes.nfv.VnfOperateOperationConfiguration
       description: Configuration parameters for the OperateVnf operation 
       required: false
     change_ext_connectivity:
       type:   tosca.datatypes.nfv.VnfChangeExtConnectivityOperationConfiguration
       description: Configuration parameters for the changeExtVnfConnectivityOpConfig operation 
       required: false
363
364

  tosca.datatypes.nfv.VnfInstantiateOperationConfiguration:
admin_forge's avatar
admin_forge committed
365
366
367
368
   derived_from: tosca.datatypes.Root
   description: represents information that affect the invocation of the InstantiateVnf operation.
   # This data type definition is reserved for future use in the present document.
   # properties:
369
370

  tosca.datatypes.nfv.VnfScaleOperationConfiguration:
admin_forge's avatar
admin_forge committed
371
372
373
374
375
376
377
378
   derived_from: tosca.datatypes.Root
   description: Represents information that affect the invocation of the ScaleVnf operation 
   properties:
     scaling_by_more_than_one_step_supported:
       type: boolean
       description: Signals whether passing a value larger than one in the numScalingSteps parameter of the ScaleVnf operation is supported by this VNF.
       required: false
       default: false 
379
380

  tosca.datatypes.nfv.VnfScaleToLevelOperationConfiguration:
admin_forge's avatar
admin_forge committed
381
382
383
384
385
386
387
   derived_from: tosca.datatypes.Root
   description: represents information that affect the invocation of the ScaleVnfToLevel operation
   properties:
     arbitrary_target_levels_supported:
       type: boolean
       description: Signals whether scaling according to the parameter "scaleInfo" is supported by this VNF
       required: true
388
389

  tosca.datatypes.nfv.VnfHealOperationConfiguration:
admin_forge's avatar
admin_forge committed
390
391
392
393
394
395
396
397
398
   derived_from: tosca.datatypes.Root
   description: represents information that affect the invocation of the HealVnf operation 
   properties:
     causes:
       type: list
       description: Supported "cause" parameter values 
       required: false
       entry_schema:
         type: string
399
400

  tosca.datatypes.nfv.VnfTerminateOperationConfiguration:
admin_forge's avatar
admin_forge committed
401
402
403
404
405
406
407
408
409
410
411
   derived_from: tosca.datatypes.Root
   description: represents information that affect the invocation of the TerminateVnf 
   properties:
     min_graceful_termination_timeout:
       type: scalar-unit.time
       description: Minimum timeout value for graceful termination of a VNF instance 
       required: true
     max_recommended_graceful_termination_timeout:
       type: scalar-unit.time
       description: Maximum recommended timeout value that can be needed to gracefully terminate a VNF instance of a particular type under certain conditions, such as maximum load condition. This is provided by VNF provider as information for the operator facilitating the selection of optimal timeout value. This value is not used as constraint
       required: false
412
413

  tosca.datatypes.nfv.VnfOperateOperationConfiguration:
admin_forge's avatar
admin_forge committed
414
415
416
417
418
419
420
421
422
423
424
   derived_from: tosca.datatypes.Root
   description: represents information that affect the invocation of the OperateVnf operation 
   properties:
     min_graceful_stop_timeout:
       type: scalar-unit.time
       description: Minimum timeout value for graceful stop of a VNF instance 
       required: true
     max_recommended_graceful_stop_timeout:
       type: scalar-unit.time
       description: Maximum recommended timeout value that can be needed to gracefully stop a VNF instance of a particular type under certain conditions, such as maximum load condition. This is provided by VNF provider as information for the operator facilitating the selection of optimal timeout value. This value is not used as constraint
       required: false
425
426

  tosca.datatypes.nfv.ScaleInfo:
admin_forge's avatar
admin_forge committed
427
428
429
430
431
432
433
434
435
   derived_from: tosca.datatypes.Root
   description: Indicates for a given scaleAspect the corresponding scaleLevel 
   properties:
     scale_level:
       type: integer
       description: The scale level for a particular aspect 
       required: true
       constraints:
         - greater_or_equal: 0
436
437

  tosca.datatypes.nfv.ScalingAspect:
admin_forge's avatar
admin_forge committed
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
   derived_from: tosca.datatypes.Root
   description: describes the details of an aspect used for horizontal scaling
   properties:
     name:
       type: string
       description: Human readable name of the aspect
       required: true
     description:
       type: string
       description: Human readable description of the aspect
       required: true
     max_scale_level:
       type: integer # positiveInteger
       description: Total number of scaling steps that can be applied w.r.t. this aspect. The value of this property corresponds to the number of scaling steps can be applied to this aspect when scaling it from the minimum scale level (i.e. 0) to the maximum scale level defined by this property
       required: true
       constraints:
         - greater_or_equal: 0
     step_deltas:
       type: list
       description: List of scaling deltas to be applied for the different subsequent scaling steps of this aspect. The first entry in the array shall correspond to the first scaling step (between scale levels 0 to 1) and the last entry in the array shall correspond to the last scaling step (between maxScaleLevel-1 and maxScaleLevel)
       required: false
       entry_schema:
         type: string # Identifier
461
462

  tosca.datatypes.nfv.VnfConfigurableProperties:
admin_forge's avatar
admin_forge committed
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
   derived_from: tosca.datatypes.Root
   description: indicates configuration properties for a given VNF (e.g. related to auto scaling and auto healing).
   properties:
     is_autoscale_enabled:
       type: boolean
       description: It permits to enable (TRUE)/disable (FALSE) the auto-scaling functionality. If the property is not present, then configuring this VNF property is not supported 
       required: false
     is_autoheal_enabled:
       type: boolean
       description: It permits to enable (TRUE)/disable (FALSE) the auto-healing functionality. If the property is not present, then configuring this VNF property is not supported 
       required: false
     vnfm_interface_info:
       type: tosca.datatypes.nfv.VnfmInterfaceInfo
       description: Contains information enabling access to the NFV-MANO interfaces produced by the VNFM (e.g. URIs and credentials), If the property is not present, then configuring this VNF property is not supported.
       required: false
     vnfm_oauth_server_info:
       type: tosca.datatypes.nfv.OauthServerInfo
       description: Contains information to enable discovery of the authorization server protecting access to VNFM interfaces. If the property is not present, then configuring this VNF property is not supported.
       required: false
     vnf_oauth_server_info:
       type: tosca.datatypes.nfv.OauthServerInfo
       description: Contains information to enable discovery of the authorization server to validate the access tokens provided by the VNFM when  the VNFM accesses the VNF interfaces, if that functionality (token introspection) is supported by the authorization server. If the property is not present, then configuring this VNF property is not supported.
       required: false
     # additional_configurable_properties:
       # description: It provides VNF specific configurable properties that can be
       # modified using the ModifyVnfInfo operation 
       # required: false
       # type: tosca.datatypes.nfv.VnfAdditionalConfigurableProperties
     # derived types are expected to introduce
     # additional_configurable_properties with its type derived from
     # tosca.datatypes.nfv.VnfAdditionalConfigurableProperties
494
495

  tosca.datatypes.nfv.VnfAdditionalConfigurableProperties:
admin_forge's avatar
admin_forge committed
496
497
498
499
500
501
502
503
504
   derived_from: tosca.datatypes.Root 
   description: is an empty base type for deriving data types for describing additional configurable properties for a given VNF
   properties:
     is_writable_anytime:
       type: boolean
       description: It specifies whether these additional configurable properties are writeable (TRUE) at any time (i.e. prior to / at instantiation time as well as after instantiation).or (FALSE) only prior to / at instantiation time. If this property is not present, the additional configurable properties are writable anytime.
       required: false
       default : false
   
505
  tosca.datatypes.nfv.VnfInfoModifiableAttributes:
admin_forge's avatar
admin_forge committed
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
   derived_from: tosca.datatypes.Root
   description: Describes VNF-specific extension and metadata for a given VNF 
   #properties:
     #extensions:
       #type: tosca.datatypes.nfv.VnfInfoModifiableAttributesExtensions
       #description: "Extension" properties of VnfInfo that are writeable 
       #required: false
       # derived types are expected to introduce
       # extensions with its type derived from
       # tosca.datatypes.nfv.VnfInfoModifiableAttributesExtensions
     #metadata:
       #type: tosca.datatypes.nfv.VnfInfoModifiableAttributesMetadata
       #description: "Metadata" properties of VnfInfo that are writeable 
       #required: false
       # derived types are expected to introduce
       # metadata with its type derived from
       # tosca.datatypes.nfv.VnfInfoModifiableAttributesMetadata
523
524

  tosca.datatypes.nfv.VnfInfoModifiableAttributesExtensions:
admin_forge's avatar
admin_forge committed
525
526
   derived_from: tosca.datatypes.Root 
   description: is an empty base type for deriving data types for describing VNF-specific extension
527
528

  tosca.datatypes.nfv.VnfInfoModifiableAttributesMetadata:
admin_forge's avatar
admin_forge committed
529
530
   derived_from: tosca.datatypes.Root
   description: is an empty base type for deriving data types for describing VNF-specific metadata
531
532

  tosca.datatypes.nfv.LogicalNodeData:
admin_forge's avatar
admin_forge committed
533
534
535
536
537
538
539
540
541
   derived_from: tosca.datatypes.Root
   description: Describes compute, memory and I/O requirements associated with a particular VDU.
   properties:
     logical_node_requirements:
       type: map
       description: The logical node-level compute, memory and I/O requirements. A map  of strings that contains a set of key-value pairs that describes hardware platform specific deployment requirements, including the number of CPU cores on this logical node, a memory configuration specific to a logical node  or a requirement related to the association of an I/O device with the logical node.
       required: false
       entry_schema:
         type: string 
542
543

  tosca.datatypes.nfv.SwImageData:
admin_forge's avatar
admin_forge committed
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
   derived_from: tosca.datatypes.Root
   description: describes information  related to a software image artifact 
   properties: 
     name:
       type: string
       description: Name of this software image 
       required: true
     version:
       type: string
       description: Version of this software image 
       required: true
     provider:
       type: string
       description: Provider of this software image
       required: false
     checksum:
       type: tosca.datatypes.nfv.ChecksumData
       description:  Checksum of the software image file 
       required: true
     container_format:
       type: string
       description: The container format describes the container file format in which software image is provided 
       required: true
       constraints:
         - valid_values: [ aki, ami, ari, bare, docker, ova, ovf ]
     disk_format:
       type: string
       description: The disk format of a software image is the format of the underlying disk image 
       required: true
       constraints:
         - valid_values: [ aki, ami, ari, iso, qcow2, raw, vdi, vhd, vhdx, vmdk ]  
     min_disk:
       type: scalar-unit.size # Number
       description:  The minimal disk size requirement for this software image 
       required: true
       constraints:
         - greater_or_equal: 0 B
     min_ram:
       type: scalar-unit.size # Number
       description: The minimal RAM requirement for this software image 
       required: false
       constraints:
         - greater_or_equal: 0 B
     size:
       type: scalar-unit.size # Number
       description: The size of this software image 
       required: true
     operating_system:
       type: string
       description: Identifies the operating system used in the software image 
       required: false
     supported_virtualisation_environments:
       type: list
       description: Identifies the virtualisation environments (e.g. hypervisor) compatible with this software image 
       required: false
       entry_schema:
         type: string
601
602

  tosca.datatypes.nfv.VirtualBlockStorageData:
admin_forge's avatar
admin_forge committed
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
   derived_from: tosca.datatypes.Root
   description: VirtualBlockStorageData describes block storage requirements associated with compute resources in a particular VDU, either as a local disk or as virtual attached storage
   properties:
     size_of_storage:
       type: scalar-unit.size
       description: Size of virtualised storage resource
       required: true
       constraints:
         - greater_or_equal: 0 B
     vdu_storage_requirements:
       type: map
       description: The hardware platform specific storage requirements. A map of strings that contains a set of key-value pairs that represents the hardware platform specific storage deployment requirements 
       required: false 
       entry_schema:
         type: string
     rdma_enabled:
       type: boolean
       description: Indicates if the storage support RDMA 
       required: false
       default: false
623
624

  tosca.datatypes.nfv.VirtualObjectStorageData:
admin_forge's avatar
admin_forge committed
625
626
627
628
629
630
631
632
633
     derived_from: tosca.datatypes.Root
     description: VirtualObjectStorageData describes object storage requirements associated with compute resources in a particular VDU
     properties:
       max_size_of_storage:
         type: scalar-unit.size
         description: Maximum size of virtualized  storage resource 
         required: false
         constraints:
           - greater_or_equal: 0 B
634
635

  tosca.datatypes.nfv.VirtualFileStorageData:
admin_forge's avatar
admin_forge committed
636
637
638
639
640
641
642
643
644
645
646
647
648
       derived_from: tosca.datatypes.Root
       description: VirtualFileStorageData describes file storage requirements associated with compute resources in a particular VDU
       properties:
         size_of_storage:
           type: scalar-unit.size
           description: Size of virtualized storage resource
           required: true
           constraints:
             - greater_or_equal: 0 B
         file_system_protocol:
           type: string
           description: The shared file system protocol (e.g. NFS, CIFS)
           required: true
649
650
651
652
653
654

  tosca.datatypes.nfv.VirtualLinkBitrateLevel:
    derived_from: tosca.datatypes.Root
    description: Describes bitrate requirements applicable to the virtual link instantiated from a particicular VnfVirtualLink 
    properties:
      bitrate_requirements:
admin_forge's avatar
admin_forge committed
655
656
657
       type: tosca.datatypes.nfv.LinkBitrateRequirements
       description: Virtual link bitrate requirements for an instantiation level or bitrate delta for a scaling step 
       required: true
658
659
660
661

  tosca.datatypes.nfv.VnfOperationAdditionalParameters:
    derived_from: tosca.datatypes.Root
    description: Is an empty base type for deriving data type for describing VNF-specific parameters to be passed when invoking lifecycle management operations 
admin_forge's avatar
admin_forge committed
662
    # properties:
663
664
665
666

  tosca.datatypes.nfv.VnfChangeFlavourOperationConfiguration:
    derived_from: tosca.datatypes.Root
    description: represents information that affect the invocation of the ChangeVnfFlavour operation 
admin_forge's avatar
admin_forge committed
667
668
    # This data type definition is reserved for future use in the present document.
    # properties:
669
670
671
672

  tosca.datatypes.nfv.VnfChangeExtConnectivityOperationConfiguration:
    derived_from: tosca.datatypes.Root
    description: represents information that affect the invocation of the ChangeExtVnfConnectivity operation 
admin_forge's avatar
admin_forge committed
673
674
675
676
    # This data type definition is reserved for future use in the present document.
    # properties:
    
  tosca.datatypes.nfv.VnfcMonitoringParameter:
677
678
679
680
    derived_from: tosca.datatypes.Root
    description: Represents information on virtualised resource related performance metrics applicable to the VNF.
    properties:
      name:
admin_forge's avatar
admin_forge committed
681
682
683
       type: string
       description: Human readable name of the monitoring parameter
       required: true
684
      performance_metric:
admin_forge's avatar
admin_forge committed
685
686
687
688
689
       type: string
       description: Identifies a performance metric to be monitored, according to ETSI GS NFV-IFA 027. 
       required: true
       constraints:
         - valid_values: [ v_cpu_usage_mean_vnf, v_cpu_usage_peak_vnf, v_memory_usage_mean_vnf, v_memory_usage_peak_vnf, v_disk_usage_mean_vnf, v_disk_usage_peak_vnf, byte_incoming_vnf_int_cp, byte_outgoing_vnf_int_cp, packet_incoming_vnf_int_cp, packet_outgoing_vnf_int_cp, v_cpu_usage_mean, v_cpu_usage_peak,v_memory_usage_mean,v_memory_usage_peak, v_disk_usage_mean, v_disk_usage_peak, v_net_byte_incoming, v_net_byte_outgoing, v_net_packet_incoming, v_net_packet_outgoing, usage_mean_vStorage, usage_peak_vStorage ] 
690
      collection_period:
admin_forge's avatar
admin_forge committed
691
692
693
694
695
       type: scalar-unit.time
       description: Describes the  periodicity at which to collect the performance information. 
       required: false
       constraints: 
        - greater_than: 0 s
696

admin_forge's avatar
admin_forge committed
697
  tosca.datatypes.nfv.VirtualLinkMonitoringParameter:
698
699
700
701
    derived_from: tosca.datatypes.Root
    description: Represents information on virtualised resource related performance metrics applicable to the VNF.
    properties:
      name:
admin_forge's avatar
admin_forge committed
702
703
704
       type: string
       description: Human readable name of the monitoring parameter
       required: true
705
      performance_metric:
admin_forge's avatar
admin_forge committed
706
707
708
709
710
       type: string
       description: Identifies a performance metric to be monitored.
       required: true
       constraints:
         - valid_values: [ byte_incoming, byte_outgoing, packet_incoming, packet_outgoing ] 
711
      collection_period:
admin_forge's avatar
admin_forge committed
712
713
714
715
716
       type: scalar-unit.time
       description: Describes the periodicity at which to collect the performance information. 
       required: false
       constraints: 
        - greater_than: 0 s
717

admin_forge's avatar
admin_forge committed
718
  tosca.datatypes.nfv.InterfaceDetails:
719
    derived_from: tosca.datatypes.Root
admin_forge's avatar
admin_forge committed
720
    description: information used to access an interface exposed by a VNF
721
    properties:
admin_forge's avatar
admin_forge committed
722
723
724
725
726
727
728
729
730
      uri_components:
       type: tosca.datatypes.nfv.UriComponents
       description: Provides components to build a Uniform Ressource Identifier (URI) where to access the interface end point.
       required: false
      interface_specific_data:
       type: map
       description: Provides additional details that are specific to the type of interface considered.
       required: false
       entry_schema:
731
732
        type: string

admin_forge's avatar
admin_forge committed
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
  tosca.datatypes.nfv.UriComponents:
    derived_from: tosca.datatypes.Root
    description: information used to build a URI that complies with IETF RFC 3986 [8].
    properties:
      scheme:
       type: string # shall comply with IETF RFC 3986
       description: scheme component of a URI.
       required: true
      authority: 
       type: tosca.datatypes.nfv.UriAuthority
       description: Authority component of a URI
       required: false
      path:
       type: string # shall comply with IETF RFC 3986
       description: path component of a URI.
       required: false
      query:
       type: string # shall comply with IETF RFC 3986
       description: query component of a URI.
       required: false
      fragment:
       type: string # shall comply with IETF RFC 3986
       description: fragment component of a URI.
       required: false

  tosca.datatypes.nfv.UriAuthority:
    derived_from: tosca.datatypes.Root
    description: information that corresponds to the authority component of a URI as specified in IETF RFC 3986 [8]
    properties:
     user_info:
      type: string # shall comply with IETF RFC 3986 
      description: user_info field of the authority component of a URI
      required: false
     host:
      type: string # shall comply with IETF RFC 3986
      description: host field of the authority component of a URI
      required: false
     port:
      type: string # shall comply with IETF RFC 3986
      description: port field of the authority component of a URI
      required: false

  tosca.datatypes.nfv.ChecksumData:
     derived_from: tosca.datatypes.Root
     description: Describes information about the result of performing a checksum operation over some arbitrary data 
     properties:
       algorithm:
         type: string
         description: Describes the algorithm used to obtain the checksum value
         required: true
         constraints:
           - valid_values: [sha-224, sha-256, sha-384, sha-512 ]
       hash:
         type: string
         description: Contains the result of applying the algorithm indicated by the algorithm property to the data to which this ChecksumData refers 
         required: true

  tosca.datatypes.nfv.VnfmInterfaceInfo:
791
    derived_from: tosca.datatypes.Root
admin_forge's avatar
admin_forge committed
792
    description: describes information enabling the VNF instance to access the NFV-MANO interfaces produced by the VNFM
793
    properties:
admin_forge's avatar
admin_forge committed
794
795
796
797
798
799
800
801
802
803
804
      interface_name: 
        type: string 
        description: Identifies an interface produced by the VNFM. 
        required: true 
        constraints: 
          - valid_values: [ vnf_lcm, vnf_pm, vnf_fm ] 
      details: 
        type: tosca.datatypes.nfv.InterfaceDetails 
        description: Provide additional data to access the interface endpoint 
        required: false  
      credentials: 
805
        type: map
admin_forge's avatar
admin_forge committed
806
        description: Provides credential enabling access to the interface
807
808
809
810
        required: false
        entry_schema:
          type: string

admin_forge's avatar
admin_forge committed
811
  tosca.datatypes.nfv.OauthServerInfo:
812
    derived_from: tosca.datatypes.Root
admin_forge's avatar
admin_forge committed
813
814
815
816
817
818
819
    description: information to enable discovery of the authorization server
    #properties: FFS
    #This data type definition is reserved for future use in the present document

  tosca.datatypes.nfv.BootData:
    derived_from: tosca.datatypes.Root
    description: describes the information used to customize a virtualised compute resource at boot time.
820
    properties:
admin_forge's avatar
admin_forge committed
821
822
823
      vim_specific_properties:
        type: tosca.datatypes.nfv.BootDataVimSpecificProperties
        description: Properties used for selecting VIM specific capabilities when setting the boot data.
824
        required: false
admin_forge's avatar
admin_forge committed
825
826
827
      kvp_data:
        type: tosca.datatypes.nfv.KvpData
        description: A set of key-value pairs for configuring a virtual compute resource.
828
        required: false
admin_forge's avatar
admin_forge committed
829
830
831
      content_or_file_data:
        type: tosca.datatypes.nfv.ContentOrFileData
        description: A string content or a file for configuring a virtual compute resource. 
832
        required: false
admin_forge's avatar
admin_forge committed
833
834
835
836
837
838
839
840

  tosca.datatypes.nfv.KvpData:
    derived_from: tosca.datatypes.Root
    description: describes a set of key-value pairs information used to customize a virtualised compute resource at boot time by using only key-value pairs data.
    properties:
      data:
        type: map
        description: A map of strings that contains a set of key-value pairs that describes the information for configuring the virtualised compute resource.
841
        required: false
admin_forge's avatar
admin_forge committed
842
843
        entry_schema:
          type: string
844

admin_forge's avatar
admin_forge committed
845
  tosca.datatypes.nfv.ContentOrFileData:
846
    derived_from: tosca.datatypes.Root
admin_forge's avatar
admin_forge committed
847
    description: describes a string content or a file information used to customize a virtualised compute resource at boot time by using string content or file.
848
    properties:
admin_forge's avatar
admin_forge committed
849
850
851
852
853
854
855
856
857
      data:
        type: map
        description: A map of strings that contains a set of key-value pairs that carries the dynamic deployment values which used to replace the corresponding variable parts in the file as identify by a URL as described in source_path. Shall be present if "source_path" is present and shall be absent otherwise..
        required: false
        entry_schema:
          type: string
      content:
        type: string
        description: The string information used to customize a virtualised compute resource at boot time.
858
        required: false
admin_forge's avatar
admin_forge committed
859
860
861
      source_path:
        type: string
        description: The URL to a file contained in the VNF package used to customize a virtualised compute resource. The content shall comply with IETF RFC 3986 [8].
862
        required: false
admin_forge's avatar
admin_forge committed
863
864
865
      destination_path:
        type: string
        description: The URL address when inject a file into the virtualised compute resource. The content shall comply with IETF RFC 3986 [8].
866
867
        required: false

admin_forge's avatar
admin_forge committed
868
  tosca.datatypes.nfv.BootDataVimSpecificProperties:
869
    derived_from: tosca.datatypes.Root
admin_forge's avatar
admin_forge committed
870
    description: describes the VIM specific information used for selecting VIM specific capabilities when setting the boot data.
871
    properties:
admin_forge's avatar
admin_forge committed
872
873
874
      vim_type:
        type: string 
        description: Discriminator for the different types of the VIM information.
875
        required: true
admin_forge's avatar
admin_forge committed
876
877
878
879
880
      properties:
        type: map
        description: Properties used for selecting VIM specific capabilities when setting the boot data
        entry_schema:
          type: string
881
882
883
        required: true

artifact_types:
admin_forge's avatar
admin_forge committed
884
  
885
886
  tosca.artifacts.nfv.SwImage:
    derived_from: tosca.artifacts.Deployment.Image
admin_forge's avatar
admin_forge committed
887
    description: describes the software image which is directly loaded on the virtualisation container realizing of the VDU or is to be loaded on a virtual storage resource
888
889
890
891
892
893
894

  tosca.artifacts.Implementation.nfv.Mistral:
    derived_from: tosca.artifacts.Implementation
    description: artifacts for Mistral workflows 
    mime_type: application/x-yaml
    file_ext: [ yaml ]

admin_forge's avatar
admin_forge committed
895

896
capability_types:
admin_forge's avatar
admin_forge committed
897
  
898
899
900
901
902
  tosca.capabilities.nfv.VirtualBindable:
    derived_from: tosca.capabilities.Node
    description: Indicates that the node that includes it can be pointed by a tosca.relationships.nfv.VirtualBindsTo relationship type which is used to model the VduHasCpd association

  tosca.capabilities.nfv.VirtualCompute:
admin_forge's avatar
admin_forge committed
903
    
904
905
906
907
    derived_from: tosca.capabilities.Node
    description: Describes the capabilities related to virtual compute resources 
    properties:
      logical_node:
admin_forge's avatar
admin_forge committed
908
909
910
911
912
       type: map
       description: Describes the Logical Node requirements 
       required: false
       entry_schema:
         type: tosca.datatypes.nfv.LogicalNodeData
913
      requested_additional_capabilities:
admin_forge's avatar
admin_forge committed
914
915
916
917
918
       type: map
       description: Describes additional capability for a particular VDU 
       required: false
       entry_schema:
         type: tosca.datatypes.nfv.RequestedAdditionalCapability
919
      compute_requirements:
admin_forge's avatar
admin_forge committed
920
921
922
923
       type: map
       required: false 
       entry_schema:
         type: string
924
      virtual_memory:
admin_forge's avatar
admin_forge committed
925
926
927
       type: tosca.datatypes.nfv.VirtualMemory
       description: Describes virtual memory of the virtualized compute 
       required: true
928
      virtual_cpu:
admin_forge's avatar
admin_forge committed
929
930
931
       type: tosca.datatypes.nfv.VirtualCpu
       description: Describes virtual CPU(s) of the virtualized compute 
       required: true
932
      virtual_local_storage:
admin_forge's avatar
admin_forge committed
933
934
935
936
937
938
       type: list
       description: A list of virtual system disks created and destroyed as part of the VM lifecycle 
       required: false
       entry_schema:
        type: tosca.datatypes.nfv.VirtualBlockStorageData
        description: virtual system disk definition 
939
940
941
942

  tosca.capabilities.nfv.VirtualStorage:
    derived_from: tosca.capabilities.Root
    description: Describes the attachment capabilities related to Vdu.Storage
admin_forge's avatar
admin_forge committed
943
944


945
946
947
948
relationship_types:
  tosca.relationships.nfv.VirtualBindsTo:
    derived_from: tosca.relationships.DependsOn
    description: Represents an association relationship between Vdu.Compute and VduCp node types 
admin_forge's avatar
admin_forge committed
949
    valid_target_types: [ tosca.capabilities.nfv.VirtualBindable ]
950
951
952
953
954

  tosca.relationships.nfv.AttachesTo:
    derived_from: tosca.relationships.Root
    description: Represents an association relationship between the Vdu.Compute and one of the node types, Vdu.VirtualBlockStorage, Vdu.VirtualObjectStorage or Vdu.VirtualFileStorage
    valid_target_types: [ tosca.capabilities.nfv.VirtualStorage ]
admin_forge's avatar
admin_forge committed
955
956


957
958
959
960
961
962
interface_types:
  tosca.interfaces.nfv.Vnflcm:
    derived_from: tosca.interfaces.Root
    description: This interface encompasses a set of TOSCA operations corresponding to the VNF LCM operations defined in ETSI GS NFV-IFA 007 as well as to preamble and postamble procedures to the execution of the VNF LCM operations.
    instantiate:
      description: Invoked upon receipt of an Instantiate VNF request
admin_forge's avatar
admin_forge committed
963
964
965
966
967
968
    # inputs:
     # additional_parameters:
      # type: tosca.datatypes.nfv.VnfOperationAdditionalParameters
      # required: false
     # derived types are expected to introduce additional_parameters with its
     # type derived from tosca.datatypes.nfv.VnfOperationAdditionalParameters
969
970
971
972
973
974
    instantiate_start:
      description: Invoked before instantiate
    instantiate_end:
      description: Invoked after instantiate
    terminate:
      description: Invoked upon receipt Terminate VNF request
admin_forge's avatar
admin_forge committed
975
976
977
978
979
980
    # inputs:
     # additional_parameters:
      # type: tosca.datatypes.nfv.VnfOperationAdditionalParameters
      # required: false
     # derived types are expected to introduce additional_parameters with its
     # type derived from tosca.datatypes.nfv.VnfOperationAdditionalParameters
981
982
983
984
985
986
987
988
989
990
991
992
    terminate_start:
      description: Invoked before terminate
    terminate_end:
      description: Invoked after terminate
    modify_information:
      description: Invoked upon receipt of a Modify VNF Information request
    modify_information_start:
      description: Invoked before modify_information
    modify_information_end:
      description: Invoked after modify_information
    change_flavour:
      description: Invoked upon receipt of a Change VNF Flavour request
admin_forge's avatar
admin_forge committed
993
994
995
996
997
998
    # inputs:
     # additional_parameters:
      # type: tosca.datatypes.nfv.VnfOperationAdditionalParameters
      # required: false
     # derived types are expected to introduce additional_parameters with its
     # type derived from tosca.datatypes.nfv.VnfOperationAdditionalParameters
999
1000
    change_flavour_start:
      description: Invoked before change_flavour
For faster browsing, not all history is shown. View entire blame