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
22 tosca.datatypes.Credential:
23 derived_from: tosca.datatypes.Root
42 tosca.datatypes.TimeInterval:
43 derived_from: tosca.datatypes.Root
52 tosca.datatypes.network.NetworkInfo:
53 derived_from: tosca.datatypes.Root
64 tosca.datatypes.network.PortInfo:
65 derived_from: tosca.datatypes.Root
80 tosca.datatypes.network.PortDef:
83 - in_range: [ 1, 65535 ]
85 tosca.datatypes.network.PortSpec:
86 derived_from: tosca.datatypes.Root
93 - valid_values: [ udp, tcp, igmp ]
95 type: tosca.datatypes.network.PortDef
99 - in_range: [ 1, 65535 ]
101 type: tosca.datatypes.network.PortDef
105 - in_range: [ 1, 65535 ]
107 ###################new Data Types Onboarding Integration##########################
109 org.openecomp.datatypes.heat.network.AddressPair:
110 derived_from: tosca.datatypes.Root
111 description: MAC/IP address pairs
115 description: MAC address
120 description: IP address
123 org.openecomp.datatypes.heat.network.subnet.HostRoute:
124 derived_from: tosca.datatypes.Root
125 description: Host route info for the subnet
129 description: The destination for static route
134 description: The next hop for the destination
138 org.openecomp.datatypes.heat.network.AllocationPool:
139 derived_from: tosca.datatypes.Root
140 description: The start and end addresses for the allocation pool
144 description: Start address for the allocation pool
149 description: End address for the allocation pool
153 org.openecomp.datatypes.heat.network.neutron.Subnet:
154 derived_from: tosca.datatypes.Root
155 description: A subnet represents an IP address block that can be used for assigning IP addresses to virtual instances
159 description: The ID of the tenant who owns the network
164 description: Set to true if DHCP is enabled and false if DHCP is disabled
170 description: IPv6 address mode
180 description: IPv6 RA (Router Advertisement) mode
190 description: Extra parameters to include in the request
199 description: The start and end addresses for the allocation pools
203 type: org.openecomp.datatypes.heat.network.AllocationPool
206 description: The name or ID of the subnet pool
211 description: A specified set of DNS name servers to be used
220 description: The gateway IP address
224 type: org.openecomp.datatypes.heat.network.subnet.HostRoute
227 description: The gateway IP address
237 description: The name of the subnet
242 description: Prefix length for subnet allocation from subnet pool
246 - greater_or_equal: 0
249 description: The CIDR
254 description: The gateway IP address
258 org.openecomp.datatypes.heat.novaServer.network.PortExtraProperties:
259 derived_from: tosca.datatypes.Root
260 description: Nova server network expand properties for port
262 port_security_enabled:
264 description: Flag to enable/disable port security on the port
269 description: MAC address to give to this port
274 description: The administrative state of this port
280 description: The name or ID of QoS policy to attach to this port
283 allowed_address_pairs:
285 description: Additional MAC/IP address pairs allowed to pass through the port
289 type: org.openecomp.datatypes.heat.network.AddressPair
292 description: The vnic type to be bound on the neutron port
302 description: Extra parameters to include in the request
309 org.openecomp.datatypes.heat.novaServer.network.AddressInfo:
310 derived_from: tosca.datatypes.network.NetworkInfo
311 description: Network addresses with corresponding port id
318 org.openecomp.datatypes.heat.neutron.port.FixedIps:
319 derived_from: tosca.datatypes.Root
320 description: subnet/ip_address
324 description: Subnet in which to allocate the IP address for this port
329 description: IP address desired in the subnet for this port
332 org.openecomp.datatypes.heat.FileInfo:
333 derived_from: tosca.datatypes.Root
334 description: Heat File Info
338 description: The required URI string (relative or absolute) which can be used to locate the file
343 description: The type of the file
352 org.openecomp.datatypes.heat.contrail.network.rule.PortPairs:
353 derived_from: tosca.datatypes.Root
354 description: source and destination port pairs
358 description: Start port
363 description: End port
366 org.openecomp.datatypes.heat.contrail.network.rule.Rule:
367 derived_from: tosca.datatypes.Root
368 description: policy rule
372 description: Source ports
376 type: org.openecomp.datatypes.heat.contrail.network.rule.PortPairs
379 description: Protocol
384 description: Destination addresses
388 type: org.openecomp.datatypes.heat.contrail.network.rule.VirtualNetwork
391 description: Service to apply
396 description: Destination ports
400 type: org.openecomp.datatypes.heat.contrail.network.rule.PortPairs
403 description: Source addresses
407 type: org.openecomp.datatypes.heat.contrail.network.rule.VirtualNetwork
410 description: Direction
413 org.openecomp.datatypes.heat.contrail.network.rule.RuleList:
414 derived_from: tosca.datatypes.Root
415 description: list of policy rules
419 description: Contrail network rule
423 type: org.openecomp.datatypes.heat.contrail.network.rule.Rule
424 org.openecomp.datatypes.heat.contrail.network.rule.VirtualNetwork:
425 derived_from: tosca.datatypes.Root
426 description: source and destination addresses
430 description: Virtual network
434 org.openecomp.datatypes.heat.network.neutron.SecurityRules.Rule:
435 derived_from: tosca.datatypes.Root
436 description: Rules Pairs
440 description: The remote group ID to be associated with this security group rule
445 description: The protocol that is matched by the security group rule
455 description: Ethertype of the traffic
465 description: 'The maximum port number in the range that is matched by the
466 security group rule. '
475 description: The remote IP prefix (CIDR) to be associated with this security group rule
480 description: Whether to specify a remote group or a remote IP prefix
482 default: remote_ip_prefix
490 description: The direction in which the security group rule is applied
500 description: The minimum port number in the range that is matched by the security group rule.
507 org.openecomp.datatypes.heat.substitution.SubstitutionFiltering:
508 derived_from: tosca.datatypes.Root
509 description: Substitution Filter
511 substitute_service_template:
513 description: Substitute Service Template
518 description: Index value of the substitution service template runtime instance
523 - greater_or_equal: 0
532 description: Indicates whether service scaling is enabled
538 description: Mandatory
542 org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.RefDataSequence:
543 derived_from: tosca.datatypes.Root
544 description: network policy refs data sequence
546 network_policy_refs_data_sequence_major:
548 description: Network Policy ref data sequence Major
551 network_policy_refs_data_sequence_minor:
553 description: Network Policy ref data sequence Minor
556 org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.RefData:
557 derived_from: tosca.datatypes.Root
558 description: network policy refs data
560 network_policy_refs_data_sequence:
561 type: org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.RefDataSequence
562 description: Network Policy ref data sequence
565 org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.ref.data.IpamSubnet:
566 derived_from: tosca.datatypes.Root
567 description: Network Ipam Ref Data Subnet
569 network_ipam_refs_data_ipam_subnets_subnet_ip_prefix_len:
571 description: Network ipam refs data ipam subnets ip prefix len
574 network_ipam_refs_data_ipam_subnets_subnet_ip_prefix:
576 description: Network ipam refs data ipam subnets ip prefix
579 org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.ref.data.IpamSubnetList:
580 derived_from: tosca.datatypes.Root
581 description: Network Ipam Ref Data Subnet List
583 network_ipam_refs_data_ipam_subnets_subnet:
584 type: org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.ref.data.IpamSubnet
585 description: Network ipam refs data ipam subnets
588 network_ipam_refs_data_ipam_subnets_addr_from_start:
590 description: Network ipam refs data ipam subnets addr from start
593 org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.IpamRefData:
594 derived_from: tosca.datatypes.Root
595 description: Network Ipam Ref Data
597 network_ipam_refs_data_ipam_subnets:
599 description: Network ipam refs data ipam subnets
603 type: org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.ref.data.IpamSubnetList
604 org.openecomp.datatypes.heat.contrailV2.network.rule.SrcVirtualNetwork:
605 derived_from: tosca.datatypes.Root
606 description: source addresses
608 network_policy_entries_policy_rule_src_addresses_virtual_network:
610 description: Source addresses Virtual network
613 org.openecomp.datatypes.heat.contrailV2.network.rule.DstVirtualNetwork:
614 derived_from: tosca.datatypes.Root
615 description: destination addresses
617 network_policy_entries_policy_rule_dst_addresses_virtual_network:
619 description: Destination addresses Virtual network
622 org.openecomp.datatypes.heat.contrailV2.network.rule.DstPortPairs:
623 derived_from: tosca.datatypes.Root
624 description: destination port pairs
626 network_policy_entries_policy_rule_dst_ports_start_port:
628 description: Start port
631 network_policy_entries_policy_rule_dst_ports_end_port:
633 description: End port
636 org.openecomp.datatypes.heat.contrailV2.network.rule.SrcPortPairs:
637 derived_from: tosca.datatypes.Root
638 description: source port pairs
640 network_policy_entries_policy_rule_src_ports_start_port:
642 description: Start port
645 network_policy_entries_policy_rule_src_ports_end_port:
647 description: End port
650 org.openecomp.datatypes.heat.contrailV2.network.rule.ActionList:
651 derived_from: tosca.datatypes.Root
652 description: Action List
654 network_policy_entries_policy_rule_action_list_simple_action:
656 description: Simple Action
659 network_policy_entries_policy_rule_action_list_apply_service:
661 description: Apply Service
666 org.openecomp.datatypes.heat.contrailV2.network.rule.ActionList:
667 derived_from: tosca.datatypes.Root
668 description: Action List
670 network_policy_entries_policy_rule_action_list_simple_action:
672 description: Simple Action
675 network_policy_entries_policy_rule_action_list_apply_service:
677 description: Apply Service
682 org.openecomp.datatypes.heat.contrailV2.network.rule.Rule:
683 derived_from: tosca.datatypes.Root
684 description: policy rule
686 network_policy_entries_policy_rule_dst_addresses:
688 description: Destination addresses
692 type: org.openecomp.datatypes.heat.contrailV2.network.rule.DstVirtualNetwork
693 network_policy_entries_policy_rule_dst_ports:
695 description: Destination ports
699 type: org.openecomp.datatypes.heat.contrailV2.network.rule.DstPortPairs
700 network_policy_entries_policy_rule_protocol:
702 description: Protocol
705 network_policy_entries_policy_rule_src_addresses:
707 description: Source addresses
711 type: org.openecomp.datatypes.heat.contrailV2.network.rule.SrcVirtualNetwork
712 network_policy_entries_policy_rule_direction:
714 description: Direction
717 network_policy_entries_policy_rule_src_ports:
719 description: Source ports
723 type: org.openecomp.datatypes.heat.contrailV2.network.rule.SrcPortPairs
724 network_policy_entries_policy_rule_action_list:
725 type: org.openecomp.datatypes.heat.contrailV2.network.rule.ActionList
726 description: Action list
729 org.openecomp.datatypes.heat.contrailV2.network.rule.RuleList:
730 derived_from: tosca.datatypes.Root
731 description: list of policy rules
733 network_policy_entries_policy_rule:
735 description: Contrail network rule
739 type: org.openecomp.datatypes.heat.contrailV2.network.rule.Rule
740 org.openecomp.datatypes.heat.network.contrail.port.StaticRoute:
741 derived_from: tosca.datatypes.Root
742 description: static route
746 description: Route prefix
751 description: Next hop
756 description: Next hop type
759 org.openecomp.datatypes.heat.network.contrail.AddressPair:
760 derived_from: tosca.datatypes.Root
761 description: Address Pair
765 description: Address mode active-active or active-standy
774 description: IP address prefix
779 description: Mac address
782 org.openecomp.datatypes.heat.network.contrail.InterfaceData:
783 derived_from: tosca.datatypes.Root
784 description: Interface Data
788 description: An ordered list of static routes to be added to this interface
792 type: org.openecomp.datatypes.heat.network.contrail.port.StaticRoute
795 description: Virtual Network for this interface
798 allowed_address_pairs:
800 description: List of allowed address pair for this interface
804 type: org.openecomp.datatypes.heat.network.contrail.AddressPair
807 description: IP for this interface
810 org.openecomp.datatypes.heat.contrailV2.virtual.machine.interface.Properties:
811 derived_from: tosca.datatypes.Root
812 description: Virtual Machine Interface Properties.
814 virtual_machine_interface_properties_service_interface_type:
816 description: Service Interface Type.
819 org.openecomp.datatypes.Root:
820 derived_from: tosca.datatypes.Root
822 The AT&T root Data Type all other Data Types derive from
828 A placeholder for missing properties that would be included in future ecomp model versions.
832 org.openecomp.datatypes.network.SubnetAssignments:
833 derived_from: org.openecomp.datatypes.Root
835 ip_network_address_plan:
838 description: Reference to EIPAM, VLAN or other address plan ID used to assign subnets to this network
842 description: \"true\" indicates the network has 1 or more policies
846 - valid_values: [4,6]
848 description: The IP version of the subnet
852 description: The default subnet CIDR mask
857 description: Quantity of subnets that must be initially assigned
858 org.openecomp.datatypes.network.IPv4SubnetAssignments:
859 derived_from: org.openecomp.datatypes.network.SubnetAssignments
864 description: Indicates IPv4 subnet assignments
866 org.openecomp.datatypes.network.IPv6SubnetAssignments:
867 derived_from: org.openecomp.datatypes.network.SubnetAssignments
872 description: Indicates IPv6 subnet assignments
874 org.openecomp.datatypes.network.NetworkAssignments:
875 derived_from: org.openecomp.datatypes.Root
877 ecomp_generated_network_assignment:
882 \"true\" indicates that the network assignments will be auto-generated by ECOMP
883 \"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).
887 description: \"true\" means this network is shared by multiple Openstack tenants
893 \"true\" means this Contrail external network
894 ipv4_subnet_default_assignment:
895 type: org.openecomp.datatypes.network.IPv4SubnetAssignments
897 description: IPv4 defualt subnet assignments
898 ipv6_subnet_default_assignment:
899 type: org.openecomp.datatypes.network.IPv6SubnetAssignments
901 description: IPv6 defualt subnet assignments
903 org.openecomp.datatypes.network.ProviderNetwork:
904 derived_from: org.openecomp.datatypes.Root
909 description: \"true\" indicates that this a Neutron provider type of network
910 physical_network_name:
914 - valid_values: ["Physnet41", "Physnet42", "Physnet43", "Physnet44", "Physnet21", "Physnet22"]
916 Identifies the NUMA processor cluster to which this physical network interface belongs.
917 NUMA instance correlates to the first digit of the Physical Network Name suffix (e.g. \"01\" = NUMA 0, \"11\" = NUMA 1)
922 - valid_values: ["NUMA 0", "NUMA 1"]
924 PNIC instance within the NUMA processor cluster
925 PNIC Instance correlates to the second digit of the Physical Network Name suffix (e.g. "01" = PNIC 1, "02" = "PNIC 2)
929 description: PNIC instance within the NUMA processor cluster
931 org.openecomp.datatypes.network.NetworkFlows:
932 derived_from: org.openecomp.datatypes.Root
938 description: \"true\" indicates the network has 1 or more policies
942 description: "Identifies the specific Cloud network policy that must be applied to this network (source: from Policy Manager)."
947 description: \"true\" indicates the network has 1 or more vpn bindings
951 description: "Identifies the specific VPN Binding entry in A&AI that must be applied when creating this network (source: A&AI)"
953 org.openecomp.datatypes.network.VlanRequirements:
954 derived_from: org.openecomp.datatypes.Root
959 description: reference to a vlan range plan
964 - valid_values: ["c-tag", "s-tag"]
965 description: identifies the vlan type (e.g., c-tag)
969 description: identifies the number of vlan tags to assign to the CP from the plan
971 org.openecomp.datatypes.network.IpRequirements:
972 derived_from: org.openecomp.datatypes.Root
977 - valid_values: [4,6]
983 description: identifies the number of ip address to assign to the CP from the plan
993 - valid_values: ["fixed", "dhcp"]
997 org.openecomp.datatypes.network.MacAssignments:
998 derived_from: org.openecomp.datatypes.Root
1003 description: reference to a MAC address range plan
1007 description: identifies the number of MAC addresses to assign to the CP from the plan
1009 org.openecomp.datatypes.EcompHoming:
1010 derived_from: org.openecomp.datatypes.Root
1012 ecomp_selected_instance_node_target:
1017 \"true\" indicates that the target deployment node for this instance will be auto-selected by ECOMP
1018 \"false\" indicates operator-supplied instance target deployment node required (e.g. VID will present a prompt to operator and collect the
1019 operator-selected target node for the deployment of this Network instance).
1023 description: Referenc to a service level homing policy that ECOMP will use for instance deployment target node
1024 instance_node_target:
1027 description: Instance target deployment node
1029 org.openecomp.datatypes.EcompNaming:
1030 derived_from: org.openecomp.datatypes.Root
1032 ecomp_generated_naming:
1037 \"true\" indicates that the name for the instance will be auto-generated by ECOMP.
1038 \"false\" indicates operator-supplied name required (e.g. VID will present prompt to operator and collect the operator-supplied instance name).
1042 description: Referenc to naming policy that ECOMP will use when the name is auto-generated
1044 org.openecomp.datatypes.network.MacRequirements:
1045 derived_from: org.openecomp.datatypes.Root
1050 description: reference to a MAC address range plan
1054 description: identifies the number of MAC addresses to assign to the CP from the plan
1056 org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPairIp:
1057 derived_from: tosca.datatypes.Root
1058 description: Virtual Machine Sub Interface Address Pair IP.
1062 description: IP Prefix.
1067 description: IP Prefix Len.
1071 org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.MacAddress:
1072 derived_from: tosca.datatypes.Root
1073 description: Virtual Machine Sub Interface Mac Address.
1077 description: Mac Addresses List.
1083 org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.Properties:
1084 derived_from: tosca.datatypes.Root
1085 description: Virtual Machine Sub Interface VLAN Properties.
1087 sub_interface_vlan_tag:
1089 description: Sub Interface VLAN Tag.
1093 org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPair:
1094 derived_from: tosca.datatypes.Root
1095 description: Virtual Machine Sub Interface Address Pair.
1099 description: Address Mode.
1103 type: org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPairIp
1113 org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPairs:
1114 derived_from: tosca.datatypes.Root
1115 description: Virtual Machine Sub Interface Address Pairs.
1117 allowed_address_pair:
1119 description: Addresses pair List.
1123 type: org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPair