2 # Licensed under the Apache License, Version 2.0 (the "License");
3 # you may not use this file except in compliance with the License.
4 # You may obtain a copy of the License at
6 # http://www.apache.org/licenses/LICENSE-2.0
8 # Unless required by applicable law or agreed to in writing, software
9 # distributed under the License is distributed on an "AS IS" BASIS,
10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11 # See the License for the specific language governing permissions and
12 # limitations under the License.
14 tosca_definitions_version: tosca_simple_yaml_1_1
17 description: The TOSCA root Data Type all other TOSCA base Data Types derive from
19 derived_from: tosca.datatypes.Root
21 derived_from: tosca.datatypes.Root
23 derived_from: tosca.datatypes.Root
25 derived_from: tosca.datatypes.Root
27 derived_from: tosca.datatypes.Root
29 derived_from: tosca.datatypes.Root
31 derived_from: tosca.datatypes.Root
33 derived_from: tosca.datatypes.Root
35 derived_from: scalar-unit
37 derived_from: scalar-unit
38 scalar-unit.frequency:
39 derived_from: scalar-unit
40 tosca.datatypes.Credential:
41 derived_from: tosca.datatypes.Root
59 org.openecomp.datatypes.PortMirroringConnectionPointDescription:
60 derived_from: tosca.datatypes.Root
70 tosca.datatypes.TimeInterval:
71 derived_from: tosca.datatypes.Root
79 tosca.datatypes.network.NetworkInfo:
80 derived_from: tosca.datatypes.Root
90 tosca.datatypes.network.PortInfo:
91 derived_from: tosca.datatypes.Root
105 tosca.datatypes.network.PortDef:
106 derived_from: integer
111 tosca.datatypes.network.PortSpec:
112 derived_from: tosca.datatypes.Root
124 type: tosca.datatypes.network.PortDef
132 type: tosca.datatypes.network.PortDef
139 org.openecomp.datatypes.heat.network.AddressPair:
140 derived_from: tosca.datatypes.Root
141 description: MAC/IP address pairs
145 description: MAC address
150 description: IP address
153 org.openecomp.datatypes.heat.network.subnet.HostRoute:
154 derived_from: tosca.datatypes.Root
155 description: Host route info for the subnet
159 description: The destination for static route
164 description: The next hop for the destination
167 org.openecomp.datatypes.heat.network.AllocationPool:
168 derived_from: tosca.datatypes.Root
169 description: The start and end addresses for the allocation pool
173 description: Start address for the allocation pool
178 description: End address for the allocation pool
181 org.openecomp.datatypes.heat.network.neutron.Subnet:
182 derived_from: tosca.datatypes.Root
183 description: A subnet represents an IP address block that can be used for assigning IP addresses to virtual instances
187 description: The ID of the tenant who owns the network
192 description: Set to true if DHCP is enabled and false if DHCP is disabled
198 description: IPv6 address mode
208 description: IPv6 RA (Router Advertisement) mode
218 description: Extra parameters to include in the request
226 description: The start and end addresses for the allocation pools
230 type: org.openecomp.datatypes.heat.network.AllocationPool
233 description: The name or ID of the subnet pool
238 description: A specified set of DNS name servers to be used
246 description: The gateway IP address
250 type: org.openecomp.datatypes.heat.network.subnet.HostRoute
253 description: The gateway IP address
263 description: The name of the subnet
268 description: Prefix length for subnet allocation from subnet pool
272 - greater_or_equal: 0
275 description: The CIDR
280 description: The gateway IP address
283 org.openecomp.datatypes.heat.novaServer.network.PortExtraProperties:
284 derived_from: tosca.datatypes.Root
285 description: Nova server network expand properties for port
287 port_security_enabled:
289 description: Flag to enable/disable port security on the port
294 description: MAC address to give to this port
299 description: The administrative state of this port
305 description: The name or ID of QoS policy to attach to this port
308 allowed_address_pairs:
310 description: Additional MAC/IP address pairs allowed to pass through the port
314 type: org.openecomp.datatypes.heat.network.AddressPair
317 description: The vnic type to be bound on the neutron port
327 description: Extra parameters to include in the request
333 org.openecomp.datatypes.heat.novaServer.network.AddressInfo:
334 derived_from: tosca.datatypes.network.NetworkInfo
335 description: Network addresses with corresponding port id
342 org.openecomp.datatypes.heat.neutron.port.FixedIps:
343 derived_from: tosca.datatypes.Root
344 description: subnet/ip_address
348 description: Subnet in which to allocate the IP address for this port
353 description: IP address desired in the subnet for this port
358 description: Subnet in which to allocate the IP address for this port
361 org.openecomp.datatypes.heat.FileInfo:
362 derived_from: tosca.datatypes.Root
363 description: Heat File Info
367 description: The required URI string (relative or absolute) which can be used to locate the file
372 description: The type of the file
381 org.openecomp.datatypes.heat.contrail.network.rule.PortPairs:
382 derived_from: tosca.datatypes.Root
383 description: source and destination port pairs
387 description: Start port
392 description: End port
395 org.openecomp.datatypes.heat.contrail.network.rule.Rule:
396 derived_from: tosca.datatypes.Root
397 description: policy rule
401 description: Source ports
405 type: org.openecomp.datatypes.heat.contrail.network.rule.PortPairs
408 description: Protocol
413 description: Destination addresses
417 type: org.openecomp.datatypes.heat.contrail.network.rule.VirtualNetwork
420 description: Service to apply
425 description: Destination ports
429 type: org.openecomp.datatypes.heat.contrail.network.rule.PortPairs
432 description: Source addresses
436 type: org.openecomp.datatypes.heat.contrail.network.rule.VirtualNetwork
439 description: Direction
442 org.openecomp.datatypes.heat.contrail.network.rule.RuleList:
443 derived_from: tosca.datatypes.Root
444 description: list of policy rules
448 description: Contrail network rule
452 type: org.openecomp.datatypes.heat.contrail.network.rule.Rule
453 org.openecomp.datatypes.heat.contrail.network.rule.VirtualNetwork:
454 derived_from: tosca.datatypes.Root
455 description: source and destination addresses
459 description: Virtual network
462 org.openecomp.datatypes.heat.network.neutron.SecurityRules.Rule:
463 derived_from: tosca.datatypes.Root
464 description: Rules Pairs
468 description: The remote group ID to be associated with this security group rule
473 description: The protocol that is matched by the security group rule
483 description: Ethertype of the traffic
493 description: 'The maximum port number in the range that is matched by the
494 security group rule. '
503 description: The remote IP prefix (CIDR) to be associated with this security group rule
508 description: Whether to specify a remote group or a remote IP prefix
510 default: remote_ip_prefix
518 description: The direction in which the security group rule is applied
528 description: The minimum port number in the range that is matched by the security group rule.
535 org.openecomp.datatypes.heat.substitution.SubstitutionFiltering:
536 derived_from: tosca.datatypes.Root
537 description: Substitution Filter
539 substitute_service_template:
541 description: Substitute Service Template
546 description: Index value of the substitution service template runtime instance
551 - greater_or_equal: 0
560 description: Indicates whether service scaling is enabled
566 description: Mandatory
570 org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.RefDataSequence:
571 derived_from: tosca.datatypes.Root
572 description: network policy refs data sequence
574 network_policy_refs_data_sequence_major:
576 description: Network Policy ref data sequence Major
579 network_policy_refs_data_sequence_minor:
581 description: Network Policy ref data sequence Minor
584 org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.RefData:
585 derived_from: tosca.datatypes.Root
586 description: network policy refs data
588 network_policy_refs_data_sequence:
589 type: org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.RefDataSequence
590 description: Network Policy ref data sequence
593 org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.ref.data.IpamSubnet:
594 derived_from: tosca.datatypes.Root
595 description: Network Ipam Ref Data Subnet
597 network_ipam_refs_data_ipam_subnets_subnet_ip_prefix_len:
599 description: Network ipam refs data ipam subnets ip prefix len
602 network_ipam_refs_data_ipam_subnets_subnet_ip_prefix:
604 description: Network ipam refs data ipam subnets ip prefix
607 org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.ref.data.IpamSubnetList:
608 derived_from: tosca.datatypes.Root
609 description: Network Ipam Ref Data Subnet List
611 network_ipam_refs_data_ipam_subnets_subnet:
612 type: org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.ref.data.IpamSubnet
613 description: Network ipam refs data ipam subnets
616 network_ipam_refs_data_ipam_subnets_addr_from_start:
618 description: Network ipam refs data ipam subnets addr from start
621 org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.IpamRefData:
622 derived_from: tosca.datatypes.Root
623 description: Network Ipam Ref Data
625 network_ipam_refs_data_ipam_subnets:
627 description: Network ipam refs data ipam subnets
631 type: org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.ref.data.IpamSubnetList
632 org.openecomp.datatypes.heat.contrailV2.network.rule.SrcVirtualNetwork:
633 derived_from: tosca.datatypes.Root
634 description: source addresses
636 network_policy_entries_policy_rule_src_addresses_virtual_network:
638 description: Source addresses Virtual network
641 org.openecomp.datatypes.heat.contrailV2.network.rule.DstVirtualNetwork:
642 derived_from: tosca.datatypes.Root
643 description: destination addresses
645 network_policy_entries_policy_rule_dst_addresses_virtual_network:
647 description: Destination addresses Virtual network
650 org.openecomp.datatypes.heat.contrailV2.network.rule.DstPortPairs:
651 derived_from: tosca.datatypes.Root
652 description: destination port pairs
654 network_policy_entries_policy_rule_dst_ports_start_port:
656 description: Start port
659 network_policy_entries_policy_rule_dst_ports_end_port:
661 description: End port
664 org.openecomp.datatypes.heat.contrailV2.network.rule.SrcPortPairs:
665 derived_from: tosca.datatypes.Root
666 description: source port pairs
668 network_policy_entries_policy_rule_src_ports_start_port:
670 description: Start port
673 network_policy_entries_policy_rule_src_ports_end_port:
675 description: End port
678 org.openecomp.datatypes.heat.contrailV2.network.rule.ActionList:
679 derived_from: tosca.datatypes.Root
680 description: Action List
682 network_policy_entries_policy_rule_action_list_simple_action:
684 description: Simple Action
687 network_policy_entries_policy_rule_action_list_apply_service:
689 description: Apply Service
694 org.openecomp.datatypes.heat.contrailV2.network.rule.Rule:
695 derived_from: tosca.datatypes.Root
696 description: policy rule
698 network_policy_entries_policy_rule_dst_addresses:
700 description: Destination addresses
704 type: org.openecomp.datatypes.heat.contrailV2.network.rule.DstVirtualNetwork
705 network_policy_entries_policy_rule_dst_ports:
707 description: Destination ports
711 type: org.openecomp.datatypes.heat.contrailV2.network.rule.DstPortPairs
712 network_policy_entries_policy_rule_protocol:
714 description: Protocol
717 network_policy_entries_policy_rule_src_addresses:
719 description: Source addresses
723 type: org.openecomp.datatypes.heat.contrailV2.network.rule.SrcVirtualNetwork
724 network_policy_entries_policy_rule_direction:
726 description: Direction
729 network_policy_entries_policy_rule_src_ports:
731 description: Source ports
735 type: org.openecomp.datatypes.heat.contrailV2.network.rule.SrcPortPairs
736 network_policy_entries_policy_rule_action_list:
737 type: org.openecomp.datatypes.heat.contrailV2.network.rule.ActionList
738 description: Action list
741 org.openecomp.datatypes.heat.contrailV2.network.rule.RuleList:
742 derived_from: tosca.datatypes.Root
743 description: list of policy rules
745 network_policy_entries_policy_rule:
747 description: Contrail network rule
751 type: org.openecomp.datatypes.heat.contrailV2.network.rule.Rule
752 org.openecomp.datatypes.heat.network.contrail.port.StaticRoute:
753 derived_from: tosca.datatypes.Root
754 description: static route
758 description: Route prefix
763 description: Next hop
768 description: Next hop type
771 org.openecomp.datatypes.heat.network.contrail.AddressPair:
772 derived_from: tosca.datatypes.Root
773 description: Address Pair
777 description: Address mode active-active or active-standy
786 description: IP address prefix
791 description: Mac address
794 org.openecomp.datatypes.heat.network.contrail.InterfaceData:
795 derived_from: tosca.datatypes.Root
796 description: Interface Data
800 description: An ordered list of static routes to be added to this interface
804 type: org.openecomp.datatypes.heat.network.contrail.port.StaticRoute
807 description: Virtual Network for this interface
810 allowed_address_pairs:
812 description: List of allowed address pair for this interface
816 type: org.openecomp.datatypes.heat.network.contrail.AddressPair
819 description: IP for this interface
822 org.openecomp.datatypes.heat.contrailV2.virtual.machine.interface.Properties:
823 derived_from: tosca.datatypes.Root
824 description: Virtual Machine Interface Properties.
826 virtual_machine_interface_properties_service_interface_type:
828 description: Service Interface Type.
831 org.openecomp.datatypes.Root:
832 derived_from: tosca.datatypes.Root
834 The ECOMP root Data Type all other Data Types derive from
840 A placeholder for missing properties that would be included in future ecomp model versions. fromat <key>:<value>
842 org.openecomp.datatypes.AssignmentRequirements:
843 derived_from: org.openecomp.datatypes.Root
847 "true" indicates that assignment is required
852 description: number of assignments required
855 org.openecomp.datatypes.network.SubnetAssignments:
856 derived_from: org.openecomp.datatypes.Root
858 ip_network_address_plan:
861 description: Reference to EIPAM, VLAN or other address plan ID used to assign subnets to this network
865 description: \"true\" indicates the network has 1 or more policies
873 description: The IP version of the subnet
877 description: The default subnet CIDR mask
882 description: Quantity of subnets that must be initially assigned
883 org.openecomp.datatypes.network.IPv4SubnetAssignments:
884 derived_from: org.openecomp.datatypes.network.SubnetAssignments
889 description: Indicates IPv4 subnet assignments
890 org.openecomp.datatypes.network.IPv6SubnetAssignments:
891 derived_from: org.openecomp.datatypes.network.SubnetAssignments
896 description: Indicates IPv6 subnet assignments
897 org.openecomp.datatypes.network.NetworkAssignments:
898 derived_from: org.openecomp.datatypes.Root
900 ecomp_generated_network_assignment:
905 \"true\" indicates that the network assignments will be auto-generated by ECOMP \"false\" indicates operator-supplied Network assignments file upload is required (e.g. VID will present prompt to operator to upload operator-supplied Network assignments file).
909 description: \"true\" means this network is shared by multiple Openstack tenants
915 \"true\" means this Contrail external network
916 ipv4_subnet_default_assignment:
917 type: org.openecomp.datatypes.network.IPv4SubnetAssignments
919 description: IPv4 defualt subnet assignments
920 ipv6_subnet_default_assignment:
921 type: org.openecomp.datatypes.network.IPv6SubnetAssignments
923 description: IPv6 defualt subnet assignments
924 org.openecomp.datatypes.network.ProviderNetwork:
925 derived_from: org.openecomp.datatypes.Root
930 description: \"true\" indicates that this a Neutron provider type of network
931 physical_network_name:
943 Identifies the NUMA processor cluster to which this physical network interface belongs. NUMA instance correlates to the first digit of the Physical Network Name suffix (e.g. \"01\" = NUMA 0, \"11\" = NUMA 1)
952 PNIC instance within the NUMA processor cluster PNIC Instance correlates to the second digit of the Physical Network Name suffix (e.g. "01" = PNIC 1, "02" = "PNIC 2)
956 description: PNIC instance within the NUMA processor cluster
957 org.openecomp.datatypes.network.NetworkFlows:
958 derived_from: org.openecomp.datatypes.Root
964 description: \"true\" indicates the network has 1 or more policies
968 description: 'Identifies the specific Cloud network policy that must be applied
969 to this network (source: from Policy Manager).'
974 description: \"true\" indicates the network has 1 or more vpn bindings
978 description: 'Identifies the specific VPN Binding entry in A&AI that must
979 be applied when creating this network (source: A&AI)'
980 org.openecomp.datatypes.network.VlanRequirements:
981 derived_from: org.openecomp.datatypes.Root
986 description: reference to a vlan range plan
994 description: identifies the vlan type (e.g., c-tag)
998 description: identifies the number of vlan tags to assign to the CP from the plan
999 org.openecomp.datatypes.network.IpRequirements:
1000 derived_from: org.openecomp.datatypes.Root
1010 description: identifies the number of ip address to assign to the CP from the plan
1030 description: identifies the number of ip address to assign to the CP from the plan
1031 type: org.openecomp.datatypes.AssignmentRequirements
1033 floating_ip_count_required:
1034 type: org.openecomp.datatypes.AssignmentRequirements
1036 ip_address_plan_name:
1042 org.openecomp.datatypes.network.MacAssignments:
1043 derived_from: org.openecomp.datatypes.Root
1048 description: reference to a MAC address range plan
1052 description: identifies the number of MAC addresses to assign to the CP from the plan
1053 org.openecomp.datatypes.EcompHoming:
1054 derived_from: org.openecomp.datatypes.Root
1056 ecomp_selected_instance_node_target:
1061 \"true\" indicates that the target deployment node for this instance will be auto-selected by ECOMP \"false\" indicates operator-supplied instance target deployment node required (e.g. VID will present a prompt to operator and collect the operator-selected target node for the deployment of this Network instance).
1065 description: Referenc to a service level homing policy that ECOMP will use for instance deployment target node
1066 instance_node_target:
1069 description: Instance target deployment node
1070 org.openecomp.datatypes.EcompNaming:
1071 derived_from: org.openecomp.datatypes.Root
1073 ecomp_generated_naming:
1078 \"true\" indicates that the name for the instance will be auto-generated by ECOMP. \"false\" indicates operator-supplied name required (e.g. VID will present prompt to operator and collect the operator-supplied instance name).
1082 description: Referenc to naming policy that ECOMP will use when the name is auto-generated
1083 org.openecomp.datatypes.network.MacRequirements:
1084 derived_from: org.openecomp.datatypes.Root
1087 description: reference to a MAC address range plan
1091 description: identifies the number of MAC addresses to assign to the CP from the plan
1095 description: identifies the number of MAC addresses to assign to the CP from the plan
1096 type: org.openecomp.datatypes.AssignmentRequirements
1097 org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPairIp:
1098 derived_from: tosca.datatypes.Root
1099 description: Virtual Machine Sub Interface Address Pair IP.
1103 description: IP Prefix.
1108 description: IP Prefix Len.
1111 org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.MacAddress:
1112 derived_from: tosca.datatypes.Root
1113 description: Virtual Machine Sub Interface Mac Address.
1117 description: Mac Addresses List.
1122 org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.Properties:
1123 derived_from: tosca.datatypes.Root
1124 description: Virtual Machine Sub Interface VLAN Properties.
1126 sub_interface_vlan_tag:
1128 description: Sub Interface VLAN Tag.
1131 org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPair:
1132 derived_from: tosca.datatypes.Root
1133 description: Virtual Machine Sub Interface Address Pair.
1137 description: Address Mode.
1141 type: org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPairIp
1150 org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPairs:
1151 derived_from: tosca.datatypes.Root
1152 description: Virtual Machine Sub Interface Address Pairs.
1154 allowed_address_pair:
1156 description: Addresses pair List.
1160 type: org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPair
1161 org.openecomp.datatypes.Naming:
1162 derived_from: org.openecomp.datatypes.Root
1164 ecomp_generated_naming:
1166 "true" indicates that the name for the instance will be auto-generated by ECOMP. "false" indicates operator-supplied name required (e.g. VID will present prompt to operator and collect the operator-supplied instance name).
1171 description: Reference to naming policy that ECOMP will use when the name is auto-generated
1175 description: indicates operator-supplied name required (e.g. VID will present prompt to operator and collect the operator-supplied instance name).
1178 org.openecomp.datatypes.flavors.ComputeFlavor:
1179 derived_from: tosca.datatypes.Root
1184 type: scalar-unit.size
1186 type: scalar-unit.size
1187 org.openecomp.datatypes.flavors.LicenseFlavor:
1188 derived_from: tosca.datatypes.Root
1192 org.openecomp.datatypes.flavors.VendorInfo:
1193 derived_from: tosca.datatypes.Root
1195 manufacturer_reference_number:
1199 org.openecomp.datatypes.flavors.DeploymentFlavor:
1200 derived_from: tosca.datatypes.Root
1205 type: org.openecomp.datatypes.flavors.VendorInfo
1207 type: org.openecomp.datatypes.flavors.ComputeFlavor
1209 type: org.openecomp.datatypes.flavors.LicenseFlavor
1211 org.openecomp.datatypes.ImageInfo:
1212 derived_from: tosca.datatypes.Root
1220 description: checksum/signature
1225 tosca.datatypes.nfv.VnfcConfigurableProperties:
1226 derived_from: tosca.datatypes.Root
1228 additional_vnfc_configurable_properties:
1233 tosca.datatypes.nfv.RequestedAdditionalCapability:
1234 derived_from: tosca.datatypes.Root
1239 min_requested_additional_capability_version:
1242 preferred_requested_additional_capability_version:
1245 requested_additional_capability_name:
1248 target_performance_parameters:
1253 tosca.datatypes.nfv.VirtualMemory:
1254 derived_from: tosca.datatypes.Root
1257 type: scalar-unit.size
1259 virtual_mem_oversubscription_policy:
1265 tosca.datatypes.nfv.VirtualCpuPinning:
1266 derived_from: tosca.datatypes.Root
1280 tosca.datatypes.nfv.VirtualCpu:
1281 derived_from: tosca.datatypes.Root
1290 type: scalar-unit.frequency
1292 virtual_cpu_oversubscription_policy:
1295 virtual_cpu_pinning:
1296 type: tosca.datatypes.nfv.VirtualCpuPinning
1298 tosca.datatypes.nfv.VirtualNetworkInterfaceRequirements:
1299 derived_from: tosca.datatypes.Root
1313 tosca.datatypes.nfv.L2AddressData:
1314 derived_from: tosca.datatypes.Root
1319 tosca.datatypes.nfv.L3AddressData:
1320 derived_from: tosca.datatypes.Root
1322 ip_address_assignment:
1325 floating_ip_activated:
1335 number_of_ip_address:
1338 tosca.datatype.nfv.AddressData:
1348 type: tosca.datatypes.nfv.L2AddressData
1351 type: tosca.datatypes.nfv.L3AddressData
1352 tosca.datatypes.nfv.ConnectivityType:
1353 derived_from: tosca.datatypes.Root
1369 tosca.datatypes.nfv.VlFlavour:
1370 derived_from: tosca.datatypes.Root
1374 tosca.datatypes.nfv.ext.AddressPairs:
1382 tosca.datatypes.nfv.ext.FloatingIP:
1390 tosca.datatypes.nfv.ext.LocationInfo:
1401 tosca.datatypes.nfv.ext.HostRouteInfo:
1409 tosca.datatypes.nfv.ext.InjectData:
1417 tosca.datatypes.nfv.ext.zte.WatchDog:
1425 tosca.datatypes.nfv.ext.LocalAffinityOrAntiAffinityRule:
1430 affinity_antiaffinity: