tosca_definitions_version: tosca_simple_yaml_1_2 description: ETSI NFV SOL 001 nsd types definitions version 2.5.1 imports: - etsi_nfv_sol001_vnfd_types.yaml data_types: tosca.datatypes.nfv.ServiceAvailability: derived_from: tosca.datatypes.Root description: service availability properties: level: type: string description: service availability levels required: true constraints: - valid_values: [ level1, level2, level3 ] tosca.datatypes.nfv.L2AddressData: derived_from: tosca.datatypes.Root description: Describes the information on the MAC addresses to be assigned to a connection point. properties: mac_address_assignment: type: boolean 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 required: true tosca.datatypes.nfv.L3AddressData: derived_from: tosca.datatypes.Root description: Provides information about Layer 3 level addressing scheme and parameters applicable to a CP properties: ip_address_assignment: type: boolean 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 required: true floating_ip_activated: type: boolean description: Specifies if the floating IP scheme is activated on the Connection Point or not required: true ip_address_type: type: string description: Defines address type. The address type should be aligned with the address type supported by the layer_protocols properties of the parent VnfExtCp required: false constraints: - valid_values: [ ipv4, ipv6 ] number_of_ip_address: type: integer description: Minimum number of IP addresses to be assigned required: false constraints: - greater_than: 0 tosca.datatypes.nfv.AddressData: derived_from: tosca.datatypes.Root description: Describes information about the addressing scheme and parameters applicable to a CP properties: address_type: type: string 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 required: true constraints: - valid_values: [ mac_address, ip_address ] l2_address_data: type: tosca.datatypes.nfv.L2AddressData description: Provides the information on the MAC addresses to be assigned to a connection point. required: false l3_address_data: type: tosca.datatypes.nfv.L3AddressData description: Provides the information on the IP addresses to be assigned to a connection point required: false tosca.datatypes.nfv.ConnectivityType: derived_from: tosca.datatypes.Root description: describes additional connectivity information of a virtualLink properties: layer_protocols: type: list 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. required: true entry_schema: type: string constraints: - valid_values: [ ethernet, mpls, odu2, ipv4, ipv6, pseudo-wire ] flow_pattern: type: string description: Identifies the flow pattern of the connectivity required: false constraints: - valid_values: [ line, tree, mesh ] tosca.datatypes.nfv.NsVlProfile: derived_from: tosca.datatypes.Root description: Describes additional instantiation data for a given NsVirtualLink used in a specific NS 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.NsVirtualLinkQos description: Specifies the QoS requirements of a VL instantiated according to this profile. required: false service_availability: type: tosca.datatypes.nfv.ServiceAvailability description: Network service virtual link service availability levels, as described in ETSI GS NFV-REL 001 required: false tosca.datatypes.nfv.VirtualLinkProtocolData: 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: type: string 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 constraints: - 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. required: false 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. required: false tosca.datatypes.nfv.L2ProtocolData: derived_from: tosca.datatypes.Root description: describes L2 protocol data for a given virtual link used in a specific VNF deployment flavour. properties: name: type: string description: Identifies the network name associated with this L2 protocol. required: false network_type: type: string description: Specifies the network type for this L2 protocol.The value may be overridden at run-time. required: false constraints: - valid_values: [ flat, vlan, vxlan, gre ] vlan_transparent: type: boolean description: Specifies whether to support VLAN transparency for this L2 protocol or not. required: false default: false mtu: type: integer description: Specifies the maximum transmission unit (MTU) value for this L2 protocol. required: false constraints: - greater_than: 0 tosca.datatypes.nfv.L3ProtocolData: 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 ] tosca.datatypes.nfv.IpAllocationPool: 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 tosca.datatypes.nfv.LinkBitrateRequirements: derived_from: tosca.datatypes.Root description: describes the requirements in terms of bitrate for a virtual link properties: root: type: integer # in bits per second 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). required: true constraints: - greater_or_equal: 0 leaf: type: integer # in bits per second 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). required: false constraints: - greater_or_equal: 0 tosca.datatypes.nfv.NsVirtualLinkQos: derived_from: tosca.datatypes.nfv.Qos description: describes QoS data for a given VL used in a VNF deployment flavour properties: priority: type: integer description: Specifies the priority level in case of congestion on the underlying physical links required: false tosca.datatypes.nfv.CpProtocolData: derived_from: tosca.datatypes.Root description: Describes and associates the protocol layer that a CP uses together with other protocol and connection point information properties: associated_layer_protocol: type: string required: true description: One of the values of the property layer_protocols of the CP constraints: - valid_values: [ ethernet, mpls, odu2, ipv4, ipv6, pseudo-wire ] address_data: type: list description: Provides information on the addresses to be assigned to the CP entry_schema: type: tosca.datatypes.nfv.AddressData tosca.datatypes.nfv.VnfProfile: derived_from: tosca.datatypes.Root description: describes a profile for instantiating VNFs of a particular NS DF according to a specific VNFD and VNF DF. properties: instantiation_level: type: string 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. required: false min_number_of_instances: type: integer description: Minimum number of instances of the VNF based on this VNFD that is permitted to exist for this VnfProfile. required: true constraints: - greater_or_equal: 0 max_number_of_instances: type: integer description: Maximum number of instances of the VNF based on this VNFD that is permitted to exist for this VnfProfile. required: true constraints: - greater_or_equal: 0 tosca.datatypes.nfv.Qos: derived_from: tosca.datatypes.Root description: describes QoS data for a given VL used in a VNF deployment flavour properties: latency: type: scalar-unit.time #Number description: Specifies the maximum latency required: true constraints: - greater_than: 0 s packet_delay_variation: type: scalar-unit.time #Number description: Specifies the maximum jitter required: true constraints: - greater_or_equal: 0 s packet_loss_ratio: type: float description: Specifies the maximum packet loss ratio required: false constraints: - in_range: [ 0.0, 1.0 ] capability_types: tosca.capabilities.nfv.VirtualLinkable: derived_from: tosca.capabilities.Node description: A node type that includes the VirtualLinkable capability indicates that it can be pointed by tosca.relationships.nfv.VirtualLinksTo relationship type relationship_types: tosca.relationships.nfv.VirtualLinksTo: derived_from: tosca.relationships.DependsOn description: Represents an association relationship between the VNF or PNF or Sap of a Nested NS and NsVirtualLink node types valid_target_types: [ tosca.capabilities.nfv.VirtualLinkable ] interface_types: tosca.interfaces.nfv.Nslcm: derived_from: tosca.interfaces.Root 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. instantiate_start: description: Preamble to execution of the instantiate operation instantiate: description: Base procedure for instantiating an NS, corresponding to the Instantiate NS operation defined in GS NFV-IFA 013. instantiate_end: description: Postamble to the execution of the instantiate operation terminate_start: description: Preamble to execution of the terminate operation terminate: description: Base procedure for terminating an NS, corresponding to the Terminate NS operation defined in GS NFV-IFA 013. terminate _end: description: Postamble to the execution of the terminate operation update_start: description: Preamble to execution of the update operation update: description: Base procedure for updating an NS, corresponding to the Update NS operation defined in GS NFV-IFA 013. update_end: description: Postamble to the execution of the update operation scale_start: description: Preamble to execution of the scale operation scale: description: Base procedure for scaling an NS, corresponding to the Scale NS operation defined in GS NFV-IFA 013. scale _end: description: Postamble to the execution of the scale operation heal_start: description: Preamble to execution of the heal operation heal: description: Base procedure for healing an NS, corresponding to the Heal NS operation defined in GS NFV-IFA 013. heal _end: description: Postamble to the execution of the heal operation 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 VNF instances created using different VNFDs, the Virtual Link instances created using different VLDs or the nested NS instances created using different NSDs properties: description: type: string description: Human readable description of the group required: true members: [ tosca.nodes.nfv.VNF, tosca.nodes.nfv.NsVirtualLink, tosca.nodes.nfv.NS ] node_types: tosca.nodes.nfv.Cp: derived_from: tosca.nodes.Root description: Provides information regarding the purpose of the connection point properties: layer_protocols: type: list description: Identifies which protocol the connection point uses for connectivity purposes required: true entry_schema: type: string constraints: - valid_values: [ ethernet, mpls, odu2, ipv4, ipv6, pseudo-wire ] role: #Name in ETSI NFV IFA011 v0.7.3: cpRole type: string description: Identifies the role of the port in the context of the traffic flow patterns in the VNF or parent NS required: false constraints: - valid_values: [ root, leaf ] description: type: string description: Provides human-readable information on the purpose of the connection point required: false protocol: type: list description: Provides information on the addresses to be assigned to the connection point(s) instantiated from this Connection Point Descriptor required: true entry_schema: type: tosca.datatypes.nfv.CpProtocolData trunk_mode: type: boolean description: Provides information about whether the CP instantiated from this Cp is in Trunk mode (802.1Q or other) required: true tosca.nodes.nfv.NS: derived_from: tosca.nodes.Root properties: descriptor_id: type: string # GUID description: Identifier of this NS descriptor required: true designer: type: string description: Identifies the designer of the NSD. required: true version: type: string description: Identifies the version of the NSD. required: true name: type: string description: Provides the human readable name of the NSD. required: true invariant_id: type: string description: Identifies an NSD in a version independent manner. This attribute is invariant across versions of NSD. required: true requirements: - virtual_link: capability: tosca.capabilities.nfv.VirtualLinkable relationship: tosca.relationships.nfv.VirtualLinksTo node: tosca.nodes.nfv.NsVirtualLink occurrences: [ 0, 1 ] interfaces: Nslcm: type: tosca.interfaces.nfv.Nslcm tosca.nodes.nfv.Sap: derived_from: tosca.nodes.nfv.Cp description: node definition of SAP. requirements: - external_virtual_link: capability: tosca.capabilities.nfv.VirtualLinkable relationship: tosca.relationships.nfv.VirtualLinksTo - internal_virtual_link: capability: tosca.capabilities.nfv.VirtualLinkable relationship: tosca.relationships.nfv.VirtualLinksTo tosca.nodes.nfv.NsVirtualLink: derived_from: tosca.nodes.Root description: node definition of Virtual Links properties: vl_profile: type: tosca.datatypes.nfv.NsVlProfile # only covers min/max bitrate requirements description: Specifies instantiation parameters for a virtual link of a particular NS deployment flavour. required: true connectivity_type: type: tosca.datatypes.nfv.ConnectivityType required: true test_access: type: list description: Test access facilities available on the VL required: false entry_schema: type: string constraints: - valid_values: [ passive_monitoring, active_loopback ] description: type: string required: false description: Human readable information on the purpose of the virtual link (e.g. VL for control plane traffic). capabilities: virtual_linkable: type: tosca.capabilities.nfv.VirtualLinkable policy_types: tosca.policies.nfv.AffinityRule: derived_from: tosca.policies.Placement description: The AffinityRule describes the affinity rules applicable for the defined targets properties: scope: type: string description: scope of the rule is an NFVI_node, an NFVI_PoP, etc. required: true constraints: - valid_values: [ nfvi_node, zone, zone_group, nfvi_pop ] targets: [ tosca.nodes.nfv.VNF, tosca.nodes.nfv.NsVirtualLink, tosca.nodes.nfv.NS, 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: type: string description: scope of the rule is an NFVI_node, an NFVI_PoP, etc. required: true constraints: - valid_values: [ nfvi_node, zone, zone_group, nfvi_pop ] targets: [ tosca.nodes.nfv.VNF, tosca.nodes.nfv.NsVirtualLink, tosca.nodes.nfv.NS, tosca.groups.nfv.PlacementGroup ] tosca.policies.nfv.SecurityGroupRule: derived_from: tosca.policies.Root 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]. properties: description: type: string description: Human readable description of the security group rule. required: false direction: type: string 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. required: false constraints: - valid_values: [ ingress, egress ] default: ingress ether_type: type: string description: Indicates the protocol carried over the Ethernet layer. required: false constraints: - valid_values: [ ipv4, ipv6 ] default: ipv4 protocol: type: string 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. required: false constraints: - 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 ] default: tcp port_range_min: type: integer 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. required: false constraints: - greater_or_equal: 0 - less_or_equal: 65535 default: 0 port_range_max: type: integer 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. required: false constraints: - greater_or_equal: 0 - less_or_equal: 65535 default: 65535 targets: [ tosca.nodes.nfv.Sap ]