1 tosca_definitions_version: tosca_simple_yaml_1_2
2 description: ETSI NFV SOL 001 nsd types definitions version 2.5.1
5 - etsi_nfv_sol001_vnfd_types.yaml
8 tosca.datatypes.nfv.ServiceAvailability:
9 derived_from: tosca.datatypes.Root
10 description: service availability
14 description: service availability levels
17 - valid_values: [ level1, level2, level3 ]
19 tosca.datatypes.nfv.L2AddressData:
20 derived_from: tosca.datatypes.Root
21 description: Describes the information on the MAC addresses to be assigned to a connection point.
23 mac_address_assignment:
25 description: Specifies if the address assignment is the responsibility of management and orchestration function or not. If it is set to True, it is the management and orchestration function responsibility
28 tosca.datatypes.nfv.L3AddressData:
29 derived_from: tosca.datatypes.Root
30 description: Provides information about Layer 3 level addressing scheme and parameters applicable to a CP
32 ip_address_assignment:
34 description: Specifies if the address assignment is the responsibility of management and orchestration function or not. If it is set to True, it is the management and orchestration function responsibility
36 floating_ip_activated:
38 description: Specifies if the floating IP scheme is activated on the Connection Point or not
42 description: Defines address type. The address type should be aligned with the address type supported by the layer_protocols properties of the parent VnfExtCp
45 - valid_values: [ ipv4, ipv6 ]
48 description: Minimum number of IP addresses to be assigned
53 tosca.datatypes.nfv.AddressData:
54 derived_from: tosca.datatypes.Root
55 description: Describes information about the addressing scheme and parameters applicable to a CP
59 description: Describes the type of the address to be assigned to a connection point. The content type shall be aligned with the address type supported by the layerProtocol property of the connection point
62 - valid_values: [ mac_address, ip_address ]
64 type: tosca.datatypes.nfv.L2AddressData
65 description: Provides the information on the MAC addresses to be assigned to a connection point.
68 type: tosca.datatypes.nfv.L3AddressData
69 description: Provides the information on the IP addresses to be assigned to a connection point
72 tosca.datatypes.nfv.ConnectivityType:
73 derived_from: tosca.datatypes.Root
74 description: describes additional connectivity information of a virtualLink
78 description: Identifies the protocol a virtualLink gives access to (ethernet, mpls, odu2, ipv4, ipv6, pseudo-wire).The top layer protocol of the virtualLink protocol stack shall always be provided. The lower layer protocols may be included when there are specific requirements on these layers.
83 - valid_values: [ ethernet, mpls, odu2, ipv4, ipv6, pseudo-wire ]
86 description: Identifies the flow pattern of the connectivity
89 - valid_values: [ line, tree, mesh ]
91 tosca.datatypes.nfv.NsVlProfile:
92 derived_from: tosca.datatypes.Root
93 description: Describes additional instantiation data for a given NsVirtualLink used in a specific NS deployment flavour.
95 max_bitrate_requirements:
96 type: tosca.datatypes.nfv.LinkBitrateRequirements
97 description: Specifies the maximum bitrate requirements for a VL instantiated according to this profile.
99 min_bitrate_requirements:
100 type: tosca.datatypes.nfv.LinkBitrateRequirements
101 description: Specifies the minimum bitrate requirements for a VL instantiated according to this profile.
104 type: tosca.datatypes.nfv.NsVirtualLinkQos
105 description: Specifies the QoS requirements of a VL instantiated according to this profile.
107 service_availability:
108 type: tosca.datatypes.nfv.ServiceAvailability
109 description: Network service virtual link service availability levels, as described in ETSI GS NFV-REL 001
112 tosca.datatypes.nfv.VirtualLinkProtocolData:
113 derived_from: tosca.datatypes.Root
114 description: describes one protocol layer and associated protocol data for a given virtual link used in a specific VNF deployment flavour
116 associated_layer_protocol:
118 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.
121 - valid_values: [ ethernet, mpls, odu2, ipv4, ipv6, pseudo-wire ]
123 type: tosca.datatypes.nfv.L2ProtocolData
124 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.
127 type: tosca.datatypes.nfv.L3ProtocolData
128 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.
131 tosca.datatypes.nfv.L2ProtocolData:
132 derived_from: tosca.datatypes.Root
133 description: describes L2 protocol data for a given virtual link used in a specific VNF deployment flavour.
137 description: Identifies the network name associated with this L2 protocol.
141 description: Specifies the network type for this L2 protocol.The value may be overridden at run-time.
144 - valid_values: [ flat, vlan, vxlan, gre ]
147 description: Specifies whether to support VLAN transparency for this L2 protocol or not.
152 description: Specifies the maximum transmission unit (MTU) value for this L2 protocol.
157 tosca.datatypes.nfv.L3ProtocolData:
158 derived_from: tosca.datatypes.Root
159 description: describes L3 protocol data for a given virtual link used in a specific VNF deployment flavour.
163 description: Identifies the network name associated with this L3 protocol.
167 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.
170 - valid_values: [ ipv4, ipv6 ]
173 description: Specifies the CIDR (Classless Inter-Domain Routing) of this L3 protocol. The value may be overridden at run-time.
177 description: Specifies the allocation pools with start and end IP addresses for this L3 protocol. The value may be overridden at run-time.
180 type: tosca.datatypes.nfv.IpAllocationPool
183 description: Specifies the gateway IP address for this L3 protocol. The value may be overridden at run-time.
187 description: Indicates whether DHCP (Dynamic Host Configuration Protocol) is enabled or disabled for this L3 protocol. The value may be overridden at run-time.
191 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.
194 - valid_values: [ slaac, dhcpv6-stateful, dhcpv6-stateless ]
196 tosca.datatypes.nfv.IpAllocationPool:
197 derived_from: tosca.datatypes.Root
198 description: Specifies a range of IP addresses
202 description: The IP address to be used as the first one in a pool of addresses derived from the cidr block full IP range
206 description: The IP address to be used as the last one in a pool of addresses derived from the cidr block full IP range
209 tosca.datatypes.nfv.LinkBitrateRequirements:
210 derived_from: tosca.datatypes.Root
211 description: describes the requirements in terms of bitrate for a virtual link
214 type: integer # in bits per second
215 description: Specifies the throughput requirement in bits per second of the link (e.g. bitrate of E-Line, root bitrate of E-Tree, aggregate capacity of E-LAN).
218 - greater_or_equal: 0
220 type: integer # in bits per second
221 description: Specifies the throughput requirement in bits per second of leaf connections to the link when applicable to the connectivity type (e.g. for E-Tree and E LAN branches).
224 - greater_or_equal: 0
226 tosca.datatypes.nfv.NsVirtualLinkQos:
227 derived_from: tosca.datatypes.nfv.Qos
228 description: describes QoS data for a given VL used in a VNF deployment flavour
232 description: Specifies the priority level in case of congestion on the underlying physical links
235 tosca.datatypes.nfv.CpProtocolData:
236 derived_from: tosca.datatypes.Root
237 description: Describes and associates the protocol layer that a CP uses together with other protocol and connection point information
239 associated_layer_protocol:
242 description: One of the values of the property layer_protocols of the CP
244 - valid_values: [ ethernet, mpls, odu2, ipv4, ipv6, pseudo-wire ]
247 description: Provides information on the addresses to be assigned to the CP
249 type: tosca.datatypes.nfv.AddressData
251 tosca.datatypes.nfv.VnfProfile:
252 derived_from: tosca.datatypes.Root
253 description: describes a profile for instantiating VNFs of a particular NS DF according to a specific VNFD and VNF DF.
257 description: Identifier of the instantiation level of the VNF DF to be used for instantiation. If not present, the default instantiation level as declared in the VNFD shall be used.
259 min_number_of_instances:
261 description: Minimum number of instances of the VNF based on this VNFD that is permitted to exist for this VnfProfile.
264 - greater_or_equal: 0
265 max_number_of_instances:
267 description: Maximum number of instances of the VNF based on this VNFD that is permitted to exist for this VnfProfile.
270 - greater_or_equal: 0
272 tosca.datatypes.nfv.Qos:
273 derived_from: tosca.datatypes.Root
274 description: describes QoS data for a given VL used in a VNF deployment flavour
277 type: scalar-unit.time #Number
278 description: Specifies the maximum latency
282 packet_delay_variation:
283 type: scalar-unit.time #Number
284 description: Specifies the maximum jitter
287 - greater_or_equal: 0 s
290 description: Specifies the maximum packet loss ratio
293 - in_range: [ 0.0, 1.0 ]
296 tosca.capabilities.nfv.VirtualLinkable:
297 derived_from: tosca.capabilities.Node
298 description: A node type that includes the VirtualLinkable capability indicates that it can be pointed by tosca.relationships.nfv.VirtualLinksTo relationship type
301 tosca.relationships.nfv.VirtualLinksTo:
302 derived_from: tosca.relationships.DependsOn
303 description: Represents an association relationship between the VNF or PNF or Sap of a Nested NS and NsVirtualLink node types
304 valid_target_types: [ tosca.capabilities.nfv.VirtualLinkable ]
307 tosca.interfaces.nfv.Nslcm:
308 derived_from: tosca.interfaces.Root
309 description: This interface encompasses a set of TOSCA operations corresponding to NS LCM operations defined in ETSI GS NFV-IFA 013. as well as to preamble and postamble procedures to the execution of the NS LCM operations.
311 description: Preamble to execution of the instantiate operation
313 description: Base procedure for instantiating an NS, corresponding to the Instantiate NS operation defined in GS NFV-IFA 013.
315 description: Postamble to the execution of the instantiate operation
317 description: Preamble to execution of the terminate operation
319 description: Base procedure for terminating an NS, corresponding to the Terminate NS operation defined in GS NFV-IFA 013.
321 description: Postamble to the execution of the terminate operation
323 description: Preamble to execution of the update operation
325 description: Base procedure for updating an NS, corresponding to the Update NS operation defined in GS NFV-IFA 013.
327 description: Postamble to the execution of the update operation
329 description: Preamble to execution of the scale operation
331 description: Base procedure for scaling an NS, corresponding to the Scale NS operation defined in GS NFV-IFA 013.
333 description: Postamble to the execution of the scale operation
335 description: Preamble to execution of the heal operation
337 description: Base procedure for healing an NS, corresponding to the Heal NS operation defined in GS NFV-IFA 013.
339 description: Postamble to the execution of the heal operation
341 tosca.groups.nfv.PlacementGroup:
342 derived_from: tosca.groups.Root
343 description: PlacementGroup is used for describing the affinity or anti-affinity relationship applicable between VNF instances created using different VNFDs, the Virtual Link instances created using different VLDs or the nested NS instances created using different NSDs
347 description: Human readable description of the group
349 members: [ tosca.nodes.nfv.VNF, tosca.nodes.nfv.NsVirtualLink, tosca.nodes.nfv.NS ]
353 derived_from: tosca.nodes.Root
354 description: Provides information regarding the purpose of the connection point
358 description: Identifies which protocol the connection point uses for connectivity purposes
363 - valid_values: [ ethernet, mpls, odu2, ipv4, ipv6, pseudo-wire ]
364 role: #Name in ETSI NFV IFA011 v0.7.3: cpRole
366 description: Identifies the role of the port in the context of the traffic flow patterns in the VNF or parent NS
369 - valid_values: [ root, leaf ]
372 description: Provides human-readable information on the purpose of the connection point
376 description: Provides information on the addresses to be assigned to the connection point(s) instantiated from this Connection Point Descriptor
379 type: tosca.datatypes.nfv.CpProtocolData
382 description: Provides information about whether the CP instantiated from this Cp is in Trunk mode (802.1Q or other)
386 derived_from: tosca.nodes.Root
390 description: Identifier of this NS descriptor
394 description: Identifies the designer of the NSD.
398 description: Identifies the version of the NSD.
402 description: Provides the human readable name of the NSD.
406 description: Identifies an NSD in a version independent manner. This attribute is invariant across versions of NSD.
410 capability: tosca.capabilities.nfv.VirtualLinkable
411 relationship: tosca.relationships.nfv.VirtualLinksTo
412 node: tosca.nodes.nfv.NsVirtualLink
413 occurrences: [ 0, 1 ]
416 type: tosca.interfaces.nfv.Nslcm
420 derived_from: tosca.nodes.nfv.Cp
421 description: node definition of SAP.
423 - external_virtual_link:
424 capability: tosca.capabilities.nfv.VirtualLinkable
425 relationship: tosca.relationships.nfv.VirtualLinksTo
426 - internal_virtual_link:
427 capability: tosca.capabilities.nfv.VirtualLinkable
428 relationship: tosca.relationships.nfv.VirtualLinksTo
430 tosca.nodes.nfv.NsVirtualLink:
431 derived_from: tosca.nodes.Root
432 description: node definition of Virtual Links
435 type: tosca.datatypes.nfv.NsVlProfile # only covers min/max bitrate requirements
436 description: Specifies instantiation parameters for a virtual link of a particular NS deployment flavour.
439 type: tosca.datatypes.nfv.ConnectivityType
443 description: Test access facilities available on the VL
448 - valid_values: [ passive_monitoring, active_loopback ]
452 description: Human readable information on the purpose of the virtual link (e.g. VL for control plane traffic).
455 type: tosca.capabilities.nfv.VirtualLinkable
458 tosca.policies.nfv.AffinityRule:
459 derived_from: tosca.policies.Placement
460 description: The AffinityRule describes the affinity rules applicable for the defined targets
464 description: scope of the rule is an NFVI_node, an NFVI_PoP, etc.
467 - valid_values: [ nfvi_node, zone, zone_group, nfvi_pop ]
468 targets: [ tosca.nodes.nfv.VNF, tosca.nodes.nfv.NsVirtualLink, tosca.nodes.nfv.NS, tosca.groups.nfv.PlacementGroup ]
470 tosca.policies.nfv.AntiAffinityRule:
471 derived_from: tosca.policies.Placement
472 description: The AntiAffinityRule describes the anti-affinity rules applicable for the defined targets
476 description: scope of the rule is an NFVI_node, an NFVI_PoP, etc.
479 - valid_values: [ nfvi_node, zone, zone_group, nfvi_pop ]
480 targets: [ tosca.nodes.nfv.VNF, tosca.nodes.nfv.NsVirtualLink, tosca.nodes.nfv.NS, tosca.groups.nfv.PlacementGroup ]
482 tosca.policies.nfv.SecurityGroupRule:
483 derived_from: tosca.policies.Root
484 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].
488 description: Human readable description of the security group rule.
492 description: The direction in which the security group rule is applied. The direction of 'ingress' or 'egress' is specified against the associated CP. I.e., 'ingress' means the packets entering a CP, while 'egress' means the packets sent out of a CP.
495 - valid_values: [ ingress, egress ]
499 description: Indicates the protocol carried over the Ethernet layer.
502 - valid_values: [ ipv4, ipv6 ]
506 description: Indicates the protocol carried over the IP layer. Permitted values include any protocol defined in the IANA protocol registry, e.g. TCP, UDP, ICMP, etc.
509 - valid_values: [ hopopt, icmp, igmp, ggp, ipv4, st, tcp, cbt, egp, igp, bbn_rcc_mon, nvp_ii, pup, argus, emcon, xnet, chaos, udp, mux, dcn_meas, hmp, prm, xns_idp, trunk_1, trunk_2, leaf_1, leaf_2, rdp, irtp, iso_tp4, netblt, mfe_nsp, merit_inp, dccp, 3pc, idpr, xtp, ddp, idpr_cmtp, tp++, il, ipv6, sdrp, ipv6_route, ipv6_frag, idrp, rsvp, gre, dsr, bna, esp, ah, i_nlsp, swipe, narp, mobile, tlsp, skip, ipv6_icmp, ipv6_no_nxt, ipv6_opts, cftp, sat_expak, kryptolan, rvd, ippc, sat_mon, visa, ipcv, cpnx, cphb, wsn, pvp, br_sat_mon, sun_nd, wb_mon, wb_expak, iso_ip, vmtp, secure_vmtp, vines, ttp, iptm, nsfnet_igp, dgp, tcf, eigrp, ospfigp, sprite_rpc, larp, mtp, ax.25, ipip, micp, scc_sp, etherip, encap, gmtp, ifmp, pnni, pim, aris, scps, qnx, a/n, ip_comp, snp, compaq_peer, ipx_in_ip, vrrp, pgm, l2tp, ddx, iatp, stp, srp, uti, smp, sm, ptp, isis, fire, crtp, crudp, sscopmce, iplt, sps, pipe, sctp, fc, rsvp_e2e_ignore, mobility, udp_lite, mpls_in_ip, manet, hip, shim6, wesp, rohc ]
513 description: Indicates minimum port number in the range that is matched by the security group rule. If a value is provided at design-time, this value may be overridden at run-time based on other deployment requirements or constraints.
516 - greater_or_equal: 0
517 - less_or_equal: 65535
521 description: Indicates maximum port number in the range that is matched by the security group rule. If a value is provided at design-time, this value may be overridden at run-time based on other deployment requirements or constraints.
524 - greater_or_equal: 0
525 - less_or_equal: 65535
527 targets: [ tosca.nodes.nfv.Sap ]
528 tosca.dataTypes.tmf.milestoneJeopardyData:
529 derived_from: tosca.datatypes.Root
540 valid_values: [milestone, jeopardy]
544 valid_values: [normal, critical, hazard]