Newer
Older
# Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt
definitions:
VnfInstance:
description: >
This type represents a VNF instance.
* NOTE 1: Modifying the value of this attribute shall not be performed when conflicts exist
between the previous and the newly referred VNF package, i.e. when the new VNFD is
changed with respect to the previous VNFD in other aspects than merely referencing
to other VNF software images. In order to avoid misalignment of the VnfInstance with
the current VNF's on-boarded VNF package, the values of attributes in the VnfInstance
that have corresponding attributes in the VNFD shall be kept in sync with the values in the VNFD.
* NOTE 2: ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD based on TOSCA specifications.
* NOTE 3: VNF configurable properties are sometimes also referred to as configuration parameters
applicable to a VNF. Some of these are set prior to instantiation and cannot be modified
if the VNF is instantiated, some are set prior to instantiation (are part of initial configuration)
and can be modified later, and others can be set only after instantiation.
The applicability of certain configuration may depend on the VNF and the required operation of
the VNF at a certain point in time.
* NOTE 4: Upon creation of the VnfInstance structure, the VNFM shall create and initialize all child
attributes of "vnfConfigurableProperties", "metadata" and "extensions" that were declared
in the VNFD with a defined initial value. The defined initial values can be declared in the VNFD,
and/or, in case of "metadata", obtained from the "CreateVnfRequest" structure. Child attributes of
"vnfConfigurableProperties", "metadata" and "extensions" that have no defined initial value shall
not be created, in order to be consistent with the semantics of the JSON Merge Patch method
(see IETF RFC 7396) that interprets null values as deletion request.
* NOTE 5: It is possible to have several ExtManagedVirtualLinkInfo for the same VNF internal VL in case
of a multi-site VNF spanning several VIMs. The set of ExtManagedVirtualLinkInfo corresponding
to the same VNF internal VL shall indicate so by referencing to the same VnfVirtualLinkDesc
and externally-managed multi-site VL instance (refer to clause 5.5.3.5).
* NOTE 6: Even though externally-managed internal VLs are also used for VNF-internal connectivity,
they shall not be listed in the "vnfVirtualLinkResourceInfo" attribute as this would be redundant.
type: object
required:
- id
- vnfdId
- vnfProvider
- vnfProductName
- vnfSoftwareVersion
- vnfdVersion
- instantiationState
Giacomo Bernini
committed
- _links
properties:
id:
description: >
Identifier of the VNF instance.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
vnfInstanceName:
description: >
Name of the VNF instance.
This attribute can be modified with the PATCH method.
type: string
vnfInstanceDescription:
description: >
Human-readable description of the VNF instance.
This attribute can be modified with the PATCH method.
type: string
vnfdId:
description: >
Identifier of the VNFD on which the VNF instance is based. See note 1.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
vnfProvider:
description: >
Provider of the VNF and the VNFD. The value is copied from the VNFD.
type: string
vnfProductName:
description: >
Name to identify the VNF Product. The value is copied from the VNFD.
type: string
vnfSoftwareVersion:
description: >
Software version of the VNF. The value is copied from the VNFD.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Version"
vnfdVersion:
description: >
Identifies the version of the VNFD. The value is copied from the VNFD.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Version"
vnfConfigurableProperties:
description: >
Additional VNF-specific attributes that provide the current values
of the configurable properties of the VNF instance.
These attributes represent values that are stored persistently in
the VnfInstance structure and that correspond to configuration
parameters of the VNF instance.
Modifying these attributes affects the configuration of the VNF
instance either directly (if the VNF instance is in INSTANTIATED
state at the time of the modification) or as part of the subsequent
VNF instantiation operation (if the VNF instance is in NOT_INSTANTIATED
state at the time of the modification).
Configurable properties referred in these attributes shall be declared
in the VNFD.
The declaration of configurable properties in the VNFD can optionally
contain the specification of initial values. See note 2, note 3 and note 4. The VNFM
shall reject requests to write configurable properties that are not declared in the
VNFD with a "422 Unprocessable entity" error response as defined in clause 6.4 of ETSI GS NFV SOL 013.
These configurable properties include the following standard attributes,
which are declared in the VNFD if auto-scaling and/or auto-healing are
supported by the VNF:
- isAutoscaleEnabled: If present, the VNF supports auto-scaling. If set
to true, auto-scaling is currently enabled. If set to false, auto-scaling
is currently disabled.
- isAutohealEnabled: If present, the VNF supports auto-healing. If set
to true, auto-healing is currently enabled. If set to false, auto-healing
is currently disabled.
These configurable properties can be initialized with default values from the VNFD (see note 4).
Configurable properties can be modified with values passed in the request structures of certain
LCM operations, such as the InstantiateVnfRequest structure.
Further, these configurable properties can be created, modified or deleted with the PATCH method.
In addition, the provisions in clause 5.7 shall apply.
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
instantiationState:
description: >
The instantiation state of the VNF.
type: string
enum:
- NOT_INSTANTIATED
- INSTANTIATED
instantiatedVnfInfo:
description: >
Information specific to an instantiated VNF instance. This attribute
shall be present if the instantiateState attribute value is
INSTANTIATED.
type: object
required:
- flavourId
- vnfState
- extCpInfo
properties:
flavourId:
description: >
Identifier of the VNF deployment flavour applied to this VNF instance.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
vnfState:
description: >
The state of the VNF instance.
$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfOperationalStateType"
scaleStatus:
description: >
Scale status of the VNF, one entry per aspect. Represents for every
scaling aspect how "big" the VNF has been scaled w.r.t. that aspect.
This attribute shall be present if the VNF supports scaling.
See clause B.2 for an explanation of VNF scaling.
type: array
items:
$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ScaleInfo"
Giacomo Bernini
committed
maxScaleLevels:
description: >
Maximum allowed scale levels of the VNF, one entry per aspect.
This attribute shall be present if the VNF supports scaling.
type: array
items:
$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ScaleInfo"
extCpInfo:
description: >
Information about the external CPs exposed by the VNF instance. When trunking is enabled, the list of
entries includes both, external CPs corresponding to parent ports of a trunk, and external CPs associated
to sub-ports of a trunk.
type: array
minItems: 1
items:
$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfExtCpInfo"
vipCpInfo:
description: >
VIP CPs that are part of the VNF instance. Shall be present when that particular VIP
CP of the VNFC instance is associated to an external CP of the VNF instance.
May be present otherwise.
type: array
items:
$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VipCpInfo"
extVirtualLinkInfo:
description: >
Information about the external VLs the VNF instance is connected to.
type: array
items:
$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ExtVirtualLinkInfo"
extManagedVirtualLinkInfo:
description: >
Information about the externally managed internal VLs of the VNF instance. See note 5 and note 6.
It is possible to have several ExtManagedVirtualLinkInfo for the same VNF internal VL in case of a
multi-site VNF spanning several VIMs. The set of ExtManagedVirtualLinkInfo corresponding to the same
VNF internal VL shall indicate so by referencing to the same VnfVirtualLinkDesc and externally-managed
multi-site VL instance (refer to clause 5.5.3.5).
Even though externally-managed internal VLs are also used for VNF-internal connectivity,
they shall not be listed in the "vnfVirtualLinkResourceInfo" attribute as this would be redundant.
monitoringParameters:
description: >
Active monitoring parameters.
type: array
items:
$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/MonitoringParameter"
localizationLanguage:
description: >
Information about localization language of the VNF (includes e.g.
strings in the VNFD). The localization languages supported by a VNF
can be declared in the VNFD, and localization language selection can
take place at instantiation time.
The value shall comply with the format defined in IETF RFC 5646.
type: string
vnfcResourceInfo:
description: >
Information about the virtualised compute and storage resources used
by the VNFCs of the VNF instance.
type: array
items:
vnfVirtualLinkResourceInfo:
description: >
Information about the virtualised network resources used by the VLs
of the VNF instance. See note 6.
Even though externally-managed internal VLs are also used for VNF-internal connectivity,
they shall not be listed in the "vnfVirtualLinkResourceInfo" attribute as this would be redundant.
vnfVirtualStorageResourceInfo:
description: >
Information on the virtualised storage resource(s) used as storage for the VNF instance.
type: array
items:
vnfcInfo:
description: >
Information about the VNFC instances.
type: array
items:
$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfcInfo"
metadata:
description: >
Additional VNF-specific attributes that provide metadata describing the VNF instance.
These attributes represent values that are stored persistently in the VnfInstance
structure for consumption by functional blocks that invoke the VNF lifecycle management
interface. They are not consumed by the VNFM, or the lifecycle management scripts.
Modifying the values of these attributes has no effect on the VNF instance, it only
affects the information represented in the VnfInstance structure.
Metadata that VNF provider foresees shall be declared in the VNFD. The declaration of metadata in
the VNFD can optionally contain the specification of initial values. See note 2 and note 4. The VNFM shall
accept requests to write metadata that are not are declared in the VNFD.
These attributes can be initialized with default values from VNFD (see note 4) and/or with values
passed in the CreateVnfRequest structure (see clause 5.5.2.3).
These attributes can be created, modified or removed with the PATCH method.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
extensions:
description: >
Additional VNF specific attributes that affect the lifecycle management of this VNF instance.
These attributes represent values that are stored persistently in the VnfInstance structure for
consumption by the VNFM, or by the lifecycle management scripts during the execution of VNF
lifecycle management operations.
All extensions that are allowed for the VNF are declared in the VNFD. The declaration of an
extension in the VNFD contains information on whether its presence is optional or required,
and optionally can specify an initial value. See note 2 and note 4. The VNFM shall reject
requests to write extension attributes that are not declared in the VNFD with a "422 Unprocessable
entity" error response as defined in clause 6.4 of ETSI GS NFV SOL 013.
Modifying the values of these attributes has no direct effect on the VNF instance; however, the
modified attribute values can be considered during subsequent VNF lifecycle management operations,
which means that the modified values can indirectly affect the configuration of the VNF instance.
These attributes can be initialized with default values from the VNFD (see note 4).
These attributes can be modified with values passed in the request structures of certain LCM operations,
such as the InstantiateVnfRequest structure.
Further, these attributes can be created, modified or deleted with the PATCH method.
In addition, the provisions in clause 5.7 shall apply.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
_links:
description: >
Links to resources related to this resource.
type: object
required:
- self
properties:
self:
description: URI of this resource.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
indicators:
description: Indicators related to this VNF instance, if applicable.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
instantiate:
description: >
Link to the "Instantiate VNF task" resource, if the related operation
is possible based on the current status of this VNF instance
resource (i.e. VNF instance in NOT_INSTANTIATED state).
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
terminate:
description: >
Link to the "Terminate VNF task" resource, if the related operation
is possible based on the current status of this VNF instance
resource (i.e. VNF instance is in INSTANTIATED state).
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
scale:
description: >
Link to the "Scale VNF task" resource, if the related operation is
supported for this VNF instance, and is possible based on the
current status of this VNF instance resource (i.e. VNF instance
is in INSTANTIATED state).
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
scaleToLevel:
description: >
Link to the "Scale VNF to Level task" resource, if the related
operation is supported for this VNF instance, and is possible
based on the current status of this VNF instance resource
(i.e. VNF instance is in INSTANTIATED state).
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
changeFlavour:
description: >
Link to the "Change VNF flavour task" resource, if the related
operation is supported for this VNF instance, and is possible
based on the current status of this VNF instance resource
(i.e. VNF instance is in INSTANTIATED state).
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
heal:
description: >
Link to the "Heal VNF task" resource, if the related operation is
supported for this VNF instance, and is possible based on the
current status of this VNF instance resource
(i.e. VNF instance is in INSTANTIATED state).
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
operate:
description: >
Link to the "Operate VNF task" resource, if the related operation is
supported for this VNF instance, and is possible based on the
current status of this VNF instance resource
(i.e. VNF instance is in INSTANTIATED state).
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
changeExtConn:
description: >
Link to the "Change external VNF connectivity task" resource, if the related
operation is possible based on the current status of this VNF
instance resource (i.e. VNF instance is in INSTANTIATED state).
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
createSnapshot:
description: >
Link to the "Create VNF snapshot task" resource, if the related operation is
supported for this VNF instance and is possible based on the current status of
this VNF instance resource (i.e., VNF instance is in INSTANTIATED state).
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
revertToSnapshot:
description: >
Link to the "Revert to VNF snapshot task" resource, if the related operation is
supported for this VNF instance and is possible based on the current status of this
VNF instance resource (i.e., VNF instance is in INSTANTIATED state).
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
InstantiateVnfRequest:
description: >
This type represents request parameters for the "Instantiate VNF" operation.
* NOTE: The indication of externally-managed internal VLs is needed in case networks have been
pre-configured for use with certain VNFs, for instance to ensure that these networks have certain
properties such as security or acceleration features, or to address particular network topologies.
The present document assumes that externally-managed internal VLs are managed by the NFVO and
created towards the VIM.
type: object
required:
- flavourId
flavourId:
description: >
Identifier of the VNF deployment flavour to be instantiated.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
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 VNFD is instantiated.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
extVirtualLinks:
description: >
Information about external VLs to connect the VNF to.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ExtVirtualLinkData"
extManagedVirtualLinks:
description: >
Information about external VLs to connect the VNF to. See note.
type: array
items:
localizationLanguage:
description: >
Localization language of the VNF to be instantiated. The value shall
comply with the format defined in IETF RFC 5646.
type: string
additionalParams:
description: >
Additional input parameters for the instantiation process, specific
to the VNF being instantiated, as declared in the VNFD as part of
"InstantiateVnfOpConfig".
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
extensions:
description: >
If present, this attribute provides modifications to the default values, as obtained from the VNFD, of the
"extensions" attribute in "VnfInstance", as defined in clause 5.5.2.2. Provisions for handling extensions
during the operation are defined in clause 5.4.4.3.1.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
Giacomo Bernini
committed
vnfConfigurableProperties:
description: >
If present, this attribute provides modifications to the default values, as obtained from the VNFD, of the
"vnfConfigurableProperties" attribute in "VnfInstance", as defined in clause 5.5.2.2.
Provisions for handling configurable properties during the operation are defined in clause 5.4.4.3.1.
Giacomo Bernini
committed
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
ChangeVnfFlavourRequest:
description: >
This type represents request parameters for the "Change VNF flavour" operation.
* NOTE: The indication of externally-managed internal VLs is needed in case networks have been
pre-configured for use with certain VNFs, for instance to ensure that these networks have certain
properties such as security or acceleration features, or to address particular network topologies.
The present document assumes that externally-managed internal VLs are managed by the NFVO and
created towards the VIM.
type: object
required:
- newFlavourId
properties:
newFlavourId:
description: >
Identifier of the VNF deployment flavour to be instantiated.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
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 VNFD is instantiated.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
extVirtualLinks:
description: >
Information about external VLs to connect the VNF to.
type: array
items:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ExtVirtualLinkData"
extManagedVirtualLinks:
description: >
Information about external VLs to connect the VNF to. See note.
additionalParams:
description: >
Additional input parameters for the instantiation process, specific
to the VNF being instantiated, as declared in the VNFD as part of
"InstantiateVnfOpConfig".
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
extensions:
description: >
If present, this attribute provides modifications to the values of the "extensions" attribute in "VnfInstance",
as defined in clause 5.5.2.2. Provisions for handling extensions during the operation, are defined in clause
5.4.7.3.1.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
vnfConfigurableProperties:
description: >
If present, this attribute provides modifications to the values of the “vnfConfigurableProperties” attribute in
"VnfInstance", as defined in clause 5.5.2.2. Provisions for handling VNF configurable properties during the
operation, are defined in clause 5.4.7.3.1.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
TerminateVnfRequest:
description: >
This type represents request parameters for the "Terminate VNF" operation.
* NOTE: In case of forceful termination, the VNF instance is terminated immediately.
If the VNF is still in service, this can adversely impact the network service,
and therefore, the EM needs to determine if forceful termination is applicable
in the particular situation.
type: object
required:
- terminationType
properties:
terminationType:
description: >
Indicates the type of termination is requested. See note.
Permitted values:
* FORCEFUL: The VNFM will shut down the VNF and release the resources immediately after accepting the request.
* GRACEFUL: The VNFM will first arrange to take the VNF out of service after accepting the request. Once the
operation of taking the VNF out of service finishes (irrespective of whether it has succeeded or failed) or
once the timer value specified in the "gracefulTerminationTimeout" attribute expires, the VNFM will shut down
the VNF and release the resources.
type: string
enum:
- FORCEFUL
- GRACEFUL
gracefulTerminationTimeout:
description: >
This attribute is only applicable in case of graceful termination. It defines the time to wait for the VNF to be
taken out of service before shutting down the VNF and releasing the resources.
The unit is seconds. If not given and the "terminationType" attribute is set to "GRACEFUL", it is expected that
the VNFM waits for the successful taking out of service of the VNF, no matter how long it takes, before shutting
down the VNF and releasing the resources.
type: integer
additionalParams:
description: >
Additional parameters passed by the NFVO as input to the termination
process, specific to the VNF being terminated, as declared in the
VNFD as part of "TerminateVnfOpConfig".
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
HealVnfRequest:
type: object
properties:
vnfcInstanceId:
description: >
List of identifiers of VNFC instances for which a healing action is requested. Each identifier references the
"id" attribute in a "VnfcInfo" structure. Cardinality can be "0" to denote that the request applies to the
whole VNF and not a specific VNFC instance.
type: array
items:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
cause:
description: >
Indicates the reason why a healing procedure is required.
type: string
additionalParams:
description: >
Additional parameters passed by the NFVO as input to the healing
process, specific to the VNF being healed, as declared in the VNFD
as part of "HealVnfOpConfig".
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
healScript:
description: >
Provides link to a script that should be executed as part
of the healing action or a set of rules for healing procedure.
type: string
OperateVnfRequest:
description: >
This type represents request parameters for the "Operate VNF" operation.
* NOTE: The "stopType" and "gracefulStopTimeout" attributes shall be absent, when the "changeStateTo"
attribute is equal to "STARTED". The "gracefulStopTimeout" attribute shall be present, when the
"changeStateTo" is equal to "STOPPED" and the "stopType" attribute is equal to "GRACEFUL".
The "gracefulStopTimeout" attribute shall be absent, when the "changeStateTo" attribute is equal to
"STOPPED" and the "stopType" attribute is equal to "FORCEFUL". The request shall be treated as if
the "stopType" attribute has been set to "FORCEFUL", when the "changeStateTo" attribute is equal
to "STOPPED" and the "stopType" attribute is absent.
type: object
required:
- changeStateTo
properties:
vnfcInstanceId:
description: >
List of identifiers of VNFC instances. Each identifier references the "id" attribute in a "VnfcInfo" structure.
Cardinality can be "0" to denote that the request applies to the whole VNF and not a specific VNFC instance.
type: array
items:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
changeStateTo:
description: >
The desired operational state (i.e. started or stopped) to change
the VNF to.
$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfOperationalStateType"
stopType:
description: >
It signals whether forceful or graceful stop is requested. See note
type: string
enum:
- FORCEFUL
- GRACEFUL
gracefulStopTimeout:
description: >
The time interval (in seconds) to wait for the VNF to be taken out of service during graceful stop,
additionalParams:
description: >
Additional parameters passed by the NFVO as input to the process,
specific to the VNF of which the operation status is changed, as
declared in the VNFD as part of "OperateVnfOpConfig".
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
ChangeExtVnfConnectivityRequest:
description: >
This type represents request parameters for the
"Change external VNF connectivity" operation to modify the external
connectivity of a VNF instance.
type: object
required:
- extVirtualLinks
extVirtualLinks:
Information about external VLs to change (e.g. connect the VNF to).
type: array
items:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ExtVirtualLinkData"
additionalParams:
description: >
Additional input parameters for the instantiation process, specific
to the VNF being instantiated, as declared in the VNFD as part of
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
description: >
This type represents request parameters for the "Change current VNF package" operation to replace the VNF package
on which a VNF instance is based.
* NOTE: The indication of externally-managed internal VLs is needed in case networks have been
pre-configured for use with certain VNFs, for instance to ensure that these networks have certain
properties such as security or acceleration features, or to address particular network topologies.
The present document assumes that externally-managed internal VLs are managed by the NFVO and created
towards the VIM.
type: object
required:
- vnfdId
properties:
vnfdId:
description: >
Identifier of the VNFD which defines the destination VNF Package for the change.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
extVirtualLinks:
description: >
Information about external VLs to connect the VNF to. Entries in the list that are unchanged need not be
supplied as part of this request.
type: array
items:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ExtVirtualLinkData"
extManagedVirtualLinks:
description: >
Information about internal VLs that are managed by other entities than the VNFM. See note.
additionalParams:
description: >
Additional parameters passed by the EM as input to the process, specific to the VNF of which the underlying
VNF package is changed, as declared in the VNFD as part of "ChangeCurrentVnfPkgOpConfig".
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
extensions:
descriptions: >
If present, this attribute provides modifications to the values of the "extensions" attribute in "VnfInstance",
as defined in clause 5.5.2.2. Provisions for handling extensions during the operation, and needed passed
parameter values in case of conflicts, are defined in clause 5.4.11a.3.1.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
vnfConfigurableProperties:
description: >
If present, this attribute provides modifications to the values of the “vnfConfigurableProperties” attribute
in "VnfInstance", as defined in clause 5.5.2.2. Provisions for handling VNF configurable properties during the
operation, and needed passed parameter values in case of conflicts, are defined in clause 5.4.11a.3.1.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
VnfInfoModificationRequest:
description: >
This type represents attribute modifications for an "Individual VNF instance" resource,
i.e. modifications to a resource representation based on the "VnfInstance" data type.
The attributes of "VnfInstance" that can be modified according to the provisions in clause 5.5.2.2
are included in the "VnfInfoModificationRequest" data type.
type: object
properties:
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
vnfdId:
description: >
New value of the "vnfdId" attribute in "VnfInstance". The value "null" is not permitted.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
vnfConfigurableProperties:
description: >
Modifications of the "vnfConfigurableProperties" attribute in "VnfInstance".
If present, these modifications shall be applied according to the rules of
JSON Merge PATCH (see IETF RFC 7396 [15]).
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
metadata:
description: >
Modifications of the "metadattametadata" attribute in "VnfInstance".
If present, these modifications shall be applied according to the rules of
JSON Merge PATCH (see IETF RFC 7396 [15]).
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
extensions:
description: >
Modifications of the "extensions" attribute in "VnfInstance".
If present, these modifications shall be applied according to the rules of
JSON Merge PATCH (see IETF RFC 7396 [15]).
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
vnfcInfoModifications:
description: >
Modifications of certain entries in the "vnfcInfo" attribute array in the
"instantiatedVnfInfo" attribute of "VnfInstance" to be used as "newList" as defined below this table.
The following provisions shall apply when modifying an attribute that is an array of objects of type
"VnfcInfo" by supplying an array of objects of type "VnfcInfoModifications".
Assumptions:
1) "oldList" is the "VnfcInfo" array to be modified and "newList" is the "VnfcInfoModifications"
array that contains the changes.
2) "oldEntry" is an entry in "oldList" and "newEntry" is an entry in "newList".
3) A "newEntry" has a "corresponding entry" if there exists an "oldEntry" that has the same content
of the "id" attribute as the "newEntry"; a "newEntry" has no corresponding entry if no such "oldEntry" exists.
4) In any array of "VnfcInfo" resp. "VnfcInfoModifications" structures, the content of "id" is unique
(i.e. there are no two entries with the same content of "id").
Provisions:
1) For each "newEntry" in "newList" that has no corresponding entry in "oldList",
the "oldList" array shall be modified by adding that "newEntry".
2) For each "newEntry" in "newList" that has a corresponding "oldEntry" in "oldList",
the value of "oldEntry" shall be updated with the content of "newEntry" as specified for
the data type of "newEntry (refer to clause 5.5.3.24 for the data type "VnfcInfoModifications").
type: array
items:
Giacomo Bernini
committed
$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfcInfoModifications"
description: >
This type represents request parameters for the "Create VNF Snapshot" operation.
type: object
required:
- vnfSnapshotResId
properties:
description: >
Identifier of the individual VNF snapshot resource to which the VNF Snapshot is to be associated.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
vnfcInstanceId:
description: >
Identifier of the VNFC instance to be snapshotted. Each identifier references the "id" attribute in a
"VnfcInfo" structure. If this attribute is provided, only a snapshot of the referred VNFC instance shall
be created.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
additionalParams:
description: >
Additional input parameters for the snapshot creation process, specific for the VNF being “snapshotted”,
as declared in the VNFD as part of "CreateSnapshotVnfOpConfig".
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
userDefinedData:
description: >
User defined data for the VNF snapshot.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
description: >
This type represents request parameters for the "Revert-to VNF Snapshot" operation.
Identifier of the “individual VNF snapshot” resource with the information of the VNF snapshot to be reverted to.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
List of identifiers of the VNFC instance to be reverted. Each identifier references the "id" attribute in a
"VnfcInfo" structure. Shall be present if the request is for reverting a specific VNFC instance.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
Identifier of the VNFC snapshot information with the information of the VNFC snapshot to be reverted to.
Shall only be present if the "vnfcInstanceId" is present.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
Additional input parameters for the revert to VNF snapshot process, specific for the VNF being “reverted”,
as declared in the VNFD as part of “RevertToSnapshotVnfOpConfig”.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
CreateVnfSnapshotInfoRequest:
description: |
This type represents request parameters for the creation of an "Individual VNF snapshot" resource which can be
populated with content obtained by invoking the "Create VNF snapshot" LCM operation or extracted from a VNF
snapshot package.
* NOTE: The present attribute shall be provided if the "Individual VNF snapshot" resource
is requested to be created and be filled from a VNF snapshot package extraction.
type: object
properties:
vnfSnapshotPkgId:
description: |
Identifier of the VNF snapshot package information held by the NFVO. See note.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
description: >
This type represents an individual VNF snapshot resource.
type: object
required:
- id
properties:
id:
description: >
Identifier of the individual VNF snapshot resource. This identifier is allocated by the VNFM.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
vnfSnapshotPkgId:
description: |
Identifier of the VNF snapshot package information held by the EM. Shall be present when the
“Individual VNF snapshot" resource is created from a VNF snapshot package extraction.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
vnfSnapshot:
description: >
Information about the VNF snapshot, content and/or references to its content. Shall be present when the
individual VNF snapshot resource is associated to a VNF snapshot created via the corresponding "Create VNF
snapshot" task resource or extracted from a VNF snapshot package.
$ref: '#/definitions/VnfSnapshot'
_links:
description: >
Links to resources related to this resource.
type: object
required:
- self
properties:
self:
description: >
URI of this resource.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
takenFrom:
description: >
Link to the VNF instance from which this snapshot was taken. Shall be present when the "Individual VNF
snapshot" resource is associated to a VNF snapshot created via the corresponding "Create VNF snapshot"
task resource.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
VnfSnapshot:
description: >
This type represents a VNF snapshot.
type: object
required:
- id
- vnfInstanceId
- triggeredAt
- vnfdId
- vnfInfo
- vnfcSnapshots
properties:
id:
description: >
Identifier of the VNF Snapshot. This identifier is allocated by the VNFM.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
vnfInstanceId:
description: >
Identifier of the snapshotted VNF instance.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
Timestamp indicating when the VNF snapshot creation has been started by the VNFM.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime"
Timestamp indicating when the VNF snapshot has been completed by the VNFM.
Shall be present once the VNF snapshot creation has been completed.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime"
vnfdId:
description: >
Identifier of the VNFD in use at the time the snapshot of the VNF instance has been created.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
VNF Instance information of the snapshotted VNF instance. This is a copy of the individual VNF instance resource.
$ref: '#/definitions/VnfInstance'
vnfcSnapshots:
description: >
Information about VNFC snapshots constituting this VNF snapshot.
type: array
items:
$ref: '#/definitions/VnfcSnapshotInfo'
userDefinedData:
description: >
User defined data for the VNF snapshot.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
VnfcSnapshotInfo:
description: >
This type represents a VNFC snapshot.
* NOTE 1: The identifier of the compute snapshot resource is assigned during creation of a VNFC
snapshot being returned from the VIM as output data in the response message of the individual
resource operations. This attribute shall only be present for a VNFC snapshot that has been
newly created by the VNFM as a result of the "Create VNF snapshot task".
NOTE 2: The identifier of the storage snapshot resource is assigned during creation of a VNFC snapshot
being returned from the VIM as output data in the response message of the individual resource
operations. This attribute shall only be present for a VNFC snapshot with an associated storage
resource and that has been newly created by the VNFM as a result of the "Create VNF snapshot task".
type: object
required:
- id
- vnfcInstanceId
- creationStartedAt
- vnfcResourceInfoId
properties:
id:
description: >
Identifier of the information held by the VNFM about a specific VNFC snapshot. This identifier is allocated by
the VNFM and is unique within the scope of a VNF snapshot.
The attribute also identifies the compute snapshot image associated
to this VNFC snapshot within the context of a referred VNF snapshot.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
vnfcInstanceId:
description: >
Identifier of the snapshotted VNFC instance.
The identifier references the "id" attribute in a "VnfcInfo" structure.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
Timestamp indicating when the VNF snapshot creation has been started by the VNFM.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime"
description: >
Timestamp indicating when the VNFC snapshot has been completed. Shall be present once the VNFC snapshot
creation has been completed by the VNFM.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime"
Reference to the "VnfcResourceInfo" structure in the "VnfInstance" structure that represents the resources of
the snapshotted VNFC instance. A snapshot of that structure is available in the "vnfInstance" attribute of the
"VnfSnapshot" structure.
$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfcInfo"
computeSnapshotResource:
description: >
Reference to a compute snapshot resource. See note 1.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ResourceHandle"
storageSnapshotResources:
description: >
Mapping of the storage resources associated to the VNFC with the storage snapshot resources.
type: object
required:
- storageResourceId
properties:
storageResourceId:
description: >
Reference to the "VirtualStorageResourceInfo" structure in the "VnfInstance" structure that represents
the virtual storage resource. The attribute also identifies the storage snapshot image
associated to this VNFC snapshot within the context of a referred VNF snapshot
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
storageSnapshotResource:
description: >
Reference to a storage snapshot resource. See note 2.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ResourceHandle"
userDefinedData:
description: >
User defined data for the VNF snapshot.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
StopType:
description: >
The enumeration StopType.
* FORCEFUL: The VNFM will stop the VNF instance or VNFC instance(s) immediately after accepting the request.
* GRACEFUL: The VNFM will first arrange to take the VNF instance or VNFC instance(s) 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 instance or VNFC instance(s).
type: string
enum:
- FORCEFUL
description: >
This type represents an externally-managed internal VL.
* NOTE: The information about the VIM connection referenced by the VIM connection id is known to the VNFM.
Moreover, the identifier of the VIM connection provides scope to the resourceId.
type: object
required:
- id
- virtualLinkDescId
- resourceId
properties:
id:
description: >
The identifier of the externally-managed internal VL instance. The
identifier is assigned by the NFV-MANO entity that manages this VL
instance.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
vnfVirtualLinkDescId:
description: >
The identifier of the VLD in the VNFD for this VL.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
vimConnectionId:
description: >
Identifier of the VIM connection to manage this resource. This
attribute shall only be supported and present if VNF-related
resource management in direct mode is applicable. See note.
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
resourceProviderId:
description: >
Identifies the entity responsible for the management of this
resource. This attribute shall only be supported and present if
VNF-related resource management in indirect mode is applicable. The
identification scheme is outside the scope of the present document.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
resourceId:
description: >
The identifier of the resource in the scope of the VIM or the
resource provider.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVim"
ExtManagedVirtualLinkInfo:
type: object
required:
- id
- vnfVirtualLinkDescId
- networkResource
properties:
id:
description: >
Identifier of the externally-managed internal VL and the related
externally-managed VL information instance.
The identifier is assigned by the NFV-MANO entity that manages this
VL instance.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
vnfVirtualLinkDescId:
description: >
Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
vnfdId:
description: >
Identifier of the VNFD.
Shall be present in case the value differs from the vnfdId attribute of the VnfInstance (e.g. during a "Change
current VNF package" operation or due to its final failure).
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
networkResource:
description: >
Reference to the VirtualNetwork resource providing this VL.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ResourceHandle"
vnfLinkPorts:
description: >
Link ports of this VL.
type: array
items:
$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfLinkPortInfo"
VnfcResourceInfo:
description: >
This type represents the information on virtualised compute and storage
resources used by a VNFC in a VNF instance.
* NOTE 1: ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD based on TOSCA specifications.
* NOTE 2: A VNFC CP is "connected to" an external CP if the VNFC CP is connected to an internal VL that
exposes an external CP. A VNFC CP is "exposed as" an external CP if it is connected directly
to an external VL.
* NOTE 3: The information can be omitted because it is already available as part of the external CP information.
type: object
required:
- id
- vduId
- computeResource
properties:
id:
description: >
Identifier of this VnfcResourceInfo instance.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
vduId:
description: >
Reference to the applicable VDU in the VNFD. See note 1.
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
vnfdId:
description: >
Identifier of the VNFD.
Shall be present in case the value differs from the vnfdId attribute of the VnfInstance (e.g. during a "Change
current VNF package" operation or due to its final failure).
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
computeResource:
description: >
Reference to the VirtualCompute resource.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ResourceHandle"
storageResourceIds:
description: >
References to the VirtualStorage resources. The value refers to a
VirtualStorageResourceInfo item in the VnfInstance.
type: array
items:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
reservationId:
description: >
The reservation identifier applicable to the resource. It shall be
present when an applicable reservation exists.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
vnfcCpInfo:
description: >
All the CPs of the VNFC instance.
type: array
items:
type: object
required:
- id
- cpdId
properties:
id:
description: >
Identifier of this VNFC CP instance and the associated array
entry.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
cpdId:
description: >
Identifier of the VDU CPD, cpdId, in the VNFD. See note 1.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
vnfExtCpId:
description: >
Identifier of the related external CP. Shall be present when the VNFC CP is exposed as an external CP of
the VNF instance or connected to an external CP of the VNF instance (see note 2) and shall be absent otherwise.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
cpProtocolInfo:
description: >
Network protocol information for this CP. May be omitted if the VNFC CP is exposed as an external CP.
The information can be omitted because it is already available as part of the external CP information.
type: array
items:
$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/CpProtocolInfo"
vnfLinkPortId:
description: >
Identifier of the "VnfLinkPortInfo" structure in the "VnfVirtualLinkResourceInfo"
or "ExtManagedVirtualLinkInfo" structure. Shall be present if
the CP is associated to a link port on an internal VL (including externally-managed internal VL)
of the VNF instance and shall be absent otherwise.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
parentCpId:
description: >
Identifier of another VNFC CP instance that corresponds to the parent port
of a trunk that the present VNFC CP instance participates in.
Shall be provided if the present CP instance participates in a trunk as subport.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
metadata:
description: >
Metadata about this CP.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
metadata:
description: >
Metadata about this resource.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
VnfVirtualLinkResourceInfo:
description: >
This type represents the information that allows addressing a virtualised
resource that is used by an internal VL instance in a VNF instance.
type: object
required:
- id
- vnfVirtualLinkDescId
- networkResource
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
properties:
id:
description: >
Identifier of this VnfVirtualLinkResourceInfo instance.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
vnfVirtualLinkDescId:
description: >
Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
vnfdId:
description: >
Identifier of the VNFD.
Shall be present in case the value differs from the vnfdId attribute of the VnfInstance (e.g. during a "Change
current VNF package" operation or due to its final failure).
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
networkResource:
description: >
Reference to the VirtualNetwork resource.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ResourceHandle"
reservationId:
description: >
The reservation identifier applicable to the resource. It shall be
present when an applicable reservation exists.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
vnfLinkPorts:
description: >
Links ports of this VL.
Shall be present when the linkPort is used for external connectivity
by the VNF (refer to VnfLinkPortInfo).
May be present otherwise.
type: array
items:
$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfLinkPortInfo"
metadata:
description: >
Metadata about this resource.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
VirtualStorageResourceInfo:
description: >
This type represents the information that allows addressing a virtualised
resource that is used by a VNF instance.
type: object
required:
- id
- virtualStorageDescId
- storageResource
properties:
id:
description: >
Identifier of this VirtualStorageResourceInfo instance.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
virtualStorageDescId:
description: >
Identifier of the VirtualStorageDesc in the VNFD.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
vnfdId:
description: >
Identifier of the VNFD.
Shall be present in case the value differs from the vnfdId attribute of the VnfInstance (e.g. during a "Change
current VNF package" operation or due to its final failure).
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
storageResource:
description: >
Reference to the VirtualStorage resource.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ResourceHandle"
reservationId:
description: >
The reservation identifier applicable to the resource. It shall be
present when an applicable reservation exists.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
metadata:
description: >
Metadata about this resource.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
AffectedVnfc:
description: >
This type provides information about added, deleted, modified and
temporary VNFCs.
type: object
required:
- id
- vduId
- changeType
- computeResource
properties:
id:
description: >
Identifier of the Vnfc instance, identifying the applicable
"vnfcResourceInfo" entry in the "VnfInstance" data type.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
vduId:
description: >
Identifier of the related VDU in the VNFD.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
vnfdId:
description: >
Identifier of the VNFD.
Shall be present in case of a "change current VNF Package" to identify whether the affected VNFC instance is
associated to a VDU which is referred from the source or destination VNFD.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
changeType:
description: >
Signals the type of change. Permitted values:
* ADDED
* REMOVED
* MODIFIED
* TEMPORARY
For a temporary resource, an AffectedVnfc structure exists as long
as the temporary resource exists.
type: string
enum:
- ADDED
- REMOVED
- MODIFIED
- TEMPORARY
computeResource:
description: >
Reference to the VirtualCompute resource. Detailed information is
(for new and modified resources) or has been (for removed
resources) available from the VIM.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ResourceHandle"
metadata:
description: >
Metadata about this resource.
The content of this attribute shall be a copy of the content of the
"metadata" attribute of the VnfcResourceInfo structure.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
affectedVnfcCpIds:
description: >
Identifiers of CP(s) of the VNFC instance that were affected by the
change.
Shall be present for those affected CPs of the VNFC instance that
are associated to an external CP of the VNF instance.
May be present for further affected CPs of the VNFC instance.
type: array
items:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
addedStorageResourceIds:
description: >
References to VirtualStorage resources that have been added. Each
value refers to a VirtualStorageResourceInfo item in the
VnfInstance that was added to the VNFC. It shall be provided if at
least one storage resource was added to the VNFC.
type: array
items:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
removedStorageResourceIds:
description: >
References to VirtualStorage resources that have been removed.
The value contains the identifier of a VirtualStorageResourceInfo
item that has been removed from the VNFC, and might no longer exist
in the VnfInstance.
It shall be provided if at least one storage resource was removed
from the VNFC.
type: array
items:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
AffectedVirtualLink:
description: >
This type provides information about added, deleted, modified and
temporary VLs, and added or removed VNF link ports.
NOTE: When signalling the addition (LINK_PORT_ADDED) or removal (LINK_PORT_REMOVED) of VNF link ports,
the "networkResource" attribute refers to the affected virtual link instance, not the link port
instance. The resource handles of the affected VNF link ports can be found by dereferencing the
identifiers in the "vnfLinkPortIds" attribute.
type: object
required:
- id
- vnfVirtualLinkDescId
- changeType
- networkResource
properties:
id:
description: >
Identifier of the virtual link instance, identifying the applicable
"vnfVirtualLinkResourceInfo" or "extManagedVirtualLinkInfo" entry in the "VnfInstance" data type.
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
vnfVirtualLinkDescId:
description: >
Identifier of the related VLD in the VNFD.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
vnfdId:
description: >
Identifier of the VNFD.
Shall be present in case of a "change current VNF Package" to identify whether the affected VL instance is
associated to a VLD which is referred from the source or destination VNFD.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
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.
When signalling the addition (LINK_PORT_ADDED) or removal (LINK_PORT_REMOVED) of VNF link ports, the
"networkResource" attribute refers to the affected virtual link instance, not the link port instance.
The resource handles of the affected VNF link ports can be found by dereferencing the identifiers in the
"vnfLinkPortIds" attribute.
type: string
enum:
- ADDED
- REMOVED
- MODIFIED
- TEMPORARY
- LINK_PORT_ADDED
- LINK_PORT_REMOVED
networkResource:
description: >
Reference to the VirtualNetwork resource. Detailed information is
(for new and modified resources) or has been (for removed
resources) available from the VIM. See note.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ResourceHandle"
vnfLinkPortIds:
description: >
Identifiers of the link ports of the affected VL related to the change. Each identifier references a
"VnfLinkPortInfo" structure.
Shall be set when changeType is equal to "LINK_PORT_ADDED" or "LINK_PORT_REMOVED", and the related
"VnfLinkPortInfo" structures are present (case "added") or have been present (case "removed") in the
"VnfVirtualLinkResourceInfo" or "ExtManagedVirtualLinkInfo" structures that are represented by the
"vnfVirtualLinkResourceInfo" or "extManagedVirtualLinkInfo" attribute in the "VnfInstance" structure.
See note.
type: array
items:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
metadata:
description: >
Metadata about this resource.
The content of this attribute shall be a copy of the content of the
"metadata" attribute of the applicable "VnfVirtualLinkResourceInfo" structure
if such structure is referenced by the "id" attribute and it has metadata.
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
AffectedVirtualStorage:
description: >
This type provides information about added, deleted, modified and
temporary virtual storage resources.
type: object
required:
- id
- virtualStorageDescId
- changeType
- storageResource
properties:
id:
description: >
Identifier of the storage instance, identifying the applicable
"virtualStorageResourceInfo" entry in the "VnfInstance" data type.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
virtualStorageDescId:
description: >
Identifier of the related VirtualStorage descriptor in the VNFD.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
vnfdId:
description: >
Identifier of the VNFD.
Shall be present in case of a "change current VNF Package" to identify whether the affected virtual storage
instance is associated to a VirtualStorage descriptor which is referred from the source or destination VNFD.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
changeType:
description: >
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.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ResourceHandle"
metadata:
description: >
Metadata about this resource.
The content of this attribute shall be a copy of the content of the
"metadata" attribute of the VirtualStorageResourceInfo structure.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
VnfLcmOpOcc:
description: >
This type represents a VNF lifecycle management operation occurrence. Shall be set to the value of the "id"
attribute in the "Grant" representing the associated "Individual Grant", if such grant exists.
* NOTE 1: This allows the API consumer to obtain the information contained in the latest "result"
notification if it has not received it due to an error or a wrongly configured subscription filter.
* NOTE 2: Not more than one of changedInfo and modificationsTriggeredByVnfPkgChange shall be present.
* NOTE 3: For a particular affected VL, there shall be as many "AffectedVirtualLink" entries as needed
for signalling the different types of changes, i.e. one per virtual link and change type.
For instance, in the case of signaling affected VL instances involving the addition of a
particular VL instance with links ports, one "AffectedVirtualLink" entry signals the addition
of the VL by using the "changeType" attribute of "AffectedVirtualLink" structure equal to "ADDED",
and another "AffectedVirtualLink" entry signals the addition of VNF link ports of the VL by using the
"changeType" equal to "LINK_PORT_ADDED".
* NOTE 4: A coordination action has timed out if the VNFM has not been able to read the
"Individual coordination action" resource within a timeout interval after requesting the coordination
to be started or to be cancelled. The length of the timeout interval is defined by means outside
the scope of the present document.
* NOTE 5: The list of rejected coordinations may be garbage collected if the LCM operation occurrence has
reached a terminal state, i.e. one of "COMPLETED", "FAILED" and "ROLLED_BACK".
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
type: object
oneOf:
- required:
- changedInfo
- required:
- modificationsTriggeredByVnfPkgChange
required:
- id
- operationState
- stateEnteredTime
- startTime
- vnfInstanceId
- operation
- isAutomaticInvocation
- isCancelPending
properties:
id:
description: >
Identifier of this VNF lifecycle management operation occurrence.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
operationState:
description: >
The state of the LCM operation.
$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LcmOperationStateType"
stateEnteredTime:
description: >
Date-time when the current state has been entered.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime"
startTime:
description: >
Date-time of the start of the operation.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime"
vnfInstanceId:
description: >
Identifier of the VNF instance to which the operation applies
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
grantId:
description: >
Identifier of the grant related to this VNF LCM operation
occurrence. Shall be set to the value of the "id" attribute
in the "Grant" representing the associated "Individual Grant",
if such grant exists.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
operation:
description: >
Type of the actual LCM operation represented by this VNF LCM
operation occurrence.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/LcmOperationType"
isAutomaticInvocation:
description: >
Set to true if this VNF LCM operation occurrence has been triggered
by an automated procedure inside the VNFM (i.e.
ScaleVnf / ScaleVnfToLevel triggered by auto-scale, or HealVnf
triggered by auto-heal). Set to false otherwise.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Boolean"
operationParams:
description: >
Input parameters of the LCM operation. This attribute shall be
formatted according to the request data type of the related LCM
operation. In addition, the provisions in clause 5.7 shall apply.
The following mapping between operationType and the data type of this attribute shall apply:
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
* INSTANTIATE: InstantiateVnfRequest
* SCALE: ScaleVnfRequest
* SCALE_TO_LEVEL: ScaleVnfToLevelRequest
* CHANGE_FLAVOUR: ChangeVnfFlavourRequest
* OPERATE: OperateVnfRequest
* HEAL: HealVnfRequest
* CHANGE_EXT_CONN: ChangeExtVnfConnectivityRequest
* TERMINATE: TerminateVnfRequest
* MODIFY_INFO: VnfInfoModifications
* CREATE_SNAPSHOT: CreateVnfSnapshotRequest
* REVERT_TO_SNAPSHOT: RevertToVnfSnapshotRequest
* CHANGE_VNFPKG: ChangeCurrentVnfPkgRequest
type: object
isCancelPending:
description: >
If the VNF LCM operation occurrence is in "STARTING", "PROCESSING"
or "ROLLING_BACK" state and the operation is being cancelled, this
attribute shall be set to true. Otherwise, it shall be set to false.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Boolean"
cancelMode:
description: >
The mode of an ongoing cancellation. Shall be present when
isCancelPending=true, and shall be absent otherwise.
$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/CancelModeType"
error:
description: >
If "operationState" is "FAILED_TEMP" or "FAILED" or "operationState"
is "PROCESSING" or "ROLLING_BACK" and previous value of
"operationState" was "FAILED_TEMP", this attribute shall be present
and contain error information, unless it has been requested to be
excluded via an attribute selector.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
resourceChanges:
description: >
This attribute contains information about the cumulative changes to
virtualised resources that were performed so far by the LCM
operation since its start, if applicable.
type: object
properties:
affectedVnfcs:
description: >
Information about VNFC instances that were affected during the
type: array
items:
$ref: "#/definitions/AffectedVnfc"
affectedVirtualLinks:
description: >
Information about VL instances that were affected during the
type: array
items:
$ref: "#/definitions/AffectedVirtualLink"
affectedExtLinkPorts:
description: >
Information about external VNF link ports that were affected during the lifecycle operation.
See note 1.
$ref: "#/definitions/AffectedExtLinkPort"
affectedVirtualStorages:
description: >
Information about virtualised storage instances that were affected
type: array
items:
$ref: "#/definitions/AffectedVirtualStorage"
changedInfo:
description: >
Information about the changed VNF instance information, including
VNF configurable properties, if applicable. See note 1 and note 2.
$ref: "#/definitions/VnfInfoModifications"
affectedVipCps:
description: >
Information about virtual IP CP instances that were affected during
the execution of the lifecycle management operation.
type: array
items:
$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/AffectedVipCp"
Information about changed external connectivity, if applicable. See note 1.
type: array
items:
$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ExtVirtualLinkInfo"
modificationsTriggeredByVnfPkgChange:
description: >
Information about performed changes of "VnfInstance" attributes triggered by changing the current VNF package,
if applicable. Shall be absent if the "operation" attribute is different from "CHANGE_VNFPKG".
$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ModificationsTriggeredByVnfPkgChange"
vnfSnapshotInfoId:
description: >
Identifier of the "individual VNF snapshot" resource. Shall be present if applicable to the type of LCM operation,
i.e., if the value of the "operation" attribute is either "CREATE_SNAPSHOT" or "REVERT_TO_SNAPSHOT".
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
lcmCoordinations:
description: >
Information about LCM coordination actions (see clause 10) related to this LCM operation occurrence.
type: object
required:
- id
- coordinationActionName
- startTime
- endpointType
properties:
id:
description: >
Identifier of this coordination action. For a terminated coordination action,
this attribute refers to the "id" attribute in the "LcmCoord" data structure
(see clause 10.5.2.3). For a timed-out or ongoing coordination action,
this attribute refers to the {coordinationId} URI variable in the "Location"
header of the "202 Accepted" HTTP response to the POST request that has initiated
the coordination action (see clause 10.4.2.3.1).
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
coordinationActionName:
description: >
Indicator of the actual coordination action.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
coordinationResult:
description: >
The result of executing the coordination action which also implies the action to
be performed by the VNFM as the result of this coordination. See note 4.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/LcmCoordResultType"
startTime:
description: >
The time when the VNFM has received the confirmation that the coordination action has been started.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime"
endTime:
description: >
The end time when the VNFM has received the confirmation that the coordination action
has finished or has been cancelled, or the time when a coordination action has timed out.
Shall be present for a coordination action that has finished or timed out (see note 4) and
shall be absent if the coordination is ongoing.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime"
endpointType:
description: >
The endpoint type used by this coordination action.
Valid values:
- MGMT: coordination with other operation supporting management systems (e.g. EM)
- VNF: coordination with the VNF instance
type: string
enum:
- MGMT
- VNF
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
delay:
description: >
The end of the delay period.
This attribute shall be present if the last known HTTP response related to this coordination
has contained a "Retry-After" header, and shall be absent otherwise.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime"
rejectedLcmCoordinations:
description: >
Information about LCM coordination actions (see clause 10) that were rejected by 503 error which
means they will be tried again after a delay. See note 5.
type: object
required:
- coordinationActionName
- rejectionTime
- endpointType
- delay
properties:
coordinationActionName:
description: >
Indicator of the actual coordination action.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
rejectionTime:
description: >
The time when the VNFM has received the 503 response that rejects the actual coordination.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime"
endpointType:
description: >
The endpoint type used by this coordination action.
Valid values:
- MGMT: coordination with other operation supporting management systems (e.g. EM)
- VNF: coordination with the VNF instance
type: string
enum:
- MGMT
- VNF
delay:
description: >
The end of the delay period, as calculated from the startTime and "Retry-After" header.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime"
warnings:
description: >
Warning messages that were generated while the operation was executing.
If the operation has included LCM coordination actions and these have resulted
in warnings, such warnings should be added to this attribute.
type: array
items:
type: string
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
_links:
description: >
Links to resources related to this resource.
type: object
required:
- self
- vnfInstance
properties:
self:
description: >
URI of this resource.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
vnfInstance:
description: >
Link to the VNF instance that the operation applies to.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
grant:
description: >
Link to the grant for this operation, if one exists.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
cancel:
description: >
Link to the task resource that represents the "cancel" operation
for this VNF LCM operation occurrence, if cancelling is
currently allowed.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
retry:
description: >
Link to the task resource that represents the "retry" operation
for this VNF LCM operation occurrence, if retrying is currently
allowed.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
rollback:
description: >
Link to the task resource that represents the "rollback"
operation for this VNF LCM operation occurrence, if rolling back
is currently allowed.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
fail:
description: >
Link to the task resource that represents the "fail" operation
for this VNF LCM operation occurrence, if declaring as failed is
currently allowed.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
vnfSnapshot:
description: >
Link to the VNF snapshot resource, if the VNF LCM operation occurrence is related to a VNF snapshot.
Shall be present if operation="CREATE_SNAPSHOT" or operation="REVERT_TO_SNAPSHOT".
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
AffectedExtLinkPort:
description: >
This type provides information about added and deleted external link ports (link ports attached to external virtual links).
type: object
required:
- id
- changeType
- extCpInstanceId
- resourceHandle
properties:
id:
description: >
Identifier of the link port, identifying the applicable "extLinkPorts" entry in the "ExtVirtualLinkInfo" data
type (see clause 5.5.3.2).
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
changeType:
description: >
Signals the type of change.
Permitted values:
- ADDED
- REMOVED
type: string
enum:
- ADDED
- REMOVED
extCpInstanceId:
description: >
Identifier of the related external CP instance.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
resourceHandle:
description: >
Reference to the link port resource.
Detailed information is (for added resources) or has been (for removed resources) available from the VIM.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ResourceHandle"
VnfInfoModifications:
description: >
This type represents attribute modifications that were performed on an
"Individual VNF instance" resource. The attributes that can be included
consist of those requested to be modified explicitly in the
"VnfInfoModificationRequest" data structure, and additional attributes
of the "VnfInstance" data structure that were modified implicitly e.g.
when modifying the referenced VNF package.
* NOTE: If present, this attribute (which depends on the value of the "vnfdId" attribute)
was modified implicitly following a request to modify the "vnfdId" attribute, by
copying the value of this attribute from the VNFD in the VNF Package identified
by the "vnfdId" attribute.
type: object
properties:
vnfInstanceName:
description: >
If present, this attribute signals modifications of the
"vnfInstanceName" attribute in "VnfInstance" as defined in clause 5.5.2.12..
type: string
vnfInstanceDescription:
description: >
If present, this attribute signals modifications of the
"vnfInstanceDescription" attribute in "VnfInstance", as defined in clause 5.5.2.12..
type: string
vnfConfigurableProperties:
description: >
If present, this attribute signals modifications of the
"vnfConfigurableProperties" attribute in "VnfInstance" as defined in clause 5.5.2.12.
In addition, the provisions in clause 5.7 shall apply..
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
metadata:
description: >
If present, this attribute signals modifications of the "metadata"
attribute in "VnfInstance" , as defined in clause 5.5.2.12..
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
extensions:
description: >
If present, this attribute signals modifications of the "extensions"
attribute in "VnfInstance", as defined in clause 5.5.2.12.
In addition, the provisions in clause 5.7 shall apply..
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
vnfdId:
description: >
If present, this attribute signals modifications of the "vnfdId"
attribute in "VnfInstance", as defined in clause 5.5.2.12..
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
vnfProvider:
description: >
If present, this attribute signals modifications of the
"vnfProvider" attribute in "VnfInstance". See note.
type: string
vnfProductName:
description: >
If present, this attribute signals modifications of the
"vnfProductName" attribute in "VnfInstance". See note.
type: string
vnfSoftwareVersion:
description: >
If present, this attribute signals modifications of the
"vnfSoftwareVersion" attribute in "VnfInstance". See note.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Version"
vnfdVersion:
description: >
If present, this attribute signals modifications of the
"vnfdVersion" attribute in "VnfInstance". See note.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Version"
vnfcInfoModifications:
description: >
If present, this attribute signals modifications of certain
entries in the "vnfcInfo" attribute array in the
"instantiatedVnfInfo" attribute of "VnfInstance", as defined
type: array
items:
$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfcInfoModifications"