etsi_nfv_sol001_vnfd_types.yaml 90.3 KB
Newer Older
1
tosca_definitions_version: tosca_simple_yaml_1_3
2
description: ETSI NFV SOL 001 vnfd types definitions version 3.5.1
3 4 5
metadata:
  template_name: etsi_nfv_sol001_vnfd_types
  template_author: ETSI_NFV
6
  template_version: 3.5.1
7

8
imports:
9 10
   - https://forge.etsi.org/rep/nfv/SOL001/raw/v3.5.1/etsi_nfv_sol001_common_types.yaml
# editor's note: During the development of the SOL001ed351 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
data_types:
  tosca.datatypes.nfv.VirtualNetworkInterfaceRequirements:
ETSI CTI's avatar
ETSI CTI committed
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37
   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
38 39

  tosca.datatypes.nfv.RequestedAdditionalCapability:
ETSI CTI's avatar
ETSI CTI committed
40 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
   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
       
66 67

  tosca.datatypes.nfv.VirtualMemory:
ETSI CTI's avatar
ETSI CTI committed
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
     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.
88
         required: true
ETSI CTI's avatar
ETSI CTI committed
89
         default: false
90 91

  tosca.datatypes.nfv.VirtualCpu:
ETSI CTI's avatar
ETSI CTI committed
92 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
   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
123 124

  tosca.datatypes.nfv.VirtualCpuPinning:
ETSI CTI's avatar
ETSI CTI committed
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140
   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
       
141 142

  tosca.datatypes.nfv.VnfcConfigurableProperties:
ETSI CTI's avatar
ETSI CTI committed
143 144 145 146 147 148 149 150 151 152
   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
153 154

  tosca.datatypes.nfv.VnfcAdditionalConfigurableProperties:
ETSI CTI's avatar
ETSI CTI committed
155 156
   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.
157 158

  tosca.datatypes.nfv.VduProfile:
ETSI CTI's avatar
ETSI CTI committed
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173
   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
174 175

  tosca.datatypes.nfv.VlProfile:
ETSI CTI's avatar
ETSI CTI committed
176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196
   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
197 198

  tosca.datatypes.nfv.VirtualLinkProtocolData:
ETSI CTI's avatar
ETSI CTI committed
199 200 201 202
   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:
203
        type: string
ETSI CTI's avatar
ETSI CTI committed
204 205
        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
206
        constraints:
ETSI CTI's avatar
ETSI CTI committed
207 208 209 210
          - 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.
211
        required: false
ETSI CTI's avatar
ETSI CTI committed
212 213 214
     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.
215
        required: false
ETSI CTI's avatar
ETSI CTI committed
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233

  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.
234
       required: true
ETSI CTI's avatar
ETSI CTI committed
235 236 237 238 239 240 241 242 243 244 245 246
       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

247 248

  tosca.datatypes.nfv.L3ProtocolData:
ETSI CTI's avatar
ETSI CTI committed
249 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
   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 ] 
286 287

  tosca.datatypes.nfv.IpAllocationPool:
ETSI CTI's avatar
ETSI CTI committed
288 289 290 291 292 293 294 295 296 297 298
   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
299 300

  tosca.datatypes.nfv.InstantiationLevel:
ETSI CTI's avatar
ETSI CTI committed
301 302 303 304 305 306 307 308 309 310 311 312 313
   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
314 315

  tosca.datatypes.nfv.VduLevel:
ETSI CTI's avatar
ETSI CTI committed
316 317 318 319 320 321 322 323 324
   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
325 326

  tosca.datatypes.nfv.VnfLcmOperationsConfiguration:
ETSI CTI's avatar
ETSI CTI committed
327 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
   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
362 363 364 365 366 367 368 369 370 371 372 373 374 375 376
     change_current_package:
       type: tosca.datatypes.nfv.VnfChangeCurrentPackageOperationConfiguration
       description: Configuration parameters for the ChangeCurrentVnfPackage operation
       required: false
       # derived types are expected to introduce new properties, with their type derived from
       # tosca.datatypes.nfv.VnfChangeCurrentPackageOperationConfiguration,
       # with the same name as the operation designated to the ChangeCurrentVnfPackage request
     create_snapshot:
       type: tosca.datatypes.nfv.VnfCreateSnapshotOperationConfiguration
       description: Configuration parameters for the CreateVnfSnapshot operation 
       required: false
     revert_to_snapshot:
       type: tosca.datatypes.nfv.VnfRevertToSnapshotOperationConfiguration
       description: Configuration parameters for the RevertToVnfSnapshot operation 
       required: false
377 378

  tosca.datatypes.nfv.VnfInstantiateOperationConfiguration:
ETSI CTI's avatar
ETSI CTI committed
379 380 381 382
   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:
383 384

  tosca.datatypes.nfv.VnfScaleOperationConfiguration:
ETSI CTI's avatar
ETSI CTI committed
385 386 387 388 389 390
   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.
391
       required: true
ETSI CTI's avatar
ETSI CTI committed
392
       default: false 
393 394

  tosca.datatypes.nfv.VnfScaleToLevelOperationConfiguration:
ETSI CTI's avatar
ETSI CTI committed
395 396 397 398 399 400 401
   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
402 403

  tosca.datatypes.nfv.VnfHealOperationConfiguration:
ETSI CTI's avatar
ETSI CTI committed
404 405 406 407 408 409 410 411 412
   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
413 414

  tosca.datatypes.nfv.VnfTerminateOperationConfiguration:
ETSI CTI's avatar
ETSI CTI committed
415 416 417 418 419 420 421 422 423 424 425
   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
426 427

  tosca.datatypes.nfv.VnfOperateOperationConfiguration:
ETSI CTI's avatar
ETSI CTI committed
428 429 430 431 432 433 434 435 436 437 438
   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
439 440

  tosca.datatypes.nfv.ScaleInfo:
ETSI CTI's avatar
ETSI CTI committed
441 442 443 444 445 446 447 448 449
   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
450 451

  tosca.datatypes.nfv.ScalingAspect:
ETSI CTI's avatar
ETSI CTI committed
452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474
   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
475 476

  tosca.datatypes.nfv.VnfConfigurableProperties:
ETSI CTI's avatar
ETSI CTI committed
477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507
   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
508 509

  tosca.datatypes.nfv.VnfAdditionalConfigurableProperties:
ETSI CTI's avatar
ETSI CTI committed
510 511 512 513 514 515
   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.
516 517
       required: true
       default : true
ETSI CTI's avatar
ETSI CTI committed
518
   
519
  tosca.datatypes.nfv.VnfInfoModifiableAttributes:
ETSI CTI's avatar
ETSI CTI committed
520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536
   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
537 538

  tosca.datatypes.nfv.VnfInfoModifiableAttributesExtensions:
ETSI CTI's avatar
ETSI CTI committed
539 540
   derived_from: tosca.datatypes.Root 
   description: is an empty base type for deriving data types for describing VNF-specific extension
541 542

  tosca.datatypes.nfv.VnfInfoModifiableAttributesMetadata:
ETSI CTI's avatar
ETSI CTI committed
543 544
   derived_from: tosca.datatypes.Root
   description: is an empty base type for deriving data types for describing VNF-specific metadata
545 546

  tosca.datatypes.nfv.LogicalNodeData:
ETSI CTI's avatar
ETSI CTI committed
547 548 549 550 551 552 553 554 555
   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 
556 557

  tosca.datatypes.nfv.SwImageData:
ETSI CTI's avatar
ETSI CTI committed
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 601 602 603 604 605 606 607 608 609 610 611 612 613 614
   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
615 616

  tosca.datatypes.nfv.VirtualBlockStorageData:
ETSI CTI's avatar
ETSI CTI committed
617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634
   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 
635
       required: true
ETSI CTI's avatar
ETSI CTI committed
636
       default: false
637 638

  tosca.datatypes.nfv.VirtualObjectStorageData:
ETSI CTI's avatar
ETSI CTI committed
639 640 641 642 643 644 645 646 647
     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
648 649

  tosca.datatypes.nfv.VirtualFileStorageData:
ETSI CTI's avatar
ETSI CTI committed
650 651 652 653 654 655 656 657 658 659 660 661 662
       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
663 664 665 666 667 668

  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:
ETSI CTI's avatar
ETSI CTI committed
669 670 671
       type: tosca.datatypes.nfv.LinkBitrateRequirements
       description: Virtual link bitrate requirements for an instantiation level or bitrate delta for a scaling step 
       required: true
672 673 674 675

  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 
ETSI CTI's avatar
ETSI CTI committed
676
    # properties:
677 678 679 680

  tosca.datatypes.nfv.VnfChangeFlavourOperationConfiguration:
    derived_from: tosca.datatypes.Root
    description: represents information that affect the invocation of the ChangeVnfFlavour operation 
ETSI CTI's avatar
ETSI CTI committed
681 682
    # This data type definition is reserved for future use in the present document.
    # properties:
683 684 685 686

  tosca.datatypes.nfv.VnfChangeExtConnectivityOperationConfiguration:
    derived_from: tosca.datatypes.Root
    description: represents information that affect the invocation of the ChangeExtVnfConnectivity operation 
ETSI CTI's avatar
ETSI CTI committed
687 688 689 690
    # This data type definition is reserved for future use in the present document.
    # properties:
    
  tosca.datatypes.nfv.VnfcMonitoringParameter:
691 692 693 694
    derived_from: tosca.datatypes.Root
    description: Represents information on virtualised resource related performance metrics applicable to the VNF.
    properties:
      name:
ETSI CTI's avatar
ETSI CTI committed
695 696 697
       type: string
       description: Human readable name of the monitoring parameter
       required: true
698
      performance_metric:
ETSI CTI's avatar
ETSI CTI committed
699 700 701 702 703
       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 ] 
704
      collection_period:
ETSI CTI's avatar
ETSI CTI committed
705 706 707 708 709
       type: scalar-unit.time
       description: Describes the  periodicity at which to collect the performance information. 
       required: false
       constraints: 
        - greater_than: 0 s
710

ETSI CTI's avatar
ETSI CTI committed
711
  tosca.datatypes.nfv.VirtualLinkMonitoringParameter:
712 713 714 715
    derived_from: tosca.datatypes.Root
    description: Represents information on virtualised resource related performance metrics applicable to the VNF.
    properties:
      name:
ETSI CTI's avatar
ETSI CTI committed
716 717 718
       type: string
       description: Human readable name of the monitoring parameter
       required: true
719
      performance_metric:
ETSI CTI's avatar
ETSI CTI committed
720 721 722 723 724
       type: string
       description: Identifies a performance metric to be monitored.
       required: true
       constraints:
         - valid_values: [ byte_incoming, byte_outgoing, packet_incoming, packet_outgoing ] 
725
      collection_period:
ETSI CTI's avatar
ETSI CTI committed
726 727 728 729 730
       type: scalar-unit.time
       description: Describes the periodicity at which to collect the performance information. 
       required: false
       constraints: 
        - greater_than: 0 s
731

ETSI CTI's avatar
ETSI CTI committed
732
  tosca.datatypes.nfv.InterfaceDetails:
733
    derived_from: tosca.datatypes.Root
ETSI CTI's avatar
ETSI CTI committed
734
    description: information used to access an interface exposed by a VNF
735
    properties:
ETSI CTI's avatar
ETSI CTI committed
736 737 738 739 740 741 742 743 744
      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:
745 746
        type: string

ETSI CTI's avatar
ETSI CTI committed
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 791 792 793 794 795 796 797 798 799 800 801 802 803 804
  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:
805
    derived_from: tosca.datatypes.Root
ETSI CTI's avatar
ETSI CTI committed
806
    description: describes information enabling the VNF instance to access the NFV-MANO interfaces produced by the VNFM
807
    properties:
ETSI CTI's avatar
ETSI CTI committed
808 809 810 811 812 813 814 815 816 817 818
      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: 
819
        type: map
ETSI CTI's avatar
ETSI CTI committed
820
        description: Provides credential enabling access to the interface
821 822 823 824
        required: false
        entry_schema:
          type: string

ETSI CTI's avatar
ETSI CTI committed
825
  tosca.datatypes.nfv.OauthServerInfo:
826
    derived_from: tosca.datatypes.Root
ETSI CTI's avatar
ETSI CTI committed
827 828 829 830 831 832 833
    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.
834
    properties:
ETSI CTI's avatar
ETSI CTI committed
835 836 837
      vim_specific_properties:
        type: tosca.datatypes.nfv.BootDataVimSpecificProperties
        description: Properties used for selecting VIM specific capabilities when setting the boot data.
838
        required: false
ETSI CTI's avatar
ETSI CTI committed
839 840 841
      kvp_data:
        type: tosca.datatypes.nfv.KvpData
        description: A set of key-value pairs for configuring a virtual compute resource.
842
        required: false
ETSI CTI's avatar
ETSI CTI committed
843 844 845
      content_or_file_data:
        type: tosca.datatypes.nfv.ContentOrFileData
        description: A string content or a file for configuring a virtual compute resource. 
846
        required: false
ETSI CTI's avatar
ETSI CTI committed
847 848 849 850 851 852 853 854

  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.
855
        required: false
ETSI CTI's avatar
ETSI CTI committed
856 857
        entry_schema:
          type: string
858

ETSI CTI's avatar
ETSI CTI committed
859
  tosca.datatypes.nfv.ContentOrFileData:
860
    derived_from: tosca.datatypes.Root
ETSI CTI's avatar
ETSI CTI committed
861
    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.
862
    properties:
ETSI CTI's avatar
ETSI CTI committed
863 864 865 866 867 868 869 870 871
      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.
872
        required: false
ETSI CTI's avatar
ETSI CTI committed
873 874 875
      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].
876
        required: false
ETSI CTI's avatar
ETSI CTI committed
877 878 879
      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].
880 881
        required: false

ETSI CTI's avatar
ETSI CTI committed
882
  tosca.datatypes.nfv.BootDataVimSpecificProperties:
883
    derived_from: tosca.datatypes.Root
ETSI CTI's avatar
ETSI CTI committed
884
    description: describes the VIM specific information used for selecting VIM specific capabilities when setting the boot data.
885
    properties:
ETSI CTI's avatar
ETSI CTI committed
886 887 888
      vim_type:
        type: string 
        description: Discriminator for the different types of the VIM information.
889
        required: true
ETSI CTI's avatar
ETSI CTI committed
890 891 892 893 894
      properties:
        type: map
        description: Properties used for selecting VIM specific capabilities when setting the boot data
        entry_schema:
          type: string
895 896
        required: true

897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955
  tosca.datatypes.nfv.VnfPackageChangeSelector:
    derived_from: tosca.datatypes.Root
    description: data type describes the source and destination VNFDs as well as source deployment flavour for a change current VNF Package.
    properties:
      source_descriptor_id:
        type: string
        description: Identifier of the source VNFD and the source VNF package.
        required: true
      destination_descriptor_id:
        type: string
        description: Identifier of the destination VNFD and the destination VNF package.
        required: true
      source_flavour_id:
        type: string
        description: Identifier of the deployment flavour in the source VNF package for which this data type applies.
        required: true

  tosca.datatypes.nfv.VnfPackageChangeComponentMapping:
    derived_from: tosca.datatypes.Root
    description: A mapping between the identifier of a components or property in the source VNFD and the identifier of the corresponding component or property in the destination VNFD.
    properties:
      component_type:
        type: string
        description: The type of component or property. Possible values differentiate whether changes concern to some VNF component (e.g. VDU, internal VLD, etc.) or property (e.g. a Scaling Aspect, etc.).
        constraints:
          - valid_values: [ vdu, cp, virtual_link, virtual_storage, deployment_flavour, instantiation_level, scaling_aspect ]
        required: true
      source_id:
        type: string
        description: Identifier of the component or property in the source VNFD.
        required: true
      destination_id:
        type: string
        description: Identifier of the component or property in the destination VNFD.
        required: true
      description:
        type: string
        description: Human readable description of the component changes.
        required: false

  tosca.datatypes.nfv.VnfChangeCurrentPackageOperationConfiguration:
    derived_from: tosca.datatypes.Root
    description: represents information that affect the invocation of the change current VNF Package operation.
    # This data type definition is reserved for future use in the present document.
    # properties:
      # derived types are expected to introduce new properties, with their type derived from tosca.datatypes.nfv.VnfChangeCurrentPackageOperationConfiguration, with the same name as the operation designated to the ChangeCurrentVnfPackage request

  tosca.datatypes.nfv.VnfCreateSnapshotOperationConfiguration:
    derived_from: tosca.datatypes.Root
    description: represents information that affect the invocation of the CreateVnfSnapshot operation 
  # This data type definition is reserved for future use in the present document.
  # properties:

  tosca.datatypes.nfv.VnfRevertToSnapshotOperationConfiguration:
    derived_from: tosca.datatypes.Root
    description: represents information that affect the invocation of the RevertToVnfSnapshot operation 
  # This data type definition is reserved for future use in the present document.
  # properties:

956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988
  tosca.datatypes.nfv.VnfLcmOpCoord:
    derived_from: tosca.datatypes.Root
    description: describes a set of information used for a coordination action in a VNF lifecycle management operation for a given VNF.
    properties:
      description:
        type: string
        description: Human readable description of the coordination action. 
        required: false
      endpoint_type:
        type: string
        description: Specifies the type of the endpoint exposing the LCM operation coordination such as other operations supporting or management systems (e.g. an EM) or the VNF instance. If the VNF produces the LCM coordination interface, this property may be omitted or may have the value "vnf". If this attribute is omitted, the type of endpoint that provides the interface is determined at deployment time. If the VNF does not produce the LCM coordination interface but coordination via this interface is needed, it is expected that a management entity such as the EM exposes the coordination interface, and consequently, this attribute shall be present and shall have the value “mgmt”.
        required: false
        constraints:
          - valid_values: [ mgmt, vnf ]
      coordination_stage:
        type: string
        description: Indicates whether the coordination action is invoked before or after all other changes performed by the VNF LCM operation. coordination_stage property shall be omitted if the coordination action is intended to be invoked at an intermediate stage of the LCM operation, i.e. neither at the start nor at the end. In this case, the time at which to invoke  the coordination during the execution of  the LCM operation is determined by means outside the scope of the present document such as VNFM-internal logic or LCM script.
        required: false
        constraints:
          - valid_values: [ start, end  ]
      # input_parameters:
        # type: tosca.datatypes.nfv.InputOpCoordParams
        # description: Input parameters to be provided in the LCM coordination request.
        # required: false
      # output_parameters:
        # type: tosca.datatypes.nfv.OutputOpCoordParams
        # description: Output parameters provided in the LCM coordination response.
        # required: false

  tosca.datatypes.nfv.OutputOpCoordParams:
    derived_from: tosca.datatypes.Root 
    description: is an empty base type for deriving data types for describing additional Output operation coordination parameters for a given coordination action
        
989
artifact_types:  
990 991
  tosca.artifacts.nfv.SwImage:
    derived_from: tosca.artifacts.Deployment.Image
ETSI CTI's avatar
ETSI CTI committed
992
    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
993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047
    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
1048 1049 1050 1051 1052 1053 1054

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

ETSI CTI's avatar
ETSI CTI committed
1055

1056
capability_types:  
1057 1058 1059 1060
  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

1061
  tosca.capabilities.nfv.VirtualCompute:    
1062 1063 1064 1065
    derived_from: tosca.capabilities.Node
    description: Describes the capabilities related to virtual compute resources 
    properties:
      logical_node:
ETSI CTI's avatar
ETSI CTI committed
1066 1067 1068 1069 1070
       type: map
       description: Describes the Logical Node requirements 
       required: false
       entry_schema:
         type: tosca.datatypes.nfv.LogicalNodeData
1071
      requested_additional_capabilities:
ETSI CTI's avatar
ETSI CTI committed
1072 1073 1074 1075 1076
       type: map
       description: Describes additional capability for a particular VDU 
       required: false
       entry_schema:
         type: tosca.datatypes.nfv.RequestedAdditionalCapability
1077
      compute_requirements:
ETSI CTI's avatar
ETSI CTI committed
1078 1079 1080 1081
       type: map
       required: false 
       entry_schema:
         type: string
1082
      virtual_memory:
ETSI CTI's avatar
ETSI CTI committed
1083 1084 1085
       type: tosca.datatypes.nfv.VirtualMemory
       description: Describes virtual memory of the virtualized compute 
       required: true
1086
      virtual_cpu:
ETSI CTI's avatar
ETSI CTI committed
1087 1088 1089
       type: tosca.datatypes.nfv.VirtualCpu
       description: Describes virtual CPU(s) of the virtualized compute 
       required: true
1090
      virtual_local_storage:
ETSI CTI's avatar
ETSI CTI committed
1091 1092 1093 1094 1095 1096
       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 
1097 1098 1099 1100

  tosca.capabilities.nfv.VirtualStorage:
    derived_from: tosca.capabilities.Root
    description: Describes the attachment capabilities related to Vdu.Storage
ETSI CTI's avatar
ETSI CTI committed
1101

1102 1103 1104 1105
  tosca.capabilities.nfv.TrunkBindable:
    derived_from: tosca.capabilities.Node
    description: Indicates that the node that includes it can be pointed by a tosca.relationships.nfv.TrunkBindsTo relationship type which is used to model the trunkPortTopology. 
 
1106 1107 1108 1109
relationship_types:
  tosca.relationships.nfv.VirtualBindsTo:
    derived_from: tosca.relationships.DependsOn
    description: Represents an association relationship between Vdu.Compute and VduCp node types 
ETSI CTI's avatar
ETSI CTI committed
1110
    valid_target_types: [ tosca.capabilities.nfv.VirtualBindable ]
1111 1112 1113 1114 1115

  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 ]
ETSI CTI's avatar
ETSI CTI committed
1116

1117 1118 1119 1120
  tosca.relationships.nfv.TrunkBindsTo:
    derived_from: tosca.relationships.DependsOn
    description: Represents the association relationship between a VduCp node used as a trunk port and other VduSubCp nodes used as subports of the same trunk.
    valid_target_types: [ tosca.capabilities.nfv.TrunkBindable ]   
ETSI CTI's avatar
ETSI CTI committed
1121

1122 1123 1124 1125
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.
1126 1127 1128 1129 1130 1131 1132
    operations:
      instantiate:
        description: Invoked upon receipt of an Instantiate VNF request
      # inputs:
        # additional_parameters:
        # type: tosca.datatypes.nfv.VnfOperationAdditionalParameters
        # required: false
ETSI CTI's avatar
ETSI CTI committed
1133 1134
     # derived types are expected to introduce additional_parameters with its
     # type derived from tosca.datatypes.nfv.VnfOperationAdditionalParameters
1135 1136 1137 1138 1139 1140 1141 1142 1143 1144
      instantiate_start:
        description: Invoked before instantiate
      instantiate_end:
        description: Invoked after instantiate
      terminate:
        description: Invoked upon receipt Terminate VNF request
      # inputs:
        # additional_parameters:
        # type: tosca.datatypes.nfv.VnfOperationAdditionalParameters
        # required: false
ETSI CTI's avatar
ETSI CTI committed
1145 1146
     # derived types are expected to introduce additional_parameters with its
     # type derived from tosca.datatypes.nfv.VnfOperationAdditionalParameters
1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162
      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
      # inputs:
        # additional_parameters:
        # type: tosca.datatypes.nfv.VnfOperationAdditionalParameters
        # required: false
ETSI CTI's avatar
ETSI CTI committed
1163 1164
     # derived types are expected to introduce additional_parameters with its
     # type derived from tosca.datatypes.nfv.VnfOperationAdditionalParameters
1165 1166 1167 1168 1169 1170 1171 1172 1173 1174
      change_flavour_start:
        description: Invoked before change_flavour
      change_flavour_end:
        description: Invoked after change_flavour
      change_external_connectivity:
        description: Invoked upon receipt of a Change External VNF Connectivity  request
      # inputs:
        # additional_parameters:
        # type: tosca.datatypes.nfv.VnfOperationAdditionalParameters
        # required: false
ETSI CTI's avatar
ETSI CTI committed
1175 1176
     # derived types are expected to introduce additional_parameters with its
     # type derived from tosca.datatypes.nfv.VnfOperationAdditionalParameters
1177 1178 1179 1180 1181 1182 1183 1184 1185 1186
      change_external_connectivity_start:
        description: Invoked before change_external_connectivity
      change_external_connectivity_end:
        description: Invoked after change_external_connectivity
      operate:
        description: Invoked upon receipt of an Operate VNF request
      # inputs:
        # additional_parameters:
        # type: tosca.datatypes.nfv.VnfOperationAdditionalParameters
        # required: false
ETSI CTI's avatar
ETSI CTI committed
1187 1188
     # derived types are expected to introduce additional_parameters with its
     # type derived from tosca.datatypes.nfv.VnfOperationAdditionalParameters
1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221
      operate_start:
        description: Invoked before operate
      operate_end:
        description: Invoked after operate
      heal:
        description: Invoked upon receipt of a Heal VNF request
      # 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
        inputs:
          cause:
            type: string
            description: Indicates the reason why a healing procedure is required.
            required: false
          vnfc_instance_ids:
            type: list
            entry_schema:
              type: string
            description: List of VNFC instances requiring a healing action.
            required: false
      heal_start:
        description: Invoked before heal
      heal_end:
        description: Invoked after heal
      scale:
        description: Invoked upon receipt of a Scale VNF request
      # inputs:
        # additional_parameters:
        # type: tosca.datatypes.nfv.VnfOperationAdditionalParameters
        # required: false
ETSI CTI's avatar
ETSI CTI committed
1222 1223
     # derived types are expected to introduce additional_parameters with its
     # type derived from tosca.datatypes.nfv.VnfOperationAdditionalParameters
1224 1225 1226 1227
        inputs:
          type:
            type: string
            description: Indicates the type of the scale operation requested.
1228
            required: false
1229 1230 1231 1232 1233
            constraints:
              - valid_values: [ scale_out, scale_in ]
          aspect:
            type: string
            description: Identifier of the scaling aspect.
1234
            required: false
1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251
          number_of_steps:
            type: integer
            description: Number of scaling steps to be executed.
            required: true
            constraints:
              - greater_than: 0
            default: 1
      scale_start:
        description: Invoked before scale
      scale_end:
        description: Invoked after scale 
      scale_to_level:
        description: Invoked upon receipt of a Scale VNF to Level request
      # inputs:
        # additional_parameters:
        # type: tosca.datatypes.nfv.VnfOperationAdditionalParameters
        # required: false
ETSI CTI's avatar
ETSI CTI committed
1252 1253
     # derived types are expected to introduce additional_parameters with its
     # type derived from tosca.datatypes.nfv.VnfOperationAdditionalParameters
1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311
        inputs:
          instantiation_level:
            type: string
            description: Identifier of the target instantiation level of the current deployment flavour to which the VNF is requested to be scaled. Either instantiation_level or scale_info shall be provided.
            required: false
          scale_info:
            type: map # key: aspectId
            description: For each scaling aspect of the current deployment flavour, indicates the target scale level to which the VNF is to be scaled. Either instantiation_level or scale_info shall be provided.
            required: false
            entry_schema:
              type: tosca.datatypes.nfv.ScaleInfo
      scale_to_level_start:
        description: Invoked before scale_to_level
      scale_to_level_end:
        description: Invoked after scale_to_level
      create_snapshot:
        description: Invoked upon receipt of a Create VNF snapshot request
        # 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
      create_snapshot_start:
        description: Invoked before create_snapshot
      create_snapshot_end:
        description: Invoked after create_snapshot
      revert_to_snapshot:
        description: Invoked upon receipt of a Revert to VNF snapshot request
        # 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
      revert_to_snapshot_start:
        description: Invoked before revert_to_snapshot
      revert_to_snapshot_end:
        description: Invoked after revert_to_snapshot
      change_current_package:
        description: Invoked by tosca.policies.nfv.VnfPackageChange
        # 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
      change_current_package_start:
        description: Invoked by tosca.policies.nfv.VnfPackageChange 
      change_current_package_end:
        description: Invoked by tosca.policies.nfv.VnfPackageChange
    notifications:
      change_current_package_notification:
        description: Invoked upon receipt of a ChangeCurrentVnfPackage request
      change_current_package_start_notification:
        description: Invoked before the operation designated to changing the current VNF package
      change_current_package_end_notification:
        description: Invoked after the operation designated to changing the current VNF package
ETSI CTI's avatar
ETSI CTI committed
1312 1313

  tosca.interfaces.nfv.VnfIndicator:
1314 1315 1316 1317 1318 1319
    derived_from: tosca.interfaces.Root
    description: This interface is an empty base interface type for deriving VNF specific interface types that include VNF indicator specific notifications.

  tosca.interfaces.nfv.ChangeCurrentVnfPackage:
    derived_from: tosca.interfaces.Root
    description: This interface is an empty base interface type for deriving VNF specific interface types that include VNF Change Current VNF Package specific operation.
1320
  # operations:
1321 1322 1323 1324 1325 1326 1327 1328
      # operation_name: name of a VNF-specific operation serving the Change current VNF Package request.
        # description: Invoked by tosca.policies.nfv.VnfPackageChange
        # 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
ETSI CTI's avatar
ETSI CTI committed
1329

1330 1331 1332
node_types:
  tosca.nodes.nfv.VNF:
    derived_from: tosca.nodes.Root
1333
    description: The generic abstract type from which all VNF specific node types shall be derived to form, together with other node types, the TOSCA service template(s) representing the VNFD
1334 1335
    properties:
      descriptor_id: # instead of vnfd_id
ETSI CTI's avatar
ETSI CTI committed
1336 1337 1338
       type: string # UUID
       description: Identifier of this VNFD information element. This attribute shall be globally unique
       required: true
1339
      descriptor_version: # instead of vnfd_version
ETSI CTI's avatar
ETSI CTI committed
1340 1341 1342
       type: string
       description: Identifies the version of the VNFD
       required: true
1343
      provider: # instead of vnf_provider
ETSI CTI's avatar
ETSI CTI committed
1344 1345 1346
       type: string
       description: Provider of the VNF and of the VNFD
       required: true
1347
      product_name: # instead of vnf_product_name
ETSI CTI's avatar
ETSI CTI committed
1348 1349 1350
       type: string
       description: Human readable name for the VNF Product
       required: true
1351
      software_version: # instead of vnf_software_version
ETSI CTI's avatar
ETSI CTI committed
1352 1353 1354
       type: string
       description: Software version of the VNF
       required: true
1355
      product_info_name: # instead of vnf_product_info_name
ETSI CTI's avatar
ETSI CTI committed
1356 1357 1358
       type: string
       description: Human readable name for the VNF Product
       required: false
1359
      product_info_description: # instead of vnf_product_info_description
ETSI CTI's avatar
ETSI CTI committed
1360 1361 1362
       type: string
       description: Human readable description of the VNF Product
       required: false
1363
      vnfm_info:
ETSI CTI's avatar
ETSI CTI committed
1364 1365 1366 1367 1368 1369 1370
       type: list
       required: true
       description: Identifies VNFM(s) compatible with the VNF
       entry_schema:
        type: string
        constraints:
          - pattern: (^etsivnfm:v[0-9]?[0-9]\.[0-9]?[0-9]\.[0-9]?[0-9]$)|(^[0-9]+:[a-zA-Z0-9.-]+$)
1371
      localization_languages:
ETSI CTI's avatar
ETSI CTI committed
1372 1373 1374 1375
       type: list
       description: Information about localization languages of the VNF
       required: false
       entry_schema:
1376
        type: string #IETF RFC 5646 string
ETSI CTI's avatar
ETSI CTI committed
1377 1378 1379 1380
      default_localization_language:
       type: string #IETF RFC 5646 string
       description: Default localization language that is instantiated if no information about selected localization language is available
       required: false
1381
      #configurable_properties:
ETSI CTI's avatar
ETSI CTI committed
1382 1383 1384 1385 1386
       #type: tosca.datatypes.nfv.VnfConfigurableProperties
       #description: Describes the configurable properties of the VNF
       #required: false
       # derived types are expected to introduce configurable_properties 
       # with its type derived from tosca.datatypes.nfv.VnfConfigurableProperties
1387
      #modifiable_attributes:
ETSI CTI's avatar
ETSI CTI committed
1388 1389 1390 1391 1392 1393
       #type: tosca.datatypes.nfv.VnfInfoModifiableAttributes
       #description: Describes the modifiable attributes of the VNF
       #required: false 
       # derived types are expected to introduce modifiable_attributes
       # with its type derived from
       # tosca.datatypes.nfv.VnfInfoModifiableAttributes
1394
      lcm_operations_configuration:
ETSI CTI's avatar
ETSI CTI committed
1395 1396 1397
       type: tosca.datatypes.nfv.VnfLcmOperationsConfiguration
       description: Describes the configuration parameters for the VNF LCM operations
       required: false
1398
      monitoring_parameters:
1399
       type: map # key: id
ETSI CTI's avatar
ETSI CTI committed
1400 1401 1402 1403
       entry_schema:
        type: tosca.datatypes.nfv.VnfMonitoringParameter
       description: Describes monitoring parameters applicable to the VNF.
       required: false
1404
      flavour_id:
ETSI CTI's avatar
ETSI CTI committed
1405 1406 1407
       type: string
       description: Identifier of the Deployment Flavour within the VNFD
       required: true
1408
      flavour_description:
ETSI CTI's avatar
ETSI CTI committed
1409 1410 1411
       type: string
       description: Human readable description of the DF
       required: true
1412
      vnf_profile:
ETSI CTI's avatar
ETSI CTI committed
1413 1414 1415
       type: tosca.datatypes.nfv.VnfProfile
       description: Describes a profile for instantiating VNFs of a particular NS DF according to a specific VNFD and VNF DF
       required: false
1416 1417 1418 1419 1420 1421
    attributes:
      scale_status:
        type: map # key: aspectId
        description: Scale status of the VNF, one entry per aspect. Represents for every scaling aspect how "big" the VNF has been scaled w.r.t. that aspect.
        entry_schema:
          type: tosca.datatypes.nfv.ScaleInfo
1422 1423 1424 1425 1426
    requirements:
      - virtual_link:
          capability: tosca.capabilities.nfv.VirtualLinkable
          relationship: tosca.relationships.nfv.VirtualLinksTo
          occurrences: [ 0, 1 ]
ETSI CTI's avatar
ETSI CTI committed
1427
    # Additional requirements shall be defined in the VNF specific node type (deriving from tosca.nodes.nfv.VNF) corresponding to NS virtual links that need to connect to VnfExtCps
1428 1429 1430
    interfaces:
      Vnflcm:
        type: tosca.interfaces.nfv.Vnflcm
ETSI CTI's avatar
ETSI CTI committed
1431 1432 1433 1434
    # VnfIndicator:
    #   type: tosca.interfaces.nfv.VnfIndicator
    # derived types are expected to introduce Vnf Indicator interfaces 
    # with their type derived from tosca.interfaces.nfv.VnfIndicator
1435 1436 1437 1438 1439 1440

  tosca.nodes.nfv.VnfExtCp:
    derived_from: tosca.nodes.nfv.Cp
    description: Describes a logical external connection point, exposed by the VNF enabling connection with an external Virtual Link 
    properties:
      virtual_network_interface_requirements:
ETSI CTI's avatar
ETSI CTI committed
1441 1442 1443 1444 1445
       type: list
       description: The actual virtual NIC requirements that is been assigned when instantiating the connection point 
       required: false
       entry_schema:
        type: tosca.datatypes.nfv.VirtualNetworkInterfaceRequirements
1446 1447 1448 1449
    requirements:
      - external_virtual_link:
          capability: tosca.capabilities.nfv.VirtualLinkable
          relationship: tosca.relationships.nfv.VirtualLinksTo
ETSI CTI's avatar
ETSI CTI committed
1450 1451
          occurrences: [0, 1]
      - internal_virtual_link: 
1452 1453
          capability: tosca.capabilities.nfv.VirtualLinkable
          relationship: tosca.relationships.nfv.VirtualLinksTo
ETSI CTI's avatar
ETSI CTI committed
1454
          occurrences: [1, 1]
1455 1456 1457

  tosca.nodes.nfv.Vdu.Compute:
    derived_from: tosca.nodes.Root
ETSI CTI's avatar
ETSI CTI committed
1458
    description: Describes the virtual compute part of a VDU which is a construct  supporting the description of the deployment and operational behavior of a VNFC 
1459 1460
    properties:
      name:
1461 1462 1463
        type: string
        description: Human readable name of the VDU 
        required: true
1464
      description:
1465 1466 1467
        type: string
        description: Human readable description of the VDU 
        required: true
1468
      boot_order:
1469 1470 1471 1472
        type: boolean
        description: indicates whether the order of the virtual_storage requirements is used as the boot index (the first requirement represents the lowest index and defines highest boot priority) 
        required: true
        default: false
1473
      nfvi_constraints:
1474 1475 1476 1477 1478
        type: map
        description: Describes constraints on the NFVI for the VNFC instance(s) created from this VDU. This property is reserved for future use in the present document.
        required: false
        entry_schema:
          type: string
1479
      monitoring_parameters:
1480
        type: map # key: id
1481 1482 1483 1484
        description: Describes monitoring parameters applicable to a VNFC instantiated from this VDU
        required: false
        entry_schema: 
          type: tosca.datatypes.nfv.VnfcMonitoringParameter
1485
      #configurable_properties:
ETSI CTI's avatar
ETSI CTI committed
1486 1487 1488 1489 1490
        #type: tosca.datatypes.nfv.VnfcConfigurableProperties
        #required: false 
        # derived types are expected to introduce
        # configurable_properties with its type derived from
        # tosca.datatypes.nfv.VnfcConfigurableProperties
1491
      vdu_profile:
1492 1493 1494
        type: tosca.datatypes.nfv.VduProfile
        description: Defines additional instantiation data for the VDU.Compute node 
        required: true
1495
      sw_image_data:
1496 1497 1498 1499
        type: tosca.datatypes.nfv.SwImageData
        description: Defines information related to a SwImage artifact used by this Vdu.Compute node 
        required: false # property is required when the node template has an associated artifact of type tosca.artifacts.nfv.SwImage and not required otherwise
        status: deprecated
1500
      boot_data:
1501 1502 1503
        type: tosca.datatypes.nfv.BootData
        description: Contains the information used to customize a virtualised compute resource at boot time. The bootData may contain variable parts that are replaced by deployment specific values before being sent to the VIM.
        required: false  
1504 1505
    capabilities:
      virtual_compute:
1506 1507
        type: tosca.capabilities.nfv.VirtualCompute
        occurrences: [ 1, 1 ]
1508
      virtual_binding:
1509 1510
        type: tosca.capabilities.nfv.VirtualBindable
        occurrences: [ 1, UNBOUNDED ]
1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521
    requirements:
      - virtual_storage:
          capability: tosca.capabilities.nfv.VirtualStorage
          relationship: tosca.relationships.nfv.AttachesTo
          occurrences: [ 0, UNBOUNDED ]

  tosca.nodes.nfv.Vdu.VirtualBlockStorage:
    derived_from: tosca.nodes.Root
    description: This node type describes the specifications of requirements related to virtual block storage resources
    properties:
      virtual_block_storage_data:
1522 1523 1524
        type: tosca.datatypes.nfv.VirtualBlockStorageData
        description: Describes the block storage characteristics. 
        required: true
1525
      sw_image_data:
1526 1527 1528 1529
        type: tosca.datatypes.nfv.SwImageData
        description: Defines information related to a SwImage artifact used by this Vdu.Compute node. 
        required: false # property is required when the node template has an associated artifact of type tosca.artifacts.nfv.SwImage and not required otherwise
        status: deprecated
1530 1531
    capabilities:
      virtual_storage:
1532 1533
        type: tosca.capabilities.nfv.VirtualStorage
        description: Defines the capabilities of virtual_storage.
1534 1535 1536 1537 1538 1539 1540

  tosca.nodes.nfv.Vdu.VirtualObjectStorage: 
    derived_from: tosca.nodes.Root
    description: This node type describes the specifications of requirements related to virtual object storage resources
    properties:
      virtual_object_storage_data:
        type: tosca.datatypes.nfv.VirtualObjectStorageData
ETSI CTI's avatar
ETSI CTI committed
1541
        description: Describes the object storage characteristics.
1542 1543 1544 1545 1546 1547 1548
        required: true
    capabilities:
      virtual_storage:
        type: tosca.capabilities.nfv.VirtualStorage
        description: Defines the capabilities of virtual_storage.

  tosca.nodes.nfv.Vdu.VirtualFileStorage: 
1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560
    derived_from: tosca.nodes.Root
    description: This node type describes the specifications of requirements related to virtual file storage resources
    properties:
      virtual_file_storage_data:
        type: tosca.datatypes.nfv.VirtualFileStorageData
        description: Describes the file  storage characteristics.
        required: true
    capabilities:
      virtual_storage:
        type: tosca.capabilities.nfv.VirtualStorage
        #description: Defines the capabilities of virtual_storage.
    requirements:
1561 1562 1563
      - virtual_link:
          capability: tosca.capabilities.nfv.VirtualLinkable
          relationship: tosca.relationships.nfv.VirtualLinksTo
ETSI CTI's avatar
ETSI CTI committed
1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594
          occurrences: [1, 1]
          # description: Describes the requirements for linking to virtual link

  tosca.nodes.nfv.VduCp:
     derived_from: tosca.nodes.nfv.Cp
     description: describes network connectivity between a VNFC instance based on this VDU and an internal VL 
     properties:
       bitrate_requirement:
         type: integer   # in bits per second
         description: Bitrate requirement in bit per second on this connection point 
         required: false
         constraints: 
           - greater_or_equal: 0
       virtual_network_interface_requirements:
         type: list
         description: Specifies requirements on a virtual network interface realising  the CPs instantiated from this CPD 
         required: false
         entry_schema:
           type: tosca.datatypes.nfv.VirtualNetworkInterfaceRequirements
       order:
         type: integer
         description: The order of the NIC on the compute instance (e.g.eth2)
         required: false
         constraints:
           - greater_or_equal: 0
       vnic_type: 
         type: string
         description: Describes the type of the virtual network interface realizing the CPs instantiated from this CPD
         required: false
         constraints:
         - valid_values: [ normal, macvtap, direct, baremetal, virtio-forwarder, direct-physical, smart-nic ]
1595 1596 1597 1598
     capabilities: 
       trunk_binding: # This capability is available only the trunk_mode property value of this VduCp is “true” and there is at least one VduSubCp defined as subport of the same trunk.
         type: tosca.capabilities.nfv.TrunkBindable
         occurrences: [ 0, UNBOUNDED ]
ETSI CTI's avatar
ETSI CTI committed
1599 1600 1601 1602
     requirements:
       - virtual_link:
           capability: tosca.capabilities.nfv.VirtualLinkable
           relationship: tosca.relationships.nfv.VirtualLinksTo
1603
           occurrences: [1, 1]
ETSI CTI's avatar
ETSI CTI committed
1604 1605 1606 1607
       - virtual_binding:
           capability: tosca.capabilities.nfv.VirtualBindable
           relationship: tosca.relationships.nfv.VirtualBindsTo
           node: tosca.nodes.nfv.Vdu.Compute
1608
           occurrences: [0, 1]
1609 1610 1611 1612 1613 1614

  tosca.nodes.nfv.VnfVirtualLink:
    derived_from: tosca.nodes.Root
    description: Describes the information about an internal VNF VL 
    properties:
      connectivity_type:
ETSI CTI's avatar
ETSI CTI committed
1615 1616 1617
       type: tosca.datatypes.nfv.ConnectivityType
       description: Specifies the protocol exposed by the VL and the flow pattern supported by the VL 
       required: true
1618
      description:
ETSI CTI's avatar
ETSI CTI committed
1619 1620 1621
       type: string
       description: Provides human-readable information on the purpose of the VL 
       required: false
1622
      test_access:
ETSI CTI's avatar
ETSI CTI committed
1623 1624 1625 1626 1627 1628 1629
       type: list
       description: Test access facilities available on the VL 
       required: false
       entry_schema:
        type: string
        constraints:
         - valid_values: [ passive_monitoring, active_loopback ]
1630
      vl_profile:
ETSI CTI's avatar
ETSI CTI committed
1631 1632 1633
       type: tosca.datatypes.nfv.VlProfile
       description: Defines additional data for the VL 
       required: true
1634
      monitoring_parameters:
1635
       type: map #key: id
ETSI CTI's avatar
ETSI CTI committed
1636 1637 1638 1639
       entry_schema:
        type: tosca.datatypes.nfv.VirtualLinkMonitoringParameter
       description: Describes monitoring parameters applicable to the VL
       required: false
1640 1641
    capabilities:
      virtual_linkable:
ETSI CTI's avatar
ETSI CTI committed
1642 1643 1644 1645 1646 1647
       type: tosca.capabilities.nfv.VirtualLinkable

  tosca.nodes.nfv.VipCp:
    derived_from: tosca.nodes.nfv.Cp
    description: Describes a connection point to allocate one or a set of virtual IP addresses 
    properties:
1648 1649 1650 1651 1652
      dedicated_ip_address:
        type: boolean
        description: Indicates whether the VIP address shall be different from the addresses allocated to all associated VduCp instances or shall be the same as one of them.
        required: true
        default: true    
ETSI CTI's avatar
ETSI CTI committed
1653 1654 1655 1656 1657 1658 1659 1660 1661
      vip_function:
        type: string
        description: "Indicates the function the virtual IP address is used for: high availability or load balancing. When used for high availability, only one of the internal VDU CP instances or VNF external CP instances that share the virtual IP is bound to the VIP address at a time. When used for load balancing purposes all CP instances that share the virtual IP are bound to it." 
        required: true
        constraints:
          - valid_values: [ high_availability, load_balance ]
    requirements:
      - target:
          capability: tosca.capabilities.Node
1662
          node: tosca.nodes.nfv.VduCp
ETSI CTI's avatar
ETSI CTI committed
1663 1664 1665 1666 1667 1668 1669
          relationship: tosca.relationships.DependsOn
          occurrences: [ 1, UNBOUNDED ]
      - virtual_link:
          capability: tosca.capabilities.nfv.VirtualLinkable
          relationship: tosca.relationships.nfv.VipVirtualLinksTo
          occurrences: [1, 1]

1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692
  tosca.nodes.nfv.VduSubCp:
    derived_from: tosca.nodes.nfv.VduCp
    description: describes network connectivity between a VNFC instance based on this VDU and an internal VL through a trunk port 
    properties:
      segmentation_type:
        type: string
        description: Specifies the encapsulation type for the traffics coming in and out of the trunk subport.
        required: false
        constraints:
          - valid_values: [ vlan, inherit ]
      segmentation_id:
        type: integer
        description: Specifies the segmentation ID for the subport, which is used to differentiate the traffics on different networks coming in and out of the trunk port.
        required: false
        constraints:
          - greater_or_equal: 0
    requirements:
      - trunk_binding:
          capability: tosca.capabilities.nfv.TrunkBindable
          relationship: tosca.relationships.nfv.TrunkBindsTo
          node: tosca.nodes.nfv.VduCp
          occurrences: [1, 1]
          
1693 1694 1695 1696 1697 1698
group_types:
  tosca.groups.nfv.PlacementGroup:
    derived_from: tosca.groups.Root
    description: PlacementGroup is used for describing the affinity or anti-affinity relationship applicable between the virtualization containers to be created based on different VDUs, or between internal VLs to be created based on different VnfVirtualLinkDesc(s)
    properties:
      description:
ETSI CTI's avatar
ETSI CTI committed
1699 1700 1701
       type: string
       description: Human readable description of the group
       required: true
1702
    members: [ tosca.nodes.nfv.Vdu.Compute, tosca.nodes.nfv.VnfVirtualLink ]
ETSI CTI's avatar
ETSI CTI committed
1703 1704


1705 1706 1707 1708 1709 1710
policy_types:
  tosca.policies.nfv.InstantiationLevels:
    derived_from: tosca.policies.Root
    description: The InstantiationLevels type is a policy type representing all the instantiation levels of resources to be instantiated within a deployment flavour and including default instantiation level in term of the number of VNFC instances to be created as defined in ETSI GS NFV-IFA 011 [1].
    properties:
      levels:
ETSI CTI's avatar
ETSI CTI committed
1711 1712 1713 1714
       type: map # key: levelId
       description: Describes the various levels of resources that can be used to instantiate the VNF using this flavour.
       required: true
       entry_schema:
1715
         type: tosca.datatypes.nfv.InstantiationLevel
ETSI CTI's avatar
ETSI CTI committed
1716 1717
       constraints:
         - min_length: 1
1718
      default_level:
ETSI CTI's avatar
ETSI CTI committed
1719 1720 1721
       type: string # levelId
       description: The default instantiation level for this flavour.
       required: false # required if multiple entries in levels
1722 1723 1724

  tosca.policies.nfv.VduInstantiationLevels:
    derived_from: tosca.policies.Root
ETSI CTI's avatar
ETSI CTI committed
1725
    description: The VduInstantiationLevels type is a policy type representing all the instantiation levels of resources to be instantiated within a deployment flavour in term of the number of VNFC instances to be created from each vdu.Compute. as defined in ETSI GS NFV-IFA 011 [1]
1726 1727
    properties:
      levels:
ETSI CTI's avatar
ETSI CTI committed
1728 1729 1730 1731 1732 1733 1734
       type: map # key: levelId
       description: Describes the Vdu.Compute levels of resources that can be used to instantiate the VNF using this flavour
       required: true
       entry_schema:
        type: tosca.datatypes.nfv.VduLevel
       constraints:
         - min_length: 1
1735 1736 1737 1738
    targets: [ tosca.nodes.nfv.Vdu.Compute ]

  tosca.policies.nfv.VirtualLinkInstantiationLevels:
    derived_from: tosca.policies.Root
ETSI CTI's avatar
ETSI CTI committed
1739
    description: The VirtualLinkInstantiationLevels type is a policy type representing all the instantiation levels of virtual link resources to be instantiated within a deployment flavour as defined in ETSI GS NFV-IFA 011 [1].
1740 1741
    properties:
      levels:
ETSI CTI's avatar
ETSI CTI committed
1742 1743 1744 1745 1746 1747 1748
       type: map # key: levelId
       description: Describes the virtual link levels of resources that can be used to instantiate the VNF using this flavour.
       required: true
       entry_schema:
        type: tosca.datatypes.nfv.VirtualLinkBitrateLevel
       constraints:
         - min_length: 1
1749 1750 1751 1752
    targets: [ tosca.nodes.nfv.VnfVirtualLink ]

  tosca.policies.nfv.ScalingAspects:
    derived_from: tosca.policies.Root
ETSI CTI's avatar
ETSI CTI committed
1753
    description: The ScalingAspects type is a policy type representing the scaling aspects used for horizontal scaling as defined in ETSI GS NFV-IFA 011 [1]
1754 1755
    properties:
      aspects:
ETSI CTI's avatar
ETSI CTI committed
1756 1757 1758 1759 1760 1761 1762
       type: map # key: aspectId
       description: Describe maximum scale level for total number of scaling steps that can be applied to a particular aspect
       required: true
       entry_schema:
        type: tosca.datatypes.nfv.ScalingAspect
       constraints:
         - min_length: 1
1763 1764 1765

  tosca.policies.nfv.VduScalingAspectDeltas:
    derived_from: tosca.policies.Root
ETSI CTI's avatar
ETSI CTI committed
1766
    description: The VduScalingAspectDeltas type is a policy type representing the Vdu.Compute detail of an aspect deltas used for horizontal scaling, as defined in ETSI GS NFV-IFA 011 [1]
1767 1768
    properties:
      aspect:
ETSI CTI's avatar
ETSI CTI committed
1769 1770 1771
       type: string
       description: Represents the scaling aspect to which this policy applies
       required: true
1772
      deltas:
ETSI CTI's avatar
ETSI CTI committed
1773 1774 1775 1776 1777 1778 1779
       type: map # key: scalingDeltaId
       description: Describes the Vdu.Compute scaling deltas to be applied for every scaling steps of a particular aspect.
       required: true
       entry_schema:
        type: tosca.datatypes.nfv.VduLevel
       constraints:
         - min_length: 1
1780 1781 1782 1783 1784 1785 1786
    targets: [ tosca.nodes.nfv.Vdu.Compute ]

  tosca.policies.nfv.VirtualLinkBitrateScalingAspectDeltas:
    derived_from: tosca.policies.Root
    description: The VirtualLinkBitrateScalingAspectDeltas type is a policy type representing the VnfVirtualLink detail of an aspect deltas used for horizontal scaling, as defined in ETSI GS NFV-IFA 011 [1].
    properties:
      aspect:
ETSI CTI's avatar
ETSI CTI committed
1787 1788 1789
       type: string
       description: Represents the scaling aspect to which this policy applies.
       required: true
1790
      deltas:
ETSI CTI's avatar
ETSI CTI committed
1791 1792 1793 1794 1795 1796 1797
       type: map # key: scalingDeltaId
       description: Describes the VnfVirtualLink scaling deltas to be applied for every scaling steps of a particular aspect.
       required: true
       entry_schema:
        type: tosca.datatypes.nfv.VirtualLinkBitrateLevel
       constraints:
         - min_length: 1
1798 1799 1800 1801 1802 1803
    targets: [ tosca.nodes.nfv.VnfVirtualLink ]

  tosca.policies.nfv.VduInitialDelta:
    derived_from: tosca.policies.Root
    description: The VduInitialDelta type is a policy type representing the Vdu.Compute detail of an initial delta used for horizontal scaling, as defined in ETSI GS NFV-IFA 011 [1].
    properties:
ETSI CTI's avatar
ETSI CTI committed
1804 1805 1806 1807
     initial_delta:
      type: tosca.datatypes.nfv.VduLevel
      description: Represents the initial minimum size of the VNF.
      required: true
1808 1809 1810 1811 1812 1813 1814
    targets: [ tosca.nodes.nfv.Vdu.Compute ]

  tosca.policies.nfv.VirtualLinkBitrateInitialDelta:
    derived_from: tosca.policies.Root
    description: The VirtualLinkBitrateInitialDelta type is a policy type representing the VnfVirtualLink detail of an initial deltas used for horizontal scaling, as defined in ETSI GS NFV-IFA 011 [1].
    properties:
      initial_delta:
ETSI CTI's avatar
ETSI CTI committed
1815 1816 1817
       type: tosca.datatypes.nfv.VirtualLinkBitrateLevel
       description: Represents the initial minimum size of the VNF.
       required: true
1818 1819 1820 1821 1822 1823 1824
    targets: [ tosca.nodes.nfv.VnfVirtualLink ]

  tosca.policies.nfv.AffinityRule:
    derived_from: tosca.policies.Placement
    description: The AffinityRule describes the affinity rules applicable for the defined targets
    properties:
      scope:
ETSI CTI's avatar
ETSI CTI committed
1825 1826 1827 1828
       type: string
       description: scope of the rule is an NFVI_node, an NFVI_PoP, etc.
       required: true
       constraints:
1829
        - valid_values: [ nfvi_node, zone, zone_group, nfvi_pop, network_link_and_node ]
1830 1831 1832 1833 1834 1835 1836
    targets: [ tosca.nodes.nfv.Vdu.Compute, tosca.nodes.nfv.VnfVirtualLink, tosca.groups.nfv.PlacementGroup ]

  tosca.policies.nfv.AntiAffinityRule:
    derived_from: tosca.policies.Placement
    description: The AntiAffinityRule describes the anti-affinity rules applicable for the defined targets
    properties:
      scope:
ETSI CTI's avatar
ETSI CTI committed
1837 1838 1839 1840
       type: string
       description: scope of the rule is an NFVI_node, an NFVI_PoP, etc.
       required: true
       constraints:
1841
        - valid_values: [ nfvi_node, zone, zone_group, nfvi_pop, network_link_and_node ]
1842
    targets: [ tosca.nodes.nfv.Vdu.Compute, tosca.nodes.nfv.VnfVirtualLink, tosca.groups.nfv.PlacementGroup ]
ETSI CTI's avatar
ETSI CTI committed
1843 1844 1845 1846 1847 1848 1849 1850 1851 1852
  
  tosca.policies.nfv.SupportedVnfInterface:
   derived_from: tosca.policies.Root
   description:  this policy type represents interfaces produced by a VNF, the details to access them and the applicable connection points to use to access these interfaces
   properties:
     interface_name:
       type: string
       description: Identifies an interface produced by the VNF.
       required: true
       constraints:
1853
         - valid_values: [ vnf_indicator, vnf_configuration, vnf_lcm_coordination ]
ETSI CTI's avatar
ETSI CTI committed
1854 1855 1856 1857 1858
     details:
       type: tosca.datatypes.nfv.InterfaceDetails
       description: Provide additional data to access the interface endpoint
       required: false 
   targets: [ tosca.nodes.nfv.VnfExtCp, tosca.nodes.nfv.VduCp ]
1859 1860

  tosca.policies.nfv.SecurityGroupRule:
ETSI CTI's avatar
ETSI CTI committed
1861
    derived_from: tosca.policies.nfv.Abstract.SecurityGroupRule
1862
    description: The SecurityGroupRule type is a policy type specified the matching criteria for the ingress and/or egress traffic to/from visited connection points as defined in ETSI GS NFV-IFA 011 [1].
ETSI CTI's avatar
ETSI CTI committed
1863
    targets: [ tosca.nodes.nfv.VduCp, tosca.nodes.nfv.VnfExtCp ]
1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903

  tosca.policies.nfv.VnfIndicator:
    derived_from: tosca.policies.Root
    description: The VnfIndicator policy type is a base policy type for defining VNF indicator specific policies that define the conditions to assess and the action to perform when a VNF indicator changes value as defined in ETSI GS NFV-IFA 011 [1].
    properties:
      source:
        type: string
        description: Describe the source of the indicator.
        required: true
        constraints:
          - valid_values: [ vnf, em, both_vnf_and_em ]
    targets: [ tosca.nodes.nfv.VNF ]

  tosca.policies.nfv.VnfPackageChange:
    derived_from: tosca.policies.Root
    description: policy type specifying the processes and rules to be used for performing the resource related tasks, to change VNF instance to a different VNF Package (destination package)
    properties:
      selector:
        type: tosca.datatypes.nfv.VnfPackageChangeSelector
        description: Information to identify the source and destination VNFD for the change, and the related deployment flavours.
        required: true
      modification_qualifier:
        type: string
        description: Specifies the type of modification resulting from transitioning from srcVnfdId to dstVnfdId. The possible values are UP indicating that the destination VNF version is newer than the source version, DOWN indicating that the destination VNF version is older than the source version.
        constraints: [ valid_values: [ up, down ] ]
        required: true
      additional_modification_description:
        type: string
        description: Additional information to qualify further the change between the two versions.
        required: false
      component_mappings:
        type: list
        entry_schema:
          type: tosca.datatypes.nfv.VnfPackageChangeComponentMapping
        description: Mapping information related to identifiers of components in source VNFD and destination VNFD that concern to the change process.
        required: false
      destination_flavour_id:
        type: string
        description: Identifies the deployment flavour in the destination VNF package for which this change applies. The flavour ID is defined in the destination VNF package.
        required: true
1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952
      actions:
        type: list
        description: List of applicable supported LCM coordination action names (action_name) specified in this VNFD as a TOSCA policy of a type derived from tosca.policies.nfv.LcmCoordinationAction.
        required: false
        entry_schema:
          type: string
      referenced_coordination_actions:
        type: list
        description: List of names of coordination actions not specified within this VNFD as a TOSCA policy of a type derived from tosca.policies.nfv.LcmCoordinationAction.
        required: false
        entry_schema:
          type: string

  tosca.policies.nfv.LcmCoordinationAction:
    derived_from: tosca.policies.Root
    description: The LcmCoordinationAction type is a policy type representing the LCM coordination actions supported by a VNF and/or expected to be supported by its EM for a particular VNF LCM operation. This policy concerns the whole VNF (deployment flavour) represented by the topology_template and thus has no explicit target list.
    properties:
      action_name:
        type: string
        description: Coordination action name.
        required: true
      # action:  #represents a place holder for specifying actions of a VNF-specific type derived from tosca.datatypes.nfv.VnfLcmOpCoord
        # type: tosca.datatypes.nfv.VnfLcmOpCoord
        # description: Describes a set of information needed for coordination action in the VNF LCM operation.
        # required: true

  tosca.policies.nfv.LcmCoordinationsForLcmOperation: