description:ETSI NFV SOL 001 common types definitions version 4.2.1
description:ETSI NFV SOL 001 common types definitions version 4.3.1
metadata:
template_name:etsi_nfv_sol001_common_types
template_author:ETSI_NFV
template_version:4.2.1
template_version:4.3.1
data_types:
tosca.datatypes.nfv.L2AddressData:
...
...
@@ -12,7 +12,7 @@ data_types:
properties:
mac_address_assignment:
type:boolean
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
description:Specifies which mode is used for the MAC address assignment. If it is set to True, a MAC address is expected to be provided by a management entity via the NFV MANO interfaces towards the VNFM using attributes standardized for this purpose in the NFV-MANO information model and is further transferred from the VNFM to the VIM/CISM. A MAC address will be automatically assigned by the VIM/NFVI/CISM as fallback if not provided. If it is set to False, a MAC address is expected to it will be assigned by means specific to the VNF itself (e.g., by an LCM script, by the EM) and is further transferred from the VNFM to the VIM/CISM. A MAC address will be automatically assigned by the VIM/NFVI/CISM as fallback if not provided to the VIM/CISM.
required:true
tosca.datatypes.nfv.L3AddressData:
...
...
@@ -21,8 +21,14 @@ data_types:
properties:
ip_address_assignment:
type:boolean
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
required:true
description:Specify which mode is used for the IP address assignment. If it is set to True and this property is not used in the context of the VirtualCp node type, IP configuration information shall be provided for the VNF by a management entity using the NFV MANO interfaces towards the VNFM. If it is set to True and this property is used in the context of the VirtualCp node type, IP configuration information should be provided for the VNF by a management entity using the NFV MANO interfaces towards the VNFM. If it is not provided, the CISM assigns an IP address. If it is set to False, the value of the ip_address_assignment_subtype property defines the method of IP address assignment. Shall be present if the fixed_ip_address property is not present and should be absent otherwise.
description:Specifies if the floating IP scheme is activated on the Connection Point or not
...
...
@@ -41,7 +47,7 @@ data_types:
-greater_than:0
fixed_ip_address:
type:list
description:IP address to be assigned to the CP instance. This attribute is only permitted for Cpds without external connectivity, i.e. connectivity outside the VNF. If present, it shall be compatible with the values of the L3ProtocolData of the VnfVirtualLink referred to by the Cp, if L3ProtocolData is included in the VnfVirtualLink
description:Fixed IP addresses to be assigned to the internal CP instance. This property enables the VNF provider to define fixed IP addresses for internal CP instances to be assigned by the VNFM or the NFVO. This attribute property is only permitted for Cpds without external connectivity, i.e. connectivity outside the VNF. If present, it shall be compatible with the values of the L3ProtocolData of the VnfVirtualLink referred to by the Cp, if L3ProtocolData is included in the VnfVirtualLink
required:false
entry_schema:
type:string
...
...
@@ -126,6 +132,12 @@ data_types:
type:string
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.
required:false
target_vnf_scale_level_info:
type:map# key: aspectId
description:For each scaling aspect of the current VNF deployment flavour, it specifies the scale level of VNF constituents (e.g., VDU level) to be instantiated. If the property is present it shall contain all scaling aspects
required:false
entry_schema:
type:tosca.datatypes.nfv.ScaleInfo
min_number_of_instances:
type:integer
description:Minimum number of instances of the VNF based on this VNFD that is permitted to exist for this VnfProfile.
...
...
@@ -144,6 +156,12 @@ data_types:
required:false
constraints:
-greater_or_equal:1
version_dependency:
type:list
description:Identifies versions of descriptors of other constituents in the NSD upon which the VNF depends. The dependencies may be described for the VNFD referenced with descriptor_id in the VNF node where this profile is defined and for VNFDs with the same ext_invariant_id.
required:false
entry_schema:
type:tosca.datatypes.nfv.VersionDependency
tosca.datatypes.nfv.Qos:
derived_from:tosca.datatypes.Root
...
...
@@ -188,7 +206,44 @@ data_types:
required:false
constraints:
-greater_than:0 s
tosca.datatypes.nfv.VersionDependency:
derived_from:tosca.datatypes.Root
description:Describes and associates the protocol layer that a CP uses together with other protocol and connection point information.
properties:
dependent_constituent_id:
type:string
description:Identifier of the NSD constituent which has version dependencies on other NSD constituents.
required:true
version_dependency_statement:
type:list
description:Identifies one or multiple versions of an NSD constituent upon which the dependent constituent identified by dependent_constituent_id has a dependency.
description:Lists one or more VNF, NS or PNF descriptor identifiers which describe one single dependency.
properties:
descriptor_id:
description:List of identifiers of VNFDs, NSDs or PNFDs upon which the entity using this information element depends. When more than one descriptor is indicated, they shall correspond to versions of the same VNF, NS or PNF and they represent. alternatives, i.e. the presence of one of them fulfills the dependency.
type:list
entry_schema:
type:string
required:true
tosca.datatypes.nfv.ScaleInfo:
derived_from:tosca.datatypes.Root
description:Indicates for a given scaleAspect the corresponding scaleLevel
properties:
scale_level:
type:integer
description:The scale level for a particular aspect
# editor's note: During the development of the SOL001ed421 GS, to enable this file to be verified by a TOSCA parser, the imports statement has to be replaced with a reference to a local copy of the common definitions YAML file
description:It describes the data flow mirroring to be associated to the NS instance containing the NS VL created from this NsVlProfile..
required:false
entry_schema:
type:tosca.datatypes.nfv.NsDataFlowMirroring
tosca.datatypes.nfv.NsVirtualLinkQos:
derived_from:tosca.datatypes.nfv.Qos
...
...
@@ -72,10 +78,12 @@ data_types:
required:true
constraints:
-greater_or_equal:0
flavour_id:
type:string
description:Identifies the applicable network service DF within the scope of the NSD.
required:true
version_dependency:
type:list
description:Identifies versions of descriptors of other constituents in the NSD upon which the nested NS depends. The dependencies may be described for the NSD referenced with descriptor_id in the NS node where this profile is defined and for NSDs with the same ext_invariant_id.
required:false
entry_schema:
type:tosca.datatypes.nfv.VersionDependency
tosca.datatypes.nfv.Mask:
derived_from:tosca.datatypes.Root
...
...
@@ -279,6 +287,19 @@ data_types:
constraints:
-greater_or_equal:0
tosca.datatypes.nfv.NsDataFlowMirroring:
derived_from:tosca.datatypes.Root
description:describes the data flow mirroring information to be associated to the NS instance.
properties:
mirroring_job_name:
type:string
description:Name of Data Flow Mirroring Job
required:true
description:
type:string
description:Information description of Data Flow Mirroring Job
required:false
capability_types:
tosca.capabilities.nfv.Forwarding:
derived_from:tosca.capabilities.Root
...
...
@@ -297,10 +318,10 @@ interface_types:
description:Preamble to execution of the instantiate operation
instantiate:
description:Base procedure for instantiating an NS, corresponding to the Instantiate NS operation defined in ETSI GS NFV-IFA 013.
description:Describes the information needed to scale an NS instance by one or more scaling steps, with respect to a particular NS scaling aspect as defined in ETSI GS NFV-IFA 013. Either scale_ns_by_steps_data or scale_ns_to_level_data shall be provided.
...
...
@@ -338,10 +358,10 @@ interface_types:
description:Preamble to execution of the heal operation
heal:
description:Base procedure for healing an NS, corresponding to the Heal NS operation defined in ETSI GS NFV-IFA 013.
description:Postamble to the execution of the heal operation
...
...
@@ -371,8 +391,12 @@ node_types:
required:true
invariant_id:# UUID
type:string
description:Identifies an NSD in a version independent manner. This attribute is invariant across versions of NSD
description:Identifies an NSD in a version independent manner. This attribute is invariant across versions of NSD with no constraints on the changes across versions.
required:true
ext_invariant_id:# UUID
type:string
description:Identifies an NSD in a version independent manner. This attribute is invariant across versions of the NSD that fulfil certain conditions related to the external connectivity and management of the NS. When used in a nested NS node template in a composite NSD it allows for nested NS instances during NS LCM the use of an NSD different from the one referenced by the descriptor_id property, provided they have the same ext_invariant_id.
required:false
flavour_id:
type:string
description:Identifier of the NS Deployment Flavour within the NSD
...
...
@@ -393,6 +417,11 @@ node_types:
required:false
constraints:
-greater_or_equal:0
strict_nsd_constituent_onboarding:
type:boolean
description:Indicates if all NSD constituents referenced by this NSD shall be onboarded before onboarding the NSD identified by this information element. If true all referenced constituents shall be onboarded.
required:true
default:true
attributes:
scale_status:
type:map# key: aspectId
...
...
@@ -414,6 +443,9 @@ node_types:
tosca.nodes.nfv.Sap:
derived_from:tosca.nodes.nfv.Cp
description:node definition of SAP.
capabilities:
forwarding:
type:tosca.capabilities.nfv.Forwarding
requirements:
-external_virtual_link:
capability:tosca.capabilities.nfv.VirtualLinkable
...
...
@@ -473,12 +505,12 @@ node_types:
constraints:
-valid_values:[all,lb,ff]
required:false
# forwarding_behaviour_input_parameters:
# description: Provides input parameters to configure the forwarding behaviour.
# type: map
# required: false
# entry_schema:
# type: string
forwarding_behaviour_input_parameters:
description:Provides input parameters to configure the forwarding behaviour.
type:map
required:false
entry_schema:
type:string
capabilities:
forwarding:
type:tosca.capabilities.nfv.Forwarding
...
...
@@ -506,7 +538,6 @@ node_types:
type:tosca.capabilities.nfv.VirtualLinkable
forwarding:
type:tosca.capabilities.nfv.Forwarding
occurrences:[1,2]#When the number of occurrences is 1, the ingress and egress traffic is associated to a single VnfExtCp, PnfExtCp or Sap; When the number of occurrences is 2, the ingress VnfExtCp, PnfExtCp or Sap is associated to the first value and the egress VnfExtCp, PnfExtCp or Sap is associated to the second value.
requirements:
-virtual_link:
capability:tosca.capabilities.nfv.VirtualLinkable
...
...
@@ -521,7 +552,7 @@ group_types:
type:string
description:Human readable description of the group
description:The ScalingAspects type is a policy type representing the scaling aspects used for horizontal scaling as defined in ETSI GS NFV-IFA 014 [2]
description:The NsScalingAspects type is a policy type representing the scaling aspects used for horizontal scaling as defined in ETSI GS NFV-IFA 014 [2]
properties:
aspects:
type:map# key: aspectId
...
...
@@ -802,3 +833,24 @@ policy_types:
derived_from:tosca.policies.Root
description:The NsAutoScale policy type is a base policy type for defining NS auto-scale specific policies as defined in ETSI GS NFV-IFA 014 [2].
targets:[tosca.nodes.nfv.NS]
tosca.policies.nfv.DataFlowInfo:
derived_from:tosca.policies.Root
description:The NsDataFlowMirroring type is a policy type representing the the information to identify an external connection point of the VNF/PNF or a Sap from which the data flows are expected to be mirrored as defined in ETSI GS NFV-IFA 014 [2].
properties:
data_flow_info_id:
type:string
description:Identifier of the Data flow information
required:true
associated_mirroring_job_name:
type:string
description:Associated data mirroring job name as defined in NsVirtualLink node
required:true
direction:
type:string
description:The direction of the data flow that are requested to be mirrored. The direction is specified against the associated CP. I.e., 'in' means the data flow that enters the target connection point needs to be mirrored. 'out' means the data flow that sends out the target connection point needs to be mirrored. 'both' means the data flows that both enters and sends out the target connection point all need to be mirrored.
description:Identifier of this PNFD information element. It uniquely identifies the PNFD.
type:string# UUID
required:true
description:Identifier of this PNFD information element. It uniquely identifies the PNFD.
function_description:
type:string
required:true
description:Describes the PNF function.
type:string
required:true
description:Describes the PNF function.
provider:
type:string
required:true
description:Identifies the provider of the PNFD.
type:string
required:true
description:Identifies the provider of the PNFD.
version:
type:string
required:true
description:Identifies the version of the PNFD.
type:string
required:true
description:Identifies the version of the PNFD.
descriptor_invariant_id:# instead of pnfd-invariant-id
type:string# UUID
required:true
description:Identifier of this PNFD in a version independent manner. This attribute is invariant across versions of PNFD.
type:string# UUID
required:true
description:Identifier of this PNFD in a version independent manner. This attribute is invariant across versions of PNFD with no constraint on the changes across versions.
ext_invariant_id:
type:string# UUID
required:false
description:Identifies a PNFD in a version independent manner. This attribute is invariant across versions of the PNFD that expose the same external connectivity, i.e. same number and name of the requirements for VirtualLinkable capability that represent PnfExtCps. When used in a PNF node template in an NSD it allows for PNF instances during NS LCM the use of a PNFD different from the one referenced by the descriptor_id attribute, provided they have the same ext_invariant_id.
name:
type:string
required:true
description:Name to identify the PNFD.
type:string
required:true
description:Name to identify the PNFD.
geographical_location_info:
type:tosca.datatypes.nfv.LocationInfo
required:false
description:Provides information about the geographical location (e.g. geographic coordinates or address of the building, etc.) of the PNF
type:tosca.datatypes.nfv.LocationInfo
required:false
description:Provides information about the geographical location (e.g. geographic coordinates or address of the building, etc.) of the PNF
version_dependency:
type:list
description:Identifies versions of descriptors of other constituents in the NSD upon which the PNF depends. The dependencies may be described for the PNFD referenced with descriptor_id and for PNFDs with the same ext_invariant_id.
# Additional requirements shall be defined in the PNF specific node type (deriving from tosca.nodes.nfv.PNF) corresponding to NS virtual links that need to connect to PnfExtCps
Laurent VRECK <laurent.vreck@etsi.org>