Newer
Older
# Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt
definitions:
This type represents a VNF instance.
- id
- vnfdId
- vnfProvider
- vnfProductName
- vnfSoftwareVersion
- vnfdVersion
- instantiationState
Identifier of the VNF instance.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
vnfInstanceName:
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.
Giacomo Bernini
committed
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 not 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.
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
$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: >
Current values of the configurable properties of the VNF instance.
Configurable properties referred in this attribute are declared in
the VNFD.
ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD
based on TOSCA specifications.
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.
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.
Giacomo Bernini
committed
These configurable properties can be initialized with default values
Francesca Moscatelli
committed
from the VNFD (see note 4).
Configurable properties can be modified with values passed in request
structures of certain LCM operations, such as the InstantiateVnfRequest
structure.
Giacomo Bernini
committed
Further, these configurable properties can be created, modified or
deleted with the PATCH method.
Francesca Moscatelli
committed
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.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
vimConnectionInfo:
description: >
Information about VIM connections to be used for managing the
resources for the VNF instance. This attribute shall only be
supported and present if VNF-related resource management in direct
mode is applicable.
This attribute can be modified with the PATCH method.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/VimConnectionInfo"
instantiationState:
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
143
144
145
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
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"
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
extCpInfo:
description: >
Information about the external CPs exposed by the VNF instance.
type: array
minItems: 1
items:
$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfExtCpInfo"
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: >
External virtual links the VNF instance is connected to.
type: array
items:
$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ExtManagedVirtualLinkInfo"
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:
Francesca Moscatelli
committed
$ref: "#/definitions/VnfcResourceInfo"
virtualLinkResourceInfo:
description: >
Information about the virtualised network resources used by the VLs
of the VNF instance.
type: array
items:
$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfVirtualLinkResourceInfo"
virtualStorageResourceInfo:
description: >
Information on the virtualised storage resource(s) used as storage for the VNF instance.
type: array
items:
$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VirtualStorageResourceInfo"
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 are writeable are the VNF provider foresees are expected to be declared in the VNFD.
The declaration of metadata in the VNFD can optionally contain the specification of initial values.
The VNFM shall accept requests to write metadata that are not declared in the VNFD.
These attributes can be initialized with default values from the VNFD or with values
Francesca Moscatelli
committed
passed in the CreateVnfRequest structure (see clause 5.4.2.3.1).
This attributeThese attributes can be created, modified or removed with the PATCH method.
ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD based on TOSCA specifications.
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. Child attributes of "vnfConfigurableProperties", "metadata" and "extensions"
that have no declared 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.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
extensions:
description: >
Additional VNF-specific attributes that affect the lifecycle management of this VNF instance.
Francesca Moscatelli
committed
These attributes represent values that are stored persistently in the VnfInstance structure for
consumption by the VNFM or 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.
Francesca Moscatelli
committed
These attributes can be initialized with default values from the VNFD (see note 4).
These attributes can be updatedmodified 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.
Francesca Moscatelli
committed
NOTE 2: ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD based on TOSCA specifications.
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 declareddefined 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.
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
$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"
InstantiateVnfRequest:
#SOL003 location: 5.5.2.4
- 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.
type: array
items:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ExtVirtualLinkData"
extManagedVirtualLinks:
description: >
Information about internal VLs that are managed by the NFVO.
Francesca Moscatelli
committed
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.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ExtManagedVirtualLinkData"
vimConnectionInfo:
description: >
Information about VIM connections to be used for managing the
resources for the VNF instance, or refer to
external / externally-managed virtual links. This attribute shall
only be supported and may be present if VNF-related resource
management in direct mode is applicable.
type: array
items:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/VimConnectionInfo"
localizationLanguage:
Localization language of the VNF to be instantiated. The value shall
comply with the format defined in IETF RFC 5646.
Giacomo Bernini
committed
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/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"
Giacomo Bernini
committed
extensions:
description: >
Francesca Moscatelli
committed
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.
Giacomo Bernini
committed
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
vnfConfigurableProperties:
description: >
Francesca Moscatelli
committed
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:
#SOL003 location: 5.5.2.7
description: >
This type represents request parameters for the "Change VNF flavour" operation.
- newFlavourId
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.
Giacomo Bernini
committed
Entries in the list of external VLs that are unchanged need not be supplied as part of this request.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ExtVirtualLinkData"
extManagedVirtualLinks:
description: >
Information about internal VLs that are managed by the NFVO.
Francesca Moscatelli
committed
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.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ExtManagedVirtualLinkData"
vimConnectionInfo:
description: >
Information about VIM connections to be used for managing the
resources for the VNF instance, or refer to
external / externally-managed virtual links. This attribute shall
only be supported and may be present if VNF-related resource
management in direct mode is applicable.
type: array
items:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/VimConnectionInfo"
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"
Francesca Moscatelli
committed
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"
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
TerminateVnfRequest:
type: object
required:
- terminationType
properties:
terminationType:
description: >
Indicates whether forceful or graceful termination is requested.
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:
cause:
description: >
Indicates the reason why a healing procedure is required.
Giacomo Bernini
committed
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/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"
OperateVnfRequest:
description: >
This type represents request parameters for the "Operate VNF" operation.
type: object
required:
- changeStateTo
properties:
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.
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 was set to ”FORCEFUL”, when
the “changeStateTo” attribute is equal to “STOPPED” and the
“stopType” attribute is absent.
$ref: "#/definitions/StopType"
description: >
The time interval (in seconds) to wait for the VNF to be taken out
of service during graceful stop, before stopping the VNF.
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 was set to ”FORCEFUL”, when
the “changeStateTo” attribute is equal to “STOPPED” and the
“stopType” attribute is absent.
type: integer
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:
#SOL003 location: 5.5.2.11
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
properties:
extVirtualLinks:
description: >
Information about external VLs to change (e.g. connect the VNF to).
Giacomo Bernini
committed
Entries in the list of external VLs that are unchanged need not be supplied as part of this request.
type: array
items:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ExtVirtualLinkData"
vimConnectionInfo:
description: >
Information about VIM connections to be used for managing the
resources for the VNF instance, or refer to external virtual
links. This attribute shall only be supported and may be present
if VNF-related resource management in direct mode is applicable.
type: array
items:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/VimConnectionInfo"
additionalParams:
description: >
Additional input parameters for the instantiation process, specific
to the VNF being instantiated, as declared in the VNFD as part of
"ChangeExtVnfConnectivityOpConfig".".
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
VnfInfoModificationRequest:
This type represents attribute modifications for an
"Individual VNF instance" resource, i.e. modifications to a resource
representation based on the "VnfInstance" data type.
vnfInstanceName:
description: >
New value of the "vnfInstanceName" attribute in "VnfInstance", or
"null" to remove the attribute.
Giacomo Bernini
committed
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String"
vnfInstanceDescription:
description: >
New value of the "vnfInstanceDescription" attribute in
"VnfInstance", or "null" to remove the attribute.
Giacomo Bernini
committed
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String"
vnfPkgId:
description: >
New value of the "vnfPkgId" 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
Francesca Moscatelli
committed
according to the rules of JSON Merge Patch (see IETF RFC 7396).
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
metadata:
description: >
Modifications of the "metadata" attribute in "VnfInstance". If
present, these modifications shall be applied according to the rules
Francesca Moscatelli
committed
of JSON Merge Patch (see IETF RFC 7396).
$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
Francesca Moscatelli
committed
of JSON Merge Patch (see IETF RFC 7396).
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
vimConnectionInfo:
New content of certain entries in the "vimConnectionInfo" attribute
array in "VnfInstance", as defined below this table.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/VimConnectionInfo"
vimConnectionInfoDeleteIds:
List of identifiers entries to be deleted from the "vimConnectionInfo"
attribute array in "VnfInstance", to be used as "deleteIdList" as defined
below this table.
type: array
items:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
VnfInfoModifications:
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.
vnfInstanceName:
If present, this attribute signals modifications of the
"vnfInstanceName" attribute in "VnfInstance".
Giacomo Bernini
committed
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String"
vnfInstanceDescription:
description: >
If present, this attribute signals modifications of the
"vnfInstanceDescription" attribute in "VnfInstance".
Giacomo Bernini
committed
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String"
vnfConfigurableProperties:
description: >
If present, this attribute signals modifications of the
"vnfConfigurableProperties" attribute in "VnfInstance".
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
metadata:
description: >
If present, this attribute signals modifications of the "metadata"
attribute in "VnfInstance".
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
extensions:
description: >
If present, this attribute signals modifications of the "extensions"
attribute in "VnfInstance".
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
vimConnectionInfo:
If present, this attribute signals modifications of certain entries
in the "vimConnectionInfo" attribute array in "VnfInstance".
type: array
items:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/VimConnectionInfo"
vimConnectionInfoDeleteIds:
If present, this attribute signals the deletion of certain entries
in the "vimConnectionInfo" attribute array in "VnfInstance".
type: array
items:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
vnfdId:
If present, this attribute signals modifications of the "vnfdId"
attribute in "VnfInstance".
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
vnfProvider:
description: >
If present, this attribute signals modifications of the
"vnfProvider" attribute in "VnfInstance".
If present, this attribute (which depends on the value of the
"vnfPkgId" attribute) was modified implicitly following a request to
modify the "vnfPkgId" attribute, by copying the value of this
attribute from the VNFD in the VNF Package identified by the
"vnfPkgId” attribute.
Giacomo Bernini
committed
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String"
vnfProductName:
description: >
If present, this attribute signals modifications of the
"vnfProductName" attribute in "VnfInstance".
If present, this attribute (which depends on the value of the
"vnfPkgId" attribute) was modified implicitly following a request to
modify the "vnfPkgId" attribute, by copying the value of this
attribute from the VNFD in the VNF Package identified by the
"vnfPkgId” attribute.
Giacomo Bernini
committed
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String"
vnfSoftwareVersion:
description: >
If present, this attribute signals modifications of the
"vnfSoftwareVersion" attribute in "VnfInstance".
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Version"
vnfdVersion:
description: >
If present, this attribute signals modifications of the
"vnfdVersion" attribute in "VnfInstance".
If present, this attribute (which depends on the value of the
"vnfPkgId" attribute) was modified implicitly following a request to
modify the "vnfPkgId" attribute, by copying the value of this
attribute from the VNFD in the VNF Package identified by the
"vnfPkgId” attribute.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Version"
StopType:
description: >
Francesca Moscatelli
committed
* FORCEFUL: The VNFM will stop the VNF instance immediately after accepting the
Francesca Moscatelli
committed
* GRACEFUL: The VNFM will first arrange to take the VNF instance out of service
after accepting the request. Once that operation is successful or once
the timer value specified in the "gracefulStopTimeout" attribute
Francesca Moscatelli
committed
expires, the VNFM will stop the VNF instance.
type: string
enum:
- FORCEFUL
Francesca Moscatelli
committed
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
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
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
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
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
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
- GRACEFUL
VnfcResourceInfo:
description: >
This type represents the information on virtualised compute and storage
resources used by a VNFC in a VNF instance.
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.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
computeResource:
description: >
Reference to the VirtualCompute resource.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ResourceHandle"
zoneId:
description: >
The identifier of the resource zone, as managed by the
resource management layer (typically, the VIM), where
the referenced VirtualCompute resource is placed.
Shall be provided if this information is available from the VIM.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
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: >
CPs of the VNFC instance.
Shall be present when that particular CP of the VNFC instance is exposed as
an external CP of the VNF instance or is connected to an external CP of the
VNF instance. See note 2. May be present otherwise.
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.
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.
$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.
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.
$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. See note 3.
NOTE 3: 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 "VnfLinkPorts" structure in the
"VnfVirtualLinkResourceInfo" structure. Shall be present if the CP is associated to a link port
on an internal VL of the VNF instance and shall be absent otherwise.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
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"
VnfLcmOpOcc:
description: >
This type represents a VNF lifecycle management operation occurrence.
type: object
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: "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. The following mapping between operationType and the
data type of this attribute shall apply:
* INSTANTIATE: InstantiateVnfRequest
* SCALE: ScaleVnfRequest
* SCALE_TO_LEVEL: ScaleVnfToLevelRequest
* CHANGE_FLAVOUR: ChangeVnfFlavourRequest
* OPERATE: OperateVnfRequest
* HEAL: HealVnfRequest
* CHANGE_EXT_CONN: ChangeExtVnfConnectivityRequest
* TERMINATE: TerminateVnfRequest
* MODIFY_INFO: VnfInfoModifications
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
lifecycle operation.
NOTE 1: This allows the NFVO 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.
type: array
items:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/AffectedVnfc"
affectedVirtualLinks:
description: >
Information about VL instances that were affected during the
lifecycle operation. See note 1 and note 2.
NOTE 1: This allows the NFVO 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: 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 externally visible VNF link ports of the VL by using
the "changeType" equal to "LINK_PORT_ADDED".
type: array
items:
$ref: "#/definitions/AffectedVirtualLink"
affectedExtLinkPorts:
description: >
Information about external VNF link ports that were affected during the lifecycle
operation. See note 1.
NOTE 1: This allows the NFVO 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.
type: array
items:
$ref: "#/definitions/AffectedExtLinkPort"
affectedVirtualStorages:
description: >
Information about virtualised storage instances that were affected
during the lifecycle operation.
This allows the NFVO 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.
type: array
items:
$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/AffectedVirtualStorage"
changedInfo:
description: >
Information about the changed VNF instance information, including
VNF configurable properties, if applicable.
This allows the NFVO 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.
$ref: "#/definitions/VnfInfoModifications"
changedExtConnectivity:
description: >
Information about changed external connectivity, if applicable.
This allows the NFVO 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.
type: array
items:
$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ExtVirtualLinkInfo"
_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"
AffectedVirtualLink:
description: >
This type provides information about added, deleted, modified and
temporary VLs, and added or removed VNF link ports.
It shall comply with the provisions in table 5.5.3.14-1.
type: object
required:
- id
- vnfVirtualLinkDescId
- changeType
- networkResource
properties:
id:
description: >
Identifier of the virtual link instance, identifying the applicable
"vnfVirtualLinkResourceInfo" entry in the "VnfInstance" data type.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
vnfVirtualLinkDescId:
description: >
Identifier of the related VLD in the VNFD.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
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.
NOTE 1: When signalling the addition (LINK_PORT_ADDED) or removal (LINK_PORT_REMOVED) of VNF link
ports, the "networkResource" and "resourceDefinitionId" attributes refer 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.
NOTE 1: When signalling the addition (LINK_PORT_ADDED) or removal (LINK_PORT_REMOVED) of VNF link
ports, the "networkResource" and "resourceDefinitionId" attributes refer 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.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ResourceHandle"
virtualLinkPortIds:
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 "vnfVirtualLinkResource¬Info" or "extManagedVirtualLinkInfo"
attribute in the "VnfInstance" structure. See note 1.
NOTE 1: When signalling the addition (LINK_PORT_ADDED) or removal (LINK_PORT_REMOVED) of VNF link
ports, the "networkResource" and "resourceDefinitionId" attributes refer 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: array
items:
$ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
resourceDefinitionId:
description: >
The identifier of the "ResourceDefinition" in the granting exchange
related to the LCM operation occurrence. It shall be present when an
applicable GrantInfo for the granted resource exists.
The "resourceDefinitionId" attribute provides information to the API
consumer (i.e. the NFVO) to assist in correlating the resource changes
performed during the LCM operation with the granted resources in a
specific Grant exchange, which is identified by the "grantId" available
in the "Individual VNF lifecycle management operation occurrence" and
the "id" in the "Individual Grant".
NOTE 1: When signalling the addition (LINK_PORT_ADDED) or removal (LINK_PORT_REMOVED) of VNF link
ports, the "networkResource" and "resourceDefinitionId" attributes refer 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.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierLocal"
zoneId:
description: >
The identifier of the resource zone, as managed by the resource
management layer (typically, the VIM), where the referenced VirtualNetwork
resource is placed. Shall be provided if this information is available from the VIM.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
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.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
AffectedExtLinkPort:
description: >
This type provides information about added and deleted external link ports (link ports attached to external
virtual links). It shall comply with the provisions in table 5.5.3.14a-1.
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/IdentifierInVnf"
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"
resourceDefinitionId:
description: >
The identifier of the "ResourceDefinition" in the granting exchange related to the LCM
operation occurrence. It shall be present when an applicable GrantInfo for the granted
resource exists. See note.
NOTE: The "resourceDefinitionId" attribute provides information to the API consumer
(i.e. the NFVO) to assist in correlating the resource changes performed during the LCM
operation with the granted resources in a specific Grant exchange, which is identified
by the "grantId" available in the "Individual VNF lifecycle management operation occurrence"
and the "id" in the "Individual Grant".
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierLocal"