Newer
Older
moscatelli
committed
Timestamp indicating the scale time of the NS, i.e. the
NS will be scaled at this timestamp. Cardinality "0"
indicates the NS scaling takes place immediately".
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
moscatelli
committed
UpdateNsRequest:
description: >
This operation supports the update of a NS instance,
It shall comply with the provisions defined in Table 6.5.2.12-1.
type: object
required:
- updateType
properties:
updateType:
description: >
The type of update. It determines also which one of the
following parameters is present in the operation.
Possible values include:
* ADD_VNF: Adding existing VNF instance(s)
* REMOVE_VNF: Removing VNF instance(s)
* INSTANTIATE_VNF: Instantiating new VNF(s)
* CHANGE_VNF_DF: Changing VNF DF
* OPERATE_VNF: Changing VNF state,
* MODIFY_VNF_INFORMATION: Modifying
VNF information and/or the configurable
properties of VNF instance(s)
* CHANGE_EXTERNAL_VNF_CONNECTIVITY:
Changing the external connectivity of VNF
instance(s)
* ADD_SAP: Adding SAP(s)
* REMOVE_SAP: Removing SAP(s)
* ADD_NESTED_NS: Adding existing NS
instance(s) as nested NS(s)
* REMOVE_NESTED_NS: Removing existing
nested NS instance(s)
* ASSOC_NEW_NSD_VERSION: Associating a
new NSD version to the NS instance
* MOVE_VNF: Moving VNF instance(s) from one
origin NS instance to another target NS
instance
* ADD_VNFFG: Adding VNFFG(s)
* REMOVE_VNFFG: Removing VNFFG(s)
* UPDATE_VNFFG: Updating VNFFG(s)
* CHANGE_NS_DF: Changing NS DF
* ADD_PNF: Adding PNF
* MODIFY_PNF: Modifying PNF
* REMOVE_PNF: Removing PNF
type: string
moscatelli
committed
enum:
- ADD_VNF
- REMOVE_VNF
- INSTANTIATE_VNF
- CHANGE_VNF_DF
- OPERATE_VNF
- MODIFY_VNF_INFORMATION
- CHANGE_EXTERNAL_VNF_CONNECTIVITY
- REMOVE_SAP
- ADD_NESTED_NS
- REMOVE_NESTED_NS
- ASSOC_NEW_NSD_VERSION
- MOVE_VNF
- ADD_VNFFG
moscatelli
committed
- REMOVE_VNFFG
- UPDATE_VNFFG
- CHANGE_NS_DF
- ADD_PNF
- MODIFY_PNF
- REMOVE_PNF
addVnfIstance:
description: >
Identifies an existing VNF instance to be added to the
NS instance. It shall be present only if updateType = "ADD_VNF".
type: array
moscatelli
committed
items:
$ref: "#/definitions/VnfInstanceData"
removeVnfInstanceId:
description: >
Identifies an existing VNF instance to be removed from
the NS instance. It contains the identifier(s) of the VNF
instances to be removed. It shall be present only if
updateType = "REMOVE_VNF." Note: If a VNF instance
is removed from a NS and this NS was the last one for
which this VNF instance was a part, the VNF instance is
terminated by the NFVO.
type: array
moscatelli
committed
items:
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
instantiateVnfData:
description: >
Identifies the new VNF to be instantiated. It can be used
e.g. for the bottom-up NS creation. It shall be present
only if updateType = "INSTANTIATE_VNF".
type: array
moscatelli
committed
items:
$ref: "#/definitions/InstantiateVnfData"
changeVnfFlavourData:
description: >
Identifies the new DF of the VNF instance to be
changed to. It shall be present only if updateType = "CHANGE_VNF_DF".
type: array
moscatelli
committed
items:
$ref: "#/definitions/ChangeVnfFlavourData"
operateVnfData:
description: >
Identifies the state of the VNF instance to be changed.
It shall be present only if updateType = "OPERATE_VNF".
type: array
moscatelli
committed
items:
$ref: "#/definitions/OperateVnfData"
modifyVnfInfoData:
description: >
Identifies the VNF information parameters and/or the
configurable properties of VNF instance to be modified.
It shall be present only if updateType = "MODIFY_VNF_INFORMATION".
type: array
moscatelli
committed
items:
$ref: "#/definitions/ModifyVnfInfoData"
changeExtVnfConnectivityData:
description: >
Specifies the new external connectivity data of the VNF
instance to be changed. It shall be present only if
updateType = "CHANGE_EXTERNAL_VNF_CONNECTIVITY".
type: array
moscatelli
committed
items:
$ref: "#/definitions/ChangeExtVnfConnectivityData"
addSap:
description: >
Identifies a new SAP to be added to the NS instance.
It shall be present only if updateType = "ADD_SAP."
type: array
moscatelli
committed
items:
$ref: "#/definitions/SapData"
removeSapId:
description: >
The identifier an existing SAP to be removed from the
NS instance. It shall be present only if updateType = "REMOVE_SAP."
type: array
moscatelli
committed
items:
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
Samir Medjiah
committed
addNestedNsData:
description: >
The identifier of an existing nested NS instance to be
added to (nested within) the NS instance. It shall be
present only if updateType = "ADD_NESTED_NS".
type: array
moscatelli
committed
items:
Samir Medjiah
committed
$ref: "#/definitions/NestedNsInstanceData"
moscatelli
committed
description: >
The identifier of an existing nested NS instance to be
removed from the NS instance. It shall be present only if
updateType = "REMOVE_NESTED_NS".
type: array
items:
$ref: "#/definitions/IdentifierInNs"
assocNewNsdVersionData:
description: >
Specify the new NSD to be used for the NS instance. It
shall be present only if updateType =
ASSOC_NEW_NSD_VERSION".
$ref: "#/definitions/AssocNewNsdVersionData"
moveVnfInstanceData:
description: >
Specify existing VNF instance to be moved from one NS
instance to another NS instance. It shall be present only
if updateType = MOVE_VNF".
type: array
moscatelli
committed
items:
$ref: "#/definitions/MoveVnfInstanceData"
addVnffg:
description: >
Specify the new VNFFG to be created to the NS
Instance. It shall be present only if updateType =
"ADD_VNFFG".
type: array
moscatelli
committed
items:
$ref: "#/definitions/AddVnffgData"
removeVnffgId:
description: >
Identifier of an existing VNFFG to be removed from the
NS Instance. It shall be present only if updateType =
"REMOVE_VNFFG".
type: array
moscatelli
committed
items:
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
updateVnffg:
description: >
Specify the new VNFFG Information data to be updated
for a VNFFG of the NS Instance. It shall be present only
if updateType = "UPDATE_VNFFG".
type: array
moscatelli
committed
items:
$ref: "#/definitions/UpdateVnffgData"
changeNsFlavourData:
description: >
Specifies the new DF to be applied to the NS instance. It
shall be present only if updateType =
"CHANGE_NS_DF".
moscatelli
committed
$ref: "#/definitions/ChangeNsFlavourData"
addPnfData:
description: >
specifies the PNF to be added into the NS instance.
It shall be present only if updateType = "ADD_PNF".
type: array
moscatelli
committed
items:
$ref: "#/definitions/AddPnfData"
modifyPnfData:
description: >
Specifies the PNF to be modified in the NS instance.
It shall be present only if updateType = "MODIFY_PNF".
type: array
moscatelli
committed
items:
$ref: "#/definitions/ModifyPnfData"
removePnfId:
description: >
Identifier of the PNF to be deleted from the NS instance.
It shall be present only if updateType = "REMOVE_PNF".
type: array
moscatelli
committed
items:
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
updateTime:
description: >
Timestamp indicating the update time of the NS, i.e. the
NS will be updated at this timestamp. Cardinality "0"
indicates the NS update takes place immediately.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
InstantiateVnfData:
description: >
This type represents the information related to a SAP of a NS. The InstantiateVnfData data type specifies the
parameters that are needed for VNF instantiation. This information element is used for the bottom-up NS creation when
the OSS/BSS explicitly requests VNF instantiation for a given NS. When the NFVO invokes the Instantiate VNF
update operation, a set of these parameters are then passed by the NFVO to the VNFM. It shall comply with the
provisions defined in Table 6.5.3.24-1.
type: object
required:
- vnfdId
moscatelli
committed
- vnfFlavourId
properties:
vnfdId:
description: >
Information sufficient to identify the VNFD which defines
the VNF to be instantiated.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
vnfFlavourId:
description: >
Identifier of the VNF deployment flavor to be instantiated.
$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
vnfInstantiationLevelId:
description: >
Identifier of the instantiation level of the deployment
flavor to be instantiated. If not present, the default
instantiation level as declared in the VNFD is
instantiated.
$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
vnfInstanceName:
description: >
Human-readable name of the VNF instance to be created.
type: string
vnfInstanceDescription:
description: >
Human-readable description of the VNF instance to be created.
type: string
extVirtualLinks:
description: >
Information about external VLs to connect the VNF to.
type: array
moscatelli
committed
items:
$ref: "#/definitions/ExtVirtualLinkData"
extManagedVirtualLinks:
description: >
Information about internal VLs that are managed by other entities than the VNFM.
type: array
moscatelli
committed
items:
$ref: "#/definitions/ExtManagedVirtualLinkData"
localizationLanguage:
description: >
moscatelli
committed
Localization language of the VNF to be instantiated.
The value shall comply with the format defined in IETF RFC 5646.
moscatelli
committed
type: string
vnfConfigurableProperties:
description: >
Values for the "vnfConfigurableProperties" input
parameter of the Instantiate VNF operation
defined in ETSI GS NFV-SOL 003 [4].
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
moscatelli
committed
additionalParams:
description: >
Additional input parameters for the instantiation process,
specific to the VNF being instantiated.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
metadata:
description: >
This attribute provides values for the "metadata" input parameter of
the Create VNF Identifier operation.
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
extensions:
description: >
This attribute provides values for the "extensions" input parameter of
the Instantiate VNF operation.
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
locationConstraints:
description: >
Defines the location constraints for the VNF to be
instantiated as part of the NS Update.
An example can be a constraint for the VNF to be
in a specific geographic location.
$ref: "#/definitions/VnfLocationConstraint"
moscatelli
committed
ChangeVnfFlavourData:
description: >
The type represents the information that is requested to be changed
deployment flavor for an existing VNF instance.
It shall comply with the provisions defined in Table 6.5.3.25-1.
type: object
required:
- vnfInstanceId
- newFlavourId
properties:
vnfInstanceId:
description: >
Identifier of the VNF instance to be modified.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
moscatelli
committed
newFlavourId:
description: >
Identifier of the VNF deployment flavor to be instantiated.
$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
moscatelli
committed
instantiationLevelId:
description: >
Identifier of the instantiation level of the deployment
flavor to be instantiated. If not present, the default
instantiation level as declared in the VNFD is
instantiated.
$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
moscatelli
committed
extVirtualLinks:
description: >
Information about external VLs to connect the VNF to.
type: array
items:
$ref: "#/definitions/ExtVirtualLinkData"
moscatelli
committed
extManagedVirtualLinks:
description: >
information about internal VLs that are managed by NFVO.
type: array
items:
$ref: "#/definitions/ExtManagedVirtualLinkData"
moscatelli
committed
additionalParams:
description: >
Additional input parameters for the flavor change
process, specific to the VNF being modified, as declared
in the VNFD as part of "ChangeVnfFlavourOpConfig".
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
moscatelli
committed
OperateVnfData:
description: >
This type represents a VNF instance for which the operational state
needs to be changed and the requested new state. It
shall comply with the provisions defined in Table 6.5.3.31-1.
type: object
required:
- vnfInstanceId
- changeStateTo
properties:
vnfInstanceId:
description: >
Identifier of the VNF instance.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
moscatelli
committed
changeStateTo:
description: >
The desired operational state (i.e. started or stopped)
to change the VNF to.
$ref: "#/definitions/OperationalStates"
stopType:
description: >
It signals whether forceful or graceful stop is requested.
$ref: "#/definitions/StopType"
gracefulStopTimeout:
description: >
The time interval (in seconds) to wait for the VNF to be
taken out of service during graceful stop, before
stopping the VNF.
type: integer
additionalParam:
description: >
Additional parameters passed by the OSS/BSS as input
to the Operate VNF operation, specific to the VNF being
operated.
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
moscatelli
committed
OperationalStates:
description: >
STARTED - The VNF instance is up and running.
STOPPED - The VNF instance has been shut down.
type: string
enum:
- STARTED
- STOPPED
Samir Medjiah
committed
moscatelli
committed
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
StopType:
description: >
* FORCEFUL: The VNFM will stop the VNF immediately after accepting the
request.
* GRACEFUL: The VNFM will first arrange to take the VNF out of service
after accepting the request. Once that operation is successful or once
the timer value specified in the "gracefulStopTimeout" attribute
expires, the VNFM will stop the VNF.
type: string
enum:
- FORCEFUL
- GRACEFUL
ModifyVnfInfoData:
description: >
This type represents the information that is requested to be modified for a VNF instance. The information to be
modified shall comply with the associated NSD.
EXAMPLE. The vnfPkgId attribute value for a particular VNF instance can only be updated with a value that
matches the identifier value of a VNF package whose vnfdId is present in the associated profile of the NSD.
type: object
required:
- vnfInstanceId
properties:
vnfInstanceId:
description: >
Identifier of the VNF instance.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
moscatelli
committed
vnfInstanceName:
description: >
New value of the "vnfInstanceName" attribute in
"VnfInstance", or "null" to remove the attribute.
type: string
vnfInstanceDescription:
description: >
New value of the "vnfInstanceDescription" attribute in "VnfInstance",
or "null" to remove the attribute.
type: string
moscatelli
committed
description: >
New value of the "vnfdId" attribute in "VnfInstance".
moscatelli
committed
The value "null" is not permitted
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
moscatelli
committed
vnfConfigurableProperties:
description: >
Modifications to entries in the
"vnfConfigurableProperties" attribute in "VnfInstance", as defined below in clause 6.5.3.57.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
metadata:
moscatelli
committed
description: >
Modifications to entries in the "metadata" attribute in "VnfInstance", as defined below in clause 6.5.3.57.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
extensions:
moscatelli
committed
description: >
Modifications to entries in the "extensions" attribute in "VnfInstance", as defined below in clause 6.5.3.57.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
moscatelli
committed
ChangeExtVnfConnectivityData:
description: >
This type describes the information invoked by the NFVO to change the external VNF connectivity information
maintained by the VNFM. The types of changes that this operation supports are:
1) Disconnect the external CPs that are connected to a particular external VL, and connect them to a different
external VL.
2) Change the connectivity parameters of the existing external CPs, including changing addresses.
NOTE: Depending on the capabilities of the underlying VIM resources, certain changes (e.g. modifying the IP
address assignment) might not be supported without deleting the resource and creating another one with
the modified configuration.
This type shall comply with the provisions defined in Table 6.5.3.33-1.
type: object
required:
- vnfInstanceId
moscatelli
committed
properties:
vnfInstanceId:
description: >
Identifier of the VNF instance.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
moscatelli
committed
description: >
Information about external VLs to change (e.g. connect the VNF to).
type: array
items:
$ref: "#/definitions/ExtVirtualLinkData"
moscatelli
committed
additionalParams:
description: >
Additional parameters passed by the OSS as input to
the external connectivity change process, specific to the
VNF instance being changed.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
moscatelli
committed
AssocNewNsdVersionData:
description: >
This type specifies a new NSD version that is associated to the NS instance. After issuing the Update NS operation with
updateType = "AssocNewNsdVersion", the NFVO shall use the referred NSD as a basis for the given NS instance.
Different versions of the same NSD have same nsdInvariantId, but different nsdId attributes, therefore if the
nsdInvariantId of the NSD version that is to be associated to this NS instance is different from the one used before, the
NFVO shall reject the request. Only new versions of the same NSD can be associated to an existing NS instance. This
data type shall comply with the provisions defined in Table 6.5.3.34-1.
type: object
required:
- newNsdId
properties:
newNsdId:
description: >
Identifier of the new NSD version that is to be
associated to the NS instance.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
moscatelli
committed
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
sync:
description: >
Specify whether the NS instance shall be automatically
synchronized to the new NSD by the NFVO (in case of
true value) or the NFVO shall not do any action (in case
of a false value) and wait for further guidance from
OSS/BSS (i.e. waiting for OSS/BSS to issue NS
lifecycle management operation to explicitly add/remove
VNFs and modify information of VNF instances
according to the new NSD).
The synchronization to the new NSD means e.g.
instantiating/adding those VNFs whose VNFD is
referenced by the new NSD version but not referenced
by the old one, terminating/removing those VNFs whose
VNFD is referenced by the old NSD version but not
referenced by the new NSD version, modifying
information of VNF instances to the new applicable
VNFD provided in the new NSD version.
A cardinality of 0 indicates that synchronization shall not be done.
type: boolean
MoveVnfInstanceData:
description: >
This type specifies existing VNF instances to be moved from one NS instance (source) to another NS instance
(destination). The NS instance defined in the Update NS operation indicates the source NS instance and the destination
NS instance is specified in this data type (referred to targetNsInstanceId).
It shall comply with the provisions defined in Table 6.5.3.35-1.
type: object
required:
- targetNsInstanceId
properties:
targetNsInstanceId:
description: >
Specify the target NS instance where the VNF instances
are moved to.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
moscatelli
committed
vnfInstanceId:
description: >
Specify the VNF instance that is moved.
type: array
items:
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
moscatelli
committed
AddVnffgData:
description: >
This type specifies the parameters used for the creation of a new VNFFG instance.
It shall comply with the provisions defined in Table 6.5.3.36-1.
type: object
required:
- vnffgdId
- vnffgName
- description
properties:
targetNsInstanceId:
description: >
Identifier of the VNFFGD used to create this VNFFG
instance.
$ref: "#/definitions/IdentifierInNsd"
moscatelli
committed
vnffgName:
description: >
Human readable name for the VNFFG.
type: string
description:
description: >
Human readable description for the VNFFG.
type: string
UpdateVnffgData:
description: >
This type specifies the parameters used for the update of an existing VNFFG instance.
It shall comply with the provisions defined in Table 6.5.3.37-1.
type: object
required:
- vnffgInfoId
properties:
vnffgInfoId:
description: >
Identifier of an existing VNFFG to be updated for the NS Instance.
$ref: "#/definitions/IdentifierInNs"
moscatelli
committed
nfp:
description: >
Indicate the desired new NFP(s) for a given VNFFG
after the operations of addition/removal of NS
components (e.g. VNFs, VLs, etc.) have been
completed, or indicate the updated or newly created
NFP classification and selection rule which applied to an existing NFP.
type: array
items:
$ref: "#/definitions/NfpData"
nfpInfoId:
description: >
Identifier(s) of the NFP to be deleted from a given VNFFG.
type: array
items:
$ref: "#/definitions/IdentifierInNs"
moscatelli
committed
NfpData:
description: >
This type contains information used to create or modify NFP instance parameters
for the update of an existing VNFFG instance.
It shall comply with the provisions defined in Table 6.5.3.38-1.
type: object
properties:
nfpInfoId:
description: >
Identifier of the NFP to be modified. It shall be present
for modified NFPs and shall be absent for the new NFP.
It shall be present for modified NFPs and shall be absent
for the new NFP.
$ref: "#/definitions/IdentifierInNs"
moscatelli
committed
nfpName:
description: >
Human readable name for the NFP. It shall be present
for the new NFP, and it may be present otherwise.
It shall be present for the new NFP, and it may be
present otherwise.
moscatelli
committed
type: string
description:
description: >
Human readable description for the NFP. It shall be
present for the new NFP, and it may be present otherwise.
It shall be present for the new NFP, and it may be
present otherwise.
moscatelli
committed
type: string
moscatelli
committed
description: >
Group(s) of CPs and/or SAPs which the NFP passes by.
moscatelli
committed
Cardinality can be 0 if only updated or newly created
NFP classification and selection rule which applied to an
existing NFP is provided.
At least a CP or an nfpRule shall be present.
When multiple identifiers are included, the position of
the identifier in the cpGroup value specifies the position
of the group in the path.
moscatelli
committed
type: array
items:
$ref: "#/definitions/CpGroupInfo"
moscatelli
committed
nfpRule:
description: >
NFP classification and selection rule. See note 1.
$ref: "#/definitions/NfpRule"
NfpRule:
description: >
The NfpRule data type is an expression of the conditions that shall be met
in order for the NFP to be applicable to the packet. The condition acts as a flow classifier and
it is met only if all the values expressed in the condition are matched
by those in the packet. It shall comply with the provisions defined in Table 6.5.3.40-1.
type: object
properties:
etherDestinationAddress:
description: >
Indicates a destination Mac address.
$ref: "#/definitions/MacAddress"
moscatelli
committed
etherSourceAddress:
description: >
Indicates a source Mac address.
$ref: "#/definitions/MacAddress"
moscatelli
committed
etherType:
description: >
Human readable description for the VNFFG.
type: string
enum:
- IPV4
- IPV6
vlanTag:
description: >
Indicates a VLAN identifier in an IEEE 802.1Q-2018
moscatelli
committed
tag [6] Multiple tags can be included for QinQ stacking. See note.
type: array
items:
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/String"
moscatelli
committed
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
protocol:
description: >
Indicates the L4 protocol, For IPv4 [7] this
corresponds to the field called "Protocol" to identify
the next level protocol. For IPv6 [28] this
corresponds to the field is called the "Next Header" field.
Permitted values: Any keyword defined in the IANA
protocol registry [1], e.g.:
TCP
UDP
ICMP
type: string
enum:
- TCP
- UDP
- ICMP
dscp:
description: >
For IPv4 [7] a string of "0" and "1" digits that
corresponds to the 6-bit Differentiated Services
Code Point (DSCP) field of the IP header.
For IPv6 [28] a string of "0" and "1" digits that
corresponds to the 6 differentiated services bits of
the traffic class header field
type: string
sourcePortRange:
description: >
Indicates a range of source ports
$ref: "#/definitions/PortRange"
moscatelli
committed
destinationPortRange:
description: >
Indicates a range of destination ports.
$ref: "#/definitions/PortRange"
moscatelli
committed
sourceIpAddressPrefix:
description: >
Indicates the source IP address range in CIDR format.
$ref: "#/definitions/IpAddressPrefix"
moscatelli
committed
destinationIpAddressPrefix:
description: >
Indicates the destination IP address range in CIDR format.
$ref: "#/definitions/IpAddressPrefix"
moscatelli
committed
extendedCriteria:
description: >
Indicates values of specific bits in a frame.
type: array
items:
$ref: "#/definitions/Mask"
moscatelli
committed
ChangeNsFlavourData:
description: >
This type specifies an existing NS instance for which the DF needs to be changed.
This specifies the new DF, the instantiationLevel of the new DF that may be used and
the additional parameters as input for the flavour change.
It shall comply with the provisions defined in Table 6.5.3.39-1.
type: object
required:
- newNsFlavourId
properties:
newNsFlavourId:
description: >
Identifier of the new NS DF to apply to this NS instance.
$ref: "#/definitions/IdentifierInNsd"
moscatelli
committed
instantiationLevelId:
description: >
Identifier of the instantiation level of the deployment flavour to be instantiated.
If not present, the default instantiation level as declared in the NSD is instantiated.
$ref: "#/definitions/IdentifierInNsd"
moscatelli
committed
AddPnfData:
description: >
This type specifies an PNF to be added to the NS instance and the PNF Profile
to use for this PNF. It shall comply with the provisions defined in Table 6.5.3.14-1.
type: object
required:
- pnfId
- pnfName
- pnfdId
- pnfProfileId
properties:
pnfId:
description: >
Identifier of the PNF. This identifier is allocated by the OSS/BSS.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
moscatelli
committed
pnfName:
description: >
Name of the PNF
type: string
pnfdId:
description: >
Identifier of the PNFD on which the PNF is based.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
moscatelli
committed
pnfProfileId:
description: >
Identifier of related PnfProfile in the NSD on which the PNF is based.
$ref: "#/definitions/IdentifierInNsd"
moscatelli
committed
cpData:
description: >
Address assigned for the PNF external CP(s).
type: array
items:
$ref: "#/definitions/PnfExtCpData"
PnfExtCpData:
description: >
This type represents the configuration data on the external CP of the PNF.
It shall comply with the provisions defined in
Table 6.5.3.16-1.
type: object
required:
- cpProtocolData
properties:
moscatelli
committed
description: >
Identifier of the CP. Shall be present for existing CP.
$ref: "#/definitions/IdentifierInPnf"
moscatelli
committed
cpdId:
description: >
Identifier of the Connection Point Descriptor (CPD) for this CP. Shall be present for new CP.
$ref: "#/definitions/IdentifierInNsd"
moscatelli
committed
cpProtocolData:
description: >
Address assigned for this CP.
type: array
items:
Samir Medjiah
committed
$ref: "#/definitions/CpProtocolData"
moscatelli
committed
ModifyPnfData:
description: >
This type specifies an PNF to be modified in the NS instance.
It shall comply with the provisions defined in
Table 6.5.3.15-1.
type: object
required:
- pnfId
properties:
pnfId:
description: >
Identifier of the PNF. This identifier is allocated by the OSS/BSS.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
moscatelli
committed
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
pnfName:
description: >
Name of the PNF.
type: string
cpData:
description: >
Address assigned for the PNF external CP(s).
type: array
items:
$ref: "#/definitions/PnfExtCpData"
AffectedVirtualLink:
description: >
This type provides information about added, deleted, modified and
temporary VLs.
type: object
required:
- id
- virtualLinkDescId
- changeType
- networkResource
properties:
id:
description: >
Identifier of the virtual link instance, identifying the applicable
"vnfVirtualLinkResourceInfo" entry in the "VnfInstance" data type.
$ref: "#/definitions/IdentifierInVnf"
moscatelli
committed
virtualLinkDescId:
description: >
Identifier of the related VLD in the VNFD.
$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
moscatelli
committed
changeType:
description: >
Signals the type of change. Permitted values:
* ADDED
* REMOVED
* MODIFIED
* TEMPORARY
* LINK_PORT_ADDED
* LINK_PORT_REMOVED
For a temporary resource, an AffectedVirtualLink structure exists as
long as the temporary resource exists.
moscatelli
committed
enum:
- ADDED
- REMOVED
- MODIFIED
- TEMPORARY
- LINK_PORT_ADDED
- LINK_PORT_REMOVED
networkResource:
moscatelli
committed
Reference to the VirtualNetwork resource. Detailed information is
(for new and modified resources) or has been (for removed
resources) available from the VIM.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
moscatelli
committed
metadata:
description: >
Metadata about this resource.
The content of this attribute shall be a copy of the content of the
"metadata" attribute of the VnfVirtualLinkResourceInfo structure.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
moscatelli
committed
AffectedVirtualStorage:
moscatelli
committed
This type provides information about added, deleted, modified and
temporary virtual storage resources.
type: object
required:
moscatelli
committed
- id
- virtualStorageDescId
- changeType
- storageResource
moscatelli
committed
id:
moscatelli
committed
Identifier of the storage instance, identifying the applicable
"virtualStorageResourceInfo" entry in the "VnfInstance" data type.
$ref: "#/definitions/IdentifierInVnf"
moscatelli
committed
virtualStorageDescId:
moscatelli
committed
Identifier of the related VirtualStorage descriptor in the VNFD.
$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
moscatelli
committed
changeType:
moscatelli
committed
Signals the type of change. Permitted values:
* ADDED
* REMOVED
* MODIFIED
* TEMPORARY
For a temporary resource, an AffectedVirtualStorage structure exists
as long as the temporary resource exists.
type: string
enum:
- ADDED
- REMOVED
- MODIFIED
- TEMPORARY
storageResource:
description: >
Reference to the VirtualStorage resource. Detailed information is
(for new and modified resources) or has been (for removed
resources) available from the VIM.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
moscatelli
committed
metadata:
moscatelli
committed
Metadata about this resource.
The content of this attribute shall be a copy of the content of the
"metadata" attribute of the VirtualStorageResourceInfo structure.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
AffectedVnf:
description: >
This type provides information about added, deleted and modified VNFs.
It shall comply with the provisions in Table 6.5.3.2-1.
type: object
required:
- vnfInstanceId
- vnfdId
moscatelli
committed
- vnfProfileId
- vnfName
- changeType
- changeResult
properties:
vnfInstanceId:
description: >
Identifier of the VNF instance.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
vnfdId:
description: >
Identifier of the VNFD of the VNF Instance.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
vnfProfileId:
description: >
Identifier of the VNF profile of the NSD.
$ref: "#/definitions/IdentifierInNsd"
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
vnfName:
description: >
Name of the VNF Instance.
type: string
changeType:
description: >
Signals the type of change
Permitted values:
- ADD
- REMOVE
- INSTANTIATE
- TERMINATE
- SCALE
- CHANGE_FLAVOUR
- HEAL
- OPERATE
- MODIFY_INFORMATION
- CHANGE_EXTERNAL_VNF_CONNECTIVITY
type: string
enum:
- ADD
moscatelli
committed
- REMOVE
- INSTANTIATE
- TERMINATE
- SCALE
- CHANGE_FLAVOUR
- HEAL
moscatelli
committed
- OPERATE
- MODIFY_INFORMATION
- CHANGE_EXTERNAL_VNF_CONNECTIVITY
changeResult:
description: >
Signals the result of change identified by the
"changeType" attribute.
Permitted values:
- COMPLETED
- ROLLED_BACK
- FAILED
type: string
enum:
- COMPLETED
moscatelli
committed
- ROLLED_BACK
- FAILED
changedInfo:
description: >
Information about the changed VNF instance
rameshnaraya
committed
information, including VNF configurable properties,if applicable.
When the "changedInfo" attribute is present,