catalog-be/src/main/resources/import/tosca/data-types/dataTypes.yml

   1 tosca.datatypes.Root:
   2   description: The TOSCA root Data Type all other TOSCA base Data Types derive from
   3
   4 integer:
   5   derived_from: tosca.datatypes.Root
   6
   7 string:
   8   derived_from: tosca.datatypes.Root
   9
  10 boolean:
  11   derived_from: tosca.datatypes.Root
  12
  13 float:
  14   derived_from: tosca.datatypes.Root
  15
  16 list:
  17   derived_from: tosca.datatypes.Root
  18
  19 map:
  20   derived_from: tosca.datatypes.Root
  21
  22 json:
  23   derived_from: tosca.datatypes.Root
  24
  25 scalar-unit:
  26   derived_from: tosca.datatypes.Root
  27
  28 scalar-unit.size:
  29   derived_from: scalar-unit
  30
  31 scalar-unit.time:
  32   derived_from: scalar-unit
  33
  34 scalar-unit.frequency:
  35   derived_from: scalar-unit
  36
  37
  38 tosca.datatypes.Credential:
  39   derived_from: tosca.datatypes.Root
  40   properties:
  41     protocol:
  42       type: string
  43       required: false
  44     token_type:
  45       type: string
  46       default: password
  47     token:
  48       type: string
  49     keys:
  50       type: map
  51       required: false
  52       entry_schema:
  53         type: string
  54     user:
  55       type: string
  56       required: false
  57
  58 tosca.datatypes.TimeInterval:
  59   derived_from: tosca.datatypes.Root
  60   properties:
  61     start_time:
  62       type: timestamp
  63       required: true
  64     end_time:
  65       type: timestamp
  66       required: true
  67
  68 tosca.datatypes.network.NetworkInfo:
  69   derived_from: tosca.datatypes.Root
  70   properties:
  71     network_name:
  72       type: string
  73     network_id:
  74       type: string
  75     addresses:
  76       type: list
  77       entry_schema:
  78         type: string
  79
  80 tosca.datatypes.network.PortInfo:
  81   derived_from: tosca.datatypes.Root
  82   properties:
  83     port_name:
  84       type: string
  85     port_id:
  86       type: string
  87     network_id:
  88       type: string
  89     mac_address:
  90       type: string
  91     addresses:
  92       type: list
  93       entry_schema:
  94         type: string
  95
  96 tosca.datatypes.network.PortDef:
  97   derived_from: integer
  98   constraints:
  99     - in_range: [ 1, 65535 ]
 100
 101 tosca.datatypes.network.PortSpec:
 102   derived_from: tosca.datatypes.Root
 103   properties:
 104     protocol:
 105       type: string
 106       required: true
 107       default: tcp
 108       constraints:
 109         - valid_values: [ udp, tcp, igmp ]
 110     target:
 111       type: tosca.datatypes.network.PortDef
 112     target_range:
 113       type: range
 114       constraints:
 115         - in_range: [ 1, 65535 ]
 116     source:
 117       type: tosca.datatypes.network.PortDef
 118     source_range:
 119       type: range
 120       constraints:
 121         - in_range: [ 1, 65535 ]
 122
 123 ###################new Data Types Onboarding Integration##########################
 124
 125 org.openecomp.datatypes.heat.network.AddressPair:
 126   derived_from: tosca.datatypes.Root
 127   description: MAC/IP address pairs
 128   properties:
 129     mac_address:
 130       type: string
 131       description: MAC address
 132       required: false
 133       status: SUPPORTED
 134     ip_address:
 135       type: string
 136       description: IP address
 137       required: false
 138       status: SUPPORTED
 139
 140 org.openecomp.datatypes.heat.network.subnet.HostRoute:
 141   derived_from: tosca.datatypes.Root
 142   description: Host route info for the subnet
 143   properties:
 144     destination:
 145       type: string
 146       description: The destination for static route
 147       required: false
 148       status: SUPPORTED
 149     nexthop:
 150       type: string
 151       description: The next hop for the destination
 152       required: false
 153       status: SUPPORTED
 154
 155 org.openecomp.datatypes.heat.network.AllocationPool:
 156   derived_from: tosca.datatypes.Root
 157   description: The start and end addresses for the allocation pool
 158   properties:
 159     start:
 160       type: string
 161       description: Start address for the allocation pool
 162       required: false
 163       status: SUPPORTED
 164     end:
 165       type: string
 166       description: End address for the allocation pool
 167       required: false
 168       status: SUPPORTED
 169
 170 org.openecomp.datatypes.heat.network.neutron.Subnet:
 171   derived_from: tosca.datatypes.Root
 172   description: A subnet represents an IP address block that can be used for assigning IP addresses to virtual instances
 173   properties:
 174     tenant_id:
 175       type: string
 176       description: The ID of the tenant who owns the network
 177       required: false
 178       status: SUPPORTED
 179     enable_dhcp:
 180       type: boolean
 181       description: Set to true if DHCP is enabled and false if DHCP is disabled
 182       required: false
 183       default: true
 184       status: SUPPORTED
 185     ipv6_address_mode:
 186       type: string
 187       description: IPv6 address mode
 188       required: false
 189       status: SUPPORTED
 190       constraints:
 191       - valid_values:
 192         - dhcpv6-stateful
 193         - dhcpv6-stateless
 194         - slaac
 195     ipv6_ra_mode:
 196       type: string
 197       description: IPv6 RA (Router Advertisement) mode
 198       required: false
 199       status: SUPPORTED
 200       constraints:
 201       - valid_values:
 202         - dhcpv6-stateful
 203         - dhcpv6-stateless
 204         - slaac
 205     value_specs:
 206       type: map
 207       description: Extra parameters to include in the request
 208       required: false
 209       default: {
 210         }
 211       status: SUPPORTED
 212       entry_schema:
 213         type: string
 214     allocation_pools:
 215        type: list
 216        description: The start and end addresses for the allocation pools
 217        required: false
 218        status: SUPPORTED
 219        entry_schema:
 220          type: org.openecomp.datatypes.heat.network.AllocationPool
 221     subnetpool:
 222       type: string
 223       description: The name or ID of the subnet pool
 224       required: false
 225       status: SUPPORTED
 226     dns_nameservers:
 227       type: list
 228       description: A specified set of DNS name servers to be used
 229       required: false
 230       default: [
 231         ]
 232       status: SUPPORTED
 233       entry_schema:
 234         type: string
 235     host_routes:
 236       type: list
 237       description: The gateway IP address
 238       required: false
 239       status: SUPPORTED
 240       entry_schema:
 241         type: org.openecomp.datatypes.heat.network.subnet.HostRoute
 242     ip_version:
 243       type: integer
 244       description: The gateway IP address
 245       required: false
 246       default: 4
 247       status: SUPPORTED
 248       constraints:
 249       - valid_values:
 250         - '4'
 251         - '6'
 252     name:
 253       type: string
 254       description: The name of the subnet
 255       required: false
 256       status: SUPPORTED
 257     prefixlen:
 258       type: integer
 259       description: Prefix length for subnet allocation from subnet pool
 260       required: false
 261       status: SUPPORTED
 262       constraints:
 263       - greater_or_equal: 0
 264     cidr:
 265       type: string
 266       description: The CIDR
 267       required: false
 268       status: SUPPORTED
 269     gateway_ip:
 270       type: string
 271       description: The gateway IP address
 272       required: false
 273       status: SUPPORTED
 274
 275 org.openecomp.datatypes.heat.novaServer.network.PortExtraProperties:
 276   derived_from: tosca.datatypes.Root
 277   description: Nova server network expand properties for port
 278   properties:
 279     port_security_enabled:
 280       type: boolean
 281       description: Flag to enable/disable port security on the port
 282       required: false
 283       status: SUPPORTED
 284     mac_address:
 285       type: string
 286       description: MAC address to give to this port
 287       required: false
 288       status: SUPPORTED
 289     admin_state_up:
 290       type: boolean
 291       description: The administrative state of this port
 292       required: false
 293       default: true
 294       status: SUPPORTED
 295     qos_policy:
 296       type: string
 297       description: The name or ID of QoS policy to attach to this port
 298       required: false
 299       status: SUPPORTED
 300     allowed_address_pairs:
 301       type: list
 302       description: Additional MAC/IP address pairs allowed to pass through the port
 303       required: false
 304       status: SUPPORTED
 305       entry_schema:
 306         type: org.openecomp.datatypes.heat.network.AddressPair
 307     binding:vnic_type:
 308       type: string
 309       description: The vnic type to be bound on the neutron port
 310       required: false
 311       status: SUPPORTED
 312       constraints:
 313       - valid_values:
 314         - macvtap
 315         - direct
 316         - normal
 317     value_specs:
 318       type: map
 319       description: Extra parameters to include in the request
 320       required: false
 321       default: {
 322         }
 323       status: SUPPORTED
 324       entry_schema:
 325         type: string
 326
 327 org.openecomp.datatypes.heat.novaServer.network.AddressInfo:
 328   derived_from: tosca.datatypes.network.NetworkInfo
 329   description: Network addresses with corresponding port id
 330   properties:
 331     port_id:
 332       type: string
 333       description: Port id
 334       required: false
 335       status: SUPPORTED
 336
 337 org.openecomp.datatypes.heat.neutron.port.FixedIps:
 338   derived_from: tosca.datatypes.Root
 339   description: subnet/ip_address
 340   properties:
 341     subnet:
 342       type: string
 343       description: Subnet in which to allocate the IP address for this port
 344       required: false
 345       status: SUPPORTED
 346     ip_address:
 347       type: string
 348       description: IP address desired in the subnet for this port
 349       required: false
 350       status: SUPPORTED
 351
 352 org.openecomp.datatypes.heat.FileInfo:
 353   derived_from: tosca.datatypes.Root
 354   description: Heat File Info
 355   properties:
 356     file:
 357       type: string
 358       description: The required URI string (relative or absolute) which can be used to locate the file
 359       required: true
 360       status: SUPPORTED
 361     file_type:
 362       type: string
 363       description: The type of the file
 364       required: true
 365       status: SUPPORTED
 366       constraints:
 367       - valid_values:
 368         - base
 369         - env
 370         - volume
 371         - network
 372
 373 org.openecomp.datatypes.heat.contrail.network.rule.PortPairs:
 374     derived_from: tosca.datatypes.Root
 375     description: source and destination port pairs
 376     properties:
 377       start_port:
 378         type: string
 379         description: Start port
 380         required: false
 381         status: SUPPORTED
 382       end_port:
 383         type: string
 384         description: End port
 385         required: false
 386         status: SUPPORTED
 387
 388 org.openecomp.datatypes.heat.contrail.network.rule.Rule:
 389     derived_from: tosca.datatypes.Root
 390     description: policy rule
 391     properties:
 392       src_ports:
 393         type: list
 394         description: Source ports
 395         required: false
 396         status: SUPPORTED
 397         entry_schema:
 398           type: org.openecomp.datatypes.heat.contrail.network.rule.PortPairs
 399       protocol:
 400         type: string
 401         description: Protocol
 402         required: false
 403         status: SUPPORTED
 404       dst_addresses:
 405         type: list
 406         description: Destination addresses
 407         required: false
 408         status: SUPPORTED
 409         entry_schema:
 410           type: org.openecomp.datatypes.heat.contrail.network.rule.VirtualNetwork
 411       apply_service:
 412         type: string
 413         description: Service to apply
 414         required: false
 415         status: SUPPORTED
 416       dst_ports:
 417         type: list
 418         description: Destination ports
 419         required: false
 420         status: SUPPORTED
 421         entry_schema:
 422           type: org.openecomp.datatypes.heat.contrail.network.rule.PortPairs
 423       src_addresses:
 424         type: list
 425         description: Source addresses
 426         required: false
 427         status: SUPPORTED
 428         entry_schema:
 429           type: org.openecomp.datatypes.heat.contrail.network.rule.VirtualNetwork
 430       direction:
 431         type: string
 432         description: Direction
 433         required: false
 434         status: SUPPORTED
 435
 436 org.openecomp.datatypes.heat.contrail.network.rule.RuleList:
 437     derived_from: tosca.datatypes.Root
 438     description: list of policy rules
 439     properties:
 440       policy_rule:
 441         type: list
 442         description: Contrail network rule
 443         required: false
 444         status: SUPPORTED
 445         entry_schema:
 446           type: org.openecomp.datatypes.heat.contrail.network.rule.Rule
 447
 448 org.openecomp.datatypes.heat.contrail.network.rule.VirtualNetwork:
 449     derived_from: tosca.datatypes.Root
 450     description: source and destination addresses
 451     properties:
 452       virtual_network:
 453         type: string
 454         description: Virtual network
 455         required: false
 456         status: SUPPORTED
 457
 458 org.openecomp.datatypes.heat.network.neutron.SecurityRules.Rule:
 459     derived_from: tosca.datatypes.Root
 460     description: Rules Pairs
 461     properties:
 462       remote_group_id:
 463         type: string
 464         description: The remote group ID to be associated with this security group rule
 465         required: false
 466         status: SUPPORTED
 467       protocol:
 468         type: string
 469         description: The protocol that is matched by the security group rule
 470         required: false
 471         status: SUPPORTED
 472         constraints:
 473         - valid_values:
 474           - tcp
 475           - udp
 476           - icmp
 477       ethertype:
 478         type: string
 479         description: Ethertype of the traffic
 480         required: false
 481         default: IPv4
 482         status: SUPPORTED
 483         constraints:
 484         - valid_values:
 485           - IPv4
 486           - IPv6
 487       port_range_max:
 488         type: integer
 489         description: 'The maximum port number in the range that is matched by the
 490           security group rule. '
 491         required: false
 492         status: SUPPORTED
 493         constraints:
 494         - in_range:
 495           - 0
 496           - 65535
 497       remote_ip_prefix:
 498         type: string
 499         description: The remote IP prefix (CIDR) to be associated with this security group rule
 500         required: false
 501         status: SUPPORTED
 502       remote_mode:
 503         type: string
 504         description: Whether to specify a remote group or a remote IP prefix
 505         required: false
 506         default: remote_ip_prefix
 507         status: SUPPORTED
 508         constraints:
 509         - valid_values:
 510           - remote_ip_prefix
 511           - remote_group_id
 512       direction:
 513         type: string
 514         description: The direction in which the security group rule is applied
 515         required: false
 516         default: ingress
 517         status: SUPPORTED
 518         constraints:
 519         - valid_values:
 520           - egress
 521           - ingress
 522       port_range_min:
 523         type: integer
 524         description: The minimum port number in the range that is matched by the security group rule.
 525         required: false
 526         status: SUPPORTED
 527         constraints:
 528         - in_range:
 529           - 0
 530           - 65535
 531
 532 org.openecomp.datatypes.heat.substitution.SubstitutionFiltering:
 533     derived_from: tosca.datatypes.Root
 534     description: Substitution Filter
 535     properties:
 536       substitute_service_template:
 537         type: string
 538         description: Substitute Service Template
 539         required: true
 540         status: SUPPORTED
 541       index_value:
 542         type: integer
 543         description: Index value of the substitution service template runtime instance
 544         required: false
 545         default: 0
 546         status: SUPPORTED
 547         constraints:
 548         - greater_or_equal: 0
 549       count:
 550         type: string
 551         description: Count
 552         required: false
 553         default: 1
 554         status: SUPPORTED
 555       scaling_enabled:
 556         type: boolean
 557         description: Indicates whether service scaling is enabled
 558         required: false
 559         default: true
 560         status: SUPPORTED
 561       mandatory:
 562         type: boolean
 563         description: Mandatory
 564         required: false
 565         default: true
 566         status: SUPPORTED
 567
 568 org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.RefDataSequence:
 569     derived_from: tosca.datatypes.Root
 570     description: network policy refs data sequence
 571     properties:
 572       network_policy_refs_data_sequence_major:
 573         type: integer
 574         description: Network Policy ref data sequence Major
 575         required: false
 576         status: SUPPORTED
 577       network_policy_refs_data_sequence_minor:
 578         type: integer
 579         description: Network Policy ref data sequence Minor
 580         required: false
 581         status: SUPPORTED
 582
 583 org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.RefData:
 584     derived_from: tosca.datatypes.Root
 585     description: network policy refs data
 586     properties:
 587       network_policy_refs_data_sequence:
 588         type: org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.RefDataSequence
 589         description: Network Policy ref data sequence
 590         required: false
 591         status: SUPPORTED
 592
 593 org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.ref.data.IpamSubnet:
 594     derived_from: tosca.datatypes.Root
 595     description: Network Ipam Ref Data Subnet
 596     properties:
 597       network_ipam_refs_data_ipam_subnets_subnet_ip_prefix_len:
 598         type: string
 599         description: Network ipam refs data ipam subnets ip prefix len
 600         required: false
 601         status: SUPPORTED
 602       network_ipam_refs_data_ipam_subnets_subnet_ip_prefix:
 603         type: string
 604         description: Network ipam refs data ipam subnets ip prefix
 605         required: false
 606         status: SUPPORTED
 607
 608 org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.ref.data.IpamSubnetList:
 609     derived_from: tosca.datatypes.Root
 610     description: Network Ipam Ref Data Subnet List
 611     properties:
 612       network_ipam_refs_data_ipam_subnets_subnet:
 613         type: org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.ref.data.IpamSubnet
 614         description: Network ipam refs data ipam subnets
 615         required: false
 616         status: SUPPORTED
 617       network_ipam_refs_data_ipam_subnets_addr_from_start:
 618         type: string
 619         description: Network ipam refs data ipam subnets addr from start
 620         required: false
 621         status: SUPPORTED
 622
 623 org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.IpamRefData:
 624     derived_from: tosca.datatypes.Root
 625     description: Network Ipam Ref Data
 626     properties:
 627       network_ipam_refs_data_ipam_subnets:
 628         type: list
 629         description: Network ipam refs data ipam subnets
 630         required: false
 631         status: SUPPORTED
 632         entry_schema:
 633           type: org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.ref.data.IpamSubnetList
 634
 635 org.openecomp.datatypes.heat.contrailV2.network.rule.SrcVirtualNetwork:
 636     derived_from: tosca.datatypes.Root
 637     description: source addresses
 638     properties:
 639       network_policy_entries_policy_rule_src_addresses_virtual_network:
 640         type: string
 641         description: Source addresses Virtual network
 642         required: false
 643         status: SUPPORTED
 644
 645 org.openecomp.datatypes.heat.contrailV2.network.rule.DstVirtualNetwork:
 646     derived_from: tosca.datatypes.Root
 647     description: destination addresses
 648     properties:
 649       network_policy_entries_policy_rule_dst_addresses_virtual_network:
 650         type: string
 651         description: Destination addresses Virtual network
 652         required: false
 653         status: SUPPORTED
 654
 655 org.openecomp.datatypes.heat.contrailV2.network.rule.DstPortPairs:
 656     derived_from: tosca.datatypes.Root
 657     description: destination port pairs
 658     properties:
 659       network_policy_entries_policy_rule_dst_ports_start_port:
 660         type: string
 661         description: Start port
 662         required: false
 663         status: SUPPORTED
 664       network_policy_entries_policy_rule_dst_ports_end_port:
 665         type: string
 666         description: End port
 667         required: false
 668         status: SUPPORTED
 669
 670 org.openecomp.datatypes.heat.contrailV2.network.rule.SrcPortPairs:
 671     derived_from: tosca.datatypes.Root
 672     description: source port pairs
 673     properties:
 674       network_policy_entries_policy_rule_src_ports_start_port:
 675         type: string
 676         description: Start port
 677         required: false
 678         status: SUPPORTED
 679       network_policy_entries_policy_rule_src_ports_end_port:
 680         type: string
 681         description: End port
 682         required: false
 683         status: SUPPORTED
 684
 685 org.openecomp.datatypes.heat.contrailV2.network.rule.ActionList:
 686     derived_from: tosca.datatypes.Root
 687     description: Action List
 688     properties:
 689       network_policy_entries_policy_rule_action_list_simple_action:
 690         type: string
 691         description: Simple Action
 692         required: false
 693         status: SUPPORTED
 694       network_policy_entries_policy_rule_action_list_apply_service:
 695         type: list
 696         description: Apply Service
 697         required: false
 698         status: SUPPORTED
 699         entry_schema:
 700           type: string
 701
 702 org.openecomp.datatypes.heat.contrailV2.network.rule.Rule:
 703     derived_from: tosca.datatypes.Root
 704     description: policy rule
 705     properties:
 706       network_policy_entries_policy_rule_dst_addresses:
 707         type: list
 708         description: Destination addresses
 709         required: false
 710         status: SUPPORTED
 711         entry_schema:
 712           type: org.openecomp.datatypes.heat.contrailV2.network.rule.DstVirtualNetwork
 713       network_policy_entries_policy_rule_dst_ports:
 714         type: list
 715         description: Destination ports
 716         required: false
 717         status: SUPPORTED
 718         entry_schema:
 719           type: org.openecomp.datatypes.heat.contrailV2.network.rule.DstPortPairs
 720       network_policy_entries_policy_rule_protocol:
 721         type: string
 722         description: Protocol
 723         required: false
 724         status: SUPPORTED
 725       network_policy_entries_policy_rule_src_addresses:
 726         type: list
 727         description: Source addresses
 728         required: false
 729         status: SUPPORTED
 730         entry_schema:
 731           type: org.openecomp.datatypes.heat.contrailV2.network.rule.SrcVirtualNetwork
 732       network_policy_entries_policy_rule_direction:
 733         type: string
 734         description: Direction
 735         required: false
 736         status: SUPPORTED
 737       network_policy_entries_policy_rule_src_ports:
 738         type: list
 739         description: Source ports
 740         required: false
 741         status: SUPPORTED
 742         entry_schema:
 743           type: org.openecomp.datatypes.heat.contrailV2.network.rule.SrcPortPairs
 744       network_policy_entries_policy_rule_action_list:
 745         type: org.openecomp.datatypes.heat.contrailV2.network.rule.ActionList
 746         description: Action list
 747         required: false
 748         status: SUPPORTED
 749
 750 org.openecomp.datatypes.heat.contrailV2.network.rule.RuleList:
 751     derived_from: tosca.datatypes.Root
 752     description: list of policy rules
 753     properties:
 754       network_policy_entries_policy_rule:
 755         type: list
 756         description: Contrail network rule
 757         required: false
 758         status: SUPPORTED
 759         entry_schema:
 760           type: org.openecomp.datatypes.heat.contrailV2.network.rule.Rule
 761
 762 org.openecomp.datatypes.heat.network.contrail.port.StaticRoute:
 763     derived_from: tosca.datatypes.Root
 764     description: static route
 765     properties:
 766       prefix:
 767         type: string
 768         description: Route prefix
 769         required: false
 770         status: SUPPORTED
 771       next_hop:
 772         type: string
 773         description: Next hop
 774         required: false
 775         status: SUPPORTED
 776       next_hop_type:
 777         type: string
 778         description: Next hop type
 779         required: false
 780         status: SUPPORTED
 781
 782 org.openecomp.datatypes.heat.network.contrail.AddressPair:
 783     derived_from: tosca.datatypes.Root
 784     description: Address Pair
 785     properties:
 786       address_mode:
 787         type: string
 788         description: Address mode active-active or active-standy
 789         required: false
 790         status: SUPPORTED
 791         constraints:
 792         - valid_values:
 793           - active-active
 794           - active-standby
 795       prefix:
 796         type: string
 797         description: IP address prefix
 798         required: false
 799         status: SUPPORTED
 800       mac_address:
 801         type: string
 802         description: Mac address
 803         required: false
 804         status: SUPPORTED
 805
 806 org.openecomp.datatypes.heat.network.contrail.InterfaceData:
 807     derived_from: tosca.datatypes.Root
 808     description: Interface Data
 809     properties:
 810       static_routes:
 811         type: list
 812         description: An ordered list of static routes to be added to this interface
 813         required: false
 814         status: SUPPORTED
 815         entry_schema:
 816           type: org.openecomp.datatypes.heat.network.contrail.port.StaticRoute
 817       virtual_network:
 818         type: string
 819         description: Virtual Network for this interface
 820         required: true
 821         status: SUPPORTED
 822       allowed_address_pairs:
 823         type: list
 824         description: List of allowed address pair for this interface
 825         required: false
 826         status: SUPPORTED
 827         entry_schema:
 828           type: org.openecomp.datatypes.heat.network.contrail.AddressPair
 829       ip_address:
 830         type: string
 831         description: IP for this interface
 832         required: false
 833         status: SUPPORTED
 834
 835 org.openecomp.datatypes.heat.contrailV2.virtual.machine.interface.Properties:
 836     derived_from: tosca.datatypes.Root
 837     description: Virtual Machine Interface Properties.
 838     properties:
 839       virtual_machine_interface_properties_service_interface_type:
 840         type: string
 841         description: Service Interface Type.
 842         required: false
 843         status: SUPPORTED
 844
 845 org.openecomp.datatypes.Root:
 846   derived_from: tosca.datatypes.Root
 847   description: >
 848     The ECOMP root Data Type all other Data Types derive from
 849   properties:
 850     supplemental_data:
 851       type: map
 852       required: true
 853       entry_schema:
 854         description: >
 855            A placeholder for missing properties that would be included in future ecomp model versions.
 856            fromat <key>:<value>
 857         type: string
 858
 859 org.openecomp.datatypes.AssignmentRequirements:
 860   derived_from: org.openecomp.datatypes.Root
 861   properties:
 862     is_required:
 863       description: |
 864         "true" indicates that assignment is required
 865       type: boolean
 866       default: false
 867       required: true
 868     count:
 869       description: number of assignments required
 870       type: integer
 871       required: false
 872
 873 org.openecomp.datatypes.network.SubnetAssignments:
 874   derived_from: org.openecomp.datatypes.Root
 875   properties:
 876     ip_network_address_plan:
 877       type: string
 878       required: false
 879       description: Reference to EIPAM, VLAN or other address plan ID used to assign subnets to this network
 880     dhcp_enabled:
 881       type: boolean
 882       required: false
 883       description: \"true\" indicates the network has 1 or more policies
 884     ip_version:
 885       type: integer
 886       constraints:
 887         - valid_values: [4,6]
 888       required: true
 889       description: The IP version of the subnet
 890     cidr_mask:
 891       type: integer
 892       required: true
 893       description: The default subnet CIDR mask
 894     min_subnets_count:
 895       type: integer
 896       default: 1
 897       required: true
 898       description: Quantity of subnets that must be initially assigned
 899
 900 org.openecomp.datatypes.network.IPv4SubnetAssignments:
 901   derived_from: org.openecomp.datatypes.network.SubnetAssignments
 902   properties:
 903     use_ipv4:
 904       type: boolean
 905       required: true
 906       description: Indicates IPv4 subnet assignments
 907
 908 org.openecomp.datatypes.network.IPv6SubnetAssignments:
 909   derived_from: org.openecomp.datatypes.network.SubnetAssignments
 910   properties:
 911     use_ipv6:
 912       type: boolean
 913       required: true
 914       description: Indicates IPv6 subnet assignments
 915
 916 org.openecomp.datatypes.network.NetworkAssignments:
 917   derived_from: org.openecomp.datatypes.Root
 918   properties:
 919     ecomp_generated_network_assignment:
 920       type: boolean
 921       required: true
 922       default: false
 923       description: >
 924         \"true\" indicates that the network assignments will be auto-generated by ECOMP
 925         \"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).
 926     is_shared_network:
 927       type: boolean
 928       required: true
 929       description: \"true\" means this network is shared by multiple Openstack tenants
 930     is_external_network:
 931       type: boolean
 932       required: true
 933       default: false
 934       description: >
 935         \"true\" means this Contrail external network
 936     ipv4_subnet_default_assignment:
 937       type: org.openecomp.datatypes.network.IPv4SubnetAssignments
 938       required: true
 939       description: IPv4 defualt subnet assignments
 940     ipv6_subnet_default_assignment:
 941       type: org.openecomp.datatypes.network.IPv6SubnetAssignments
 942       required: true
 943       description: IPv6 defualt subnet assignments
 944
 945 org.openecomp.datatypes.network.ProviderNetwork:
 946   derived_from: org.openecomp.datatypes.Root
 947   properties:
 948     is_provider_network:
 949       type: boolean
 950       required: true
 951       description: \"true\" indicates that this a Neutron provider type of network
 952     physical_network_name:
 953       type: string
 954       required: false
 955       constraints:
 956         - valid_values: ["Physnet41", "Physnet42", "Physnet43", "Physnet44", "Physnet21", "Physnet22"]
 957       description: >
 958         Identifies the NUMA processor cluster to which this physical network interface belongs.
 959         NUMA instance correlates to the first digit of the Physical Network Name suffix (e.g. \"01\" = NUMA 0, \"11\" = NUMA 1)
 960     numa:
 961       type: string
 962       required: false
 963       constraints:
 964         - valid_values: ["NUMA 0", "NUMA 1"]
 965       description: >
 966         PNIC instance within the NUMA processor cluster
 967         PNIC Instance correlates to the second digit of the Physical Network Name suffix (e.g. "01" = PNIC 1, "02" = "PNIC 2)
 968     pnic_instance:
 969       type: integer
 970       required: false
 971       description: PNIC instance within the NUMA processor cluster
 972
 973 org.openecomp.datatypes.network.NetworkFlows:
 974   derived_from: org.openecomp.datatypes.Root
 975   properties:
 976     is_network_policy:
 977       type: boolean
 978       required: false
 979       default: false
 980       description: \"true\" indicates the network has 1 or more policies
 981     network_policy:
 982       type: string
 983       required: false
 984       description: "Identifies the specific Cloud network policy that must be applied to this network (source: from Policy Manager)."
 985     is_bound_to_vpn:
 986       type: boolean
 987       required: false
 988       default: false
 989       description: \"true\" indicates the network has 1 or more vpn bindings
 990     vpn_binding:
 991       type: string
 992       required: false
 993       description: "Identifies the specific VPN Binding entry in A&AI that must be applied when creating this network (source: A&AI)"
 994
 995 org.openecomp.datatypes.network.VlanRequirements:
 996   derived_from: org.openecomp.datatypes.Root
 997   properties:
 998     vlan_range_plan:
 999       type: string
1000       required: true
1001       description: reference to a vlan range plan
1002     vlan_type:
1003       type: string
1004       required: true
1005       constraints:
1006         - valid_values: ["c-tag", "s-tag"]
1007       description: identifies the vlan type (e.g., c-tag)
1008     vlan_count:
1009       type: integer
1010       required: true
1011       description: identifies the number of vlan tags to assign to the CP from the plan
1012
1013 org.openecomp.datatypes.network.IpRequirements:
1014   derived_from: org.openecomp.datatypes.Root
1015   properties:
1016     ip_version:
1017       type: integer
1018       required: true
1019       constraints:
1020         - valid_values:
1021           - 4
1022           - 6
1023     ip_count:
1024       description: identifies the number of ip address to assign to the CP from the plan
1025       type: integer
1026       required: false
1027     floating_ip_count:
1028       type: integer
1029       required: false
1030     subnet_role:
1031       type: string
1032       required: false
1033     assingment_method:
1034       type: string
1035       required: true
1036       constraints:
1037         - valid_values:
1038           - fixed
1039           - dhcp
1040     dhcp_enabled:
1041       type: boolean
1042       required: false
1043     ip_count_required:
1044       description: identifies the number of ip address to assign to the CP from the plan
1045       type: org.openecomp.datatypes.AssignmentRequirements
1046       required: false
1047     floating_ip_count_required:
1048       type: org.openecomp.datatypes.AssignmentRequirements
1049       required: false
1050     ip_address_plan_name:
1051       type: string
1052       required: false
1053     vrf_name:
1054       type: string
1055       required: false
1056
1057 org.openecomp.datatypes.network.MacAssignments:
1058   derived_from: org.openecomp.datatypes.Root
1059   properties:
1060     mac_range_plan:
1061       type: string
1062       required: true
1063       description: reference to a MAC address range plan
1064     mac_count:
1065       type: integer
1066       required: true
1067       description: identifies the number of MAC addresses to assign to the CP from the plan
1068
1069 org.openecomp.datatypes.EcompHoming:
1070   derived_from: org.openecomp.datatypes.Root
1071   properties:
1072     ecomp_selected_instance_node_target:
1073       type: boolean
1074       required: true
1075       default: false
1076       description: >
1077         \"true\" indicates that the target deployment node for this instance will be auto-selected by ECOMP
1078         \"false\" indicates operator-supplied instance target deployment node required (e.g. VID will present a prompt to operator and collect the
1079         operator-selected target node for the deployment of this Network instance).
1080     homing_policy:
1081       type: string
1082       required: false
1083       description: Referenc to a service level homing policy that ECOMP will use for instance deployment target node
1084     instance_node_target:
1085       type: string
1086       required: false
1087       description: Instance target deployment node
1088
1089 org.openecomp.datatypes.EcompNaming:
1090   derived_from: org.openecomp.datatypes.Root
1091   properties:
1092     ecomp_generated_naming:
1093       type: boolean
1094       required: true
1095       default: true
1096       description: >
1097         \"true\" indicates that the name for the instance will be auto-generated by ECOMP.
1098         \"false\" indicates operator-supplied name required (e.g. VID will present prompt to operator and collect the operator-supplied instance name).
1099     naming_policy:
1100       type: string
1101       required: false
1102       description: Referenc to naming policy that ECOMP will use when the name is auto-generated
1103
1104 org.openecomp.datatypes.network.MacRequirements:
1105   derived_from: org.openecomp.datatypes.Root
1106   properties:
1107     mac_range_plan:
1108       description: reference to a MAC address range plan
1109       type: string
1110       required: false
1111     mac_count:
1112       description: identifies the number of MAC addresses to assign to the CP from the plan
1113       type: integer
1114       required: false
1115     mac_count_required:
1116       description: identifies the number of MAC addresses to assign to the CP from the plan
1117       type: org.openecomp.datatypes.AssignmentRequirements
1118
1119 org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPairIp:
1120   derived_from: tosca.datatypes.Root
1121   description: Virtual Machine Sub Interface Address Pair IP.
1122   properties:
1123     ip_prefix:
1124       type: string
1125       description: IP Prefix.
1126       required: false
1127       status: SUPPORTED
1128     ip_prefix_len:
1129       type: integer
1130       description: IP Prefix Len.
1131       required: false
1132       status: SUPPORTED
1133
1134 org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.MacAddress:
1135   derived_from: tosca.datatypes.Root
1136   description: Virtual Machine Sub Interface Mac Address.
1137   properties:
1138     mac_address:
1139       type: list
1140       description: Mac Addresses List.
1141       required: false
1142       status: SUPPORTED
1143       entry_schema:
1144         type: string
1145
1146 org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.Properties:
1147   derived_from: tosca.datatypes.Root
1148   description: Virtual Machine Sub Interface VLAN Properties.
1149   properties:
1150     sub_interface_vlan_tag:
1151       type: string
1152       description: Sub Interface VLAN Tag.
1153       required: false
1154       status: SUPPORTED
1155
1156 org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPair:
1157   derived_from: tosca.datatypes.Root
1158   description: Virtual Machine Sub Interface Address Pair.
1159   properties:
1160     address_mode:
1161       type: string
1162       description: Address Mode.
1163       required: false
1164       status: SUPPORTED
1165     ip:
1166       type: org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPairIp
1167       description: IP.
1168       required: false
1169       status: SUPPORTED
1170     mac:
1171       type: string
1172       description: Mac.
1173       required: false
1174       status: SUPPORTED
1175
1176 org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPairs:
1177   derived_from: tosca.datatypes.Root
1178   description: Virtual Machine Sub Interface Address Pairs.
1179   properties:
1180     allowed_address_pair:
1181       type: list
1182       description: Addresses pair List.
1183       required: false
1184       status: SUPPORTED
1185       entry_schema:
1186         type: org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPair
1187
1188 org.openecomp.datatypes.Naming:
1189   derived_from: org.openecomp.datatypes.Root
1190   properties:
1191       ecomp_generated_naming:
1192         description: |
1193           "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).
1194         type: boolean
1195         default: true
1196         required: true
1197       naming_policy:
1198         description: Reference to naming policy that ECOMP will use when the name is auto-generated
1199         type: string
1200         required: false
1201       instance_name:
1202         description: indicates operator-supplied name required (e.g. VID will present prompt to operator and collect the operator-supplied instance name).
1203         type: string
1204         required: false
1205
1206 # NFoD
1207 org.openecomp.datatypes.flavors.ComputeFlavor:
1208   derived_from: tosca.datatypes.Root
1209   properties:
1210       num_cpus:
1211         type: integer
1212       disk_size:
1213         type: scalar-unit.size
1214       mem_size:
1215         type: scalar-unit.size
1216
1217 org.openecomp.datatypes.flavors.LicenseFlavor:
1218   derived_from: tosca.datatypes.Root
1219   properties:
1220       feature_group_uuid:
1221         type: string
1222
1223 org.openecomp.datatypes.flavors.VendorInfo:
1224   derived_from: tosca.datatypes.Root
1225   properties:
1226       manufacturer_reference_number:
1227         type: string
1228       vendor_model:
1229         type: string
1230
1231 org.openecomp.datatypes.flavors.DeploymentFlavor:
1232   derived_from: tosca.datatypes.Root
1233   properties:
1234       sp_part_number:
1235         type: string
1236       vendor_info:
1237         type: org.openecomp.datatypes.flavors.VendorInfo
1238       compute_flavor:
1239         type: org.openecomp.datatypes.flavors.ComputeFlavor
1240       license_flavor:
1241         type: org.openecomp.datatypes.flavors.LicenseFlavor
1242         required: false
1243 org.openecomp.datatypes.ImageInfo:
1244   derived_from: tosca.datatypes.Root
1245   properties:
1246       software_version:
1247         type: string
1248       file_name:
1249         type: string
1250       file_hash:
1251         type: string
1252         description: checksum/signature
1253       file_hash_type:
1254         type: string
1255         required: false
1256         default: md5
1257 #onap
1258 tosca.datatypes.nfv.VnfcConfigurableProperties:
1259   derived_from: tosca.datatypes.Root
1260   properties:
1261     additional_vnfc_configurable_properties:
1262       type: map
1263       entry_schema:
1264         type: string
1265       required: false
1266 tosca.datatypes.nfv.RequestedAdditionalCapability:
1267   derived_from: tosca.datatypes.Root
1268   properties:
1269     #name:
1270       # key of containing map
1271     support_mandatory:
1272       type: boolean
1273       required: true
1274     min_requested_additional_capability_version:
1275       type: string
1276       required: false
1277     preferred_requested_additional_capability_version:
1278       type: string
1279       required: false
1280     requested_additional_capability_name:
1281       type: string
1282       required: true
1283     target_performance_parameters:
1284       type: map
1285       entry_schema:
1286         type: string
1287       required: true
1288 tosca.datatypes.nfv.VirtualMemory:
1289     derived_from: tosca.datatypes.Root
1290     properties:
1291         # Number
1292       virtual_mem_size:
1293         type: scalar-unit.size
1294         required: true
1295       virtual_mem_oversubscription_policy:
1296         type: string
1297         required: false
1298       numa_enabled:
1299         type: boolean
1300         required: false
1301 tosca.datatypes.nfv.VirtualCpuPinning:
1302   derived_from: tosca.datatypes.Root
1303   properties:
1304     cpu_pinning_policy:
1305       type: string # CpuPinningPolicy
1306       constraints:
1307         - valid_values: [ static, dynamic ]
1308       required: false
1309     cpu_pinning_map:
1310       type: map
1311       entry_schema:
1312         type: string
1313       required: false
1314 tosca.datatypes.nfv.VirtualCpu:
1315   derived_from: tosca.datatypes.Root
1316   properties:
1317     cpu_architecture:
1318       type: string
1319       required: false
1320     num_virtual_cpu:
1321       type: integer
1322       required: true
1323     virtual_cpu_clock:
1324       type: scalar-unit.frequency
1325       required: false
1326     virtual_cpu_oversubscription_policy:
1327       type: string
1328       required: false
1329     virtual_cpu_pinning:
1330       type: tosca.datatypes.nfv.VirtualCpuPinning
1331       required: false
1332 tosca.datatypes.nfv.VirtualNetworkInterfaceRequirements:
1333   derived_from: tosca.datatypes.Root
1334   properties:
1335     name:
1336       type: string
1337       required: false
1338     description:
1339       type: string
1340       required: false
1341     support_mandatory:
1342       type: boolean
1343       required: true
1344     requirement:
1345       type: string      # not specified
1346       required: true
1347 tosca.datatypes.nfv.L2AddressData:
1348   derived_from: tosca.datatypes.Root
1349   properties:
1350     address:
1351       type: string
1352       required: false
1353 tosca.datatypes.nfv.L3AddressData:
1354   derived_from: tosca.datatypes.Root
1355   properties:
1356     ip_address_assignment:
1357       type: boolean
1358       required: true
1359     floating_ip_activated:
1360       type: boolean
1361       required: true
1362     ip_address_type:
1363       type: string
1364       required: false
1365       constraints:
1366         - valid_values: [ipv4, ipv6]
1367     number_of_ip_address:
1368       type: integer
1369       required: false
1370 tosca.datatype.nfv.AddressData:
1371   properties:
1372     address_type:
1373       constraints:
1374       - valid_values:
1375         - mac_address
1376         - ip_address
1377       type: string
1378     l2_address_data:
1379       required: false
1380       type: tosca.datatypes.nfv.L2AddressData
1381     l3_address_data:
1382       required: false
1383       type: tosca.datatypes.nfv.L3AddressData
1384 tosca.datatypes.nfv.ConnectivityType:
1385   derived_from: tosca.datatypes.Root
1386   properties:
1387     layer_protocol:
1388       type: string
1389       required: true
1390       constraints:
1391         - valid_values: [ethernet, mpls, odu2, ipv4, ipv6, pseudo_wire ]
1392     flow_pattern:
1393       type: string
1394       required: false
1395 tosca.datatypes.nfv.VlFlavour:
1396   derived_from: tosca.datatypes.Root
1397   properties:
1398     flavourId:
1399       type: string
1400 tosca.datatypes.nfv.ext.AddressPairs:
1401   properties:
1402     ip:
1403       type: string
1404       required: false
1405     mac:
1406       type: string
1407       required: false
1408 tosca.datatypes.nfv.ext.FloatingIP:
1409   properties:
1410     external_network:
1411       type: string
1412       required: false
1413     ip_address:
1414       type: string
1415       required: false
1416 tosca.datatypes.nfv.ext.LocationInfo:
1417   properties:
1418     availability_zone:
1419       type: string
1420       required: false
1421     vimid:
1422       type: integer
1423       required: false
1424     tenant:
1425       type: string
1426       required: false
1427 tosca.datatypes.nfv.ext.HostRouteInfo:
1428   properties:
1429     destination:
1430       type: string
1431       required: false
1432     nexthop:
1433       type: string
1434       required: false
1435
1436 tosca.datatypes.nfv.ext.InjectData:
1437   properties:
1438     file_name:
1439       type: string
1440       required: false
1441     file_data:
1442       type: string
1443       required: false
1444 tosca.datatypes.nfv.ext.zte.WatchDog:
1445   properties:
1446     enable_delay:
1447       type: integer
1448       required: false
1449     action:
1450       type: string
1451       required: false
1452 tosca.datatypes.nfv.ext.LocalAffinityOrAntiAffinityRule:
1453   properties:
1454     scope:
1455       type: string
1456       required: false
1457     affinity_antiaffinity:
1458       type: string
1459       required: false