src/test/resources/ymlFiles/data.yml

   1 #
   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
   5 #
   6 #      http://www.apache.org/licenses/LICENSE-2.0
   7 #
   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.
  13 #
  14
  15 tosca_definitions_version: tosca_simple_yaml_1_0
  16
  17 #metadata:
  18 #  filename: openecomp-heat/data.yml
  19 #  version: '1.0'
  20
  21 data_types:
  22
  23     tosca.datatypes.Root:
  24       description: The TOSCA root Data Type all other TOSCA base Data Types derive from
  25
  26     integer:
  27       derived_from: tosca.datatypes.Root
  28
  29     string:
  30       derived_from: tosca.datatypes.Root
  31
  32     boolean:
  33       derived_from: tosca.datatypes.Root
  34
  35     float:
  36       derived_from: tosca.datatypes.Root
  37
  38     list:
  39       derived_from: tosca.datatypes.Root
  40
  41     map:
  42       derived_from: tosca.datatypes.Root
  43
  44     json:
  45       derived_from: tosca.datatypes.Root
  46
  47     scalar-unit:
  48       derived_from: tosca.datatypes.Root
  49
  50     scalar-unit.size:
  51       derived_from: scalar-unit
  52
  53     scalar-unit.time:
  54       derived_from: scalar-unit
  55
  56     scalar-unit.frequency:
  57       derived_from: scalar-unit
  58
  59     tosca.datatypes.Credential:
  60       derived_from: tosca.datatypes.Root
  61       properties:
  62         protocol:
  63           type: string
  64           required: false
  65         token_type:
  66           type: string
  67           default: password
  68         token:
  69           type: string
  70         keys:
  71           type: map
  72           required: false
  73           entry_schema:
  74             type: string
  75         user:
  76           type: string
  77           required: false
  78
  79     tosca.datatypes.TimeInterval:
  80       derived_from: tosca.datatypes.Root
  81       properties:
  82         start_time:
  83           type: timestamp
  84           required: true
  85         end_time:
  86           type: timestamp
  87           required: true
  88
  89     tosca.datatypes.network.NetworkInfo:
  90       derived_from: tosca.datatypes.Root
  91       properties:
  92         network_name:
  93           type: string
  94         network_id:
  95           type: string
  96         addresses:
  97           type: list
  98           entry_schema:
  99             type: string
 100
 101     tosca.datatypes.network.PortInfo:
 102       derived_from: tosca.datatypes.Root
 103       properties:
 104         port_name:
 105           type: string
 106         port_id:
 107           type: string
 108         network_id:
 109           type: string
 110         mac_address:
 111           type: string
 112         addresses:
 113           type: list
 114           entry_schema:
 115             type: string
 116
 117     tosca.datatypes.network.PortDef:
 118       derived_from: integer
 119       constraints:
 120         - in_range: [ 1, 65535 ]
 121
 122     tosca.datatypes.network.PortSpec:
 123       derived_from: tosca.datatypes.Root
 124       properties:
 125         protocol:
 126           type: string
 127           required: true
 128           default: tcp
 129           constraints:
 130             - valid_values: [ udp, tcp, igmp ]
 131         target:
 132           type: tosca.datatypes.network.PortDef
 133         target_range:
 134           type: range
 135           constraints:
 136             - in_range: [ 1, 65535 ]
 137         source:
 138           type: tosca.datatypes.network.PortDef
 139         source_range:
 140           type: range
 141           constraints:
 142             - in_range: [ 1, 65535 ]
 143
 144     ###################new Data Types Onboarding Integration##########################
 145
 146     org.openecomp.datatypes.heat.network.AddressPair:
 147       derived_from: tosca.datatypes.Root
 148       description: MAC/IP address pairs
 149       properties:
 150         mac_address:
 151           type: string
 152           description: MAC address
 153           required: false
 154           status: SUPPORTED
 155         ip_address:
 156           type: string
 157           description: IP address
 158           required: false
 159           status: SUPPORTED
 160
 161     org.openecomp.datatypes.heat.network.subnet.HostRoute:
 162       derived_from: tosca.datatypes.Root
 163       description: Host route info for the subnet
 164       properties:
 165         destination:
 166           type: string
 167           description: The destination for static route
 168           required: false
 169           status: SUPPORTED
 170         nexthop:
 171           type: string
 172           description: The next hop for the destination
 173           required: false
 174           status: SUPPORTED
 175
 176     org.openecomp.datatypes.heat.network.AllocationPool:
 177       derived_from: tosca.datatypes.Root
 178       description: The start and end addresses for the allocation pool
 179       properties:
 180         start:
 181           type: string
 182           description: Start address for the allocation pool
 183           required: false
 184           status: SUPPORTED
 185         end:
 186           type: string
 187           description: End address for the allocation pool
 188           required: false
 189           status: SUPPORTED
 190
 191     org.openecomp.datatypes.heat.network.neutron.Subnet:
 192       derived_from: tosca.datatypes.Root
 193       description: A subnet represents an IP address block that can be used for assigning IP addresses to virtual instances
 194       properties:
 195         tenant_id:
 196           type: string
 197           description: The ID of the tenant who owns the network
 198           required: false
 199           status: SUPPORTED
 200         enable_dhcp:
 201           type: boolean
 202           description: Set to true if DHCP is enabled and false if DHCP is disabled
 203           required: false
 204           default: true
 205           status: SUPPORTED
 206         ipv6_address_mode:
 207           type: string
 208           description: IPv6 address mode
 209           required: false
 210           status: SUPPORTED
 211           constraints:
 212           - valid_values:
 213             - dhcpv6-stateful
 214             - dhcpv6-stateless
 215             - slaac
 216         ipv6_ra_mode:
 217           type: string
 218           description: IPv6 RA (Router Advertisement) mode
 219           required: false
 220           status: SUPPORTED
 221           constraints:
 222           - valid_values:
 223             - dhcpv6-stateful
 224             - dhcpv6-stateless
 225             - slaac
 226         value_specs:
 227           type: map
 228           description: Extra parameters to include in the request
 229           required: false
 230           default: {
 231             }
 232           status: SUPPORTED
 233           entry_schema:
 234             type: string
 235         allocation_pools:
 236            type: list
 237            description: The start and end addresses for the allocation pools
 238            required: false
 239            status: SUPPORTED
 240            entry_schema:
 241              type: org.openecomp.datatypes.heat.network.AllocationPool
 242         subnetpool:
 243           type: string
 244           description: The name or ID of the subnet pool
 245           required: false
 246           status: SUPPORTED
 247         dns_nameservers:
 248           type: list
 249           description: A specified set of DNS name servers to be used
 250           required: false
 251           default: [
 252             ]
 253           status: SUPPORTED
 254           entry_schema:
 255             type: string
 256         host_routes:
 257           type: list
 258           description: The gateway IP address
 259           required: false
 260           status: SUPPORTED
 261           entry_schema:
 262             type: org.openecomp.datatypes.heat.network.subnet.HostRoute
 263         ip_version:
 264           type: integer
 265           description: The gateway IP address
 266           required: false
 267           default: 4
 268           status: SUPPORTED
 269           constraints:
 270           - valid_values:
 271             - '4'
 272             - '6'
 273         name:
 274           type: string
 275           description: The name of the subnet
 276           required: false
 277           status: SUPPORTED
 278         prefixlen:
 279           type: integer
 280           description: Prefix length for subnet allocation from subnet pool
 281           required: false
 282           status: SUPPORTED
 283           constraints:
 284           - greater_or_equal: 0
 285         cidr:
 286           type: string
 287           description: The CIDR
 288           required: false
 289           status: SUPPORTED
 290         gateway_ip:
 291           type: string
 292           description: The gateway IP address
 293           required: false
 294           status: SUPPORTED
 295
 296     org.openecomp.datatypes.heat.novaServer.network.PortExtraProperties:
 297       derived_from: tosca.datatypes.Root
 298       description: Nova server network expand properties for port
 299       properties:
 300         port_security_enabled:
 301           type: boolean
 302           description: Flag to enable/disable port security on the port
 303           required: false
 304           status: SUPPORTED
 305         mac_address:
 306           type: string
 307           description: MAC address to give to this port
 308           required: false
 309           status: SUPPORTED
 310         admin_state_up:
 311           type: boolean
 312           description: The administrative state of this port
 313           required: false
 314           default: true
 315           status: SUPPORTED
 316         qos_policy:
 317           type: string
 318           description: The name or ID of QoS policy to attach to this port
 319           required: false
 320           status: SUPPORTED
 321         allowed_address_pairs:
 322           type: list
 323           description: Additional MAC/IP address pairs allowed to pass through the port
 324           required: false
 325           status: SUPPORTED
 326           entry_schema:
 327             type: org.openecomp.datatypes.heat.network.AddressPair
 328         binding:vnic_type:
 329           type: string
 330           description: The vnic type to be bound on the neutron port
 331           required: false
 332           status: SUPPORTED
 333           constraints:
 334           - valid_values:
 335             - macvtap
 336             - direct
 337             - normal
 338         value_specs:
 339           type: map
 340           description: Extra parameters to include in the request
 341           required: false
 342           default: {
 343             }
 344           status: SUPPORTED
 345           entry_schema:
 346             type: string
 347
 348     org.openecomp.datatypes.heat.novaServer.network.AddressInfo:
 349       derived_from: tosca.datatypes.network.NetworkInfo
 350       description: Network addresses with corresponding port id
 351       properties:
 352         port_id:
 353           type: string
 354           description: Port id
 355           required: false
 356           status: SUPPORTED
 357
 358     org.openecomp.datatypes.heat.neutron.port.FixedIps:
 359       derived_from: tosca.datatypes.Root
 360       description: subnet/ip_address
 361       properties:
 362         subnet:
 363           type: string
 364           description: Subnet in which to allocate the IP address for this port
 365           required: false
 366           status: SUPPORTED
 367         ip_address:
 368           type: string
 369           description: IP address desired in the subnet for this port
 370           required: false
 371           status: SUPPORTED
 372
 373     org.openecomp.datatypes.heat.FileInfo:
 374       derived_from: tosca.datatypes.Root
 375       description: Heat File Info
 376       properties:
 377         file:
 378           type: string
 379           description: The required URI string (relative or absolute) which can be used to locate the file
 380           required: true
 381           status: SUPPORTED
 382         file_type:
 383           type: string
 384           description: The type of the file
 385           required: true
 386           status: SUPPORTED
 387           constraints:
 388           - valid_values:
 389             - base
 390             - env
 391             - volume
 392             - network
 393
 394     org.openecomp.datatypes.heat.contrail.network.rule.PortPairs:
 395         derived_from: tosca.datatypes.Root
 396         description: source and destination port pairs
 397         properties:
 398           start_port:
 399             type: string
 400             description: Start port
 401             required: false
 402             status: SUPPORTED
 403           end_port:
 404             type: string
 405             description: End port
 406             required: false
 407             status: SUPPORTED
 408
 409     org.openecomp.datatypes.heat.contrail.network.rule.Rule:
 410         derived_from: tosca.datatypes.Root
 411         description: policy rule
 412         properties:
 413           src_ports:
 414             type: list
 415             description: Source ports
 416             required: false
 417             status: SUPPORTED
 418             entry_schema:
 419               type: org.openecomp.datatypes.heat.contrail.network.rule.PortPairs
 420           protocol:
 421             type: string
 422             description: Protocol
 423             required: false
 424             status: SUPPORTED
 425           dst_addresses:
 426             type: list
 427             description: Destination addresses
 428             required: false
 429             status: SUPPORTED
 430             entry_schema:
 431               type: org.openecomp.datatypes.heat.contrail.network.rule.VirtualNetwork
 432           apply_service:
 433             type: string
 434             description: Service to apply
 435             required: false
 436             status: SUPPORTED
 437           dst_ports:
 438             type: list
 439             description: Destination ports
 440             required: false
 441             status: SUPPORTED
 442             entry_schema:
 443               type: org.openecomp.datatypes.heat.contrail.network.rule.PortPairs
 444           src_addresses:
 445             type: list
 446             description: Source addresses
 447             required: false
 448             status: SUPPORTED
 449             entry_schema:
 450               type: org.openecomp.datatypes.heat.contrail.network.rule.VirtualNetwork
 451           direction:
 452             type: string
 453             description: Direction
 454             required: false
 455             status: SUPPORTED
 456
 457     org.openecomp.datatypes.heat.contrail.network.rule.RuleList:
 458         derived_from: tosca.datatypes.Root
 459         description: list of policy rules
 460         properties:
 461           policy_rule:
 462             type: list
 463             description: Contrail network rule
 464             required: false
 465             status: SUPPORTED
 466             entry_schema:
 467               type: org.openecomp.datatypes.heat.contrail.network.rule.Rule
 468
 469     org.openecomp.datatypes.heat.contrail.network.rule.VirtualNetwork:
 470         derived_from: tosca.datatypes.Root
 471         description: source and destination addresses
 472         properties:
 473           virtual_network:
 474             type: string
 475             description: Virtual network
 476             required: false
 477             status: SUPPORTED
 478
 479     org.openecomp.datatypes.heat.network.neutron.SecurityRules.Rule:
 480         derived_from: tosca.datatypes.Root
 481         description: Rules Pairs
 482         properties:
 483           remote_group_id:
 484             type: string
 485             description: The remote group ID to be associated with this security group rule
 486             required: false
 487             status: SUPPORTED
 488           protocol:
 489             type: string
 490             description: The protocol that is matched by the security group rule
 491             required: false
 492             status: SUPPORTED
 493             constraints:
 494             - valid_values:
 495               - tcp
 496               - udp
 497               - icmp
 498           ethertype:
 499             type: string
 500             description: Ethertype of the traffic
 501             required: false
 502             default: IPv4
 503             status: SUPPORTED
 504             constraints:
 505             - valid_values:
 506               - IPv4
 507               - IPv6
 508           port_range_max:
 509             type: integer
 510             description: 'The maximum port number in the range that is matched by the
 511               security group rule. '
 512             required: false
 513             status: SUPPORTED
 514             constraints:
 515             - in_range:
 516               - 0
 517               - 65535
 518           remote_ip_prefix:
 519             type: string
 520             description: The remote IP prefix (CIDR) to be associated with this security group rule
 521             required: false
 522             status: SUPPORTED
 523           remote_mode:
 524             type: string
 525             description: Whether to specify a remote group or a remote IP prefix
 526             required: false
 527             default: remote_ip_prefix
 528             status: SUPPORTED
 529             constraints:
 530             - valid_values:
 531               - remote_ip_prefix
 532               - remote_group_id
 533           direction:
 534             type: string
 535             description: The direction in which the security group rule is applied
 536             required: false
 537             default: ingress
 538             status: SUPPORTED
 539             constraints:
 540             - valid_values:
 541               - egress
 542               - ingress
 543           port_range_min:
 544             type: integer
 545             description: The minimum port number in the range that is matched by the security group rule.
 546             required: false
 547             status: SUPPORTED
 548             constraints:
 549             - in_range:
 550               - 0
 551               - 65535
 552
 553     org.openecomp.datatypes.heat.substitution.SubstitutionFiltering:
 554         derived_from: tosca.datatypes.Root
 555         description: Substitution Filter
 556         properties:
 557           substitute_service_template:
 558             type: string
 559             description: Substitute Service Template
 560             required: true
 561             status: SUPPORTED
 562           index_value:
 563             type: integer
 564             description: Index value of the substitution service template runtime instance
 565             required: false
 566             default: 0
 567             status: SUPPORTED
 568             constraints:
 569             - greater_or_equal: 0
 570           count:
 571             type: string
 572             description: Count
 573             required: false
 574             default: 1
 575             status: SUPPORTED
 576           scaling_enabled:
 577             type: boolean
 578             description: Indicates whether service scaling is enabled
 579             required: false
 580             default: true
 581             status: SUPPORTED
 582           mandatory:
 583             type: boolean
 584             description: Mandatory
 585             required: false
 586             default: true
 587             status: SUPPORTED
 588
 589     org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.RefDataSequence:
 590         derived_from: tosca.datatypes.Root
 591         description: network policy refs data sequence
 592         properties:
 593           network_policy_refs_data_sequence_major:
 594             type: integer
 595             description: Network Policy ref data sequence Major
 596             required: false
 597             status: SUPPORTED
 598           network_policy_refs_data_sequence_minor:
 599             type: integer
 600             description: Network Policy ref data sequence Minor
 601             required: false
 602             status: SUPPORTED
 603
 604     org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.RefData:
 605         derived_from: tosca.datatypes.Root
 606         description: network policy refs data
 607         properties:
 608           network_policy_refs_data_sequence:
 609             type: org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.RefDataSequence
 610             description: Network Policy ref data sequence
 611             required: false
 612             status: SUPPORTED
 613
 614     org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.ref.data.IpamSubnet:
 615         derived_from: tosca.datatypes.Root
 616         description: Network Ipam Ref Data Subnet
 617         properties:
 618           network_ipam_refs_data_ipam_subnets_subnet_ip_prefix_len:
 619             type: string
 620             description: Network ipam refs data ipam subnets ip prefix len
 621             required: false
 622             status: SUPPORTED
 623           network_ipam_refs_data_ipam_subnets_subnet_ip_prefix:
 624             type: string
 625             description: Network ipam refs data ipam subnets ip prefix
 626             required: false
 627             status: SUPPORTED
 628
 629     org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.ref.data.IpamSubnetList:
 630         derived_from: tosca.datatypes.Root
 631         description: Network Ipam Ref Data Subnet List
 632         properties:
 633           network_ipam_refs_data_ipam_subnets_subnet:
 634             type: org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.ref.data.IpamSubnet
 635             description: Network ipam refs data ipam subnets
 636             required: false
 637             status: SUPPORTED
 638           network_ipam_refs_data_ipam_subnets_addr_from_start:
 639             type: string
 640             description: Network ipam refs data ipam subnets addr from start
 641             required: false
 642             status: SUPPORTED
 643
 644     org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.IpamRefData:
 645         derived_from: tosca.datatypes.Root
 646         description: Network Ipam Ref Data
 647         properties:
 648           network_ipam_refs_data_ipam_subnets:
 649             type: list
 650             description: Network ipam refs data ipam subnets
 651             required: false
 652             status: SUPPORTED
 653             entry_schema:
 654               type: org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.ref.data.IpamSubnetList
 655
 656     org.openecomp.datatypes.heat.contrailV2.network.rule.SrcVirtualNetwork:
 657         derived_from: tosca.datatypes.Root
 658         description: source addresses
 659         properties:
 660           network_policy_entries_policy_rule_src_addresses_virtual_network:
 661             type: string
 662             description: Source addresses Virtual network
 663             required: false
 664             status: SUPPORTED
 665
 666     org.openecomp.datatypes.heat.contrailV2.network.rule.DstVirtualNetwork:
 667         derived_from: tosca.datatypes.Root
 668         description: destination addresses
 669         properties:
 670           network_policy_entries_policy_rule_dst_addresses_virtual_network:
 671             type: string
 672             description: Destination addresses Virtual network
 673             required: false
 674             status: SUPPORTED
 675
 676     org.openecomp.datatypes.heat.contrailV2.network.rule.DstPortPairs:
 677         derived_from: tosca.datatypes.Root
 678         description: destination port pairs
 679         properties:
 680           network_policy_entries_policy_rule_dst_ports_start_port:
 681             type: string
 682             description: Start port
 683             required: false
 684             status: SUPPORTED
 685           network_policy_entries_policy_rule_dst_ports_end_port:
 686             type: string
 687             description: End port
 688             required: false
 689             status: SUPPORTED
 690
 691     org.openecomp.datatypes.heat.contrailV2.network.rule.SrcPortPairs:
 692         derived_from: tosca.datatypes.Root
 693         description: source port pairs
 694         properties:
 695           network_policy_entries_policy_rule_src_ports_start_port:
 696             type: string
 697             description: Start port
 698             required: false
 699             status: SUPPORTED
 700           network_policy_entries_policy_rule_src_ports_end_port:
 701             type: string
 702             description: End port
 703             required: false
 704             status: SUPPORTED
 705
 706     org.openecomp.datatypes.heat.contrailV2.network.rule.ActionList:
 707         derived_from: tosca.datatypes.Root
 708         description: Action List
 709         properties:
 710           network_policy_entries_policy_rule_action_list_simple_action:
 711             type: string
 712             description: Simple Action
 713             required: false
 714             status: SUPPORTED
 715           network_policy_entries_policy_rule_action_list_apply_service:
 716             type: list
 717             description: Apply Service
 718             required: false
 719             status: SUPPORTED
 720             entry_schema:
 721               type: string
 722
 723     org.openecomp.datatypes.heat.contrailV2.network.rule.Rule:
 724         derived_from: tosca.datatypes.Root
 725         description: policy rule
 726         properties:
 727           network_policy_entries_policy_rule_dst_addresses:
 728             type: list
 729             description: Destination addresses
 730             required: false
 731             status: SUPPORTED
 732             entry_schema:
 733               type: org.openecomp.datatypes.heat.contrailV2.network.rule.DstVirtualNetwork
 734           network_policy_entries_policy_rule_dst_ports:
 735             type: list
 736             description: Destination ports
 737             required: false
 738             status: SUPPORTED
 739             entry_schema:
 740               type: org.openecomp.datatypes.heat.contrailV2.network.rule.DstPortPairs
 741           network_policy_entries_policy_rule_protocol:
 742             type: string
 743             description: Protocol
 744             required: false
 745             status: SUPPORTED
 746           network_policy_entries_policy_rule_src_addresses:
 747             type: list
 748             description: Source addresses
 749             required: false
 750             status: SUPPORTED
 751             entry_schema:
 752               type: org.openecomp.datatypes.heat.contrailV2.network.rule.SrcVirtualNetwork
 753           network_policy_entries_policy_rule_direction:
 754             type: string
 755             description: Direction
 756             required: false
 757             status: SUPPORTED
 758           network_policy_entries_policy_rule_src_ports:
 759             type: list
 760             description: Source ports
 761             required: false
 762             status: SUPPORTED
 763             entry_schema:
 764               type: org.openecomp.datatypes.heat.contrailV2.network.rule.SrcPortPairs
 765           network_policy_entries_policy_rule_action_list:
 766             type: org.openecomp.datatypes.heat.contrailV2.network.rule.ActionList
 767             description: Action list
 768             required: false
 769             status: SUPPORTED
 770
 771     org.openecomp.datatypes.heat.contrailV2.network.rule.RuleList:
 772         derived_from: tosca.datatypes.Root
 773         description: list of policy rules
 774         properties:
 775           network_policy_entries_policy_rule:
 776             type: list
 777             description: Contrail network rule
 778             required: false
 779             status: SUPPORTED
 780             entry_schema:
 781               type: org.openecomp.datatypes.heat.contrailV2.network.rule.Rule
 782
 783     org.openecomp.datatypes.heat.network.contrail.port.StaticRoute:
 784         derived_from: tosca.datatypes.Root
 785         description: static route
 786         properties:
 787           prefix:
 788             type: string
 789             description: Route prefix
 790             required: false
 791             status: SUPPORTED
 792           next_hop:
 793             type: string
 794             description: Next hop
 795             required: false
 796             status: SUPPORTED
 797           next_hop_type:
 798             type: string
 799             description: Next hop type
 800             required: false
 801             status: SUPPORTED
 802
 803     org.openecomp.datatypes.heat.network.contrail.AddressPair:
 804         derived_from: tosca.datatypes.Root
 805         description: Address Pair
 806         properties:
 807           address_mode:
 808             type: string
 809             description: Address mode active-active or active-standy
 810             required: false
 811             status: SUPPORTED
 812             constraints:
 813             - valid_values:
 814               - active-active
 815               - active-standby
 816           prefix:
 817             type: string
 818             description: IP address prefix
 819             required: false
 820             status: SUPPORTED
 821           mac_address:
 822             type: string
 823             description: Mac address
 824             required: false
 825             status: SUPPORTED
 826
 827     org.openecomp.datatypes.heat.network.contrail.InterfaceData:
 828         derived_from: tosca.datatypes.Root
 829         description: Interface Data
 830         properties:
 831           static_routes:
 832             type: list
 833             description: An ordered list of static routes to be added to this interface
 834             required: false
 835             status: SUPPORTED
 836             entry_schema:
 837               type: org.openecomp.datatypes.heat.network.contrail.port.StaticRoute
 838           virtual_network:
 839             type: string
 840             description: Virtual Network for this interface
 841             required: true
 842             status: SUPPORTED
 843           allowed_address_pairs:
 844             type: list
 845             description: List of allowed address pair for this interface
 846             required: false
 847             status: SUPPORTED
 848             entry_schema:
 849               type: org.openecomp.datatypes.heat.network.contrail.AddressPair
 850           ip_address:
 851             type: string
 852             description: IP for this interface
 853             required: false
 854             status: SUPPORTED
 855
 856     # Duplicate type - removed after investigating with Renana and Shiri Amichai from Amdocs
 857     # org.openecomp.datatypes.heat.contrailV2.virtual.machine.interface.Properties:
 858     #     derived_from: tosca.datatypes.Root
 859     #     description: Virtual Machine Interface Properties.
 860     #     properties:
 861     #       virtual_machine_interface_properties_service_interface_type:
 862     #         type: string
 863     #         description: Service Interface Type.
 864     #         required: false
 865     #         status: SUPPORTED
 866
 867     org.openecomp.datatypes.Root:
 868       derived_from: tosca.datatypes.Root
 869       description: >
 870         The ECOMP root Data Type all other Data Types derive from
 871       properties:
 872         supplemental_data:
 873           type: map
 874           entry_schema:
 875             description: >
 876                A placeholder for missing properties that would be included in future ecomp model versions.
 877                fromat <key>:<value>
 878             type: string
 879
 880     org.openecomp.datatypes.AssignmentRequirements:
 881       derived_from: org.openecomp.datatypes.Root
 882       properties:
 883         is_required:
 884           description: |
 885             "true" indicates that assignment is required
 886           type: boolean
 887           default: false
 888           required: true
 889         count:
 890           description: number of assignments required
 891           type: integer
 892           required: false
 893
 894     org.openecomp.datatypes.network.SubnetAssignments:
 895       derived_from: org.openecomp.datatypes.Root
 896       properties:
 897         ip_network_address_plan:
 898           type: string
 899           required: false
 900           description: Reference to EIPAM, VLAN or other address plan ID used to assign subnets to this network
 901         dhcp_enabled:
 902           type: boolean
 903           required: false
 904           description: \"true\" indicates the network has 1 or more policies
 905         ip_version:
 906           type: integer
 907           constraints:
 908             - valid_values: [4,6]
 909           required: true
 910           description: The IP version of the subnet
 911         cidr_mask:
 912           type: integer
 913           required: true
 914           description: The default subnet CIDR mask
 915         min_subnets_count:
 916           type: integer
 917           default: 1
 918           required: true
 919           description: Quantity of subnets that must be initially assigned
 920
 921     org.openecomp.datatypes.network.IPv4SubnetAssignments:
 922       derived_from: org.openecomp.datatypes.network.SubnetAssignments
 923       properties:
 924         use_ipv4:
 925           type: boolean
 926           required: true
 927           description: Indicates IPv4 subnet assignments
 928
 929     org.openecomp.datatypes.network.IPv6SubnetAssignments:
 930       derived_from: org.openecomp.datatypes.network.SubnetAssignments
 931       properties:
 932         use_ipv6:
 933           type: boolean
 934           required: true
 935           description: Indicates IPv6 subnet assignments
 936
 937     org.openecomp.datatypes.network.NetworkAssignments:
 938       derived_from: org.openecomp.datatypes.Root
 939       properties:
 940         ecomp_generated_network_assignment:
 941           type: boolean
 942           required: true
 943           default: false
 944           description: >
 945             \"true\" indicates that the network assignments will be auto-generated by ECOMP
 946             \"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).
 947         is_shared_network:
 948           type: boolean
 949           required: true
 950           description: \"true\" means this network is shared by multiple Openstack tenants
 951         is_external_network:
 952           type: boolean
 953           required: true
 954           default: false
 955           description: >
 956             \"true\" means this Contrail external network
 957         ipv4_subnet_default_assignment:
 958           type: org.openecomp.datatypes.network.IPv4SubnetAssignments
 959           required: true
 960           description: IPv4 defualt subnet assignments
 961         ipv6_subnet_default_assignment:
 962           type: org.openecomp.datatypes.network.IPv6SubnetAssignments
 963           required: true
 964           description: IPv6 defualt subnet assignments
 965
 966     org.openecomp.datatypes.network.ProviderNetwork:
 967       derived_from: org.openecomp.datatypes.Root
 968       properties:
 969         is_provider_network:
 970           type: boolean
 971           required: true
 972           description: \"true\" indicates that this a Neutron provider type of network
 973         physical_network_name:
 974           type: string
 975           required: false
 976           constraints:
 977             - valid_values: ["Physnet41", "Physnet42", "Physnet43", "Physnet44", "Physnet21", "Physnet22"]
 978           description: >
 979             Identifies the NUMA processor cluster to which this physical network interface belongs.
 980             NUMA instance correlates to the first digit of the Physical Network Name suffix (e.g. \"01\" = NUMA 0, \"11\" = NUMA 1)
 981         numa:
 982           type: string
 983           required: false
 984           constraints:
 985             - valid_values: ["NUMA 0", "NUMA 1"]
 986           description: >
 987             PNIC instance within the NUMA processor cluster
 988             PNIC Instance correlates to the second digit of the Physical Network Name suffix (e.g. "01" = PNIC 1, "02" = "PNIC 2)
 989         pnic_instance:
 990           type: integer
 991           required: false
 992           description: PNIC instance within the NUMA processor cluster
 993
 994     org.openecomp.datatypes.network.NetworkFlows:
 995       derived_from: org.openecomp.datatypes.Root
 996       properties:
 997         is_network_policy:
 998           type: boolean
 999           required: false
1000           default: false
1001           description: \"true\" indicates the network has 1 or more policies
1002         network_policy:
1003           type: string
1004           required: false
1005           description: "Identifies the specific Cloud network policy that must be applied to this network (source: from Policy Manager)."
1006         is_bound_to_vpn:
1007           type: boolean
1008           required: false
1009           default: false
1010           description: \"true\" indicates the network has 1 or more vpn bindings
1011         vpn_binding:
1012           type: string
1013           required: false
1014           description: "Identifies the specific VPN Binding entry in A&AI that must be applied when creating this network (source: A&AI)"
1015
1016     org.openecomp.datatypes.network.VlanRequirements:
1017       derived_from: org.openecomp.datatypes.Root
1018       properties:
1019         vlan_range_plan:
1020           type: string
1021           required: true
1022           description: reference to a vlan range plan
1023         vlan_type:
1024           type: string
1025           required: true
1026           constraints:
1027             - valid_values: ["c-tag", "s-tag"]
1028           description: identifies the vlan type (e.g., c-tag)
1029         vlan_count:
1030           type: integer
1031           required: true
1032           description: identifies the number of vlan tags to assign to the CP from the plan
1033
1034     org.openecomp.datatypes.network.IpRequirements:
1035       derived_from: org.openecomp.datatypes.Root
1036       properties:
1037         ip_version:
1038           type: integer
1039           required: true
1040           constraints:
1041             - valid_values:
1042               - 4
1043               - 6
1044         ip_count:
1045           description: identifies the number of ip address to assign to the CP from the plan
1046           type: integer
1047           required: false
1048         floating_ip_count:
1049           type: integer
1050           required: false
1051         subnet_role:
1052           type: string
1053           required: false
1054         assingment_method:
1055           type: string
1056           required: true
1057           constraints:
1058             - valid_values:
1059               - fixed
1060               - dhcp
1061         dhcp_enabled:
1062           type: boolean
1063           required: false
1064         ip_count_required:
1065           description: identifies the number of ip address to assign to the CP from the plan
1066           type: org.openecomp.datatypes.AssignmentRequirements
1067           required: false
1068         floating_ip_count_required:
1069           type: org.openecomp.datatypes.AssignmentRequirements
1070           required: false
1071
1072     org.openecomp.datatypes.network.MacAssignments:
1073       derived_from: org.openecomp.datatypes.Root
1074       properties:
1075         mac_range_plan:
1076           type: string
1077           required: true
1078           description: reference to a MAC address range plan
1079         mac_count:
1080           type: integer
1081           required: true
1082           description: identifies the number of MAC addresses to assign to the CP from the plan
1083
1084     org.openecomp.datatypes.EcompHoming:
1085       derived_from: org.openecomp.datatypes.Root
1086       properties:
1087         ecomp_selected_instance_node_target:
1088           type: boolean
1089           required: true
1090           default: false
1091           description: >
1092             \"true\" indicates that the target deployment node for this instance will be auto-selected by ECOMP
1093             \"false\" indicates operator-supplied instance target deployment node required (e.g. VID will present a prompt to operator and collect the
1094             operator-selected target node for the deployment of this Network instance).
1095         homing_policy:
1096           type: string
1097           required: false
1098           description: Referenc to a service level homing policy that ECOMP will use for instance deployment target node
1099         instance_node_target:
1100           type: string
1101           required: false
1102           description: Instance target deployment node
1103
1104     org.openecomp.datatypes.EcompNaming:
1105       derived_from: org.openecomp.datatypes.Root
1106       properties:
1107         ecomp_generated_naming:
1108           type: boolean
1109           required: true
1110           default: true
1111           description: >
1112             \"true\" indicates that the name for the instance will be auto-generated by ECOMP.
1113             \"false\" indicates operator-supplied name required (e.g. VID will present prompt to operator and collect the operator-supplied instance name).
1114         naming_policy:
1115           type: string
1116           required: false
1117           description: Referenc to naming policy that ECOMP will use when the name is auto-generated
1118
1119     org.openecomp.datatypes.network.MacRequirements:
1120       derived_from: org.openecomp.datatypes.Root
1121       properties:
1122         mac_range_plan:
1123           description: reference to a MAC address range plan
1124           type: string
1125           required: false
1126         mac_count:
1127           description: identifies the number of MAC addresses to assign to the CP from the plan
1128           type: integer
1129           required: false
1130         mac_count_required:
1131           description: identifies the number of MAC addresses to assign to the CP from the plan
1132           type: org.openecomp.datatypes.AssignmentRequirements
1133
1134     org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPairIp:
1135       derived_from: tosca.datatypes.Root
1136       description: Virtual Machine Sub Interface Address Pair IP.
1137       properties:
1138         ip_prefix:
1139           type: string
1140           description: IP Prefix.
1141           required: false
1142           status: SUPPORTED
1143         ip_prefix_len:
1144           type: integer
1145           description: IP Prefix Len.
1146           required: false
1147           status: SUPPORTED
1148
1149     org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.MacAddress:
1150       derived_from: tosca.datatypes.Root
1151       description: Virtual Machine Sub Interface Mac Address.
1152       properties:
1153         mac_address:
1154           type: list
1155           description: Mac Addresses List.
1156           required: false
1157           status: SUPPORTED
1158           entry_schema:
1159             type: string
1160
1161     org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.Properties:
1162       derived_from: tosca.datatypes.Root
1163       description: Virtual Machine Sub Interface VLAN Properties.
1164       properties:
1165         sub_interface_vlan_tag:
1166           type: string
1167           description: Sub Interface VLAN Tag.
1168           required: false
1169           status: SUPPORTED
1170
1171     org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPair:
1172       derived_from: tosca.datatypes.Root
1173       description: Virtual Machine Sub Interface Address Pair.
1174       properties:
1175         address_mode:
1176           type: string
1177           description: Address Mode.
1178           required: false
1179           status: SUPPORTED
1180         ip:
1181           type: org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPairIp
1182           description: IP.
1183           required: false
1184           status: SUPPORTED
1185         mac:
1186           type: string
1187           description: Mac.
1188           required: false
1189           status: SUPPORTED
1190
1191     org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPairs:
1192       derived_from: tosca.datatypes.Root
1193       description: Virtual Machine Sub Interface Address Pairs.
1194       properties:
1195         allowed_address_pair:
1196           type: list
1197           description: Addresses pair List.
1198           required: false
1199           status: SUPPORTED
1200           entry_schema:
1201             type: org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPair
1202
1203     org.openecomp.datatypes.Naming:
1204       derived_from: org.openecomp.datatypes.Root
1205       properties:
1206           ecomp_generated_naming:
1207             description: |
1208                 "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).
1209             type: boolean
1210             default: true
1211             required: true
1212           naming_policy:
1213             description: Reference to naming policy that ECOMP will use when the name is auto-generated
1214             type: string
1215             required: false
1216           instance_name:
1217             description: indicates operator-supplied name required (e.g. VID will present prompt to operator and collect the operator-supplied instance name).
1218             type: string
1219             required: false
1220           port_id:
1221             description: The unique ID for the network port generated by the network provider.
1222             type: string
1223             required: false
1224           network_id:
1225             description: The unique ID for the network.
1226             type: string
1227             required: false
1228           mac_address:
1229             description: The unique media access control address (MAC address) assigned to the port.
1230             type: string
1231             required: false
1232           addresses:
1233             description: The list of IP address(es) assigned to the port.
1234             type: list
1235             entry_schema:
1236               type: string
1237             required: false
1238
1239     tosca.datatypes.Credential:
1240       derived_from: tosca.datatypes.Root
1241       description: The Credential type is a complex TOSCA data Type used when describing authorization credentials used to access network accessible resources.
1242       properties:
1243         protocol:
1244           description: The optional protocol name.
1245           type: string
1246           required: false
1247         token_type:
1248           description: The required token type.
1249           type: string
1250           default: password
1251         token:
1252           description: The required token used as a credential for authorization or access to a networked resource.
1253           type: string
1254         keys:
1255           description: The optional list of protocol-specific keys or assertions.
1256           type: map
1257           entry_schema:
1258             type: string
1259           required: false
1260         user:
1261           description: The optional user (name or ID) used for non-token based credentials.
1262           type: string
1263           required: false
1264
1265     org.openecomp.datatypes.heat.network.AddressPair:
1266       derived_from: tosca.datatypes.Root
1267       description: MAC/IP address pairs
1268       properties:
1269         mac_address:
1270           description: MAC address
1271           type: string
1272           status: supported
1273           required: false
1274         ip_address:
1275           description: IP address
1276           type: string
1277           status: supported
1278           required: false
1279
1280     org.openecomp.datatypes.heat.novaServer.network.PortExtraProperties:
1281       derived_from: tosca.datatypes.Root
1282       description: Nova server network expand properties for port
1283       properties:
1284         port_security_enabled:
1285           description: Flag to enable/disable port security on the port
1286           type: boolean
1287           status: supported
1288           required: false
1289         mac_address:
1290           description: MAC address to give to this port
1291           type: string
1292           status: supported
1293           required: false
1294         admin_state_up:
1295           description: The administrative state of this port
1296           type: boolean
1297           status: supported
1298           default: true
1299           required: false
1300         qos_policy:
1301           description: The name or ID of QoS policy to attach to this port
1302           type: string
1303           status: supported
1304           required: false
1305         allowed_address_pairs:
1306           description: Additional MAC/IP address pairs allowed to pass through the port
1307           type: list
1308           status: supported
1309           entry_schema:
1310             type: org.openecomp.datatypes.heat.network.AddressPair
1311           required: false
1312         binding:vnic_type:
1313           description: The vnic type to be bound on the neutron port
1314           type: string
1315           status: supported
1316           required: false
1317           constraints:
1318           - valid_values:
1319             - macvtap
1320             - direct
1321             - normal
1322         value_specs:
1323           description: Extra parameters to include in the request
1324           type: map
1325           status: supported
1326           entry_schema:
1327             type: string
1328           default: {}
1329           required: false
1330
1331     org.openecomp.datatypes.heat.contrailV2.network.rule.SrcPortPairs:
1332       derived_from: tosca.datatypes.Root
1333       description: source port pairs
1334       properties:
1335         network_policy_entries_policy_rule_src_ports_start_port:
1336           description: Start port
1337           type: string
1338           status: supported
1339           required: false
1340         network_policy_entries_policy_rule_src_ports_end_port:
1341           description: End port
1342           type: string
1343           status: supported
1344           required: false
1345
1346     org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPair:
1347       derived_from: tosca.datatypes.Root
1348       description: Virtual Machine Sub Interface Address Pair.
1349       properties:
1350         address_mode:
1351           description: Address Mode.
1352           type: string
1353           status: supported
1354           required: false
1355         ip:
1356           description: IP.
1357           type: org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPairIp
1358           status: supported
1359           required: false
1360         mac:
1361           description: Mac.
1362           type: string
1363           status: supported
1364           required: false
1365
1366     org.openecomp.datatypes.heat.contrailV2.network.rule.DstVirtualNetwork:
1367       derived_from: tosca.datatypes.Root
1368       description: destination addresses
1369       properties:
1370         network_policy_entries_policy_rule_dst_addresses_virtual_network:
1371           description: Destination addresses Virtual network
1372           type: string
1373           status: supported
1374           required: false
1375
1376     org.openecomp.datatypes.heat.contrailV2.network.rule.Rule:
1377       derived_from: tosca.datatypes.Root
1378       description: policy rule
1379       properties:
1380         network_policy_entries_policy_rule_dst_addresses:
1381           description: Destination addresses
1382           type: list
1383           status: supported
1384           entry_schema:
1385             type: org.openecomp.datatypes.heat.contrailV2.network.rule.DstVirtualNetwork
1386           required: false
1387         network_policy_entries_policy_rule_dst_ports:
1388           description: Destination ports
1389           type: list
1390           status: supported
1391           entry_schema:
1392             type: org.openecomp.datatypes.heat.contrailV2.network.rule.DstPortPairs
1393           required: false
1394         network_policy_entries_policy_rule_protocol:
1395           description: Protocol
1396           type: string
1397           status: supported
1398           required: false
1399         network_policy_entries_policy_rule_src_addresses:
1400           description: Source addresses
1401           type: list
1402           status: supported
1403           entry_schema:
1404             type: org.openecomp.datatypes.heat.contrailV2.network.rule.SrcVirtualNetwork
1405           required: false
1406         network_policy_entries_policy_rule_direction:
1407           description: Direction
1408           type: string
1409           status: supported
1410           required: false
1411         network_policy_entries_policy_rule_src_ports:
1412           description: Source ports
1413           type: list
1414           status: supported
1415           entry_schema:
1416             type: org.openecomp.datatypes.heat.contrailV2.network.rule.SrcPortPairs
1417           required: false
1418         network_policy_entries_policy_rule_action_list:
1419           description: Action list
1420           type: org.openecomp.datatypes.heat.contrailV2.network.rule.ActionList
1421           status: supported
1422           required: false
1423
1424     org.openecomp.datatypes.heat.network.neutron.SecurityRules.Rule:
1425       derived_from: tosca.datatypes.Root
1426       description: Rules Pairs
1427       properties:
1428         remote_group_id:
1429           description: The remote group ID to be associated with this security group rule
1430           type: string
1431           status: supported
1432           required: false
1433         protocol:
1434           description: The protocol that is matched by the security group rule
1435           type: string
1436           status: supported
1437           required: false
1438           constraints:
1439           - valid_values:
1440             - tcp
1441             - udp
1442             - icmp
1443         ethertype:
1444           description: Ethertype of the traffic
1445           type: string
1446           status: supported
1447           default: IPv4
1448           required: false
1449           constraints:
1450           - valid_values:
1451             - IPv4
1452             - IPv6
1453         port_range_max:
1454           description: 'The maximum port number in the range that is matched by the          security group rule. '
1455           type: integer
1456           status: supported
1457           required: false
1458           constraints:
1459           - in_range:
1460             - 0
1461             - 65535
1462         remote_ip_prefix:
1463           description: The remote IP prefix (CIDR) to be associated with this security group rule
1464           type: string
1465           status: supported
1466           required: false
1467         remote_mode:
1468           description: Whether to specify a remote group or a remote IP prefix
1469           type: string
1470           status: supported
1471           default: remote_ip_prefix
1472           required: false
1473           constraints:
1474           - valid_values:
1475             - remote_ip_prefix
1476             - remote_group_id
1477         direction:
1478           description: The direction in which the security group rule is applied
1479           type: string
1480           status: supported
1481           default: ingress
1482           required: false
1483           constraints:
1484           - valid_values:
1485             - egress
1486             - ingress
1487         port_range_min:
1488           description: The minimum port number in the range that is matched by the security group rule.
1489           type: integer
1490           status: supported
1491           required: false
1492           constraints:
1493           - in_range:
1494             - 0
1495             - 65535
1496
1497     org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.ref.data.IpamSubnet:
1498       derived_from: tosca.datatypes.Root
1499       description: Network Ipam Ref Data Subnet
1500       properties:
1501         network_ipam_refs_data_ipam_subnets_subnet_ip_prefix_len:
1502           description: Network ipam refs data ipam subnets ip prefix len
1503           type: string
1504           status: supported
1505           required: false
1506         network_ipam_refs_data_ipam_subnets_subnet_ip_prefix:
1507           description: Network ipam refs data ipam subnets ip prefix
1508           type: string
1509           status: supported
1510           required: false
1511
1512     org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.Properties:
1513       derived_from: tosca.datatypes.Root
1514       description: Virtual Machine Sub Interface VLAN Properties.
1515       properties:
1516         sub_interface_vlan_tag:
1517           description: Sub Interface VLAN Tag.
1518           type: string
1519           status: supported
1520           required: false
1521
1522     org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPairIp:
1523       derived_from: tosca.datatypes.Root
1524       description: Virtual Machine Sub Interface Address Pair IP.
1525       properties:
1526         ip_prefix:
1527           description: IP Prefix.
1528           type: string
1529           status: supported
1530           required: false
1531         ip_prefix_len:
1532           description: IP Prefix Len.
1533           type: integer
1534           status: supported
1535           required: false
1536
1537     org.openecomp.datatypes.heat.contrailV2.network.rule.SrcVirtualNetwork:
1538       derived_from: tosca.datatypes.Root
1539       description: source addresses
1540       properties:
1541         network_policy_entries_policy_rule_src_addresses_virtual_network:
1542           description: Source addresses Virtual network
1543           type: string
1544           status: supported
1545           required: false
1546
1547     org.openecomp.datatypes.heat.contrailV2.network.rule.ActionList:
1548       derived_from: tosca.datatypes.Root
1549       description: Action List
1550       properties:
1551         network_policy_entries_policy_rule_action_list_simple_action:
1552           description: Simple Action
1553           type: string
1554           status: supported
1555           required: false
1556         network_policy_entries_policy_rule_action_list_apply_service:
1557           description: Apply Service
1558           type: list
1559           status: supported
1560           entry_schema:
1561             type: string
1562           required: false
1563
1564     org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.IpamRefData:
1565       derived_from: tosca.datatypes.Root
1566       description: Network Ipam Ref Data
1567       properties:
1568         network_ipam_refs_data_ipam_subnets:
1569           description: Network ipam refs data ipam subnets
1570           type: list
1571           status: supported
1572           entry_schema:
1573             type: org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.ref.data.IpamSubnetList
1574           required: false
1575
1576     org.openecomp.datatypes.heat.FileInfo:
1577       derived_from: tosca.datatypes.Root
1578       description: Heat File Info
1579       properties:
1580         file:
1581           description: The required URI string (relative or absolute) which can be used to locate the file
1582           type: string
1583           status: supported
1584           required: true
1585         file_type:
1586           description: The type of the file
1587           type: string
1588           status: supported
1589           required: true
1590           constraints:
1591           - valid_values:
1592             - base
1593             - env
1594             - volume
1595             - network
1596
1597     org.openecomp.datatypes.heat.network.contrail.InterfaceData:
1598       derived_from: tosca.datatypes.Root
1599       description: Interface Data
1600       properties:
1601         static_routes:
1602           description: An ordered list of static routes to be added to this interface
1603           type: list
1604           status: supported
1605           entry_schema:
1606             type: org.openecomp.datatypes.heat.network.contrail.port.StaticRoute
1607           required: false
1608         virtual_network:
1609           description: Virtual Network for this interface
1610           type: string
1611           status: supported
1612           required: true
1613         allowed_address_pairs:
1614           description: List of allowed address pair for this interface
1615           type: list
1616           status: supported
1617           entry_schema:
1618             type: org.openecomp.datatypes.heat.network.contrail.AddressPair
1619           required: false
1620         ip_address:
1621           description: IP for this interface
1622           type: string
1623           status: supported
1624           required: false
1625
1626     org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.RefData:
1627       derived_from: tosca.datatypes.Root
1628       description: network policy refs data
1629       properties:
1630         network_policy_refs_data_sequence:
1631           description: Network Policy ref data sequence
1632           type: org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.RefDataSequence
1633           status: supported
1634           required: false
1635
1636     org.openecomp.datatypes.heat.contrailV2.network.rule.DstPortPairs:
1637       derived_from: tosca.datatypes.Root
1638       description: destination port pairs
1639       properties:
1640         network_policy_entries_policy_rule_dst_ports_start_port:
1641           description: Start port
1642           type: string
1643           status: supported
1644           required: false
1645         network_policy_entries_policy_rule_dst_ports_end_port:
1646           description: End port
1647           type: string
1648           status: supported
1649           required: false
1650
1651     org.openecomp.datatypes.heat.network.AllocationPool:
1652       derived_from: tosca.datatypes.Root
1653       description: The start and end addresses for the allocation pool
1654       properties:
1655         start:
1656           description: Start address for the allocation pool
1657           type: string
1658           status: supported
1659           required: false
1660         end:
1661           description: End address for the allocation pool
1662           type: string
1663           status: supported
1664           required: false
1665
1666     org.openecomp.datatypes.heat.contrail.network.rule.PortPairs:
1667       derived_from: tosca.datatypes.Root
1668       description: source and destination port pairs
1669       properties:
1670         start_port:
1671           description: Start port
1672           type: string
1673           status: supported
1674           required: false
1675         end_port:
1676           description: End port
1677           type: string
1678           status: supported
1679           required: false
1680
1681     org.openecomp.datatypes.heat.contrail.network.rule.VirtualNetwork:
1682       derived_from: tosca.datatypes.Root
1683       description: source and destination addresses
1684       properties:
1685         virtual_network:
1686           description: Virtual network
1687           type: string
1688           status: supported
1689           required: false
1690
1691     org.openecomp.datatypes.heat.contrail.network.rule.RuleList:
1692       derived_from: tosca.datatypes.Root
1693       description: list of policy rules
1694       properties:
1695         policy_rule:
1696           description: Contrail network rule
1697           type: list
1698           status: supported
1699           entry_schema:
1700             type: org.openecomp.datatypes.heat.contrail.network.rule.Rule
1701           required: false
1702
1703     org.openecomp.datatypes.heat.network.contrail.AddressPair:
1704       derived_from: tosca.datatypes.Root
1705       description: Address Pair
1706       properties:
1707         address_mode:
1708           description: Address mode active-active or active-standy
1709           type: string
1710           status: supported
1711           required: false
1712           constraints:
1713           - valid_values:
1714             - active-active
1715             - active-standby
1716         prefix:
1717           description: IP address prefix
1718           type: string
1719           status: supported
1720           required: false
1721         mac_address:
1722           description: Mac address
1723           type: string
1724           status: supported
1725           required: false
1726
1727     org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.MacAddress:
1728       derived_from: tosca.datatypes.Root
1729       description: Virtual Machine Sub Interface Mac Address.
1730       properties:
1731         mac_address:
1732           description: Mac Addresses List.
1733           type: list
1734           status: supported
1735           entry_schema:
1736             type: string
1737           required: false
1738
1739     org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.ref.data.IpamSubnetList:
1740       derived_from: tosca.datatypes.Root
1741       description: Network Ipam Ref Data Subnet List
1742       properties:
1743         network_ipam_refs_data_ipam_subnets_subnet:
1744           description: Network ipam refs data ipam subnets
1745           type: org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.ref.data.IpamSubnet
1746           status: supported
1747           required: false
1748         network_ipam_refs_data_ipam_subnets_addr_from_start:
1749           description: Network ipam refs data ipam subnets addr from start
1750           type: string
1751           status: supported
1752           required: false
1753
1754     org.openecomp.datatypes.heat.contrailV2.network.rule.RuleList:
1755       derived_from: tosca.datatypes.Root
1756       description: list of policy rules
1757       properties:
1758         network_policy_entries_policy_rule:
1759           description: Contrail network rule
1760           type: list
1761           status: supported
1762           entry_schema:
1763             type: org.openecomp.datatypes.heat.contrailV2.network.rule.Rule
1764           required: false
1765
1766     org.openecomp.datatypes.heat.novaServer.network.AddressInfo:
1767       derived_from: tosca.datatypes.network.NetworkInfo
1768       description: Network addresses with corresponding port id
1769       properties:
1770         port_id:
1771           description: Port id
1772           type: string
1773           status: supported
1774           required: false
1775
1776     org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPairs:
1777       derived_from: tosca.datatypes.Root
1778       description: Virtual Machine Sub Interface Address Pairs.
1779       properties:
1780         allowed_address_pair:
1781           description: Addresses pair List.
1782           type: list
1783           status: supported
1784           entry_schema:
1785             type: org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPair
1786           required: false
1787
1788     org.openecomp.datatypes.heat.neutron.port.FixedIps:
1789       derived_from: tosca.datatypes.Root
1790       description: subnet/ip_address
1791       properties:
1792         subnet:
1793           description: Subnet in which to allocate the IP address for this port
1794           type: string
1795           status: supported
1796           required: false
1797         ip_address:
1798           description: IP address desired in the subnet for this port
1799           type: string
1800           status: supported
1801           required: false
1802
1803     org.openecomp.datatypes.heat.contrailV2.virtual.machine.interface.Properties:
1804       derived_from: tosca.datatypes.Root
1805       description: Virtual Machine Interface Properties.
1806       properties:
1807         service_interface_type:
1808           description: Service Interface Type.
1809           type: string
1810           status: SUPPORTED
1811           required: false
1812
1813     org.openecomp.datatypes.heat.network.subnet.HostRoute:
1814       derived_from: tosca.datatypes.Root
1815       description: Host route info for the subnet
1816       properties:
1817         destination:
1818           description: The destination for static route
1819           type: string
1820           status: supported
1821           required: false
1822         nexthop:
1823           description: The next hop for the destination
1824           type: string
1825           status: supported
1826           required: false
1827
1828     org.openecomp.datatypes.heat.network.contrail.port.StaticRoute:
1829       derived_from: tosca.datatypes.Root
1830       description: static route
1831       properties:
1832         prefix:
1833           description: Route prefix
1834           type: string
1835           status: supported
1836           required: false
1837         next_hop:
1838           description: Next hop
1839           type: string
1840           status: supported
1841           required: false
1842         next_hop_type:
1843           description: Next hop type
1844           type: string
1845           status: supported
1846           required: false
1847
1848     org.openecomp.datatypes.substitution.SubstitutionFiltering:
1849       derived_from: tosca.datatypes.Root
1850       description: Substitution Filter
1851       properties:
1852         substitute_service_template:
1853           description: Substitute Service Template
1854           type: string
1855           status: supported
1856           required: true
1857         index_value:
1858           description: Index value of the substitution service template runtime instance
1859           type: integer
1860           status: supported
1861           default: 0
1862           required: false
1863           constraints:
1864           - greater_or_equal: 0
1865         count:
1866           description: Count
1867           type: float
1868           status: supported
1869           default: 1
1870           required: false
1871         scaling_enabled:
1872           description: Indicates whether service scaling is enabled
1873           type: boolean
1874           status: supported
1875           default: true
1876           required: false
1877         mandatory:
1878           description: Mandatory
1879           type: boolean
1880           status: supported
1881           default: true
1882           required: false
1883
1884     org.openecomp.datatypes.heat.network.neutron.Subnet:
1885       derived_from: tosca.datatypes.Root
1886       description: A subnet represents an IP address block that can be used for assigning IP addresses to virtual instances
1887       properties:
1888         tenant_id:
1889           description: The ID of the tenant who owns the network
1890           type: string
1891           status: supported
1892           required: false
1893         enable_dhcp:
1894           description: Set to true if DHCP is enabled and false if DHCP is disabled
1895           type: boolean
1896           status: supported
1897           default: true
1898           required: false
1899         ipv6_address_mode:
1900           description: IPv6 address mode
1901           type: string
1902           status: supported
1903           required: false
1904           constraints:
1905           - valid_values:
1906             - dhcpv6-stateful
1907             - dhcpv6-stateless
1908             - slaac
1909         ipv6_ra_mode:
1910           description: IPv6 RA (Router Advertisement) mode
1911           type: string
1912           status: supported
1913           required: false
1914           constraints:
1915           - valid_values:
1916             - dhcpv6-stateful
1917             - dhcpv6-stateless
1918             - slaac
1919         value_specs:
1920           description: Extra parameters to include in the request
1921           type: map
1922           status: supported
1923           entry_schema:
1924             type: string
1925           default: {}
1926           required: false
1927         allocation_pools:
1928           description: The start and end addresses for the allocation pools
1929           type: list
1930           status: supported
1931           entry_schema:
1932             type: org.openecomp.datatypes.heat.network.AllocationPool
1933           required: false
1934         subnetpool:
1935           description: The name or ID of the subnet pool
1936           type: string
1937           status: supported
1938           required: false
1939         dns_nameservers:
1940           description: A specified set of DNS name servers to be used
1941           type: list
1942           status: supported
1943           entry_schema:
1944             type: string
1945           default: []
1946           required: false
1947         host_routes:
1948           description: The gateway IP address
1949           type: list
1950           status: supported
1951           entry_schema:
1952             type: org.openecomp.datatypes.heat.network.subnet.HostRoute
1953           required: false
1954         ip_version:
1955           description: The gateway IP address
1956           type: integer
1957           status: supported
1958           default: 4
1959           required: false
1960           constraints:
1961           - valid_values:
1962             - 4
1963             - 6
1964         name:
1965           description: The name of the subnet
1966           type: string
1967           status: supported
1968           required: false
1969         prefixlen:
1970           description: Prefix length for subnet allocation from subnet pool
1971           type: integer
1972           status: supported
1973           required: false
1974           constraints:
1975           - greater_or_equal: 0
1976         cidr:
1977           description: The CIDR
1978           type: string
1979           status: supported
1980           required: false
1981         gateway_ip:
1982           description: The gateway IP address
1983           type: string
1984           status: supported
1985           required: false
1986
1987     org.openecomp.datatypes.heat.contrail.network.rule.Rule:
1988       derived_from: tosca.datatypes.Root
1989       description: policy rule
1990       properties:
1991         src_ports:
1992           description: Source ports
1993           type: list
1994           status: supported
1995           entry_schema:
1996             type: org.openecomp.datatypes.heat.contrail.network.rule.PortPairs
1997           required: false
1998         protocol:
1999           description: Protocol
2000           type: string
2001           status: supported
2002           required: false
2003         dst_addresses:
2004           description: Destination addresses
2005           type: list
2006           status: supported
2007           entry_schema:
2008             type: org.openecomp.datatypes.heat.contrail.network.rule.VirtualNetwork
2009           required: false
2010         apply_service:
2011           description: Service to apply
2012           type: string
2013           status: supported
2014           required: false
2015         dst_ports:
2016           description: Destination ports
2017           type: list
2018           status: supported
2019           entry_schema:
2020             type: org.openecomp.datatypes.heat.contrail.network.rule.PortPairs
2021           required: false
2022         src_addresses:
2023           description: Source addresses
2024           type: list
2025           status: supported
2026           entry_schema:
2027             type: org.openecomp.datatypes.heat.contrail.network.rule.VirtualNetwork
2028           required: false
2029         direction:
2030           description: Direction
2031           type: string
2032           status: supported
2033           required: false
2034
2035     org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.RefDataSequence:
2036       derived_from: tosca.datatypes.Root
2037       description: network policy refs data sequence
2038       properties:
2039         network_policy_refs_data_sequence_major:
2040           description: Network Policy ref data sequence Major
2041           type: integer
2042           status: supported
2043           required: false
2044         network_policy_refs_data_sequence_minor:
2045           description: Network Policy ref data sequence Minor
2046           type: integer
2047           status: supported
2048           required: false
2049
2050     org.openecomp.datatypes.Naming:
2051       derived_from: tosca.datatypes.Root
2052       description: Naming
2053       properties:
2054         ecomp_generated_naming:
2055           description: |
2056             "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).
2057           type: boolean
2058           default: true
2059           required: false
2060           status: supported
2061         naming_policy:
2062           description: Reference to naming policy that ECOMP will use when the name is auto-generated
2063           type: string
2064           required: false
2065           status: supported
2066         instance_name:
2067           description: Reference to naming policy that ECOMP will use when the name is auto-generated
2068           type: string
2069           required: false
2070           status: supported
2071
2072     org.openecomp.datatypes.EcompGeneratedNaming:
2073       derived_from: org.openecomp.datatypes.Naming
2074       description: Naming
2075       properties:
2076         naming_policy:
2077           description: Referenc to naming policy that ECOMP will use when the name is auto-generated
2078           type: string
2079           required: false
2080
2081     org.openecomp.datatypes.UserDefinedNaming:
2082       derived_from: org.openecomp.datatypes.Naming
2083       description: Naming
2084       properties:
2085         instance_name:
2086           description: Reference to naming policy that ECOMP will use when the name is auto-generated
2087           type: string
2088           required: false
2089
2090     org.openecomp.datatypes.Root:
2091       derived_from: tosca.datatypes.Root
2092       description: >
2093         The AT&T root Data Type all other Data Types derive from
2094       properties:
2095         supplemental_data:
2096           type: map
2097           entry_schema:
2098             description: >
2099                A placeholder for missing properties that would be included in future ecomp model versions.
2100                fromat <key>:<value>
2101             type: string
2102
2103     org.openecomp.datatypes.EcompHoming:
2104       derived_from: org.openecomp.datatypes.Root
2105       properties:
2106         ecomp_selected_instance_node_target:
2107           type: boolean
2108           required: true
2109           default: false
2110           description: >
2111             "true" indicates that the target deployment node for this instance will be auto-selected by ECOMP
2112             "false" indicates operator-supplied instance target deployment node required (e.g. VID will present a prompt to operator and collect the
2113             operator-selected target node for the deployment of this Network instance).
2114         homing_policy:
2115           type: string
2116           required: false
2117           description: Referenc to a service level homing policy that ECOMP will use for instance deployment target node
2118         instance_node_target:
2119           type: string
2120           required: false
2121           description: Instance target deployment node
2122
2123     org.openecomp.datatypes.EcompNaming:
2124       derived_from: org.openecomp.datatypes.Root
2125       properties:
2126         ecomp_generated_naming:
2127           type: boolean
2128           required: true
2129           default: true
2130           description: >
2131             "true" indicates that the name for the instance will be auto-generated by ECOMP.
2132             "false" indicates operator-supplied name required (e.g. VID will present prompt to operator and collect the operator-supplied instance name).
2133         naming_policy:
2134           type: string
2135           required: false
2136           description: Referenc to naming policy that ECOMP will use when the name is auto-generated
2137     org.openecomp.datatypes.network.NetworkAssignments:
2138       derived_from: org.openecomp.datatypes.Root
2139       properties:
2140         ecomp_generated_network_assignment:
2141           type: boolean
2142           required: true
2143           default: false
2144           description: >
2145             "true" indicates that the network assignments will be auto-generated by ECOMP
2146             "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).
2147         network_assignments_file:
2148           type: string
2149           required: false
2150           description: Filename of the template that specifies all of the configurable name/value pairs of Network assignments in this Network model
2151         multi_tenant:
2152           type: boolean
2153           required: true
2154           default: true
2155           description: true means this network is shared by multiple Openstack tenants
2156         min_subnets_count:
2157           type: integer
2158           required: true
2159           description: Quantity of subnets that must be initially assigned
2160         ip_network_address_plan:
2161           type: string
2162           required: true
2163           description: Reference to EIPAM, VLAN or other address plan ID used to assign subnets to this network
2164         vlan_network_address_plan:
2165           type: string
2166           required: true
2167           description: Reference to VLAN or other address plan ID used to assign subnets to this network
2168     org.openecomp.datatypes.network.PhysicalNetwork:
2169       derived_from: org.openecomp.datatypes.Root
2170       properties:
2171         provider_network:
2172           type: boolean
2173           required: true
2174           description: true indicates that this a Neutron provider type of network
2175         physical_network_name:
2176           type: string
2177           required: false
2178           constraint:
2179             - valid_values:
2180                - Physnet-SRIOV-1
2181                - Physnet-SRIOV-2
2182                - Physnet-SRIOV-11
2183                - Physnet-SRIOV-12
2184           description: >
2185             Identifies the NUMA processor cluster to which this physical network interface belongs.
2186             NUMA instance correlates to the first digit of the Physical Network Name suffix (e.g. "01" = NUMA 0, "11" = NUMA 1)
2187         numa:
2188           type: string
2189           required: false
2190           constraint:
2191             - valid_values:
2192               - NUMA 0
2193               - NUMA 1
2194           description: >
2195             PNIC instance within the NUMA processor cluster
2196             PNIC Instance correlates to the second digit of the Physical Network Name suffix (e.g. "01" = PNIC 1, "02" = "PNIC 2)
2197         pnic_instance:
2198           type: integer
2199           required: false
2200           description: PNIC instance within the NUMA processor cluster
2201
2202     org.openecomp.datatypes.network.NetworkFlows:
2203       derived_from: org.openecomp.datatypes.Root
2204       properties:
2205         is_network_policy:
2206           type: boolean
2207           required: false
2208           default: false
2209           description: true indicates the network has 1 or more policies
2210         network_policy:
2211           type: string
2212           required: flase
2213           description: Identifies the specific Cloud network policy that must be applied to this network (source - from Policy Manager)
2214         vpn_binding:
2215           type: string
2216           required: false
2217           description: Identifies the specific VPN Binding entry in A&AI that must be applied when creating this network (source - A&AI)
2218
2219     org.openecomp.datatypes.Artifact:
2220       derived_from: org.openecomp.datatypes.Root
2221       properties:
2222         artifact_name:
2223           type: string
2224           required: true
2225           description: Artifcat name
2226         artifact_type:
2227           type: string
2228           required: true
2229           description: Artifcat type
2230         artifact_uuid:
2231           type: string
2232           required: true
2233           description: Artifcat UUID
2234         artifact_checksum:
2235           type: string
2236           required: true
2237           description: Artifact checksum
2238         artifact_url:
2239           type: string
2240           required: true
2241           description: Artifcay URL. Can also include only the file name