Rework the Model Json
[clamp.git] / src / test / resources / example / sdc / expected-result / policy-data.yaml
1 #
2 # Licensed under the Apache License, Version 2.0 (the "License");
3 # you may not use this file except in compliance with the License.
4 # You may obtain a copy of the License at
5 #
6 #      http://www.apache.org/licenses/LICENSE-2.0
7 #
8 # Unless required by applicable law or agreed to in writing, software
9 # distributed under the License is distributed on an "AS IS" BASIS,
10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11 # See the License for the specific language governing permissions and
12 # limitations under the License.
13 #
14 tosca_definitions_version: tosca_simple_yaml_1_1
15 imports:
16 - data.yml
17 policy_types:
18   tosca.policies.Root:
19     description: The TOSCA Policy Type all other TOSCA Policy Types derive from
20   tosca.policies.Placement:
21     derived_from: tosca.policies.Root
22     description: The TOSCA Policy Type definition that is used to govern placement of TOSCA nodes or groups of nodes.
23   tosca.policies.Scaling:
24     derived_from: tosca.policies.Root
25     description: The TOSCA Policy Type definition that is used to govern scaling of TOSCA nodes or groups of nodes.
26   tosca.policies.Update:
27     derived_from: tosca.policies.Root
28     description: The TOSCA Policy Type definition that is used to govern update of TOSCA nodes or groups of nodes.
29   tosca.policies.Performance:
30     derived_from: tosca.policies.Root
31     description: The TOSCA Policy Type definition that is used to declare performance requirements for TOSCA nodes or groups of nodes.
32   org.openecomp.policies.placement.Antilocate:
33     derived_from: tosca.policies.Placement
34     description: My placement policy for separation based upon container type value
35     properties:
36       name:
37         type: string
38         description: The name of the policy
39         required: false
40         status: SUPPORTED
41       container_type:
42         type: string
43         description: container type
44         required: false
45         status: SUPPORTED
46         constraints:
47         - valid_values:
48           - host
49           - region
50           - compute
51   org.openecomp.policies.placement.Colocate:
52     derived_from: tosca.policies.Placement
53     description: Keep associated nodes (groups of nodes) based upon affinity value
54     properties:
55       name:
56         type: string
57         description: The name of the policy
58         required: false
59         status: SUPPORTED
60       affinity:
61         type: string
62         description: affinity
63         required: true
64         status: SUPPORTED
65         constraints:
66         - valid_values:
67           - host
68           - region
69           - compute
70   org.openecomp.policies.placement.valet.Diversity:
71     derived_from: tosca.policies.Placement
72     description: Valet Diversity
73     properties:
74       level:
75         type: string
76         description: diversity
77         required: false
78         default: host
79         status: SUPPORTED
80         constraints:
81         - valid_values:
82           - host
83           - rack
84   org.openecomp.policies.placement.valet.Exclusivity:
85     derived_from: tosca.policies.Placement
86     description: Valet Exclusivity
87     properties:
88       level:
89         type: string
90         description: exclusivity
91         required: false
92         default: host
93         status: SUPPORTED
94         constraints:
95         - valid_values:
96           - host
97           - rack
98   org.openecomp.policies.placement.valet.Affinity:
99     derived_from: tosca.policies.Placement
100     description: Valet Affinity
101     properties:
102       level:
103         type: string
104         description: affinity
105         required: false
106         default: host
107         status: SUPPORTED
108         constraints:
109         - valid_values:
110           - host
111           - rack
112   org.openecomp.policies.scaling.Fixed:
113     derived_from: tosca.policies.Scaling
114     properties:
115       quantity:
116         description: the exact number of instances to keep up
117         type: integer
118         required: true
119   org.openecomp.policies.External:
120     derived_from: tosca.policies.Root
121     description: externally managed policy (for example, type="network assignment", source="Policy Manager", name="route target")
122     properties:
123       source:
124         type: string
125         description: The name of the server that exposes the policy with predefined type and name.
126         required: false
127       type:
128         type: string
129         description: The type (category) of the policy same as it is defined in the source.
130         required: false
131       name:
132         type: string
133         description: The name of the policy, that related to specific type, same as it is defined in the source.
134         required: false
135   onap.policies.Monitoring:
136     derived_from: tosca.policies.Root
137     description: A base policy type for all policies that governs monitoring provisioning
138   onap.policies.monitoring.cdap.tca.hi.lo.app:
139     derived_from: onap.policies.Monitoring
140     version: 1.0.0
141     properties:
142       tca_policy:
143         type: map
144         description: TCA Policy JSON
145         entry_schema:
146           type: onap.datatypes.monitoring.tca_policy
147   tosca.policies.nfv.InstantiationLevels:
148     derived_from: tosca.policies.Root
149     description: The InstantiationLevels type is a policy type representing all the instantiation levels of resources to be instantiated within a deployment flavour and including default instantiation level in term of the number of VNFC instances to be created as defined in ETSI GS NFV-IFA 011 [1].
150     properties:
151       levels:
152         type: map
153         description: Describes the various levels of resources that can be used to instantiate the VNF using this flavour.
154         required: true
155         entry_schema:
156           type: tosca.datatypes.nfv.InstantiationLevel
157       default_level:
158         type: string
159         description: The default instantiation level for this flavour.
160         required: false
161   tosca.policies.nfv.VduInstantiationLevels:
162     derived_from: tosca.policies.Root
163     description: The VduInstantiationLevels type is a policy type representing all the instantiation levels of resources to be instantiated within a deployment flavour in term of the number of VNFC instances to be created from each vdu.Compute. as defined in ETSI GS NFV-IFA 011 [1]
164     properties:
165       levels:
166         type: map
167         description: Describes the Vdu.Compute levels of resources that can be used to instantiate the VNF using this flavour
168         required: true
169         entry_schema:
170           type: tosca.datatypes.nfv.VduLevel
171     targets:
172     - tosca.nodes.nfv.Vdu.Compute
173   tosca.policies.nfv.VirtualLinkInstantiationLevels:
174     derived_from: tosca.policies.Root
175     description: The VirtualLinkInstantiationLevels type is a policy type representing all the instantiation levels of virtual link resources to be instantiated within a deployment flavour as defined in ETSI GS NFV-IFA 011 [1].
176     properties:
177       levels:
178         type: map
179         description: Describes the virtual link levels of resources that can be used to instantiate the VNF using this flavour.
180         required: true
181         entry_schema:
182           type: tosca.datatypes.nfv.VirtualLinkBitrateLevel
183     targets:
184     - tosca.nodes.nfv.VnfVirtualLink
185   tosca.policies.nfv.ScalingAspects:
186     derived_from: tosca.policies.Root
187     description: The ScalingAspects type is a policy type representing the scaling aspects used for horizontal scaling as defined in ETSI GS NFV-IFA 011 [1].
188     properties:
189       aspects:
190         type: map
191         description: Describe maximum scale level for total number of scaling steps that can be applied to a particular aspect
192         required: true
193         entry_schema:
194           type: tosca.datatypes.nfv.ScalingAspect
195   tosca.policies.nfv.VduScalingAspectDeltas:
196     derived_from: tosca.policies.Root
197     description: The VduScalingAspectDeltas type is a policy type representing the Vdu.Compute detail of an aspect deltas used for horizontal scaling, as defined in ETSI GS NFV-IFA 011 [1].
198     properties:
199       aspect:
200         type: string
201         description: Represents the scaling aspect to which this policy applies
202         required: true
203       deltas:
204         type: map
205         description: Describes the Vdu.Compute scaling deltas to be applied for every scaling steps of a particular aspect.
206         required: true
207         entry_schema:
208           type: tosca.datatypes.nfv.VduLevel
209     targets:
210     - tosca.nodes.nfv.Vdu.Compute
211   tosca.policies.nfv.VirtualLinkBitrateScalingAspectDeltas:
212     derived_from: tosca.policies.Root
213     description: The VirtualLinkBitrateScalingAspectDeltas type is a policy type representing the VnfVirtualLink detail of an aspect deltas used for horizontal scaling, as defined in ETSI GS NFV-IFA 011 [1].
214     properties:
215       aspect:
216         type: string
217         description: Represents the scaling aspect to which this policy applies.
218         required: true
219       deltas:
220         type: map
221         description: Describes the VnfVirtualLink scaling deltas to be applied for every scaling steps of a particular aspect.
222         required: true
223         entry_schema:
224           type: tosca.datatypes.nfv.VirtualLinkBitrateLevel
225     targets:
226     - tosca.nodes.nfv.VnfVirtualLink
227   tosca.policies.nfv.VduInitialDelta:
228     derived_from: tosca.policies.Root
229     description: The VduInitialDelta type is a policy type representing the Vdu.Compute detail of an initial delta used for horizontal scaling, as defined in ETSI GS NFV-IFA 011 [1].
230     properties:
231       initial_delta:
232         type: tosca.datatypes.nfv.VduLevel
233         description: Represents the initial minimum size of the VNF.
234         required: true
235     targets:
236     - tosca.nodes.nfv.Vdu.Compute
237   tosca.policies.nfv.VirtualLinkBitrateInitialDelta:
238     derived_from: tosca.policies.Root
239     description: The VirtualLinkBitrateInitialDelta type is a policy type representing the VnfVirtualLink detail of an initial deltas used for horizontal scaling, as defined in ETSI GS NFV-IFA 011 [1].
240     properties:
241       initial_delta:
242         type: tosca.datatypes.nfv.VirtualLinkBitrateLevel
243         description: Represents the initial minimum size of the VNF.
244         required: true
245     targets:
246     - tosca.nodes.nfv.VnfVirtualLink
247   tosca.policies.nfv.SecurityGroupRule:
248     derived_from: tosca.policies.Root
249     description: The SecurityGroupRule type is a policy type specified the matching criteria for the ingress and/or egress traffic to/from visited connection points as defined in ETSI GS NFV-IFA 011 [1].
250     properties:
251       description:
252         type: string
253         description: Human readable description of the security group rule.
254         required: false
255       direction:
256         type: string
257         description: The direction in which the security group rule is applied. The direction of 'ingress' or 'egress' is specified against the associated CP. I.e., 'ingress' means the packets entering a CP, while 'egress' means the packets sent out of a CP.
258         required: false
259         constraints:
260         - valid_values:
261           - ingress
262           - egress
263         default: ingress
264       ether_type:
265         type: string
266         description: Indicates the protocol carried over the Ethernet layer.
267         required: false
268         constraints:
269         - valid_values:
270           - ipv4
271           - ipv6
272         default: ipv4
273       protocol:
274         type: string
275         description: Indicates the protocol carried over the IP layer. Permitted values include any protocol defined in the IANA protocol registry, e.g. TCP, UDP, ICMP, etc.
276         required: false
277         constraints:
278         - valid_values:
279           - hopopt
280           - icmp
281           - igmp
282           - ggp
283           - ipv4
284           - st
285           - tcp
286           - cbt
287           - egp
288           - igp
289           - bbn_rcc_mon
290           - nvp_ii
291           - pup
292           - argus
293           - emcon
294           - xnet
295           - chaos
296           - udp
297           - mux
298           - dcn_meas
299           - hmp
300           - prm
301           - xns_idp
302           - trunk_1
303           - trunk_2
304           - leaf_1
305           - leaf_2
306           - rdp
307           - irtp
308           - iso_tp4
309           - netblt
310           - mfe_nsp
311           - merit_inp
312           - dccp
313           - 3pc
314           - idpr
315           - xtp
316           - ddp
317           - idpr_cmtp
318           - tp++
319           - il
320           - ipv6
321           - sdrp
322           - ipv6_route
323           - ipv6_frag
324           - idrp
325           - rsvp
326           - gre
327           - dsr
328           - bna
329           - esp
330           - ah
331           - i_nlsp
332           - swipe
333           - narp
334           - mobile
335           - tlsp
336           - skip
337           - ipv6_icmp
338           - ipv6_no_nxt
339           - ipv6_opts
340           - cftp
341           - sat_expak
342           - kryptolan
343           - rvd
344           - ippc
345           - sat_mon
346           - visa
347           - ipcv
348           - cpnx
349           - cphb
350           - wsn
351           - pvp
352           - br_sat_mon
353           - sun_nd
354           - wb_mon
355           - wb_expak
356           - iso_ip
357           - vmtp
358           - secure_vmtp
359           - vines
360           - ttp
361           - iptm
362           - nsfnet_igp
363           - dgp
364           - tcf
365           - eigrp
366           - ospfigp
367           - sprite_rpc
368           - larp
369           - mtp
370           - ax.25
371           - ipip
372           - micp
373           - scc_sp
374           - etherip
375           - encap
376           - gmtp
377           - ifmp
378           - pnni
379           - pim
380           - aris
381           - scps
382           - qnx
383           - a/n
384           - ip_comp
385           - snp
386           - compaq_peer
387           - ipx_in_ip
388           - vrrp
389           - pgm
390           - l2tp
391           - ddx
392           - iatp
393           - stp
394           - srp
395           - uti
396           - smp
397           - sm
398           - ptp
399           - isis
400           - fire
401           - crtp
402           - crudp
403           - sscopmce
404           - iplt
405           - sps
406           - pipe
407           - sctp
408           - fc
409           - rsvp_e2e_ignore
410           - mobility
411           - udp_lite
412           - mpls_in_ip
413           - manet
414           - hip
415           - shim6
416           - wesp
417           - rohc
418         default: tcp
419       port_range_min:
420         type: integer
421         description: Indicates minimum port number in the range that is matched by the security group rule. If a value is provided at design-time, this value may be overridden at run-time based on other deployment requirements or constraints.
422         required: false
423         constraints:
424         - greater_or_equal: 0
425         - less_or_equal: 65535
426         default: 0
427       port_range_max:
428         type: integer
429         description: Indicates maximum port number in the range that is matched by the security group rule. If a value is provided at design-time, this value may be overridden at run-time based on other deployment requirements or constraints.
430         required: false
431         constraints:
432         - greater_or_equal: 0
433         - less_or_equal: 65535
434         default: 65535
435     targets:
436     - tosca.nodes.nfv.VduCp
437     - tosca.nodes.nfv.VnfExtCp
438   tosca.policies.nfv.SupportedVnfInterface:
439     derived_from: tosca.policies.Root
440     description: this policy type represents interfaces produced by a VNF, the details to access them and the applicable connection points to use to access these interfaces
441     properties:
442       interface_name:
443         type: string
444         description: Identifies an interface produced by the VNF.
445         required: true
446         constraints:
447         - valid_values:
448           - vnf_indicator
449           - vnf_configuration
450       details:
451         type: tosca.datatypes.nfv.InterfaceDetails
452         description: Provide additional data to access the interface endpoint
453         required: false
454     targets:
455     - tosca.nodes.nfv.VnfExtCp
456     - tosca.nodes.nfv.VduCp
457 data_types:
458   tosca.datatypes.Root:
459     description: The TOSCA root Data Type all other TOSCA base Data Types derive from
460   integer:
461     derived_from: tosca.datatypes.Root
462   string:
463     derived_from: tosca.datatypes.Root
464   boolean:
465     derived_from: tosca.datatypes.Root
466   float:
467     derived_from: tosca.datatypes.Root
468   list:
469     derived_from: tosca.datatypes.Root
470   map:
471     derived_from: tosca.datatypes.Root
472   json:
473     derived_from: tosca.datatypes.Root
474   scalar-unit:
475     derived_from: tosca.datatypes.Root
476   scalar-unit.size:
477     derived_from: scalar-unit
478   scalar-unit.time:
479     derived_from: scalar-unit
480   scalar-unit.frequency:
481     derived_from: scalar-unit
482   tosca.datatypes.Credential:
483     derived_from: tosca.datatypes.Root
484     properties:
485       protocol:
486         type: string
487         required: false
488       token_type:
489         type: string
490         default: password
491       token:
492         type: string
493       keys:
494         type: map
495         required: false
496         entry_schema:
497           type: string
498       user:
499         type: string
500         required: false
501   org.openecomp.datatypes.PortMirroringConnectionPointDescription:
502     derived_from: tosca.datatypes.Root
503     properties:
504       nf_naming_code:
505         type: string
506       nfc_naming_code:
507         type: string
508       network_role:
509         type: string
510       pps_capacity:
511         type: string
512       nf_type:
513         type: string
514         description: deprecated
515       nfc_type:
516         type: string
517         description: deprecated
518   tosca.datatypes.TimeInterval:
519     derived_from: tosca.datatypes.Root
520     properties:
521       start_time:
522         type: timestamp
523         required: true
524       end_time:
525         type: timestamp
526         required: true
527   tosca.datatypes.network.NetworkInfo:
528     derived_from: tosca.datatypes.Root
529     properties:
530       network_name:
531         type: string
532       network_id:
533         type: string
534       addresses:
535         type: list
536         entry_schema:
537           type: string
538   tosca.datatypes.network.PortInfo:
539     derived_from: tosca.datatypes.Root
540     properties:
541       port_name:
542         type: string
543       port_id:
544         type: string
545       network_id:
546         type: string
547       mac_address:
548         type: string
549       addresses:
550         type: list
551         entry_schema:
552           type: string
553   tosca.datatypes.network.PortDef:
554     derived_from: integer
555     constraints:
556     - in_range:
557       - 1
558       - 65535
559   tosca.datatypes.network.PortSpec:
560     derived_from: tosca.datatypes.Root
561     properties:
562       protocol:
563         type: string
564         required: true
565         default: tcp
566         constraints:
567         - valid_values:
568           - udp
569           - tcp
570           - igmp
571       target:
572         type: tosca.datatypes.network.PortDef
573       target_range:
574         type: range
575         constraints:
576         - in_range:
577           - 1
578           - 65535
579       source:
580         type: tosca.datatypes.network.PortDef
581       source_range:
582         type: range
583         constraints:
584         - in_range:
585           - 1
586           - 65535
587   org.openecomp.datatypes.heat.network.AddressPair:
588     derived_from: tosca.datatypes.Root
589     description: MAC/IP address pairs
590     properties:
591       mac_address:
592         type: string
593         description: MAC address
594         required: false
595         status: SUPPORTED
596       ip_address:
597         type: string
598         description: IP address
599         required: false
600         status: SUPPORTED
601   org.openecomp.datatypes.heat.network.subnet.HostRoute:
602     derived_from: tosca.datatypes.Root
603     description: Host route info for the subnet
604     properties:
605       destination:
606         type: string
607         description: The destination for static route
608         required: false
609         status: SUPPORTED
610       nexthop:
611         type: string
612         description: The next hop for the destination
613         required: false
614         status: SUPPORTED
615   org.openecomp.datatypes.heat.network.AllocationPool:
616     derived_from: tosca.datatypes.Root
617     description: The start and end addresses for the allocation pool
618     properties:
619       start:
620         type: string
621         description: Start address for the allocation pool
622         required: false
623         status: SUPPORTED
624       end:
625         type: string
626         description: End address for the allocation pool
627         required: false
628         status: SUPPORTED
629   org.openecomp.datatypes.heat.network.neutron.Subnet:
630     derived_from: tosca.datatypes.Root
631     description: A subnet represents an IP address block that can be used for assigning IP addresses to virtual instances
632     properties:
633       tenant_id:
634         type: string
635         description: The ID of the tenant who owns the network
636         required: false
637         status: SUPPORTED
638       enable_dhcp:
639         type: boolean
640         description: Set to true if DHCP is enabled and false if DHCP is disabled
641         required: false
642         default: true
643         status: SUPPORTED
644       ipv6_address_mode:
645         type: string
646         description: IPv6 address mode
647         required: false
648         status: SUPPORTED
649         constraints:
650         - valid_values:
651           - dhcpv6-stateful
652           - dhcpv6-stateless
653           - slaac
654       ipv6_ra_mode:
655         type: string
656         description: IPv6 RA (Router Advertisement) mode
657         required: false
658         status: SUPPORTED
659         constraints:
660         - valid_values:
661           - dhcpv6-stateful
662           - dhcpv6-stateless
663           - slaac
664       value_specs:
665         type: map
666         description: Extra parameters to include in the request
667         required: false
668         default: {}
669         status: SUPPORTED
670         entry_schema:
671           type: string
672       allocation_pools:
673         type: list
674         description: The start and end addresses for the allocation pools
675         required: false
676         status: SUPPORTED
677         entry_schema:
678           type: org.openecomp.datatypes.heat.network.AllocationPool
679       subnetpool:
680         type: string
681         description: The name or ID of the subnet pool
682         required: false
683         status: SUPPORTED
684       dns_nameservers:
685         type: list
686         description: A specified set of DNS name servers to be used
687         required: false
688         default: []
689         status: SUPPORTED
690         entry_schema:
691           type: string
692       host_routes:
693         type: list
694         description: The gateway IP address
695         required: false
696         status: SUPPORTED
697         entry_schema:
698           type: org.openecomp.datatypes.heat.network.subnet.HostRoute
699       ip_version:
700         type: integer
701         description: The gateway IP address
702         required: false
703         default: 4
704         status: SUPPORTED
705         constraints:
706         - valid_values:
707           - '4'
708           - '6'
709       name:
710         type: string
711         description: The name of the subnet
712         required: false
713         status: SUPPORTED
714       prefixlen:
715         type: integer
716         description: Prefix length for subnet allocation from subnet pool
717         required: false
718         status: SUPPORTED
719         constraints:
720         - greater_or_equal: 0
721       cidr:
722         type: string
723         description: The CIDR
724         required: false
725         status: SUPPORTED
726       gateway_ip:
727         type: string
728         description: The gateway IP address
729         required: false
730         status: SUPPORTED
731   org.openecomp.datatypes.heat.novaServer.network.PortExtraProperties:
732     derived_from: tosca.datatypes.Root
733     description: Nova server network expand properties for port
734     properties:
735       port_security_enabled:
736         type: boolean
737         description: Flag to enable/disable port security on the port
738         required: false
739         status: SUPPORTED
740       mac_address:
741         type: string
742         description: MAC address to give to this port
743         required: false
744         status: SUPPORTED
745       admin_state_up:
746         type: boolean
747         description: The administrative state of this port
748         required: false
749         default: true
750         status: SUPPORTED
751       qos_policy:
752         type: string
753         description: The name or ID of QoS policy to attach to this port
754         required: false
755         status: SUPPORTED
756       allowed_address_pairs:
757         type: list
758         description: Additional MAC/IP address pairs allowed to pass through the port
759         required: false
760         status: SUPPORTED
761         entry_schema:
762           type: org.openecomp.datatypes.heat.network.AddressPair
763       binding:vnic_type:
764         type: string
765         description: The vnic type to be bound on the neutron port
766         required: false
767         status: SUPPORTED
768         constraints:
769         - valid_values:
770           - macvtap
771           - direct
772           - normal
773       value_specs:
774         type: map
775         description: Extra parameters to include in the request
776         required: false
777         default: {}
778         status: SUPPORTED
779         entry_schema:
780           type: string
781   org.openecomp.datatypes.heat.novaServer.network.AddressInfo:
782     derived_from: tosca.datatypes.network.NetworkInfo
783     description: Network addresses with corresponding port id
784     properties:
785       port_id:
786         type: string
787         description: Port id
788         required: false
789         status: SUPPORTED
790   org.openecomp.datatypes.heat.neutron.port.FixedIps:
791     derived_from: tosca.datatypes.Root
792     description: subnet/ip_address
793     properties:
794       subnet:
795         type: string
796         description: Subnet in which to allocate the IP address for this port
797         required: false
798         status: SUPPORTED
799       ip_address:
800         type: string
801         description: IP address desired in the subnet for this port
802         required: false
803         status: SUPPORTED
804       subnet_id:
805         type: string
806         description: Subnet in which to allocate the IP address for this port
807         required: false
808         status: SUPPORTED
809   org.openecomp.datatypes.heat.FileInfo:
810     derived_from: tosca.datatypes.Root
811     description: Heat File Info
812     properties:
813       file:
814         type: string
815         description: The required URI string (relative or absolute) which can be used to locate the file
816         required: true
817         status: SUPPORTED
818       file_type:
819         type: string
820         description: The type of the file
821         required: true
822         status: SUPPORTED
823         constraints:
824         - valid_values:
825           - base
826           - env
827           - volume
828           - network
829   org.openecomp.datatypes.heat.contrail.network.rule.PortPairs:
830     derived_from: tosca.datatypes.Root
831     description: source and destination port pairs
832     properties:
833       start_port:
834         type: string
835         description: Start port
836         required: false
837         status: SUPPORTED
838       end_port:
839         type: string
840         description: End port
841         required: false
842         status: SUPPORTED
843   org.openecomp.datatypes.heat.contrail.network.rule.Rule:
844     derived_from: tosca.datatypes.Root
845     description: policy rule
846     properties:
847       src_ports:
848         type: list
849         description: Source ports
850         required: false
851         status: SUPPORTED
852         entry_schema:
853           type: org.openecomp.datatypes.heat.contrail.network.rule.PortPairs
854       protocol:
855         type: string
856         description: Protocol
857         required: false
858         status: SUPPORTED
859       dst_addresses:
860         type: list
861         description: Destination addresses
862         required: false
863         status: SUPPORTED
864         entry_schema:
865           type: org.openecomp.datatypes.heat.contrail.network.rule.VirtualNetwork
866       apply_service:
867         type: string
868         description: Service to apply
869         required: false
870         status: SUPPORTED
871       dst_ports:
872         type: list
873         description: Destination ports
874         required: false
875         status: SUPPORTED
876         entry_schema:
877           type: org.openecomp.datatypes.heat.contrail.network.rule.PortPairs
878       src_addresses:
879         type: list
880         description: Source addresses
881         required: false
882         status: SUPPORTED
883         entry_schema:
884           type: org.openecomp.datatypes.heat.contrail.network.rule.VirtualNetwork
885       direction:
886         type: string
887         description: Direction
888         required: false
889         status: SUPPORTED
890   org.openecomp.datatypes.heat.contrail.network.rule.RuleList:
891     derived_from: tosca.datatypes.Root
892     description: list of policy rules
893     properties:
894       policy_rule:
895         type: list
896         description: Contrail network rule
897         required: false
898         status: SUPPORTED
899         entry_schema:
900           type: org.openecomp.datatypes.heat.contrail.network.rule.Rule
901   org.openecomp.datatypes.heat.contrail.network.rule.VirtualNetwork:
902     derived_from: tosca.datatypes.Root
903     description: source and destination addresses
904     properties:
905       virtual_network:
906         type: string
907         description: Virtual network
908         required: false
909         status: SUPPORTED
910   org.openecomp.datatypes.heat.network.neutron.SecurityRules.Rule:
911     derived_from: tosca.datatypes.Root
912     description: Rules Pairs
913     properties:
914       remote_group_id:
915         type: string
916         description: The remote group ID to be associated with this security group rule
917         required: false
918         status: SUPPORTED
919       protocol:
920         type: string
921         description: The protocol that is matched by the security group rule
922         required: false
923         status: SUPPORTED
924         constraints:
925         - valid_values:
926           - tcp
927           - udp
928           - icmp
929       ethertype:
930         type: string
931         description: Ethertype of the traffic
932         required: false
933         default: IPv4
934         status: SUPPORTED
935         constraints:
936         - valid_values:
937           - IPv4
938           - IPv6
939       port_range_max:
940         type: integer
941         description: 'The maximum port number in the range that is matched by the
942           security group rule. '
943         required: false
944         status: SUPPORTED
945         constraints:
946         - in_range:
947           - 0
948           - 65535
949       remote_ip_prefix:
950         type: string
951         description: The remote IP prefix (CIDR) to be associated with this security group rule
952         required: false
953         status: SUPPORTED
954       remote_mode:
955         type: string
956         description: Whether to specify a remote group or a remote IP prefix
957         required: false
958         default: remote_ip_prefix
959         status: SUPPORTED
960         constraints:
961         - valid_values:
962           - remote_ip_prefix
963           - remote_group_id
964       direction:
965         type: string
966         description: The direction in which the security group rule is applied
967         required: false
968         default: ingress
969         status: SUPPORTED
970         constraints:
971         - valid_values:
972           - egress
973           - ingress
974       port_range_min:
975         type: integer
976         description: The minimum port number in the range that is matched by the security group rule.
977         required: false
978         status: SUPPORTED
979         constraints:
980         - in_range:
981           - 0
982           - 65535
983   org.openecomp.datatypes.heat.substitution.SubstitutionFiltering:
984     derived_from: tosca.datatypes.Root
985     description: Substitution Filter
986     properties:
987       substitute_service_template:
988         type: string
989         description: Substitute Service Template
990         required: true
991         status: SUPPORTED
992       index_value:
993         type: integer
994         description: Index value of the substitution service template runtime instance
995         required: false
996         default: 0
997         status: SUPPORTED
998         constraints:
999         - greater_or_equal: 0
1000       count:
1001         type: string
1002         description: Count
1003         required: false
1004         default: 1
1005         status: SUPPORTED
1006       scaling_enabled:
1007         type: boolean
1008         description: Indicates whether service scaling is enabled
1009         required: false
1010         default: true
1011         status: SUPPORTED
1012       mandatory:
1013         type: boolean
1014         description: Mandatory
1015         required: false
1016         default: true
1017         status: SUPPORTED
1018   org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.RefDataSequence:
1019     derived_from: tosca.datatypes.Root
1020     description: network policy refs data sequence
1021     properties:
1022       network_policy_refs_data_sequence_major:
1023         type: integer
1024         description: Network Policy ref data sequence Major
1025         required: false
1026         status: SUPPORTED
1027       network_policy_refs_data_sequence_minor:
1028         type: integer
1029         description: Network Policy ref data sequence Minor
1030         required: false
1031         status: SUPPORTED
1032   org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.RefData:
1033     derived_from: tosca.datatypes.Root
1034     description: network policy refs data
1035     properties:
1036       network_policy_refs_data_sequence:
1037         type: org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.RefDataSequence
1038         description: Network Policy ref data sequence
1039         required: false
1040         status: SUPPORTED
1041   org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.ref.data.IpamSubnet:
1042     derived_from: tosca.datatypes.Root
1043     description: Network Ipam Ref Data Subnet
1044     properties:
1045       network_ipam_refs_data_ipam_subnets_subnet_ip_prefix_len:
1046         type: string
1047         description: Network ipam refs data ipam subnets ip prefix len
1048         required: false
1049         status: SUPPORTED
1050       network_ipam_refs_data_ipam_subnets_subnet_ip_prefix:
1051         type: string
1052         description: Network ipam refs data ipam subnets ip prefix
1053         required: false
1054         status: SUPPORTED
1055   org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.ref.data.IpamSubnetList:
1056     derived_from: tosca.datatypes.Root
1057     description: Network Ipam Ref Data Subnet List
1058     properties:
1059       network_ipam_refs_data_ipam_subnets_subnet:
1060         type: org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.ref.data.IpamSubnet
1061         description: Network ipam refs data ipam subnets
1062         required: false
1063         status: SUPPORTED
1064       network_ipam_refs_data_ipam_subnets_addr_from_start:
1065         type: string
1066         description: Network ipam refs data ipam subnets addr from start
1067         required: false
1068         status: SUPPORTED
1069   org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.IpamRefData:
1070     derived_from: tosca.datatypes.Root
1071     description: Network Ipam Ref Data
1072     properties:
1073       network_ipam_refs_data_ipam_subnets:
1074         type: list
1075         description: Network ipam refs data ipam subnets
1076         required: false
1077         status: SUPPORTED
1078         entry_schema:
1079           type: org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.ref.data.IpamSubnetList
1080   org.openecomp.datatypes.heat.contrailV2.network.rule.SrcVirtualNetwork:
1081     derived_from: tosca.datatypes.Root
1082     description: source addresses
1083     properties:
1084       network_policy_entries_policy_rule_src_addresses_virtual_network:
1085         type: string
1086         description: Source addresses Virtual network
1087         required: false
1088         status: SUPPORTED
1089   org.openecomp.datatypes.heat.contrailV2.network.rule.DstVirtualNetwork:
1090     derived_from: tosca.datatypes.Root
1091     description: destination addresses
1092     properties:
1093       network_policy_entries_policy_rule_dst_addresses_virtual_network:
1094         type: string
1095         description: Destination addresses Virtual network
1096         required: false
1097         status: SUPPORTED
1098   org.openecomp.datatypes.heat.contrailV2.network.rule.DstPortPairs:
1099     derived_from: tosca.datatypes.Root
1100     description: destination port pairs
1101     properties:
1102       network_policy_entries_policy_rule_dst_ports_start_port:
1103         type: string
1104         description: Start port
1105         required: false
1106         status: SUPPORTED
1107       network_policy_entries_policy_rule_dst_ports_end_port:
1108         type: string
1109         description: End port
1110         required: false
1111         status: SUPPORTED
1112   org.openecomp.datatypes.heat.contrailV2.network.rule.SrcPortPairs:
1113     derived_from: tosca.datatypes.Root
1114     description: source port pairs
1115     properties:
1116       network_policy_entries_policy_rule_src_ports_start_port:
1117         type: string
1118         description: Start port
1119         required: false
1120         status: SUPPORTED
1121       network_policy_entries_policy_rule_src_ports_end_port:
1122         type: string
1123         description: End port
1124         required: false
1125         status: SUPPORTED
1126   org.openecomp.datatypes.heat.contrailV2.network.rule.ActionList:
1127     derived_from: tosca.datatypes.Root
1128     description: Action List
1129     properties:
1130       network_policy_entries_policy_rule_action_list_simple_action:
1131         type: string
1132         description: Simple Action
1133         required: false
1134         status: SUPPORTED
1135       network_policy_entries_policy_rule_action_list_apply_service:
1136         type: list
1137         description: Apply Service
1138         required: false
1139         status: SUPPORTED
1140         entry_schema:
1141           type: string
1142   org.openecomp.datatypes.heat.contrailV2.network.rule.Rule:
1143     derived_from: tosca.datatypes.Root
1144     description: policy rule
1145     properties:
1146       network_policy_entries_policy_rule_dst_addresses:
1147         type: list
1148         description: Destination addresses
1149         required: false
1150         status: SUPPORTED
1151         entry_schema:
1152           type: org.openecomp.datatypes.heat.contrailV2.network.rule.DstVirtualNetwork
1153       network_policy_entries_policy_rule_dst_ports:
1154         type: list
1155         description: Destination ports
1156         required: false
1157         status: SUPPORTED
1158         entry_schema:
1159           type: org.openecomp.datatypes.heat.contrailV2.network.rule.DstPortPairs
1160       network_policy_entries_policy_rule_protocol:
1161         type: string
1162         description: Protocol
1163         required: false
1164         status: SUPPORTED
1165       network_policy_entries_policy_rule_src_addresses:
1166         type: list
1167         description: Source addresses
1168         required: false
1169         status: SUPPORTED
1170         entry_schema:
1171           type: org.openecomp.datatypes.heat.contrailV2.network.rule.SrcVirtualNetwork
1172       network_policy_entries_policy_rule_direction:
1173         type: string
1174         description: Direction
1175         required: false
1176         status: SUPPORTED
1177       network_policy_entries_policy_rule_src_ports:
1178         type: list
1179         description: Source ports
1180         required: false
1181         status: SUPPORTED
1182         entry_schema:
1183           type: org.openecomp.datatypes.heat.contrailV2.network.rule.SrcPortPairs
1184       network_policy_entries_policy_rule_action_list:
1185         type: org.openecomp.datatypes.heat.contrailV2.network.rule.ActionList
1186         description: Action list
1187         required: false
1188         status: SUPPORTED
1189   org.openecomp.datatypes.heat.contrailV2.network.rule.RuleList:
1190     derived_from: tosca.datatypes.Root
1191     description: list of policy rules
1192     properties:
1193       network_policy_entries_policy_rule:
1194         type: list
1195         description: Contrail network rule
1196         required: false
1197         status: SUPPORTED
1198         entry_schema:
1199           type: org.openecomp.datatypes.heat.contrailV2.network.rule.Rule
1200   org.openecomp.datatypes.heat.network.contrail.port.StaticRoute:
1201     derived_from: tosca.datatypes.Root
1202     description: static route
1203     properties:
1204       prefix:
1205         type: string
1206         description: Route prefix
1207         required: false
1208         status: SUPPORTED
1209       next_hop:
1210         type: string
1211         description: Next hop
1212         required: false
1213         status: SUPPORTED
1214       next_hop_type:
1215         type: string
1216         description: Next hop type
1217         required: false
1218         status: SUPPORTED
1219   org.openecomp.datatypes.heat.network.contrail.AddressPair:
1220     derived_from: tosca.datatypes.Root
1221     description: Address Pair
1222     properties:
1223       address_mode:
1224         type: string
1225         description: Address mode active-active or active-standy
1226         required: false
1227         status: SUPPORTED
1228         constraints:
1229         - valid_values:
1230           - active-active
1231           - active-standby
1232       prefix:
1233         type: string
1234         description: IP address prefix
1235         required: false
1236         status: SUPPORTED
1237       mac_address:
1238         type: string
1239         description: Mac address
1240         required: false
1241         status: SUPPORTED
1242   org.openecomp.datatypes.heat.network.contrail.InterfaceData:
1243     derived_from: tosca.datatypes.Root
1244     description: Interface Data
1245     properties:
1246       static_routes:
1247         type: list
1248         description: An ordered list of static routes to be added to this interface
1249         required: false
1250         status: SUPPORTED
1251         entry_schema:
1252           type: org.openecomp.datatypes.heat.network.contrail.port.StaticRoute
1253       virtual_network:
1254         type: string
1255         description: Virtual Network for this interface
1256         required: true
1257         status: SUPPORTED
1258       allowed_address_pairs:
1259         type: list
1260         description: List of allowed address pair for this interface
1261         required: false
1262         status: SUPPORTED
1263         entry_schema:
1264           type: org.openecomp.datatypes.heat.network.contrail.AddressPair
1265       ip_address:
1266         type: string
1267         description: IP for this interface
1268         required: false
1269         status: SUPPORTED
1270   org.openecomp.datatypes.heat.contrailV2.virtual.machine.interface.Properties:
1271     derived_from: tosca.datatypes.Root
1272     description: Virtual Machine Interface Properties.
1273     properties:
1274       virtual_machine_interface_properties_service_interface_type:
1275         type: string
1276         description: Service Interface Type.
1277         required: false
1278         status: SUPPORTED
1279   org.openecomp.datatypes.Root:
1280     derived_from: tosca.datatypes.Root
1281     description: |
1282       The ECOMP root Data Type all other Data Types derive from
1283     properties:
1284       supplemental_data:
1285         type: map
1286         entry_schema:
1287           description: |
1288             A placeholder for missing properties that would be included in future ecomp model versions. fromat <key>:<value>
1289           type: string
1290   org.openecomp.datatypes.AssignmentRequirements:
1291     derived_from: org.openecomp.datatypes.Root
1292     properties:
1293       is_required:
1294         description: |
1295           "true" indicates that assignment is required
1296         type: boolean
1297         default: false
1298         required: true
1299       count:
1300         description: number of assignments required
1301         type: integer
1302         required: false
1303   org.openecomp.datatypes.network.SubnetAssignments:
1304     derived_from: org.openecomp.datatypes.Root
1305     properties:
1306       ip_network_address_plan:
1307         type: string
1308         required: false
1309         description: Reference to EIPAM, VLAN or other address plan ID used to assign subnets to this network
1310       dhcp_enabled:
1311         type: boolean
1312         required: false
1313         description: \"true\" indicates the network has 1 or more policies
1314       ip_version:
1315         type: integer
1316         constraints:
1317         - valid_values:
1318           - 4
1319           - 6
1320         required: true
1321         description: The IP version of the subnet
1322       cidr_mask:
1323         type: integer
1324         required: true
1325         description: The default subnet CIDR mask
1326       min_subnets_count:
1327         type: integer
1328         default: 1
1329         required: true
1330         description: Quantity of subnets that must be initially assigned
1331   org.openecomp.datatypes.network.IPv4SubnetAssignments:
1332     derived_from: org.openecomp.datatypes.network.SubnetAssignments
1333     properties:
1334       use_ipv4:
1335         type: boolean
1336         required: true
1337         description: Indicates IPv4 subnet assignments
1338   org.openecomp.datatypes.network.IPv6SubnetAssignments:
1339     derived_from: org.openecomp.datatypes.network.SubnetAssignments
1340     properties:
1341       use_ipv6:
1342         type: boolean
1343         required: true
1344         description: Indicates IPv6 subnet assignments
1345   org.openecomp.datatypes.network.NetworkAssignments:
1346     derived_from: org.openecomp.datatypes.Root
1347     properties:
1348       ecomp_generated_network_assignment:
1349         type: boolean
1350         required: true
1351         default: false
1352         description: |
1353           \"true\" indicates that the network assignments will be auto-generated by ECOMP \"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).
1354       is_shared_network:
1355         type: boolean
1356         required: true
1357         description: \"true\" means this network is shared by multiple Openstack tenants
1358       is_external_network:
1359         type: boolean
1360         required: true
1361         default: false
1362         description: |
1363           \"true\" means this Contrail external network
1364       ipv4_subnet_default_assignment:
1365         type: org.openecomp.datatypes.network.IPv4SubnetAssignments
1366         required: true
1367         description: IPv4 defualt subnet assignments
1368       ipv6_subnet_default_assignment:
1369         type: org.openecomp.datatypes.network.IPv6SubnetAssignments
1370         required: true
1371         description: IPv6 defualt subnet assignments
1372       related_networks:
1373         type: list
1374         required: false
1375         description: Related Networks List.
1376         entry_schema:
1377           type: org.openecomp.datatypes.network.RelatedNetworksAssignments
1378       is_trunked:
1379         type: boolean
1380         required: true
1381         description: \"true\" indicates that network is trunked
1382         default: false
1383   org.openecomp.datatypes.network.ProviderNetwork:
1384     derived_from: org.openecomp.datatypes.Root
1385     properties:
1386       is_provider_network:
1387         type: boolean
1388         required: true
1389         description: \"true\" indicates that this a Neutron provider type of network
1390       physical_network_name:
1391         type: string
1392         required: false
1393         constraints:
1394         - valid_values:
1395           - Physnet41
1396           - Physnet42
1397           - Physnet43
1398           - Physnet44
1399           - Physnet21
1400           - Physnet22
1401           - sriovnet1
1402           - sriovnet2
1403           - oam
1404         description: |
1405           Identifies the NUMA processor cluster to which this physical network interface belongs. NUMA instance correlates to the first digit of the Physical Network Name suffix (e.g. \"01\" = NUMA 0, \"11\" = NUMA 1)
1406       numa:
1407         type: string
1408         required: false
1409         constraints:
1410         - valid_values:
1411           - NUMA 0
1412           - NUMA 1
1413         description: |
1414           PNIC instance within the NUMA processor cluster PNIC Instance correlates to the second digit of the Physical Network Name suffix (e.g. "01" = PNIC 1, "02" = "PNIC 2)
1415       pnic_instance:
1416         type: integer
1417         required: false
1418         description: PNIC instance within the NUMA processor cluster
1419   org.openecomp.datatypes.network.NetworkFlows:
1420     derived_from: org.openecomp.datatypes.Root
1421     properties:
1422       is_network_policy:
1423         type: boolean
1424         required: false
1425         default: false
1426         description: \"true\" indicates the network has 1 or more policies
1427       network_policy:
1428         type: string
1429         required: false
1430         description: 'Identifies the specific Cloud network policy that must be applied
1431           to this network (source: from Policy Manager).'
1432       is_bound_to_vpn:
1433         type: boolean
1434         required: false
1435         default: false
1436         description: \"true\" indicates the network has 1 or more vpn bindings
1437       vpn_binding:
1438         type: string
1439         required: false
1440         description: 'Identifies the specific VPN Binding entry in A&AI that must
1441           be applied when creating this network (source: A&AI)'
1442   org.openecomp.datatypes.network.VlanRequirements:
1443     derived_from: org.openecomp.datatypes.Root
1444     properties:
1445       vlan_range_plan:
1446         type: string
1447         required: true
1448         description: reference to a vlan range plan
1449       vlan_type:
1450         type: string
1451         required: true
1452         constraints:
1453         - valid_values:
1454           - c-tag
1455           - s-tag
1456         description: identifies the vlan type (e.g., c-tag)
1457       vlan_count:
1458         type: integer
1459         required: true
1460         description: identifies the number of vlan tags to assign to the CP from the plan
1461   org.openecomp.datatypes.network.IpRequirements:
1462     derived_from: org.openecomp.datatypes.Root
1463     properties:
1464       ip_version:
1465         type: integer
1466         required: true
1467         constraints:
1468         - valid_values:
1469           - 4
1470           - 6
1471       ip_count:
1472         description: identifies the number of ip address to assign to the CP from the plan
1473         type: integer
1474         required: false
1475       floating_ip_count:
1476         type: integer
1477         required: false
1478       subnet_role:
1479         type: string
1480         required: false
1481       assingment_method:
1482         type: string
1483         required: true
1484         constraints:
1485         - valid_values:
1486           - fixed
1487           - dhcp
1488       dhcp_enabled:
1489         type: boolean
1490         required: false
1491       ip_count_required:
1492         description: identifies the number of ip address to assign to the CP from the plan
1493         type: org.openecomp.datatypes.AssignmentRequirements
1494         required: false
1495       floating_ip_count_required:
1496         type: org.openecomp.datatypes.AssignmentRequirements
1497         required: false
1498       ip_address_plan_name:
1499         type: string
1500         required: false
1501       vrf_name:
1502         type: string
1503         required: false
1504   org.openecomp.datatypes.network.MacAssignments:
1505     derived_from: org.openecomp.datatypes.Root
1506     properties:
1507       mac_range_plan:
1508         type: string
1509         required: true
1510         description: reference to a MAC address range plan
1511       mac_count:
1512         type: integer
1513         required: true
1514         description: identifies the number of MAC addresses to assign to the CP from the plan
1515   org.openecomp.datatypes.EcompHoming:
1516     derived_from: org.openecomp.datatypes.Root
1517     properties:
1518       ecomp_selected_instance_node_target:
1519         type: boolean
1520         required: true
1521         default: false
1522         description: |
1523           \"true\" indicates that the target deployment node for this instance will be auto-selected by ECOMP \"false\" indicates operator-supplied instance target deployment node required (e.g. VID will present a prompt to operator and collect the operator-selected target node for the deployment of this Network instance).
1524       homing_policy:
1525         type: string
1526         required: false
1527         description: Referenc to a service level homing policy that ECOMP will use for instance deployment target node
1528       instance_node_target:
1529         type: string
1530         required: false
1531         description: Instance target deployment node
1532   org.openecomp.datatypes.EcompNaming:
1533     derived_from: org.openecomp.datatypes.Root
1534     properties:
1535       ecomp_generated_naming:
1536         type: boolean
1537         required: true
1538         default: true
1539         description: |
1540           \"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).
1541       naming_policy:
1542         type: string
1543         required: false
1544         description: Referenc to naming policy that ECOMP will use when the name is auto-generated
1545   org.openecomp.datatypes.network.MacRequirements:
1546     derived_from: org.openecomp.datatypes.Root
1547     properties:
1548       mac_range_plan:
1549         description: reference to a MAC address range plan
1550         type: string
1551         required: false
1552       mac_count:
1553         description: identifies the number of MAC addresses to assign to the CP from the plan
1554         type: integer
1555         required: false
1556       mac_count_required:
1557         description: identifies the number of MAC addresses to assign to the CP from the plan
1558         type: org.openecomp.datatypes.AssignmentRequirements
1559   org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPairIp:
1560     derived_from: tosca.datatypes.Root
1561     description: Virtual Machine Sub Interface Address Pair IP.
1562     properties:
1563       ip_prefix:
1564         type: string
1565         description: IP Prefix.
1566         required: false
1567         status: SUPPORTED
1568       ip_prefix_len:
1569         type: integer
1570         description: IP Prefix Len.
1571         required: false
1572         status: SUPPORTED
1573   org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.MacAddress:
1574     derived_from: tosca.datatypes.Root
1575     description: Virtual Machine Sub Interface Mac Address.
1576     properties:
1577       mac_address:
1578         type: list
1579         description: Mac Addresses List.
1580         required: false
1581         status: SUPPORTED
1582         entry_schema:
1583           type: string
1584   org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.Properties:
1585     derived_from: tosca.datatypes.Root
1586     description: Virtual Machine Sub Interface VLAN Properties.
1587     properties:
1588       sub_interface_vlan_tag:
1589         type: string
1590         description: Sub Interface VLAN Tag.
1591         required: false
1592         status: SUPPORTED
1593   org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPair:
1594     derived_from: tosca.datatypes.Root
1595     description: Virtual Machine Sub Interface Address Pair.
1596     properties:
1597       address_mode:
1598         type: string
1599         description: Address Mode.
1600         required: false
1601         status: SUPPORTED
1602       ip:
1603         type: org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPairIp
1604         description: IP.
1605         required: false
1606         status: SUPPORTED
1607       mac:
1608         type: string
1609         description: Mac.
1610         required: false
1611         status: SUPPORTED
1612   org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPairs:
1613     derived_from: tosca.datatypes.Root
1614     description: Virtual Machine Sub Interface Address Pairs.
1615     properties:
1616       allowed_address_pair:
1617         type: list
1618         description: Addresses pair List.
1619         required: false
1620         status: SUPPORTED
1621         entry_schema:
1622           type: org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPair
1623   org.openecomp.datatypes.Naming:
1624     derived_from: org.openecomp.datatypes.Root
1625     properties:
1626       ecomp_generated_naming:
1627         description: |
1628           "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).
1629         type: boolean
1630         default: true
1631         required: true
1632       naming_policy:
1633         description: Reference to naming policy that ECOMP will use when the name is auto-generated
1634         type: string
1635         required: false
1636       instance_name:
1637         description: indicates operator-supplied name required (e.g. VID will present prompt to operator and collect the operator-supplied instance name).
1638         type: string
1639         required: false
1640   org.openecomp.datatypes.flavors.ComputeFlavor:
1641     derived_from: tosca.datatypes.Root
1642     properties:
1643       num_cpus:
1644         type: integer
1645       disk_size:
1646         type: scalar-unit.size
1647       mem_size:
1648         type: scalar-unit.size
1649   org.openecomp.datatypes.flavors.LicenseFlavor:
1650     derived_from: tosca.datatypes.Root
1651     properties:
1652       feature_group_uuid:
1653         type: string
1654   org.openecomp.datatypes.flavors.VendorInfo:
1655     derived_from: tosca.datatypes.Root
1656     properties:
1657       manufacturer_reference_number:
1658         type: string
1659       vendor_model:
1660         type: string
1661   org.openecomp.datatypes.flavors.DeploymentFlavor:
1662     derived_from: tosca.datatypes.Root
1663     properties:
1664       sp_part_number:
1665         type: string
1666       vendor_info:
1667         type: org.openecomp.datatypes.flavors.VendorInfo
1668       compute_flavor:
1669         type: org.openecomp.datatypes.flavors.ComputeFlavor
1670       license_flavor:
1671         type: org.openecomp.datatypes.flavors.LicenseFlavor
1672         required: false
1673   org.openecomp.datatypes.ImageInfo:
1674     derived_from: tosca.datatypes.Root
1675     properties:
1676       software_version:
1677         type: string
1678       file_name:
1679         type: string
1680       file_hash:
1681         type: string
1682         description: checksum/signature
1683       file_hash_type:
1684         type: string
1685         required: false
1686         default: md5
1687   org.openecomp.datatypes.network.RelatedNetworksAssignments:
1688     derived_from: org.openecomp.datatypes.Root
1689     properties:
1690       related_network_role:
1691         type: string
1692         description: The network role of the related network, sharing provider network.
1693         required: false
1694   tosca.datatypes.nfv.VnfcAdditionalConfigurableProperties:
1695     derived_from: tosca.datatypes.Root
1696     description: VnfcAdditionalConfigurableProperties type is an empty base type for deriving data types for describing additional configurable properties for a given VNFC.
1697     properties:
1698       description:
1699         type: string
1700         required: false
1701   tosca.datatypes.nfv.VnfcConfigurableProperties:
1702     derived_from: tosca.datatypes.Root
1703     description: Defines the configurable properties of a VNFC
1704     properties:
1705       additional_vnfc_configurable_properties:
1706         type: tosca.datatypes.nfv.VnfcAdditionalConfigurableProperties
1707         description: Describes additional configuration for VNFC that can be modified using the ModifyVnfInfo operation
1708         required: false
1709   tosca.datatypes.nfv.RequestedAdditionalCapability:
1710     derived_from: tosca.datatypes.Root
1711     description: describes requested additional capability for a particular VDU
1712     properties:
1713       requested_additional_capability_name:
1714         type: string
1715         description: Identifies a requested additional capability for the VDU.
1716         required: true
1717       support_mandatory:
1718         type: boolean
1719         description: Indicates whether the requested additional capability is mandatory for successful operation.
1720         required: true
1721       min_requested_additional_capability_version:
1722         type: string
1723         description: Identifies the minimum version of the requested additional capability.
1724         required: false
1725       preferred_requested_additional_capability_version:
1726         type: string
1727         description: Identifies the preferred version of the requested additional capability.
1728         required: false
1729       target_performance_parameters:
1730         type: map
1731         description: Identifies specific attributes, dependent on the requested additional capability type.
1732         required: true
1733         entry_schema:
1734           type: string
1735   tosca.datatypes.nfv.VirtualMemory:
1736     derived_from: tosca.datatypes.Root
1737     description: supports the specification of requirements related to virtual memory of a virtual compute resource
1738     properties:
1739       virtual_mem_size:
1740         type: scalar-unit.size
1741         description: Amount of virtual memory.
1742         required: true
1743       virtual_mem_oversubscription_policy:
1744         type: string
1745         description: The memory core oversubscription policy in terms of virtual memory to physical memory on the platform.
1746         required: false
1747       vdu_mem_requirements:
1748         type: map
1749         description: The hardware platform specific VDU memory requirements. A map of strings that contains a set of key-value pairs that describes hardware platform specific VDU memory requirements.
1750         required: false
1751         entry_schema:
1752           type: string
1753       numa_enabled:
1754         type: boolean
1755         description: It specifies the memory allocation to be cognisant of the relevant process/core allocation.
1756         required: false
1757         default: false
1758   tosca.datatypes.nfv.VirtualCpuPinning:
1759     derived_from: tosca.datatypes.Root
1760     description: Supports the specification of requirements related to the virtual CPU pinning configuration of a virtual compute resource
1761     properties:
1762       virtual_cpu_pinning_policy:
1763         type: string
1764         description: 'Indicates the policy for CPU pinning. The policy can take values
1765           of "static" or "dynamic". In case of "dynamic" the allocation of virtual
1766           CPU cores to logical CPU cores is decided by the VIM. (e.g.: SMT (Simultaneous
1767           Multi-Threading) requirements). In case of "static" the allocation is requested
1768           to be according to the virtual_cpu_pinning_rule.'
1769         required: false
1770         constraints:
1771         - valid_values:
1772           - static
1773           - dynamic
1774       virtual_cpu_pinning_rule:
1775         type: list
1776         description: Provides the list of rules for allocating virtual CPU cores to logical CPU cores/threads
1777         required: false
1778         entry_schema:
1779           type: string
1780   tosca.datatypes.nfv.VirtualCpu:
1781     derived_from: tosca.datatypes.Root
1782     description: Supports the specification of requirements related to virtual CPU(s) of a virtual compute resource
1783     properties:
1784       cpu_architecture:
1785         type: string
1786         description: CPU architecture type. Examples are x86, ARM
1787         required: false
1788       num_virtual_cpu:
1789         type: integer
1790         description: Number of virtual CPUs
1791         required: true
1792         constraints:
1793         - greater_than: 0
1794       virtual_cpu_clock:
1795         type: scalar-unit.frequency
1796         description: Minimum virtual CPU clock rate
1797         required: false
1798       virtual_cpu_oversubscription_policy:
1799         type: string
1800         description: CPU core oversubscription policy e.g. the relation of virtual CPU cores to physical CPU cores/threads.
1801         required: false
1802       vdu_cpu_requirements:
1803         type: map
1804         description: The hardware platform specific VDU CPU requirements. A map of strings that contains a set of key-value pairs describing VDU CPU specific hardware platform requirements.
1805         required: false
1806         entry_schema:
1807           type: string
1808       virtual_cpu_pinning:
1809         type: tosca.datatypes.nfv.VirtualCpuPinning
1810         description: The virtual CPU pinning configuration for the virtualised compute resource.
1811         required: false
1812   tosca.datatypes.nfv.LogicalNodeData:
1813     derived_from: tosca.datatypes.Root
1814     description: Describes compute, memory and I/O requirements associated with a particular VDU.
1815     properties:
1816       logical_node_requirements:
1817         type: map
1818         description: The logical node-level compute, memory and I/O requirements. A map  of strings that contains a set of key-value pairs that describes hardware platform specific deployment requirements, including the number of CPU cores on this logical node, a memory configuration specific to a logical node  or a requirement related to the association of an I/O device with the logical node.
1819         required: false
1820         entry_schema:
1821           type: string
1822   tosca.datatypes.nfv.VirtualNetworkInterfaceRequirements:
1823     derived_from: tosca.datatypes.Root
1824     description: Describes requirements on a virtual network interface
1825     properties:
1826       name:
1827         type: string
1828         description: Provides a human readable name for the requirement.
1829         required: false
1830       description:
1831         type: string
1832         description: Provides a human readable description of the requirement.
1833         required: false
1834       support_mandatory:
1835         type: boolean
1836         description: Indicates whether fulfilling the constraint is mandatory (TRUE) for successful operation or desirable (FALSE).
1837         required: true
1838       network_interface_requirements:
1839         type: map
1840         description: The network interface requirements. A map of strings that contain a set of key-value pairs that describes the hardware platform specific  network interface deployment requirements.
1841         required: true
1842         entry_schema:
1843           type: string
1844       nic_io_requirements:
1845         type: tosca.datatypes.nfv.LogicalNodeData
1846         description: references (couples) the CP with any logical node I/O requirements (for network devices) that may have been created. Linking these attributes is necessary so that so that I/O requirements that need to be articulated at the logical node level can be associated with the network interface requirements associated with the CP.
1847         required: false
1848   tosca.datatypes.nfv.injectFile:
1849     derived_from: tosca.datatypes.Root
1850     properties:
1851       source_path:
1852         type: string
1853         required: true
1854       dest_path:
1855         type: string
1856         required: true
1857   tosca.datatypes.nfv.L2AddressData:
1858     derived_from: tosca.datatypes.Root
1859     description: Describes the information on the MAC addresses to be assigned to a connection point.
1860     properties:
1861       mac_address_assignment:
1862         type: boolean
1863         description: Specifies if the address assignment is the responsibility of management and orchestration function or not. If it is set to True, it is the management and orchestration function responsibility
1864         required: true
1865   tosca.datatypes.nfv.L3AddressData:
1866     derived_from: tosca.datatypes.Root
1867     description: Provides information about Layer 3 level addressing scheme and parameters applicable to a CP
1868     properties:
1869       ip_address_assignment:
1870         type: boolean
1871         description: Specifies if the address assignment is the responsibility of management and orchestration function or not. If it is set to True, it is the management and orchestration function responsibility
1872         required: true
1873       floating_ip_activated:
1874         type: boolean
1875         description: Specifies if the floating IP scheme is activated on the Connection Point or not
1876         required: true
1877       ip_address_type:
1878         type: string
1879         description: Defines address type. The address type should be aligned with the address type supported by the layer_protocols properties of the parent VnfExtCp
1880         required: false
1881         constraints:
1882         - valid_values:
1883           - ipv4
1884           - ipv6
1885       number_of_ip_address:
1886         type: integer
1887         description: Minimum number of IP addresses to be assigned
1888         required: false
1889         constraints:
1890         - greater_than: 0
1891       fixed_ip_address:
1892         type: list
1893         entry_schema:
1894           type: string
1895         required: false
1896   tosca.datatypes.nfv.AddressData:
1897     derived_from: tosca.datatypes.Root
1898     description: Describes information about the addressing scheme and parameters applicable to a CP
1899     properties:
1900       address_type:
1901         type: string
1902         description: Describes the type of the address to be assigned to a connection point. The content type shall be aligned with the address type supported by the layerProtocol property of the connection point
1903         required: true
1904         constraints:
1905         - valid_values:
1906           - mac_address
1907           - ip_address
1908       l2_address_data:
1909         type: tosca.datatypes.nfv.L2AddressData
1910         description: Provides the information on the MAC addresses to be assigned to a connection point.
1911         required: false
1912       l3_address_data:
1913         type: tosca.datatypes.nfv.L3AddressData
1914         description: Provides the information on the IP addresses to be assigned to a connection point
1915         required: false
1916   tosca.datatypes.nfv.ConnectivityType:
1917     derived_from: tosca.datatypes.Root
1918     description: describes additional connectivity information of a virtualLink
1919     properties:
1920       layer_protocols:
1921         type: list
1922         description: Identifies the protocol a virtualLink gives access to (ethernet, mpls, odu2, ipv4, ipv6, pseudo-wire).The top layer protocol of the virtualLink protocol stack shall always be provided. The lower layer protocols may be included when there are specific requirements on these layers.
1923         required: true
1924         entry_schema:
1925           type: string
1926           constraints:
1927           - valid_values:
1928             - ethernet
1929             - mpls
1930             - odu2
1931             - ipv4
1932             - ipv6
1933             - pseudo-wire
1934       flow_pattern:
1935         type: string
1936         description: Identifies the flow pattern of the connectivity
1937         required: false
1938         constraints:
1939         - valid_values:
1940           - line
1941           - tree
1942           - mesh
1943   tosca.datatypes.nfv.VlFlavour:
1944     derived_from: tosca.datatypes.Root
1945     properties:
1946       flavourId:
1947         type: string
1948   tosca.datatypes.nfv.ext.AddressPairs:
1949     properties:
1950       ip:
1951         type: string
1952         required: false
1953       mac:
1954         type: string
1955         required: false
1956   tosca.datatypes.nfv.ext.FloatingIP:
1957     properties:
1958       external_network:
1959         type: string
1960         required: false
1961       ip_address:
1962         type: string
1963         required: false
1964   tosca.datatypes.nfv.ext.LocationInfo:
1965     properties:
1966       availability_zone:
1967         type: string
1968         required: false
1969       vimid:
1970         type: integer
1971         required: false
1972       tenant:
1973         type: string
1974         required: false
1975   tosca.datatypes.nfv.ext.HostRouteInfo:
1976     properties:
1977       destination:
1978         type: string
1979         required: false
1980       nexthop:
1981         type: string
1982         required: false
1983   tosca.datatypes.nfv.ext.InjectData:
1984     properties:
1985       file_name:
1986         type: string
1987         required: false
1988       file_data:
1989         type: string
1990         required: false
1991   tosca.datatypes.nfv.ext.zte.WatchDog:
1992     properties:
1993       enable_delay:
1994         type: integer
1995         required: false
1996       action:
1997         type: string
1998         required: false
1999   tosca.datatypes.nfv.ext.LocalAffinityOrAntiAffinityRule:
2000     properties:
2001       scope:
2002         type: string
2003         required: false
2004       affinity_antiaffinity:
2005         type: string
2006         required: false
2007   tosca.datatypes.nfv.VduProfile:
2008     derived_from: tosca.datatypes.Root
2009     description: describes additional instantiation data for a given Vdu.Compute used in a specific deployment flavour.
2010     properties:
2011       min_number_of_instances:
2012         type: integer
2013         description: Minimum number of instances of the VNFC based on this Vdu.Compute that is permitted to exist for a particular VNF deployment flavour.
2014         required: true
2015         constraints:
2016         - greater_or_equal: 0
2017       max_number_of_instances:
2018         type: integer
2019         description: Maximum number of instances of the VNFC based on this Vdu.Compute that is permitted to exist for a particular VNF deployment flavour.
2020         required: true
2021         constraints:
2022         - greater_or_equal: 0
2023       watchdog:
2024         type: string
2025         required: true
2026       vmBootUpTimeOut:
2027         type: integer
2028         required: false
2029   tosca.datatypes.nfv.LinkBitrateRequirements:
2030     derived_from: tosca.datatypes.Root
2031     description: describes the requirements in terms of bitrate for a virtual link
2032     properties:
2033       root:
2034         type: integer
2035         description: Specifies the throughput requirement in bits per second of the link (e.g. bitrate of E-Line, root bitrate of E-Tree, aggregate capacity of E-LAN).
2036         required: true
2037         constraints:
2038         - greater_or_equal: 0
2039       leaf:
2040         type: integer
2041         description: Specifies the throughput requirement in bits per second of leaf connections to the link when applicable to the connectivity type (e.g. for E-Tree and E LAN branches).
2042         required: false
2043         constraints:
2044         - greater_or_equal: 0
2045   tosca.datatypes.nfv.Qos:
2046     derived_from: tosca.datatypes.Root
2047     description: describes QoS data for a given VL used in a VNF deployment flavour
2048     properties:
2049       latency:
2050         type: scalar-unit.time
2051         description: Specifies the maximum latency
2052         required: true
2053         constraints:
2054         - greater_than: 0 s
2055       packet_delay_variation:
2056         type: scalar-unit.time
2057         description: Specifies the maximum jitter
2058         required: true
2059         constraints:
2060         - greater_or_equal: 0 s
2061       packet_loss_ratio:
2062         type: float
2063         description: Specifies the maximum packet loss ratio
2064         required: false
2065         constraints:
2066         - in_range:
2067           - 0.0
2068           - 1.0
2069   tosca.datatypes.nfv.IpAllocationPool:
2070     derived_from: tosca.datatypes.Root
2071     description: Specifies a range of IP addresses
2072     properties:
2073       start_ip_address:
2074         type: string
2075         description: The IP address to be used as the first one in a pool of addresses derived from the cidr block full IP range
2076         required: true
2077       end_ip_address:
2078         type: string
2079         description: The IP address to be used as the last one in a pool of addresses derived from the cidr block full IP range
2080         required: true
2081   tosca.datatypes.nfv.L2ProtocolData:
2082     derived_from: tosca.datatypes.Root
2083     description: describes L2 protocol data for a given virtual link used in a specific VNF deployment flavour.
2084     properties:
2085       name:
2086         type: string
2087         description: Identifies the network name associated with this L2 protocol.
2088         required: false
2089       network_type:
2090         type: string
2091         description: Specifies the network type for this L2 protocol.The value may be overridden at run-time.
2092         required: false
2093         constraints:
2094         - valid_values:
2095           - flat
2096           - vlan
2097           - vxlan
2098           - gre
2099       vlan_transparent:
2100         type: boolean
2101         description: Specifies whether to support VLAN transparency for this L2 protocol or not.
2102         required: false
2103         default: false
2104       mtu:
2105         type: integer
2106         description: Specifies the maximum transmission unit (MTU) value for this L2 protocol.
2107         required: false
2108         constraints:
2109         - greater_than: 0
2110       segmentation_id:
2111         type: integer
2112         required: false
2113       physical_network:
2114         type: string
2115         required: false
2116   tosca.datatypes.nfv.L3ProtocolData:
2117     derived_from: tosca.datatypes.Root
2118     description: describes L3 protocol data for a given virtual link used in a specific VNF deployment flavour.
2119     properties:
2120       name:
2121         type: string
2122         description: Identifies the network name associated with this L3 protocol.
2123         required: false
2124       ip_version:
2125         type: string
2126         description: Specifies IP version of this L3 protocol.The value of the ip_version property shall be consistent with the value of the layer_protocol in the connectivity_type property of the virtual link node.
2127         required: true
2128         constraints:
2129         - valid_values:
2130           - ipv4
2131           - ipv6
2132       cidr:
2133         type: string
2134         description: Specifies the CIDR (Classless Inter-Domain Routing) of this L3 protocol. The value may be overridden at run-time.
2135         required: true
2136       ip_allocation_pools:
2137         type: list
2138         description: Specifies the allocation pools with start and end IP addresses for this L3 protocol. The value may be overridden at run-time.
2139         required: false
2140         entry_schema:
2141           type: tosca.datatypes.nfv.IpAllocationPool
2142       gateway_ip:
2143         type: string
2144         description: Specifies the gateway IP address for this L3 protocol. The value may be overridden at run-time.
2145         required: false
2146       dhcp_enabled:
2147         type: boolean
2148         description: Indicates whether DHCP (Dynamic Host Configuration Protocol) is enabled or disabled for this L3 protocol. The value may be overridden at run-time.
2149         required: false
2150       ipv6_address_mode:
2151         type: string
2152         description: Specifies IPv6 address mode. May be present when the value of the ipVersion attribute is "ipv6" and shall be absent otherwise. The value may be overridden at run-time.
2153         required: false
2154         constraints:
2155         - valid_values:
2156           - slaac
2157           - dhcpv6-stateful
2158           - dhcpv6-stateless
2159   tosca.datatypes.nfv.VirtualLinkProtocolData:
2160     derived_from: tosca.datatypes.Root
2161     description: describes one protocol layer and associated protocol data for a given virtual link used in a specific VNF deployment flavour
2162     properties:
2163       associated_layer_protocol:
2164         type: string
2165         description: Identifies one of the protocols a virtualLink gives access to (ethernet, mpls, odu2, ipv4, ipv6, pseudo-wire) as specified by the connectivity_type property.
2166         required: true
2167         constraints:
2168         - valid_values:
2169           - ethernet
2170           - mpls
2171           - odu2
2172           - ipv4
2173           - ipv6
2174           - pseudo-wire
2175       l2_protocol_data:
2176         type: tosca.datatypes.nfv.L2ProtocolData
2177         description: Specifies the L2 protocol data for a virtual link. Shall be present when the associatedLayerProtocol attribute indicates a L2 protocol and shall be absent otherwise.
2178         required: false
2179       l3_protocol_data:
2180         type: tosca.datatypes.nfv.L3ProtocolData
2181         description: Specifies the L3 protocol data for this virtual link.  Shall be present when the associatedLayerProtocol attribute indicates a L3 protocol and shall be absent otherwise.
2182         required: false
2183   tosca.datatypes.nfv.VlProfile:
2184     derived_from: tosca.datatypes.Root
2185     description: Describes additional instantiation data for a given VL used in a specific VNF deployment flavour.
2186     properties:
2187       max_bitrate_requirements:
2188         type: tosca.datatypes.nfv.LinkBitrateRequirements
2189         description: Specifies the maximum bitrate requirements for a VL instantiated according to this profile.
2190         required: true
2191       min_bitrate_requirements:
2192         type: tosca.datatypes.nfv.LinkBitrateRequirements
2193         description: Specifies the minimum bitrate requirements for a VL instantiated according to this profile.
2194         required: true
2195       qos:
2196         type: tosca.datatypes.nfv.Qos
2197         description: Specifies the QoS requirements of a VL instantiated according to this profile.
2198         required: false
2199       virtual_link_protocol_data:
2200         type: list
2201         description: Specifies the protocol data for a virtual link.
2202         required: false
2203         entry_schema:
2204           type: tosca.datatypes.nfv.VirtualLinkProtocolData
2205   tosca.datatypes.nfv.VduLevel:
2206     derived_from: tosca.datatypes.Root
2207     description: Indicates for a given Vdu.Compute in a given level the number of instances to deploy
2208     properties:
2209       number_of_instances:
2210         type: integer
2211         description: Number of instances of VNFC based on this VDU to deploy for this level.
2212         required: true
2213         constraints:
2214         - greater_or_equal: 0
2215   tosca.datatypes.nfv.ScaleInfo:
2216     derived_from: tosca.datatypes.Root
2217     description: Indicates for a given scaleAspect the corresponding scaleLevel
2218     properties:
2219       scale_level:
2220         type: integer
2221         description: The scale level for a particular aspect
2222         required: true
2223         constraints:
2224         - greater_or_equal: 0
2225   tosca.datatypes.nfv.ScalingAspect:
2226     derived_from: tosca.datatypes.Root
2227     properties:
2228       name:
2229         type: string
2230         required: true
2231       description:
2232         type: string
2233         required: true
2234       max_scale_level:
2235         type: integer
2236         required: true
2237         constraints:
2238         - greater_or_equal: 0
2239       step_deltas:
2240         type: list
2241         required: false
2242         entry_schema:
2243           type: string
2244   tosca.datatypes.nfv.InstantiationLevel:
2245     derived_from: tosca.datatypes.Root
2246     description: Describes the scale level for each aspect that corresponds to a given level of resources to be instantiated within a deployment flavour in term of the number VNFC instances
2247     properties:
2248       description:
2249         type: string
2250         description: Human readable description of the level
2251         required: true
2252       scale_info:
2253         type: map
2254         description: Represents for each aspect the scale level that corresponds to this instantiation level. scale_info shall be present if the VNF supports scaling.
2255         required: false
2256         entry_schema:
2257           type: tosca.datatypes.nfv.ScaleInfo
2258   tosca.datatypes.nfv.VnfInstantiateOperationConfiguration:
2259     derived_from: tosca.datatypes.Root
2260     description: represents information that affect the invocation of the InstantiateVnf operation.
2261     properties:
2262       description:
2263         type: string
2264         required: false
2265   tosca.datatypes.nfv.VnfScaleOperationConfiguration:
2266     derived_from: tosca.datatypes.Root
2267     description: Represents information that affect the invocation of the ScaleVnf operation
2268     properties:
2269       scaling_by_more_than_one_step_supported:
2270         type: boolean
2271         description: Signals whether passing a value larger than one in the numScalingSteps parameter of the ScaleVnf operation is supported by this VNF.
2272         required: false
2273         default: false
2274   tosca.datatypes.nfv.VnfScaleToLevelOperationConfiguration:
2275     derived_from: tosca.datatypes.Root
2276     description: represents information that affect the invocation of the ScaleVnfToLevel operation
2277     properties:
2278       arbitrary_target_levels_supported:
2279         type: boolean
2280         description: Signals whether scaling according to the parameter "scaleInfo" is supported by this VNF
2281         required: true
2282   tosca.datatypes.nfv.VnfHealOperationConfiguration:
2283     derived_from: tosca.datatypes.Root
2284     description: represents information that affect the invocation of the HealVnf operation
2285     properties:
2286       causes:
2287         type: list
2288         description: Supported "cause" parameter values
2289         required: false
2290         entry_schema:
2291           type: string
2292   tosca.datatypes.nfv.VnfTerminateOperationConfiguration:
2293     derived_from: tosca.datatypes.Root
2294     description: represents information that affect the invocation of the TerminateVnf
2295     properties:
2296       min_graceful_termination_timeout:
2297         type: scalar-unit.time
2298         description: Minimum timeout value for graceful termination of a VNF instance
2299         required: true
2300       max_recommended_graceful_termination_timeout:
2301         type: scalar-unit.time
2302         description: Maximum recommended timeout value that can be needed to gracefully terminate a VNF instance of a particular type under certain conditions, such as maximum load condition. This is provided by VNF provider as information for the operator facilitating the selection of optimal timeout value. This value is not used as constraint
2303         required: false
2304   tosca.datatypes.nfv.VnfOperateOperationConfiguration:
2305     derived_from: tosca.datatypes.Root
2306     description: represents information that affect the invocation of the OperateVnf operation
2307     properties:
2308       min_graceful_stop_timeout:
2309         type: scalar-unit.time
2310         description: Minimum timeout value for graceful stop of a VNF instance
2311         required: true
2312       max_recommended_graceful_stop_timeout:
2313         type: scalar-unit.time
2314         description: Maximum recommended timeout value that can be needed to gracefully stop a VNF instance of a particular type under certain conditions, such as maximum load condition. This is provided by VNF provider as information for the operator facilitating the selection of optimal timeout value. This value is not used as constraint
2315         required: false
2316   tosca.datatypes.nfv.VnfChangeFlavourOperationConfiguration:
2317     derived_from: tosca.datatypes.Root
2318     description: represents information that affect the invocation of the ChangeVnfFlavour operation
2319     properties:
2320       description:
2321         type: string
2322         required: false
2323   tosca.datatypes.nfv.VnfProfile:
2324     derived_from: tosca.datatypes.Root
2325     description: describes a profile for instantiating VNFs of a particular NS DF according to a specific VNFD and VNF DF.
2326     properties:
2327       instantiation_level:
2328         type: string
2329         description: Identifier of the instantiation level of the VNF DF to be used for instantiation. If not present, the default instantiation level as declared in the VNFD shall be used.
2330         required: false
2331       min_number_of_instances:
2332         type: integer
2333         description: Minimum number of instances of the VNF based on this VNFD that is permitted to exist for this VnfProfile.
2334         required: true
2335         constraints:
2336         - greater_or_equal: 0
2337       max_number_of_instances:
2338         type: integer
2339         description: Maximum number of instances of the VNF based on this VNFD that is permitted to exist for this VnfProfile.
2340         required: true
2341         constraints:
2342         - greater_or_equal: 0
2343   tosca.datatypes.nfv.UriAuthority:
2344     derived_from: tosca.datatypes.Root
2345     description: information that corresponds to the authority component of a URI as specified in IETF RFC 3986 [8]
2346     properties:
2347       user_info:
2348         type: string
2349         description: user_info field of the authority component of a URI
2350         required: false
2351       host:
2352         type: string
2353         description: host field of the authority component of a URI
2354         required: false
2355       port:
2356         type: string
2357         description: port field of the authority component of a URI
2358         required: false
2359   tosca.datatypes.nfv.UriComponents:
2360     derived_from: tosca.datatypes.Root
2361     description: information used to build a URI that complies with IETF RFC 3986 [8].
2362     properties:
2363       scheme:
2364         type: string
2365         description: scheme component of a URI.
2366         required: true
2367       authority:
2368         type: tosca.datatypes.nfv.UriAuthority
2369         description: Authority component of a URI
2370         required: false
2371       path:
2372         type: string
2373         description: path component of a URI.
2374         required: false
2375       query:
2376         type: string
2377         description: query component of a URI.
2378         required: false
2379       fragment:
2380         type: string
2381         description: fragment component of a URI.
2382         required: false
2383   tosca.datatypes.nfv.InterfaceDetails:
2384     derived_from: tosca.datatypes.Root
2385     description: information used to access an interface exposed by a VNF
2386     properties:
2387       uri_components:
2388         type: tosca.datatypes.nfv.UriComponents
2389         description: Provides components to build a Uniform Ressource Identifier (URI) where to access the interface end point.
2390         required: false
2391       interface_specific_data:
2392         type: map
2393         description: Provides additional details that are specific to the type of interface considered.
2394         required: false
2395         entry_schema:
2396           type: string
2397   tosca.datatypes.nfv.VirtualLinkMonitoringParameter:
2398     derived_from: tosca.datatypes.Root
2399     description: Represents information on virtualised resource related performance metrics applicable to the VNF.
2400     properties:
2401       name:
2402         type: string
2403         description: Human readable name of the monitoring parameter
2404         required: true
2405       performance_metric:
2406         type: string
2407         description: Identifies a performance metric derived from those defined in ETSI GS NFV-IFA 027.The packetOutgoingVirtualLink and packetIncomingVirtualLink metrics shall be obtained by aggregation the PacketOutgoing and PacketIncoming measurements defined in clause 7.1 of GS NFV-IFA 027 of all virtual link ports attached to the virtual link to which the metrics apply.
2408         required: true
2409         constraints:
2410         - valid_values:
2411           - packet_outgoing_virtual_link
2412           - packet_incoming_virtual_link
2413       collection_period:
2414         type: scalar-unit.time
2415         description: Describes the recommended periodicity at which to collect the performance information.
2416         required: false
2417         constraints:
2418         - greater_than: 0 s
2419   tosca.datatypes.nfv.VnfcMonitoringParameter:
2420     derived_from: tosca.datatypes.Root
2421     description: Represents information on virtualised resource related performance metrics applicable to the VNF.
2422     properties:
2423       name:
2424         type: string
2425         description: Human readable name of the monitoring parameter
2426         required: true
2427       performance_metric:
2428         type: string
2429         description: Identifies the performance metric, according to ETSI GS NFV-IFA 027.
2430         required: true
2431         constraints:
2432         - valid_values:
2433           - v_cpu_usage_mean_vnf
2434           - v_cpu_usage_peak_vnf
2435           - v_memory_usage_mean_vnf
2436           - v_memory_usage_peak_vnf
2437           - v_disk_usage_mean_vnf
2438           - v_disk_usage_peak_vnf
2439           - byte_incoming_vnf_int_cp
2440           - byte_outgoing_vnf_int_cp
2441           - packet_incoming_vnf_int_cp
2442           - packet_outgoing_vnf_int_cp
2443       collection_period:
2444         type: scalar-unit.time
2445         description: Describes the recommended periodicity at which to collect the performance information.
2446         required: false
2447         constraints:
2448         - greater_than: 0 s
2449   tosca.datatypes.nfv.VnfChangeExtConnectivityOperationConfiguration:
2450     derived_from: tosca.datatypes.Root
2451     description: represents information that affect the invocation of the ChangeExtVnfConnectivity operation
2452     properties:
2453       description:
2454         type: string
2455         required: false
2456   tosca.datatypes.nfv.VnfMonitoringParameter:
2457     derived_from: tosca.datatypes.Root
2458     description: Represents information on virtualised resource related performance metrics applicable to the VNF.
2459     properties:
2460       name:
2461         type: string
2462         description: Human readable name of the monitoring parameter
2463         required: true
2464       performance_metric:
2465         type: string
2466         description: Identifies the performance metric, according to ETSI GS NFV-IFA 027.
2467         required: true
2468         constraints:
2469         - valid_values:
2470           - v_cpu_usage_mean_vnf
2471           - v_cpu_usage_peak_vnf
2472           - v_memory_usage_mean_vnf
2473           - v_memory_usage_peak_vnf
2474           - v_disk_usage_mean_vnf
2475           - v_disk_usage_peak_vnf
2476           - byte_incoming_vnf_ext_cp
2477           - byte_outgoing_vnf_ext_cp
2478           - packet_incoming_vnf_ext_cp
2479           - packet_outgoing_vnf_ext_cp
2480       collection_period:
2481         type: scalar-unit.time
2482         description: Describes the recommended periodicity at which to collect the performance information.
2483         required: false
2484         constraints:
2485         - greater_than: 0 s
2486   tosca.datatypes.nfv.VnfLcmOperationsConfiguration:
2487     derived_from: tosca.datatypes.Root
2488     description: Represents information to configure lifecycle management operations
2489     properties:
2490       instantiate:
2491         type: tosca.datatypes.nfv.VnfInstantiateOperationConfiguration
2492         description: Configuration parameters for the InstantiateVnf operation
2493         required: false
2494       scale:
2495         type: tosca.datatypes.nfv.VnfScaleOperationConfiguration
2496         description: Configuration parameters for the ScaleVnf operation
2497         required: false
2498       scale_to_level:
2499         type: tosca.datatypes.nfv.VnfScaleToLevelOperationConfiguration
2500         description: Configuration parameters for the ScaleVnfToLevel operation
2501         required: false
2502       change_flavour:
2503         type: tosca.datatypes.nfv.VnfChangeFlavourOperationConfiguration
2504         description: Configuration parameters for the changeVnfFlavourOpConfig operation
2505         required: false
2506       heal:
2507         type: tosca.datatypes.nfv.VnfHealOperationConfiguration
2508         description: Configuration parameters for the HealVnf operation
2509         required: false
2510       terminate:
2511         type: tosca.datatypes.nfv.VnfTerminateOperationConfiguration
2512         description: Configuration parameters for the TerminateVnf operation
2513         required: false
2514       operate:
2515         type: tosca.datatypes.nfv.VnfOperateOperationConfiguration
2516         description: Configuration parameters for the OperateVnf operation
2517         required: false
2518       change_ext_connectivity:
2519         type: tosca.datatypes.nfv.VnfChangeExtConnectivityOperationConfiguration
2520         description: Configuration parameters for the changeExtVnfConnectivityOpConfig operation
2521         required: false
2522   tosca.datatypes.nfv.CpProtocolData:
2523     derived_from: tosca.datatypes.Root
2524     description: Describes and associates the protocol layer that a CP uses together with other protocol and connection point information
2525     properties:
2526       associated_layer_protocol:
2527         type: string
2528         required: true
2529         description: One of the values of the property layer_protocols of the CP
2530         constraints:
2531         - valid_values:
2532           - ethernet
2533           - mpls
2534           - odu2
2535           - ipv4
2536           - ipv6
2537           - pseudo-wire
2538       address_data:
2539         type: list
2540         description: Provides information on the addresses to be assigned to the CP
2541         entry_schema:
2542           type: tosca.datatypes.nfv.AddressData
2543         required: false
2544   tosca.datatypes.nfv.VnfAdditionalConfigurableProperties:
2545     derived_from: tosca.datatypes.Root
2546     description: is an empty base type for deriving data types for describing additional configurable properties for a given VNF
2547     properties:
2548       description:
2549         type: string
2550         required: false
2551   tosca.datatypes.nfv.VnfConfigurableProperties:
2552     derived_from: tosca.datatypes.Root
2553     description: indicates configuration properties for a given VNF (e.g. related to auto scaling and auto healing).
2554     properties:
2555       is_autoscale_enabled:
2556         type: boolean
2557         description: It permits to enable (TRUE)/disable (FALSE) the auto-scaling functionality. If the properties is not present for configuring, then VNF property is not supported
2558         required: false
2559       is_autoheal_enabled:
2560         type: boolean
2561         description: It permits to enable (TRUE)/disable (FALSE) the auto-healing functionality. If the properties is not present for configuring, then VNF property is not supported
2562         required: false
2563       additional_configurable_properties:
2564         description: It provides VNF specific configurable properties that can be modified using the ModifyVnfInfo operation
2565         required: false
2566         type: tosca.datatypes.nfv.VnfAdditionalConfigurableProperties
2567   tosca.datatypes.nfv.VnfInfoModifiableAttributesExtensions:
2568     derived_from: tosca.datatypes.Root
2569     description: is an empty base type for deriving data types for describing VNF-specific extension
2570     properties:
2571       description:
2572         type: string
2573         required: false
2574   tosca.datatypes.nfv.VnfInfoModifiableAttributesMetadata:
2575     derived_from: tosca.datatypes.Root
2576     description: is an empty base type for deriving data types for describing VNF-specific metadata
2577     properties:
2578       description:
2579         type: string
2580         required: false
2581   tosca.datatypes.nfv.VnfInfoModifiableAttributes:
2582     derived_from: tosca.datatypes.Root
2583     description: Describes VNF-specific extension and metadata for a given VNF
2584     properties:
2585       extensions:
2586         type: tosca.datatypes.nfv.VnfInfoModifiableAttributesExtensions
2587         description: \"Extension\" properties of VnfInfo that are writeable
2588         required: false
2589       metadata:
2590         type: tosca.datatypes.nfv.VnfInfoModifiableAttributesMetadata
2591         description: \"Metadata\" properties of VnfInfo that are writeable
2592         required: false
2593   tosca.datatypes.nfv.VirtualLinkBitrateLevel:
2594     derived_from: tosca.datatypes.Root
2595     description: Describes bitrate requirements applicable to the virtual link instantiated from a particicular VnfVirtualLink
2596     properties:
2597       description:
2598         type: string
2599         required: false
2600       bitrate_requirements:
2601         type: tosca.datatypes.nfv.LinkBitrateRequirements
2602         description: Virtual link bitrate requirements for an instantiation level or bitrate delta for a scaling step
2603         required: true
2604   tosca.datatypes.nfv.VnfOperationAdditionalParameters:
2605     derived_from: tosca.datatypes.Root
2606     description: Is an empty base type for deriving data type for describing VNF-specific parameters to be passed when invoking lifecycle management operations
2607     properties:
2608       description:
2609         type: string
2610         required: false
2611   tosca.datatypes.nfv.VirtualFileStorageData:
2612     derived_from: tosca.datatypes.Root
2613     description: VirtualFileStorageData describes file storage requirements associated with compute resources in a particular VDU
2614     properties:
2615       size_of_storage:
2616         type: scalar-unit.size
2617         description: Size of virtualized storage resource
2618         required: true
2619       file_system_protocol:
2620         type: string
2621         description: The shared file system protocol (e.g. NFS, CIFS)
2622         required: true
2623   tosca.datatypes.nfv.VirtualObjectStorageData:
2624     derived_from: tosca.datatypes.Root
2625     description: VirtualObjectStorageData describes object storage requirements associated with compute resources in a particular VDU
2626     properties:
2627       max_size_of_storage:
2628         type: scalar-unit.size
2629         description: Maximum size of virtualized storage resource
2630         required: false
2631   tosca.datatypes.nfv.VirtualBlockStorageData:
2632     derived_from: tosca.datatypes.Root
2633     description: VirtualBlockStorageData describes block storage requirements associated with compute resources in a particular VDU, either as a local disk or as virtual attached storage
2634     properties:
2635       size_of_storage:
2636         type: scalar-unit.size
2637         description: Size of virtualised storage resource
2638         required: true
2639       vdu_storage_requirements:
2640         type: map
2641         description: The hardware platform specific storage requirements. A map of strings that contains a set of key-value pairs that represents the hardware platform specific storage deployment requirements.
2642         required: false
2643         entry_schema:
2644           type: string
2645       rdma_enabled:
2646         type: boolean
2647         description: Indicates if the storage support RDMA
2648         required: false
2649         default: false
2650   tosca.datatypes.nfv.SwImageData:
2651     derived_from: tosca.datatypes.Root
2652     description: describes information  related to a software image artifact
2653     properties:
2654       name:
2655         type: string
2656         description: Name of this software image
2657         required: true
2658       version:
2659         type: string
2660         description: Version of this software image
2661         required: true
2662       checksum:
2663         type: string
2664         description: Checksum of the software image file
2665         required: true
2666       container_format:
2667         type: string
2668         description: The container format describes the container file format in which software image is provided
2669         required: true
2670         constraints:
2671         - valid_values:
2672           - aki
2673           - ami
2674           - ari
2675           - bare
2676           - docker
2677           - ova
2678           - ovf
2679       disk_format:
2680         type: string
2681         description: The disk format of a software image is the format of the underlying disk image
2682         required: true
2683         constraints:
2684         - valid_values:
2685           - aki
2686           - ami
2687           - ari
2688           - iso
2689           - qcow2
2690           - raw
2691           - vdi
2692           - vhd
2693           - vhdx
2694           - vmdk
2695       min_disk:
2696         type: scalar-unit.size
2697         description: The minimal disk size requirement for this software image
2698         required: true
2699       min_ram:
2700         type: scalar-unit.size
2701         description: The minimal RAM requirement for this software image
2702         required: false
2703       size:
2704         type: scalar-unit.size
2705         description: The size of this software image
2706         required: true
2707       operating_system:
2708         type: string
2709         description: Identifies the operating system used in the software image
2710         required: false
2711       supported_virtualisation_environments:
2712         type: list
2713         description: Identifies the virtualisation environments (e.g. hypervisor) compatible with this software image
2714         required: false
2715         entry_schema:
2716           type: string
2717   onap.datatypes.monitoring.metricsPerEventName:
2718     derived_from: tosca.datatypes.Root
2719     properties:
2720       controlLoopSchemaType:
2721         constraints:
2722         - valid_values:
2723           - VM
2724           - VNF
2725         description: Specifies Control Loop Schema Type for the event Name e.g. VNF, VM
2726         required: true
2727         type: string
2728       eventName:
2729         description: Event name to which thresholds need to be applied
2730         required: true
2731         type: string
2732       policyName:
2733         description: TCA Policy Scope Name
2734         required: true
2735         type: string
2736       policyScope:
2737         description: TCA Policy Scope
2738         required: true
2739         type: string
2740       policyVersion:
2741         description: TCA Policy Scope Version
2742         required: true
2743         type: string
2744       thresholds:
2745         description: Thresholds associated with eventName
2746         entry_schema:
2747           type: onap.datatypes.monitoring.thresholds
2748         required: true
2749         type: list
2750   onap.datatypes.monitoring.tca_policy:
2751     derived_from: tosca.datatypes.Root
2752     properties:
2753       domain:
2754         constraints:
2755         - equal: measurementsForVfScaling
2756         default: measurementsForVfScaling
2757         description: Domain name to which TCA needs to be applied
2758         required: true
2759         type: string
2760       metricsPerEventName:
2761         description: Contains eventName and threshold details that need to be applied to given eventName
2762         entry_schema:
2763           type: onap.datatypes.monitoring.metricsPerEventName
2764         required: true
2765         type: list
2766   onap.datatypes.monitoring.thresholds:
2767     derived_from: tosca.datatypes.Root
2768     properties:
2769       closedLoopControlName:
2770         description: Closed Loop Control Name associated with the threshold
2771         required: true
2772         type: string
2773       closedLoopEventStatus:
2774         constraints:
2775         - valid_values:
2776           - ONSET
2777           - ABATED
2778         description: Closed Loop Event Status of the threshold
2779         required: true
2780         type: string
2781       direction:
2782         constraints:
2783         - valid_values:
2784           - LESS
2785           - LESS_OR_EQUAL
2786           - GREATER
2787           - GREATER_OR_EQUAL
2788           - EQUAL
2789         description: Direction of the threshold
2790         required: true
2791         type: string
2792       fieldPath:
2793         constraints:
2794         - valid_values:
2795           - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedTotalPacketsDelta
2796           - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedOctetsDelta
2797           - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedUnicastPacketsDelta
2798           - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedMulticastPacketsDelta
2799           - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedBroadcastPacketsDelta
2800           - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedDiscardedPacketsDelta
2801           - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedErrorPacketsDelta
2802           - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedTotalPacketsAccumulated
2803           - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedOctetsAccumulated
2804           - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedUnicastPacketsAccumulated
2805           - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedMulticastPacketsAccumulated
2806           - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedBroadcastPacketsAccumulated
2807           - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedDiscardedPacketsAccumulated
2808           - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedErrorPacketsAccumulated
2809           - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedTotalPacketsDelta
2810           - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedOctetsDelta
2811           - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedUnicastPacketsDelta
2812           - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedMulticastPacketsDelta
2813           - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedBroadcastPacketsDelta
2814           - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedDiscardedPacketsDelta
2815           - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedErrorPacketsDelta
2816           - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedTotalPacketsAccumulated
2817           - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedOctetsAccumulated
2818           - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedUnicastPacketsAccumulated
2819           - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedMulticastPacketsAccumulated
2820           - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedBroadcastPacketsAccumulated
2821           - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedDiscardedPacketsAccumulated
2822           - $.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedErrorPacketsAccumulated
2823           - $.event.measurementsForVfScalingFields.cpuUsageArray[*].cpuIdle
2824           - $.event.measurementsForVfScalingFields.cpuUsageArray[*].cpuUsageInterrupt
2825           - $.event.measurementsForVfScalingFields.cpuUsageArray[*].cpuUsageNice
2826           - $.event.measurementsForVfScalingFields.cpuUsageArray[*].cpuUsageSoftIrq
2827           - $.event.measurementsForVfScalingFields.cpuUsageArray[*].cpuUsageSteal
2828           - $.event.measurementsForVfScalingFields.cpuUsageArray[*].cpuUsageSystem
2829           - $.event.measurementsForVfScalingFields.cpuUsageArray[*].cpuWait
2830           - $.event.measurementsForVfScalingFields.cpuUsageArray[*].percentUsage
2831           - $.event.measurementsForVfScalingFields.meanRequestLatency
2832           - $.event.measurementsForVfScalingFields.memoryUsageArray[*].memoryBuffered
2833           - $.event.measurementsForVfScalingFields.memoryUsageArray[*].memoryCached
2834           - $.event.measurementsForVfScalingFields.memoryUsageArray[*].memoryConfigured
2835           - $.event.measurementsForVfScalingFields.memoryUsageArray[*].memoryFree
2836           - $.event.measurementsForVfScalingFields.memoryUsageArray[*].memoryUsed
2837           - $.event.measurementsForVfScalingFields.additionalMeasurements[*].arrayOfFields[0].value
2838         description: Json field Path as per CEF message which needs to be analyzed for TCA
2839         required: true
2840         type: string
2841       severity:
2842         constraints:
2843         - valid_values:
2844           - CRITICAL
2845           - MAJOR
2846           - MINOR
2847           - WARNING
2848           - NORMAL
2849         description: Threshold Event Severity
2850         required: true
2851         type: string
2852       thresholdValue:
2853         description: Threshold value for the field Path inside CEF message
2854         required: true
2855         type: integer
2856       version:
2857         description: Version number associated with the threshold
2858         required: true
2859         type: string