Newer
Older
# https://forge.etsi.org/etsi-forge-copyright-notice.txt
definitions:
InstantiateVnfRequest:
This type represents request parameters for the "Instantiate VNF" operation.
* 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.
* NOTE 5: If the referenced instantiationLevel or the targetScaleLevelInfo contain information related to VNFCs that are
not going to be instantiated due to the selection of deployable modules, the information is stored in the VNFM
for later use and included in the instantiatedVnfInfo. If none of the attributes is present, the information from the
defaultInstantiationLevel related to those VNFCs is stored and included in the instantiatedVnfInfo. If, during the
lifecycle of the VNF, as a result of a change of the selected deployable modules any of those VNFCs is going to
be instantiated, the stored information determines the number of instances, unless the request that triggered
the change also contains information about the number of instances.
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 and 5.
$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, 4, and 5.
$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 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"
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"
selectedDeployableModule:
description: >
Identifier of a selected deployable module. Only VNFCs based on VDUs that belong to deployable
modules listed in this attribute are requested to be instantiated.
type: array
items:
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnfd"
resourceCapacityDefinition:
description: >
Indicates values for resource capacity related attributes pertaining to a
descriptor. Values can only be provided for resource capacity related attributes
that have been defined in the VNFD as being configurable. Furthermore, provided
values shall be within the allowed values indicated in the VNFD.
type: array
items:
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/ResourceCapacityDefinition"
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).
* NOTE 4: In the case that the cloud native template included in the MCIOP describes the set of VNFC instances, an
instance of intCp need not be included for each VNFC instance as all instances would contain the same
information. It is sufficient to include one intCp for the related CPD. The case of using, for a scalable VDU, a
cloud native template in the MCIOP that describes one single VNFC instance is not specified in the present
document version
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 and 4.
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.
* 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.
$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"
selectedDeployableModule:
description: >
Identifier of a selected deployable module. Only VNFCs based on VDUs that belong to deployable
modules listed in this attribute are requested to be instantiated or preserved if they were already
instantiated.
type: array
items:
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnfd"
resourceCapacityDefinition:
description: >
Indicates values for resource capacity related attributes pertaining to a descriptor.
Values can only be provided for resource capacity related attributes that have been
defined in the VNFD as being configurable. Furthermore, provided values shall be within
the allowed values indicated in the VNFD.
type: array
items:
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/ResourceCapacityDefinition"
certificateConfigurationData:
description: >
Configuration for certificate management such as certificate profile and security policy in this VNF. Can
be present when setting a new certificate to the VNF instance in delegation mode. Otherwise shall not be
present.
This attribute shall be supported when delegation mode of certificate management is applicable.
$ref: "#/definitions/CertificateConfigurationData"
TerminateVnfRequest:
description: >
This type represents request parameters for the "Terminate VNF" operation.
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"
healingResource:
description: >
Indicates the kinds of the virtual resource to be healed.
Permitted values:
* VL
* LINKPORT
* STORAGE
* VIRTUALCP
* COMPUTE
* OSCONTAINER
Default value is COMPUTE when the VDUs of the VNF are realized by a set of virtual machines
and OSCONTAINER when the VDUs of the VNF are realized by a set of OS containers.
type: array
enum:
- VL
- LINKPORT
- STORAGE
- VIRTUALCP
- COMPUTE
- OSCONTAINER
OperateVnfRequest:
description: >
This type represents request parameters for the "Operate VNF" operation.
NOTE: The "stopType" and "gracefulStopTimeout" attributes shall be absent,
when the "changeStateTo" attribute is equal to "STARTED".
The "gracefulStopTimeout" attribute shall be present, when the "changeStateTo"
is equal to "STOPPED" and the "stopType" attribute is equal to "GRACEFUL".
The "gracefulStopTimeout" attribute shall be absent, when the "changeStateTo"
attribute is equal to "STOPPED" and the "stopType" attribute is equal to "FORCEFUL".
The request shall be treated as if the "stopType" attribute has been set to "FORCEFUL",
when the "changeStateTo" attribute is equal to "STOPPED" and the "stopType" attribute
is absent.
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"
certificateConfigurationData:
description: >
Configuration for certificate management such as certificate profile and security policy in this VNF. Can be
present when setting a new certificate to the VNF instance in delegation mode. Otherwise shall not be
present.This attribute shall be supported when delegation mode of certificate management is applicable.
$ref: "#/definitions/CertificateConfigurationData"
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.
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: Component mappings are defined in the VNFD in the source or destination package for the relevant change
path. See clause 7.1.15.2 in ETSI GS NFV-IFA 011 [13].
NOTE 4: In the current version of the present document, only Rolling upgrade and Blue-green
upgrade types are supported. The definition of additional upgrade types is left for future
specification.
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"
selectedDeployableModule:
description: >
Identifier of a selected deployable module.
If this attribute is present only VNFCs based on VDUs that belong to deployable modules listed
in this attribute are requested to be instantiated or preserved if they were already instantiated.
If this attribute is not present the deployable modules that were selected before the operation,
and that still are defined in the VNFD in the destination package, or the corresponding ones
according to the component mappings, remain valid. See note 3.
type: array
items:
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnfd"
resourceCapacityDefinition:
description: >
Indicates values for resource capacity related attributes pertaining to a descriptor.
Values can only be provided for resource capacity related attributes that have been
defined in the VNFD as being configurable. Furthermore, provided values shall be within
the allowed values indicated in the VNFD.
type: array
items:
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/ResourceCapacityDefinition"
certificateConfigurationData:
description: >
Configuration for certificate management such as certificate profile and security policy in this VNF.
Can be present when setting a new certificate to the VNF instance in delegation mode. Otherwise
shall not be present.This attribute shall be supported when delegation
mode of certificate management is applicable.
$ref: "#/definitions/CertificateConfigurationData"
upgradeType:
description: >
Indicates upgrade type when change the current VNF Package on which a VNF instance is based.
Permitted values:
* ROLLING_UPGRADE
* BLUE_GREEN
See note 4.
type: string
enum:
- ROLLING_UPGRADE
- BLUE_GREEN
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.
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.
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.
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"
SelectVnfDeployableModulesRequest:
description: >
This type represents request parameters for the "Select VNF deployable modules" operation.
* NOTE 1: Thus, the select VNF deployable modules operation cannot be used as a scale VNF operation
to scale VNFCs that were already instantiated.
* NOTE 2: Thus, the select VNF deployable modules operation cannot be used as a scale
VNF operation to vertically scale VNFCs that were already instantiated.
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
type: object
properties:
selectedDeployableModule:
description: >
Identifier of a selected deployable module, as defined in the VNFD.
VNFCs based on VDUs that belong to deployable modules listed in
this attribute will be instantiated if not already instantiated.
VNFCs based on VDUs that belong to deployable modules not listed in
this attribute and that were already instantiated will be terminated.
type: array
items:
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnfd"
targetScaleLevelInfo:
description: >
Defines the target scale levels of scaling aspects of the VDUs that
belong to selected deployable modules. If this attribute is not
present or if there are VDUs that belong to selected deployable
modules that take no part in any of the scaling aspects indicated in
this attribute, the VNFCs based on those VDUs shall be instantiated
according to the currently valid VNF scale level or instantiation
level. This attribute should only contain scale level information of
scaling aspects associated with VDUs that will be used to
instantiate VNFCs as a result of this operation. If it contains
other scale level information, it shall be ignored. See note.
type: array
items:
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/ScaleInfo"
resourceCapacityDefinition:
description: >
Indicates values for resource capacity related attributes pertaining to a descriptor.
Values can only be provided for resource capacity related attributes that have been defined
in the VNFD as being configurable. Furthermore, provided values shall be within the
allowed values indicated in the VNFD.
This attribute should only contain information about resource capacity related attributes
of VDUs that will be used to instantiate VNFCs as a result of this operation.
If it contains information about attributes of other VDUs it shall be ignored. See note 2.
type: array
items:
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/ResourceCapacityDefinition"
additionalParams:
description: >
Additional parameters passed by the NFVO as input to the selection
of deployable modules process, specific to the VNF being affected by
this operation, as declared in the VNFD as part of
"selectVnfDeployableModulesOpConfig" 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.
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.
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: >
This type represents a VNF instance.
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 [14] 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.
NOTE 7: Subports need not be used for containerized VNFCs. The application container can send and receive IP
packets with any VLAN tag as long as the network interface to connect to the secondary container cluster
network has been configured appropriately. Thus, no individual vnfcCpInfo, except the one representing
the trunk, need be modelled to allow traffic tagged with a particular VLAN through the connection point.
NOTE 8: For a scaling aspect whose related VNFCs have not been instantiated due to the selection of deployable
modules, the “scaleStatus” indicates the scale level that would be applicable to the aspect if a VNF LCM
operation changes the selected deployable modules and the related VNFCs are instantiated, unless the
VNF LCM operation explicitly indicates the scale level for the aspect.
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"
vnfConfigurableProperties:
description: >
Additional VNF-specific attributes that provide the current values of the configurable
properties of the VNF instance.
These attributes represent values that are stored persistently in the VnfInstance structure
and that correspond to configuration parameters of the VNF instance.
Modifying these attributes affects the configuration of the VNF instance either directly
(if the VNF instance is in INSTANTIATED state at the time of the modification) or as part
of the subsequent VNF instantiation operation (if the VNF instance is in NOT_INSTANTIATED
state at the time of the modification).
Configurable properties referred in these attributes 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 Content" 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.
If VIM connection information is provisioned to the VNFM by means outside the scope of
the present document, the information in the "vimConnectionInfo" attribute provides
necessary information for binding the VnfInstance representing the "Individual VNF
instance" to the applicable VIM connection information used to perform resource
management for the VNF instance. See also the definition of the "VimConnectionInfo" in
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"
certificateInfo:
description: >
Information about certificate and certificate management in this VNF. Shall be present
when using delegation mode, otherwise shall be absent.This attribute can be modified with the
PATCH method.Content of this attribute shall not be either added (if previously not set) or removed (if
previously set) by using the Modify VNF Information operation. See note 3.
$ref: "#/definitions/CertificateInfo"
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.
For an aspect that has not been deployed because the related deployableModule has
not been selected, it indicates the scale level that has been requested in the instantiation
or in a scaling operation, or, if none has been requested in any of them, the scale level
applicable to the aspect based on the default instantiation level. See note 8.
$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"
selectedDeployableModule:
description: >
References a currently selected deployable module, as defined in the VNFD, that has
already completed the instantiation of its VNFCs.
type: array
items:
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnfd"
resourceCapacityDefinition:
description: >
Shows current values of VDU attributes related to resource capacity,
if different to the default values from the VNFD, as indicated in the
(one or more) request(s) of all completed VNF LCM operation(s) that
contain this attribute. If an attribute value has been modified multiple times,
only the last value is shown. The values indicated in this attribute are
applicable to all VNFC instances based on the VDU to which the
resourceCapacityDefinition is related.
type: array
items:
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/ResourceCapacityDefinition"
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.See note 7.
$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
items:
$ref: "#/definitions/VirtualCpInfo"
extVirtualLinkInfo:
description: >
Information about the external VLs the VNF instance is connected to.
type: array
items:
$ref: "#/definitions/ExtVirtualLinkInfo"
extManagedVirtualLinkInfo:
description: >
Information about the externally-managed internal VLs of the VNF instance. See notes 5 and 6.
$ref: "#/definitions/ExtManagedVirtualLinkInfo"
monitoringParameters:
description: >
Active monitoring parameters.
type: array
items:
$ref: "#/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:
$ref: "#/definitions/VnfcResourceInfo"
vnfVirtualLinkResourceInfo:
Information about the virtualised network resources used by the VLs of the VNF instance. See note 6.
type: array
items:
$ref: "#/definitions/VnfVirtualLinkResourceInfo"
virtualStorageResourceInfo:
description: >
Information on the virtualised storage resource(s) used as storage for the VNF instance.
type: array
items:
$ref: "#/definitions/VirtualStorageResourceInfo"
mcioInfo:
description: >
Information on the MCIO(s) representing
VNFC instance(s) realized by one or a set of
OS containers and created from the same
VDU for the VNF instance.
type: array
items:
$ref: "#/definitions/McioInfo"
vnfPaasServiceInfo:
description: >
Information on the PaaS Services assigned and used by the VNF instance.
type: array
items:
$ref: "#/definitions/PaasServiceInfo"
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 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. See notes 2 and 4.
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 (see note 4) or with values
passed in the CreateVnfRequest structure (see clause 5.4.2.3.1).
These attributes can be created, modified or removed with the PATCH method.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"
extensions:
description: >
Additional VNF-specific attributes that affect the lifecycle management of this VNF instance.
These attributes represent values that are stored persistently in the VnfInstance structure for
consumption by the VNFM or 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 notes 2 and 4. The VNFM shall reject requests to write extension attributes
that are not declared in the VNFD with a "422 Unprocessable Content" error response as defined in clause
6.4 of ETSI GS NFV-SOL 013.
Modifying the values of these attributes has no direct effect on the VNF instance; however, the modified
attribute values can be considered during subsequent VNF lifecycle management operations, which means that
the modified values can indirectly affect the configuration of the VNF instance.
These attributes can be initialized with default values from the VNFD (see note 4).
These attributes can be modified with values passed in the request structures of certain LCM operations,
Further, these attributes 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"
_links:
description: >
Links to resources related to this resource.
type: object
required:
- self
properties:
self:
description: URI of this resource.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Link"
indicators:
description: Indicators related to this VNF instance, if applicable.
$ref: "../../General_Definitions/SOL003_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: "../../General_Definitions/SOL003_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: "../../General_Definitions/SOL003_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: "../../General_Definitions/SOL003_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: "../../General_Definitions/SOL003_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: "../../General_Definitions/SOL003_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: "../../General_Definitions/SOL003_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: "../../General_Definitions/SOL003_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: "../../General_Definitions/SOL003_def.yaml#/definitions/Link"
createSnapshot:
description: >
Link to the "Create VNF snapshot task" resource, if the related operation is
supported for this VNF instance and is possible based on the current status of
this VNF instance resource (i.e., VNF instance is in INSTANTIATED state).
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Link"
revertToSnapshot:
description: >
Link to the "Revert to VNF snapshot task" resource, if the related operation is
supported for this VNF instance and is possible based on the current status of
this VNF instance resource (i.e., VNF instance is in INSTANTIATED state).
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Link"
changeCurrentVnfPkg:
description: >
Link to the "Change current VNF package 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: "../../General_Definitions/SOL003_def.yaml#/definitions/Link"
ExtManagedVirtualLinkInfo:
type: object
required:
- id
- vnfVirtualLinkDescId
- networkResource
properties:
id:
description: >
Identifier of the externally-managed internal VL and the related
externally-managed VL information instance.
The identifier is assigned by the NFV-MANO entity that manages this
VL instance.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
vnfVirtualLinkDescId:
description: >
Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
vnfdId:
description: >
Identifier of the VNFD.
Shall be present in case the value differs from the vnfdId attribute of the VnfInstance (e.g. during a "Change
current VNF package" operation or due to its final failure).
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
networkResource:
description: >
Reference to the VirtualNetwork resource providing this VL.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/ResourceHandle"
vnfLinkPorts:
description: >
Link ports of this VL.
type: array
items:
$ref: "#/definitions/VnfLinkPortInfo"
vnfNetAttDefResource:
description: >
Network attachment definition resources that provide the specification of the interface to attach connection
points to this VL.
type: array
items:
$ref: "#/definitions/NetAttDefResourceInfo"
extManagedMultisiteVirtualLinkId:
description: >
Identifier of the externally-managed multi-site VL instance. The identifier is assigned by the NFV-MANO entity
that manages the externally managed multi-site VL instance. It shall be present when the externally-managed
internal VL 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"
VirtualStorageResourceInfo:
description: >
This type represents the information that allows addressing a virtualised
resource that is used by a VNF instance.
Note: If only the value or the presence of this attribute is changed in the "VirtualStorageResourceInfo"
structure by an LCM operation occurrence, this does not represent a change that requires
including a related "AffectedVirtualStorage" structure in the VNF LCM operation occurrence
notifications or the "VnfLcmOpOcc" structure related to this LCM operation occurrence.
type: object
required:
- id
- virtualStorageDescId
- storageResource
properties:
id:
description: >
Identifier of this VirtualStorageResourceInfo instance.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
virtualStorageDescId:
description: >
Identifier of the VirtualStorageDesc in the VNFD.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnfd"
vnfdId:
description: >
Identifier of the VNFD.
Shall be present in case the value differs from the vnfdId attribute of the VnfInstance (e.g. during a "Change
current VNF package" operation or due to its final failure). See note.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
storageResource:
description: >
Reference to the VirtualStorage resource or reference to a Storage MCIO.
$ref: "../../General_Definitions/SOL003_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
VirtualStorage resource is placed. Shall be provided if this
information is available from the VIM.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
reservationId:
description: >
The reservation identifier applicable to the resource. It shall be
present when an applicable reservation exists.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
metadata:
description: >
Metadata about this resource.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"
This type represents the information on virtualised compute and storage resources used by a VNFC in a VNF instance.
Depending on the form of virtualisation container of the VNFC:
- For a VNFC based on VM, a reference to the corresponding VirtualCompute shall be provided, and
- For a VNFC based on OS container(s), a reference to the Compute MCIO shall be provided. Hence, exposure of
information by the VNFM to the NFVO is at the MCIO level.
In addition, the references to the storage resources depend on the form of the VNFC:
a) For a VNFC based on VM, storage resource identifiers shall refer to VirtualStorage resources, and
b) For a VNFC based on OS container(s), storage resource identifiers shall refer to Storage MCIOs.
NOTE 1: ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD based on
TOSCA specifications.
NOTE 2: A VNFC CP is "connected to" an external CP if the VNFC CP is connected to an
internal VL that exposes an external CP. A VNFC CP is "exposed as" an external
CP if it is connected directly to an external VL.
NOTE 3: The information can be omitted because it is already available as part of the
external CP information.
NOTE 4: If only the value or the presence of this attribute is changed in the "VnfcResourceInfo"
structure by an LCM operation occurrence, this does not represent a change that requires
including a related "AffectedVnfc" structure in the VNF LCM operation occurrence notifications
or the "VnfLcmOpOcc" structure related to this LCM operation occurrence.
NOTE 5: Cardinality greater than 1 is only applicable for specific cases where more than one network attachment
definition resource is needed to fulfil the connectivity requirements of the internal CP, e.g. to build a link
redundant mated pair in SR-IOV cases.
NOTE 6: When more than one netAttDefResourceId is indicated, all shall belong to the same namespace.
NOTE 7: Subports need not be used for containerized VNFCs. The application container can send and receive IP
packets with any VLAN tag as long as the network interface to connect to the secondary container cluster
network has been configured appropriately. Thus, no individual vnfcCpInfo, except the one representing the
trunk, need be modelled to allow traffic tagged with a particular VLAN through the connection point.
type: object
required:
- id
- vduId
- computeResource
properties:
id:
description: >
Identifier of this VnfcResourceInfo instance.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
Reference to the applicable VDU in the VNFD. See note 1.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnfd"
vnfdId:
description: >
Identifier of the VNFD.
Shall be present in case the value differs from the vnfdId attribute of the VnfInstance (e.g. during a "Change
current VNF package" operation or due to its final failure). See note 4.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
Reference to the VirtualCompute resource or reference to a Compute MCIO.
$ref: "../../General_Definitions/SOL003_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: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
References to the VirtualStorage resources or references to Storage MCIOs.
The value refers to a VirtualStorageResourceInfo item in the VnfInstance.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
reservationId:
description: >
The reservation identifier applicable to the resource. It shall be
present when an applicable reservation exists.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
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. See note 7.
type: array
items:
type: object
required:
- id
- cpdId
properties:
id:
description: >
Identifier of this VNFC CP instance and the associated array
entry.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
Identifier of the VDU CPD, cpdId, in the VNFD. See note 1.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnfd"
Identifier of the related external CP. Shall be present when the VNFC CP is exposed as an
external CP of the VNF instance or connected to an external CP of the VNF instance (see note 2)
and shall be absent otherwise.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
Network protocol information for this CP. May be omitted if the VNFC CP is exposed as an external CP.
See note 3.
$ref: "#/definitions/CpProtocolInfo"
Identifier of the "VnfLinkPortInfo" structure in the "VnfVirtualLinkResourceInfo" or "ExtManagedVirtualLinkInfo" structure.
Shall be present if the CP is associated to a link port on an internal VL (including externally-managed internal VL)
of the VNF instance and shall be absent otherwise.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
parentCpId:
description: >
Identifier of another VNFC CP instance that corresponds to the parent port of a trunk that the present VNFC CP
instance participates in. Shall be provided if the present CP instance participates in a trunk as subport, and
the referred VNFC CP instances are also present in the vnfcCpInfo attribute.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
netAttDefResourceId:
description: >
Identifier of the “NetAttDefResourceInfo” structure that provides the specification of the interface to attach the
connection point to a secondary container cluster network. See notes 5 and 6.
It shall be present if the internal CP is associated to a VNFC realized by one or a set of OS containers and is
connected to a secondary container cluster network. It shall not be present otherwise.
type: array
items:
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
metadata:
description: >
Metadata about this CP.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"
certificateContentId:
description: >
Identifier of the "CertificateContent" structure that provides the information of the certificate that this VNFC
CP instance uses. Shall be present when using in delegation-mode. Otherwise shall not be present.
This attribute shall be supported when delegation mode in certificate management is applicable
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
metadata:
description: >
Metadata about this resource.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"
certificateContentId:
description: >
Identifier of the "CertificateContent" structure that provides the information of the certificate that this VNFC
instance uses. Shall be present when using in delegation-mode. Otherwise shall not be present.
This attribute shall be supported when delegation mode in certificate management is applicable.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
VnfSnapshotInfo:
description: >
This type represents an "Individual VNF snapshot" resource.
type: object
required:
- id
- _links
properties:
id:
description: >
Identifier of the "Individual VNF snapshot" resource. This identifier is allocated by the VNFM.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
vnfSnapshotPkgId:
description: >
Identifier of the VNF snapshot package information held by the NFVO. Shall be present when the
“Individual VNF snapshot" resource is created from a VNF snapshot package extraction.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
vnfSnapshot:
description: >
Information about the VNF snapshot, content and/or references to its content. Shall be present
when the "Individual VNF snapshot" resource is associated to a VNF snapshot created via the
corresponding "Create VNF Snapshot" task resource or extracted from a VNF snapshot package.
$ref: "#/definitions/VnfSnapshot"
_links:
description: >
Links to resources related to this resource.
type: object
required:
- self
properties:
self:
description: >
URI of this resource.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Link"
takenFrom:
description: >
Link to the VNF instance from which this snapshot was taken. Shall be present when the
"Individual VNF snapshot" resource is associated to a VNF snapshot created via the
corresponding "Create VNF snapshot" task resource.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Link"
VnfStateSnapshotInfo:
description: >
This type represents information about VNF-specific state snapshot data.
type: object
required:
- checksum
- isEncrypted
properties:
checksum:
description: >
Checksum of the VNF state snapshot file. Hash algorithms applicable to VNF snapshot package artifacts
are defined in ETSI GS NFV-SOL 010.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Checksum"
isEncrypted:
description: >
Reflects whether the VNF state snapshot content is encrypted (true) or not (false).
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Boolean"
metadata:
description: >
The metadata with additional information such as content type, size, creation date, etc.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"
VnfSnapshot:
description: >
This type represents a VNF snapshot.
type: object
required:
- id
- vnfInstanceId
- triggeredAt
- vnfdId
- vnfInfo
- vnfcSnapshots
properties:
id:
description: >
Identifier of the VNF Snapshot. This identifier is allocated by the VNFM.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
vnfInstanceId:
description: >
Identifier of the snapshotted VNF instance.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
creationStartedAt:
description: >
Timestamp indicating when the VNF snapshot creation has been started by the VNFM.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/DateTime"
creationFinishedAt:
description: >
Timestamp indicating when the VNF snapshot has been completed by the VNFM.
Shall be present once the VNF snapshot creation has been completed.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/DateTime"
vnfdId:
description: >
Identifier of the VNFD in use at the time the snapshot of the VNF instance has been created.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
vnfInstance:
description: >
VNF Instance information of the snapshotted VNF instance. This is a copy of the "ndividual VNF instance" resource.
$ref: '#/definitions/VnfInstance'
vnfcSnapshots:
description: >
Information about VNFC snapshots constituting this VNF snapshot.
type: array
items:
$ref: '#/definitions/VnfcSnapshotInfo'
vnfStateSnapshotInfo:
description: >
Information about VNF-specific state snapshot data.
This attribute shall not be present before the VNF snapshot has been completed.
Otherwise, this attribute shall be present if the VNF snapshot has associated
additional VNF-specific state data.
$ref: '#/definitions/VnfStateSnapshotInfo'
userDefinedData:
description: >
User defined data for the VNF snapshot.
$ref: "../../General_Definitions/SOL003_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: "../../General_Definitions/SOL003_def.yaml#/definitions/Link"
vnfStateSnapshot:
description: >
Link to the "VNF state snapshot" resource. This attribute shall not be
present before the VNF snapshot has been completed. Otherwise, this
attribute shall be present if the VNF snapshot has associated additional
VNFspecific state data.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Link"
This type represents a VNFC snapshot.
NOTE 1: The identifier of the compute snapshot resource is assigned during creation of a VNFC snapshot
being returned from the VIM as output data in the response message of the individual resource
operations. This attribute shall only be present for a VNFC snapshot that has been newly created
by the VNFM as a result of the "Create VNF snapshot task".
NOTE 2: The identifier of the storage snapshot resource is assigned during creation of a VNFC snapshot being
returned from the VIM as output data in the response message of the individual resource operations.
This attribute shall only be present for a VNFC snapshot with an associated storage resource and that
has been newly created by the VNFM as a result of the "Create VNF snapshot task".
type: object
required:
- id
- vnfcInstanceId
- triggeredAt
- vnfcResourceId
properties:
id:
description: >
Identifier of the information held by the VNFM about a specific VNFC snapshot. This identifier is allocated by
the VNFM and is unique within the scope of a VNF snapshot.
The attribute also identifies the compute snapshot image associated to this VNFC snapshot within the context of
a referred VNF snapshot.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierLocal"
vnfcInstanceId:
description: >
Identifier of the snapshotted VNFC instance.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
creationStartedAt:
description: >
Timestamp indicating when the VNF snapshot creation has been started by the VNFM.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/DateTime"
creationFinishedAt:
description: >
Timestamp indicating when the VNFC snapshot has been completed. Shall be present once the VNFC snapshot
creation has been completed by the VNFM.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/DateTime"
vnfcResourceInfoId:
description: >
Reference to the "VnfcResourceInfo" structure in the "VnfInstance" structure that represents the resource
of the snapshotted VNFC instance. A snapshot of that structure is available in the "vnfInstance" attribute
of the "VnfSnapshot" structure.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
Reference to a compute snapshot resource. See note 1.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/ResourceHandle"
storageSnapshotResources:
description: >
Mapping of the storage resources associated to the VNFC with the storage snapshot resources.
type: array
items:
type: object
required:
- storageResourceId
properties:
storageResourceId:
description: >
Reference to the "VirtualStorageResourceInfo" structure in the "VnfInstance" structure
that represents the virtual storage resource.
The attribute also identifies the storage snapshot image associated to this VNFC snapshot
within the context of a referred VNF snapshot.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
Reference to a storage snapshot resource. See note 2.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"
userDefinedData:
description: >
User defined data for the VNFC snapshot.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"
VnfVirtualLinkResourceInfo:
description: >
This type represents the information that allows addressing a virtualised
resource that is used by an internal VL instance in a VNF instance.
Note: If only the value or the presence of this attribute is changed in the "VnfVirtualLinkResourceInfo"
structure by an LCM operation occurrence, this does not represent a change that requires including
a related "AffectedVirtualLink" structure in the VNF LCM operation occurrence notifications or the
"VnfLcmOpOcc" structure related to this LCM operation occurrence.
type: object
required:
- id
- vnfVirtualLinkDescId
- networkResource
properties:
id:
description: >
Identifier of this VnfVirtualLinkResourceInfo instance.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
vnfVirtualLinkDescId:
description: >
Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnfd"
vnfdId:
description: >
Identifier of the VNFD.
Shall be present in case the value differs from the vnfdId attribute of the VnfInstance (e.g. during a "Change
current VNF package" operation or due to its final failure). See note.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
Reference to the VirtualNetwork resource or reference to a Network MCIO.
$ref: "../../General_Definitions/SOL003_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
VirtualNetwork resource is placed. Shall be provided if this
information is available from the VIM.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
reservationId:
description: >
The reservation identifier applicable to the resource. It shall be
present when an applicable reservation exists.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
vnfLinkPorts:
description: >
Links ports of this VL.
Shall be present when the linkPort is used for external connectivity
by the VNF (refer to VnfLinkPortInfo).
May be present otherwise.
type: array
items:
$ref: "#/definitions/VnfLinkPortInfo"
metadata:
description: >
Metadata about this resource.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"
This type provides information about added, deleted, modified and temporary VNFCs.
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".
type: object
required:
- id
- vduId
- changeType
- computeResource
properties:
id:
description: >
Identifier of the Vnfc instance, identifying the applicable
"vnfcResourceInfo" entry in the "VnfInstance" data type.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
vduId:
description: >
Identifier of the related VDU in the VNFD.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnfd"
vnfdId:
description: >
Identifier of the VNFD.
Shall be present in case of a "change current VNF Package" to identify whether the affected
VNFC instance is associated to a VDU which is referred from the source or destination VNFD.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
changeType:
description: >
Signals the type of change. Permitted values:
* ADDED
* REMOVED
* MODIFIED
* TEMPORARY
For a temporary resource, an AffectedVnfc structure exists as long
as the temporary resource exists.
type: string
enum:
- ADDED
- REMOVED
- MODIFIED
- TEMPORARY
computeResource:
description: >
Reference to the VirtualCompute resource or reference to a Compute MCIO.
Detailed information is (for new and modified resources) or has been (for removed resources)
available from the VIM or the CISM.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/ResourceHandle"
The identifier of the "ResourceDefinition" in the granting exchange related to the LCM operation
occurrence. It shall be present when an applicable GrantInfo for thegranted resource exists. See note.
$ref: "../../General_Definitions/SOL003_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 VirtualCompute resource is placed.
Shall be provided if this information is available from the VIM.
$ref: "../../General_Definitions/SOL003_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 VnfcResourceInfo structure.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"
affectedVnfcCpIds:
description: >
Identifiers of CP(s) of the VNFC instance that were affected by the
change.
Shall be present for those affected CPs of the VNFC instance that
are associated to an external CP of the VNF instance.
May be present for further affected CPs of the VNFC instance.
type: array
items:
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
addedStorageResourceIds:
description: >
References to VirtualStorage resources that have been added. Each
value refers to a VirtualStorageResourceInfo item in the
VnfInstance that was added to the VNFC. It shall be provided if at
least one storage resource was added to the VNFC.
type: array
items:
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
removedStorageResourceIds:
description: >
References to VirtualStorage resources that have been removed.
The value contains the identifier of a VirtualStorageResourceInfo
item that has been removed from the VNFC, and might no longer exist
in the VnfInstance.
It shall be provided if at least one storage resource was removed
from the VNFC.
type: array
items:
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
This type represents a VNF lifecycle management operation occurrence.
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: Not more than one of changedInfo and modificationsTriggeredByVnfPkgChange
shall be present.
NOTE 3: For a particular affected VL, there shall be as many "AffectedVirtualLink"
entries as needed for signalling the different types of changes, i.e. one
per virtual link and change type. For instance, in the case of signaling
affected VL instances involving the addition of a particular VL instance
with links ports, one "AffectedVirtualLink" entry signals the addition of
the VL by using the "changeType" attribute of "AffectedVirtualLink" structure
equal to "ADDED", and another "AffectedVirtualLink" entry signals the addition
of externally visible VNF link ports of the VL by using the "changeType" equal
to "LINK_PORT_ADDED".
NOTE 4: A coordination action has timed out if the VNFM has not been able to read the
"Individual coordination action" resource within a timeout interval after requesting
the coordination to be started or to be cancelled. The length of the timeout interval
is defined by means outside the scope of the present document.
NOTE 5: The list of rejected coordinations may be garbage collected if the LCM operation
occurrence has reached a terminal state, i.e. one of "COMPLETED", "FAILED" and "ROLLED_BACK".
type: object
oneOf:
- required:
- changedInfo
- required:
- modificationsTriggeredByVnfPkgChange
required:
- id
- operationState
- stateEnteredTime
- startTime
- vnfInstanceId
- operation
- isAutomaticInvocation
- isCancelPending
properties:
id:
description: >
Identifier of this VNF lifecycle management operation occurrence.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
operationState:
description: >
The state of the LCM operation.
$ref: "#/definitions/LcmOperationStateType"
stateEnteredTime:
description: >
Date-time when the current state has been entered.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/DateTime"
startTime:
description: >
Date-time of the start of the operation.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/DateTime"
vnfInstanceId:
description: >
Identifier of the VNF instance to which the operation applies
$ref: "../../General_Definitions/SOL003_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: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
operation:
description: >
Type of the actual LCM operation represented by this VNF LCM
operation occurrence.
$ref: "../../General_Definitions/SOL003_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: "../../General_Definitions/SOL003_def.yaml#/definitions/Boolean"
operationParams:
description: >
Input parameters of the LCM operation. This attribute shall be
formatted according to the request data type of the related LCM
operation. In addition, the provisions in clause 5.7 shall apply.
The following mapping between operationType and the
data type of this attribute shall apply:
* INSTANTIATE: InstantiateVnfRequest
* SCALE: ScaleVnfRequest
* SCALE_TO_LEVEL: ScaleVnfToLevelRequest
* CHANGE_FLAVOUR: ChangeVnfFlavourRequest
* OPERATE: OperateVnfRequest
* HEAL: HealVnfRequest
* CHANGE_EXT_CONN: ChangeExtVnfConnectivityRequest
* TERMINATE: TerminateVnfRequest
* MODIFY_INFO: VnfInfoModifications
* CREATE_SNAPSHOT: CreateVnfSnapshotRequest
* REVERT_TO_SNAPSHOT: RevertToVnfSnapshotRequest
* CHANGE_VNFPKG: ChangeCurrentVnfPkgRequest
* SELECT_DEPL_MODS: SelectVnfDeployableModulesRequest
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: "../../General_Definitions/SOL003_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/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: "../../General_Definitions/SOL003_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.
See note 1.
type: array
items:
$ref: "#/definitions/AffectedVnfc"
affectedVirtualLinks:
description: >
Information about VL instances that were affected during the lifecycle operation.
See notes 1 and 3.
type: array
items:
$ref: "#/definitions/AffectedVirtualLink"
affectedExtLinkPorts:
description: >
Information about external VNF link ports that were affected during the lifecycle operation.
See note 1.
$ref: "#/definitions/AffectedExtLinkPort"
Information about virtualised storage instances that were affected during the lifecycle operation.
See note 1.
type: array
items:
$ref: "#/definitions/AffectedVirtualStorage"
changedInfo:
description: >
Information about the changed VNF instance information, including VNF configurable properties,
if applicable. See note 1 and note 2.
$ref: "#/definitions/VnfInfoModifications"
piscione
committed
affectedVipCps:
description: >
Information about virtual IP CP instances that were affected during
the execution of the lifecycle management operation.
type: array
items:
$ref: "#/definitions/AffectedVipCp"
Information about changed external connectivity, if applicable. See note 1.
$ref: "#/definitions/ExtVirtualLinkInfo"
modificationsTriggeredByVnfPkgChange:
description: >
Information about performed changes of "VnfInstance" attributes triggered by changing the current VNF package,
if applicable. Shall be absent if the "operation" attribute is different from "CHANGE_VNFPKG".
See notes 1 and 2.
$ref: "#/definitions/ModificationsTriggeredByVnfPkgChange"
vnfSnapshotInfoId:
description: >
Identifier of the "individual VNF snapshot" resource. Shall be present if applicable to the type of LCM operation,
i.e., if the value of the "operation" attribute is either "CREATE_SNAPSHOT" or "REVERT_TO_SNAPSHOT".
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
piscione
committed
lcmCoordinations:
description: >
Information about LCM coordination actions (see clause 10 in ETSI GS NFV-SOL002) related to this LCM operation occurrence.
type: array
items:
type: object
required:
- id
- coordinationActionName
- startTime
- endpointType
properties:
id:
description: >
Identifier of this coordination action.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
piscione
committed
coordinationActionName:
description: >
Indicator of the actual coordination action.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
piscione
committed
coordinationResult:
description: >
The result of executing the coordination action which also implies the action to be performed by the VNFM as
the result of this coordination.
Shall be present if the coordination has been finished. Shall be absent if the coordination is ongoing or has
timed out (see note 4).
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/LcmCoordResultType"
piscione
committed
startTime:
description: >
The time when the VNFM has received the confirmation that the coordination action has been started.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/DateTime"
piscione
committed
endTime:
description: >
The time when the VNFM has received the confirmation that the coordination action has finished or has been
cancelled, or the time when a coordination action has timed out. Shall be present for a coordination
action that has finished or timed out (see note 4) and shall be absent if the coordination is ongoing.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/DateTime"
delay:
description: >
The end of the delay period.
This attribute shall be present if the last known HTTP response related to this coordination has
contained a "Retry-After" header, and shall be absent otherwise.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/DateTime"
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
endpointType:
description: >
The endpoint type used by this coordination action.
Valid values:
• MGMT: coordination with other operation supporting management systems (e.g. EM)
• VNF: coordination with the VNF instance
type: string
enum:
- MGMT
- VNF
rejectedLcmCoordinations:
description: >
Information about LCM coordination actions (see clause 10 in ETSI GS NFV-SOL002) that were rejected
by 503 error which means they can be tried again after a delay. See note 5.
type: array
items:
type: object
required:
- coordinationActionName
- rejectionTime
- endpointType
- delay
properties:
coordinationActionName:
description: >
Indicator of the actual coordination action.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
rejectionTime:
description: >
The time when the VNFM has received the 503 response that rejects the actual coordination.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/DateTime"
delay:
description: >
The end of the delay period, as calculated from the startTime and "Retry-After" header.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/DateTime"
piscione
committed
endpointType:
description: >
The endpoint type used by this coordination action.
Valid values:
• MGMT: coordination with other operation supporting management systems (e.g. EM)
• VNF: coordination with the VNF instance
type: string
enum:
- MGMT
- VNF
warnings:
description: >
Warning messages that were generated while the operation was executing.
If the operation has included LCM coordination actions and these have resulted
in warnings, such warnings should be added to this attribute.
type: array
items:
type: string
_links:
description: >
Links to resources related to this resource.
type: object
required:
- self
- vnfInstance
properties:
self:
description: >
URI of this resource.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Link"
vnfInstance:
description: >
Link to the VNF instance that the operation applies to.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Link"
grant:
description: >
Link to the grant for this operation, if one exists.
$ref: "../../General_Definitions/SOL003_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: "../../General_Definitions/SOL003_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: "../../General_Definitions/SOL003_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: "../../General_Definitions/SOL003_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: "../../General_Definitions/SOL003_def.yaml#/definitions/Link"
vnfSnapshot:
description: >
Link to the VNF snapshot resource, if the VNF LCM operation occurrence is related to a VNF snapshot.
Shall be present if operation="CREATE_SNAPSHOT" or operation="REVERT_TO_SNAPSHOT".
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Link"
AffectedExtLinkPort:
description: >
This type provides information about added and deleted external link ports (link ports attached to external virtual links).
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".
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: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
changeType:
description: >
Signals the type of change.
Permitted values:
- ADDED
- REMOVED
type: string
enum:
- ADDED
- REMOVED
extCpInstanceId:
description: >
Identifier of the related external CP instance.
$ref: "../../General_Definitions/SOL003_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: "../../General_Definitions/SOL003_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.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierLocal"
VnfLcmOperationOccurrenceNotification:
description: >
This type represents a VNF lifecycle management operation occurrence notification, which
informs the receiver of changes in the VNF lifecycle caused by a VNF LCM operation occurrence.
The support of the notification is mandatory.
This notification shall be triggered by the VNFM when there is a change in the state of a VNF LCM
operation occurrence that changes the VNF lifecycle, which represents an occurrence of one the
following LCM operations:
- Instantiation of the VNF
- Scaling of the VNF instance (including auto-scaling)
- Healing of the VNF instance (including auto-healing)
- Change of the state of the VNF instance (i.e. Operate VNF)
- Change of the deployment flavour of the VNF instance
- Change of the external connectivity of the VNF instance
- Change of the current VNF package
- Selection of deployable modules of the VNF instance
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
- Termination of the VNF instance
- Modification of VNF instance information and/or VNF configurable properties through the "PATCH"
method on the "Individual VNF instance" resource
- Creation of a VNF snapshot
- Reversion of the VNF instance to a VNF snapshot
Clause 5.6.2 defines the states and state transition of a VNF LCM operation occurrence, and also
specifies details of the notifications to be emitted at each state transition.
If this is the initial notification about the start of a VNF LCM operation occurrence, it is assumed
that the notification is sent by the VNFM before any action (including sending the grant request) is
taken as part of the LCM operation. Due to possible race conditions, the "start" notification, the grant
request and the LCM operation acknowledgment (i.e. the "202 Accepted" response) can arrive in any order
at the NFVO, and the NFVO shall be able to handle such a situation.
If this is a notification about a final or intermediate result state of a VNF LCM operation occurrence,
the notification shall be sent after all related actions of the LCM operation that led to this state have
been executed.
The new state shall be set in the "Individual VNF LCM operation occurrence" resource before the notification
about the state change is sent.
The amount of information provided in the LCM operation occurrence notifications to be issued by the VNFM when
a particular subscription matches can be controlled by the API consumer using the "verbosity" attribute in the
subscription request (see clause 5.5.2.15). The "verbosity" setting in a particular individual subscription shall
only apply to the LCM operation occurrence notifications triggered by that subscription. However, it shall not
affect the amount of information in the "VnfLcmOpOcc" structure (see clause 5.5.2.13) which represents the "Individual
LCM operation occurrence" resource associated with each of the notifications.
See clause 5.6.2.2 for further provisions regarding sending this notification, including in cases of handling LCM
operation errors.
NOTE 1: Shall be present if the "notificationStatus" is set to "RESULT", the "verbosity" attribute is set to "FULL"
and the operation has performed any resource modification. Shall be absent otherwise. This attribute contains
information about the cumulative changes to virtualised resources that were performed so far by the VNF LCM
operation occurrence and by any of the error handling procedures for that operation occurrence.
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".
Note 3: Not more than one of changedInfo and modificationsTriggeredByVnfPkgChange shall be present.
type: object
required:
- id
- notificationType
- subscriptionId
- timeStamp
- notificationStatus
- operationState
- vnfInstanceId
- operation
- isAutomaticInvocation
- vnfLcmOpOccId
- _links
properties:
id:
description: >
Identifier of this notification. If a notification is sent multiple
times due to multiple subscriptions, the "id" attribute of all these
notifications shall have the same value.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
notificationType:
description: >
Discriminator for the different notification types. Shall be set to
"VnfLcmOperationOccurrenceNotification" for this notification type.
type: string
enum:
- VnfLcmOperationOccurrenceNotification
subscriptionId:
description: >
Identifier of the subscription that this notification relates to.Shall be set to the value of the "id" attribute
of the "LccnSubscription" representing the associated "Individual subscription" resource.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
timeStamp:
description: >
Date-time of the generation of the notification.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/DateTime"
notificationStatus:
description: >
Indicates whether this notification reports about the start of a
lifecycle operation or the result of a lifecycle operation.
Permitted values:
* START: Informs about the start of the VNF LCM operation
occurrence.
* RESULT: Informs about the final or intermediate result of the VNF
LCM operation occurrence.
type: string
enum:
- START
- RESULT
operationState:
description: >
The state of the VNF LCM operation occurrence.
$ref: "#/definitions/LcmOperationStateType"
vnfInstanceId:
description: >
The identifier of the VNF instance affected.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
operation:
description: >
The lifecycle management operation.
$ref: "../../General_Definitions/SOL003_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.
type: boolean
verbosity:
description: >
This attribute signals the verbosity of the notification. If it is not present, it shall default to the value "FULL".
If the value is "SHORT", full change details can be obtained by performing a GET request on the "Individual LCM
operation occurrence" resource that is signalled by the "vnfLcmOpOcc" child attribute of the "_links" attribute.
$ref: '#/definitions/LcmOpOccNotificationVerbosityType'
vnfLcmOpOccId:
description: >
The identifier of the VNF lifecycle management operation occurrence associated to the notification. Shall be
set to the value of the "id" attribute of the "VnfLcmOpOcc" representing the associate "Individual VNF lifecycle
management operation occurrence" resource.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
Information about VNFC instances that were affected during the lifecycle operation. See note 1.
type: array
items:
$ref: "#/definitions/AffectedVnfc"
affectedVirtualLinks:
description: >
Information about VL instances that were affected during the lifecycle operation. See note 1 and note 2.
type: array
items:
$ref: "#/definitions/AffectedVirtualLink"
affectedExtLinkPorts:
description: >
Information about external VNF link ports that were affected during the lifecycle operation. See note 1.
$ref: "#/definitions/AffectedExtLinkPort"
Information about virtualised storage instances that were affected during the lifecycle operation. See note 1.
type: array
items:
$ref: "#/definitions/AffectedVirtualStorage"
changedInfo:
description: >
Information about the changed VNF instance information, including
changed VNF configurable properties.
Shall be present if the "notificationStatus" is set to "RESULT",
the "operation" attribute is not equal to "CHANGE_VNFPKG", the
"verbosity" attribute is set to "FULL" and the operation has performed
any changes to VNF instance information, including VNF configurable
properties. Shall be absent otherwise. See note 3.
$ref: "#/definitions/VnfInfoModifications"
piscione
committed
affectedVipCps:
description: >
Information about virtual IP CP instances that were affected during the execution of the lifecycle management
operation, if this notification represents the result of a lifecycle management operation occurrence.
Shall be present if the "notificationStatus" is set to "RESULT", the "verbosity" attribute is set to "FULL"
and the operation has made any changes to the VIP CP instances of the VNF instance. Shall be absent otherwise.
Only information about VIP CP instances that have been added, deleted or modified shall be provided.
type: array
items:
$ref: "#/definitions/AffectedVipCp"
affectedVirtualCps:
description:
Information about virtual CP instances that were affected during the execution of the lifecycle
management operation, if this notification represents the result of a lifecycle management operation
occurrence.
Shall be present if the "notificationStatus" is set to "RESULT", the "verbosity" attribute is set to "FULL"
and the operation has made any changes to the virtual CP instances of the VNF instance. Shall be absent
otherwise. Only information about virtual CP instances that have been added, deleted or modified shall be
provided.
type: array
items:
$ref: "#/definitions/AffectedVirtualCp"
affectedCertificates:
description: >
Information about certificate content that were affected during the execution of the lifecycle management
operation, if this notification represents the result of a lifecycle management operation occurrence.
Shall be present when using delegation mode, otherwise shall be absent.
This attribute shall be supported when delegation mode in certificate management is applicable
type: array
items:
$ref: "#/definitions/AffectedCertificate"
changedExtConnectivity:
description: >
Information about changed external connectivity, if this notification
represents the result of a lifecycle operation occurrence.
Shall be present if the "notificationStatus" is set to "RESULT",
the "verbosity" attribute is set to "FULL" and the operation has made
any changes to the external connectivity of the VNF instance. Shall be
absent otherwise. Only information about external VL instances that
have been added or modified shall be provided.
type: array
items:
$ref: "#/definitions/ExtVirtualLinkInfo"
modificationsTriggeredByVnfPkgChange:
description: >
Information about performed changes of "VnfInstance" attributes triggered by changing the current VNF package.
Shall be present if the "notificationStatus" is set to "RESULT", the "operation" attribute is equal to
"CHANGE_VNFPKG", the "verbosity" attribute is set to "FULL" and the operation has performed any changes to
"VnfInstance" attributes. Shall be absent otherwise. See note 3.
$ref: "#/definitions/ModificationsTriggeredByVnfPkgChange"
error:
description: >
Details of the latest error, if one has occurred during executing
the LCM operation (see clause 6.3 of ETSI GS NFV-SOL 013).
Shall be present if the "operationState" attribute is "FAILED_TEMP", "FAILED"
or "ROLLED_BACK" and shall be absent otherwise.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/ProblemDetails"
_links:
description: >
Links to resources related to this notification.
The link URIs in this structure shall be set to point to the
resources identified by the corresponding identifier attributes
in this notification.
$ref: "#/definitions/LccnLinks"
AffectedVirtualLink:
description: >
This type provides information about added, deleted, modified and
temporary VLs, and added or removed VNF link ports.
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.
NOTE 2: 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".
type: object
required:
- id
- vnfVirtualLinkDescId
- changeType
- networkResource
properties:
id:
description: >
Identifier of the virtual link instance, identifying the applicable
"vnfVirtualLinkResourceInfo" or "extManagedVirtualLinkInfo" entry in the "VnfInstance" data type.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
vnfVirtualLinkDescId:
description: >
Identifier of the related VLD in the VNFD.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnfd"
vnfdId:
description: >
Identifier of the VNFD.
Shall be present in case of a "change current VNF Package" to identify whether the affected VL instance is
associated to a VLD which is referred from the source or destination VNFD.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
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.
See note 1.
type: string
enum:
- ADDED
- REMOVED
- MODIFIED
- TEMPORARY
- LINK_PORT_ADDED
- LINK_PORT_REMOVED
networkResource:
description: >
Reference to the VirtualNetwork resource or reference to a Network MCIO.
Detailed information is (for new and modified resources) or has been (for removed resources)
available from the VIM or the CISM.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/ResourceHandle"
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.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnfd"
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 1 and note 2.
$ref: "../../General_Definitions/SOL003_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: "../../General_Definitions/SOL003_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 applicable "vnfVirtualLinkResourceInfo”
structure if such structure is referenced by the "id" attribute and it has metadata.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"
AffectedVirtualStorage:
description: >
This type provides information about added, deleted, modified and temporary virtual storage resources.
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".
type: object
required:
- id
- virtualStorageDescId
- changeType
- storageResource
properties:
id:
description: >
Identifier of the storage instance, identifying the applicable
"virtualStorageResourceInfo" entry in the "VnfInstance" data type.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
virtualStorageDescId:
description: >
Identifier of the related VirtualStorage descriptor in the VNFD.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnfd"
vnfdId:
description: >
Identifier of the VNFD.
Shall be present in case of a "change current VNF Package" to identify whether the affected virtual storage
instance is associated to a VirtualStorage descriptor which is referred from the source or destination VNFD.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
changeType:
description: >
Signals the type of change. Permitted values:
* ADDED
* REMOVED
* MODIFIED
* TEMPORARY
For a temporary resource, an AffectedVirtualStorage structure exists
as long as the temporary resource exists.
type: string
enum:
- ADDED
- REMOVED
- MODIFIED
- TEMPORARY
storageResource:
description: >
Reference to the VirtualStorage resource or reference to a Storage MCIO.
Detailed information is (for new and modified resources) or has been (for removed
resources) available from the VIM or the CISM.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/ResourceHandle"
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.
$ref: "../../General_Definitions/SOL003_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: "../../General_Definitions/SOL003_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 VirtualStorageResourceInfo structure.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"
IntVnfCpData:
description: >
This type represents input information related to one or more VNF internal CP instances
created based on the same CPD.
NOTE: Cardinality greater than 1 is only applicable for specific cases where more than one network attachment
definition resource is needed to fulfil the connectivity requirements of the VNF internal CP, e.g. to build a link
redundant mated pair in SR-IOV cases. When more than one netAttDefResourceId is indicated, all shall
belong to the same namespace as defined by the corresponding "containerNamespace" attribute in the "resourceHandle" attribute
in the "NetAttDefResourceData".
type: object
required:
- cpdId
- netAttDefResourceId
properties:
cpdId:
description: >
Identifier of the CPD in the VNFD.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
netAttDefResourceId:
description: >
Identifiers of the “NetAttDefResourceData” structure that
provides the specification of the interface to attach the VNF
internal CP created from the CPD identified by cpdId to a
secondary container cluster network. See note.
type: array
items:
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
CertificateConfigurationData:
description: >
This type provides input information related to certificate management.
ETSI GS NFV-SOL 009 [i.18] specifies the means to discover the applicable certificate management mode of VNFM
and configure into the NFVO applicable certificate management mode via the "NFV-MANO Configuration and
Information Management" interface
type: object
properties:
overridingCertificateProfiles:
description: >
Overriding certificate profile. This overrides the
certificateBaseProfile provided in the VNFD, and the CA
and CMF can additionally override aspects of this
certificateBaseProfile at later point in the VNF lifecycle if
necessary to meet operator security policy.
type: array
items:
$ref: "#/definitions/CertificateBaseProfile"
securityPolicy:
description: >
Security policy to be satisfied for the certificate.
type: array
items:
$ref: "#/definitions/SecurityPolicy"
cmfData:
description: >
Information for CMF.
$ref: "#/definitions/CmfData"
SecurityPolicy:
description: >
This type provides input information related to security policy for certificate management.
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
type: object
required:
- id
properties:
id:
description: Identifier of this security policy.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
maxValidityPeriod:
description: Allowed max validity period for certificates.
type: number
allowedAlgorithm:
description: Allowed signature algorithm.
type: string
minimumKeyLength:
description: Minimum key length for certificates.
type: number
CertificateBaseProfile:
description: >
NOTE: At least one overriding attributes shall be present, otherwise shall be absent.
This type provides input information to override certificate base profile
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
type: object
required:
- id
properties:
id:
description: The identifier of this certificate profile.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
issuer:
description: Issuer of certificates. See note.
type: string
issuerUniqueIdentifier:
description: Identifier of this issuer of certificates. See note.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
subject:
description: Subject of certificates. See note.
$ref: "#/definitions/CertSubjectData"
subjectUniqueIdentifier:
description: Identifier of this subject of certificates. See note.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
basicConstraints:
description: Basic constraints of certificates. See note.
type: string
issuerAltName:
description: Alternative name of issuer of certificates in this NS. See note.
type: array
items:
type: string
subjectAltName:
description: >
Alternative name of subject of certificates. Shall be present when
this certificate is used for encrypted communication using IP
address and subjectAltName attribute of CertificateBaseProfile in
CertificateDesc of VNFD is empty (see ETSI GS NFV-IFA 011 [14],
clause 7.1.19.4). See note.
type: array
items:
type: string
nameConstraints:
description: Name constraints of certificates. See note.
type: array
items:
type: string
CmfData:
description: >
This type provides input information related to CMF for certificate
type: object
required:
- endPoint
- supportedProtocols
properties:
endPoint:
description: End point of CMF instance.
type: object
properties:
ipAddress:
description: An IP address of this end point.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IpAddress"
link:
description: A link to this end point.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Link"
supportedProtocols:
description: Supported protocols by CMF instance.
type: array
items:
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/SupportedProtocol"
CertSubjectData:
description: >
This type provides input information related to the subject of the certificate.
NOTE: At least one overriding attributes shall be present, otherwise shall be absent.
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
type: object
properties:
commonName:
description: >
Information of the certification target subject FQDN. Can be set
empty when this certificate is used for encrypted communication
using IP address. See note.
type: string
organization:
description: Information of the certification target subject Organization. See note.
type: string
country:
description: Information of the certification target subject Country. See note.
type: string
state:
description: Information of the certification target subject State. See note.
type: string
locality:
description: Information of the certification target subject Locality. See note.
type: string
emailAddress:
description: Information of the certification contact email address. See note.
type: string
CmfInfo:
description: >
This type provides input information related to CMF for certificate management.
type: object
required:
- id
- endPoint
- supportedProtocol
properties:
id:
description: Identifier of this CMF information.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
endPoint:
description: End point of CMF instance.
type: object
properties:
ipAddress:
description: An IP address of this end point.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IpAddress"
link:
description: A link to this end point.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Link"
supportedProtocol:
description: Supported protocols by CMF instance.
type: array
items:
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/SupportedProtocol"
certificateChain:
description: Certificate chain that this CMF provides.
type: array
items:
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"
AffectedCertificate:
description: >
This type provides input information about added, deleted, and modified certificate contents.
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
type: object
required:
- certificateInfoId
- changeType
properties:
certificateInfoId:
description: Identifier of certificate information.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
certificateBaseProfileId:
description: Identifier of certificate base profile.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
securityPolicyId:
description: Identifier of security policy.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
cmfInfoId:
description: Identifier of CMF information.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
certificateContentId:
description: Identifier of certificate content.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
changeType:
description: Signals the type of change.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/ChangeType"
PaasServiceInfo:
description: >
This type provides input information about a PaaS Service that is used by
a VNF instance. The PaasServiceInfo is comprised of various sets of
information. Some information comes from the VNFD, other information comes
from the PaaS Service assets provided by the NFVO to the VNFM, and other
information is provided at runtime information about the usage of the PaaS
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
type: object
required:
- id
- paasServiceId
- paasServiceType
- paasServiceRequestId
- paasServiceHandle
properties:
id:
description: Identifier of this PaaS Service Information.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
paasServiceId:
description: Identifier of the assigned PaaS Service as managed by the PaaS Services Management (PSM) function.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
paasServiceType:
description: The type of PaaS Service. The value of this attribute is expected to be matched against values of the registered PaaS Services in the PSR.
type: string
paasServiceVersion:
description: Version of the PaaS Service. It shall be present if the PaaS Service is versioned.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Version"
paasServiceRequestId:
description: Identifier of the PaaS Service request in the VNFD that maps to the assigned PaaS Service.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnfd"
paasServiceHandle:
description: A handle enabling the access and use of the PaaS Service by the VNF instance.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/PaasServiceHandle"
additionalInfo:
description: Additional information which is specific to the PaaS Service, its type, and which is available from the PaaS Service instance.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"
CertificateInfo:
description: >
This type provides input information related to certificate and certificate management.
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
type: object
required:
- id
properties:
id:
description: Identifier of this certificate information.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
certificateConfigurationInfo:
description: >
Configuration for certificate management such as certificate profile
and security policy.
$ref: "#/definitions/CertificateConfigurationInfo"
certificateContents:
description: >
Information for contents of issued certificates. The information
contained in this attribute may be updated over time during the VNF
LCM, e.g., certificate(s) renewal.
type: array
items:
$ref: "#/definitions/CertificateContent"
CertificateConfigurationInfo:
description: >
This type provides input information related to certificate management.
type: object
required:
- securityPolicy
properties:
certificateBaseProfile:
description: Information for certificate profile.
type: array
items:
$ref: "#/definitions/CertificateBaseProfile"
securityPolicy:
description: Information for security policy to be satisfied for certificate.
type: array
items:
$ref: "#/definitions/SecurityPolicy"
delegationSupportedCertificateManagements:
description: Describes supported certificate management information.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"
cmfInfo:
description: Information for CMF.
$ref: "#/definitions/CmfInfo"
CertificateContent:
description: >
This type provides input information related to certificate content.
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
NOTE: The CertificateDesc data type is defined in clause 7.1.19.2 of ETSI GS NFV IFA 011 [10].
type: object
required:
- id
- certificateDescId
- certificateType
properties:
id:
description: Identifier of this certificate.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
certificateDescId:
description: >
Identifier of certificate description in VNFD to be used to issue
this certificate. See note.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnfd"
certificateType:
description: Type of this certificate.
type: string
enum:
- VNFCI_CERT
- VNFOAM_CERT
supportedCertificateManagements:
description: Describes supported certificate management information.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"
version:
description: Version of this certificate.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Version"
serialNumber:
description: Serial number of this certificate.
type: integer
signatureAlgorithm:
description: Algorithm of this certificate's signature.
type: string
issuer:
description: Issuer of this certificate.
type: string
notBefore:
description: Start date of the valid period for this certificate.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/DateTime"
notAfter:
description: End date of the valid period for this certificate.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/DateTime"
subject:
description: Subject of this certificate.
type: string
publicKeyAlgorithm:
description: Algorithm of this certificate's public key.
type: string
publicKey:
description: Public key of this certificate.
type: string
certificateExtensions:
description: Extension of this certificate.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"
CreateVnfRequest:
description: >
This type represents request parameters for the "Create VNF identifier" operation.
type: object
required:
- vnfdId
properties:
vnfdId:
description: >
Identifier that identifies the VNFD which defines the VNF instance to
be created.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
vnfInstanceName:
description: >
Human-readable name of the VNF instance to be created.
type: string
vnfInstanceDescription:
description: >
Human-readable description of the VNF instance to be created.
type: string
metadata:
description: >
If present, this attribute provides additional initial values, overriding those obtained from the VNFD, for
the "metadata" attribute in "VnfInstance", as defined in clause 5.5.2.2. Provisions for handling metadata
during the operation are defined in clause 5.4.2.3.1.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"
certificateConfigurationData:
description: >
Configuration for certificate management such as certificate profile, information of CMF and security policy
in this VNF. It shall be present when using delegation mode, otherwise it shall be absent.
This attribute shall be supported when delegation mode of certificate management is applicable.
$ref: "#/definitions/CertificateConfigurationData"
ScaleVnfRequest:
description: >
This type represents request parameters for the "Scale VNF" operation.
type: object
required:
- type
properties:
type:
description: >
Indicates the type of the scale operation requested.
Permitted values:
* SCALE_OUT: adding additional VNFC instances to the VNF to increase
capacity
* SCALE_IN: removing VNFC instances from the VNF in order to release
unused capacity.
* SCALE_VERTICAL: increasing or decreasing the resource capacity of all instances of one or multiple VNFCs.
type: string
enum:
- SCALE_OUT
- SCALE_IN
aspectId:
description: >
Identifier of the scaling aspect. It shall be present when ‘type’ indicates SCALE_OUT or SCALE_IN and absent otherwise.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnfd"
numberOfSteps:
description: >
Number of scaling steps to be executed as part of this Scale VNF
operation. It shall be a positive number and the default value
shall be 1.
type: integer
default: 1
resourceCapacityDefinition:
description: >
Indicates values for resource capacity related attributes pertaining to a descriptor.
The indicated values are absolute (target) values, as opposed to relative (delta) values.
Values can only be provided for resource capacity related attributes that have been defined
in the VNFD as being configurable. Furthermore, provided values shall be within the allowed
values indicated in the VNFD. It shall be present when 'type' indicates SCALE_VERTICAL and
absent otherwise.
type: array
items:
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/ResourceCapacityDefinition"
additionalParams:
description: >
Additional parameters passed by the NFVO as input to the scaling
process, specific to the VNF being scaled, as declared in the VNFD
as part of "ScaleVnfOpConfig" defined in ETSI GS NFV-IFA 011 [10].
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"
ScaleVnfToLevelRequest:
description: >
This type represents request parameters for the "Scale VNF to Level" operation.
NOTE 1: Either the instantiationLevelId attribute or the scaleInfo attribute shall
be included.
NOTE 2: If the referenced instantiationLevel or the scaleInfo attribute contain information related to VNFCs that are not
going to be instantiated due to the selection of deployable modules, the information is stored in the VNFM for
later use and included in the instantiatedVnfInfo. If, during the lifecycle of the VNF, as a result of a change of
the selected deployable modules any of those VNFCs is going to be instantiated, the stored information
determines the number of instances, unless the request that triggered the change also contains information
about the number of instances
type: object
anyOf:
- oneOf:
- required:
- instantiationLevelId
- required:
- scaleInfo
properties:
instantiationLevelId:
description: >
Identifier of the target instantiation level of the current
deployment flavour to which the VNF is requested to be scaled.
See note 1 and 2.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnfd"
scaleInfo:
description: >
For each scaling aspect of the current deployment flavour, indicates
the target scale level to which the VNF is to be scaled.
See note 1 and 2.
type: array
items:
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/ScaleInfo"
additionalParams:
description: >
Additional parameters passed by the NFVO as input to the scaling
process, specific to the VNF being scaled, as declared in the
VNFD as part of "ScaleVnfToLevelOpConfig" defined in ETSI GS NFV-IFA 011 [10].
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
CancelMode:
description: >
This type represents a parameter to select the mode of cancelling an
ongoing VNF LCM operation occurrence.
type: object
required:
- cancelMode
properties:
cancelMode:
description: >
Cancellation mode to apply.
$ref: "#/definitions/CancelModeType"
LccnSubscriptionRequest:
description: >
This type represents a subscription request related to notifications
about VNF lifecycle changes.
type: object
required:
- callbackUri
properties:
filter:
description: >
Filter settings for this subscription, to define the subset of all
notifications this subscription relates to. A particular
notification is sent to the subscriber if the filter matches, or if
there is no filter.
$ref: "#/definitions/LifecycleChangeNotificationsFilter"
callbackUri:
description: >
The URI of the endpoint to send the notification to.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Uri"
authentication:
description: >
Authentication parameters to configure the use of Authorization when
sending notifications corresponding to this subscription, as defined
in clause 8.3.4 of ETSI GS NFV-SOL 013.
This attribute shall only be present if the subscriber requires
authorization of notifications.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/SubscriptionAuthentication"
verbosity:
description: >
This attribute signals the requested verbosity of LCM operation occurrence notifications. If it is not present,
it shall default to the value "FULL".
$ref: "#/definitions/LcmOpOccNotificationVerbosityType"
LccnSubscription:
description: >
This type represents a subscription related to notifications about VNF
lifecycle changes.
type: object
required:
- id
- callbackUri
- verbosity
- _links
properties:
id:
description: >
Identifier of this subscription resource.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
filter:
description: >
Filter settings for this subscription, to define the subset of all
notifications this subscription relates to. A particular
notification is sent to the subscriber if the filter matches, or if
there is no filter.
$ref: "#/definitions/LifecycleChangeNotificationsFilter"
callbackUri:
description: >
The URI of the endpoint to send the notification to.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Uri"
verbosity:
description: >
This attribute signals the verbosity of LCM operation occurrence notifications.
$ref: "#/definitions/LcmOpOccNotificationVerbosityType"
_links:
description: >
Links to resources related to this resource.
type: object
required:
- self
properties:
self:
description: >
URI of this resource.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Link"
ExtVirtualLinkInfo:
description: >
This type represents information about an external VL.
NOTE: This attribute reflects the current configuration information that has resulted from merging into this attribute
the "VnfExtCpData" information which was passed as part of the "ExtVirtualLinkData" structure in the input of the
most recent VNF LCM operation such as "InstantiateVnfRequest", "ChangeExtVnfConnectivityRequest", "ChangeVnfFlavourRequest"
or "ChangeCurrentVnfPkgRequest", or in the Grant response. If applying such change results in an empty list of
"currentVnfExtCpData" structure instances, the affected instance of "ExtVirtualLinkInfo" shall be removed from its
parent data structure.
type: object
required:
- id
- resourceHandle
- currentVnfExtCpData
properties:
id:
description: >
Identifier of the external VL and the related external VL
information instance.
The identifier is assigned by the NFV-MANO entity that manages this
VL instance.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
resourceHandle:
description: >
Reference to the resource realizing this VL.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/ResourceHandle"
extLinkPorts:
description: >
Link ports of this VL.
type: array
items:
$ref: "#/definitions/ExtLinkPortInfo"
currentVnfExtCpData:
description: >
Allows the API consumer to read the current CP configuration information for the connection of external CPs
to the external virtual link. See note.
type: array
items:
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/VnfExtCpData"
extNetAttDefResource:
description: >
Network attachment definition resources that provide the specification of the interface to attach connection points
to this VL.
type: array
items:
$ref: "#/definitions/NetAttDefResourceInfo"
VnfLinkPortInfo:
description: >
This type represents a link port of an internal VL of a VNF.
NOTE 1: Either cpInstanceId with cpInstanceType set to "EXT_CP" or any combination of cpInstanceId
with cpInstanceType set to "VNFC_CP" and vipCpInstanceId (i.e. one or both of them) shall be
present for a VnfLinkPortInfo. In case both cpInstanceId with cpInstanceType set to "VNFC_CP"
and vipCpInstanceId are present, the two different CP instances share the linkport.
NOTE 2: Annex A.4 of ETSI GS NFV-IFA 007 provides examples for configurations where both vipCpInstanceId
and vnfcCpInstanceId are present (UC#5 and UC#5-b), only vnfcCpInstanceId is present (UC#2), or
only vipCpInstanceId is present (UC6 and UC#6-b).
NOTE 3: The value of "trunkResourceId" is scoped by the value of "vimConnectionId" in the "resourceHandle"
attribute.
type: object
required:
- id
- resourceHandle
properties:
id:
description: >
Identifier of this link port as provided by the entity that has created the link port.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
resourceHandle:
description: >
Reference to the virtualised resource realizing this link
port.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/ResourceHandle"
cpInstanceId:
description: >
When the link port is used for external connectivity by the VNF, this attribute represents the
identifier of the external CP associated with this link port.
When the link port is used for internal connectivity in the VNF, this attribute represents the
identifier of the VNFC CP to be connected to this link port.
Shall be present when the link port is used for external connectivity by the VNF.
May be present if used to reference a VNFC CP instance.
There shall be at most one link port associated with any external connection point instance or
internal connection point (i.e. VNFC CP) instance.
The value refers to an "extCpInfo" item in the VnfInstance or a "vnfcCpInfo" item of a "vnfcResourceInfo"
item in the VnfInstance. See note 1.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
cpInstanceType:
description: >
Type of the CP instance that is identified by cpInstanceId.
Shall be present if "cpInstanceId" is present and shall be absent otherwise.
Permitted values:
- VNFC_CP: The link port is connected to a VNFC CP.
- EXT_CP: The link port is associated to an external CP.
See note 1.
type: string
enum:
- VNFC_CP
- EXT_CP
vipCpInstanceId:
description: >
VIP CP instance of the VNF connected to this link port. May be present.
See notes 1, and 2.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
trunkResourceId:
description: >
Identifier of the trunk resource in the VIM.
Shall be present if the present link port corresponds to the parent port that the trunk resource is associated with.
See note 3.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVim"
ExtLinkPortInfo:
description: >
This type represents information about a link port of an external VL, i.e. a port providing connectivity for the VNF to
NOTE 1: The use cases UC#4 and UC#5 in clause A.4 of ETSI GS NFV-IFA 007 provide examples for such a configuration.
NOTE 2: The value of "trunkResourceId" is scoped by the value of "vimConnectionId" in the "resourceHandle" attribute.
type: object
required:
- id
- resourceHandle
properties:
id:
description: >
Identifier of this link port as provided by the entity that has
created the link port.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
resourceHandle:
description: >
Reference to the virtualised resource realizing this link
port.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/ResourceHandle"
cpInstanceId:
description: >
Identifier of the external CP of the VNF connected to this link
port. There shall be at most one link port associated with any
external connection point instance. The value refers to an
"extCpInfo" item in the VnfInstance.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
secondaryCpInstanceId:
description: >
Additional external CP of the VNF connected to this link port.
If present, this attribute shall refer to a "secondary" ExtCpInfo item in the VNF instance that exposes a virtual
IP CP instance which shares this linkport with the external CP instance referenced by the "cpInstanceId" attribute.
See note 1.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
trunkResourceId:
description: >
Identifier of the trunk resource in the VIM.
Shall be present if the present link port corresponds to the parent port that the trunk resource is associated with.
See note 2.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVim"
CpProtocolInfo:
description: >
This type describes the protocol layer(s) that a CP uses together with protocol-related information, like addresses.
NOTE: This attribute allows to signal the addition of further types of layer and protocol in future versions of the
present document in a backwards-compatible way. In the current version of the present document, only IP over
Ethernet is supported.
type: object
required:
- layerProtocol
properties:
layerProtocol:
description: >
The identifier of layer(s) and protocol(s) associated to the network address information.
Permitted values:
- IP_OVER_ETHERNET
- IP_FOR_VIRTUAL_CP
See note.
type: string
enum:
- IP_OVER_ETHERNET
ipOverEthernet:
description: >
IP addresses over Ethernet to assign to the extCP instance. Shall be
present if layerProtocol is equal to " IP_OVER_ETHERNET", and shall
be absent otherwise.
$ref: "#/definitions/IpOverEthernetAddressInfo"
virtualCpAddress:
description: >
IP address data assigned to an external CP instance exposing a virtual CP. It shall be present if
layerProtocol is equal to “IP_FOR_VIRTUAL_CP” and the external CP instance exposes a virtual CP and
shall not be present otherwise.
$ref: "#/definitions/VirtualCpAddressInfo"
IpOverEthernetAddressInfo:
description: >
This type represents information about a network address that has been assigned.
NOTE 1: At least one of "macAddress" or "ipAddresses" shall be present.
NOTE 2: Exactly one of "addresses" or "addressRange" shall be present.
NOTE 3: If the Cp instance represents a subport in a trunk, segmentationId shall be present.
Otherwise it shall not be present.
NOTE 4: Depending on the NFVI networking infrastructure, the segmentationId may indicate the
actual network segment value (e.g. vlan Id, Vxlan segmentation id, etc.) used in the
transport header of the packets or it may be an identifier used between the application
and the NFVI networking infrastructure to identify the network sub-interface of the trunk
port in question. In the latter case the NFVI infrastructure will map this local segmentationId
to whatever segmentationId is actually used by the NFVI's transport technology.
type: object
anyOf:
- required:
- macAddress
- required:
- ipAddresses
properties:
macAddress:
description: >
MAC address, if assigned. See note 1.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/MacAddress"
segmentationId:
description: >
Identification of the network segment to which the Cp instance connects to. See notes 3 and 4.
type: string
ipAddresses:
description: >
Addresses assigned to the CP instance. Each entry represents IP addresses assigned by fixed or
dynamic IP address assignment per subnet. See note 1.
type: array
items:
type: object
required:
- type
oneOf:
- required:
- addresses
- required:
- addressRange
properties:
type:
description: >
The type of the IP addresses.
Permitted values: IPV4, IPV6.
type: string
enum:
- IPV4
- IPV6
addresses:
description: >
Fixed addresses assigned (from the subnet defined by "subnetId" if provided). See note 2.
type: array
items:
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IpAddress"
isDynamic:
description: >
Indicates whether this set of addresses was assigned
dynamically (true) or based on address information provided as
input from the API consumer (false). Shall be present if
"addresses" is present and shall be absent otherwise.
type: boolean
addressRange:
description: >
An IP address range used, e.g. in case of egress connections. See note 2.
type: object
required:
- minAddress
- maxAddress
properties:
minAddress:
description: >
Lowest IP address belonging to the range.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IpAddress"
maxAddress:
description: >
Highest IP address belonging to the range
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IpAddress"
subnetId:
description: >
Subnet defined by the identifier of the subnet resource in
the VIM.
In case this attribute is present, IP addresses are bound
to that subnet.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVim"
MonitoringParameter:
description: >
This type represents a monitoring parameter that is tracked by the VNFM,
type: object
required:
- id
- performanceMetric
properties:
id:
description: >
Identifier of the monitoring parameter defined in the VNFD.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnfd"
vnfdId:
description: >
Identifier of the VNFD.
Shall be present in case the value differs from the vnfdId attribute of the VnfInstance (e.g. during a "Change
current VNF package" operation or due to its final failure).
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
name:
description: >
Human readable name of the monitoring parameter, as defined in the
VNFD.
type: string
performanceMetric:
description: >
Performance metric that is monitored. This attribute shall contain the
related "Measurement Name" value as defined in clause 7.2 of ETSI GS NFV-IFA 027.
type: string
LifecycleChangeNotificationsFilter:
description: >
This type represents a subscription filter related to notifications about VNF lifecycle changes.
At a particular nesting level in the filter structure, the following applies: All attributes shall
match in order for the filter to match (logical "and" between different filter attributes).
If an attribute is an array, the attribute shall match if at least one of the values in the array
matches (logical "or" between the values of one filter attribute).
NOTE: The permitted values of the "notificationTypes" attribute are spelled exactly as the names of
the notification types to facilitate automated code generation systems.
type: object
properties:
vnfInstanceSubscriptionFilter:
description: >
Filter criteria to select VNF instances about which to notify.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/VnfInstanceSubscriptionFilter"
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
notificationTypes:
description: >
Match particular notification types.
Permitted values:
- VnfLcmOperationOccurrenceNotification
- VnfIdentifierCreationNotification
- VnfIdentifierDeletionNotification
See note.
type: array
items:
type: string
enum:
- VnfLcmOperationOccurrenceNotification
- VnfIdentifierCreationNotification
- VnfIdentifierDeletionNotification
operationTypes:
description: >
Match particular VNF lifecycle operation types for the notification
of type VnfLcmOperationOccurrenceNotification.
May be present if the "notificationTypes" attribute contains the
value "VnfLcmOperationOccurrenceNotification", and shall be absent
otherwise.
type: array
items:
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/LcmOperationType"
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
operationStates:
description: >
Match particular LCM operation state values as reported in
notifications of type VnfLcmOperationOccurrenceNotification.
May be present if the "notificationTypes" attribute contains the
value "VnfLcmOperationOccurrenceNotification", and shall be absent
otherwise.
type: array
items:
$ref: "#/definitions/LcmOperationStateType"
LccnLinks:
description: >
This type represents the links to resources that a notification can
contain.
type: object
required:
- vnfInstance
- subscription
properties:
vnfInstance:
description: >
Link to the resource representing the VNF instance to which the
notified change applies.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/NotificationLink"
subscription:
description: >
Link to the related subscription.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/NotificationLink"
vnfLcmOpOcc:
description: >
Link to the VNF lifecycle management operation occurrence that this
notification is related to. Shall be present if there is a related
lifecycle operation occurrence.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/NotificationLink"
VnfExtCpInfo:
description: >
This type represents information about an external CP of a VNF.
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
NOTE 1: The attributes "associatedVnfcCpId", "associatedVipCpId", "associatedVirtualCpId" and
"associatedVnfVirtualLinkId" are mutually exclusive. Exactly one shall be present.
NOTE 2: An external CP instance is not associated to a link port in the cases indicated for the
“extLinkPorts” attribute in clause 4.4.1.11.
NOTE 3: Cardinality greater than 1 is only applicable for specific cases where more than one network
attachment definition resource is needed to fulfil the connectivity requirements of the external
CP, e.g. to build a link redundant mated pair in SR-IOV cases.
NOTE 4: When more than one netAttDefResourceId is indicated, all shall belong to the same namespace.
type: object
required:
- id
- cpdId
- cpConfigId
- cpProtocolInfo
oneOf:
- required:
- associatedVnfcCpId
- required:
- associatedVipCpId
- required:
- associatedVnfVirtualLinkId
properties:
id:
description: >
Identifier of the external CP instance and the related information instance.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
cpdId:
description: >
Identifier of the external CPD, VnfExtCpd, in the VNFD.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnfd"
cpConfigId:
description: >
Identifier that references the applied "VnfExtCpConfig" entry in the "cpConfig" map of the "currentVnfExtCpData"
in the "ExtVirtualLinkInfo" structure.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
vnfdId:
description: >
Identifier of the VNFD.
Shall be present in case the value differs from the vnfdId attribute of the VnfInstance (e.g. during a "Change
current VNF package" operation or due to its final failure).
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
cpProtocolInfo:
description: >
Network protocol information for this CP.
type: array
items:
$ref: "#/definitions/CpProtocolInfo"
extLinkPortId:
description: >
Identifier of the "ExtLinkPortInfo" structure inside the "ExtVirtualLinkInfo" structure.
Shall be present if the CP is associated to a link port. See note 2.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
metadata:
description: >
Metadata about this external CP.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"
associatedVnfcCpId:
description: >
Identifier of the "vnfcCpInfo" structure in "VnfcResourceInfo" structure that represents the VNFC CP
which is exposed by this external CP instance, either directly or via a floating IP address.
Shall be present in case this CP instance maps to a VNFC CP. See note 1.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
associatedVipCpId:
description: >
Identifier of the VIP CP instance that is exposed as this VnfExtCp instance, either directly or via a
floating IP address, and the related "VipCpInfo" structure in "VnfInstance". Shall be present if the
cpdId of this VnfExtCp has a vipCpd attribute. See note 1.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
associatedVirtualCpId:
description: >
Identifier of the "VirtualCpInfo" structure that represents the Virtual CP that is exposed by this
external CP instance. Shall be present in case this CP instance maps to a Virtual CP. See note 1.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
associatedVnfVirtualLinkId:
description: >
Identifier of the "VnfVirtualLinkResourceInfo" structure that represents the internal VL or of the
"ExtManagedVirtualLinkInfo" structure that represents the externally-managed internal VL which is
exposed by this external CP instance. Shall be present in case this CP instance maps to an internal
VL (including externally-managed internal VL). See note 1.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
netAttDefResourceId:
description: >
Identifier of the “NetAttDefResourceInfo” structure that provides the specification of the interface to attach the
connection point to a secondary container cluster network. See notes 3 and 4.
It shall be present if the external CP is associated to a VNFC realized by one or a set of OS containers and
is connected to a secondary container cluster network. It shall not be present otherwise.
type: array
items:
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
certificateContentId:
description: >
Identifier of the "CertificateContent" structure that provides the information of the certificate that this
VNF CP instance uses. Shall be present when using in delegation-mode. Otherwise shall not be present.
This attribute shall be supported when delegation mode in certificate management is applicable.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
VnfOperationalStateType:
description: >
STARTED: The VNF instance is up and running.
STOPPED: The VNF instance has been shut down.
type: string
enum:
- STARTED
- STOPPED
LcmOperationStateType:
description: >
STARTING: The LCM operation is starting.
PROCESSING: The LCM operation is currently in execution.
COMPLETED: The LCM operation has been completed successfully.
FAILED_TEMP: The LCM operation has failed and execution has stopped,
but the execution of the operation is not considered to be closed.
FAILED: The LCM operation has failed and it cannot be retried or rolled back,
as it is determined that such action won't succeed.
ROLLING_BACK: The LCM operation is currently being rolled back.
ROLLED_BACK: The LCM operation has been successfully rolled back,
i.e. The state of the VNF prior to the original operation invocation has been restored as closely as possible.
type: string
enum:
- STARTING
- PROCESSING
- COMPLETED
- FAILED_TEMP
- FAILED
- ROLLING_BACK
- ROLLED_BACK
CancelModeType:
description: >
Cancellation mode.
GRACEFUL: If the VNF LCM operation occurrence is in "PROCESSING" or
"ROLLING_BACK" state, the VNFM shall not start any new resource
management operation and shall wait for the ongoing resource management
operations in the underlying system, typically the VIM, to finish
execution or to time out. After that, the VNFM shall put the operation
occurrence into the FAILED_TEMP state.
If the VNF LCM operation occurrence is in "STARTING" state, the VNFM
shall not start any resource management operation and shall wait for
the granting request to finish execution or time out. After that, the
VNFM shall put the operation occurrence into the ROLLED_BACK state.
FORCEFUL: If the VNF LCM operation occurrence is in "PROCESSING" or
"ROLLING_BACK" state, the VNFM shall not start any new resource
management operation, shall cancel the ongoing resource management
operations in the underlying system, typically the VIM, and shall wait
for the cancellation to finish or to time out. After that, the VNFM
shall put the operation occurrence into the FAILED_TEMP state.
If the VNF LCM operation occurrence is in "STARTING" state, the VNFM
shall not start any resource management operation and put the operation
occurrence into the ROLLED_BACK state.
type: string
enum:
- GRACEFUL
- FORCEFUL
########################################################################################################################
VnfIdentifierCreationNotification:
description: >
This type represents a VNF identifier creation notification, which
informs the receiver of the creation of a new "Individual VNF instance" resource and
the associated VNF instance identifier.
This notification shall be triggered by the VNFM when it has created an
"Individual VNF instance" resource and the associated VNF instance identifier.
type: object
required:
- id
- notificationType
- subscriptionId
- timeStamp
- vnfInstanceId
- _links
properties:
id:
description: >
Identifier of the VNF instance.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
notificationType:
description: >
Discriminator for the different notification types. Shall be set to
"VnfIdentifierCreationNotification" for this notification type.
type: string
enum:
- VnfIdentifierCreationNotification
subscriptionId:
description: >
Identifier of the subscription that this notification relates to.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
timeStamp:
description: >
Date-time of the generation of the notification.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/DateTime"
vnfInstanceId:
description: >
The created VNF instance identifier.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
_links:
description: >
Links to resources related to this notification.
$ref: "#/definitions/LccnLinks"
VnfIdentifierDeletionNotification:
description: >
This type represents a VNF identifier deletion notification, which
informs the receiver of the deletion of a new "Individual VNF instance" resource and
the associated VNF instance identifier.
This notification shall be triggered by the VNFM when it has deleted an
"Individual VNF instance" resource and the associated VNF instance identifier.
type: object
required:
- id
- notificationType
- subscriptionId
- timeStamp
- vnfInstanceId
- _links
properties:
id:
description: >
Identifier of this notification. If a notification is sent multiple
times due to multiple subscriptions, the "id" attribute of all these
notifications shall have the same value.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
notificationType:
description: >
Discriminator for the different notification types. Shall be set to
"VnfIdentifierDeletionNotification" for this notification type.
type: string
enum:
- VnfIdentifierDeletionNotification
subscriptionId:
description: >
Identifier of the subscription that this notification relates to.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
timeStamp:
description: >
Date-time of the generation of the notification.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/DateTime"
vnfInstanceId:
description: >
The deleted VNF instance identifier.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
_links:
description: >
Links to resources related to this notification.
$ref: "#/definitions/LccnLinks"
VnfcInfoModifications:
description: >
This type represents modifications of an entry in an array of "VnfcInfo" objects.
* NOTE: The attribute "id" in this data type represents the same identifier as the attribute
"vnfcInstanceId" in other related data types in the present document. For reasons of backward
compatibility, this misalignment is not corrected.
type: object
required:
- id
- vnfcConfigurableProperties
properties:
id:
description: >
Identifier of the VNFC instance of which the information is to be modified.
The identifier references the "id" attribute in a "VnfcInfo" structure. See note.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
vnfcConfigurableProperties:
description: >
Changes of the configurable properties of the VNFC instance.
When this structure is part of a request, the modifications signalled in this attribute
shall be applied according to the rules of JSON Merge Patch (see IETF RFC 7396).
In addition, the provisions in clause 5.7 shall apply.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"
VnfcInfo:
description: >
This type represents the information about a VNFC instance that is part of a VNF instance.
* NOTE: This allows to represent the error condition that a VNFC instance has lost its resources.
type: object
required:
- id
- vduId
- vnfcState
properties:
id:
description: >
Identifier of the VNFC instance.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
vduId:
description: >
Reference to the applicable VDU information element in
the VNFD.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
vnfcResourceInfoId:
description: >
Identifier of the VnfcResourceInfo instance representing
the virtualised resources used by this VNFC instance. See note.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
vnfcState:
description: >
Identifier of the VnfcResourceInfo instance representing
the virtualised resources used by this VNFC instance.
State of the VNFC instance.
Permitted values:
• STARTED: The VNFC instance is up and
running.
• STOPPED: The VNFC instance has been shut down
type: string
enum:
- STARTED
- STOPPED
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
vnfcConfigurableProperties:
description: >
Current values of the configurable properties of the
VNFC instance.
Configurable properties referred in this attribute are
declared in the VNFD.
This attribute can be modified with the PATCH method.
In addition, the provisions in clause 5.7 shall apply.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
ModificationsTriggeredByVnfPkgChange:
description: >
This type represents attribute modifications that were performed on an "Individual VNF instance" resource
when changing the current VNF package. The attributes that can be included consist of those requested to
be modified explicitly in the "ChangeCurrentVnfPkgRequest" data structure, and additional attributes of the
"VnfInstance" data structure that were modified implicitly during the operation.
NOTE 1: This attribute represents the delta (semantics as per IETF RFC 7396, JSON Merge Patch) between the value
of the attribute at the start of the "Change current VNF package" operation and the value of the attribute
at its completion.
NOTE 2: If present, this attribute (which depends on the value of the "vnfdId" attribute) was modified implicitly
during the related operation and contains a copy of the value of the related attribute from the VNFD in the
VNF Package identified by the "vnfdId" attribute.
type: object
properties:
vnfConfigurableProperties:
description: >
This attribute signals the modifications of the "vnfConfigurableProperties" attribute in "VnfInstance" performed
by the operation and shall be present if that attribute was modified during the operation. See note 1.
In addition, the provisions in clause 5.7 shall apply.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"
metadata:
description: >
This attribute signals the modifications of the "metadata" attribute in "VnfInstance" performed by the operation and
shall be present if that attribute was modified during the operation. See note 1.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"
extensions:
description: >
This attribute signals the modifications of the "extensions" attribute in "VnfInstance" performed by the operation and
shall be present if that attribute was modified during the operation. See note 1.
In addition, the provisions in clause 5.7 shall apply.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"
vnfdId:
description: >
If present, this attribute signals the new value of the "vnfdId" attribute in "VnfInstance".
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
vnfProvider:
description: >
If present, this attribute signals the new value of the "vnfProvider" attribute in "VnfInstance". See note 2.
type: string
vnfProductName:
description: >
If present, this attribute signals the new value of the "vnfProductName" attribute in "VnfInstance". See note 2.
type: string
vnfSoftwareVersion:
description: >
If present, this attribute signals the new value of the "vnfSoftwareVersion" attribute in "VnfInstance". See note 2.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Version"
vnfdVersion:
description: >
If present, this attribute signals the new value of the "vnfdVersion" attribute in "VnfInstance". See note 2.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Version"
vimConnectionInfo:
description: >
If present, this attribute signals the changes to VIM connection info that were passed in the related
"ChangeCurrentVnfPkgRequest" structure.
type: object
additionalProperties:
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/VimConnectionInfo"
LcmOpOccNotificationVerbosityType:
description: >
The enumeration LcmOpOccNotificationVerbosityType provides values to control the verbosity of LCM operation
occurrence notifications.
* FULL: This signals a full notification which contains all change details.
* SHORT: This signals a short notification which omits large-volume change details to reduce the size of data to
be sent via the notification mechanism.
type: string
enum:
- FULL
- SHORT
McioTypeName:
description: >
The present type definition provides valid string values for the "mcioType" attribute of the "McioInfo" data type , and
the valid values are defined in table 5.5.4.9-1.
type: string
enum:
- Deployment
- DaemonSet
AffectedVipCp:
description: >
This type provides information about added, deleted and modified virtual IP CP instances.
type: object
required:
- cpInstanceId
- cpdId
- changeType
properties:
cpInstanceId:
description: >
Identifier of the virtual IP CP instance and the related "VipCpInfo" structure in "VnfInstance".
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
cpdId:
description: >
Identifier of the VipCpd in the VNFD.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnfd"
vnfdId:
description: >
Reference to the VNFD.
Shall be present in case of a "change current VNF Package" to
identify whether the affected virtual CP instance is associated
to a VipCpd which is referred from the source or destination VNFD.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
changeType:
description: >
Signals the type of change.
Permitted values:
- ADDED
- REMOVED
- MODIFIED
type: string
enum:
- ADDED
- REMOVED
- MODIFIED
VipCpInfo:
description: >
This type provides information related to virtual IP (VIP) CP.
NOTE 1: It is possible that there is no associated VnfcCp because the VIP CP is available but not
associated yet.
NOTE 2: If only the value or the presence of this attribute is changed in the "VipCpInfo" structure
by an LCM operation occurrence, this does not represent a change that requires including a related
"AffectedVipCp" structure in the VNF LCM operation occurrence notifications or the "VnfLcmOpOcc"
structure related to this LCM operation occurrence.
type: object
required:
- cpInstanceId
- cpdId
properties:
cpInstanceId:
description: >
Identifier of this VIP CP instance and of this VipCpInfo.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
cpdId:
description: >
Identifier of the VIP Connection Point Descriptor, VipCpd, in the VNFD.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnfd"
vnfdId:
description: >
Identifier of the VNFD.
Shall be present in case the value differs from the vnfdId attribute of the VnfInstance
(e.g. during a "Change current VNF package" operation or due to its final failure). See note 2.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
vnfExtCpId:
description: >
When the VIP CP is exposed as external CP of the VNF, the identifier of this external VNF CP instance.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
cpProtocolInfo:
description: >
Protocol information for this CP. There shall be one cpProtocolInfo for layer 3.
There may be one cpProtocolInfo for layer 2.
type: array
items:
$ref: "#/definitions/CpProtocolInfo"
associatedVnfcCpIds:
description: >
Identifiers of the VnfcCps that share the virtual IP address allocated to the VIP CP instance. See note.
type: array
items:
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
vnfLinkPortId:
description: >
Identifier of the "VnfLinkPortInfo" structure in the "VnfVirtualLinkResourceInfo" or
"ExtManagedVirtualLinkInfo" structure. Shall be present if the CP is associated to a
link port on an internal VL (including externally-managed internal VL).
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
metadata:
description: >
Metadata about this VIP CP.
type: array
items:
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"
AffectedVirtualCp:
description: >
This type provides information about added, deleted and modified virtual CP instances.
type: object
required:
- cpInstanceId
- cpdId
- changeType
properties:
cpInstanceId:
description: >
Identifier of the virtual CP instance and the related "VirtualCpInfo"
structure in "VnfInstance".
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
cpdId:
description: >
Identifier of the VirtualCpd in the VNFD.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnfd"
vnfdId:
description: >
Reference to the VNFD.
Shall be present in case of a "change current VNF Package" to identify whether
the affected virtual CP instance is associated to a VirtualCpd which is referred
from the source or destination VNFD.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
changeType:
description: >
Signals the type of change.
Permitted values:
- ADDED
- REMOVED
- MODIFIED
type: string
enum:
- ADDED
- REMOVED
- MODIFIED
McioInfo:
description: >
This type provides information about an MCIO representing the set of VNFC instances realized by one
or a set of OS containers which have been created based on the same VDU.
Within the CISM, an MCIO controller monitors the actual state of an MCIO representing the set of VNFC
instances realized by one or a set of OS containers and compare it to the desired state For an MCIO related to a VDU that has the
attribute isNumOfInstancesClusterBased set to FALSE the desired state is specified in the respective declarative
descriptor. For an MCIO related to a VDU that has the attribute isNumOfInstancesClusterBased set to TRUE, the
desired state is determined by the number of CIS-nodes in the cluster that fulfil the VDU requirements.as specified in
the respective declarative descriptor. It triggers actions toward the CIS to align the actual to
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
the desired state. Monitoring the actual state includes monitoring the number of MCIO instances available
at any specific point in time. In addition, an MCIO controller maintains properties and runtime information
on the MCIO instances which have been created based on the same VDU.
The McioInfo data structure provides the runtime information on the MCIOs obtained from the MCIO controller.
NOTE: There are different types of MCIOs. The set of VNFC instances based on the same VDU is represented
by one MCIO, e.g. of type Deployment. Each individual VNFC instance is represented by another type
of MCIO, e.g. a POD.
Runtime information of the set of OS containers realizing an individual VNFC instance is not part of the
McioInfo data structure; such runtime information is provided in the ResourceHandle data structure
referenced from the VnfcResourceInfo. The McioInfo does not provide runtime information of a constituent
VNFC instance created based on a specific VDU.
NOTE 1: The type of MCIO as specified in the declarative descriptor of the MCIO, and that can be read from
the CISM. EXAMPLE: In case of MCIOs managed by Kubernetes®, the type of MCIO corresponds to the
“kind” property of the declarative descriptor.
NOTE 2: If the attribute additionalInfo is present, it may contain runtime information on the actual and
desired state of the MCIO(s).
NOTE 3: When the container infrastructure service is a Kubernetes® instance, the mcioId is the combined
values from the kind and name fields of the Kubernetes resource object, separated by a slash.
Example: "Deployment/abcd".
NOTE 4: When the container infrastructure service is a Kubernetes® instance, the mcioName is the name
field of the resource object.
type: object
required:
- mcioId
- mcioName
- mcioNamespace
- vduId
- cismId
- mcioType
- desiredInstances
- availableInstances
properties:
mcioId:
description: >
Identifier of this MCIO, created by the CISM. See note 3.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
mcioName:
description: >
Human readable name of this MCIO. See note 4.
type: string
mcioNamespace:
description: >
Namespace of this MCIO.
type: string
vduId:
description: >
Reference to the related VDU in the VNFD applicable to this resource.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnfd"
cismId:
description: >
Identifier of the CISM managing this MCIO.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
mcioType:
description: >
The type of MCIO. Specific values, their semantics and associated MCIO types are defined in clause
5.5.4.9. Additional values are also permitted.
See note 1.
type: string
enum:
- Deployment
- Statefulset
desiredInstances:
description: >
Number of desired MCIO instances.
type: integer
availableInstances:
description: >
Number of available MCIO instances.
type: integer
additionalInfo:
decription: >
Additional information which is specific to the MCIO, its type, and which is available
from the CISM.
See note 2.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"
certificateContentId:
description: >
Identifier of the "CertificateContent" structure that provides the information of the certificate that this
MCIO instance uses. Shall be present when using in delegation mode. Otherwise shall not be present.
This attribute shall be supported when delegation mode in certificate management is applicable.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
VirtualCpInfo:
description: >
This type provides information related to a virtual CP instance of a VNF.
NOTE 1: A consumer of the VNF LCM interface can learn the actual VNFC instances implementing the service
accessible via the virtual CP instance by querying the "vnfcResourceInfo" from the "InstantiatedVnfInfo"
and filtering by corresponding "vduIds" values.
NOTE 2: The information can be omitted because it is already available as part of the external CP information in the
VnfExtCpInfo structure.
type: object
required:
- cpInstanceId
- cpdId
- resourceHandle
- vduIds
properties:
cpInstanceId:
description: >
Identifier of this virtual CP instance.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
cpdId:
description: >
Identifier of the VirtualCpd in the VNFD.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnfd"
resourceHandle:
description: >
Reference to the virtualised resource realizing this virtual CP.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/ResourceHandle"
vnfExtCpId:
description: >
When the virtual CP is exposed as external CP of the VNF, the identifier of this external VNF CP instance.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
cpProtocolInfo:
description: >
Protocol information for this CP. There shall be one cpProtocolInfo for each layer protocol supported.
This attribute may be omitted if the virtual CP is exposed as an external CP. See note 2.
type: array
items:
$ref: "#/definitions/CpProtocolInfo"
vduIds:
description: >
Reference to the VDU(s) which implement the service accessible via the virtual CP instance. See note 1.
type: array
minItems: 1
items:
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnfd"
additionalServiceInfo:
description: >
Additional service identification information of the virtual CP instance.
type: array
items:
$ref: "#/definitions/AdditionalServiceInfo"
metadata:
description: >
Metadata about this virtual CP instance.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"
AdditionalServiceInfo:
description: >
This type provides additional service information of the virtual CP instance used to expose properties of the
NOTE: This attribute shall only be present if additional information is needed to identify the service
termination within the VNF, such as for example a URL path information in an HTTP request required
to allow a single virtual CP IP address to be used for several HTTP based services that use the
same port number.
type: object
required:
- portInfo
properties:
portInfo:
description: >
Service port numbers exposed by the virtual CP instance.
minItems: 1
type: array
items:
$ref: "#/definitions/ServicePortInfo"
serviceInfo:
description: >
Service matching information exposed by the virtual CP instance.
See note.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"
ServicePortInfo:
description: >
This type describes the service identifying port properties exposed by the virtual CP instance.
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
type: object
required:
- name
- port
- portConfigurable
properties:
name:
description: >
The name of the port exposed by the virtual CP instance.
type: string
protocol:
description: >
The L4 protocol for this port exposed by the virtual CP instance.
Permitted values:
- TCP
- UDP
- SCTP
type: string
enum:
- TCP
- UDP
- SCTP
port:
description: >
The L4 port number exposed by the virtual CP instance.
type: integer
portConfigurable:
description:
Specifies whether the port attribute value is allowed to be configurable.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Boolean"
NetAttDefResourceInfo:
description: >
This type contains information related to a network attachment definition resource that provides the
specification of the interface used to connect one or multiple connection points to a secondary container
type: object
required:
- netAttDefResourceInfoId
- netAttDefResource
properties:
netAttDefResourceInfoId:
description: >
Identifier of this network attachment definition resource as provided by the entity that has
created it.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
netAttDefResource:
description: >
Resource handle of the resource in the scope of the CISM.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/ResourceHandle"
associatedExtCpId:
description: >
Identifier of the external CP associated to this network attachment definition resource. Shall be present
when the network attachment definition resource is used for external connectivity by the VNF.
type: array
items:
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
associatedVnfcCpId:
description: >
Identifier of the VNFC CP associated to this network attachment definition resource. May be present when
the network attachment definition resource is used for internal connectivity by the VNF.
type: array
items:
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
VirtualCpAddressInfo:
description: >
This type represents information about a network address that has been assigned to a virtual CP.
type: object
required:
- type
properties:
type:
description: >
The type of the IP addresses. Permitted values:
- IPV4
- IPV6
type: string
enum:
- IPV4
- IPV6
loadBalancerIp:
description: >
Fixed addresses assigned to an external load balancer.
$ref: '../../General_Definitions/SOL003_def.yaml#/definitions/IpAddress'
addressPoolName:
description: >
Name of an address pool from which an IP address is
assigned to the virtual CP.
type: string