Catalog alignment
[sdc.git] / 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 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 tosca.datatypes.Credential: 
23   derived_from: tosca.datatypes.Root
24   properties: 
25     protocol: 
26       type: string
27       required: false
28     token_type: 
29       type: string
30       default: password
31     token: 
32       type: string
33     keys:
34       type: map
35       required: false
36       entry_schema:
37         type: string
38     user:
39       type: string
40       required: false
41
42 tosca.datatypes.TimeInterval: 
43   derived_from: tosca.datatypes.Root
44   properties:
45     start_time: 
46       type: timestamp
47       required: true
48     end_time: 
49       type: timestamp
50       required: true
51
52 tosca.datatypes.network.NetworkInfo:
53   derived_from: tosca.datatypes.Root
54   properties:  
55     network_name: 
56       type: string
57     network_id: 
58       type: string
59     addresses:
60       type: list
61       entry_schema:
62         type: string
63
64 tosca.datatypes.network.PortInfo: 
65   derived_from: tosca.datatypes.Root
66   properties:  
67     port_name: 
68       type: string
69     port_id: 
70       type: string
71     network_id: 
72       type: string
73     mac_address: 
74       type: string
75     addresses:
76       type: list
77       entry_schema:
78         type: string
79
80 tosca.datatypes.network.PortDef:
81   derived_from: integer
82   constraints: 
83     - in_range: [ 1, 65535 ]
84
85 tosca.datatypes.network.PortSpec: 
86   derived_from: tosca.datatypes.Root
87   properties:  
88     protocol: 
89       type: string
90       required: true
91       default: tcp
92       constraints:
93         - valid_values: [ udp, tcp, igmp ]
94     target:  
95       type: tosca.datatypes.network.PortDef
96     target_range:
97       type: range 
98       constraints:
99         - in_range: [ 1, 65535 ]
100     source:
101       type: tosca.datatypes.network.PortDef
102     source_range:
103       type: range
104       constraints:
105         - in_range: [ 1, 65535 ]
106
107 ###################new Data Types Onboarding Integration##########################
108
109 org.openecomp.datatypes.heat.network.AddressPair:
110   derived_from: tosca.datatypes.Root
111   description: MAC/IP address pairs
112   properties:
113     mac_address:
114       type: string
115       description: MAC address
116       required: false
117       status: SUPPORTED
118     ip_address:
119       type: string
120       description: IP address
121       required: false
122       status: SUPPORTED
123 org.openecomp.datatypes.heat.network.subnet.HostRoute:
124   derived_from: tosca.datatypes.Root
125   description: Host route info for the subnet
126   properties:
127     destination:
128       type: string
129       description: The destination for static route
130       required: false
131       status: SUPPORTED
132     nexthop:
133       type: string
134       description: The next hop for the destination
135       required: false
136       status: SUPPORTED
137       
138 org.openecomp.datatypes.heat.network.AllocationPool:
139   derived_from: tosca.datatypes.Root
140   description: The start and end addresses for the allocation pool
141   properties:
142     start:
143       type: string
144       description: Start address for the allocation pool
145       required: false
146       status: SUPPORTED
147     end:
148       type: string
149       description: End address for the allocation pool
150       required: false
151       status: SUPPORTED
152
153 org.openecomp.datatypes.heat.network.neutron.Subnet:
154   derived_from: tosca.datatypes.Root
155   description: A subnet represents an IP address block that can be used for assigning IP addresses to virtual instances
156   properties:
157     tenant_id:
158       type: string
159       description: The ID of the tenant who owns the network
160       required: false
161       status: SUPPORTED
162     enable_dhcp:
163       type: boolean
164       description: Set to true if DHCP is enabled and false if DHCP is disabled
165       required: false
166       default: true
167       status: SUPPORTED
168     ipv6_address_mode:
169       type: string
170       description: IPv6 address mode
171       required: false
172       status: SUPPORTED
173       constraints:
174       - valid_values:
175         - dhcpv6-stateful
176         - dhcpv6-stateless
177         - slaac
178     ipv6_ra_mode:
179       type: string
180       description: IPv6 RA (Router Advertisement) mode
181       required: false
182       status: SUPPORTED
183       constraints:
184       - valid_values:
185         - dhcpv6-stateful
186         - dhcpv6-stateless
187         - slaac
188     value_specs:
189       type: map
190       description: Extra parameters to include in the request
191       required: false
192       default: {
193         }
194       status: SUPPORTED
195       entry_schema:
196         type: string
197     allocation_pools:
198        type: list
199        description: The start and end addresses for the allocation pools
200        required: false
201        status: SUPPORTED
202        entry_schema:
203          type: org.openecomp.datatypes.heat.network.AllocationPool
204     subnetpool:
205       type: string
206       description: The name or ID of the subnet pool
207       required: false
208       status: SUPPORTED
209     dns_nameservers:
210       type: list
211       description: A specified set of DNS name servers to be used
212       required: false
213       default: [
214         ]
215       status: SUPPORTED
216       entry_schema:
217         type: string     
218     host_routes:
219       type: list
220       description: The gateway IP address
221       required: false
222       status: SUPPORTED
223       entry_schema:
224         type: org.openecomp.datatypes.heat.network.subnet.HostRoute
225     ip_version:
226       type: integer
227       description: The gateway IP address
228       required: false
229       default: 4
230       status: SUPPORTED
231       constraints:
232       - valid_values:
233         - '4'
234         - '6'
235     name:
236       type: string
237       description: The name of the subnet
238       required: false
239       status: SUPPORTED
240     prefixlen:
241       type: integer
242       description: Prefix length for subnet allocation from subnet pool
243       required: false
244       status: SUPPORTED
245       constraints:
246       - greater_or_equal: 0
247     cidr:
248       type: string
249       description: The CIDR
250       required: false
251       status: SUPPORTED
252     gateway_ip:
253       type: string
254       description: The gateway IP address
255       required: false
256       status: SUPPORTED
257
258 org.openecomp.datatypes.heat.novaServer.network.PortExtraProperties:
259   derived_from: tosca.datatypes.Root
260   description: Nova server network expand properties for port
261   properties:
262     port_security_enabled:
263       type: boolean
264       description: Flag to enable/disable port security on the port
265       required: false
266       status: SUPPORTED
267     mac_address:
268       type: string
269       description: MAC address to give to this port
270       required: false
271       status: SUPPORTED
272     admin_state_up:
273       type: boolean
274       description: The administrative state of this port
275       required: false
276       default: true
277       status: SUPPORTED
278     qos_policy:
279       type: string
280       description: The name or ID of QoS policy to attach to this port
281       required: false
282       status: SUPPORTED
283     allowed_address_pairs:
284       type: list
285       description: Additional MAC/IP address pairs allowed to pass through the port
286       required: false
287       status: SUPPORTED
288       entry_schema:
289         type: org.openecomp.datatypes.heat.network.AddressPair
290     binding:vnic_type:
291       type: string
292       description: The vnic type to be bound on the neutron port
293       required: false
294       status: SUPPORTED
295       constraints:
296       - valid_values:
297         - macvtap
298         - direct
299         - normal
300     value_specs:
301       type: map
302       description: Extra parameters to include in the request
303       required: false
304       default: {
305         }
306       status: SUPPORTED
307       entry_schema:
308         type: string
309 org.openecomp.datatypes.heat.novaServer.network.AddressInfo:
310   derived_from: tosca.datatypes.network.NetworkInfo
311   description: Network addresses with corresponding port id
312   properties:
313     port_id:
314       type: string
315       description: Port id
316       required: false
317       status: SUPPORTED
318 org.openecomp.datatypes.heat.neutron.port.FixedIps:
319   derived_from: tosca.datatypes.Root
320   description: subnet/ip_address
321   properties:
322     subnet:
323       type: string
324       description: Subnet in which to allocate the IP address for this port
325       required: false
326       status: SUPPORTED
327     ip_address:
328       type: string
329       description: IP address desired in the subnet for this port
330       required: false
331       status: SUPPORTED
332 org.openecomp.datatypes.heat.FileInfo:
333   derived_from: tosca.datatypes.Root
334   description: Heat File Info
335   properties:
336     file:
337       type: string
338       description: The required URI string (relative or absolute) which can be used to locate the file
339       required: true
340       status: SUPPORTED
341     file_type:
342       type: string
343       description: The type of the file
344       required: true
345       status: SUPPORTED
346       constraints:
347       - valid_values:
348         - base
349         - env
350         - volume
351         - network
352 org.openecomp.datatypes.heat.contrail.network.rule.PortPairs:
353     derived_from: tosca.datatypes.Root
354     description: source and destination port pairs
355     properties:
356       start_port:
357         type: string
358         description: Start port
359         required: false
360         status: SUPPORTED
361       end_port:
362         type: string
363         description: End port
364         required: false
365         status: SUPPORTED
366 org.openecomp.datatypes.heat.contrail.network.rule.Rule:
367     derived_from: tosca.datatypes.Root
368     description: policy rule
369     properties:
370       src_ports:
371         type: list
372         description: Source ports
373         required: false
374         status: SUPPORTED
375         entry_schema:
376           type: org.openecomp.datatypes.heat.contrail.network.rule.PortPairs
377       protocol:
378         type: string
379         description: Protocol
380         required: false
381         status: SUPPORTED
382       dst_addresses:
383         type: list
384         description: Destination addresses
385         required: false
386         status: SUPPORTED
387         entry_schema:
388           type: org.openecomp.datatypes.heat.contrail.network.rule.VirtualNetwork
389       apply_service:
390         type: string
391         description: Service to apply
392         required: false
393         status: SUPPORTED
394       dst_ports:
395         type: list
396         description: Destination ports
397         required: false
398         status: SUPPORTED
399         entry_schema:
400           type: org.openecomp.datatypes.heat.contrail.network.rule.PortPairs
401       src_addresses:
402         type: list
403         description: Source addresses
404         required: false
405         status: SUPPORTED
406         entry_schema:
407           type: org.openecomp.datatypes.heat.contrail.network.rule.VirtualNetwork
408       direction:
409         type: string
410         description: Direction
411         required: false
412         status: SUPPORTED
413 org.openecomp.datatypes.heat.contrail.network.rule.RuleList:
414     derived_from: tosca.datatypes.Root
415     description: list of policy rules
416     properties:
417       policy_rule:
418         type: list
419         description: Contrail network rule
420         required: false
421         status: SUPPORTED
422         entry_schema:
423           type: org.openecomp.datatypes.heat.contrail.network.rule.Rule
424 org.openecomp.datatypes.heat.contrail.network.rule.VirtualNetwork:
425     derived_from: tosca.datatypes.Root
426     description: source and destination addresses
427     properties:
428       virtual_network:
429         type: string
430         description: Virtual network
431         required: false
432         status: SUPPORTED
433
434 org.openecomp.datatypes.heat.network.neutron.SecurityRules.Rule:
435     derived_from: tosca.datatypes.Root
436     description: Rules Pairs
437     properties:
438       remote_group_id:
439         type: string
440         description: The remote group ID to be associated with this security group rule
441         required: false
442         status: SUPPORTED
443       protocol:
444         type: string
445         description: The protocol that is matched by the security group rule
446         required: false
447         status: SUPPORTED
448         constraints:
449         - valid_values:
450           - tcp
451           - udp
452           - icmp
453       ethertype:
454         type: string
455         description: Ethertype of the traffic
456         required: false
457         default: IPv4
458         status: SUPPORTED
459         constraints:
460         - valid_values:
461           - IPv4
462           - IPv6
463       port_range_max:
464         type: integer
465         description: 'The maximum port number in the range that is matched by the
466           security group rule. '
467         required: false
468         status: SUPPORTED
469         constraints:
470         - in_range:
471           - 0
472           - 65535
473       remote_ip_prefix:
474         type: string
475         description: The remote IP prefix (CIDR) to be associated with this security group rule
476         required: false
477         status: SUPPORTED
478       remote_mode:
479         type: string
480         description: Whether to specify a remote group or a remote IP prefix
481         required: false
482         default: remote_ip_prefix
483         status: SUPPORTED
484         constraints:
485         - valid_values:
486           - remote_ip_prefix
487           - remote_group_id
488       direction:
489         type: string
490         description: The direction in which the security group rule is applied
491         required: false
492         default: ingress
493         status: SUPPORTED
494         constraints:
495         - valid_values:
496           - egress
497           - ingress
498       port_range_min:
499         type: integer
500         description: The minimum port number in the range that is matched by the security group rule.
501         required: false
502         status: SUPPORTED
503         constraints:
504         - in_range:
505           - 0
506           - 65535
507 org.openecomp.datatypes.heat.substitution.SubstitutionFiltering:
508     derived_from: tosca.datatypes.Root
509     description: Substitution Filter
510     properties:
511       substitute_service_template:
512         type: string
513         description: Substitute Service Template
514         required: true
515         status: SUPPORTED
516       index_value:
517         type: integer
518         description: Index value of the substitution service template runtime instance
519         required: false
520         default: 0
521         status: SUPPORTED
522         constraints:
523         - greater_or_equal: 0
524       count:
525         type: string
526         description: Count
527         required: false
528         default: 1
529         status: SUPPORTED
530       scaling_enabled:
531         type: boolean
532         description: Indicates whether service scaling is enabled
533         required: false
534         default: true
535         status: SUPPORTED
536       mandatory:
537         type: boolean
538         description: Mandatory
539         required: false
540         default: true
541         status: SUPPORTED
542 org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.RefDataSequence:
543     derived_from: tosca.datatypes.Root
544     description: network policy refs data sequence
545     properties:
546       network_policy_refs_data_sequence_major:
547         type: integer
548         description: Network Policy ref data sequence Major
549         required: false
550         status: SUPPORTED
551       network_policy_refs_data_sequence_minor:
552         type: integer
553         description: Network Policy ref data sequence Minor
554         required: false
555         status: SUPPORTED
556 org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.RefData:
557     derived_from: tosca.datatypes.Root
558     description: network policy refs data
559     properties:
560       network_policy_refs_data_sequence:
561         type: org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.RefDataSequence
562         description: Network Policy ref data sequence
563         required: false
564         status: SUPPORTED
565 org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.ref.data.IpamSubnet:
566     derived_from: tosca.datatypes.Root
567     description: Network Ipam Ref Data Subnet
568     properties:
569       network_ipam_refs_data_ipam_subnets_subnet_ip_prefix_len:
570         type: string
571         description: Network ipam refs data ipam subnets ip prefix len
572         required: false
573         status: SUPPORTED
574       network_ipam_refs_data_ipam_subnets_subnet_ip_prefix:
575         type: string
576         description: Network ipam refs data ipam subnets ip prefix
577         required: false
578         status: SUPPORTED
579 org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.ref.data.IpamSubnetList:
580     derived_from: tosca.datatypes.Root
581     description: Network Ipam Ref Data Subnet List
582     properties:
583       network_ipam_refs_data_ipam_subnets_subnet:
584         type: org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.ref.data.IpamSubnet
585         description: Network ipam refs data ipam subnets
586         required: false
587         status: SUPPORTED
588       network_ipam_refs_data_ipam_subnets_addr_from_start:
589         type: string
590         description: Network ipam refs data ipam subnets addr from start
591         required: false
592         status: SUPPORTED
593 org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.IpamRefData:
594     derived_from: tosca.datatypes.Root
595     description: Network Ipam Ref Data
596     properties:
597       network_ipam_refs_data_ipam_subnets:
598         type: list
599         description: Network ipam refs data ipam subnets
600         required: false
601         status: SUPPORTED
602         entry_schema:
603           type: org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.ref.data.IpamSubnetList
604 org.openecomp.datatypes.heat.contrailV2.network.rule.SrcVirtualNetwork:
605     derived_from: tosca.datatypes.Root
606     description: source addresses
607     properties:
608       network_policy_entries_policy_rule_src_addresses_virtual_network:
609         type: string
610         description: Source addresses Virtual network
611         required: false
612         status: SUPPORTED
613 org.openecomp.datatypes.heat.contrailV2.network.rule.DstVirtualNetwork:
614     derived_from: tosca.datatypes.Root
615     description: destination addresses
616     properties:
617       network_policy_entries_policy_rule_dst_addresses_virtual_network:
618         type: string
619         description: Destination addresses Virtual network
620         required: false
621         status: SUPPORTED
622 org.openecomp.datatypes.heat.contrailV2.network.rule.DstPortPairs:
623     derived_from: tosca.datatypes.Root
624     description: destination port pairs
625     properties:
626       network_policy_entries_policy_rule_dst_ports_start_port:
627         type: string
628         description: Start port
629         required: false
630         status: SUPPORTED
631       network_policy_entries_policy_rule_dst_ports_end_port:
632         type: string
633         description: End port
634         required: false
635         status: SUPPORTED
636 org.openecomp.datatypes.heat.contrailV2.network.rule.SrcPortPairs:
637     derived_from: tosca.datatypes.Root
638     description: source port pairs
639     properties:
640       network_policy_entries_policy_rule_src_ports_start_port:
641         type: string
642         description: Start port
643         required: false
644         status: SUPPORTED
645       network_policy_entries_policy_rule_src_ports_end_port:
646         type: string
647         description: End port
648         required: false
649         status: SUPPORTED
650 org.openecomp.datatypes.heat.contrailV2.network.rule.ActionList:
651     derived_from: tosca.datatypes.Root
652     description: Action List
653     properties:
654       network_policy_entries_policy_rule_action_list_simple_action:
655         type: string
656         description: Simple Action
657         required: false
658         status: SUPPORTED
659       network_policy_entries_policy_rule_action_list_apply_service:
660         type: list
661         description: Apply Service
662         required: false
663         status: SUPPORTED
664         entry_schema:
665           type: string
666 org.openecomp.datatypes.heat.contrailV2.network.rule.ActionList:
667     derived_from: tosca.datatypes.Root
668     description: Action List
669     properties:
670       network_policy_entries_policy_rule_action_list_simple_action:
671         type: string
672         description: Simple Action
673         required: false
674         status: SUPPORTED
675       network_policy_entries_policy_rule_action_list_apply_service:
676         type: list
677         description: Apply Service
678         required: false
679         status: SUPPORTED
680         entry_schema:
681           type: string
682 org.openecomp.datatypes.heat.contrailV2.network.rule.Rule:
683     derived_from: tosca.datatypes.Root
684     description: policy rule
685     properties:
686       network_policy_entries_policy_rule_dst_addresses:
687         type: list
688         description: Destination addresses
689         required: false
690         status: SUPPORTED
691         entry_schema:
692           type: org.openecomp.datatypes.heat.contrailV2.network.rule.DstVirtualNetwork
693       network_policy_entries_policy_rule_dst_ports:
694         type: list
695         description: Destination ports
696         required: false
697         status: SUPPORTED
698         entry_schema:
699           type: org.openecomp.datatypes.heat.contrailV2.network.rule.DstPortPairs
700       network_policy_entries_policy_rule_protocol:
701         type: string
702         description: Protocol
703         required: false
704         status: SUPPORTED
705       network_policy_entries_policy_rule_src_addresses:
706         type: list
707         description: Source addresses
708         required: false
709         status: SUPPORTED
710         entry_schema:
711           type: org.openecomp.datatypes.heat.contrailV2.network.rule.SrcVirtualNetwork
712       network_policy_entries_policy_rule_direction:
713         type: string
714         description: Direction
715         required: false
716         status: SUPPORTED
717       network_policy_entries_policy_rule_src_ports:
718         type: list
719         description: Source ports
720         required: false
721         status: SUPPORTED
722         entry_schema:
723           type: org.openecomp.datatypes.heat.contrailV2.network.rule.SrcPortPairs
724       network_policy_entries_policy_rule_action_list:
725         type: org.openecomp.datatypes.heat.contrailV2.network.rule.ActionList
726         description: Action list
727         required: false
728         status: SUPPORTED
729 org.openecomp.datatypes.heat.contrailV2.network.rule.RuleList:
730     derived_from: tosca.datatypes.Root
731     description: list of policy rules
732     properties:
733       network_policy_entries_policy_rule:
734         type: list
735         description: Contrail network rule
736         required: false
737         status: SUPPORTED
738         entry_schema:
739           type: org.openecomp.datatypes.heat.contrailV2.network.rule.Rule
740 org.openecomp.datatypes.heat.network.contrail.port.StaticRoute:
741     derived_from: tosca.datatypes.Root
742     description: static route
743     properties:
744       prefix:
745         type: string
746         description: Route prefix
747         required: false
748         status: SUPPORTED
749       next_hop:
750         type: string
751         description: Next hop
752         required: false
753         status: SUPPORTED
754       next_hop_type:
755         type: string
756         description: Next hop type
757         required: false
758         status: SUPPORTED
759 org.openecomp.datatypes.heat.network.contrail.AddressPair:
760     derived_from: tosca.datatypes.Root
761     description: Address Pair
762     properties:
763       address_mode:
764         type: string
765         description: Address mode active-active or active-standy
766         required: false
767         status: SUPPORTED
768         constraints:
769         - valid_values:
770           - active-active
771           - active-standby
772       prefix:
773         type: string
774         description: IP address prefix
775         required: false
776         status: SUPPORTED
777       mac_address:
778         type: string
779         description: Mac address
780         required: false
781         status: SUPPORTED
782 org.openecomp.datatypes.heat.network.contrail.InterfaceData:
783     derived_from: tosca.datatypes.Root
784     description: Interface Data
785     properties:
786       static_routes:
787         type: list
788         description: An ordered list of static routes to be added to this interface
789         required: false
790         status: SUPPORTED
791         entry_schema:
792           type: org.openecomp.datatypes.heat.network.contrail.port.StaticRoute
793       virtual_network:
794         type: string
795         description: Virtual Network for this interface
796         required: true
797         status: SUPPORTED
798       allowed_address_pairs:
799         type: list
800         description: List of allowed address pair for this interface
801         required: false
802         status: SUPPORTED
803         entry_schema:
804           type: org.openecomp.datatypes.heat.network.contrail.AddressPair
805       ip_address:
806         type: string
807         description: IP for this interface
808         required: false
809         status: SUPPORTED
810 org.openecomp.datatypes.heat.contrailV2.virtual.machine.interface.Properties:
811     derived_from: tosca.datatypes.Root
812     description: Virtual Machine Interface Properties.
813     properties:
814       virtual_machine_interface_properties_service_interface_type:
815         type: string
816         description: Service Interface Type.
817         required: false
818         status: SUPPORTED
819 org.openecomp.datatypes.Root:
820   derived_from: tosca.datatypes.Root
821   description: >
822     The AT&T root Data Type all other Data Types derive from
823   properties:
824     supplemental_data:
825       type: map
826       entry_schema:
827         description: > 
828            A placeholder for missing properties that would be included in future ecomp model versions.
829            fromat <key>:<value>
830         type: string
831
832 org.openecomp.datatypes.network.SubnetAssignments:
833   derived_from: org.openecomp.datatypes.Root
834   properties:
835     ip_network_address_plan:
836       type: string
837       required: false
838       description: Reference to EIPAM, VLAN or other address plan ID used to assign subnets to this network 
839     dhcp_enabled:
840       type: boolean
841       required: false
842       description: \"true\" indicates the network has 1 or more policies
843     ip_version:
844       type: integer
845       constraints:
846         - valid_values: [4,6]
847       required: true
848       description: The IP version of the subnet
849     cidr_mask:
850       type: integer
851       required: true
852       description: The default subnet CIDR mask 
853     min_subnets_count:
854       type: integer
855       default: 1
856       required: true
857       description: Quantity of subnets that must be initially assigned
858 org.openecomp.datatypes.network.IPv4SubnetAssignments:
859   derived_from: org.openecomp.datatypes.network.SubnetAssignments
860   properties:
861     use_ipv4:
862       type: boolean
863       required: true
864       description: Indicates IPv4 subnet assignments
865
866 org.openecomp.datatypes.network.IPv6SubnetAssignments:
867   derived_from: org.openecomp.datatypes.network.SubnetAssignments
868   properties:
869     use_ipv6:
870       type: boolean
871       required: true
872       description: Indicates IPv6 subnet assignments
873
874 org.openecomp.datatypes.network.NetworkAssignments:
875   derived_from: org.openecomp.datatypes.Root
876   properties:
877     ecomp_generated_network_assignment:
878       type: boolean
879       required: true
880       default: false
881       description: >
882         \"true\" indicates that the network assignments will be auto-generated by ECOMP
883         \"false\" indicates operator-supplied Network assignments file upload is required (e.g. VID will present prompt to operator to upload operator-supplied Network assignments file).
884     is_shared_network:
885       type: boolean
886       required: true
887       description: \"true\" means this network is shared by multiple Openstack tenants
888     is_external_network:
889       type: boolean
890       required: true
891       default: false
892       description: >
893         \"true\" means this Contrail external network
894     ipv4_subnet_default_assignment:
895       type: org.openecomp.datatypes.network.IPv4SubnetAssignments
896       required: true
897       description: IPv4 defualt subnet assignments
898     ipv6_subnet_default_assignment:
899       type: org.openecomp.datatypes.network.IPv6SubnetAssignments
900       required: true
901       description: IPv6 defualt subnet assignments
902
903 org.openecomp.datatypes.network.ProviderNetwork:
904   derived_from: org.openecomp.datatypes.Root
905   properties:
906     is_provider_network:
907       type: boolean
908       required: true
909       description: \"true\" indicates that this a Neutron provider type of network 
910     physical_network_name:
911       type: string
912       required: false
913       constraints:
914         - valid_values: ["Physnet41", "Physnet42", "Physnet43", "Physnet44", "Physnet21", "Physnet22"]
915       description: >
916         Identifies the NUMA processor cluster to which this physical network interface belongs.
917         NUMA instance correlates to the first digit of the Physical Network Name suffix (e.g. \"01\" = NUMA 0, \"11\" = NUMA 1)
918     numa:
919       type: string
920       required: false
921       constraints:
922         - valid_values: ["NUMA 0", "NUMA 1"]
923       description: >
924         PNIC instance within the NUMA processor cluster
925         PNIC Instance correlates to the second digit of the Physical Network Name suffix (e.g. "01" = PNIC 1, "02" = "PNIC 2)
926     pnic_instance:
927       type: integer
928       required: false
929       description: PNIC instance within the NUMA processor cluster
930
931 org.openecomp.datatypes.network.NetworkFlows:
932   derived_from: org.openecomp.datatypes.Root
933   properties:
934     is_network_policy:
935       type: boolean
936       required: false
937       default: false
938       description: \"true\" indicates the network has 1 or more policies
939     network_policy:
940       type: string
941       required: false
942       description: "Identifies the specific Cloud network policy that must be applied to this network (source: from Policy Manager)."
943     is_bound_to_vpn:
944       type: boolean
945       required: false
946       default: false
947       description: \"true\" indicates the network has 1 or more vpn bindings
948     vpn_binding:
949       type: string
950       required: false
951       description: "Identifies the specific VPN Binding entry in A&AI that must be applied when creating this network (source: A&AI)"
952
953 org.openecomp.datatypes.network.VlanRequirements:
954   derived_from: org.openecomp.datatypes.Root
955   properties:
956     vlan_range_plan:
957       type: string
958       required: true
959       description: reference to a vlan range plan
960     vlan_type:
961       type: string
962       required: true
963       constraints:
964         - valid_values: ["c-tag", "s-tag"]
965       description: identifies the vlan type (e.g., c-tag)
966     vlan_count:
967       type: integer
968       required: true
969       description: identifies the number of vlan tags to assign to the CP from the plan
970
971 org.openecomp.datatypes.network.IpRequirements:
972   derived_from: org.openecomp.datatypes.Root
973   properties:
974     ip_version:
975       type: integer
976       constraints:
977         - valid_values: [4,6]
978       required: true
979       description: 
980     ip_count:
981       type: integer
982       required: true
983       description: identifies the number of ip address to assign to the CP from the plan
984     floating_ip_count:
985       type: integer
986       required: false
987     subnet_role:
988       type: string
989       required: false
990     assingment_method:
991       type: string
992       constraints:
993         - valid_values: ["fixed", "dhcp"]
994       required: true
995       description:
996
997 org.openecomp.datatypes.network.MacAssignments:
998   derived_from: org.openecomp.datatypes.Root
999   properties:
1000     mac_range_plan:
1001       type: string
1002       required: true
1003       description: reference to a MAC address range plan
1004     mac_count:
1005       type: integer
1006       required: true
1007       description: identifies the number of MAC addresses to assign to the CP from the plan
1008
1009 org.openecomp.datatypes.EcompHoming:
1010   derived_from: org.openecomp.datatypes.Root
1011   properties:
1012     ecomp_selected_instance_node_target:
1013       type: boolean
1014       required: true
1015       default: false
1016       description: >
1017         \"true\" indicates that the target deployment node for this instance will be auto-selected by ECOMP
1018         \"false\" indicates operator-supplied instance target deployment node required (e.g. VID will present a prompt to operator and collect the
1019         operator-selected target node for the deployment of this Network instance).
1020     homing_policy:
1021       type: string
1022       required: false
1023       description: Referenc to a service level homing policy that ECOMP will use for instance deployment target node
1024     instance_node_target:
1025       type: string
1026       required: false
1027       description: Instance target deployment node
1028
1029 org.openecomp.datatypes.EcompNaming:
1030   derived_from: org.openecomp.datatypes.Root
1031   properties:
1032     ecomp_generated_naming:
1033       type: boolean
1034       required: true
1035       default: true
1036       description: >
1037         \"true\" indicates that the name for the instance will be auto-generated by ECOMP.
1038         \"false\" indicates operator-supplied name required (e.g. VID will present prompt to operator and collect the operator-supplied instance name).
1039     naming_policy:
1040       type: string
1041       required: false
1042       description: Referenc to naming policy that ECOMP will use when the name is auto-generated
1043
1044 org.openecomp.datatypes.network.MacRequirements:
1045   derived_from: org.openecomp.datatypes.Root
1046   properties:
1047     mac_range_plan:
1048       type: string
1049       required: true
1050       description: reference to a MAC address range plan
1051     mac_count:
1052         type: integer
1053         required: true
1054         description: identifies the number of MAC addresses to assign to the CP from the plan
1055
1056 org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPairIp:
1057   derived_from: tosca.datatypes.Root
1058   description: Virtual Machine Sub Interface Address Pair IP.
1059   properties:
1060     ip_prefix:
1061       type: string
1062       description: IP Prefix.
1063       required: false
1064       status: SUPPORTED
1065     ip_prefix_len:
1066       type: integer
1067       description: IP Prefix Len.
1068       required: false
1069       status: SUPPORTED
1070
1071 org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.MacAddress:
1072   derived_from: tosca.datatypes.Root
1073   description: Virtual Machine Sub Interface Mac Address.
1074   properties:
1075     mac_address:
1076       type: list
1077       description: Mac Addresses List.
1078       required: false
1079       status: SUPPORTED
1080       entry_schema:
1081         type: string
1082
1083 org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.Properties:
1084   derived_from: tosca.datatypes.Root
1085   description: Virtual Machine Sub Interface VLAN Properties.
1086   properties:
1087     sub_interface_vlan_tag:
1088       type: string
1089       description: Sub Interface VLAN Tag.
1090       required: false
1091       status: SUPPORTED
1092
1093 org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPair:
1094   derived_from: tosca.datatypes.Root
1095   description: Virtual Machine Sub Interface Address Pair.
1096   properties:
1097     address_mode:
1098       type: string
1099       description: Address Mode.
1100       required: false
1101       status: SUPPORTED
1102     ip:
1103       type: org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPairIp
1104       description: IP.
1105       required: false
1106       status: SUPPORTED
1107     mac:
1108       type: string
1109       description: Mac.
1110       required: false
1111       status: SUPPORTED
1112
1113 org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPairs:
1114   derived_from: tosca.datatypes.Root
1115   description: Virtual Machine Sub Interface Address Pairs.
1116   properties:
1117     allowed_address_pair:
1118       type: list
1119       description: Addresses pair List.
1120       required: false
1121       status: SUPPORTED
1122       entry_schema:
1123         type: org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPair