2 description: The TOSCA root Data Type all other TOSCA base Data Types derive from
5 derived_from: tosca.datatypes.Root
8 derived_from: tosca.datatypes.Root
11 derived_from: tosca.datatypes.Root
14 derived_from: tosca.datatypes.Root
17 derived_from: tosca.datatypes.Root
20 derived_from: tosca.datatypes.Root
23 derived_from: tosca.datatypes.Root
26 derived_from: tosca.datatypes.Root
29 derived_from: scalar-unit
32 derived_from: scalar-unit
34 scalar-unit.frequency:
35 derived_from: scalar-unit
38 tosca.datatypes.Credential:
39 derived_from: tosca.datatypes.Root
58 org.openecomp.datatypes.PortMirroringConnectionPointDescription:
59 derived_from: tosca.datatypes.Root
70 tosca.datatypes.TimeInterval:
71 derived_from: tosca.datatypes.Root
80 tosca.datatypes.network.NetworkInfo:
81 derived_from: tosca.datatypes.Root
92 tosca.datatypes.network.PortInfo:
93 derived_from: tosca.datatypes.Root
108 tosca.datatypes.network.PortDef:
109 derived_from: integer
111 - in_range: [ 1, 65535 ]
113 tosca.datatypes.network.PortSpec:
114 derived_from: tosca.datatypes.Root
121 - valid_values: [ udp, tcp, igmp ]
123 type: tosca.datatypes.network.PortDef
127 - in_range: [ 1, 65535 ]
129 type: tosca.datatypes.network.PortDef
133 - in_range: [ 1, 65535 ]
135 ###################new Data Types Onboarding Integration##########################
137 org.openecomp.datatypes.heat.network.AddressPair:
138 derived_from: tosca.datatypes.Root
139 description: MAC/IP address pairs
143 description: MAC address
148 description: IP address
152 org.openecomp.datatypes.heat.network.subnet.HostRoute:
153 derived_from: tosca.datatypes.Root
154 description: Host route info for the subnet
158 description: The destination for static route
163 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
182 org.openecomp.datatypes.heat.network.neutron.Subnet:
183 derived_from: tosca.datatypes.Root
184 description: A subnet represents an IP address block that can be used for assigning IP addresses to virtual instances
188 description: The ID of the tenant who owns the network
193 description: Set to true if DHCP is enabled and false if DHCP is disabled
199 description: IPv6 address mode
209 description: IPv6 RA (Router Advertisement) mode
219 description: Extra parameters to include in the request
228 description: The start and end addresses for the allocation pools
232 type: org.openecomp.datatypes.heat.network.AllocationPool
235 description: The name or ID of the subnet pool
240 description: A specified set of DNS name servers to be used
249 description: The gateway IP address
253 type: org.openecomp.datatypes.heat.network.subnet.HostRoute
256 description: The gateway IP address
266 description: The name of the subnet
271 description: Prefix length for subnet allocation from subnet pool
275 - greater_or_equal: 0
278 description: The CIDR
283 description: The gateway IP address
287 org.openecomp.datatypes.heat.novaServer.network.PortExtraProperties:
288 derived_from: tosca.datatypes.Root
289 description: Nova server network expand properties for port
291 port_security_enabled:
293 description: Flag to enable/disable port security on the port
298 description: MAC address to give to this port
303 description: The administrative state of this port
309 description: The name or ID of QoS policy to attach to this port
312 allowed_address_pairs:
314 description: Additional MAC/IP address pairs allowed to pass through the port
318 type: org.openecomp.datatypes.heat.network.AddressPair
321 description: The vnic type to be bound on the neutron port
331 description: Extra parameters to include in the request
339 org.openecomp.datatypes.heat.novaServer.network.AddressInfo:
340 derived_from: tosca.datatypes.network.NetworkInfo
341 description: Network addresses with corresponding port id
349 org.openecomp.datatypes.heat.neutron.port.FixedIps:
350 derived_from: tosca.datatypes.Root
351 description: subnet/ip_address
355 description: Subnet in which to allocate the IP address for this port
360 description: IP address desired in the subnet for this port
365 description: Subnet in which to allocate the IP address for this port
369 org.openecomp.datatypes.heat.FileInfo:
370 derived_from: tosca.datatypes.Root
371 description: Heat File Info
375 description: The required URI string (relative or absolute) which can be used to locate the file
380 description: The type of the file
390 org.openecomp.datatypes.heat.contrail.network.rule.PortPairs:
391 derived_from: tosca.datatypes.Root
392 description: source and destination port pairs
396 description: Start port
401 description: End port
405 org.openecomp.datatypes.heat.contrail.network.rule.Rule:
406 derived_from: tosca.datatypes.Root
407 description: policy rule
411 description: Source ports
415 type: org.openecomp.datatypes.heat.contrail.network.rule.PortPairs
418 description: Protocol
423 description: Destination addresses
427 type: org.openecomp.datatypes.heat.contrail.network.rule.VirtualNetwork
430 description: Service to apply
435 description: Destination ports
439 type: org.openecomp.datatypes.heat.contrail.network.rule.PortPairs
442 description: Source addresses
446 type: org.openecomp.datatypes.heat.contrail.network.rule.VirtualNetwork
449 description: Direction
453 org.openecomp.datatypes.heat.contrail.network.rule.RuleList:
454 derived_from: tosca.datatypes.Root
455 description: list of policy rules
459 description: Contrail network rule
463 type: org.openecomp.datatypes.heat.contrail.network.rule.Rule
465 org.openecomp.datatypes.heat.contrail.network.rule.VirtualNetwork:
466 derived_from: tosca.datatypes.Root
467 description: source and destination addresses
471 description: Virtual network
475 org.openecomp.datatypes.heat.network.neutron.SecurityRules.Rule:
476 derived_from: tosca.datatypes.Root
477 description: Rules Pairs
481 description: The remote group ID to be associated with this security group rule
486 description: The protocol that is matched by the security group rule
496 description: Ethertype of the traffic
506 description: 'The maximum port number in the range that is matched by the
507 security group rule. '
516 description: The remote IP prefix (CIDR) to be associated with this security group rule
521 description: Whether to specify a remote group or a remote IP prefix
523 default: remote_ip_prefix
531 description: The direction in which the security group rule is applied
541 description: The minimum port number in the range that is matched by the security group rule.
549 org.openecomp.datatypes.heat.substitution.SubstitutionFiltering:
550 derived_from: tosca.datatypes.Root
551 description: Substitution Filter
553 substitute_service_template:
555 description: Substitute Service Template
560 description: Index value of the substitution service template runtime instance
565 - greater_or_equal: 0
574 description: Indicates whether service scaling is enabled
580 description: Mandatory
585 org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.RefDataSequence:
586 derived_from: tosca.datatypes.Root
587 description: network policy refs data sequence
589 network_policy_refs_data_sequence_major:
591 description: Network Policy ref data sequence Major
594 network_policy_refs_data_sequence_minor:
596 description: Network Policy ref data sequence Minor
600 org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.RefData:
601 derived_from: tosca.datatypes.Root
602 description: network policy refs data
604 network_policy_refs_data_sequence:
605 type: org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.RefDataSequence
606 description: Network Policy ref data sequence
610 org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.ref.data.IpamSubnet:
611 derived_from: tosca.datatypes.Root
612 description: Network Ipam Ref Data Subnet
614 network_ipam_refs_data_ipam_subnets_subnet_ip_prefix_len:
616 description: Network ipam refs data ipam subnets ip prefix len
619 network_ipam_refs_data_ipam_subnets_subnet_ip_prefix:
621 description: Network ipam refs data ipam subnets ip prefix
625 org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.ref.data.IpamSubnetList:
626 derived_from: tosca.datatypes.Root
627 description: Network Ipam Ref Data Subnet List
629 network_ipam_refs_data_ipam_subnets_subnet:
630 type: org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.ref.data.IpamSubnet
631 description: Network ipam refs data ipam subnets
634 network_ipam_refs_data_ipam_subnets_addr_from_start:
636 description: Network ipam refs data ipam subnets addr from start
640 org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.IpamRefData:
641 derived_from: tosca.datatypes.Root
642 description: Network Ipam Ref Data
644 network_ipam_refs_data_ipam_subnets:
646 description: Network ipam refs data ipam subnets
650 type: org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.ref.data.IpamSubnetList
652 org.openecomp.datatypes.heat.contrailV2.network.rule.SrcVirtualNetwork:
653 derived_from: tosca.datatypes.Root
654 description: source addresses
656 network_policy_entries_policy_rule_src_addresses_virtual_network:
658 description: Source addresses Virtual network
662 org.openecomp.datatypes.heat.contrailV2.network.rule.DstVirtualNetwork:
663 derived_from: tosca.datatypes.Root
664 description: destination addresses
666 network_policy_entries_policy_rule_dst_addresses_virtual_network:
668 description: Destination addresses Virtual network
672 org.openecomp.datatypes.heat.contrailV2.network.rule.DstPortPairs:
673 derived_from: tosca.datatypes.Root
674 description: destination port pairs
676 network_policy_entries_policy_rule_dst_ports_start_port:
678 description: Start port
681 network_policy_entries_policy_rule_dst_ports_end_port:
683 description: End port
687 org.openecomp.datatypes.heat.contrailV2.network.rule.SrcPortPairs:
688 derived_from: tosca.datatypes.Root
689 description: source port pairs
691 network_policy_entries_policy_rule_src_ports_start_port:
693 description: Start port
696 network_policy_entries_policy_rule_src_ports_end_port:
698 description: End port
702 org.openecomp.datatypes.heat.contrailV2.network.rule.ActionList:
703 derived_from: tosca.datatypes.Root
704 description: Action List
706 network_policy_entries_policy_rule_action_list_simple_action:
708 description: Simple Action
711 network_policy_entries_policy_rule_action_list_apply_service:
713 description: Apply Service
719 org.openecomp.datatypes.heat.contrailV2.network.rule.Rule:
720 derived_from: tosca.datatypes.Root
721 description: policy rule
723 network_policy_entries_policy_rule_dst_addresses:
725 description: Destination addresses
729 type: org.openecomp.datatypes.heat.contrailV2.network.rule.DstVirtualNetwork
730 network_policy_entries_policy_rule_dst_ports:
732 description: Destination ports
736 type: org.openecomp.datatypes.heat.contrailV2.network.rule.DstPortPairs
737 network_policy_entries_policy_rule_protocol:
739 description: Protocol
742 network_policy_entries_policy_rule_src_addresses:
744 description: Source addresses
748 type: org.openecomp.datatypes.heat.contrailV2.network.rule.SrcVirtualNetwork
749 network_policy_entries_policy_rule_direction:
751 description: Direction
754 network_policy_entries_policy_rule_src_ports:
756 description: Source ports
760 type: org.openecomp.datatypes.heat.contrailV2.network.rule.SrcPortPairs
761 network_policy_entries_policy_rule_action_list:
762 type: org.openecomp.datatypes.heat.contrailV2.network.rule.ActionList
763 description: Action list
767 org.openecomp.datatypes.heat.contrailV2.network.rule.RuleList:
768 derived_from: tosca.datatypes.Root
769 description: list of policy rules
771 network_policy_entries_policy_rule:
773 description: Contrail network rule
777 type: org.openecomp.datatypes.heat.contrailV2.network.rule.Rule
779 org.openecomp.datatypes.heat.network.contrail.port.StaticRoute:
780 derived_from: tosca.datatypes.Root
781 description: static route
785 description: Route prefix
790 description: Next hop
795 description: Next hop type
799 org.openecomp.datatypes.heat.network.contrail.AddressPair:
800 derived_from: tosca.datatypes.Root
801 description: Address Pair
805 description: Address mode active-active or active-standy
814 description: IP address prefix
819 description: Mac address
823 org.openecomp.datatypes.heat.network.contrail.InterfaceData:
824 derived_from: tosca.datatypes.Root
825 description: Interface Data
829 description: An ordered list of static routes to be added to this interface
833 type: org.openecomp.datatypes.heat.network.contrail.port.StaticRoute
836 description: Virtual Network for this interface
839 allowed_address_pairs:
841 description: List of allowed address pair for this interface
845 type: org.openecomp.datatypes.heat.network.contrail.AddressPair
848 description: IP for this interface
852 org.openecomp.datatypes.heat.contrailV2.virtual.machine.interface.Properties:
853 derived_from: tosca.datatypes.Root
854 description: Virtual Machine Interface Properties.
856 virtual_machine_interface_properties_service_interface_type:
858 description: Service Interface Type.
862 org.openecomp.datatypes.Root:
863 derived_from: tosca.datatypes.Root
865 The ECOMP root Data Type all other Data Types derive from
872 A placeholder for missing properties that would be included in future ecomp model versions.
876 org.openecomp.datatypes.AssignmentRequirements:
877 derived_from: org.openecomp.datatypes.Root
881 "true" indicates that assignment is required
886 description: number of assignments required
890 org.openecomp.datatypes.network.SubnetAssignments:
891 derived_from: org.openecomp.datatypes.Root
893 ip_network_address_plan:
896 description: Reference to EIPAM, VLAN or other address plan ID used to assign subnets to this network
900 description: \"true\" indicates the network has 1 or more policies
904 - valid_values: [4,6]
906 description: The IP version of the subnet
910 description: The default subnet CIDR mask
915 description: Quantity of subnets that must be initially assigned
917 org.openecomp.datatypes.network.IPv4SubnetAssignments:
918 derived_from: org.openecomp.datatypes.network.SubnetAssignments
923 description: Indicates IPv4 subnet assignments
925 org.openecomp.datatypes.network.IPv6SubnetAssignments:
926 derived_from: org.openecomp.datatypes.network.SubnetAssignments
931 description: Indicates IPv6 subnet assignments
933 org.openecomp.datatypes.network.NetworkAssignments:
934 derived_from: org.openecomp.datatypes.Root
936 ecomp_generated_network_assignment:
941 \"true\" indicates that the network assignments will be auto-generated by ECOMP
942 \"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).
946 description: \"true\" means this network is shared by multiple Openstack tenants
952 \"true\" means this Contrail external network
953 ipv4_subnet_default_assignment:
954 type: org.openecomp.datatypes.network.IPv4SubnetAssignments
956 description: IPv4 defualt subnet assignments
957 ipv6_subnet_default_assignment:
958 type: org.openecomp.datatypes.network.IPv6SubnetAssignments
960 description: IPv6 defualt subnet assignments
962 org.openecomp.datatypes.network.ProviderNetwork:
963 derived_from: org.openecomp.datatypes.Root
968 description: \"true\" indicates that this a Neutron provider type of network
969 physical_network_name:
973 - valid_values: ["Physnet41", "Physnet42", "Physnet43", "Physnet44", "Physnet21", "Physnet22"]
975 Identifies the NUMA processor cluster to which this physical network interface belongs.
976 NUMA instance correlates to the first digit of the Physical Network Name suffix (e.g. \"01\" = NUMA 0, \"11\" = NUMA 1)
981 - valid_values: ["NUMA 0", "NUMA 1"]
983 PNIC instance within the NUMA processor cluster
984 PNIC Instance correlates to the second digit of the Physical Network Name suffix (e.g. "01" = PNIC 1, "02" = "PNIC 2)
988 description: PNIC instance within the NUMA processor cluster
990 org.openecomp.datatypes.network.NetworkFlows:
991 derived_from: org.openecomp.datatypes.Root
997 description: \"true\" indicates the network has 1 or more policies
1001 description: "Identifies the specific Cloud network policy that must be applied to this network (source: from Policy Manager)."
1006 description: \"true\" indicates the network has 1 or more vpn bindings
1010 description: "Identifies the specific VPN Binding entry in A&AI that must be applied when creating this network (source: A&AI)"
1012 org.openecomp.datatypes.network.VlanRequirements:
1013 derived_from: org.openecomp.datatypes.Root
1018 description: reference to a vlan range plan
1023 - valid_values: ["c-tag", "s-tag"]
1024 description: identifies the vlan type (e.g., c-tag)
1028 description: identifies the number of vlan tags to assign to the CP from the plan
1030 org.openecomp.datatypes.network.IpRequirements:
1031 derived_from: org.openecomp.datatypes.Root
1041 description: identifies the number of ip address to assign to the CP from the plan
1061 description: identifies the number of ip address to assign to the CP from the plan
1062 type: org.openecomp.datatypes.AssignmentRequirements
1064 floating_ip_count_required:
1065 type: org.openecomp.datatypes.AssignmentRequirements
1067 ip_address_plan_name:
1074 org.openecomp.datatypes.network.MacAssignments:
1075 derived_from: org.openecomp.datatypes.Root
1080 description: reference to a MAC address range plan
1084 description: identifies the number of MAC addresses to assign to the CP from the plan
1086 org.openecomp.datatypes.EcompHoming:
1087 derived_from: org.openecomp.datatypes.Root
1089 ecomp_selected_instance_node_target:
1094 \"true\" indicates that the target deployment node for this instance will be auto-selected by ECOMP
1095 \"false\" indicates operator-supplied instance target deployment node required (e.g. VID will present a prompt to operator and collect the
1096 operator-selected target node for the deployment of this Network instance).
1100 description: Referenc to a service level homing policy that ECOMP will use for instance deployment target node
1101 instance_node_target:
1104 description: Instance target deployment node
1106 org.openecomp.datatypes.EcompNaming:
1107 derived_from: org.openecomp.datatypes.Root
1109 ecomp_generated_naming:
1114 \"true\" indicates that the name for the instance will be auto-generated by ECOMP.
1115 \"false\" indicates operator-supplied name required (e.g. VID will present prompt to operator and collect the operator-supplied instance name).
1119 description: Referenc to naming policy that ECOMP will use when the name is auto-generated
1121 org.openecomp.datatypes.network.MacRequirements:
1122 derived_from: org.openecomp.datatypes.Root
1125 description: reference to a MAC address range plan
1129 description: identifies the number of MAC addresses to assign to the CP from the plan
1133 description: identifies the number of MAC addresses to assign to the CP from the plan
1134 type: org.openecomp.datatypes.AssignmentRequirements
1136 org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPairIp:
1137 derived_from: tosca.datatypes.Root
1138 description: Virtual Machine Sub Interface Address Pair IP.
1142 description: IP Prefix.
1147 description: IP Prefix Len.
1151 org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.MacAddress:
1152 derived_from: tosca.datatypes.Root
1153 description: Virtual Machine Sub Interface Mac Address.
1157 description: Mac Addresses List.
1163 org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.Properties:
1164 derived_from: tosca.datatypes.Root
1165 description: Virtual Machine Sub Interface VLAN Properties.
1167 sub_interface_vlan_tag:
1169 description: Sub Interface VLAN Tag.
1173 org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPair:
1174 derived_from: tosca.datatypes.Root
1175 description: Virtual Machine Sub Interface Address Pair.
1179 description: Address Mode.
1183 type: org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPairIp
1193 org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPairs:
1194 derived_from: tosca.datatypes.Root
1195 description: Virtual Machine Sub Interface Address Pairs.
1197 allowed_address_pair:
1199 description: Addresses pair List.
1203 type: org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPair
1205 org.openecomp.datatypes.Naming:
1206 derived_from: org.openecomp.datatypes.Root
1208 ecomp_generated_naming:
1210 "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).
1215 description: Reference to naming policy that ECOMP will use when the name is auto-generated
1219 description: indicates operator-supplied name required (e.g. VID will present prompt to operator and collect the operator-supplied instance name).
1224 org.openecomp.datatypes.flavors.ComputeFlavor:
1225 derived_from: tosca.datatypes.Root
1230 type: scalar-unit.size
1232 type: scalar-unit.size
1234 org.openecomp.datatypes.flavors.LicenseFlavor:
1235 derived_from: tosca.datatypes.Root
1240 org.openecomp.datatypes.flavors.VendorInfo:
1241 derived_from: tosca.datatypes.Root
1243 manufacturer_reference_number:
1248 org.openecomp.datatypes.flavors.DeploymentFlavor:
1249 derived_from: tosca.datatypes.Root
1254 type: org.openecomp.datatypes.flavors.VendorInfo
1256 type: org.openecomp.datatypes.flavors.ComputeFlavor
1258 type: org.openecomp.datatypes.flavors.LicenseFlavor
1261 org.openecomp.datatypes.ImageInfo:
1262 derived_from: tosca.datatypes.Root
1270 description: checksum/signature
1276 tosca.datatypes.nfv.VnfcConfigurableProperties:
1277 derived_from: tosca.datatypes.Root
1279 additional_vnfc_configurable_properties:
1284 tosca.datatypes.nfv.RequestedAdditionalCapability:
1285 derived_from: tosca.datatypes.Root
1288 # key of containing map
1292 min_requested_additional_capability_version:
1295 preferred_requested_additional_capability_version:
1298 requested_additional_capability_name:
1301 target_performance_parameters:
1306 tosca.datatypes.nfv.VirtualMemory:
1307 derived_from: tosca.datatypes.Root
1311 type: scalar-unit.size
1313 virtual_mem_oversubscription_policy:
1319 tosca.datatypes.nfv.VirtualCpuPinning:
1320 derived_from: tosca.datatypes.Root
1323 type: string # CpuPinningPolicy
1325 - valid_values: [ static, dynamic ]
1332 tosca.datatypes.nfv.VirtualCpu:
1333 derived_from: tosca.datatypes.Root
1342 type: scalar-unit.frequency
1344 virtual_cpu_oversubscription_policy:
1347 virtual_cpu_pinning:
1348 type: tosca.datatypes.nfv.VirtualCpuPinning
1350 tosca.datatypes.nfv.VirtualNetworkInterfaceRequirements:
1351 derived_from: tosca.datatypes.Root
1363 type: string # not specified
1365 tosca.datatypes.nfv.L2AddressData:
1366 derived_from: tosca.datatypes.Root
1371 tosca.datatypes.nfv.L3AddressData:
1372 derived_from: tosca.datatypes.Root
1374 ip_address_assignment:
1377 floating_ip_activated:
1384 - valid_values: [ipv4, ipv6]
1385 number_of_ip_address:
1388 tosca.datatype.nfv.AddressData:
1398 type: tosca.datatypes.nfv.L2AddressData
1401 type: tosca.datatypes.nfv.L3AddressData
1402 tosca.datatypes.nfv.ConnectivityType:
1403 derived_from: tosca.datatypes.Root
1409 - valid_values: [ethernet, mpls, odu2, ipv4, ipv6, pseudo_wire ]
1413 tosca.datatypes.nfv.VlFlavour:
1414 derived_from: tosca.datatypes.Root
1418 tosca.datatypes.nfv.ext.AddressPairs:
1426 tosca.datatypes.nfv.ext.FloatingIP:
1434 tosca.datatypes.nfv.ext.LocationInfo:
1445 tosca.datatypes.nfv.ext.HostRouteInfo:
1454 tosca.datatypes.nfv.ext.InjectData:
1462 tosca.datatypes.nfv.ext.zte.WatchDog:
1470 tosca.datatypes.nfv.ext.LocalAffinityOrAntiAffinityRule:
1475 affinity_antiaffinity: