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
6 # http://www.apache.org/licenses/LICENSE-2.0
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.
14 tosca_definitions_version: tosca_simple_yaml_1_1
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
38 description: The name of the policy
43 description: container type
51 org.openecomp.policies.placement.Colocate:
52 derived_from: tosca.policies.Placement
53 description: Keep associated nodes (groups of nodes) based upon affinity value
57 description: The name of the policy
70 org.openecomp.policies.placement.valet.Diversity:
71 derived_from: tosca.policies.Placement
72 description: Valet Diversity
76 description: diversity
84 org.openecomp.policies.placement.valet.Exclusivity:
85 derived_from: tosca.policies.Placement
86 description: Valet Exclusivity
90 description: exclusivity
98 org.openecomp.policies.placement.valet.Affinity:
99 derived_from: tosca.policies.Placement
100 description: Valet Affinity
104 description: affinity
112 org.openecomp.policies.scaling.Fixed:
113 derived_from: tosca.policies.Scaling
116 description: the exact number of instances to keep up
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")
125 description: The name of the server that exposes the policy with predefined type and name.
129 description: The type (category) of the policy same as it is defined in the source.
133 description: The name of the policy, that related to specific type, same as it is defined in the source.
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
144 description: TCA Policy JSON
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].
153 description: Describes the various levels of resources that can be used to instantiate the VNF using this flavour.
156 type: tosca.datatypes.nfv.InstantiationLevel
159 description: The default instantiation level for this flavour.
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]
167 description: Describes the Vdu.Compute levels of resources that can be used to instantiate the VNF using this flavour
170 type: tosca.datatypes.nfv.VduLevel
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].
179 description: Describes the virtual link levels of resources that can be used to instantiate the VNF using this flavour.
182 type: tosca.datatypes.nfv.VirtualLinkBitrateLevel
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].
191 description: Describe maximum scale level for total number of scaling steps that can be applied to a particular aspect
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].
201 description: Represents the scaling aspect to which this policy applies
205 description: Describes the Vdu.Compute scaling deltas to be applied for every scaling steps of a particular aspect.
208 type: tosca.datatypes.nfv.VduLevel
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].
217 description: Represents the scaling aspect to which this policy applies.
221 description: Describes the VnfVirtualLink scaling deltas to be applied for every scaling steps of a particular aspect.
224 type: tosca.datatypes.nfv.VirtualLinkBitrateLevel
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].
232 type: tosca.datatypes.nfv.VduLevel
233 description: Represents the initial minimum size of the VNF.
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].
242 type: tosca.datatypes.nfv.VirtualLinkBitrateLevel
243 description: Represents the initial minimum size of the VNF.
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].
253 description: Human readable description of the security group rule.
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.
266 description: Indicates the protocol carried over the Ethernet layer.
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.
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.
424 - greater_or_equal: 0
425 - less_or_equal: 65535
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.
432 - greater_or_equal: 0
433 - less_or_equal: 65535
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
444 description: Identifies an interface produced by the VNF.
451 type: tosca.datatypes.nfv.InterfaceDetails
452 description: Provide additional data to access the interface endpoint
455 - tosca.nodes.nfv.VnfExtCp
456 - tosca.nodes.nfv.VduCp
458 tosca.datatypes.Root:
459 description: The TOSCA root Data Type all other TOSCA base Data Types derive from
461 derived_from: tosca.datatypes.Root
463 derived_from: tosca.datatypes.Root
465 derived_from: tosca.datatypes.Root
467 derived_from: tosca.datatypes.Root
469 derived_from: tosca.datatypes.Root
471 derived_from: tosca.datatypes.Root
473 derived_from: tosca.datatypes.Root
475 derived_from: tosca.datatypes.Root
477 derived_from: scalar-unit
479 derived_from: scalar-unit
480 scalar-unit.frequency:
481 derived_from: scalar-unit
482 tosca.datatypes.Credential:
483 derived_from: tosca.datatypes.Root
501 org.openecomp.datatypes.PortMirroringConnectionPointDescription:
502 derived_from: tosca.datatypes.Root
514 description: deprecated
517 description: deprecated
518 tosca.datatypes.TimeInterval:
519 derived_from: tosca.datatypes.Root
527 tosca.datatypes.network.NetworkInfo:
528 derived_from: tosca.datatypes.Root
538 tosca.datatypes.network.PortInfo:
539 derived_from: tosca.datatypes.Root
553 tosca.datatypes.network.PortDef:
554 derived_from: integer
559 tosca.datatypes.network.PortSpec:
560 derived_from: tosca.datatypes.Root
572 type: tosca.datatypes.network.PortDef
580 type: tosca.datatypes.network.PortDef
587 org.openecomp.datatypes.heat.network.AddressPair:
588 derived_from: tosca.datatypes.Root
589 description: MAC/IP address pairs
593 description: MAC address
598 description: IP address
601 org.openecomp.datatypes.heat.network.subnet.HostRoute:
602 derived_from: tosca.datatypes.Root
603 description: Host route info for the subnet
607 description: The destination for static route
612 description: The next hop for the destination
615 org.openecomp.datatypes.heat.network.AllocationPool:
616 derived_from: tosca.datatypes.Root
617 description: The start and end addresses for the allocation pool
621 description: Start address for the allocation pool
626 description: End address for the allocation pool
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
635 description: The ID of the tenant who owns the network
640 description: Set to true if DHCP is enabled and false if DHCP is disabled
646 description: IPv6 address mode
656 description: IPv6 RA (Router Advertisement) mode
666 description: Extra parameters to include in the request
674 description: The start and end addresses for the allocation pools
678 type: org.openecomp.datatypes.heat.network.AllocationPool
681 description: The name or ID of the subnet pool
686 description: A specified set of DNS name servers to be used
694 description: The gateway IP address
698 type: org.openecomp.datatypes.heat.network.subnet.HostRoute
701 description: The gateway IP address
711 description: The name of the subnet
716 description: Prefix length for subnet allocation from subnet pool
720 - greater_or_equal: 0
723 description: The CIDR
728 description: The gateway IP address
731 org.openecomp.datatypes.heat.novaServer.network.PortExtraProperties:
732 derived_from: tosca.datatypes.Root
733 description: Nova server network expand properties for port
735 port_security_enabled:
737 description: Flag to enable/disable port security on the port
742 description: MAC address to give to this port
747 description: The administrative state of this port
753 description: The name or ID of QoS policy to attach to this port
756 allowed_address_pairs:
758 description: Additional MAC/IP address pairs allowed to pass through the port
762 type: org.openecomp.datatypes.heat.network.AddressPair
765 description: The vnic type to be bound on the neutron port
775 description: Extra parameters to include in the request
781 org.openecomp.datatypes.heat.novaServer.network.AddressInfo:
782 derived_from: tosca.datatypes.network.NetworkInfo
783 description: Network addresses with corresponding port id
790 org.openecomp.datatypes.heat.neutron.port.FixedIps:
791 derived_from: tosca.datatypes.Root
792 description: subnet/ip_address
796 description: Subnet in which to allocate the IP address for this port
801 description: IP address desired in the subnet for this port
806 description: Subnet in which to allocate the IP address for this port
809 org.openecomp.datatypes.heat.FileInfo:
810 derived_from: tosca.datatypes.Root
811 description: Heat File Info
815 description: The required URI string (relative or absolute) which can be used to locate the file
820 description: The type of the file
829 org.openecomp.datatypes.heat.contrail.network.rule.PortPairs:
830 derived_from: tosca.datatypes.Root
831 description: source and destination port pairs
835 description: Start port
840 description: End port
843 org.openecomp.datatypes.heat.contrail.network.rule.Rule:
844 derived_from: tosca.datatypes.Root
845 description: policy rule
849 description: Source ports
853 type: org.openecomp.datatypes.heat.contrail.network.rule.PortPairs
856 description: Protocol
861 description: Destination addresses
865 type: org.openecomp.datatypes.heat.contrail.network.rule.VirtualNetwork
868 description: Service to apply
873 description: Destination ports
877 type: org.openecomp.datatypes.heat.contrail.network.rule.PortPairs
880 description: Source addresses
884 type: org.openecomp.datatypes.heat.contrail.network.rule.VirtualNetwork
887 description: Direction
890 org.openecomp.datatypes.heat.contrail.network.rule.RuleList:
891 derived_from: tosca.datatypes.Root
892 description: list of policy rules
896 description: Contrail network rule
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
907 description: Virtual network
910 org.openecomp.datatypes.heat.network.neutron.SecurityRules.Rule:
911 derived_from: tosca.datatypes.Root
912 description: Rules Pairs
916 description: The remote group ID to be associated with this security group rule
921 description: The protocol that is matched by the security group rule
931 description: Ethertype of the traffic
941 description: 'The maximum port number in the range that is matched by the
942 security group rule. '
951 description: The remote IP prefix (CIDR) to be associated with this security group rule
956 description: Whether to specify a remote group or a remote IP prefix
958 default: remote_ip_prefix
966 description: The direction in which the security group rule is applied
976 description: The minimum port number in the range that is matched by the security group rule.
983 org.openecomp.datatypes.heat.substitution.SubstitutionFiltering:
984 derived_from: tosca.datatypes.Root
985 description: Substitution Filter
987 substitute_service_template:
989 description: Substitute Service Template
994 description: Index value of the substitution service template runtime instance
999 - greater_or_equal: 0
1008 description: Indicates whether service scaling is enabled
1014 description: Mandatory
1018 org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.RefDataSequence:
1019 derived_from: tosca.datatypes.Root
1020 description: network policy refs data sequence
1022 network_policy_refs_data_sequence_major:
1024 description: Network Policy ref data sequence Major
1027 network_policy_refs_data_sequence_minor:
1029 description: Network Policy ref data sequence Minor
1032 org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.RefData:
1033 derived_from: tosca.datatypes.Root
1034 description: network policy refs data
1036 network_policy_refs_data_sequence:
1037 type: org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.RefDataSequence
1038 description: Network Policy ref data sequence
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
1045 network_ipam_refs_data_ipam_subnets_subnet_ip_prefix_len:
1047 description: Network ipam refs data ipam subnets ip prefix len
1050 network_ipam_refs_data_ipam_subnets_subnet_ip_prefix:
1052 description: Network ipam refs data ipam subnets ip prefix
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
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
1064 network_ipam_refs_data_ipam_subnets_addr_from_start:
1066 description: Network ipam refs data ipam subnets addr from start
1069 org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.IpamRefData:
1070 derived_from: tosca.datatypes.Root
1071 description: Network Ipam Ref Data
1073 network_ipam_refs_data_ipam_subnets:
1075 description: Network ipam refs data ipam subnets
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
1084 network_policy_entries_policy_rule_src_addresses_virtual_network:
1086 description: Source addresses Virtual network
1089 org.openecomp.datatypes.heat.contrailV2.network.rule.DstVirtualNetwork:
1090 derived_from: tosca.datatypes.Root
1091 description: destination addresses
1093 network_policy_entries_policy_rule_dst_addresses_virtual_network:
1095 description: Destination addresses Virtual network
1098 org.openecomp.datatypes.heat.contrailV2.network.rule.DstPortPairs:
1099 derived_from: tosca.datatypes.Root
1100 description: destination port pairs
1102 network_policy_entries_policy_rule_dst_ports_start_port:
1104 description: Start port
1107 network_policy_entries_policy_rule_dst_ports_end_port:
1109 description: End port
1112 org.openecomp.datatypes.heat.contrailV2.network.rule.SrcPortPairs:
1113 derived_from: tosca.datatypes.Root
1114 description: source port pairs
1116 network_policy_entries_policy_rule_src_ports_start_port:
1118 description: Start port
1121 network_policy_entries_policy_rule_src_ports_end_port:
1123 description: End port
1126 org.openecomp.datatypes.heat.contrailV2.network.rule.ActionList:
1127 derived_from: tosca.datatypes.Root
1128 description: Action List
1130 network_policy_entries_policy_rule_action_list_simple_action:
1132 description: Simple Action
1135 network_policy_entries_policy_rule_action_list_apply_service:
1137 description: Apply Service
1142 org.openecomp.datatypes.heat.contrailV2.network.rule.Rule:
1143 derived_from: tosca.datatypes.Root
1144 description: policy rule
1146 network_policy_entries_policy_rule_dst_addresses:
1148 description: Destination addresses
1152 type: org.openecomp.datatypes.heat.contrailV2.network.rule.DstVirtualNetwork
1153 network_policy_entries_policy_rule_dst_ports:
1155 description: Destination ports
1159 type: org.openecomp.datatypes.heat.contrailV2.network.rule.DstPortPairs
1160 network_policy_entries_policy_rule_protocol:
1162 description: Protocol
1165 network_policy_entries_policy_rule_src_addresses:
1167 description: Source addresses
1171 type: org.openecomp.datatypes.heat.contrailV2.network.rule.SrcVirtualNetwork
1172 network_policy_entries_policy_rule_direction:
1174 description: Direction
1177 network_policy_entries_policy_rule_src_ports:
1179 description: Source ports
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
1189 org.openecomp.datatypes.heat.contrailV2.network.rule.RuleList:
1190 derived_from: tosca.datatypes.Root
1191 description: list of policy rules
1193 network_policy_entries_policy_rule:
1195 description: Contrail network rule
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
1206 description: Route prefix
1211 description: Next hop
1216 description: Next hop type
1219 org.openecomp.datatypes.heat.network.contrail.AddressPair:
1220 derived_from: tosca.datatypes.Root
1221 description: Address Pair
1225 description: Address mode active-active or active-standy
1234 description: IP address prefix
1239 description: Mac address
1242 org.openecomp.datatypes.heat.network.contrail.InterfaceData:
1243 derived_from: tosca.datatypes.Root
1244 description: Interface Data
1248 description: An ordered list of static routes to be added to this interface
1252 type: org.openecomp.datatypes.heat.network.contrail.port.StaticRoute
1255 description: Virtual Network for this interface
1258 allowed_address_pairs:
1260 description: List of allowed address pair for this interface
1264 type: org.openecomp.datatypes.heat.network.contrail.AddressPair
1267 description: IP for this interface
1270 org.openecomp.datatypes.heat.contrailV2.virtual.machine.interface.Properties:
1271 derived_from: tosca.datatypes.Root
1272 description: Virtual Machine Interface Properties.
1274 virtual_machine_interface_properties_service_interface_type:
1276 description: Service Interface Type.
1279 org.openecomp.datatypes.Root:
1280 derived_from: tosca.datatypes.Root
1282 The ECOMP root Data Type all other Data Types derive from
1288 A placeholder for missing properties that would be included in future ecomp model versions. fromat <key>:<value>
1290 org.openecomp.datatypes.AssignmentRequirements:
1291 derived_from: org.openecomp.datatypes.Root
1295 "true" indicates that assignment is required
1300 description: number of assignments required
1303 org.openecomp.datatypes.network.SubnetAssignments:
1304 derived_from: org.openecomp.datatypes.Root
1306 ip_network_address_plan:
1309 description: Reference to EIPAM, VLAN or other address plan ID used to assign subnets to this network
1313 description: \"true\" indicates the network has 1 or more policies
1321 description: The IP version of the subnet
1325 description: The default subnet CIDR mask
1330 description: Quantity of subnets that must be initially assigned
1331 org.openecomp.datatypes.network.IPv4SubnetAssignments:
1332 derived_from: org.openecomp.datatypes.network.SubnetAssignments
1337 description: Indicates IPv4 subnet assignments
1338 org.openecomp.datatypes.network.IPv6SubnetAssignments:
1339 derived_from: org.openecomp.datatypes.network.SubnetAssignments
1344 description: Indicates IPv6 subnet assignments
1345 org.openecomp.datatypes.network.NetworkAssignments:
1346 derived_from: org.openecomp.datatypes.Root
1348 ecomp_generated_network_assignment:
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).
1357 description: \"true\" means this network is shared by multiple Openstack tenants
1358 is_external_network:
1363 \"true\" means this Contrail external network
1364 ipv4_subnet_default_assignment:
1365 type: org.openecomp.datatypes.network.IPv4SubnetAssignments
1367 description: IPv4 defualt subnet assignments
1368 ipv6_subnet_default_assignment:
1369 type: org.openecomp.datatypes.network.IPv6SubnetAssignments
1371 description: IPv6 defualt subnet assignments
1375 description: Related Networks List.
1377 type: org.openecomp.datatypes.network.RelatedNetworksAssignments
1381 description: \"true\" indicates that network is trunked
1383 org.openecomp.datatypes.network.ProviderNetwork:
1384 derived_from: org.openecomp.datatypes.Root
1386 is_provider_network:
1389 description: \"true\" indicates that this a Neutron provider type of network
1390 physical_network_name:
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)
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)
1418 description: PNIC instance within the NUMA processor cluster
1419 org.openecomp.datatypes.network.NetworkFlows:
1420 derived_from: org.openecomp.datatypes.Root
1426 description: \"true\" indicates the network has 1 or more policies
1430 description: 'Identifies the specific Cloud network policy that must be applied
1431 to this network (source: from Policy Manager).'
1436 description: \"true\" indicates the network has 1 or more vpn bindings
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
1448 description: reference to a vlan range plan
1456 description: identifies the vlan type (e.g., c-tag)
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
1472 description: identifies the number of ip address to assign to the CP from the plan
1492 description: identifies the number of ip address to assign to the CP from the plan
1493 type: org.openecomp.datatypes.AssignmentRequirements
1495 floating_ip_count_required:
1496 type: org.openecomp.datatypes.AssignmentRequirements
1498 ip_address_plan_name:
1504 org.openecomp.datatypes.network.MacAssignments:
1505 derived_from: org.openecomp.datatypes.Root
1510 description: reference to a MAC address range plan
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
1518 ecomp_selected_instance_node_target:
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).
1527 description: Referenc to a service level homing policy that ECOMP will use for instance deployment target node
1528 instance_node_target:
1531 description: Instance target deployment node
1532 org.openecomp.datatypes.EcompNaming:
1533 derived_from: org.openecomp.datatypes.Root
1535 ecomp_generated_naming:
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).
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
1549 description: reference to a MAC address range plan
1553 description: identifies the number of MAC addresses to assign to the CP from the plan
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.
1565 description: IP Prefix.
1570 description: IP Prefix Len.
1573 org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.MacAddress:
1574 derived_from: tosca.datatypes.Root
1575 description: Virtual Machine Sub Interface Mac Address.
1579 description: Mac Addresses List.
1584 org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.Properties:
1585 derived_from: tosca.datatypes.Root
1586 description: Virtual Machine Sub Interface VLAN Properties.
1588 sub_interface_vlan_tag:
1590 description: Sub Interface VLAN Tag.
1593 org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPair:
1594 derived_from: tosca.datatypes.Root
1595 description: Virtual Machine Sub Interface Address Pair.
1599 description: Address Mode.
1603 type: org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPairIp
1612 org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPairs:
1613 derived_from: tosca.datatypes.Root
1614 description: Virtual Machine Sub Interface Address Pairs.
1616 allowed_address_pair:
1618 description: Addresses pair List.
1622 type: org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPair
1623 org.openecomp.datatypes.Naming:
1624 derived_from: org.openecomp.datatypes.Root
1626 ecomp_generated_naming:
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).
1633 description: Reference to naming policy that ECOMP will use when the name is auto-generated
1637 description: indicates operator-supplied name required (e.g. VID will present prompt to operator and collect the operator-supplied instance name).
1640 org.openecomp.datatypes.flavors.ComputeFlavor:
1641 derived_from: tosca.datatypes.Root
1646 type: scalar-unit.size
1648 type: scalar-unit.size
1649 org.openecomp.datatypes.flavors.LicenseFlavor:
1650 derived_from: tosca.datatypes.Root
1654 org.openecomp.datatypes.flavors.VendorInfo:
1655 derived_from: tosca.datatypes.Root
1657 manufacturer_reference_number:
1661 org.openecomp.datatypes.flavors.DeploymentFlavor:
1662 derived_from: tosca.datatypes.Root
1667 type: org.openecomp.datatypes.flavors.VendorInfo
1669 type: org.openecomp.datatypes.flavors.ComputeFlavor
1671 type: org.openecomp.datatypes.flavors.LicenseFlavor
1673 org.openecomp.datatypes.ImageInfo:
1674 derived_from: tosca.datatypes.Root
1682 description: checksum/signature
1687 org.openecomp.datatypes.network.RelatedNetworksAssignments:
1688 derived_from: org.openecomp.datatypes.Root
1690 related_network_role:
1692 description: The network role of the related network, sharing provider network.
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.
1701 tosca.datatypes.nfv.VnfcConfigurableProperties:
1702 derived_from: tosca.datatypes.Root
1703 description: Defines the configurable properties of a VNFC
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
1709 tosca.datatypes.nfv.RequestedAdditionalCapability:
1710 derived_from: tosca.datatypes.Root
1711 description: describes requested additional capability for a particular VDU
1713 requested_additional_capability_name:
1715 description: Identifies a requested additional capability for the VDU.
1719 description: Indicates whether the requested additional capability is mandatory for successful operation.
1721 min_requested_additional_capability_version:
1723 description: Identifies the minimum version of the requested additional capability.
1725 preferred_requested_additional_capability_version:
1727 description: Identifies the preferred version of the requested additional capability.
1729 target_performance_parameters:
1731 description: Identifies specific attributes, dependent on the requested additional capability type.
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
1740 type: scalar-unit.size
1741 description: Amount of virtual memory.
1743 virtual_mem_oversubscription_policy:
1745 description: The memory core oversubscription policy in terms of virtual memory to physical memory on the platform.
1747 vdu_mem_requirements:
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.
1755 description: It specifies the memory allocation to be cognisant of the relevant process/core allocation.
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
1762 virtual_cpu_pinning_policy:
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.'
1774 virtual_cpu_pinning_rule:
1776 description: Provides the list of rules for allocating virtual CPU cores to logical CPU cores/threads
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
1786 description: CPU architecture type. Examples are x86, ARM
1790 description: Number of virtual CPUs
1795 type: scalar-unit.frequency
1796 description: Minimum virtual CPU clock rate
1798 virtual_cpu_oversubscription_policy:
1800 description: CPU core oversubscription policy e.g. the relation of virtual CPU cores to physical CPU cores/threads.
1802 vdu_cpu_requirements:
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.
1808 virtual_cpu_pinning:
1809 type: tosca.datatypes.nfv.VirtualCpuPinning
1810 description: The virtual CPU pinning configuration for the virtualised compute resource.
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.
1816 logical_node_requirements:
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.
1822 tosca.datatypes.nfv.VirtualNetworkInterfaceRequirements:
1823 derived_from: tosca.datatypes.Root
1824 description: Describes requirements on a virtual network interface
1828 description: Provides a human readable name for the requirement.
1832 description: Provides a human readable description of the requirement.
1836 description: Indicates whether fulfilling the constraint is mandatory (TRUE) for successful operation or desirable (FALSE).
1838 network_interface_requirements:
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.
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.
1848 tosca.datatypes.nfv.injectFile:
1849 derived_from: tosca.datatypes.Root
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.
1861 mac_address_assignment:
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
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
1869 ip_address_assignment:
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
1873 floating_ip_activated:
1875 description: Specifies if the floating IP scheme is activated on the Connection Point or not
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
1885 number_of_ip_address:
1887 description: Minimum number of IP addresses to be assigned
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
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
1909 type: tosca.datatypes.nfv.L2AddressData
1910 description: Provides the information on the MAC addresses to be assigned to a connection point.
1913 type: tosca.datatypes.nfv.L3AddressData
1914 description: Provides the information on the IP addresses to be assigned to a connection point
1916 tosca.datatypes.nfv.ConnectivityType:
1917 derived_from: tosca.datatypes.Root
1918 description: describes additional connectivity information of a virtualLink
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.
1936 description: Identifies the flow pattern of the connectivity
1943 tosca.datatypes.nfv.VlFlavour:
1944 derived_from: tosca.datatypes.Root
1948 tosca.datatypes.nfv.ext.AddressPairs:
1956 tosca.datatypes.nfv.ext.FloatingIP:
1964 tosca.datatypes.nfv.ext.LocationInfo:
1975 tosca.datatypes.nfv.ext.HostRouteInfo:
1983 tosca.datatypes.nfv.ext.InjectData:
1991 tosca.datatypes.nfv.ext.zte.WatchDog:
1999 tosca.datatypes.nfv.ext.LocalAffinityOrAntiAffinityRule:
2004 affinity_antiaffinity:
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.
2011 min_number_of_instances:
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.
2016 - greater_or_equal: 0
2017 max_number_of_instances:
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.
2022 - greater_or_equal: 0
2029 tosca.datatypes.nfv.LinkBitrateRequirements:
2030 derived_from: tosca.datatypes.Root
2031 description: describes the requirements in terms of bitrate for a virtual link
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).
2038 - greater_or_equal: 0
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).
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
2050 type: scalar-unit.time
2051 description: Specifies the maximum latency
2055 packet_delay_variation:
2056 type: scalar-unit.time
2057 description: Specifies the maximum jitter
2060 - greater_or_equal: 0 s
2063 description: Specifies the maximum packet loss ratio
2069 tosca.datatypes.nfv.IpAllocationPool:
2070 derived_from: tosca.datatypes.Root
2071 description: Specifies a range of IP addresses
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
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
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.
2087 description: Identifies the network name associated with this L2 protocol.
2091 description: Specifies the network type for this L2 protocol.The value may be overridden at run-time.
2101 description: Specifies whether to support VLAN transparency for this L2 protocol or not.
2106 description: Specifies the maximum transmission unit (MTU) value for this L2 protocol.
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.
2122 description: Identifies the network name associated with this L3 protocol.
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.
2134 description: Specifies the CIDR (Classless Inter-Domain Routing) of this L3 protocol. The value may be overridden at run-time.
2136 ip_allocation_pools:
2138 description: Specifies the allocation pools with start and end IP addresses for this L3 protocol. The value may be overridden at run-time.
2141 type: tosca.datatypes.nfv.IpAllocationPool
2144 description: Specifies the gateway IP address for this L3 protocol. The value may be overridden at run-time.
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.
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.
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
2163 associated_layer_protocol:
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.
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.
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.
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.
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.
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.
2196 type: tosca.datatypes.nfv.Qos
2197 description: Specifies the QoS requirements of a VL instantiated according to this profile.
2199 virtual_link_protocol_data:
2201 description: Specifies the protocol data for a virtual link.
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
2209 number_of_instances:
2211 description: Number of instances of VNFC based on this VDU to deploy for this level.
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
2221 description: The scale level for a particular aspect
2224 - greater_or_equal: 0
2225 tosca.datatypes.nfv.ScalingAspect:
2226 derived_from: tosca.datatypes.Root
2238 - greater_or_equal: 0
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
2250 description: Human readable description of the level
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.
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.
2265 tosca.datatypes.nfv.VnfScaleOperationConfiguration:
2266 derived_from: tosca.datatypes.Root
2267 description: Represents information that affect the invocation of the ScaleVnf operation
2269 scaling_by_more_than_one_step_supported:
2271 description: Signals whether passing a value larger than one in the numScalingSteps parameter of the ScaleVnf operation is supported by this VNF.
2274 tosca.datatypes.nfv.VnfScaleToLevelOperationConfiguration:
2275 derived_from: tosca.datatypes.Root
2276 description: represents information that affect the invocation of the ScaleVnfToLevel operation
2278 arbitrary_target_levels_supported:
2280 description: Signals whether scaling according to the parameter "scaleInfo" is supported by this VNF
2282 tosca.datatypes.nfv.VnfHealOperationConfiguration:
2283 derived_from: tosca.datatypes.Root
2284 description: represents information that affect the invocation of the HealVnf operation
2288 description: Supported "cause" parameter values
2292 tosca.datatypes.nfv.VnfTerminateOperationConfiguration:
2293 derived_from: tosca.datatypes.Root
2294 description: represents information that affect the invocation of the TerminateVnf
2296 min_graceful_termination_timeout:
2297 type: scalar-unit.time
2298 description: Minimum timeout value for graceful termination of a VNF instance
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
2304 tosca.datatypes.nfv.VnfOperateOperationConfiguration:
2305 derived_from: tosca.datatypes.Root
2306 description: represents information that affect the invocation of the OperateVnf operation
2308 min_graceful_stop_timeout:
2309 type: scalar-unit.time
2310 description: Minimum timeout value for graceful stop of a VNF instance
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
2316 tosca.datatypes.nfv.VnfChangeFlavourOperationConfiguration:
2317 derived_from: tosca.datatypes.Root
2318 description: represents information that affect the invocation of the ChangeVnfFlavour operation
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.
2327 instantiation_level:
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.
2331 min_number_of_instances:
2333 description: Minimum number of instances of the VNF based on this VNFD that is permitted to exist for this VnfProfile.
2336 - greater_or_equal: 0
2337 max_number_of_instances:
2339 description: Maximum number of instances of the VNF based on this VNFD that is permitted to exist for this VnfProfile.
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]
2349 description: user_info field of the authority component of a URI
2353 description: host field of the authority component of a URI
2357 description: port field of the authority component of a URI
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].
2365 description: scheme component of a URI.
2368 type: tosca.datatypes.nfv.UriAuthority
2369 description: Authority component of a URI
2373 description: path component of a URI.
2377 description: query component of a URI.
2381 description: fragment component of a URI.
2383 tosca.datatypes.nfv.InterfaceDetails:
2384 derived_from: tosca.datatypes.Root
2385 description: information used to access an interface exposed by a VNF
2388 type: tosca.datatypes.nfv.UriComponents
2389 description: Provides components to build a Uniform Ressource Identifier (URI) where to access the interface end point.
2391 interface_specific_data:
2393 description: Provides additional details that are specific to the type of interface considered.
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.
2403 description: Human readable name of the monitoring parameter
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.
2411 - packet_outgoing_virtual_link
2412 - packet_incoming_virtual_link
2414 type: scalar-unit.time
2415 description: Describes the recommended periodicity at which to collect the performance information.
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.
2425 description: Human readable name of the monitoring parameter
2429 description: Identifies the performance metric, according to ETSI GS NFV-IFA 027.
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
2444 type: scalar-unit.time
2445 description: Describes the recommended periodicity at which to collect the performance information.
2449 tosca.datatypes.nfv.VnfChangeExtConnectivityOperationConfiguration:
2450 derived_from: tosca.datatypes.Root
2451 description: represents information that affect the invocation of the ChangeExtVnfConnectivity operation
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.
2462 description: Human readable name of the monitoring parameter
2466 description: Identifies the performance metric, according to ETSI GS NFV-IFA 027.
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
2481 type: scalar-unit.time
2482 description: Describes the recommended periodicity at which to collect the performance information.
2486 tosca.datatypes.nfv.VnfLcmOperationsConfiguration:
2487 derived_from: tosca.datatypes.Root
2488 description: Represents information to configure lifecycle management operations
2491 type: tosca.datatypes.nfv.VnfInstantiateOperationConfiguration
2492 description: Configuration parameters for the InstantiateVnf operation
2495 type: tosca.datatypes.nfv.VnfScaleOperationConfiguration
2496 description: Configuration parameters for the ScaleVnf operation
2499 type: tosca.datatypes.nfv.VnfScaleToLevelOperationConfiguration
2500 description: Configuration parameters for the ScaleVnfToLevel operation
2503 type: tosca.datatypes.nfv.VnfChangeFlavourOperationConfiguration
2504 description: Configuration parameters for the changeVnfFlavourOpConfig operation
2507 type: tosca.datatypes.nfv.VnfHealOperationConfiguration
2508 description: Configuration parameters for the HealVnf operation
2511 type: tosca.datatypes.nfv.VnfTerminateOperationConfiguration
2512 description: Configuration parameters for the TerminateVnf operation
2515 type: tosca.datatypes.nfv.VnfOperateOperationConfiguration
2516 description: Configuration parameters for the OperateVnf operation
2518 change_ext_connectivity:
2519 type: tosca.datatypes.nfv.VnfChangeExtConnectivityOperationConfiguration
2520 description: Configuration parameters for the changeExtVnfConnectivityOpConfig operation
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
2526 associated_layer_protocol:
2529 description: One of the values of the property layer_protocols of the CP
2540 description: Provides information on the addresses to be assigned to the CP
2542 type: tosca.datatypes.nfv.AddressData
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
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).
2555 is_autoscale_enabled:
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
2559 is_autoheal_enabled:
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
2563 additional_configurable_properties:
2564 description: It provides VNF specific configurable properties that can be modified using the ModifyVnfInfo operation
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
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
2581 tosca.datatypes.nfv.VnfInfoModifiableAttributes:
2582 derived_from: tosca.datatypes.Root
2583 description: Describes VNF-specific extension and metadata for a given VNF
2586 type: tosca.datatypes.nfv.VnfInfoModifiableAttributesExtensions
2587 description: \"Extension\" properties of VnfInfo that are writeable
2590 type: tosca.datatypes.nfv.VnfInfoModifiableAttributesMetadata
2591 description: \"Metadata\" properties of VnfInfo that are writeable
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
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
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
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
2616 type: scalar-unit.size
2617 description: Size of virtualized storage resource
2619 file_system_protocol:
2621 description: The shared file system protocol (e.g. NFS, CIFS)
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
2627 max_size_of_storage:
2628 type: scalar-unit.size
2629 description: Maximum size of virtualized storage resource
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
2636 type: scalar-unit.size
2637 description: Size of virtualised storage resource
2639 vdu_storage_requirements:
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.
2647 description: Indicates if the storage support RDMA
2650 tosca.datatypes.nfv.SwImageData:
2651 derived_from: tosca.datatypes.Root
2652 description: describes information related to a software image artifact
2656 description: Name of this software image
2660 description: Version of this software image
2664 description: Checksum of the software image file
2668 description: The container format describes the container file format in which software image is provided
2681 description: The disk format of a software image is the format of the underlying disk image
2696 type: scalar-unit.size
2697 description: The minimal disk size requirement for this software image
2700 type: scalar-unit.size
2701 description: The minimal RAM requirement for this software image
2704 type: scalar-unit.size
2705 description: The size of this software image
2709 description: Identifies the operating system used in the software image
2711 supported_virtualisation_environments:
2713 description: Identifies the virtualisation environments (e.g. hypervisor) compatible with this software image
2717 onap.datatypes.monitoring.metricsPerEventName:
2718 derived_from: tosca.datatypes.Root
2720 controlLoopSchemaType:
2725 description: Specifies Control Loop Schema Type for the event Name e.g. VNF, VM
2729 description: Event name to which thresholds need to be applied
2733 description: TCA Policy Scope Name
2737 description: TCA Policy Scope
2741 description: TCA Policy Scope Version
2745 description: Thresholds associated with eventName
2747 type: onap.datatypes.monitoring.thresholds
2750 onap.datatypes.monitoring.tca_policy:
2751 derived_from: tosca.datatypes.Root
2755 - equal: measurementsForVfScaling
2756 default: measurementsForVfScaling
2757 description: Domain name to which TCA needs to be applied
2760 metricsPerEventName:
2761 description: Contains eventName and threshold details that need to be applied to given eventName
2763 type: onap.datatypes.monitoring.metricsPerEventName
2766 onap.datatypes.monitoring.thresholds:
2767 derived_from: tosca.datatypes.Root
2769 closedLoopControlName:
2770 description: Closed Loop Control Name associated with the threshold
2773 closedLoopEventStatus:
2778 description: Closed Loop Event Status of the threshold
2789 description: Direction of the threshold
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
2849 description: Threshold Event Severity
2853 description: Threshold value for the field Path inside CEF message
2857 description: Version number associated with the threshold