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 derived_from: scalar-unit
40 tosca.datatypes.Credential:
41 derived_from: tosca.datatypes.Root
60 tosca.datatypes.TimeInterval:
61 derived_from: tosca.datatypes.Root
70 tosca.datatypes.network.NetworkInfo:
71 derived_from: tosca.datatypes.Root
82 tosca.datatypes.network.PortInfo:
83 derived_from: tosca.datatypes.Root
98 tosca.datatypes.network.PortDef:
101 - in_range: [ 1, 65535 ]
103 tosca.datatypes.network.PortSpec:
104 derived_from: tosca.datatypes.Root
111 - valid_values: [ udp, tcp, igmp ]
113 type: tosca.datatypes.network.PortDef
117 - in_range: [ 1, 65535 ]
119 type: tosca.datatypes.network.PortDef
123 - in_range: [ 1, 65535 ]
125 ###################new Data Types Onboarding Integration##########################
127 org.openecomp.datatypes.heat.network.AddressPair:
128 derived_from: tosca.datatypes.Root
129 description: MAC/IP address pairs
133 description: MAC address
138 description: IP address
142 org.openecomp.datatypes.heat.network.subnet.HostRoute:
143 derived_from: tosca.datatypes.Root
144 description: Host route info for the subnet
148 description: The destination for static route
153 description: The next hop for the destination
157 org.openecomp.datatypes.heat.network.AllocationPool:
158 derived_from: tosca.datatypes.Root
159 description: The start and end addresses for the allocation pool
163 description: Start address for the allocation pool
168 description: End address for the allocation pool
172 org.openecomp.datatypes.heat.network.neutron.Subnet:
173 derived_from: tosca.datatypes.Root
174 description: A subnet represents an IP address block that can be used for assigning IP addresses to virtual instances
178 description: The ID of the tenant who owns the network
183 description: Set to true if DHCP is enabled and false if DHCP is disabled
189 description: IPv6 address mode
199 description: IPv6 RA (Router Advertisement) mode
209 description: Extra parameters to include in the request
218 description: The start and end addresses for the allocation pools
222 type: org.openecomp.datatypes.heat.network.AllocationPool
225 description: The name or ID of the subnet pool
230 description: A specified set of DNS name servers to be used
239 description: The gateway IP address
243 type: org.openecomp.datatypes.heat.network.subnet.HostRoute
246 description: The gateway IP address
256 description: The name of the subnet
261 description: Prefix length for subnet allocation from subnet pool
265 - greater_or_equal: 0
268 description: The CIDR
273 description: The gateway IP address
277 org.openecomp.datatypes.heat.novaServer.network.PortExtraProperties:
278 derived_from: tosca.datatypes.Root
279 description: Nova server network expand properties for port
281 port_security_enabled:
283 description: Flag to enable/disable port security on the port
288 description: MAC address to give to this port
293 description: The administrative state of this port
299 description: The name or ID of QoS policy to attach to this port
302 allowed_address_pairs:
304 description: Additional MAC/IP address pairs allowed to pass through the port
308 type: org.openecomp.datatypes.heat.network.AddressPair
311 description: The vnic type to be bound on the neutron port
321 description: Extra parameters to include in the request
329 org.openecomp.datatypes.heat.novaServer.network.AddressInfo:
330 derived_from: tosca.datatypes.network.NetworkInfo
331 description: Network addresses with corresponding port id
339 org.openecomp.datatypes.heat.neutron.port.FixedIps:
340 derived_from: tosca.datatypes.Root
341 description: subnet/ip_address
345 description: Subnet in which to allocate the IP address for this port
350 description: IP address desired in the subnet for this port
354 org.openecomp.datatypes.heat.FileInfo:
355 derived_from: tosca.datatypes.Root
356 description: Heat File Info
360 description: The required URI string (relative or absolute) which can be used to locate the file
365 description: The type of the file
375 org.openecomp.datatypes.heat.contrail.network.rule.PortPairs:
376 derived_from: tosca.datatypes.Root
377 description: source and destination port pairs
381 description: Start port
386 description: End port
390 org.openecomp.datatypes.heat.contrail.network.rule.Rule:
391 derived_from: tosca.datatypes.Root
392 description: policy rule
396 description: Source ports
400 type: org.openecomp.datatypes.heat.contrail.network.rule.PortPairs
403 description: Protocol
408 description: Destination addresses
412 type: org.openecomp.datatypes.heat.contrail.network.rule.VirtualNetwork
415 description: Service to apply
420 description: Destination ports
424 type: org.openecomp.datatypes.heat.contrail.network.rule.PortPairs
427 description: Source addresses
431 type: org.openecomp.datatypes.heat.contrail.network.rule.VirtualNetwork
434 description: Direction
438 org.openecomp.datatypes.heat.contrail.network.rule.RuleList:
439 derived_from: tosca.datatypes.Root
440 description: list of policy rules
444 description: Contrail network rule
448 type: org.openecomp.datatypes.heat.contrail.network.rule.Rule
450 org.openecomp.datatypes.heat.contrail.network.rule.VirtualNetwork:
451 derived_from: tosca.datatypes.Root
452 description: source and destination addresses
456 description: Virtual network
460 org.openecomp.datatypes.heat.network.neutron.SecurityRules.Rule:
461 derived_from: tosca.datatypes.Root
462 description: Rules Pairs
466 description: The remote group ID to be associated with this security group rule
471 description: The protocol that is matched by the security group rule
481 description: Ethertype of the traffic
491 description: 'The maximum port number in the range that is matched by the
492 security group rule. '
501 description: The remote IP prefix (CIDR) to be associated with this security group rule
506 description: Whether to specify a remote group or a remote IP prefix
508 default: remote_ip_prefix
516 description: The direction in which the security group rule is applied
526 description: The minimum port number in the range that is matched by the security group rule.
534 org.openecomp.datatypes.heat.substitution.SubstitutionFiltering:
535 derived_from: tosca.datatypes.Root
536 description: Substitution Filter
538 substitute_service_template:
540 description: Substitute Service Template
545 description: Index value of the substitution service template runtime instance
550 - greater_or_equal: 0
559 description: Indicates whether service scaling is enabled
565 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
585 org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.RefData:
586 derived_from: tosca.datatypes.Root
587 description: network policy refs data
589 network_policy_refs_data_sequence:
590 type: org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.RefDataSequence
591 description: Network Policy ref data sequence
595 org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.ref.data.IpamSubnet:
596 derived_from: tosca.datatypes.Root
597 description: Network Ipam Ref Data Subnet
599 network_ipam_refs_data_ipam_subnets_subnet_ip_prefix_len:
601 description: Network ipam refs data ipam subnets ip prefix len
604 network_ipam_refs_data_ipam_subnets_subnet_ip_prefix:
606 description: Network ipam refs data ipam subnets ip prefix
610 org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.ref.data.IpamSubnetList:
611 derived_from: tosca.datatypes.Root
612 description: Network Ipam Ref Data Subnet List
614 network_ipam_refs_data_ipam_subnets_subnet:
615 type: org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.ref.data.IpamSubnet
616 description: Network ipam refs data ipam subnets
619 network_ipam_refs_data_ipam_subnets_addr_from_start:
621 description: Network ipam refs data ipam subnets addr from start
625 org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.IpamRefData:
626 derived_from: tosca.datatypes.Root
627 description: Network Ipam Ref Data
629 network_ipam_refs_data_ipam_subnets:
631 description: Network ipam refs data ipam subnets
635 type: org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.ref.data.IpamSubnetList
637 org.openecomp.datatypes.heat.contrailV2.network.rule.SrcVirtualNetwork:
638 derived_from: tosca.datatypes.Root
639 description: source addresses
641 network_policy_entries_policy_rule_src_addresses_virtual_network:
643 description: Source addresses Virtual network
647 org.openecomp.datatypes.heat.contrailV2.network.rule.DstVirtualNetwork:
648 derived_from: tosca.datatypes.Root
649 description: destination addresses
651 network_policy_entries_policy_rule_dst_addresses_virtual_network:
653 description: Destination addresses Virtual network
657 org.openecomp.datatypes.heat.contrailV2.network.rule.DstPortPairs:
658 derived_from: tosca.datatypes.Root
659 description: destination port pairs
661 network_policy_entries_policy_rule_dst_ports_start_port:
663 description: Start port
666 network_policy_entries_policy_rule_dst_ports_end_port:
668 description: End port
672 org.openecomp.datatypes.heat.contrailV2.network.rule.SrcPortPairs:
673 derived_from: tosca.datatypes.Root
674 description: source port pairs
676 network_policy_entries_policy_rule_src_ports_start_port:
678 description: Start port
681 network_policy_entries_policy_rule_src_ports_end_port:
683 description: End port
687 org.openecomp.datatypes.heat.contrailV2.network.rule.ActionList:
688 derived_from: tosca.datatypes.Root
689 description: Action List
691 network_policy_entries_policy_rule_action_list_simple_action:
693 description: Simple Action
696 network_policy_entries_policy_rule_action_list_apply_service:
698 description: Apply Service
704 org.openecomp.datatypes.heat.contrailV2.network.rule.Rule:
705 derived_from: tosca.datatypes.Root
706 description: policy rule
708 network_policy_entries_policy_rule_dst_addresses:
710 description: Destination addresses
714 type: org.openecomp.datatypes.heat.contrailV2.network.rule.DstVirtualNetwork
715 network_policy_entries_policy_rule_dst_ports:
717 description: Destination ports
721 type: org.openecomp.datatypes.heat.contrailV2.network.rule.DstPortPairs
722 network_policy_entries_policy_rule_protocol:
724 description: Protocol
727 network_policy_entries_policy_rule_src_addresses:
729 description: Source addresses
733 type: org.openecomp.datatypes.heat.contrailV2.network.rule.SrcVirtualNetwork
734 network_policy_entries_policy_rule_direction:
736 description: Direction
739 network_policy_entries_policy_rule_src_ports:
741 description: Source ports
745 type: org.openecomp.datatypes.heat.contrailV2.network.rule.SrcPortPairs
746 network_policy_entries_policy_rule_action_list:
747 type: org.openecomp.datatypes.heat.contrailV2.network.rule.ActionList
748 description: Action list
752 org.openecomp.datatypes.heat.contrailV2.network.rule.RuleList:
753 derived_from: tosca.datatypes.Root
754 description: list of policy rules
756 network_policy_entries_policy_rule:
758 description: Contrail network rule
762 type: org.openecomp.datatypes.heat.contrailV2.network.rule.Rule
764 org.openecomp.datatypes.heat.network.contrail.port.StaticRoute:
765 derived_from: tosca.datatypes.Root
766 description: static route
770 description: Route prefix
775 description: Next hop
780 description: Next hop type
784 org.openecomp.datatypes.heat.network.contrail.AddressPair:
785 derived_from: tosca.datatypes.Root
786 description: Address Pair
790 description: Address mode active-active or active-standy
799 description: IP address prefix
804 description: Mac address
808 org.openecomp.datatypes.heat.network.contrail.InterfaceData:
809 derived_from: tosca.datatypes.Root
810 description: Interface Data
814 description: An ordered list of static routes to be added to this interface
818 type: org.openecomp.datatypes.heat.network.contrail.port.StaticRoute
821 description: Virtual Network for this interface
824 allowed_address_pairs:
826 description: List of allowed address pair for this interface
830 type: org.openecomp.datatypes.heat.network.contrail.AddressPair
833 description: IP for this interface
837 org.openecomp.datatypes.heat.contrailV2.virtual.machine.interface.Properties:
838 derived_from: tosca.datatypes.Root
839 description: Virtual Machine Interface Properties.
841 virtual_machine_interface_properties_service_interface_type:
843 description: Service Interface Type.
847 org.openecomp.datatypes.Root:
848 derived_from: tosca.datatypes.Root
850 The ECOMP root Data Type all other Data Types derive from
856 A placeholder for missing properties that would be included in future ecomp model versions.
860 org.openecomp.datatypes.AssignmentRequirements:
861 derived_from: org.openecomp.datatypes.Root
865 "true" indicates that assignment is required
870 description: number of assignments required
874 org.openecomp.datatypes.network.SubnetAssignments:
875 derived_from: org.openecomp.datatypes.Root
877 ip_network_address_plan:
880 description: Reference to EIPAM, VLAN or other address plan ID used to assign subnets to this network
884 description: \"true\" indicates the network has 1 or more policies
888 - valid_values: [4,6]
890 description: The IP version of the subnet
894 description: The default subnet CIDR mask
899 description: Quantity of subnets that must be initially assigned
901 org.openecomp.datatypes.network.IPv4SubnetAssignments:
902 derived_from: org.openecomp.datatypes.network.SubnetAssignments
907 description: Indicates IPv4 subnet assignments
909 org.openecomp.datatypes.network.IPv6SubnetAssignments:
910 derived_from: org.openecomp.datatypes.network.SubnetAssignments
915 description: Indicates IPv6 subnet assignments
917 org.openecomp.datatypes.network.NetworkAssignments:
918 derived_from: org.openecomp.datatypes.Root
920 ecomp_generated_network_assignment:
925 \"true\" indicates that the network assignments will be auto-generated by ECOMP
926 \"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).
930 description: \"true\" means this network is shared by multiple Openstack tenants
936 \"true\" means this Contrail external network
937 ipv4_subnet_default_assignment:
938 type: org.openecomp.datatypes.network.IPv4SubnetAssignments
940 description: IPv4 defualt subnet assignments
941 ipv6_subnet_default_assignment:
942 type: org.openecomp.datatypes.network.IPv6SubnetAssignments
944 description: IPv6 defualt subnet assignments
946 org.openecomp.datatypes.network.ProviderNetwork:
947 derived_from: org.openecomp.datatypes.Root
952 description: \"true\" indicates that this a Neutron provider type of network
953 physical_network_name:
957 - valid_values: ["Physnet41", "Physnet42", "Physnet43", "Physnet44", "Physnet21", "Physnet22"]
959 Identifies the NUMA processor cluster to which this physical network interface belongs.
960 NUMA instance correlates to the first digit of the Physical Network Name suffix (e.g. \"01\" = NUMA 0, \"11\" = NUMA 1)
965 - valid_values: ["NUMA 0", "NUMA 1"]
967 PNIC instance within the NUMA processor cluster
968 PNIC Instance correlates to the second digit of the Physical Network Name suffix (e.g. "01" = PNIC 1, "02" = "PNIC 2)
972 description: PNIC instance within the NUMA processor cluster
974 org.openecomp.datatypes.network.NetworkFlows:
975 derived_from: org.openecomp.datatypes.Root
981 description: \"true\" indicates the network has 1 or more policies
985 description: "Identifies the specific Cloud network policy that must be applied to this network (source: from Policy Manager)."
990 description: \"true\" indicates the network has 1 or more vpn bindings
994 description: "Identifies the specific VPN Binding entry in A&AI that must be applied when creating this network (source: A&AI)"
996 org.openecomp.datatypes.network.VlanRequirements:
997 derived_from: org.openecomp.datatypes.Root
1002 description: reference to a vlan range plan
1007 - valid_values: ["c-tag", "s-tag"]
1008 description: identifies the vlan type (e.g., c-tag)
1012 description: identifies the number of vlan tags to assign to the CP from the plan
1014 org.openecomp.datatypes.network.IpRequirements:
1015 derived_from: org.openecomp.datatypes.Root
1025 description: identifies the number of ip address to assign to the CP from the plan
1045 description: identifies the number of ip address to assign to the CP from the plan
1046 type: org.openecomp.datatypes.AssignmentRequirements
1048 floating_ip_count_required:
1049 type: org.openecomp.datatypes.AssignmentRequirements
1052 org.openecomp.datatypes.network.MacAssignments:
1053 derived_from: org.openecomp.datatypes.Root
1058 description: reference to a MAC address range plan
1062 description: identifies the number of MAC addresses to assign to the CP from the plan
1064 org.openecomp.datatypes.EcompHoming:
1065 derived_from: org.openecomp.datatypes.Root
1067 ecomp_selected_instance_node_target:
1072 \"true\" indicates that the target deployment node for this instance will be auto-selected by ECOMP
1073 \"false\" indicates operator-supplied instance target deployment node required (e.g. VID will present a prompt to operator and collect the
1074 operator-selected target node for the deployment of this Network instance).
1078 description: Referenc to a service level homing policy that ECOMP will use for instance deployment target node
1079 instance_node_target:
1082 description: Instance target deployment node
1084 org.openecomp.datatypes.EcompNaming:
1085 derived_from: org.openecomp.datatypes.Root
1087 ecomp_generated_naming:
1092 \"true\" indicates that the name for the instance will be auto-generated by ECOMP.
1093 \"false\" indicates operator-supplied name required (e.g. VID will present prompt to operator and collect the operator-supplied instance name).
1097 description: Referenc to naming policy that ECOMP will use when the name is auto-generated
1099 org.openecomp.datatypes.network.MacRequirements:
1100 derived_from: org.openecomp.datatypes.Root
1103 description: reference to a MAC address range plan
1107 description: identifies the number of MAC addresses to assign to the CP from the plan
1111 description: identifies the number of MAC addresses to assign to the CP from the plan
1112 type: org.openecomp.datatypes.AssignmentRequirements
1114 org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPairIp:
1115 derived_from: tosca.datatypes.Root
1116 description: Virtual Machine Sub Interface Address Pair IP.
1120 description: IP Prefix.
1125 description: IP Prefix Len.
1129 org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.MacAddress:
1130 derived_from: tosca.datatypes.Root
1131 description: Virtual Machine Sub Interface Mac Address.
1135 description: Mac Addresses List.
1141 org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.Properties:
1142 derived_from: tosca.datatypes.Root
1143 description: Virtual Machine Sub Interface VLAN Properties.
1145 sub_interface_vlan_tag:
1147 description: Sub Interface VLAN Tag.
1151 org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPair:
1152 derived_from: tosca.datatypes.Root
1153 description: Virtual Machine Sub Interface Address Pair.
1157 description: Address Mode.
1161 type: org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPairIp
1171 org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPairs:
1172 derived_from: tosca.datatypes.Root
1173 description: Virtual Machine Sub Interface Address Pairs.
1175 allowed_address_pair:
1177 description: Addresses pair List.
1181 type: org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPair
1183 org.openecomp.datatypes.Naming:
1184 derived_from: org.openecomp.datatypes.Root
1186 ecomp_generated_naming:
1188 "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).
1193 description: Reference to naming policy that ECOMP will use when the name is auto-generated
1197 description: indicates operator-supplied name required (e.g. VID will present prompt to operator and collect the operator-supplied instance name).