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