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 tosca.datatypes.TimeInterval:
59 derived_from: tosca.datatypes.Root
68 tosca.datatypes.network.NetworkInfo:
69 derived_from: tosca.datatypes.Root
80 tosca.datatypes.network.PortInfo:
81 derived_from: tosca.datatypes.Root
96 tosca.datatypes.network.PortDef:
99 - in_range: [ 1, 65535 ]
101 tosca.datatypes.network.PortSpec:
102 derived_from: tosca.datatypes.Root
109 - valid_values: [ udp, tcp, igmp ]
111 type: tosca.datatypes.network.PortDef
115 - in_range: [ 1, 65535 ]
117 type: tosca.datatypes.network.PortDef
121 - in_range: [ 1, 65535 ]
123 ###################new Data Types Onboarding Integration##########################
125 org.openecomp.datatypes.heat.network.AddressPair:
126 derived_from: tosca.datatypes.Root
127 description: MAC/IP address pairs
131 description: MAC address
136 description: IP address
140 org.openecomp.datatypes.heat.network.subnet.HostRoute:
141 derived_from: tosca.datatypes.Root
142 description: Host route info for the subnet
146 description: The destination for static route
151 description: The next hop for the destination
155 org.openecomp.datatypes.heat.network.AllocationPool:
156 derived_from: tosca.datatypes.Root
157 description: The start and end addresses for the allocation pool
161 description: Start address for the allocation pool
166 description: End address for the allocation pool
170 org.openecomp.datatypes.heat.network.neutron.Subnet:
171 derived_from: tosca.datatypes.Root
172 description: A subnet represents an IP address block that can be used for assigning IP addresses to virtual instances
176 description: The ID of the tenant who owns the network
181 description: Set to true if DHCP is enabled and false if DHCP is disabled
187 description: IPv6 address mode
197 description: IPv6 RA (Router Advertisement) mode
207 description: Extra parameters to include in the request
216 description: The start and end addresses for the allocation pools
220 type: org.openecomp.datatypes.heat.network.AllocationPool
223 description: The name or ID of the subnet pool
228 description: A specified set of DNS name servers to be used
237 description: The gateway IP address
241 type: org.openecomp.datatypes.heat.network.subnet.HostRoute
244 description: The gateway IP address
254 description: The name of the subnet
259 description: Prefix length for subnet allocation from subnet pool
263 - greater_or_equal: 0
266 description: The CIDR
271 description: The gateway IP address
275 org.openecomp.datatypes.heat.novaServer.network.PortExtraProperties:
276 derived_from: tosca.datatypes.Root
277 description: Nova server network expand properties for port
279 port_security_enabled:
281 description: Flag to enable/disable port security on the port
286 description: MAC address to give to this port
291 description: The administrative state of this port
297 description: The name or ID of QoS policy to attach to this port
300 allowed_address_pairs:
302 description: Additional MAC/IP address pairs allowed to pass through the port
306 type: org.openecomp.datatypes.heat.network.AddressPair
309 description: The vnic type to be bound on the neutron port
319 description: Extra parameters to include in the request
327 org.openecomp.datatypes.heat.novaServer.network.AddressInfo:
328 derived_from: tosca.datatypes.network.NetworkInfo
329 description: Network addresses with corresponding port id
337 org.openecomp.datatypes.heat.neutron.port.FixedIps:
338 derived_from: tosca.datatypes.Root
339 description: subnet/ip_address
343 description: Subnet in which to allocate the IP address for this port
348 description: IP address desired in the subnet for this port
352 org.openecomp.datatypes.heat.FileInfo:
353 derived_from: tosca.datatypes.Root
354 description: Heat File Info
358 description: The required URI string (relative or absolute) which can be used to locate the file
363 description: The type of the file
373 org.openecomp.datatypes.heat.contrail.network.rule.PortPairs:
374 derived_from: tosca.datatypes.Root
375 description: source and destination port pairs
379 description: Start port
384 description: End port
388 org.openecomp.datatypes.heat.contrail.network.rule.Rule:
389 derived_from: tosca.datatypes.Root
390 description: policy rule
394 description: Source ports
398 type: org.openecomp.datatypes.heat.contrail.network.rule.PortPairs
401 description: Protocol
406 description: Destination addresses
410 type: org.openecomp.datatypes.heat.contrail.network.rule.VirtualNetwork
413 description: Service to apply
418 description: Destination ports
422 type: org.openecomp.datatypes.heat.contrail.network.rule.PortPairs
425 description: Source addresses
429 type: org.openecomp.datatypes.heat.contrail.network.rule.VirtualNetwork
432 description: Direction
436 org.openecomp.datatypes.heat.contrail.network.rule.RuleList:
437 derived_from: tosca.datatypes.Root
438 description: list of policy rules
442 description: Contrail network rule
446 type: org.openecomp.datatypes.heat.contrail.network.rule.Rule
448 org.openecomp.datatypes.heat.contrail.network.rule.VirtualNetwork:
449 derived_from: tosca.datatypes.Root
450 description: source and destination addresses
454 description: Virtual network
458 org.openecomp.datatypes.heat.network.neutron.SecurityRules.Rule:
459 derived_from: tosca.datatypes.Root
460 description: Rules Pairs
464 description: The remote group ID to be associated with this security group rule
469 description: The protocol that is matched by the security group rule
479 description: Ethertype of the traffic
489 description: 'The maximum port number in the range that is matched by the
490 security group rule. '
499 description: The remote IP prefix (CIDR) to be associated with this security group rule
504 description: Whether to specify a remote group or a remote IP prefix
506 default: remote_ip_prefix
514 description: The direction in which the security group rule is applied
524 description: The minimum port number in the range that is matched by the security group rule.
532 org.openecomp.datatypes.heat.substitution.SubstitutionFiltering:
533 derived_from: tosca.datatypes.Root
534 description: Substitution Filter
536 substitute_service_template:
538 description: Substitute Service Template
543 description: Index value of the substitution service template runtime instance
548 - greater_or_equal: 0
557 description: Indicates whether service scaling is enabled
563 description: Mandatory
568 org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.RefDataSequence:
569 derived_from: tosca.datatypes.Root
570 description: network policy refs data sequence
572 network_policy_refs_data_sequence_major:
574 description: Network Policy ref data sequence Major
577 network_policy_refs_data_sequence_minor:
579 description: Network Policy ref data sequence Minor
583 org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.RefData:
584 derived_from: tosca.datatypes.Root
585 description: network policy refs data
587 network_policy_refs_data_sequence:
588 type: org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.RefDataSequence
589 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
608 org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.ref.data.IpamSubnetList:
609 derived_from: tosca.datatypes.Root
610 description: Network Ipam Ref Data Subnet List
612 network_ipam_refs_data_ipam_subnets_subnet:
613 type: org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.ref.data.IpamSubnet
614 description: Network ipam refs data ipam subnets
617 network_ipam_refs_data_ipam_subnets_addr_from_start:
619 description: Network ipam refs data ipam subnets addr from start
623 org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.IpamRefData:
624 derived_from: tosca.datatypes.Root
625 description: Network Ipam Ref Data
627 network_ipam_refs_data_ipam_subnets:
629 description: Network ipam refs data ipam subnets
633 type: org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.ref.data.IpamSubnetList
635 org.openecomp.datatypes.heat.contrailV2.network.rule.SrcVirtualNetwork:
636 derived_from: tosca.datatypes.Root
637 description: source addresses
639 network_policy_entries_policy_rule_src_addresses_virtual_network:
641 description: Source addresses Virtual network
645 org.openecomp.datatypes.heat.contrailV2.network.rule.DstVirtualNetwork:
646 derived_from: tosca.datatypes.Root
647 description: destination addresses
649 network_policy_entries_policy_rule_dst_addresses_virtual_network:
651 description: Destination addresses Virtual network
655 org.openecomp.datatypes.heat.contrailV2.network.rule.DstPortPairs:
656 derived_from: tosca.datatypes.Root
657 description: destination port pairs
659 network_policy_entries_policy_rule_dst_ports_start_port:
661 description: Start port
664 network_policy_entries_policy_rule_dst_ports_end_port:
666 description: End port
670 org.openecomp.datatypes.heat.contrailV2.network.rule.SrcPortPairs:
671 derived_from: tosca.datatypes.Root
672 description: source port pairs
674 network_policy_entries_policy_rule_src_ports_start_port:
676 description: Start port
679 network_policy_entries_policy_rule_src_ports_end_port:
681 description: End port
685 org.openecomp.datatypes.heat.contrailV2.network.rule.ActionList:
686 derived_from: tosca.datatypes.Root
687 description: Action List
689 network_policy_entries_policy_rule_action_list_simple_action:
691 description: Simple Action
694 network_policy_entries_policy_rule_action_list_apply_service:
696 description: Apply Service
702 org.openecomp.datatypes.heat.contrailV2.network.rule.Rule:
703 derived_from: tosca.datatypes.Root
704 description: policy rule
706 network_policy_entries_policy_rule_dst_addresses:
708 description: Destination addresses
712 type: org.openecomp.datatypes.heat.contrailV2.network.rule.DstVirtualNetwork
713 network_policy_entries_policy_rule_dst_ports:
715 description: Destination ports
719 type: org.openecomp.datatypes.heat.contrailV2.network.rule.DstPortPairs
720 network_policy_entries_policy_rule_protocol:
722 description: Protocol
725 network_policy_entries_policy_rule_src_addresses:
727 description: Source addresses
731 type: org.openecomp.datatypes.heat.contrailV2.network.rule.SrcVirtualNetwork
732 network_policy_entries_policy_rule_direction:
734 description: Direction
737 network_policy_entries_policy_rule_src_ports:
739 description: Source ports
743 type: org.openecomp.datatypes.heat.contrailV2.network.rule.SrcPortPairs
744 network_policy_entries_policy_rule_action_list:
745 type: org.openecomp.datatypes.heat.contrailV2.network.rule.ActionList
746 description: Action list
750 org.openecomp.datatypes.heat.contrailV2.network.rule.RuleList:
751 derived_from: tosca.datatypes.Root
752 description: list of policy rules
754 network_policy_entries_policy_rule:
756 description: Contrail network rule
760 type: org.openecomp.datatypes.heat.contrailV2.network.rule.Rule
762 org.openecomp.datatypes.heat.network.contrail.port.StaticRoute:
763 derived_from: tosca.datatypes.Root
764 description: static route
768 description: Route prefix
773 description: Next hop
778 description: Next hop type
782 org.openecomp.datatypes.heat.network.contrail.AddressPair:
783 derived_from: tosca.datatypes.Root
784 description: Address Pair
788 description: Address mode active-active or active-standy
797 description: IP address prefix
802 description: Mac address
806 org.openecomp.datatypes.heat.network.contrail.InterfaceData:
807 derived_from: tosca.datatypes.Root
808 description: Interface Data
812 description: An ordered list of static routes to be added to this interface
816 type: org.openecomp.datatypes.heat.network.contrail.port.StaticRoute
819 description: Virtual Network for this interface
822 allowed_address_pairs:
824 description: List of allowed address pair for this interface
828 type: org.openecomp.datatypes.heat.network.contrail.AddressPair
831 description: IP for this interface
835 org.openecomp.datatypes.heat.contrailV2.virtual.machine.interface.Properties:
836 derived_from: tosca.datatypes.Root
837 description: Virtual Machine Interface Properties.
839 virtual_machine_interface_properties_service_interface_type:
841 description: Service Interface Type.
845 org.openecomp.datatypes.Root:
846 derived_from: tosca.datatypes.Root
848 The ECOMP root Data Type all other Data Types derive from
854 A placeholder for missing properties that would be included in future ecomp model versions.
858 org.openecomp.datatypes.AssignmentRequirements:
859 derived_from: org.openecomp.datatypes.Root
863 "true" indicates that assignment is required
868 description: number of assignments required
872 org.openecomp.datatypes.network.SubnetAssignments:
873 derived_from: org.openecomp.datatypes.Root
875 ip_network_address_plan:
878 description: Reference to EIPAM, VLAN or other address plan ID used to assign subnets to this network
882 description: \"true\" indicates the network has 1 or more policies
886 - valid_values: [4,6]
888 description: The IP version of the subnet
892 description: The default subnet CIDR mask
897 description: Quantity of subnets that must be initially assigned
899 org.openecomp.datatypes.network.IPv4SubnetAssignments:
900 derived_from: org.openecomp.datatypes.network.SubnetAssignments
905 description: Indicates IPv4 subnet assignments
907 org.openecomp.datatypes.network.IPv6SubnetAssignments:
908 derived_from: org.openecomp.datatypes.network.SubnetAssignments
913 description: Indicates IPv6 subnet assignments
915 org.openecomp.datatypes.network.NetworkAssignments:
916 derived_from: org.openecomp.datatypes.Root
918 ecomp_generated_network_assignment:
923 \"true\" indicates that the network assignments will be auto-generated by ECOMP
924 \"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).
928 description: \"true\" means this network is shared by multiple Openstack tenants
934 \"true\" means this Contrail external network
935 ipv4_subnet_default_assignment:
936 type: org.openecomp.datatypes.network.IPv4SubnetAssignments
938 description: IPv4 defualt subnet assignments
939 ipv6_subnet_default_assignment:
940 type: org.openecomp.datatypes.network.IPv6SubnetAssignments
942 description: IPv6 defualt subnet assignments
944 org.openecomp.datatypes.network.ProviderNetwork:
945 derived_from: org.openecomp.datatypes.Root
950 description: \"true\" indicates that this a Neutron provider type of network
951 physical_network_name:
955 - valid_values: ["Physnet41", "Physnet42", "Physnet43", "Physnet44", "Physnet21", "Physnet22"]
957 Identifies the NUMA processor cluster to which this physical network interface belongs.
958 NUMA instance correlates to the first digit of the Physical Network Name suffix (e.g. \"01\" = NUMA 0, \"11\" = NUMA 1)
963 - valid_values: ["NUMA 0", "NUMA 1"]
965 PNIC instance within the NUMA processor cluster
966 PNIC Instance correlates to the second digit of the Physical Network Name suffix (e.g. "01" = PNIC 1, "02" = "PNIC 2)
970 description: PNIC instance within the NUMA processor cluster
972 org.openecomp.datatypes.network.NetworkFlows:
973 derived_from: org.openecomp.datatypes.Root
979 description: \"true\" indicates the network has 1 or more policies
983 description: "Identifies the specific Cloud network policy that must be applied to this network (source: from Policy Manager)."
988 description: \"true\" indicates the network has 1 or more vpn bindings
992 description: "Identifies the specific VPN Binding entry in A&AI that must be applied when creating this network (source: A&AI)"
994 org.openecomp.datatypes.network.VlanRequirements:
995 derived_from: org.openecomp.datatypes.Root
1000 description: reference to a vlan range plan
1005 - valid_values: ["c-tag", "s-tag"]
1006 description: identifies the vlan type (e.g., c-tag)
1010 description: identifies the number of vlan tags to assign to the CP from the plan
1012 org.openecomp.datatypes.network.IpRequirements:
1013 derived_from: org.openecomp.datatypes.Root
1023 description: identifies the number of ip address to assign to the CP from the plan
1043 description: identifies the number of ip address to assign to the CP from the plan
1044 type: org.openecomp.datatypes.AssignmentRequirements
1046 floating_ip_count_required:
1047 type: org.openecomp.datatypes.AssignmentRequirements
1050 org.openecomp.datatypes.network.MacAssignments:
1051 derived_from: org.openecomp.datatypes.Root
1056 description: reference to a MAC address range plan
1060 description: identifies the number of MAC addresses to assign to the CP from the plan
1062 org.openecomp.datatypes.EcompHoming:
1063 derived_from: org.openecomp.datatypes.Root
1065 ecomp_selected_instance_node_target:
1070 \"true\" indicates that the target deployment node for this instance will be auto-selected by ECOMP
1071 \"false\" indicates operator-supplied instance target deployment node required (e.g. VID will present a prompt to operator and collect the
1072 operator-selected target node for the deployment of this Network instance).
1076 description: Referenc to a service level homing policy that ECOMP will use for instance deployment target node
1077 instance_node_target:
1080 description: Instance target deployment node
1082 org.openecomp.datatypes.EcompNaming:
1083 derived_from: org.openecomp.datatypes.Root
1085 ecomp_generated_naming:
1090 \"true\" indicates that the name for the instance will be auto-generated by ECOMP.
1091 \"false\" indicates operator-supplied name required (e.g. VID will present prompt to operator and collect the operator-supplied instance name).
1095 description: Referenc to naming policy that ECOMP will use when the name is auto-generated
1097 org.openecomp.datatypes.network.MacRequirements:
1098 derived_from: org.openecomp.datatypes.Root
1101 description: reference to a MAC address range plan
1105 description: identifies the number of MAC addresses to assign to the CP from the plan
1109 description: identifies the number of MAC addresses to assign to the CP from the plan
1110 type: org.openecomp.datatypes.AssignmentRequirements
1112 org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPairIp:
1113 derived_from: tosca.datatypes.Root
1114 description: Virtual Machine Sub Interface Address Pair IP.
1118 description: IP Prefix.
1123 description: IP Prefix Len.
1127 org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.MacAddress:
1128 derived_from: tosca.datatypes.Root
1129 description: Virtual Machine Sub Interface Mac Address.
1133 description: Mac Addresses List.
1139 org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.Properties:
1140 derived_from: tosca.datatypes.Root
1141 description: Virtual Machine Sub Interface VLAN Properties.
1143 sub_interface_vlan_tag:
1145 description: Sub Interface VLAN Tag.
1149 org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPair:
1150 derived_from: tosca.datatypes.Root
1151 description: Virtual Machine Sub Interface Address Pair.
1155 description: Address Mode.
1159 type: org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPairIp
1169 org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPairs:
1170 derived_from: tosca.datatypes.Root
1171 description: Virtual Machine Sub Interface Address Pairs.
1173 allowed_address_pair:
1175 description: Addresses pair List.
1179 type: org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPair
1181 org.openecomp.datatypes.Naming:
1182 derived_from: org.openecomp.datatypes.Root
1184 ecomp_generated_naming:
1186 "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).
1191 description: Reference to naming policy that ECOMP will use when the name is auto-generated
1195 description: indicates operator-supplied name required (e.g. VID will present prompt to operator and collect the operator-supplied instance name).