SOL005_12, SOL005_13, SOL005_67, SOL005_47, SOL005_50, SOL005_48, SOL005_49,... (b3fbe10d) · Commits · NFV - Network Functions Virtualisation / SOL005

src/SOL005/NSLifecycleManagement/definitions/SOL005NSLifecycleManagement_def.yaml

+280 −14

Original line number	Diff line number	Diff line
		@@ -231,6 +231,16 @@ definitions:
		description: >
		Identifier of the NSD on which the NS instance is based. The value is copied from the NSD.
		$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
		versionDependency:
		description: >
		Describes version dependencies currently valid for the nested NS instance. 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 in this NsInfo with nsdId and for NSDs with the same NsdExtInvariantId.
		There shall not be more than one versionDependency present with the same dependentConstituentId.
		It may be present for the NsInfo of a nested NS. It shall not be present otherwise.
		type: array
		items:
		$ref: "#/definitions/VersionDependency"


		nsdInfoId:
		description: >
		Identifier of the NSD information object on which the
		@@ -1957,14 +1967,41 @@ definitions:
		This type represents request parameters for the "Instantiate NS" operation.

		NOTE 1: The DF of the VNF instance shall match the VNF DF present in the associated VNF Profile.
		NOTE 2: The NS DF of each nested NS shall be one of the allowed flavours in the associated
		NSD (as referenced in the nestedNsd attribute of the NSD of the NS to be instantiated).
		NOTE 3: The NSD of each referenced NSs (i.e. each nestedInstanceId) shall match the one of the
		nested NSD in the composite NSD.
		NOTE 4: When the NS is deployed over several sites, the VLs of this NS will include VNs
		in each site connected over the WAN. In this case, the "wanConnectionData" provides the needed
		information required to connect each VN to the WAN. Annex E provides additional information and
		guidelines about the usage of the "wanConnectionData" attribute.
		The VNFD of the VNF instance shall match the one in the associated VNF Profile if no overridingVnfdId
		is provided in the interface as part of vnfInstanceData, or the overridingVnfdId provided in the
		interface if it is provided.
		NOTE 2: The NS DF of each nested NS shall be one of the allowed flavours in the associated NSD
		(as referenced in the nestedNsd attribute of the NSD of the NS to be instantiated).
		NOTE 3: The NSD of each referenced NSs (i.e. each nestedInstanceId) shall match the one of the nested
		NSD in the composite NSD if no overridingNsdId is provided in the interface as part of NestedNsInstanceData,
		or the overridingNsdId provided in the interface if it is provided.
		NOTE 4: When the NS is deployed over several sites, the VLs of this NS will include VNs in
		each site connected over the WAN. In this case, the "wanConnectionData" provides the needed
		information required to connect each VN to the WAN. Annex E provides additional information
		and guidelines about the usage of the "wanConnectionData" attribute.
		NOTE 5: The target size for NS instantiation may be specified in either nsInstantiationLevelId
		or targetNsScaleLevelInfo, but not both. If none of the two parameters (nsInstantiationLevelId or
		targetNsScaleLevelInfo) are present, the default NS instantiation level as declared in the NSD shall be used.
		NOTE 6: If targetNsScaleLevelInfo is specified, information provided in targetNsScaleLevelInfo shall be used
		to calculate the number of instances of the VNFs/nested NSs referred in the NSD. For VNFs or nested NSs that
		are not scalable based on targetNsScaleLevelInfo, the default NS instantiation level as declared in the NSD
		shall be used to calculate the number of instances those VNFs/nested NSs.
		NOTE 7: When "feasibilityCheckReserve" is set to FEASIBILITY_CHECK_ONLY, the "startTime" attribute shall be ignored.
		NOTE 8: When feasibilityCheckReserve is set to NO_FEASIBILITY_CHECK, the feasibility checking procedure is not performed.
		Resources might be reserved as triggered by means outside the present operation request (e.g., configuration or policies),
		e.g. if it is a scheduled NS instantiation operation. See Annex A.2.3 in ETSI GS NFV-IFA 010.
		NOTE 9: When feasibilityCheckReserve is set to FEASIBILITY_CHECK_ONLY, only feasibility checking procedure
		is performed for the operation, no resources are reserved.
		NOTE 10: When feasibilityCheckReserve is set to FEASIBILITY_CHECK_WITH_OPERATION, the feasibility checking
		procedure is performed and based on the procedure result, the actual NS instantiation operation is performed
		at the time indicated by the "startTime" attribute, if provided. Resources might be reserved as triggered by
		means outside the present operation request (e.g., configuration or policies), e.g. if it is a scheduled NS
		instantiation operation. See Annex A.2.3 in ETSI GS NFV-IFA 010.
		NOTE 11: When feasibilityCheckReserve is set to FEASIBILITY_CHECK_WITH_RESERVATION_AND_OPERATION, the feasibility
		checking is performed and based on the procedure result, resources are reserved as part of the feasibility check,
		and the actual NS instantiation operation is performed using the resources reserved during the feasibility checking
		procedure execution, and at the time indicated by the "startTime" attribute, if provided.

		required:
		- nsFlavourId
		properties:
		@@ -2056,14 +2093,25 @@ definitions:
		description: >
		Timestamp indicating the earliest time to instantiate the NS.
		Cardinality "0" indicates the NS instantiation takes place immediately.
		If the "Instantiate NS" is a scheduled operation, it shall be possible to
		modify the schedule time, whereas it shall not be possible to change any
		other operational parameters.

		This attribute can be modified with the PATCH method.
		See note 7.
		$ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
		nsInstantiationLevelId:
		description: >
		Identifies one of the NS instantiation levels declared in
		the DF applicable to this NS instance. If not present, the
		default NS instantiation level as declared in the NSD
		shall be used.
		Identifies one of the NS instantiation levels declared in the DF applicable to this NS instance. See note 5.
		$ref: "#/definitions/IdentifierInNsd"
		targetNsScaleLevelInfo:
		description: >
		This attribute is applicable for NS target scale level instantiation.
		This attribute defines the target NS scale level to which the NS instance is to be instantiated for each NS scaling aspect of the DF applicable to this NS instance.
		See notes 5 and 6.
		type: array
		items:
		$ref: "#/definitions/NsScaleInfo"
		wanConnectionData:
		description: >
		Information for connecting VNs to the WAN when VLs are deployed across a WAN.
		@@ -2081,6 +2129,22 @@ definitions:
		items:
		$ref: "#/definitions/AffinityOrAntiAffinityRule"

		feasibilityCheckReserve:
		description: >
		Specifies the feasibility check and reserve option for the NS instantiation operation.
		Default option is NO_FEASIBILITY_CHECK.
		If not present, default value applies.
		See notes 7, 8, 9, 10 and 11.
		$ref: "#/definitions/FeasibilityCheckReserveType"

		dataFlowMirroringData:
		description: >
		Information for the data flow mirroring to be associated to this NS instance.
		type: array
		items:
		$ref: "#/definitions/DataFlowMirroringData"


		ParamsForNestedNs:
		description: >
		This type specifies additional parameters on a per-nested NS instance basis.
		@@ -6589,7 +6653,32 @@ definitions:
		enum:
		- FULL
		- SHORT

		VersionDependency:
		description: >
		This type represents the information related to all dependencies that an NSD constituent has on the versions of other NSD constituents. It shall comply with the provisions defined in table 6.5.3.112-1.
		type: object
		required:
		- dependentConstituentId
		properties:
		dependentConstituentId:
		description: >
		Identifier of the NSD constituent (vnfdId, nsdId or pnfdId) which has version dependencies on other NSD constituents.
		$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd"
		versionDependencyStatement:
		description: >
		Identifies one or multiple versions of an NSD constituents upon which the dependent constituent identified by dependentConstituentId has a dependency. Cardinality 0 is used to remove an existing version dependency in a profile.
		type: array
		items:
		$ref: "#/definitions/VersionDependencyStatement"
		VersionDependencyStatement:
		description: >
		This type represents the information related to one or more VNF, NS or PNF descriptor identifiers which describe one single dependency. When more than one descriptor is indicated, they correspond to different versions of the same VNF, NS or PNF and they represent alternatives to fulfil the dependency. It shall comply with the provisions defined in table 6.5.3.113-1.
		type: object
		required:
		- descriptorId
		properties:
		descriptorId:
		$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd"
		TerminateVnfData:
		description: >
		This type represents the information to terminate a VNF that is part of an NS.
		@@ -6694,3 +6783,180 @@ definitions:
		enum:
		- FEASIBILITY_CHECK_DONE
		- FEASIBILITY_CHECK_DONE_WITH_RESERVATION

		FeasibilityCheckReserveType:
		description: >
		The enumeration FeasibilityCheckReserveType defines the permitted values to represent the feasibility check and reserve options applicable for the NS LCM operations. It shall comply with the provisions defined in table 6.5.4.14-1.
		type: string
		enum:
		- NO_FEASIBILITY_CHECK
		- FEASIBILITY_CHECK_ONLY
		- FEASIBILITY_CHECK_WITH_OPERATION
		- FEASIBILITY_CHECK_WITH_RESERVATION_AND_OPERATION



		DataFlowMirroringData:
		description: >
		This type represents the information for the data flow mirroring to be associated to this NS instance.
		It shall comply with the provisions defined in table 6.5.3.100-1.
		type: object
		required:
		- mirroringId
		- mirroringName
		- description
		- collectorDetails
		- dataFlowData
		properties:
		mirroringId:
		description: >
		Identifier of this DataFlowMirroringData.
		$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
		mirroringName:
		description: >
		Name of Data Flow Mirroring.
		type: string
		description:
		description: >
		Information description of Data Flow Mirroring.
		type: string
		collectorDetails:
		description: >
		Information about where the mirrored flow is to be delivered.
		$ref: "#/definitions/CollectorDetails"
		dataFlowData:
		description: >
		Information about the data flows to be mirrored.
		$ref: "#/definitions/DataFlowData"

		DataFlowData:
		description: >
		This type represents the information about the data flows to be mirrored.
		It shall comply with the provisions defined in table 6.5.3.101-1.
		type: object
		required:
		- DataFlowDetails
		properties:
		dataFlowInfoId:
		description: >
		Identifier of the Data flow information in NSD. It may be provided if a corresponding data flow has been declared in the NSD.
		A value need not be provided at runtime if the APIconsumer does not intend to refer to a data flow defined in the NSD.
		$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd"
		dataFlowDetails:
		description: >
		Detailed information about the data flows that are requested to be mirrored.
		$ref: "#/definitions/DataFlowDetails"

		DataFlowDetails:
		description: >
		This type represents the detailed information about the data flows that are requested to be mirrored.
		It shall comply with the provisions defined in table 6.5.3.102-1.

		NOTE 1: It shall be present when dataFlowInfoId in DataFlowData is not provided.
		NOTE 2: Depends on the value of the direction of the data flow to be mirrored, this
		attribute defines whether the data flow from the connection point to the target IP address
		or the data flow from the target IP address to the connection point or both shall be mirrored.
		type: object
		properties:
		description:
		description: >
		Information description of the data flow.
		type: string
		cpdId:
		description: >
		Identifies the descriptor of an external connection point on a VNF/PNF or a
		SAP which acts as the mirroring point of the data flow to be mirrored. See note 1.
		$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd"
		direction:
		description: >
		The direction of the data flow that are requested to be mirrored. See note 1.
		$ref: "#/definitions/DirectionType"
		targetIpAddress:
		description: >
		If present, only the data flow to or/and from the target IP address shall be mirrored. See note 2.
		$ref: "#/definitions/IpAddress"

		DirectionType:
		type: string
		description: The enumeration DirectionType represents the direction of the data flow that are requested
		to be mirrored. It shall comply with the provisions defined in table 6.5.4.12-1.
		enum:
		- IN
		- OUT
		- BOTH

		CollectorDetails:
		description: >
		TThis type represents the information about where the mirrored flow is to be delivered.
		It shall comply with the provisions defined in table 6.5.3.103-1.
		type: object
		required:
		- collectorId
		- collectorName
		properties:
		collectorId:
		description: >
		Identifier of the collector where the mirrored flow is to be delivered.
		$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
		collectorName:
		description: >
		Name of the collector where the mirrored flow is to be delivered.
		type: string
		portId:
		description: >
		Identifier of the collector port managed by VIM where the mirrored flow is to be delivered.

		Note: The collector which is attached to this port can be a virtual machine that uses the mirrored
		data for analysis purpose. The collector is not managed by VIM.
		$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVim"

		CreateDataFlowMirroring:
		description: >
		This type represents the information for the data flow mirroring to be associated to
		this NS instance. It shall comply with the provisions defined in table 6.5.3.104-1.
		type: object
		required:
		- dataFlowMirroringData
		properties:
		dataFlowMirroringData:
		description: >
		Information for the data flow mirroring to be associated to this NS instance.
		$ref: "#/definitions/DataFlowMirroringData"
		vnfInstanceId:
		description: >
		Identifier of the VNF instance from where the data flows are requested to be mirrored.
		$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
		cpInstanceId:
		description: >
		Identifier of the CP instance from where the data flows are requested to be mirrored.
		$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"

		UpdateDataFlowMirroring:
		description: >
		This type represents the information on the data flow mirroring associated to the NS instance
		that is being modified. It shall comply with the provisions defined in table 6.5.3.105-1.

		NOTE: Updating Data Flow Mirroring can involve one or more following cases:
		1) updating the name of data flow mirroring, related to “mirroringName”.
		2) updating information description of data flow mirroring, related to “description”.
		3) updating the definition about where the mirrored data flow is requested to be delivered, related to “collectorDetails”.
		type: object
		required:
		- mirroringId
		properties:
		mirroringId:
		description: >
		Identifier of the Data Flow Mirroring to be updated.
		$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
		mirroringName:
		description: >
		Name of Data Flow Mirroring. See note.
		type: string
		description:
		description: >
		Information description of Data Flow Mirroring. See note.
		type: string
		collectorDetails:
		description: >
		New information about the destination where the mirrored flow is to be delivered. See note.
		$ref: "#/definitions/CollectorDetails"
		No newline at end of file

Admin message