1 # Licensed to the Apache Software Foundation (ASF) under one or more
2 # contributor license agreements. See the NOTICE file distributed with
3 # this work for additional information regarding copyright ownership.
4 # The ASF licenses this file to You under the Apache License, Version 2.0
5 # (the "License"); you may not use this file except in compliance with
6 # the License. You may obtain a copy of the License at
8 # http://www.apache.org/licenses/LICENSE-2.0
10 # Unless required by applicable law or agreed to in writing, software
11 # distributed under the License is distributed on an "AS IS" BASIS,
12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 # See the License for the specific language governing permissions and
14 # limitations under the License.
18 tosca.datatypes.nfv.L2AddressData:
21 shorthand_name: L2AddressData
22 type_qualified_name: tosca:L2AddressData
23 specification: tosca-simple-nfv-1.0
24 specification_section: 5.3.1
25 specification_url: 'http://docs.oasis-open.org/tosca/tosca-nfv/v1.0/csd04/tosca-nfv-v1.0-csd04.html#_Toc482896055'
27 tosca.datatypes.nfv.L3AddressData:
29 shorthand_name: L3AddressData
30 type_qualified_name: tosca:L3AddressData
31 specification: tosca-simple-nfv-1.0
32 specification_section: 5.3.2
33 specification_url: 'http://docs.oasis-open.org/tosca/tosca-nfv/v1.0/csd04/tosca-nfv-v1.0-csd04.html#_Toc482896056'
35 The L3AddressData type is a complex TOSCA data type used to describe L3AddressData information
36 element as defined in [ETSI GS NFV-IFA 011], it provides the information on the IP addresses
37 to be assigned to the connection point instantiated from the parent Connection Point
39 derived_from: tosca.datatypes.Root
41 ip_address_assignment:
43 Specify if the address assignment is the responsibility of management and orchestration
44 function or not. If it is set to True, it is the management and orchestration function
48 floating_ip_activated:
49 description: Specify if the floating IP scheme is activated on the Connection Point or not.
54 Define address type. The address type should be aligned with the address type supported by
55 the layer_protocol properties of the parent VnfExtCpd.
59 - valid_values: [ ipv4, ipv6 ]
62 Minimum number of IP addresses to be assigned.
66 tosca.datatypes.nfv.AddressData:
68 shorthand_name: AddressData
69 type_qualified_name: tosca:AddressData
70 specification: tosca-simple-nfv-1.0
71 specification_section: 5.3.3
72 specification_url: 'http://docs.oasis-open.org/tosca/tosca-nfv/v1.0/csd04/tosca-nfv-v1.0-csd04.html#_Toc482896057'
74 The AddressData type is a complex TOSCA data type used to describe AddressData information
75 element as defined in [ETSI GS NFV-IFA 011], it provides information on the addresses to be
76 assigned to the connection point(s) instantiated from a Connection Point Descriptor.
77 derived_from: tosca.datatypes.Root
81 Describes the type of the address to be assigned to the connection point instantiated from
82 the parent Connection Point Descriptor. The content type shall be aligned with the address
83 type supported by the layerProtocol property of the parent Connection Point Descriptor.
87 - valid_values: [ mac_address, ip_address ]
89 # Shall be present when the addressType is mac_address.
91 Provides the information on the MAC addresses to be assigned to the connection point(s)
92 instantiated from the parent Connection Point Descriptor.
93 type: tosca.datatypes.nfv.L2AddressData # Empty in "GS NFV IFA011 V0.7.3"
96 # Shall be present when the addressType is ip_address.
98 Provides the information on the IP addresses to be assigned to the connection point
99 instantiated from the parent Connection Point Descriptor.
100 type: tosca.datatypes.nfv.L3AddressData
103 tosca.datatypes.nfv.VirtualNetworkInterfaceRequirements:
105 shorthand_name: VirtualNetworkInterfaceRequirements
106 type_qualified_name: tosca:VirtualNetworkInterfaceRequirements
107 specification: tosca-simple-nfv-1.0
108 specification_section: 5.3.4
109 specification_url: 'http://docs.oasis-open.org/tosca/tosca-nfv/v1.0/csd04/tosca-nfv-v1.0-csd04.html#_Toc482896058'
111 The VirtualNetworkInterfaceRequirements type is a complex TOSCA data type used to describe
112 VirtualNetworkInterfaceRequirements information element as defined in [ETSI GS NFV-IFA 011],
113 it provides the information to specify requirements on a virtual network interface realising the
114 CPs instantiated from this CPD.
115 derived_from: tosca.datatypes.Root
119 Provides a human readable name for the requirement.
124 Provides a human readable description for the requirement.
129 Indicates whether fulfilling the constraint is mandatory (TRUE) for successful operation
130 or desirable (FALSE).
135 Specifies a requirement such as the support of SR-IOV, a particular data plane
136 acceleration library, an API to be exposed by a NIC, etc.
137 type: string # ARIA NOTE: the spec says "not specified", but TOSCA requires a type
140 tosca.datatypes.nfv.ConnectivityType:
142 shorthand_name: ConnectivityType
143 type_qualified_name: tosca:ConnectivityType
144 specification: tosca-simple-nfv-1.0
145 specification_section: 5.3.5
146 specification_url: 'http://docs.oasis-open.org/tosca/tosca-nfv/v1.0/csd04/tosca-nfv-v1.0-csd04.html#_Toc482896059'
148 The TOSCA ConnectivityType type is a complex TOSCA data type used to describe ConnectivityType
149 information element as defined in [ETSI GS NFV-IFA 011].
150 derived_from: tosca.datatypes.Root
154 Identifies the protocol this VL gives access to (ethernet, mpls, odu2, ipv4, ipv6,
159 - valid_values: [ ethernet, mpls, odu2, ipv4, ipv6, pseudo_wire ]
162 Identifies the flow pattern of the connectivity (Line, Tree, Mesh).
166 tosca.datatypes.nfv.RequestedAdditionalCapability:
168 shorthand_name: RequestedAdditionalCapability
169 type_qualified_name: tosca:RequestedAdditionalCapability
170 specification: tosca-simple-nfv-1.0
171 specification_section: 5.3.6
172 specification_url: 'http://docs.oasis-open.org/tosca/tosca-nfv/v1.0/csd04/tosca-nfv-v1.0-csd04.html#_Toc482896060'
174 RequestAdditionalCapability describes additional capability for a particular VDU.
175 derived_from: tosca.datatypes.Root
177 request_additional_capability_name:
179 Identifies a requested additional capability for the VDU.
184 Indicates whether the requested additional capability is mandatory for successful
188 min_requested_additional_capability_version:
190 Identifies the minimum version of the requested additional capability.
193 preferred_requested_additional_capability_version:
195 Identifies the preferred version of the requested additional capability.
198 target_performance_parameters:
200 Identifies specific attributes, dependent on the requested additional capability type.
206 tosca.datatypes.nfv.VirtualMemory:
208 shorthand_name: VirtualMemory
209 type_qualified_name: tosca:VirtualMemory
210 specification: tosca-simple-nfv-1.0
211 specification_section: 5.3.7
212 specification_url: 'http://docs.oasis-open.org/tosca/tosca-nfv/v1.0/csd04/tosca-nfv-v1.0-csd04.html#_Toc482896061'
214 VirtualMemory describes virtual memory for a particular VDU.
215 derived_from: tosca.datatypes.Root
218 description: Amount of virtual memory.
219 type: scalar-unit.size
221 virtual_mem_oversubscription_policy:
223 The memory core oversubscription policy in terms of virtual memory to physical memory on
224 the platform. The cardinality can be 0 during the allocation request, if no particular
230 It specifies the memory allocation to be cognisant of the relevant process/core
231 allocation. The cardinality can be 0 during the allocation request, if no particular value
236 tosca.datatypes.nfv.VirtualCpu:
238 shorthand_name: VirtualCpu
239 type_qualified_name: tosca:VirtualCpu
240 specification: tosca-simple-nfv-1.0
241 specification_section: 5.3.8
242 specification_url: 'http://docs.oasis-open.org/tosca/tosca-nfv/v1.0/csd04/tosca-nfv-v1.0-csd04.html#_Toc482896062'
244 VirtualMemory describes virtual memory for a particular VDU.
245 derived_from: tosca.datatypes.Root
249 CPU architecture type. Examples are x86, ARM.
254 Number of virtual CPUs.
259 Minimum virtual CPU clock rate.
260 type: scalar-unit.frequency
262 virtual_cpu_oversubscription_policy:
264 CPU core oversubscription policy.
269 The virtual CPU pinning configuration for the virtualized compute resource.
270 type: tosca.datatypes.nfv.VirtualCpuPinning
273 tosca.datatypes.nfv.VirtualCpuPinning:
275 shorthand_name: VirtualCpuPinning
276 type_qualified_name: tosca:VirtualCpuPinning
277 specification: tosca-simple-nfv-1.0
278 specification_section: 5.3.9
279 specification_url: 'http://docs.oasis-open.org/tosca/tosca-nfv/v1.0/csd04/tosca-nfv-v1.0-csd04.html#_Toc482896064'
281 VirtualCpuPinning describes CPU pinning configuration for a particular CPU.
282 derived_from: tosca.datatypes.Root
286 Indicates the policy for CPU pinning.
289 - valid_values: [ static, dynamic ]
293 If cpuPinningPolicy is defined as "static", the cpuPinningMap provides the map of pinning
294 virtual CPU cores to physical CPU cores/threads.
300 tosca.datatypes.nfv.VnfcConfigurableProperties:
302 shorthand_name: VnfcconfigurableProperties
303 type_qualified_name: tosca:VnfcconfigurableProperties
304 specification: tosca-simple-nfv-1.0
305 specification_section: 5.3.10
306 specification_url: 'http://docs.oasis-open.org/tosca/tosca-nfv/v1.0/csd04/tosca-nfv-v1.0-csd04.html#_Toc482896065'
307 # ARIA NOTE: description is mangled in spec
309 VnfcConfigurableProperties describes additional configurable properties of a VNFC.
310 derived_from: tosca.datatypes.Root
312 additional_vnfc_configurable_properties:
314 Describes additional configuration for VNFC.