Newer
Older
# Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt
definitions:
InstantiateVnfRequest:
description: >
This type represents request parameters for the "Instantiate VNF" operation.
It shall comply with the provisions defined in table 5.5.2.4-1.
* NOTE 1: 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.
* NOTE 2: It is possible to have several ExtManagedVirtualLinkData for the same VNF
internal VL in case of a multi-site VNF spanning several VIMs. The set of
ExtManagedVirtualLinkData 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 4.4.1.12).
* NOTE 3: The target size for VNF instantiation may be specified in either instantiationLevelId or targetScaleLevelInfo, but
not both. If none of the two attributes (instantiationLevelId or targetScaleLevelInfo) are present, the default
instantiation level as declared in the VNFD shall be used.
* NOTE 4: If targetScaleLevelInfo is specified, information provided in targetScaleLevelInfo shall be used for instantiating
scalable constituents of the VNF (e.g, VDUs/VLs). For scaling aspects not specified in targetScaleLevelInfo or
for the VNF constituents (e.g.,VDUs/VLs) that are not scalable, the default instantiation level as declared in the
VNFD shall be used for instantiation.
description: >
Identifier of the VNF deployment flavour to be instantiated.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnfd"
instantiationLevelId:
description: >
Identifier of the instantiation level of the deployment
flavour to be instantiated. See note 3.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnfd"
targetScaleLevelInfo:
description: >
This attribute is applicable if VNF supports target
scale level instantiation.
For each scaling aspect of the current deployment
flavour, the attribute specifies the scale level of VNF
constituents (e.g., VDU level) to be instantiated. See
notes 3 and 4.
type: array
items:
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/ScaleInfo"
extVirtualLinks:
description: >
Information about external VLs to connect the VNF
to, including configuration information for the CPs
via which the VNF instance can attach to this VL.
The following applies to the "ExtVirtualLinkData"
information provided in this request, together with
the the related overriding information provided in the
"Grant" structure (see clause 9.5.2.3): Even if the
VNF is not instantiated in fully scaled-out state, the
API consumer shall provide enough CP
configuration records to allow connecting the VNF
instance, fully scaled out in all scaling aspects, to
the external VLs.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/ExtVirtualLinkData"
extManagedVirtualLinks:
description: >
Information about internal VLs that are managed by the NFVO. See note 1 and note 2.
$ref: "#/definitions/ExtManagedVirtualLinkData"
vimConnectionInfo:
description: >
Information about VIM or CISM 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
- the resources for at least one of the VNFCs
shall be managed by a VIM and VNFrelated resource management in direct
mode is applicable.
- the resources for at least one of the VNFCs
shall be managed by a CISM.
The VNFM shall apply the content of this attribute to
the "vimConnectionInfo" attribute of "VnfInstance"
according to the rules of JSON Merge Patch (see
IETF RFC 7396 [5]).
type: object
additionalProperties:
$ref: "../../General_Definitions/SOL003_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.
$ref: "../../General_Definitions/SOL003_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" defined in ETSI GS NFVIFA 011 [10].
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"
Giacomo Bernini
committed
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: "../../General_Definitions/SOL003_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.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"
description: >
This type represents an externally-managed internal VL.
* NOTE 1: It is only applicable if the externally-managed VL is realized by a secondary container cluster network. It shall
not be present otherwise.
* NOTE 2: A link port is not needed for a VNFC internal connection point connected to a secondary container cluster
network.
* NOTE 3: An example of the network attachment definition resource when the container infrastructure service
management is a Kubernetes® instance is a network attachment definition (NAD).
type: object
required:
- id
- vnfVirtualLinkDescId
- 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: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
vnfVirtualLinkDescId:
description: >
The identifier of the VLD in the VNFD for this VL.
$ref: "../../General_Definitions/SOL003_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.
$ref: "../../General_Definitions/SOL003_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: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
resourceId:
description: >
The identifier of the resource in the scope of the VIM or the
resource provider.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVim"
netAttDefResourceData:
description: >
Externally provided network attachment definition
resource(s) that provide the specification of the interface
to attach VNFC connection points to this externallymanaged VL.
See notes 1 and 3.
type: array
items:
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/NetAttDefResourceData"
intCp:
description: >
Internal CPs of the VNF to be connected to this
externally-managed VL. See note 1.
type: array
items:
$ref: "#/definitions/IntVnfCpData"
vnfLinkPort:
description: >
Externally provided link ports to be used to connect VNFC connection points to this externally-managed VL
on this network resource. If this attribute is not present, the VNFM shall create the link ports on the
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/VnfLinkPortData"
extManagedMultisiteVirtualLinkId:
description: >
Identifier of the externally-managed multi-site VL instance. The identifier is assigned by the NFVMANO
entity that manages the externally managed multi-site VL instance. It shall be present when the present
externally-managed internal VL (indicated by extManagedVirtualLinkId) is part of a multi-site VL, e.g.,
in support of multi-site VNF spanning several VIMs. All externally-managed internal VL instances
corresponding to an internal VL created based on the same virtualLinkDescId shall refer to the same
extManagedMultisiteVirtualLinkId.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
ChangeVnfFlavourRequest:
description: >
This type represents request parameters for the "Change VNF flavour" operation.
It shall comply with the provisions defined in table 5.5.2.7-1.
* NOTE 1: 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.
* NOTE 2: It is possible to have several ExtManagedVirtualLinkData for the same VNF internal
VL in case of a multi-site VNF spanning several VIMs. The set of ExtManagedVirtualLinkData
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 4.4.1.12).
* NOTE 3: The target size for VNF instantiation may be specified in either instantiationLevelId or targetScaleLevelInfo, but
not both. If none of the two attributes (instantiationLevelId or targetScaleLevelInfo) are present, the default
instantiation level as declared in the VNFD shall be used.
* NOTE 4: If targetScaleLevelInfo is specified, information provided in targetScaleLevelInfo shall be used for instantiating
scalable constituents of the VNF (e.g, VDUs/VLs). For scaling aspects not specified in targetScaleLevelInfo or
for the VNF constituents (e.g.,VDUs/VLs) that are not scalable, the default instantiation level as declared in the
VNFD shall be used for instantiation.
- newFlavourId
newFlavourId:
description: >
Identifier of the VNF deployment flavour to be instantiated.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnfd"
instantiationLevelId:
description: >
Identifier of the instantiation level of the deployment flavour to
be instantiated. See note 3. If not present, the default instantiation level as
declared in the VNFD is instantiated.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnfd"
targetScaleLevelInfo:
description: >
This attribute is applicable if VNF supports target scale
level instantiation.
For each scaling aspect of the current deployment
flavour, the attribute specifies the scale level of VNF
constituents (e.g., VDU level) to be instantiated. See
notes 3 and 4.
type: array
items:
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/ScaleInfo"
extVirtualLinks:
description: >
Information about external VLs to connect the VNF to, including configuration information
for the CPs via which the VNF instance can attach to this VL.
Entries in the list of external VLs that are unchanged need not be supplied as part of
this request.
The following applies to the "ExtVirtualLinkData" information provided in this
request, together with the related "ExtVirtualLinkInfo" information known to the
VNFM represented in the "VnfInstance" structure (see clause 5.5.2.2) and the related
overriding information provided in the "Grant" structure (see clause 9.5.2.3): Even if the VNF
is not in fully scaled-out state after changing the flavour, the API consumer shall provide
enough CP configuration records to allow connecting the VNF instance, fully scaled out in all scaling
aspects, to the external VLs.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/ExtVirtualLinkData"
extManagedVirtualLinks:
description: >
Information about internal VLs that are managed by the NFVO. See notes 1 and 2.
$ref: "#/definitions/ExtManagedVirtualLinkData"
vimConnectionInfo:
description: >
Information about VIM or CISM 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
- the resources for at least one of the VNFCs
shall be managed by a VIM and VNF-related
resource management in direct mode is
applicable.
- the resources for at least one of the VNFCs
shall be managed by a CISM.
The VNFM shall apply the content of this attribute to
the "vimConnectionInfo" attribute of "VnfInstance"
according to the rules of JSON Merge Patch (see IETF
RFC 7396 [5]).
type: object
additionalProperties:
$ref: "../../General_Definitions/SOL003_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" defined in ETSI GS NFV-IFA 011 [10].
$ref: "../../General_Definitions/SOL003_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: "../../General_Definitions/SOL003_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: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"
TerminateVnfRequest:
description: >
This type represents request parameters for the "Terminate VNF" operation.
It shall comply with the provisions defined in table 5.5.2.8-1.
NOTE: If the VNF is still in service, requesting forceful termination can
adversely impact network service.
type: object
required:
- terminationType
properties:
terminationType:
description: >
Indicates whether forceful or graceful 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" defined in ETSI GS NFV-IFA 011 [10].
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"
HealVnfRequest:
type: object
properties:
cause:
description: >
Indicates the reason why a healing procedure is required.
$ref: "../../General_Definitions/SOL003_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" defined in ETSI GS NFV-IFA 011 [10].
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"
OperateVnfRequest:
description: >
This type represents request parameters for the "Operate VNF" operation.
It shall comply with the provisions defined in table 5.5.2.10-1.
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.
required:
- changeStateTo
properties:
changeStateTo:
description: >
The desired operational state (i.e. started or stopped) to change
the VNF to.
$ref: "#/definitions/VnfOperationalStateType"
It signals whether forceful or graceful stop is requested. See note.
$ref: "#/definitions/StopType"
The time interval (in seconds) to wait for the VNF to be taken out of service
during graceful stop, before stopping the VNF. See note.
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" defined in ETSI GS NFV-IFA 011 [10].
$ref: "../../General_Definitions/SOL003_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
properties:
extVirtualLinks:
description: >
Information about external VLs to change (e.g. connect the VNF to) including configuration
information for the CPs via which the VNF instance can attach to this VL.
Entries in the list of external VLs that are unchanged need not be supplied
as part of this request.
The following applies to the "ExtVirtualLinkData" information provided in this request,
together with the related "ExtVirtualLinkInfo" informationknown to the VNFM represented
in the "VnfInstance" structure (see clause 5.5.2.2) and the related overriding
information provided in the "Grant" structure (see clause 9.5.2.3): Even if the VNF
is not in fully scaled-out state, the API consumer shall provide enough CP
configuration records to allow connecting the VNF instance, fully scaled out in
all scaling aspects, to the external VLs.
type: array
items:
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/ExtVirtualLinkData"
vimConnectionInfo:
description: >
Information about VIM or CISM 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
- the resources for at least one of the VNFCs
shall be managed by a VIM and VNF-related
resource management in direct mode is
applicable.
- the resources for at least one of the VNFCs
shall be managed by a CISM.
The VNFM shall apply the content of this attribute to the "vimConnectionInfo" attribute of "VnfInstance"
according to the rules of JSON Merge Patch (see IETF RFC 7396 [5]).
type: object
additionalProperties:
$ref: "../../General_Definitions/SOL003_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" defined in ETSI GS NFV-IFA 011 [10].
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"
ChangeCurrentVnfPkgRequest:
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.
It shall comply with the provisions defined in table 5.5.2.11a-1.
NOTE 1: 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.
NOTE 2: It is possible to have several ExtManagedVirtualLinkData for the same VNF internal
VL in case of a multi-site VNF spanning several VIMs. The set of ExtManagedVirtualLinkData
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 4.4.1.12).
type: object
required:
- vnfdId
properties:
vnfdId:
description: >
Identifier of the VNFD which defines the destination VNF Package for the
change.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
extVirtualLinks:
description: >
Information about external VLs to connect the VNF to, including configuration information for
the CPs via which the VNF instance can attach to this VL.
Entries in the list that are unchanged need not be supplied as part of this request.
The following applies to the "ExtVirtualLinkData" information provided in this request,
together with the related "ExtVirtualLinkInfo" information known to the VNFM represented
in the "VnfInstance" structure (see clause 5.5.2.2) and the related overriding information
provided in the "Grant" structure (see clause 9.5.2.3): Even if the VNF is not in fully
scaled-out state after the change of the VNF package, the API consumer shall provide enough
CP configuration records to allow connecting the VNF instance, fully scaled
out in all scaling aspects, to the external VLs.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/ExtVirtualLinkData"
extManagedVirtualLinks:
description: >
Information about internal VLs that are managed by the NFVO. See notes 1 and 2.
$ref: "#/definitions/ExtManagedVirtualLinkData"
vimConnectionInfo:
description: >
Information about VIM or CISM 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
- the resources for at least one of the VNFCs shall be managed by a VIM and
VNF-related resource management in direct mode is applicable.
- the resources for at least one of the VNFCs shall be managed by a CISM.
The VNFM shall apply the content of this attribute to the "vimConnectionInfo" attribute of
"VnfInstance" according to the rules of JSON Merge Patch (see IETF RFC 7396 [5]).
type: object
additionalProperties:
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/VimConnectionInfo"
additionalParams:
description: >
Additional parameters passed by the NFVO 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" " defined in ETSI GS NFV-IFA 011 [10].
$ref: "../../General_Definitions/SOL003_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, and needed passed
parameter values in case of conflicts, are defined in clause 5.4.11a.3.1.
$ref: "../../General_Definitions/SOL003_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: "../../General_Definitions/SOL003_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.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/String"
vnfInstanceDescription:
description: >
New value of the "vnfInstanceDescription" attribute in "VnfInstance", or "null" to remove the attribute.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/String"
description: >
New value of the "vnfdId" attribute in "VnfInstance". The value "null" is not permitted.
$ref: "../../General_Definitions/SOL003_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).
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"
metadata:
description: >
Modifications of the "metadata" attribute in "VnfInstance". If
present, these modifications shall be applied according to the rules
of JSON Merge Patch (see IETF RFC 7396).
$ref: "../../General_Definitions/SOL003_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).
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"
vimConnectionInfo:
Modifications of the "vimConnectionInfo" attribute. If present, these modifications shall be applied
according to the rules of JSON Merge Patch (see IETF RFC 7396 [5]).
type: object
additionalProperties:
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/VimConnectionInfo"
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.
The "VnfInfoModifications" data type shall comply with the provisions defined in table
5.5.2.12a-1.
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.
vnfInstanceName:
If present, this attribute signals modifications of the
"vnfInstanceName" attribute in "VnfInstance".
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/String"
vnfInstanceDescription:
description: >
If present, this attribute signals modifications of the
"vnfInstanceDescription" attribute in "VnfInstance".
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/String"
vnfConfigurableProperties:
description: >
If present, this attribute signals modifications of the
"vnfConfigurableProperties" attribute in "VnfInstance".
In addition, the provisions in clause 5.7 shall apply.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"
metadata:
description: >
If present, this attribute signals modifications of the "metadata"
attribute in "VnfInstance".
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"
extensions:
description: >
If present, this attribute signals modifications of the "extensions"
attribute in "VnfInstance".
In addition, the provisions in clause 5.7 shall apply.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"
vimConnectionInfo:
If present, this attribute signals modifications the "vimConnectionInfo"
attribute array in "VnfInstance".
type: object
additionalProperties:
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/VimConnectionInfo"
If present, this attribute signals modifications of the "vnfdId"
attribute in "VnfInstance".
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
vnfProvider:
description: >
If present, this attribute signals modifications of the "vnfProvider" attribute
in "VnfInstance". See note.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/String"
vnfProductName:
description: >
If present, this attribute signals modifications of the "vnfProductName" attribute
in "VnfInstance". See note.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/String"
vnfSoftwareVersion:
description: >
If present, this attribute signals modifications of the "vnfSoftwareVersion" attribute
in "VnfInstance". See note.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Version"
vnfdVersion:
description: >
If present, this attribute signals modifications of the "vnfdVersion" attribute
in "VnfInstance". See note.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Version"
StopType:
description: >
* FORCEFUL: The VNFM will stop the VNF instance immediately after accepting
the request.
* GRACEFUL: The VNFM instance will first arrange to take the VNF out of
service after accepting the request. Once that operation is successful
or once the timer value specified in the "gracefulStopTimeout" attribute
expires, the VNFM will stop the VNF instance.
type: string
enum:
- FORCEFUL
- GRACEFUL
CreateVnfSnapshotRequest:
description: >
This type represents request parameters for the "Create VNF Snapshot"
LCM operation which takes a snapshot of a VNF instance and populates
a previously-created "Individual VNF snapshot" resource with the content
of the snapshot.
It shall comply with the provisions defined in table 5.5.2.21-1.
type: object
required:
- vnfSnapshotResId
properties:
vnfSnapshotInfoId:
description: >
Identifier of the "Individual VNF snapshot" resource to which the
VNF snapshot is to be associated.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
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” defined in ETSI GS NFV-IFA 011 [10].
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"
userDefinedData:
description: >
User defined data for the VNF snapshot.
$ref: "../../General_Definitions/SOL003_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. It shall comply with the provisions
defined in table 5.5.2.20-1.
NOTE: The present attribute shall be provided if the "Individual VNF snapshot" resource is
requested to be created as part of a VNF snapshot package extraction.
type: object
properties:
vnfSnapshotPkgId:
description: |
Identifier of the VNF snapshot package information held by the NFVO. See note.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
vnfSnapshot:
description: |
Information about the VNF snapshot, content and/or reference to its content.
RevertToVnfSnapshotRequest:
description: >
This type represents request parameters for the "Revert to VNF Snapshot" operation.
type: object
properties:
vnfSnapshotInfoId:
description: >
Identifier of the "Individual VNF snapshot" resource with the information of the VNF snapshot
to be reverted to.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
additionalParams:
description: >
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” defined in ETSI GS NFV-IFA 011 [10].
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"
VnfSnapshotInfoModificationRequest:
description: |
This type represents attribute modifications for an "Individual VNF snapshot" resource, i.e. modifications
to a resource representation based on the "VnfSnapshotInfo" data type. The attributes of "VnfSnapshotInfo"
that can be modified according to the provisions in clause 5.5.2.22 are included in the
"VnfSnapshotInfoModificationRequest" data type. The "VnfSnapshotInfoModificationRequest" data type shall
comply with the provisions defined in table 5.5.2.24-1.
type: object
properties:
vnfSnapshotPkgId:
description: |
New value of the "vnfSnapshotPkgId" attribute in "VnfSnapshotInfo".
The value "null" is not permitted.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
vnfSnapshot:
description: |
New value of the "vnfSnapshot" attribute in "VnfSnapshotInfo".
The value "null" is not permitted.
VnfSnapshotInfoModifications:
description: |
This type represents attribute modifications that were performed on an "Individual VNF snapshot"
resource. The attributes that can be included consist of those requested to be modified explicitly
in the "VnfSnapshotInfoModificationRequest" data structure, and additional attributes of the
"VnfSnapshotInfo" data structure that were modified implicitly. The "VnfSnapshotInfoModifications"
data type shall comply with the provisions defined in table 5.5.2.25-1.
type: object
properties:
vnfSnapshotPkgId:
description: |
If present, this attribute signals modifications of the "vnfSnapshotPkgId" attribute in
"VnfSnapshotInfo" as defined in clause 5.5.2.22.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
vnfSnapshot:
description: |
If present, this attribute signals modifications of the "vnfSnapshot" attribute in
"VnfSnapshotInfo" as defined in clause 5.5.2.22.
$ref: "#/definitions/VnfSnapshot"
VnfInstance:
description: >
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
This type represents a VNF instance. It shall comply with the provisions defined in table 5.5.2.2-1.
NOTE: Clause B.3.2 provides examples illustrating the relationship among the different run-time
information elements (CP, VL and link ports) used to represent the connectivity of a VNF.
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.3).
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
properties:
id:
description: >
Identifier of the VNF instance.
$ref: "../../General_Definitions/SOL003_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: "../../General_Definitions/SOL003_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: "../../General_Definitions/SOL003_def.yaml#/definitions/Version"
vnfdVersion:
description: >
Identifies the version of the VNFD. The value is copied from the VNFD.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Version"
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 are declared in the VNFD. The declaration
of configurable properties in the VNFD can optionally contain the specification of initial values.
See notes 2, 3 and 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.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"
Information about VIM or CISM connections
to be used for managing the resources for
the VNF instance. The keys of the map, each
of which identifies information about a
particular VIM connection, are managed by
the NFVO and referenced from other data
structures via the "vimConnectionId"
attribute.
This attribute shall only be supported and
present if
- the resources of at least of the
VNFCs are managed by a VIM and
VNF-related resource management
in direct mode is applicable.
- the resources of at least of the
VNFCs are managed by a CISM.
This attribute can be modified with the
PATCH method.
type: object
additionalProperties:
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/VimConnectionInfo"
cirConnectionInfo:
description: >
Information about the CIR connection for
managing OS container images for the VNF
instance.
Shall be present when all or part of the VNF
is realized by a set of OS containers and
shall be absent otherwise.
type: object
additionalProperties:
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/VimConnectionInfo"
mciopRepositoryInfo:
description: >
Information about the MCIOP repository for
the VNF instance.
Shall be present when all or part of the VNF
is realized by a set of OS containers and
shall be absent otherwise.
See note 1.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/VimConnectionInfo"
instantiationState:
description: >
The instantiation state of the VNF.
Permitted values:
- NOT_INSTANTIATED: The VNF instance is terminated or not instantiated.
- INSTANTIATED: The VNF instance is instantiated.
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: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnfd"
vnfState:
description: >
The state of the VNF instance.
$ref: "#/definitions/VnfOperationalStateType"
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: "../../General_Definitions/SOL003_def.yaml#/definitions/ScaleInfo"
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: "../../General_Definitions/SOL003_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/VnfExtCpInfo"
piscione
committed
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
minItems: 1
items:
$ref: "#/definitions/VipCpInfo"
virtualCpInfo:
description: >
Virtual CPs that are part of the VNF instance. Shall be present when a particular Virtual CP
is associated to an external CP of the VNF instance.
May be present otherwise.
type: array