Newer
Older
rameshnaraya
committed
# Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt
definitions:
Samir Medjiah
committed
HealNsRequest:
description: >
This type represents request parameters for the "Heal NS" operation. This operation supports the healing of an NS
instance, either by healing the complete NS instance or by healing one of more of the VNF instances that are part of this
NS. It shall comply with the provisions defined in Table 6.5.2.13-1.
Either the parameter healNsData or the parameter healVnfData, but not both shall be provided.
Samir Medjiah
committed
type: object
oneOf:
- required:
- healNsData
- required:
- healVnfData
Samir Medjiah
committed
properties:
healNsData:
description: >
Provides the information needed to heal an NS. See note
Samir Medjiah
committed
$ref: "#/definitions/HealNsData"
healVnfData:
description: >
Provides the information needed to heal a VNF. See note.
Samir Medjiah
committed
type: array
items:
$ref: "#/definitions/HealVnfData"
CancelMode:
description: >
This type represents a parameter to select the mode of canceling an ongoing NS LCM operation occurrence.
It shall comply with the provisions defined in Table 6.5.2.16-1.
type: object
required:
- cancelMode
properties:
cancelMode:
description: >
Cancellation mode to apply.
$ref: "#/definitions/CancelModeType"
HealNsData:
description: >
This type represents the information used to heal a NS.
Samir Medjiah
committed
It shall comply with the provisions defined in Table 6.5.3.43-1.
NOTE: Either the actionsHealing or healScript attribute shall be present, not both attributes.
Samir Medjiah
committed
type: object
required:
- degreeHealing
oneOf:
- required:
- actionsHealing
- required:
- healScript
Samir Medjiah
committed
properties:
degreeHealing:
description: >
Indicates the degree of healing. Possible values
include:
- HEAL_RESTORE: Complete the healing of
the NS restoring the state of the NS before
the failure occurred
- HEAL_QOS: Complete the healing of the NS
based on the newest QoS values
- HEAL_RESET: Complete the healing of the
NS resetting to the original instantiation state of the NS
- PARTIAL_HEALING
type: string
enum:
- HEAL_RESTORE
- HEAL_QOS
- HEAL_RESET
- PARTIAL_HEALING
actionsHealing:
description: >
Used to specify dedicated healing actions in a
particular order (e.g. as a script). The actionsHealing
attribute can be used to provide a specific script whose
content and actions might only be possible to be
Samir Medjiah
committed
type: array
items:
$ref: "../../definitions/SOL005_def.yaml#/definitions/String"
healScript:
description: >
Reference to a script from the NSD that shall be used
to execute dedicated healing actions in a particular
order. The healScript, since it refers to a script in the
NSD, can be used to execute healing actions which
$ref: "#/definitions/IdentifierInNsd"
Samir Medjiah
committed
additionalParamsforNs:
description: >
Allows the OSS/BSS to provide additional
parameter(s) to the healing process at the NS level.
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
HealVnfData:
description: >
This type represents the information to heal a VNF that is part of an NS.
The NFVO shall then invoke the Heal VNF operation towards the appropriate VNFM.
Samir Medjiah
committed
It shall comply with the provisions defined in Table 6.5.3.44-1.
type: object
required:
- vnfInstanceId
properties:
vnfInstanceId:
description: >
Identifies the VNF instance, part of the NS, requiring a
healing action.
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
cause:
description: >
Indicates the reason why a healing procedure is required.
type: string
additionalParams:
description: >
Additional parameters passed by the NFVO as input to
the healing process, specific to the VNF being healed.
EXAMPLE: Input parameters to VNF-specific healing procedures.
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
TerminateNsRequest:
description: >
This type represents a NS termination request.
It shall comply with the provisions defined in Table 6.5.2.15-1.
NOTE 1: Information needed for terminating specific VNF instances shall only be
specified in the "terminateVnfData" attribute, and not in the "terminateNsData" attribute.
NOTE 2: VNF instance(s) part of this NS instance is(are) terminated as part of Terminate
NS operation only if the instance(s) is(are) not used by any other NS instance.
Samir Medjiah
committed
type: object
properties:
terminationTime:
description: >
Timestamp indicating the end time of the NS, i.e. the NS
will be terminated automatically at this timestamp.
Cardinality "0" indicates the NS termination takes place immediately
$ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
terminateNsData:
description: >
Provides additional parameters to the termination process at the NS level.
$ref: "#/definitions/TerminateNsData"
terminateVnfData:
description: >
Provides the information to terminate VNF instance(s).
type: array
items:
$ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
Samir Medjiah
committed
CreateNsRequest:
type: object
required:
- nsdId
- nsName
- nsDescription
properties:
nsdId:
description: >
Identifier of the NSD that defines the NS instance to be
created.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
nsName:
description: >
Human-readable name of the NS instance to be created.
type: string
nsDescription:
description: >
Human-readable description of the NS instance to be created.
type: string
moscatelli
committed
CancelModeType:
description: >
Cancellation mode.
The NFVO shall not start any new VNF lifecycle management and resource
management operation, and shall wait for the ongoing VNF lifecycle management
and resource management operations in the underlying system, typically the VNFM
and VIM, to finish execution or to time out. After that, the NFVO shall put the
operation occurrence into the FAILED_TEMP state.
The NFVO shall not start any new VNF lifecycle management and resource
management operation, shall cancel the ongoing VNF lifecycle management and
resource management operations in the underlying system, typically the VNFM and
VIM, and shall wait for the cancellation to finish or to time out. After that, the NFVO
shall put the operation occurrence into the FAILED_TEMP state.
type: string
enum:
- GRACEFUL
- FORCEFUL
NsInstance:
description: >
This type represents a response for Query NS operation.
It shall comply with the provisions defined in Table 6.5.2.10-1.
NOTE: If the "nsState" attribute is INSTANTIATED, at least either one
"vnfInstance" attribute or one "nestedNsInstanceId" attribute shall be present.
type: object
required:
- id
- nsInstanceName
- nsInstanceDescription
- nsdId
- nsdInfoId
- nsState
properties:
id:
description: >
Identifier of the NS instance.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
nsInstanceName:
description: >
Human readable name of the NS instance.
type: string
nsInstanceDescription:
description: >
Human readable description of the NS instance.
type: string
nsdId:
description: >
Identifier of the NSD on which the NS instance is based. The value is copied from the NSD.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
nsdInfoId:
description: >
Identifier of the NSD information object on which the
NS instance is based. This identifier has been allocated by the NFVO.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
flavourId:
description: >
Identifier of the NS deployment flavor applied to
the NS instance. This attribute shall be present if the nsState attribute
value is INSTANTIATED.
$ref: "#/definitions/IdentifierInNsd"
vnfInstance:
description: >
Information on constituent VNF(s) of the NS instance.
moscatelli
committed
$ref: "#/definitions/VnfInstance"
pnfInfo:
description: >
Information on the PNF(s) that are part of the NS instance.
type: array
items:
moscatelli
committed
$ref: "#/definitions/PnfInfo"
virtualLinkInfo:
description: >
Information on the VL(s) of the NS instance.
This attribute shall be present if the nsState attribute
value is INSTANTIATED and if the NS instance has
specified connectivity.
type: array
items:
moscatelli
committed
$ref: "#/definitions/NsVirtualLinkInfo"
vnffgInfo:
description: >
Information on the VNFFG(s) of the NS instance.
type: array
items:
moscatelli
committed
$ref: "#/definitions/VnffgInfo"
sapInfo:
description: >
Information on the SAP(s) of the NS instance.
type: array
moscatelli
committed
items:
$ref: "#/definitions/SapInfo"
nestedNsInstanceId:
description: >
Identifier of the nested NS(s) of the NS instance.
moscatelli
committed
items:
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
vnfSnapshotInfoIds:
description: >
Identifier of information on VNF snapshots of VNF instances that are part of this NS instance.
type: array
items:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
nsState:
description: >
The state of the NS instance.
Permitted values:
NOT_INSTANTIATED: The NS instance is
terminated or not instantiated.
INSTANTIATED: The NS instance is instantiated.
type: string
moscatelli
committed
enum:
moscatelli
committed
- INSTANTIATED
monitoringParameter:
description: >
Performance metrics tracked by the NFVO (e.g. for
auto-scaling purposes) as identified by the NS
designer in the NSD.
type: array
items:
$ref: "#/definitions/NsMonitoringParameter"
nsScaleStatus:
description: >
Status of each NS scaling aspect declared in the
applicable DF, how "big" the NS instance has been
scaled w.r.t. that aspect.
This attribute shall be present if the nsState attribute
rameshnaraya
committed
value is INSTANTIATED.
moscatelli
committed
$ref: "#/definitions/NsScaleInfo"
additionalAffinityOrAntiAffinityRule:
description: >
Information on the additional affinity or anti-affinity
rule from NS instantiation operation. Shall not
conflict with rules already specified in the NSD.
type: array
moscatelli
committed
items:
$ref: "#/definitions/AffinityOrAntiAffinityRule"
wanConnectionInfo:
description: >
Information about WAN related connectivity enabling multi-site VLs.
type: array
items:
$ref: "#/definitions/WanConnectionInfo"
rameshnaraya
committed
description: Links to resources related to this resource.
required:
- self
properties:
self:
description: >
URI of this resource.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
nestedNsInstances:
description: >
Links to resources related to this notification.
type: array
items:
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
vnfSnapshotInfos:
description: >
Links to the VNF snapshots associated to VNF instances which are part of this NS instance.
type: array
items:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
instantiate:
description: >
Link to the "instantiate" task resource, if the related
operation is possible based on the current status of
this NS instance resource (i.e. NS instance in
NOT_INSTANTIATED state).
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
terminate:
description: >
Link to the "terminate" task resource, if the related
operation is possible based on the current status of
this NS instance resource (i.e. NS instance is in
INSTANTIATED state).
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
update:
description: >
Link to the "update" task resource, if the related
operation is possible based on the current status of
this NS instance resource (i.e. NS instance is in
INSTANTIATED state).
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
scale:
description: >
Link to the "scale" task resource, if the related
operation is supported for this NS instance, and is
possible based on the current status of this NS
instance resource (i.e. NS instance is in
INSTANTIATED state).
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
heal:
description: >
Link to the "heal" task resource, if the related
operation is supported for this NS instance, and is
possible based on the current status of this NS
instance resource (i.e. NS instance is in
INSTANTIATED state).
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
moscatelli
committed
VnfInstance:
description: >
This type represents a VNF instance. It shall comply with the provisions defined in table 6.5.3.57-1.
NOTE: Clause B.3.2 of ETSI GS NFV-SOL 003 provides examples illustrating the relationship among the
different run-time information elements (CP, VL and link ports) used to represent the connectivity
of a VNF.
NOTE 1: Modifying the value of this attribute shall not be performed when conflicts exist between the
previous and the newly referred VNF package, i.e. when the new VNFD is changed with respect to
the previous VNFD in other aspects than merely referencing to other VNF software images.
In order to avoid misalignment of the VnfInstance with the current VNF's on-boarded VNF Package,
the values of attributes in the VnfInstance that have corresponding attributes in the VNFD shall
be kept in sync with the values in the VNFD.
NOTE 2: ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD based on TOSCA specifications.
NOTE 3: VNF configurable properties are sometimes also referred to as configuration parameters applicable
to a VNF. Some of these are set prior to instantiation and cannot be modified if the VNF is instantiated,
some are set prior to instantiation (are part of initial configuration) and can be modified later,
and others can be set only after instantiation. The applicability of certain configuration may depend
on the VNF and the required operation of the VNF at a certain point in time.
NOTE 4: 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 6.5.3.59).
NOTE 5: Even though externally-managed internal VLs are also used for VNF-internal connectivity, they shall not
be listed in the "vnfVirtualLinkResourceInfo" attribute as this would be redundant.
type: object
required:
- id
- vnfdId
- vnfProvider
- vnfProductName
- vnfSoftwareVersion
- vnfdVersion
- vnfPkgId
- instantiationState
properties:
id:
description: >
Identifier of the VNF instance.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
vnfInstanceName:
description: >
Name of the VNF instance.
Modifications to this attribute can be requested using the "ModifyVnfInfoData" structure.
type: string
vnfInstanceDescription:
description: >
Human-readable description of the VNF instance.
Modifications to this attribute can be requested using the "ModifyVnfInfoData" structure.
type: string
vnfdId:
description: >
Identifier of the VNFD on which the VNF instance is based.
Modifications to this attribute can be requested using the "ModifyVnfInfoData" structure.
See note 1.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_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.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Version"
vnfdVersion:
description: >
Identifies the version of the VNFD. The value is copied from the VNFD.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Version"
vnfPkgId:
description: >
moscatelli
committed
Identifier of information held by the NFVO about
the specific VNF package on which the VNF is
based. This identifier has been allocated by the NFVO.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
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
(see note 2 and note 3).
These configurable properties include the following standard attributes, which are
eclared 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.
Modifications to these attributes can be requested using the "ModifyVnfInfoData" structure.
In addition, the provisions in clause 6.7 shall apply.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
vimId:
description: >
Identifier of a VIM that manages resources for the VNF instance.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
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 flavor applied to this VNF instance.
$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
vnfState:
description: >
$ref: "#/definitions/VnfOperationalStateType"
scaleStatus:
description: >
Scale status of the VNF, one entry per aspect. Represents for every
scaling aspect how "big" the VNF has been scaled w.r.t. that aspect.
type: array
items:
$ref: "#/definitions/VnfScaleInfo"
maxScaleLevels:
description: >
Maximum allowed scale levels of the VNF, one
entry per aspect.
This attribute shall be present if the VNF
supports scaling.
type: array
items:
$ref: "#/definitions/VnfScaleInfo"
extCpInfo:
description: >
Information about the external CPs exposed by the VNF instance.
When trunking is enabled, the list of entries includes both,
external CPs corresponding to parent ports of a trunk, and external
CPs associated to sub-ports of a trunk.
type: array
minItems: 1
items:
$ref: "#/definitions/VnfExtCpInfo"
vipCpInfo:
description: >
VIP CPs that are part of the VNF instance.
Shall be present when that particular VIP CP
of the VNFC instance is associated to an external
CP of the VNF instance.
May be present otherwise.
type: array
items:
$ref: "#/definitions/VipCpInfo"
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 note 4 and note 5.
type: array
items:
$ref: "#/definitions/ExtManagedVirtualLinkInfo"
monitoringParameters:
description: >
Performance metrics tracked by the VNFM (e.g. for
auto-scaling purposes) as identified by the VNF
provider in the VNFD.
$ref: "#/definitions/VnfMonitoringParameter"
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: >
moscatelli
committed
Information about the virtualised compute and storage resources used
by the VNFCs of the VNF instance.
type: array
items:
$ref: "#/definitions/VnfcResourceInfo"
description: >
Information about the virtualised network resources used by the VLs
of the VNF instance.
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"
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 (see note 2).
Modifications to these attributes can be requested using the "ModifyVnfInfoData" structure.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
extensions:
description: >
Additional VNF-specific attributes that affect the lifecycle management of this VNF instance.
These attributes represent values that are stored persistently in the VnfInstance structure
for consumption by the VNFM, or by the lifecycle management scripts. during the execution
of VNF lifecycle management operations.
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.
Extensions that are allowed for the VNF are declared in the VNFD.
Modifications to these attributes can be requested using the "ModifyVnfInfoData" structure.
In addition, the provisions in clause 6.7 shall apply.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
moscatelli
committed
moscatelli
committed
required:
moscatelli
committed
properties:
nsInstance:
description: >
Link to the resource representing the NS instance to
which the notified change applies..
$ref: "../../definitions/SOL005_def.yaml#/definitions/NotificationLink"
subscription:
description: >
Link to the subscription that triggered this notification.
$ref: "../../definitions/SOL005_def.yaml#/definitions/NotificationLink"
description: >
Link to the lifecycle operation occurrence that this
notification is related to. Shall be present if there is a
related lifecycle operation occurrence
$ref: "../../definitions/SOL005_def.yaml#/definitions/NotificationLink"
moscatelli
committed
VnfOperationalStateType:
type: string
enum:
- STARTED
- STOPPED
moscatelli
committed
VnfScaleInfo:
required:
- aspectId
- scaleLevel
type: object
properties:
aspectId:
description: >
Identifier of the scaling aspect.
$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
vnfdId:
description: >
Identifier of the VNFD.
Shall be present in case the value differs from the vnfdId attribute of the VnfInstance (e.g. during a "Change
current VNF package" operation or due to its final failure).
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
scaleLevel:
description: >
Indicates the scale level. The minimum value shall be 0 and the
maximum value shall be <= maxScaleLevel as described in the VNFD.
type: integer
PnfInfo:
description: >
This type represents the information about a PNF that is part of an NS instance.
It shall comply with the provisions
defined in Table 6.5.3.13-1.
type: object
required:
- pnfId
- pnfdId
- pnfdInfoId
- pnfProfileId
properties:
pnfId:
description: >
Identifier of the PNF. This identifier is allocated by the OSS/BSS.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
pnfName:
description: >
Name of the PNF.
type: string
pnfdId:
description: >
Identifier of the PNFD on which the PNF is based.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
pnfdInfoId:
description: >
Identifier of the PNFD information onject related to this
PNF. This identifier is allocated by the NFVO
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
pnfProfileId:
description: >
Identifier of the related PnfProfile in the NSD on which
the PNF is based.
$ref: "#/definitions/IdentifierInNsd"
cpInfo:
description: >
Information on the external CP of the PNF.
$ref: "#/definitions/PnfExtCpInfo"
moscatelli
committed
PnfExtCpInfo:
description: >
This type represents the information about the external CP of the PNF.
It shall comply with the provisions defined in
Table 6.5.3.17-1.
type: object
required:
- cpInstanceId
- cpdId
properties:
cpInstanceId:
description: >
Identifier of the CP in the scope of the PNF.
$ref: "#/definitions/IdentifierInPnf"
cpdId:
description: >
Identifier of (reference to) the Connection Point
Descriptor (CPD) for this CP.
$ref: "#/definitions/IdentifierInNsd"
cpProtocolData:
description: >
Parameters for configuring the network protocols on the CP.
type: array
moscatelli
committed
items:
Samir Medjiah
committed
$ref: "#/definitions/CpProtocolData"
moscatelli
committed
NsVirtualLinkInfo:
description: >
This type specifies the information about an NS VL instance.
It shall comply with the provisions defined in Table 6.5.3.53-1.
NOTE: As an NS can include NFs deployed in NFVI PoPs under the control
of several different VIMs, therefore deploying an NS VL can involve
several VIMs, each allocating different virtualised network resources,
as well as WIMs handling the connectivity in between the NFVI-PoPs in
the form of multi-site connectivity services.
When this NsVirtualLink is provided as an ExtVirtualLink as input
of a VNF LCM operation, the id of the ExtVirtualLink shall be the same
as the corresponding NsVirtualLink.
type: object
required:
- id
- nsVirtualLinkDescId
- nsVirtualLinkProfileId
properties:
id:
description: >
Identifier of the VL instance.
$ref: "#/definitions/IdentifierInNs"
nsVirtualLinkDescId:
description: >
Identifier of the VLD in the NSD.
$ref: "#/definitions/IdentifierInNsd"
nsVirtualLinkProfileId:
description: >
Identifier of the VL profile in the NSD.
$ref: "#/definitions/IdentifierInNsd"
resourceHandle:
description: >
Identifier(s) of the virtualised network resource(s) and/or multi-site connectivity service(s)
realizing the VL instance.
moscatelli
committed
items:
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
linkPort:
description: >
Link ports of the VL instance.
Cardinality of zero indicates that no port has yet been
created for the VL instance.
type: array
moscatelli
committed
items:
$ref: "#/definitions/NsLinkPortInfo"
VnffgInfo:
description: >
Information on the VNFFG(s) of the NS instance.
NOTE: It indicates an exhaustive list of all the
CP instances and SAP instances of the VNFFG.
type: object
required:
- id
- vnffgdId
- vnfInstanceId
- pnfInfoId
properties:
id:
description: >
Identifier of this VNFFG instance.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
vnffgdId:
description: >
Identifier of the VNFFGD in the NSD.
$ref: "#/definitions/IdentifierInNsd"
vnfInstanceId:
description: >
Identifier(s) of the constituent VNF instance(s) of this VNFFG instance.
type: array
moscatelli
committed
items:
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
pnfdInfoId:
description: >
Identifier(s) of the constituent PNF instance(s) of this
VNFFG instance.
type: array
moscatelli
committed
items:
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
nsVirtualLinkInfoId:
description: >
Identifier(s) of the constituent VL instance(s) of this
VNFFG instance.
type: array
moscatelli
committed
items:
$ref: "#/definitions/IdentifierInNs"
nsCpHandle:
description: >
Identifiers of the CP instances attached to the
constituent VNFs and PNFs or the SAP instances of the
VNFFG. See note.
NfpInfo:
description: >
This type represents an NFP instance. It shall comply with
the provisions defined in Table 6.5.3.66-1.
NOTE: When multiple identifiers are included, the position
of the identifier in the CpGroup data type specifies the
position of the group in the path.
type: object
required:
- id
- nfpRule
- nfpState
properties:
id:
description: >
Identifier of this NFP instance.
$ref: "#/definitions/IdentifierInNs"
nfpdId:
description: >
Identifier of the NFPD used to instantiate this NFP
instance. It shall be present if the NFP instance is
instantiated from the NFPD.
$ref: "#/definitions/IdentifierInNsd"
nfpName:
description: >
Human readable name for the NFP instance.
type: string
description:
description: >
Human readable description for the NFP instance.
type: string
cpGroup:
description: >
Group(s) of CPs and/or SAPs which the NFP passes through.
type: array
minItems: 1
items:
totalCp:
description: >
Total number of CP and SAP instances in this NFP instance.
type: integer
nfpRule:
description: >
NFP classification and selection rule.
$ref: "#/definitions/NfpRule"
nfpState:
description: >
The state of the NFP instance.
Permitted values:
* ENABLED: The NFP instance is enabled.
* DISABLED: The NFP instance is disabled.
type: string
enum:
- ENABLED
- DISABLED
NsCpHandle:
description: >
This type represents an identifier of the CP or SAP instance.
It shall comply with the provisions defined in
Table 6.5.3.56-1.
NOTE 1: For the VNF external CP instance, both vnfInstanceId and vnfExtCpInstanceId shall be present as a pair.
NOTE 2: For the PNF external CP instance, both pnfInfoId and PnfExtCpInstanceId shall be present as a pair.
NOTE 3: For the SAP instance, both nsInstanceId and nsSapInstanceId shall be present as a pair.
NOTE 4: One pair of identifiers (VNF external CP, PNF external CP or SAP) shall be present.
moscatelli
committed
type: object
oneOf:
- required:
- vnfInstanceId
- vnfExtCpInstanceId
- required:
- pnfInfoId
- pnfExtCpInstanceId
- required:
- nsInstanceId
- nsSapInstanceId
properties:
vnfInstanceId:
description: >
Identifier of the VNF instance associated to the CP instance.
This attribute shall be present if the CP instance is VNF external CP.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
vnfExtCpInstanceId:
description: >
Identifier of the VNF external CP instance in the scope
of the VNF instance. This attribute shall be present if the CP instance is VNF
external CP. See notes 1 and 4.
$ref: "#/definitions/IdentifierInVnf"
pnfInfoId:
description: >
Identifier of the PNF instance associated to the CP
instance. This attribute shall be present if the CP instance is PNF
external CP. See notes 2 and 4.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
pnfExtCpInstanceId:
description: >
Identifier of the PNF external CP instance in the scope
of the PNF. This attribute shall be present if the CP instance is PNF
external CP. See notes 2 and 4.
$ref: "#/definitions/IdentifierInPnf"
nsInstanceId:
description: >
Identifier of the NS instance associated to the SAP
instance. This attribute shall be present if the CP instance is NS
SAP. See notes 3 and 4.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
nsSapInstanceId:
description: >
Identifier of the SAP instance in the scope of the NS
instance. This attribute shall be present if the CP instance is NS
SAP. See notes 3 and 4.
$ref: "#/definitions/IdentifierInNs"
moscatelli
committed
SapInfo:
description: >
This type represents an SAP instance. It shall comply with the provisions defined in Table 6.5.3.67-1.
type: object
required:
- id
- sapdId
- sapName
- sapProtocolInfo
properties:
id:
description: >
Identifier of the SAP instance.
$ref: "#/definitions/IdentifierInNs"
sapdId:
description: >
Identifier of the SAPD in the NSD.
$ref: "#/definitions/IdentifierInNsd"
sapName:
description: >
Human readable name for the SAP instance.
type: string
description:
description: >
Human readable description for the SAP instance.
type: string
sapProtocolInfo:
description: >
Network protocol information for this SAP.
type: array
moscatelli
committed
items:
$ref: "#/definitions/CpProtocolInfo"
moscatelli
committed
NsMonitoringParameter:
description: >
This type represents a monitoring parameter that is tracked by the NFVO, for example,
for auto-scaling purposes. It shall comply with the provisions defined in Table 6.5.3.68-1.
type: object
required:
- id
- performanceMetric
properties:
id:
description: >
Identifier of the monitoring parameter defined in the NSD.
$ref: "#/definitions/IdentifierInNsd"
name:
description: >
Human readable name of the monitoring parameter, as defined in the NSD.
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
VnfMonitoringParameter:
description: >
This type represents a monitoring parameter that is tracked by the VNFM, for example,
for auto-scaling purposes. It shall comply with the provisions defined in Table 6.5.3.69-1.
type: object
required:
- id
- performanceMetric
properties:
id:
description: >
Identifier of the monitoring parameter defined in the VNFD.
$ref: "#/definitions/IdentifierInNsd"
vnfdId:
description: >
Identifier of the VNFD.
Shall be present in case the value differs from the vnfdId attribute of the VnfInstance (e.g. during a
"Change current VNF package" operation or due to its final failure).
$ref: "../../definitions/SOL005_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
VnfExtCpInfo:
description: >
This type represents information about an external CP of a VNF. It shall comply
with the provisions defined in Table 6.5.3.70-1.
NOTE 1: The attributes "associatedVnfcCpId", "associatedVipCpId" 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 6.5.3.26.
type: object
required:
- id
- cpdId
- required:
- associatedVnfcCpId
- required:
- associatedVnfVirtualLinkId
properties:
id:
description: >
Identifier of the external CP instance and the related information instance.
$ref: "#/definitions/IdentifierInVnf"
cpdId:
description: >
Identifier of the external CPD, VnfExtCpd, in the VNFD.
$ref: "../../definitions/SOL005_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: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
vnfdId:
description: >
Identifier of the VNFD.
Shall be present in case the value differs from the vnfdId attribute of the
VnfInstance (e.g. during a "Change current VNF package" operation or due to
its final failure).
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
cpProtocolInfo:
description: >
Network protocol information for this CP.
type: array
minItems: 1
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.
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
metadata:
description: >
Metadata about this external CP.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_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.
The attributes "associatedVnfcCpId", "associatedVipCpId" and "associatedVnfVirtualLinkId"
are mutually exclusive. Exactly one shall be present.
$ref: "#/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: "#/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).
The attributes "associatedVnfcCpId", "associatedVipCpId" and
"associatedVnfVirtualLinkId" are mutually exclusive. Exactly one shall be present.
$ref: "#/definitions/IdentifierInVnf"
CpGroupInfo:
description: >
This type represents describes a group of CPs and/or SAPs pairs associated to
the same position in an NFP. It shall comply with the provisions defined in
Table 6.5.3.71-1.
NOTE: All CP or SAP pairs in a group shall be instantiated from connection
point descriptors or service access point descriptors referenced in the corresponding
NfpPositionDesc.
type: object
properties:
cpPairInfo:
description: >
One or more pair(s) of ingress and egress CPs or SAPs which the NFP passes by.
All CP or SAP pairs in a group shall be instantiated from connection point
descriptors or service access point descriptors referenced in the corresponding
NfpPositionDesc.
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
type: array
minItems: 1
items:
$ref: "#/definitions/CpPairInfo"
forwardingBehaviour:
description: >
Identifies a rule to apply to forward traffic to the ingress CPs or SAPs of
the group.
Permitted values:
* ALL = Traffic flows shall be forwarded simultaneously to all CPs or SAPs
of the group.
* LB = Traffic flows shall be forwarded to one CP or SAP of the group selected
based on a loadbalancing algorithm.
type: string
enum:
- ALL
- LB
forwardingBehaviourInputParameters:
description: >
Provides input parameters to configure the forwarding behaviour (e.g. identifies
a load balancing algorithm and criteria).
$ref: "#/definitions/ForwardingBehaviourInputParameters"
CpPairInfo:
description: >
This type represents describes a pair of ingress and egress CPs or SAPs which
the NFP passes by. It shall comply with the provisions defined in Table 6.5.3.72-1.
NOTE 1: The presence of a single vnfExpCpId, pnfExtCpId, or sapId occurrence indicates that the CP or SAP is used both as an ingress and egress port at a particular NFP position.
NOTE 2: Only one of these three attributes shall be present.
type: object
properties:
vnfExtCpIds:
description: >
Identifier(s) of the VNF CP(s) which form the pair.
type: array
maxItems: 2
items:
$ref: "#/definitions/IdentifierInVnf"
pnfExtCpIds:
description: >
Identifier(s) of the PNF CP(s) which form the pair.
type: array
maxItems: 2
items:
$ref: "#/definitions/IdentifierInPnf"
sapIds:
description: >
Identifier(s) of the SAP(s) which form the pair.
type: array
maxItems: 2
items:
$ref: "#/definitions/IdentifierInNs"
Samir Medjiah
committed
ForwardingBehaviourInputParameters:
description: >
This type represents provides input parameters to configure the forwarding behaviour.
It shall comply with the provisions defined in Table 6.5.3.73-1.
NOTE 1: If applicable to the algorithm but not provided, default values determined by the VIM or NFVI are expected to be used.
NOTE 2: Weight applies to the CP instances in the order they have been created.
Samir Medjiah
committed
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
type: object
properties:
algortihmName:
description: >
May be included if forwarding behaviour is equal to LB. Shall not be included otherwise.
Permitted values:
* ROUND_ROBIN
* LEAST_CONNECTION
* LEAST_TRAFFIC
* LEAST_RESPONSE_TIME
* CHAINED_FAILOVER
* SOURCE_IP_HASH
* SOURCE_MAC_HASH
type: string
enum:
- ROUND_ROBIN
- LEAST_CONNECTION
- LEAST_TRAFFIC
- LEAST_RESPONSE_TIME
- CHAINED_FAILOVER
- SOURCE_IP_HASH
Samir Medjiah
committed
algorithmWeights:
description: >
Percentage of messages sent to a CP instance. May be included if applicable to
the algorithm.
Samir Medjiah
committed
type: array
items:
type: integer
CpProtocolInfo:
description: >
This type describes the protocol layer(s) that a CP or SAP uses together with protocol-related information, like
addresses. It shall comply with the provisions defined in Table 6.5.3.58-1.
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
- ipOverEthernet
properties:
layerProtocol:
description: >
The identifier of layer(s) and protocol(s)
associated to the network address information.
Permitted values:
- IP_OVER_ETHERNET
See note.
type: string
enum:
- IP_OVER_ETHERNET
ipOverEthernet:
description: >
IP addresses over Ethernet to assign to the CP
or SAP instance. Shall be present if
layerProtocol is equal to "
IP_OVER_ETHERNET", and shall be absent otherwise.
$ref: "#/definitions/IpOverEthernetAddressInfo"
IpOverEthernetAddressInfo:
moscatelli
committed
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.
moscatelli
committed
type: object
anyOf:
- required:
- macAddress
- required:
- ipAddresses
moscatelli
committed
properties:
macAddress:
description: >
Assigned MAC address.
$ref: "#/definitions/MacAddress"
segmentationId:
description: >
Identification of the network segment to which the Cp instance connects to.
moscatelli
committed
ipAddresses:
description: >
Addresses assigned to the CP instance. Each entry represents IP
addresses assigned by fixed or dynamic IP address assignment per
subnet.
moscatelli
committed
type: array
items:
type: object
required:
- type
oneOf:
- required:
- addresses
- required:
- addressRange
moscatelli
committed
properties:
type:
description: >
The type of the IP addresses.
piscione
committed
Permitted values:
- IPV4
- IPV6
moscatelli
committed
type: string
enum:
- IPV4
- IPV6
addresses:
description: >
Fixed addresses assigned (from the subnet defined by
"subnetId" if provided).
moscatelli
committed
type: array
items:
$ref: "#/definitions/IpAddress"
moscatelli
committed
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.
Exactly one of "addresses" or "addressRange" shall be present.
moscatelli
committed
type: object
required:
- minAddress
- maxAddress
properties:
minAddress:
description: >
Lowest IP address belonging to the range.
$ref: "#/definitions/IpAddress"
moscatelli
committed
maxAddress:
description: >
Highest IP address belonging to the range
$ref: "#/definitions/IpAddress"
moscatelli
committed
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: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVim"
moscatelli
committed
type:
description: >
The type of the IP addresses
type: string
enum:
- PV4
- PV6
addresses:
description: >
Fixed addresses assigned (from the subnet
defined by "subnetId" if provided). See note.
type: array
items:
$ref: "#/definitions/IpAddress"
moscatelli
committed
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.
type: object
required:
- minAddress
- maxAddress
properties:
minAddress:
description: >
Lowest IP address belonging to the range.
$ref: "#/definitions/IpAddress"
moscatelli
committed
maxAddress:
description: >
Highest IP address belonging to the range
$ref: "#/definitions/IpAddress"
moscatelli
committed
minAddress:
description: >
Lowest IP address belonging to the range
$ref: "#/definitions/IpAddress"
moscatelli
committed
maxAddress:
description: >
Highest IP address belonging to the range.
$ref: "#/definitions/IpAddress"
moscatelli
committed
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: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVim"
moscatelli
committed
ExtVirtualLinkInfo:
type: object
required:
- id
- resourceHandle
properties:
id:
moscatelli
committed
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.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
resourceHandle:
description: >
Reference to the resource realizing this VL.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_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, as
specified in clause 5.5.3.2 of ETSI GS NFV-SOL 003.
$ref: "#/definitions/VnfExtCpData"
ExtLinkPortInfo:
description: >
This type represents information about a link port of an external VL,
i.e. a port providing connectivity for the VNF to an NS VL.
NOTE 1: The use cases UC#4 and UC#5 in Annex 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.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
resourceHandle:
description: >
Reference to the virtualised resource realizing this link port.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_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: "#/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.
$ref: "#/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.
$ref: "#/definitions/IdentifierInVim"
ExtManagedVirtualLinkInfo:
type: object
required:
- id
- vnfVirtualLinkDescId
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.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
vnfdId:
description: >
Identifier of the VNFD.
Shall be present in case the value differs from the vnfdId attribute of the VnfInstance (e.g. during a
"Change current VNF package" operation or due to its final failure).
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
vnfVirtualLinkDescId:
description: >
Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.
$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
networkResource:
description: >
Reference to the VirtualNetwork resource or multi-site connectivity service providing this VL.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
vnfLinkPorts:
description: >
Link ports of this VL.
type: array
items:
$ref: "#/definitions/VnfLinkPortInfo"
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 present 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: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
VnfLinkPortInfo:
type: object
description: >
This type represents a link port of an internal VL of a VNF.
It shall comply with the provisions defined in table 6.5.3.64-1.
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.
NOTE 2: Annex A.4 of ETSI GS NFV-IFA 007 [19] 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 (UC#6 and UC#6-b).
NOTE 3: The value of "trunkResourceId" is scoped by the value of
"vimConnectionId" in the "resourceHandle" attribute.
required:
- id
- resourceHandle
properties:
id:
description: >
Identifier of this link port as provided by the entity that has created the link port.
$ref: "#/definitions/IdentifierInVnf"
resourceHandle:
description: >
Reference to the virtualised resource realizing this link port.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_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 of the
VNF to be connected to this link port.
When the link port is used for internal connectivity in the VNF,
this attribute represents 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 "vnfcResouceInfo" item in the VnfInstance.
$ref: "#/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.
type: string
enum:
- VNFC_CP
- EXT_CP
vipCpInstanceId:
description: >
VIP CP instance of the VNF connected to this link port. May be present.
$ref: "#/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.
$ref: "#/definitions/IdentifierInVim"
MonitoringParameter:
type: object
required:
- id
- value
- timeStamp
properties:
id:
description: >
Identifier of the monitoring parameter defined in the VNFD.
$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
name:
description: >
Human readable name of the monitoring parameter, as defined in the VNFD.
type: string
value:
description: >
Value of the monitoring parameter known to the VNFM (e.g. obtained
rameshnaraya
committed
for auto-scaling purposes).
The type of the "value" attribute (i.e. scalar, structure (Object in
JSON), or array (of scalars, arrays or structures/Objects)) is
assumed to be defined in an external measurement specification.
type: object
rameshnaraya
committed
timeStamp:
description: >
Represents the point in time when the measurement has been performed,
as known to the VNFM.
Should be formatted according to ETF RFC 3339.
type: string
VnfcResourceInfo:
description: >
This type represents the information on virtualised compute and storage
resources used by a VNFC in a VNF instance.
NOTE 1: ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD based on TOSCA specifications.
NOTE 2: A VNFC CP is "connected to" an external CP if the VNFC CP
is connected to an internal VL that exposes an external CP. A VNFC CP
is "exposed as" an external CP if it is connected directly to an external VL.
NOTE 3: The information can be omitted because it is already available
as part of the external CP information.
type: object
required:
- id
- vduId
- computeResource
properties:
id:
description: >
Identifier of this VnfcResourceInfo instance.
$ref: "#/definitions/IdentifierInVnf"
vnfdId:
description: >
Identifier of the VNFD.
Shall be present in case the value differs from the vnfdId attribute of the VnfInstance (e.g. during a
"Change current VNF package" operation or due to its final failure).
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
Reference to the applicable VDU in the VNFD. See note 1.
$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
computeResource:
description: >
Reference to the VirtualCompute resource.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
storageResourceIds:
description: >
References to the VirtualStorage resources. The value refers to a
VirtualStorageResourceInfo item in the VnfInstance.
type: array
items:
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
reservationId:
description: >
The reservation identifier applicable to the resource. It shall be
present when an applicable reservation exists.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
vnfcCpInfo:
description: >
CPs of the VNFC instance.
Shall be present when that particular CP of the VNFC instance is
exposed as an external CP of the VNF instance or is connected to
an external CP of the VNF instance.See note 2.
May be present otherwise.
type: array
items:
type: object
required:
- id
- cpdId
properties:
id:
description: >
Identifier of this VNFC CP instance and the associated array
entry.
$ref: "#/definitions/IdentifierInVnf"
Identifier of the VDU CPD, cpdId, in the VNFD. See note 1.
$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
vnfExtCpId:
description: >
Identifier of the related external CP. Shall be present when
the VNFC CP is exposed as an external CP of the VNF instance
or connected to an external CP of the VNF instance (see note 2)
and shall be absent otherwise.
$ref: "#/definitions/IdentifierInVnf"
cpProtocolInfo:
description: >
Network protocol information for this CP.
May be omitted if the VNFC CP is exposed as an external CP.
type: array
items:
$ref: "#/definitions/CpProtocolInfo"
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: "#/definitions/IdentifierInVnf"
vnfLinkPortId:
description: >
Identifier of the "vnfLinkPorts" structure in the "VnfVirtualLinkResourceInfo" or "ExtManagedVirtualLinkInfo"
structure. Shall be present if the CP is associated to a link port on an internal VL (including
externally-managed internal VL) of the VNF instance and shall be absent otherwise.
$ref: "#/definitions/IdentifierInVnf"
metadata:
description: >
Metadata about this CP.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
metadata:
description: >
Metadata about this resource.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
VnfVirtualLinkResourceInfo:
moscatelli
committed
description: >
This type represents the information that allows addressing a virtualised
resource that is used by an internal VL instance in a VNF instance.
type: object
required:
- id
- vnfVirtualLinkDescId
- networkResource
properties:
id:
description: >
Identifier of this VnfVirtualLinkResourceInfo instance.
$ref: "#/definitions/IdentifierInVnf"
vnfdId:
description: >
Identifier of the VNFD.
Shall be present in case the value differs from the vnfdId attribute of the VnfInstance (e.g. during a
"Change current VNF package" operation or due to its final failure).
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
moscatelli
committed
vnfVirtualLinkDescId:
description: >
Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.
$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
moscatelli
committed
networkResource:
description: >
Reference to the VirtualNetwork resource.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
moscatelli
committed
reservationId:
description: >
The reservation identifier applicable to the resource. It shall be
present when an applicable reservation exists.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
moscatelli
committed
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.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
moscatelli
committed
VirtualStorageResourceInfo:
moscatelli
committed
description: >
This type represents the information that allows addressing a virtualised
resource that is used by a VNF instance.
type: object
required:
- id
- virtualStorageDescId
- storageResource
properties:
id:
description: >
Identifier of this VirtualStorageResourceInfo instance.
$ref: "#/definitions/IdentifierInVnf"
moscatelli
committed
virtualStorageDescId:
description: >
Identifier of the VirtualStorageDesc in the VNFD.
$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
vnfdId:
description: >
Identifier of the VNFD.
Shall be present in case the value differs from the vnfdId attribute of the VnfInstance
(e.g. during a "Change current VNF package" operation or due to its final failure).
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
moscatelli
committed
storageResource:
description: >
Reference to the VirtualStorage resource.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
moscatelli
committed
reservationId:
description: >
The reservation identifier applicable to the resource. It shall be
present when an applicable reservation exists.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
moscatelli
committed
metadata:
description: >
Metadata about this resource.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
moscatelli
committed
moscatelli
committed
description: >
This type represents information about a link port of a VL instance.
It shall comply with the provisions defined in Table 6.5.3.55-1.
NOTE: When the NsVirtualLink, from which the present NsLinkPort is part of,
is provided as an ExtVirtualLink as input of a VNF LCM operation, the id
of the ExtLinkPort shall be the same as the corresponding NsLinkPort.
moscatelli
committed
type: object
required:
- id
- resourceHandle
properties:
id:
description: >
Identifier of this link port as provided by the entity that
has created the link port.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
moscatelli
committed
resourceHandle:
description: >
Identifier of the virtualised resource realizing
moscatelli
committed
this link port.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
moscatelli
committed
nsCpHandle:
description: >
Identifier of the CP/SAP instance to be connected to this
link port. The value refers to a vnfExtCpInfo item in the
VnfInstance, or a pnfExtCpInfo item in the PnfInfo, or a
sapInfo item in the NS instance.
There shall be at most one link port associated with any
connection point instance.
moscatelli
committed
AffinityOrAntiAffinityRule:
moscatelli
committed
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
description: >
This type describes the additional affinity or anti-affinity rule
applicable between the VNF instances to be instantiated
in the NS instantiation operation request or between the VNF instances
to be instantiated in the NS instantiation
operation request and the existing VNF instances..
type: object
required:
- affinityOrAntiAffiinty
- scope
properties:
vnfdId:
description: >
Reference to a VNFD.
When the VNFD which is not used to instantiate VNF, it
presents all VNF instances of this type as the subjects
of the affinity or anti-affinity rule. The VNF instance
which the VNFD presents is not necessary as a part of
the NS to be instantiated.
type: array
items:
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
moscatelli
committed
vnfProfileId:
description: >
Reference to a vnfProfile defined in the NSD.
At least one VnfProfile which is used to instantiate VNF
for the NS to be instantiated as the subject of the affinity
or anti-affinity rule shall be present. When the VnfProfile
which is not used to instantiate VNF, it presents all VNF
instances of this type as the subjects of the affinity or
anti-affinity rule. The VNF instance which the VnfProfile
presents is not necessary as a part of the NS to be instantiated.
type: array
items:
$ref: "#/definitions/IdentifierInNsd"
moscatelli
committed
vnfInstanceId:
description: >
Reference to the existing VNF instance as the subject of
the affinity or anti-affinity rule. The existing VNF instance
is not necessary as a part of the NS to be instantiated.
type: array
items:
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
moscatelli
committed
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
affinityOrAntiAffiinty:
description: >
The type of the constraint.
Permitted values:
AFFINITY
ANTI_AFFINITY.
type: string
enum:
- AFFINITY
- ANTI_AFFINITY
scope:
description: >
Specifies the scope of the rule where the placement
constraint applies.
Permitted values:
NFVI_POP
ZONE
ZONE_GROUP
NFVI_NODE.
type: string
enum:
- NFVI_POP
- ZONE
- ZONE_GROUP
- NFVI_NODE
InstantiateNsRequest:
type: object
description: >
This type represents request parameters for the "Instantiate NS" operation.
NOTE 1: The DF of the VNF instance shall match the VNF DF present in the associated VNF Profile.
NOTE 2: The NS DF of each nested NS shall be one of the allowed flavours in the associated
NSD (as referenced in the nestedNsd attribute of the NSD of the NS to be instantiated).
NOTE 3: The NSD of each referenced NSs (i.e. each nestedInstanceId) shall match the one of the
nested NSD in the composite NSD.
NOTE 4: When the NS is deployed over several sites, the VLs of this NS will include VNs
in each site connected over the WAN. In this case, the "wanConnectionData" provides the needed
information required to connect each VN to the WAN. Annex E provides additional information and
guidelines about the usage of the "wanConnectionData" attribute.
moscatelli
committed
- nsFlavourId
properties:
nsFlavourId:
description: >
Identifier of the NS deployment flavor to be instantiated.
$ref: "#/definitions/IdentifierInNsd"
sapData:
description: >
moscatelli
committed
Create data concerning the SAPs of this NS.
moscatelli
committed
items:
$ref: "#/definitions/SapData"
addpnfData:
description: >
Information on the PNF(s) that are part of this NS.
type: array
moscatelli
committed
items:
$ref: "#/definitions/AddPnfData"
vnfInstanceData:
description: >
Specify an existing VNF instance to be used in the NS.
If needed, the VNF Profile to be used for this VNF
instance is also provided.
moscatelli
committed
items:
$ref: "#/definitions/VnfInstanceData"
nestedNsInstanceData:
description: >
Specify an existing NS instance to be used as a nested
NS within the NS.
If needed, the NS Profile to be used for this nested NS
instance is also provided.
moscatelli
committed
items:
$ref: "#/definitions/NestedNsInstanceData"
locationConstraints:
description: >
Defines the location constraints for the VNF to be
instantiated as part of the NS instantiation.
An example can be a constraint for the VNF to be in a
specific geographic location..
type: array
moscatelli
committed
items:
$ref: "#/definitions/VnfLocationConstraint"
nestedNslocationConstraints:
description: >
Defines the location constraints for the nested NS to be instantiated as part of the NS instantiation.
An example can be a constraint for the nested NS to be in a specific geographic location.
type: array
items:
additionalParamsForNs:
description: >
Allows the OSS/BSS to provide additional parameter(s)
at the composite NS level (as opposed to the VNF level,
which is covered in additionalParamsForVnf), and as
opposed to the nested NS level, which is covered in
additionalParamsForNestedNs.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
additionalParamsForNestedNs:
description: >
Allows the OSS/BSS to provide additional parameter(s)
per nested NS instance (as opposed to the composite NS
level, which is covered in additionalParamsForNs, and as
opposed to the VNF level, which is covered in
additionalParamsForVnf). This is for nested NS instances
that are to be created by the NFVO as part of the NS
instantiation and not for existing nested NS instances that
are referenced for reuse.
type: array
items:
$ref: "#/definitions/ParamsForNestedNs"
additionalParamsForVnf:
description: >
Allows the OSS/BSS to provide additional parameter(s)
per VNF instance (as opposed to the composite NS level,
which is covered in additionalParamsForNs and as opposed
to the nested NS level, which is covered in
additionalParamsForNestedNs). This is for VNFs that are
to be created by the NFVO as part of the NS instantiation
and not for existing VNF that are referenced for reuse.
moscatelli
committed
items:
$ref: "#/definitions/ParamsForVnf"
startTime:
description: >
Timestamp indicating the earliest time to instantiate the NS.
Cardinality "0" indicates the NS instantiation takes place immediately.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
nsInstantiationLevelId:
description: >
Identifies one of the NS instantiation levels declared in
the DF applicable to this NS instance. If not present, the
default NS instantiation level as declared in the NSD
shall be used.
$ref: "#/definitions/IdentifierInNsd"
wanConnectionData:
description: >
Information for connecting VNs to the WAN when VLs are deployed across a WAN.
type: array
items:
$ref: "#/definitions/WanConnectionData"
additionalAffinityOrAntiAffinityRule:
moscatelli
committed
Specifies additional affinity or anti-affinity constraint for
the VNF instances to be instantiated as part of the NS
instantiation.
Shall not conflict with rules already specified in the NSD.
moscatelli
committed
items:
$ref: "#/definitions/AffinityOrAntiAffinityRule"
ParamsForNestedNs:
description: >
This type specifies additional parameters on a per-nested NS instance basis.
It shall comply with the provisions defined in Table 6.5.3.21a-1.
type: object
required:
- nsProfileId
properties:
nsProfileId:
description: >
Identifier of a NsProfile to which the additional parameters apply.
$ref: "#/definitions/IdentifierInNsd"
additionalParam:
description: >
Additional parameters that are to be applied on a per nested NS instance.
type: array
items:
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
moscatelli
committed
description: >
This type defines the additional parameters for the VNF instance
to be created associated with an NS instance.
It shall comply with the provisions defined in Table 6.5.3.22-1.
type: object
required:
- vnfProfileId
properties:
vnfProfileId:
description: >
Identifier of (reference to) a vnfProfile to which the
additional parameters apply.
$ref: "#/definitions/IdentifierInNsd"
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
vnfConfigurableProperties:
description: >
If present, this attribute provides values for the configurable properties declared in the VNFD.
These values will override the default values if default values are also declared in the VNFD.
It provides values for the "vnfConfigurableProperties" input
parameter of the Instantiate VNF operation defined in
ETSI GS NFV-SOL 003 [4].
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
metadata:
description: >
If present, this attribute provides values for metadata.
Metadata can but need not be declared in the VNFD.
These values will override the default values if default
values are also declared in the VNFD.
It provides the values for the "metadata" input parameter of the Create
VNF Identifier operation defined in ETSI
GS NFV-SOL 003 [4].
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
extensions:
description: >
If present, this attribute provides values for the extensions
declared in the VNFD. These values will override the default
values if default values are also declared in the VNFD.
It provides the values for the "extensions" input parameter of the Instantiate
VNF operation defined in ETSI GS NFV-SOL 003 [4].
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
moscatelli
committed
additionalParams:
description: >
Additional input parameters for the instantiation process,
specific to the VNF being instantiated, as declared in the
VNFD as part of "InstantiateVnfOpConfig".
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
moscatelli
committed
moscatelli
committed
description: >
This type represents location constraints for a VNF to be instantiated.
The location constraints can be represented as follows:
• as a country code
• as a civic address combined with a country code
• as an area, conditionally combined with a country code
NOTE: If both "countryCode" and "area" are present, no conflicts should
exist between the values of these two attributes. In case of conflicts,
the API producer (i.e. the NFVO) shall disregard parts of the geographic
area signalled by "area" that are outside the boundaries of the country
signalled by "countryCode". If "countryCode" is absent, it is solely the "area"
attribute that defines the location constraint.
moscatelli
committed
type: object
properties:
countryCode:
description: >
The two-letter ISO 3166 country code in capital letters. Shall be present
in case the "area" attribute is absent. May be absent if the "area"
attribute is present (see note).
moscatelli
committed
type: string
civicAddressElement:
description: >
Zero or more elements comprising the civic address.
Shall be absent if the "area" attribute is present.
moscatelli
committed
type: array
items:
type: object
required:
- caType
- caValue
properties:
caType:
description: >
Describe the content type of caValue. The value of
caType shall comply with Section 3.4 of IETF
RFC 4776 [13].
type: integer
caValue:
description: >
Content of civic address element corresponding to the
caType. The format caValue shall comply with
Section 3.4 of IETF RFC 4776 [13].
type: string
area:
description: >
Geographic area. Shall be absent if the "civicAddressElement" attribute is present.
The content of this attribute shall follow the provisions for the "Polygon" geometry object as defined in
IETF RFC 7946, for which the "type" member shall be set to the value "Polygon".
moscatelli
committed
moscatelli
committed
description: >
This type represents the association of location constraints to a VNF instance
to be created according to a specific VNF profile.
It shall comply with the provisions defined in Table 6.5.3.20-1.
NOTE: these constraints are typically determined by the OSS/BSS from
service requirements (e.g. latency requirements, regulatory requirements).
The NFVO can map such location constraints to eligible NFVI-PoPs/resource
zones where the VNF instance is to be created.
moscatelli
committed
type: object
required:
- vnfProfileId
properties:
vnfProfileId:
description: >
Identifier of (reference to) a vnfProfile to which the
additional parameters apply.
$ref: "#/definitions/IdentifierInNsd"
moscatelli
committed
locationConstraints:
description: >
Defines the location constraints for the VNF instance to
be created based on the VNF profile.
moscatelli
committed
$ref: "#/definitions/LocationConstraints"
moscatelli
committed
description: >
This type specifies an existing VNF instance to be used in the NS instance and
if needed, the VNF Profile to use for this VNF instance.
It shall comply with the provisions defined in Table 6.5.3.19-1.
type: object
required:
- vnfInstanceId
- vnfProfileId
properties:
vnfInstanceId:
description: >
Identifier of the existing VNF instance to be used in the NS.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
moscatelli
committed
vnfProfileId:
description: >
Identifier of (Reference to) a vnfProfile defined in the
NSD which the existing VNF instance shall be matched
with. If not present, the NFVO will select the VnfProfile
matching the information in the VNF instance.
$ref: "#/definitions/IdentifierInNsd"
moscatelli
committed
NestedNsInstanceData:
description: >
This type specifies an existing nested NS instance to be used in the NS instance
and if needed, the NsProfile to use for this nested NS instance.
It shall comply with the provisions defined in Table 6.5.3.19a-1.
type: object
required:
- nestedNsInstanceId
properties:
description: >
Identifier of the existing nested NS instance to be used in the NS.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
nsProfileId:
description: >
Identifier of an NsProfile defined in the NSD which the existing
nested NS instance shall be matched with.
If not present, the NFVO will select the NsProfile matching the
information in the nested NS instance.
$ref: "#/definitions/IdentifierInNs"
moscatelli
committed
description: >
This type represents the information related to a SAP of a NS.
It shall comply with the provisions defined in Table 6.5.3.10-1.
type: object
required:
- sapdId
- sapName
- description
properties:
sapdId:
description: >
Reference to the SAPD for this SAP.
$ref: "#/definitions/IdentifierInNsd"
moscatelli
committed
sapName:
description: >
Human readable name for the SAP.
type: string
description:
description: >
Human readable description for the SAP.
type: string
sapProtocolData:
description: >
Parameters for configuring the network protocols on the SAP.
type: array
moscatelli
committed
items:
$ref: "#/definitions/CpProtocolData"
rameshnaraya
committed
description: >
moscatelli
committed
This type represents a request for the scale NS operation.
Either the parameter scaleNsData or the parameter scaleVnfData, but not both shall be provided
NOTE: Either the parameter scaleNsData or the parameter scaleVnfData, but not both shall be provided.
type: object
required:
moscatelli
committed
- scaleType
oneOf:
- required:
- scaleNsData
- required:
- scaleVnfData
moscatelli
committed
scaleType:
moscatelli
committed
Indicates the type of scaling to be performed.
Possible values:
- SCALE_NS
- SCALE_VNF
type: string
enum:
- SCALE_NS
- SCALE_VNF
scaleNsData:
description: >
The necessary information to scale the referenced NS instance.
It shall be present when scaleType = SCALE_NS.
moscatelli
committed
$ref: "#/definitions/ScaleNsData"
scaleVnfData:
description: >
The necessary information to scale the referenced NS instance.
It shall be present when scaleType = SCALE_VNF.
moscatelli
committed
type: array
items:
$ref: "#/definitions/ScaleVnfData"
scaleTime:
description: >
Timestamp indicating the scale time of the NS, i.e. the
NS will be scaled at this timestamp. Cardinality "0"
indicates the NS scaling takes place immediately".
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
moscatelli
committed
UpdateNsRequest:
description: >
This operation supports the update of a NS instance operation.
NOTE 1: The DF of the VNF instance shall match the VNF DF present in the associated VNF Profile.
NOTE 2: The NS DF of each nested NS shall be one of the allowed flavours in the associated NSD
(as referenced in the nestedNsd attribute of the NSD of the NS to be instantiated).
NOTE 3: The NSD of each referenced NSs (i.e. each nestedInstanceId) shall match the one of
the nested NSD in the composite NSD.
NOTE 4: When the NS is deployed over several sites, the VLs of this NS will include VNs
in each site connected over the WAN. In this case, the "wanConnectionData" provides the needed
information required to connect each VN to the WAN. Annex E provides additional information and
guidelines about the usage of the "wanConnectionData" attribute.
moscatelli
committed
type: object
required:
- updateType
properties:
updateType:
description: >
The type of update. It determines also which one of the following parameters is present in the operation.
moscatelli
committed
Possible values include:
* ADD_VNF: Adding existing VNF instance(s)
* REMOVE_VNF: Removing VNF instance(s)
* INSTANTIATE_VNF: Instantiating new VNF(s)
* CHANGE_VNF_DF: Changing VNF DF
* OPERATE_VNF: Changing VNF state,
* MODIFY_VNF_INFORMATION: Modifying VNF information and/or the configurable properties of VNF instance(s)
* CHANGE_EXTERNAL_VNF_CONNECTIVITY: Changing the external connectivity of VNF instance(s)
* CHANGE_VNFPKG: Changing the VNF package(s) on which (a) VNF instance(s) is/are based
* REMOVE_SAP: Removing SAP(s)
* ADD_NESTED_NS: Adding existing NS instance(s) as nested NS(s)
* REMOVE_NESTED_NS: Removing existing nested NS instance(s)
* ASSOC_NEW_NSD_VERSION: Associating a new NSD version to the NS instance
* MOVE_VNF: Moving VNF instance(s) from one origin NS instance to another target NS instance
* ADD_VNFFG: Adding VNFFG(s)
* REMOVE_VNFFG: Removing VNFFG(s)
* UPDATE_VNFFG: Updating VNFFG(s)
* CHANGE_NS_DF: Changing NS DF
* ADD_PNF: Adding PNF
* MODIFY_PNF: Modifying PNF
* REMOVE_PNF: Removing PNF
* CREATE_VNF_SNAPSHOT: Creating VNF Snapshots of VNF instances belonging to the NS instance. See note 2
* REVERT_VNF_TO_SNAPSHOT: Reverting a VNF instance belonging to the NS instance to a VNF Snapshot. See note 2 and note 3
* DELETE_VNF_SNAPSHOT_INFO: Deleting available VNF Snapshot information for a VNF instance belonging to the NS instance. See note 2
* MODIFY_WAN_CONNECTION_INFO: Modify WAN related connectivity information.
* CREATE_NS_VIRTUAL_LINK: Create an NsVirtualLink instance.
* DELETE_NS_VIRTUAL_LINK: Delete an NsVirtualLink instance.
moscatelli
committed
enum:
- ADD_VNF
- REMOVE_VNF
- INSTANTIATE_VNF
- CHANGE_VNF_DF
- OPERATE_VNF
- MODIFY_VNF_INFORMATION
- CHANGE_EXTERNAL_VNF_CONNECTIVITY
- REMOVE_SAP
- ADD_NESTED_NS
- REMOVE_NESTED_NS
- ASSOC_NEW_NSD_VERSION
- MOVE_VNF
- ADD_VNFFG
moscatelli
committed
- REMOVE_VNFFG
- UPDATE_VNFFG
- CHANGE_NS_DF
- ADD_PNF
- MODIFY_PNF
- REMOVE_PNF
- CREATE_VNF_SNAPSHOT
- REVERT_VNF_TO_SNAPSHOT
- DELETE_VNF_SNAPSHOT_INFO
- MODIFY_WAN_CONNECTION_INFO
- CREATE_NS_VIRTUAL_LINK
- DELETE_NS_VIRTUAL_LINK
addVnfIstance:
description: >
Identifies an existing VNF instance to be added to the
NS instance. It shall be present only if updateType = "ADD_VNF".
type: array
moscatelli
committed
items:
$ref: "#/definitions/VnfInstanceData"
removeVnfInstanceId:
description: >
Identifies an existing VNF instance to be removed from
the NS instance. It contains the identifier(s) of the VNF
instances to be removed. It shall be present only if
moscatelli
committed
items:
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
instantiateVnfData:
description: >
Identifies the new VNF to be instantiated. It can be used
e.g. for the bottom-up NS creation. It shall be present
only if updateType = "INSTANTIATE_VNF".
type: array
moscatelli
committed
items:
$ref: "#/definitions/InstantiateVnfData"
terminateVnfData:
description: >
Specifies the details to terminate VNF instance(s).
It shall be present only if updateType = "REMOVE_VNF"
and if the VNF instance(s) is(are) to be terminated as
part of this operation.
type: array
items:
$ref: "#/definitions/TerminateVnfData"
changeVnfFlavourData:
description: >
Identifies the new DF of the VNF instance to be
changed to. It shall be present only if updateType = "CHANGE_VNF_DF".
type: array
moscatelli
committed
items:
$ref: "#/definitions/ChangeVnfFlavourData"
operateVnfData:
description: >
Identifies the state of the VNF instance to be changed.
It shall be present only if updateType = "OPERATE_VNF".
type: array
moscatelli
committed
items:
$ref: "#/definitions/OperateVnfData"
modifyVnfInfoData:
description: >
Identifies the VNF information parameters and/or the
configurable properties of VNF instance to be modified.
It shall be present only if updateType = "MODIFY_VNF_INFORMATION".
type: array
moscatelli
committed
items:
$ref: "#/definitions/ModifyVnfInfoData"
changeExtVnfConnectivityData:
description: >
Specifies the new external connectivity data of the VNF
instance to be changed. It shall be present only if
updateType = "CHANGE_EXTERNAL_VNF_CONNECTIVITY".
type: array
moscatelli
committed
items:
$ref: "#/definitions/ChangeExtVnfConnectivityData"
changeVnfPackageData:
description: >
Specifies the details to change the VNF package on which the VNF instance is based.
It shall be present only if updateType = "CHANGE_VNFPKG".
type: array
items:
$ref: "#/definitions/ChangeVnfPackageData"
addSap:
description: >
Identifies a new SAP to be added to the NS instance.
It shall be present only if updateType = "ADD_SAP."
type: array
moscatelli
committed
items:
$ref: "#/definitions/SapData"
removeSapId:
description: >
The identifier an existing SAP to be removed from the
NS instance. It shall be present only if updateType = "REMOVE_SAP."
type: array
moscatelli
committed
items:
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
Samir Medjiah
committed
addNestedNsData:
description: >
The identifier of an existing nested NS instance to be
added to (nested within) the NS instance. It shall be
present only if updateType = "ADD_NESTED_NS".
type: array
moscatelli
committed
items:
Samir Medjiah
committed
$ref: "#/definitions/NestedNsInstanceData"
moscatelli
committed
description: >
The identifier of an existing nested NS instance to be
removed from the NS instance. It shall be present only if
updateType = "REMOVE_NESTED_NS".
type: array
items:
$ref: "#/definitions/IdentifierInNs"
assocNewNsdVersionData:
description: >
Specify the new NSD to be used for the NS instance. It
shall be present only if updateType =
ASSOC_NEW_NSD_VERSION".
$ref: "#/definitions/AssocNewNsdVersionData"
moveVnfInstanceData:
description: >
Specify existing VNF instance to be moved from one NS
instance to another NS instance. It shall be present only
if updateType = MOVE_VNF".
type: array
moscatelli
committed
items:
$ref: "#/definitions/MoveVnfInstanceData"
addVnffg:
description: >
Specify the new VNFFG to be created to the NS
Instance. It shall be present only if updateType =
"ADD_VNFFG".
type: array
moscatelli
committed
items:
$ref: "#/definitions/AddVnffgData"
removeVnffgId:
description: >
Identifier of an existing VNFFG to be removed from the
NS Instance. It shall be present only if updateType =
"REMOVE_VNFFG".
type: array
moscatelli
committed
items:
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
updateVnffg:
description: >
Specify the new VNFFG Information data to be updated
for a VNFFG of the NS Instance. It shall be present only
if updateType = "UPDATE_VNFFG".
type: array
moscatelli
committed
items:
$ref: "#/definitions/UpdateVnffgData"
changeNsFlavourData:
description: >
Specifies the new DF to be applied to the NS instance. It
shall be present only if updateType =
"CHANGE_NS_DF".
moscatelli
committed
$ref: "#/definitions/ChangeNsFlavourData"
addPnfData:
description: >
specifies the PNF to be added into the NS instance.
It shall be present only if updateType = "ADD_PNF".
type: array
moscatelli
committed
items:
$ref: "#/definitions/AddPnfData"
modifyPnfData:
description: >
Specifies the PNF to be modified in the NS instance.
It shall be present only if updateType = "MODIFY_PNF".
type: array
moscatelli
committed
items:
$ref: "#/definitions/ModifyPnfData"
removePnfId:
description: >
Identifier of the PNF to be deleted from the NS instance.
It shall be present only if updateType = "REMOVE_PNF".
type: array
moscatelli
committed
items:
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
modifyWanConnectionInfoData:
description: >
Specifies the data to modify about WAN related connectivity information.
It shall be present only if updateType = "MODIFY_WAN_CONNECTION_INFO".
type: array
items:
$ref: "#/definitions/ModifyWanConnectionInfoData"
updateTime:
description: >
Timestamp indicating the update time of the NS, i.e. the
NS will be updated at this timestamp. Cardinality "0"
indicates the NS update takes place immediately.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
createSnapshotData:
description: >
Specify the VNF instance to be snapshotted. It shall be present only if updateType = "CREATE_VNF_SNAPSHOT".
$ref: '#/definitions/CreateVnfSnapshotData'
revertVnfToSnapshotData:
description: >
Specify the VNF instance to be reverted and the VNF Snapshot to be reverted to. It shall be present only if
updateType = "REVERT_VNF_TO_SNAPSHOT".
$ref: '#/definitions/CreateVnfSnapshotData'
$ref: '#/definitions/RevertVnfToSnapshotData'
deleteVnfSnapshotData:
description: >
Specify the VNF Snapshot info to be deleted and the related VNF instance. It shall be present only if
updateType = "DELETE_VNF_SNAPSHOT_INFO".
$ref: '#/definitions/DeleteVnfSnapshotData'
addNsVirtualLinkData:
description: >
Specify data to be used to create a new NsVirtualLink instance. This parameter shall be present only if
updateType = “CREATE_NS_VIRTUAL_LINK”.
type: array
items:
$ref: '#/definitions/AddNsVirtualLinkData'
deleteNsVirtualLinkId:
description: >
Identify an existing NsVirtualLink instance to be deleted. The parameter shall be present only if
updateType = “DELETE_NS_VIRTUAL_LINK”.
type: array
items:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
Samir Medjiah
committed
InstantiateVnfData:
description: >
This type represents the information related to a SAP of a NS. The InstantiateVnfData data type specifies the
parameters that are needed for VNF instantiation. This information element is used for the bottom-up NS creation when
the OSS/BSS explicitly requests VNF instantiation for a given NS. When the NFVO invokes the Instantiate VNF
update operation, a set of these parameters are then passed by the NFVO to the VNFM.
NOTE 1: 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 6.5.3.27).
NOTE 2: If vnfdId and vnfFlavourId (and vnfInstantiationLevelId, if provided) are present,
there should be only one vnfProfile that matches the vnfdId and vnfFlavourId (and vnfInstantiationLevelId,
if present) in the NS deployment flavour specified in the NSD associated to the NS instance to which
the present operation is triggered. In the case there is more than one matching vnfProfile, the NFVO
may select a matching vnfProfile based on other information, such as external VL.
NOTE 3: Either the attribute triple "vnfdId, vnfFlavourId and vnfInstantiationLevelId
(if provided)" or the attribute "vnProfileId" shall be present, but not both.
type: object
properties:
vnfdId:
description: >
Information sufficient to identify the VNFD which defines
the VNF to be instantiated.
piscione
committed
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
vnfFlavourId:
description: >
Identifier of the VNF deployment flavor to be instantiated.
piscione
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
vnfInstantiationLevelId:
description: >
Identifier of the instantiation level of the deployment
flavor to be instantiated. If not present, the default
instantiation level as declared in the VNFD is
instantiated.
piscione
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
piscione
committed
vnfProfileId:
description: >
Identifier of (Reference to) a vnfProfile defined in the NSD which is used for instantiating the VNF.
piscione
committed
$ref: "#/definitions/IdentifierInNsd"
vnfInstanceName:
description: >
Human-readable name of the VNF instance to be created.
type: string
vnfInstanceDescription:
description: >
Human-readable description of the VNF instance to be created.
type: string
extVirtualLinks:
description: >
Information about external VLs to connect the VNF to.
moscatelli
committed
items:
$ref: "#/definitions/ExtVirtualLinkData"
extManagedVirtualLinks:
description: >
Information about internal VLs that are managed by other entities than the VNFM.
moscatelli
committed
items:
$ref: "#/definitions/ExtManagedVirtualLinkData"
localizationLanguage:
description: >
moscatelli
committed
Localization language of the VNF to be instantiated.
The value shall comply with the format defined in IETF RFC 5646.
moscatelli
committed
type: string
vnfConfigurableProperties:
description: >
piscione
committed
If present, this attribute provides values for the configurable
properties declared in the VNFD. These values will override
the default values if default values are also declared in the VNFD.
It provides values for the "vnfConfigurableProperties" input
parameter of the Instantiate VNF operation
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
moscatelli
committed
additionalParams:
description: >
Additional input parameters for the instantiation process,
specific to the VNF being instantiated.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
metadata:
description: >
piscione
committed
If present, this attribute provides values for metadata. Metadata
can but need not be declared in the VNFD. These values will override
the default values if default values are also declared in the VNFD.
This attribute provides values for the "metadata" input parameter of
the Create VNF Identifier operation.
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
extensions:
description: >
piscione
committed
If present, this attribute provides values for extensions declared
in the VNFD. These values will override the default values if default
values are also declared in the VNFD.
This attribute provides values for the "extensions" input parameter of
the Instantiate VNF operation.
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
locationConstraints:
description: >
Defines the location constraints for the VNF to be
instantiated as part of the NS Update.
An example can be a constraint for the VNF to be
in a specific geographic location.
$ref: "#/definitions/VnfLocationConstraint"
moscatelli
committed
ChangeVnfFlavourData:
description: >
The type represents the information that is requested to be changed
deployment flavor for an existing VNF instance.
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 6.5.3.27).
moscatelli
committed
type: object
required:
- vnfInstanceId
- newFlavourId
properties:
vnfInstanceId:
description: >
Identifier of the VNF instance to be modified.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
moscatelli
committed
newFlavourId:
description: >
Identifier of the VNF deployment flavor to be instantiated.
$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
moscatelli
committed
instantiationLevelId:
description: >
Identifier of the instantiation level of the deployment
flavor to be instantiated. If not present, the default
instantiation level as declared in the VNFD is
instantiated.
$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
moscatelli
committed
extVirtualLinks:
description: >
Information about external VLs to connect the VNF to.
type: array
items:
$ref: "#/definitions/ExtVirtualLinkData"
moscatelli
committed
extManagedVirtualLinks:
description: >
information about internal VLs that are managed by NFVO.
moscatelli
committed
type: array
items:
$ref: "#/definitions/ExtManagedVirtualLinkData"
moscatelli
committed
additionalParams:
description: >
Additional input parameters for the flavor change
process, specific to the VNF being modified, as declared
in the VNFD as part of "ChangeVnfFlavourOpConfig".
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
extensions:
description: >
This attribute provides values for the "extensions" input parameter of the Change VNF Flavour
operation defined in ETSI GS NFV-SOL 003.
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
vnfConfigurableProperties:
description: >
This attribute provides values for the "vnfConfigurableProperties" input parameter of the Change VNF Flavour
operation defined in ETSI GS NFV-SOL 003.
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
moscatelli
committed
OperateVnfData:
description: >
This type represents a VNF instance for which the operational state
needs to be changed and the requested new state.
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" attribute is equal to "STOPPED"
and the "stopType" attribute is equal to "GRACEFUL". The "gracefulStopTimeout"
attribute shall be absent, when the "changeStateTo" attribute is equal to
"STOPPED" and the "stopType" attribute is equal to "FORCEFUL". The request
shall be treated as if the "stopType" attribute was set to "FORCEFUL", when
the "changeStateTo" attribute is equal to "STOPPED" and the "stopType" attribute
is absent.
moscatelli
committed
type: object
required:
- vnfInstanceId
- changeStateTo
properties:
vnfInstanceId:
description: >
Identifier of the VNF instance.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
moscatelli
committed
changeStateTo:
description: >
The desired operational state (i.e. started or stopped)
to change the VNF to.
$ref: "#/definitions/OperationalStates"
stopType:
description: >
It signals whether forceful or graceful stop is requested.
See note.
moscatelli
committed
$ref: "#/definitions/StopType"
gracefulStopTimeout:
description: >
The time interval (in seconds) to wait for the VNF to be
taken out of service during graceful stop, before
moscatelli
committed
type: integer
additionalParam:
description: >
Additional parameters passed by the OSS/BSS as input
to the Operate VNF operation, specific to the VNF being
operated.
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
moscatelli
committed
OperationalStates:
description: >
STARTED - The VNF instance is up and running.
STOPPED - The VNF instance has been shut down.
type: string
enum:
- STARTED
- STOPPED
Samir Medjiah
committed
moscatelli
committed
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
StopType:
description: >
* FORCEFUL: The VNFM will stop the VNF immediately after accepting the
request.
* GRACEFUL: The VNFM will first arrange to take the VNF out of service
after accepting the request. Once that operation is successful or once
the timer value specified in the "gracefulStopTimeout" attribute
expires, the VNFM will stop the VNF.
type: string
enum:
- FORCEFUL
- GRACEFUL
ModifyVnfInfoData:
description: >
This type represents the information that is requested to be modified for a VNF instance. The information to be
modified shall comply with the associated NSD.
EXAMPLE. The vnfPkgId attribute value for a particular VNF instance can only be updated with a value that
matches the identifier value of a VNF package whose vnfdId is present in the associated profile of the NSD.
type: object
required:
- vnfInstanceId
properties:
vnfInstanceId:
description: >
Identifier of the VNF instance.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
moscatelli
committed
vnfInstanceName:
description: >
New value of the "vnfInstanceName" attribute in
"VnfInstance", or "null" to remove the attribute.
type: string
vnfInstanceDescription:
description: >
New value of the "vnfInstanceDescription" attribute in "VnfInstance",
or "null" to remove the attribute.
type: string
moscatelli
committed
description: >
New value of the "vnfdId" attribute in "VnfInstance".
moscatelli
committed
The value "null" is not permitted
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
moscatelli
committed
vnfConfigurableProperties:
description: >
Modifications to entries in the
"vnfConfigurableProperties" attribute in "VnfInstance", as defined below in clause 6.5.3.57.
In addition, the provisions in clause 6.7 shall apply.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
metadata:
moscatelli
committed
description: >
Modifications to entries in the "metadata" attribute in "VnfInstance", as defined below in clause 6.5.3.57.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
extensions:
moscatelli
committed
description: >
Modifications to entries in the "extensions" attribute in "VnfInstance", as defined below in clause 6.5.3.57.
In addition, the provisions in clause 6.7 shall apply.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
moscatelli
committed
ChangeExtVnfConnectivityData:
description: >
This type describes the information invoked by the NFVO to change the external VNF connectivity information
maintained by the VNFM. The types of changes that this operation supports are:
1) Disconnect the external CPs that are connected to a particular external VL, and connect them to a different
external VL.
2) Disconnect and delete external CPs that are connected to a particular external VL and that represent subports
in a trunk, i.e. CP instances that are created from external CPDs that have trunk mode configured according to
clause 7.1.6.3 in ETSI GS NFV-IFA 011. If the parent port is exposed as an "extCp", the VNFM shall ensure that
the parent port is not deleted. If the parent port is exposed as an "extCp" and there are other subports connected,
the VNFM shall ensure that the parent port is not disconnected, unless it is reconnected to a different external
VL in the same operation.
3) Change the connectivity parameters of the existing external CPs, including changing addresses.
NOTE: Depending on the capabilities of the underlying VIM resources, certain changes (e.g. modifying the IP address
assignment) might not be supported without deleting the resource and creating another one with the modified
configuration.
4) Create new CPs that represent supports in a trunk, i.e. CP instances that are created from external CPDs that
have trunk mode configured according to clause 7.1.6.3 in ETSI GS NFV-IFA 011, and connect them to a particular
external VL. Creation of the parent port with this operation is not supported. This type shall comply with the
provisions defined in Table 6.5.3.33-1.
moscatelli
committed
type: object
required:
- vnfInstanceId
moscatelli
committed
properties:
vnfInstanceId:
description: >
Identifier of the VNF instance.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
moscatelli
committed
description: >
Information about external VLs to change (e.g. connect the VNF to).
type: array
items:
$ref: "#/definitions/ExtVirtualLinkData"
moscatelli
committed
additionalParams:
description: >
piscione
committed
Additional parameters passed by the OSS/BSS as input to
moscatelli
committed
the external connectivity change process, specific to the
VNF instance being changed.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
moscatelli
committed
AssocNewNsdVersionData:
description: >
This type specifies a new NSD version that is associated to the NS instance. After issuing the Update NS operation with
updateType = "AssocNewNsdVersion", the NFVO shall use the referred NSD as a basis for the given NS instance.
Different versions of the same NSD have same nsdInvariantId, but different nsdId attributes, therefore if the
nsdInvariantId of the NSD version that is to be associated to this NS instance is different from the one used before, the
NFVO shall reject the request. Only new versions of the same NSD can be associated to an existing NS instance. This
data type shall comply with the provisions defined in Table 6.5.3.34-1.
type: object
required:
- newNsdId
properties:
newNsdId:
description: >
Identifier of the new NSD version that is to be
associated to the NS instance.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
moscatelli
committed
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
sync:
description: >
Specify whether the NS instance shall be automatically
synchronized to the new NSD by the NFVO (in case of
true value) or the NFVO shall not do any action (in case
of a false value) and wait for further guidance from
OSS/BSS (i.e. waiting for OSS/BSS to issue NS
lifecycle management operation to explicitly add/remove
VNFs and modify information of VNF instances
according to the new NSD).
The synchronization to the new NSD means e.g.
instantiating/adding those VNFs whose VNFD is
referenced by the new NSD version but not referenced
by the old one, terminating/removing those VNFs whose
VNFD is referenced by the old NSD version but not
referenced by the new NSD version, modifying
information of VNF instances to the new applicable
VNFD provided in the new NSD version.
A cardinality of 0 indicates that synchronization shall not be done.
type: boolean
MoveVnfInstanceData:
description: >
This type specifies existing VNF instances to be moved from one NS instance (source) to another NS instance
(destination). The NS instance defined in the Update NS operation indicates the source NS instance and the destination
NS instance is specified in this data type (referred to targetNsInstanceId).
It shall comply with the provisions defined in Table 6.5.3.35-1.
type: object
required:
- targetNsInstanceId
properties:
targetNsInstanceId:
description: >
Specify the target NS instance where the VNF instances
are moved to.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
moscatelli
committed
vnfInstanceId:
description: >
Specify the VNF instance that is moved.
type: array
items:
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
moscatelli
committed
AddVnffgData:
description: >
This type specifies the parameters used for the creation of a new VNFFG instance.
It shall comply with the provisions defined in Table 6.5.3.36-1.
type: object
required:
- vnffgdId
- vnffgName
- description
properties:
targetNsInstanceId:
description: >
Identifier of the VNFFGD used to create this VNFFG
instance.
$ref: "#/definitions/IdentifierInNsd"
moscatelli
committed
vnffgName:
description: >
Human readable name for the VNFFG.
type: string
description:
description: >
Human readable description for the VNFFG.
type: string
UpdateVnffgData:
description: >
This type specifies the parameters used for the update of an existing VNFFG instance.
It shall comply with the provisions defined in Table 6.5.3.37-1.
type: object
required:
- vnffgInfoId
properties:
vnffgInfoId:
description: >
Identifier of an existing VNFFG to be updated for the NS Instance.
$ref: "#/definitions/IdentifierInNs"
moscatelli
committed
nfp:
description: >
Indicate the desired new NFP(s) for a given VNFFG
after the operations of addition/removal of NS
components (e.g. VNFs, VLs, etc.) have been
completed, or indicate the updated or newly created
NFP classification and selection rule which applied to an existing NFP.
type: array
items:
$ref: "#/definitions/NfpData"
nfpInfoId:
description: >
Identifier(s) of the NFP to be deleted from a given VNFFG.
type: array
items:
$ref: "#/definitions/IdentifierInNs"
moscatelli
committed
NfpData:
description: >
This type contains information used to create or modify NFP instance parameters
for the update of an existing VNFFG instance.
It shall comply with the provisions defined in Table 6.5.3.38-1.
NOTE 1: It shall be present for modified NFPs and shall be absent for the new NFP.
NOTE 2: It shall be present for the new NFP, and it may be present otherwise.
NOTE 3: At least a CP or an nfpRule shall be present.
NOTE 4: When multiple identifiers are included, the position of the identifier
in the cpGroup value specifies the position of the group in the path.
moscatelli
committed
type: object
properties:
nfpInfoId:
description: >
Identifier of the NFP to be modified. It shall be present
for modified NFPs and shall be absent for the new NFP.
$ref: "#/definitions/IdentifierInNs"
moscatelli
committed
nfpName:
description: >
Human readable name for the NFP. It shall be present
for the new NFP, and it may be present otherwise.
moscatelli
committed
type: string
description:
description: >
Human readable description for the NFP. It shall be
present for the new NFP, and it may be present otherwise.
moscatelli
committed
type: string
moscatelli
committed
description: >
Group(s) of CPs and/or SAPs which the NFP passes by.
moscatelli
committed
Cardinality can be 0 if only updated or newly created
NFP classification and selection rule which applied to an
existing NFP is provided.
moscatelli
committed
type: array
items:
$ref: "#/definitions/CpGroupInfo"
moscatelli
committed
nfpRule:
description: >
NFP classification and selection rule. See note 1.
$ref: "#/definitions/NfpRule"
NfpRule:
description: >
The NfpRule data type is an expression of the conditions that shall be met
in order for the NFP to be applicable to the packet. The condition acts as a flow classifier and
it is met only if all the values expressed in the condition are matched
by those in the packet. It shall comply with the provisions defined in Table 6.5.3.40-1.
NOTE: At least one attribute shall be present. If multiple attributes are present, a logical "AND"
operation shall be applied to those attributes when matching packets against the rule.
moscatelli
committed
type: object
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
anyOf:
- required:
- etherDestinationAddress
- required:
- etherSourceAddress
- required:
- etherType
- required:
- vlanTag
- required:
- protocol
- required:
- dscp
- required:
- sourcePortRange
- required:
- destinationPortRange
- required:
- sourceIpAddressPrefix
- required:
- destinationIpAddressPrefix
- required:
- extendedCriteria
moscatelli
committed
properties:
etherDestinationAddress:
description: >
Indicates a destination Mac address. See note.
$ref: "#/definitions/MacAddress"
moscatelli
committed
etherSourceAddress:
description: >
Indicates a source Mac address. See note.
$ref: "#/definitions/MacAddress"
moscatelli
committed
etherType:
description: >
Indicates the protocol carried over the Ethernet layer.
Permitted values:
- IPV4
- IPV6
See note.
moscatelli
committed
type: string
enum:
- IPV4
- IPV6
vlanTag:
description: >
Indicates a VLAN identifier in an IEEE 802.1Q-2018
tag Multiple tags can be included for QinQ stacking. See note.
moscatelli
committed
type: array
items:
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/String"
moscatelli
committed
protocol:
description: >
moscatelli
committed
corresponds to the field called "Protocol" to identify
moscatelli
committed
corresponds to the field is called the "Next Header" field.
Permitted values: Any keyword defined in the IANA
moscatelli
committed
TCP
UDP
ICMP
See note.
moscatelli
committed
type: string
enum:
- TCP
- UDP
- ICMP
dscp:
description: >
moscatelli
committed
corresponds to the 6-bit Differentiated Services
Code Point (DSCP) field of the IP header.
moscatelli
committed
corresponds to the 6 differentiated services bits of
the traffic class header field.
See note.
moscatelli
committed
type: string
sourcePortRange:
description: >
Indicates a range of source ports.
See note.
$ref: "#/definitions/PortRange"
moscatelli
committed
destinationPortRange:
description: >
Indicates a range of destination ports.
$ref: "#/definitions/PortRange"
moscatelli
committed
sourceIpAddressPrefix:
description: >
Indicates the source IP address range in CIDR format.
$ref: "#/definitions/IpAddressPrefix"
moscatelli
committed
destinationIpAddressPrefix:
description: >
Indicates the destination IP address range in CIDR format.
$ref: "#/definitions/IpAddressPrefix"
moscatelli
committed
extendedCriteria:
description: >
Indicates values of specific bits in a frame.
moscatelli
committed
type: array
items:
$ref: "#/definitions/Mask"
moscatelli
committed
ChangeNsFlavourData:
description: >
This type specifies an existing NS instance for which the DF needs to be changed.
This specifies the new DF, the instantiationLevel of the new DF that may be used and
the additional parameters as input for the flavour change.
It shall comply with the provisions defined in Table 6.5.3.39-1.
type: object
required:
- newNsFlavourId
properties:
newNsFlavourId:
description: >
Identifier of the new NS DF to apply to this NS instance.
$ref: "#/definitions/IdentifierInNsd"
moscatelli
committed
instantiationLevelId:
description: >
Identifier of the instantiation level of the deployment flavour to be instantiated.
If not present, the default instantiation level as declared in the NSD is instantiated.
$ref: "#/definitions/IdentifierInNsd"
moscatelli
committed
AddPnfData:
description: >
This type specifies an PNF to be added to the NS instance and the PNF Profile
to use for this PNF. It shall comply with the provisions defined in Table 6.5.3.14-1.
type: object
required:
- pnfId
- pnfName
- pnfdId
- pnfProfileId
properties:
pnfId:
description: >
Identifier of the PNF. This identifier is allocated by the OSS/BSS.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
moscatelli
committed
pnfName:
description: >
Name of the PNF
type: string
pnfdId:
description: >
Identifier of the PNFD on which the PNF is based.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
moscatelli
committed
pnfProfileId:
description: >
Identifier of related PnfProfile in the NSD on which the PNF is based.
$ref: "#/definitions/IdentifierInNsd"
moscatelli
committed
cpData:
description: >
Address assigned for the PNF external CP(s).
type: array
items:
$ref: "#/definitions/PnfExtCpData"
PnfExtCpData:
description: >
This type represents the configuration data on the external CP of the PNF.
It shall comply with the provisions defined in
Table 6.5.3.16-1.
type: object
required:
- cpProtocolData
properties:
moscatelli
committed
description: >
Identifier of the CP. Shall be present for existing CP.
$ref: "#/definitions/IdentifierInPnf"
moscatelli
committed
cpdId:
description: >
Identifier of the Connection Point Descriptor (CPD) for this CP. Shall be present for new CP.
$ref: "#/definitions/IdentifierInNsd"
moscatelli
committed
cpProtocolData:
description: >
Address assigned for this CP.
type: array
items:
Samir Medjiah
committed
$ref: "#/definitions/CpProtocolData"
moscatelli
committed
ModifyPnfData:
description: >
This type specifies an PNF to be modified in the NS instance.
It shall comply with the provisions defined in
Table 6.5.3.15-1.
moscatelli
committed
type: object
required:
- pnfId
anyOf:
- required:
- pnfName
- required:
- cpData
moscatelli
committed
properties:
pnfId:
description: >
Identifier of the PNF. This identifier is allocated by the OSS/BSS.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
moscatelli
committed
pnfName:
description: >
moscatelli
committed
type: string
cpData:
description: >
Address assigned for the PNF external CP(s). See note.
moscatelli
committed
type: array
items:
$ref: "#/definitions/PnfExtCpData"
AffectedVirtualLink:
description: >
This type provides information about added, deleted, modified and
temporary VLs.
NOTE: The resource handles of the affected NS link ports can be
found by dereferencing the identifiers in the "linkPortIds" attribute.
moscatelli
committed
type: object
required:
- nsVirtualLinkInstanceId
- nsVirtualLinkDescId
- vlProfileId
moscatelli
committed
- changeType
moscatelli
committed
properties:
moscatelli
committed
description: >
Identifier of the VL Instance.
$ref: "#/definitions/IdentifierInNs"
nsVirtualLinkDescId:
moscatelli
committed
description: >
Identifier of the VLD in the NSD for this VL.
$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd"
vlProfileId:
description: >
Name of the VL profile.
$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd"
moscatelli
committed
changeType:
description: >
Signals the type of change. Permitted values:
* ADD
* DELETE
* MODIFY
* ADD_LINK_PORT
* REMOVE_LINK_PORT
moscatelli
committed
enum:
- ADD
- DELETE
- MODIFY
- ADD_LINK_PORT
- REMOVE_LINK_PORT
linkPortIds:
description: >
Identifiers of the link ports of the affected VL related to the change. Each identifier references an
"NsLinkPortInfo" structure.
Shall be set when changeType is equal to "ADD_LINK_PORT" or "REMOVE_LINK_PORT", and the related
"NsLinkPortInfo" structures are present (case "add") or have been present (case "remove") in
the "NsVirtualLinkInfo" structure that is represented by the "virtualLink¬Info" attribute
in the "NsInstance" structure.
See note.
type: array
items:
$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNs"
Signals the result of change identified by the
"changeType" attribute.
Permitted values:
* COMPLETED
* ROLLED_BACK
* FAILED
type: string
enum:
- COMPLETED
- ROLLED_BACK
- FAILED
moscatelli
committed
AffectedVirtualStorage:
moscatelli
committed
This type provides information about added, deleted, modified and
temporary virtual storage resources.
type: object
required:
moscatelli
committed
- id
- virtualStorageDescId
- changeType
- storageResource
moscatelli
committed
id:
moscatelli
committed
Identifier of the storage instance, identifying the applicable
"virtualStorageResourceInfo" entry in the "VnfInstance" data type.
$ref: "#/definitions/IdentifierInVnf"
moscatelli
committed
virtualStorageDescId:
moscatelli
committed
Identifier of the related VirtualStorage descriptor in the VNFD.
$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
moscatelli
committed
changeType:
moscatelli
committed
Signals the type of change. Permitted values:
* ADDED
* REMOVED
* MODIFIED
* TEMPORARY
For a temporary resource, an AffectedVirtualStorage structure exists
as long as the temporary resource exists.
type: string
enum:
- ADDED
- REMOVED
- MODIFIED
- TEMPORARY
storageResource:
description: >
Reference to the VirtualStorage resource. Detailed information is
(for new and modified resources) or has been (for removed
resources) available from the VIM.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
moscatelli
committed
metadata:
moscatelli
committed
Metadata about this resource.
The content of this attribute shall be a copy of the content of the
"metadata" attribute of the VirtualStorageResourceInfo structure.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
AffectedVnf:
description: >
This type provides information about added, deleted and modified VNFs.
NOTE: At least one of the attributes "changedVnfInfo", "changedExtConnectivity"
or "modificationsTriggeredByVnfPkgChange" shall be present. Not more than one
of "changedVnfInfo" and "modificationsTriggeredByVnfPkgChange" shall be present.
type: object
required:
- vnfInstanceId
- vnfdId
moscatelli
committed
- vnfProfileId
- vnfName
- changeType
- changeResult
anyOf:
- required:
- changedExtConnectivity
- oneOf:
- required:
- changedVnfInfo
- required:
- modificationsTriggeredByVnfPkgChange
properties:
vnfInstanceId:
description: >
Identifier of the VNF instance.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
vnfdId:
description: >
Identifier of the VNFD of the VNF Instance.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
vnfProfileId:
description: >
Identifier of the VNF profile of the NSD.
$ref: "#/definitions/IdentifierInNsd"
vnfName:
description: >
Name of the VNF Instance.
type: string
changeType:
description: >
Signals the type of change
Permitted values:
- ADD
- REMOVE
- INSTANTIATE
- TERMINATE
- SCALE
- CHANGE_FLAVOUR
- HEAL
- OPERATE
- MODIFY_INFORMATION
- CHANGE_EXTERNAL_VNF_CONNECTIVITY
type: string
enum:
- ADD
moscatelli
committed
- REMOVE
- INSTANTIATE
- TERMINATE
- SCALE
- CHANGE_FLAVOUR
- HEAL
moscatelli
committed
- OPERATE
- MODIFY_INFORMATION
- CHANGE_EXTERNAL_VNF_CONNECTIVITY
changeResult:
description: >
Signals the result of change identified by the
"changeType" attribute.
Permitted values:
- COMPLETED
- ROLLED_BACK
- FAILED
type: string
enum:
- COMPLETED
moscatelli
committed
- ROLLED_BACK
- FAILED
changedInfo:
description: >
Information about the changed VNF instance
rameshnaraya
committed
information, including VNF configurable properties,if applicable.
When the "changedInfo" attribute is present,
either the "changedVnfInfo" attribute or the
"changedExtConnectivity" attribute or both shall be present.
anyOf:
- required:
- changedVnfInfo
- required:
- changedVnfInfo
- required:
- modificationsTriggeredByVnfPkgChange
oneOf:
- required:
- changedVnfInfo
- required:
- modificationsTriggeredByVnfPkgChange
rameshnaraya
committed
changedVnfInfo:
description: >
Information about the changed VNF instance
information, including configurable properties,
if applicable.
rameshnaraya
committed
$ref: "#/definitions/ModifyVnfInfoData"
changedExtConnectivity:
description: >
Information about changed external connectivity, if applicable.
Only information about external VL instances that have been
added or modified shall be provided. See note.
type: array
items:
$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 note.
$ref: "#/definitions/ModificationsTriggeredByVnfPkgChange"
AffectedPnf:
description: >
This type provides information about added, deleted and modified PNFs.
It shall comply with the provisions in Table 6.5.3.3-1.
type: object
required:
- pnfId
- pnfdId
- pnfProfileId
moscatelli
committed
- cpInstanceId
properties:
pnfId:
description: >
Identifier of the affected PNF. This identifier is
allocated by the OSS/BSS.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
pnfdId:
description: >
Identifier of the PNFD on which the PNF is based.
$ref: "#/definitions/IdentifierInNsd"
pnfProfileId:
description: >
Identifier of the VNF profile of the NSD.
$ref: "#/definitions/IdentifierInNsd"
pnfName:
description: >
Name of the PNF.
type: string
cpInstanceId:
description: >
Identifier of the CP in the scope of the PNF.
type: array
moscatelli
committed
items:
$ref: "#/definitions/IdentifierInPnf"
changeType:
description: >
Signals the type of change.
Permitted values:
- ADD
- REMOVE
- MODIFY
type: string
enum:
- ADD
moscatelli
committed
- REMOVE
- MODIFY
changeResult:
description: >
Signals the result of change identified by the
"changeType" attribute.
Permitted values:
- COMPLETED
- ROLLED_BACK
- FAILED
type: string
enum:
- COMPLETED
moscatelli
committed
- ROLLED_BACK
- FAILED
AffectedVl:
description: >
This type provides information about added, deleted and modified VLs.
It shall comply with the provisions in Table 6.5.3.4-1.
type: object
required:
- nsVirtualLinkInstanceId
- nsVirtualLinkDescId
moscatelli
committed
- vlProfileId
properties:
nsVirtualLinkInstanceId:
description: >
Identifier of the VL Instance.
$ref: "#/definitions/IdentifierInNs"
nsVirtualLinkDescId:
description: >
Identifier of the VLD in the NSD for this VL.
$ref: "#/definitions/IdentifierInNsd"
vlProfileId:
description: >
Identifier of the VLD in the NSD for this VL.
$ref: "#/definitions/IdentifierInNsd"
changeType:
description: >
Signals the type of change.
Permitted values:
- ADD
- DELETE
- MODIFY
- ADD_LINK_PORT
- REMOVE_LINK_PORT
type: string
enum:
- ADD
moscatelli
committed
- DELETE
- MODIFY
moscatelli
committed
- REMOVE_LINK_PORT
changeResult:
description: >
Signals the result of change identified by the
"changeType" attribute.
Permitted values:
- COMPLETED
- ROLLED_BACK
- FAILED
type: string
enum:
- COMPLETED
moscatelli
committed
- ROLLED_BACK
moscatelli
committed
moscatelli
committed
description: >
This type provides information about added, deleted and modified VNFFG instances.
It shall comply with the
provisions in Table 6.5.3.5-1.
type: object
required:
- vnffgInstanceId
- vnffgdId
properties:
vnffgInstanceId:
description: >
Identifier of the VNFFG instance.
$ref: "#/definitions/IdentifierInNs"
moscatelli
committed
vnffgdId:
description: >
Identifier of the VNFFGD of the VNFFG instance.
$ref: "#/definitions/IdentifierInNsd"
moscatelli
committed
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
changeType:
description: >
Signals the type of change.
Permitted values:
- ADD
- DELETE
- MODIFY
type: string
enum:
- ADD
- DELETE
- MODIFY
changeResult:
description: >
Signals the result of change identified by the
"changeType" attribute.
Permitted values:
- COMPLETED
- ROLLED_BACK
- FAILED
type: string
enum:
- COMPLETED
- ROLLED_BACK
- FAILED
moscatelli
committed
description: >
This type provides information about added, deleted and modified nested NSs.
It shall comply with the provisions in Table 6.5.3.6-1.
type: object
required:
- nsInstanceId
- nsdId
- changeType
- changeResult
moscatelli
committed
properties:
nsInstanceId:
description: >
Identifier of the nested NS instance.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
moscatelli
committed
nsdId:
description: >
Identifier of the NSD of the nested NS instance.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
moscatelli
committed
3785
3786
3787
3788
3789
3790
3791
3792
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
3819
changeType:
description: >
Signals the type of lifecycle change.
Permitted values:
- ADD
- REMOVE
- INSTANTIATE
- SCALE
- UPDATE
- HEAL
- TERMINATE
type: string
enum:
- ADD
- REMOVE
- INSTANTIATE
- SCALE
- UPDATE
- HEAL
- TERMINATE
changeResult:
description: >
Signals the result of change identified by the
"changeType" attribute.
Permitted values:
- COMPLETED
- ROLLED_BACK
- FAILED
- PARTIALLY_COMPLETED
type: string
enum:
- COMPLETED
- ROLLED_BACK
- FAILED
- PARTIALLY_COMPLETED
changedInfo:
description: >
Information about the changed NS instance information, if applicable.
type: object
properties:
wanConnectionInfoModifications:
description: >
Information about the modified WAN related connectivity information, if applicable.
type: array
items:
$ref: "#/definitions/WanConnectionInfoModification"
moscatelli
committed
description: >
This type provides information about added, deleted and modified SAP of a NS.
It shall comply with the provisions in Table 6.5.3.7-1.
type: object
required:
- sapInstanceId
- sapdId
properties:
sapInstanceId:
description: >
Identifier of the nested NS instance.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
moscatelli
committed
sapdId:
description: >
Identifier of the NSD of the nested NS instance.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
moscatelli
committed
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
sapName:
description: >
Human readable name for the SAP.
type: string
changeType:
description: >
Signals the type of lifecycle change.
Permitted values:
- ADD
- REMOVE
- MODIFY
type: string
enum:
- ADD
- REMOVE
- MODIFY
changeResult:
description: >
Signals the result of change identified by the
"changeType" attribute.
Permitted values:
- COMPLETED
- ROLLED_BACK
- FAILED
type: string
enum:
- COMPLETED
- ROLLED_BACK
- FAILED
NsLcmOperationStateType:
description: >
The enumeration NsLcmOperationStateType shall comply with the provisions defined in Table 6.5.4.4-1.
Value | Description
------|------------
PROCESSING | The LCM operation is currently in execution.
COMPLETED | The LCM operation has been completed successfully.
PARTIALLY_COMPLETED | The LCM operation has been partially completed with accepTable errors.
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.
OLLING_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:
- PROCESSING
- COMPLETED
- FAILED_TEMP
- FAILED
- ROLLING_BACK
moscatelli
committed
- ROLLED_BACK
moscatelli
committed
description: >
The enumeration NsLcmOpType represents those lifecycle operations that trigger a NS lifecycle management operation
occurrence notification.
Value | Description
------|------------
INSTANTIATE | Represents the "Instantiate NS" LCM operation.
SCALE | Represents the "Scale NS" LCM operation.
UPDATE | Represents the "Update NS" LCM operation.
TERMINATE | Represents the "Terminate NS" LCM operation.
HEAL | Represents the "Heal NS" LCM operation.
type: string
enum:
- INSTANTIATE
- SCALE
- UPDATE
- TERMINATE
- HEAL
LccnSubscriptionRequest:
description: >
This type represents a subscription request related to notifications
about NS lifecycle changes. It shall comply with the
provisions defined in Table 6.5.2.2-1..
type: object
required:
- callbackUri
properties:
moscatelli
committed
filter:
moscatelli
committed
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.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_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.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_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"
moscatelli
committed
LccnSubscription:
description: >
This type represents a subscription related to notifications about NS lifecycle changes.
It shall comply with the provisions defined in Table 6.5.2.4-1.
type: object
required:
- id
- callbackUri
- _links
properties:
id:
description: >
Identifier of this subscription resource.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_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.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_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.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
LifecycleChangeNotificationsFilter:
description: >
This type represents a subscription filter related to notifications about
NS lifecycle changes. It shall comply with the
provisions defined in Table 6.5.3.8-1.
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:
nsInstanceSubscriptionFilter:
description: >
Filter criteria to select NS instances about which to notify.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/NsInstanceSubscriptionFilter"
notificationTypes:
description: >
Match particular notification types.
Permitted values:
- NsLcmOperationOccurenceNotification
- NsIdentifierCreationNotification
- NsIdentifierDeletionNotification
- NsLcmCapacityShortageNotification
type: array
items:
type: string
enum:
- NsLcmOperationOccurenceNotification
- NsIdentifierCreationNotification
- NsIdentifierDeletionNotification
moscatelli
committed
- NsChangeNotification
operationTypes:
description: >
Match particular NS lifecycle operation types
for the notification of type
NsLcmOperationOccurrenceNotification.
May be present if the "notificationTypes"
attribute contains the value
"NsLcmOperationOccurrenceNotification", and
shall be absent otherwise.
type: array
moscatelli
committed
items:
$ref: "#/definitions/NsLcmOpType"
operationStates:
description: >
Match particular LCM operation state values as
reported in notifications of type
NsLcmOperationOccurrenceNotification.
May be present if the "notificationTypes"
attribute contains the value
"NsLcmOperationOccurrenceNotification", and
shall be absent otherwise.
type: array
moscatelli
committed
items:
$ref: "#/definitions/LcmOperationStateType"
affectedNsInstanceIds:
description: >
Match particular identifiers of the NS instance(s) related to the operation occurrence that were affected by
the shortage as reported in notifications of type NsLcmCapacityShortageNotification.
May be present if the "notificationTypes" attribute contains the value "NsLcmCapacityShortageNotification",
and shall be absent otherwise.
items:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
nsComponentTypes:
description: >
Match particular NS component types for the
notification of type NsChangeNotification.
May be present if the "notificationTypes"
attribute contains the value "NsChang.
type: array
moscatelli
committed
items:
$ref: "#/definitions/NsComponentType"
lcmOpNameImpactingNsComponent:
description: >
Match particular LCM operation names for the
notification of type NsChangeNotification.
May be present if the "notificationTypes"
attribute contains the value
"NsChangeNotification", and shall be absent otherwise.
type: array
moscatelli
committed
items:
$ref: "#/definitions/LcmOpNameForChangeNotificationType"
lcmOpOccStatusImpactingNsComponent:
description: >
Match particular LCM operation status values
as reported in notifications of type
NsChangeNotification.
May be present if the "notificationTypes"
attribute contains the value
"NsChangeNotification", and shall be absent otherwise.
type: array
moscatelli
committed
items:
$ref: "#/definitions/LcmOpOccStatusForChangeNotificationType"
moscatelli
committed
NsScaleInfo:
description: >
This type represents the target NS Scale level for each NS scaling aspect of the current deployment flavor.
type: object
required:
- nsScalingAspectId
- nsScaleLevelId
properties:
nsScalingAspectId:
description: >
Identifier of the NS scaling aspect.
$ref: "#/definitions/IdentifierInNsd"
nsScaleLevelId:
description: >
Identifier of the NS scale level.
$ref: "#/definitions/IdentifierInNsd"
ScaleNsData:
description: >
This type represents the information to scale a NS.
NOTE 1: No more than two attributes between vnfInstanceToBeAdded,
vnfInstanceToBeRemoved, scaleNsByStepsData and scaleNsToLevelData shall be present.
In case of two, the attributes shall be vnfInstanceToBeAdded and vnfInstanceToBeRemoved.
NOTE 2: The DF of the VNF instance shall match the VNF DF present in the associated VNF
Profile of the new NS flavour.
NOTE 3: This functionality is the same as the one provided by the Update NS operation when
the AddVnf update type is selected (see clause 7.3.5).
NOTE 4: This functionality is the same as the one provided by the Update NS operation when
the RemoveVnf update type is selected (see clause 7.3.5).
type: object
properties:
vnfInstanceToBeAdded:
description: >
An existing VNF instance to be added to the NS
instance as part of the scaling operation. If
needed, the VNF Profile to be used for this VNF
instance may also be provided.
moscatelli
committed
items:
$ref: "#/definitions/VnfInstanceData"
vnfInstanceToBeRemoved:
description: >
The VNF instance to be removed from the NS
instance as part of the scaling operation.
moscatelli
committed
items:
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
scaleNsByStepsData:
description: >
The information used to scale an NS instance by
one or more scaling steps.
moscatelli
committed
$ref: "#/definitions/ScaleNsByStepsData"
scaleNsToLevelData:
description: >
The information used to scale an NS instance to a target size.
moscatelli
committed
$ref: "#/definitions/ScaleNsToLevelData"
additionalParamsForNs:
description: >
Allows the OSS/BSS to provide additional
parameter(s) at the NS level necessary for the
NS scaling (as opposed to the VNF level, which is
covered in additionalParamsForVnf).
moscatelli
committed
$ref: "#/definitions/ParamsForVnf"
additionalParamsForVnf:
description: >
Allows the OSS/BSS to provide additional
parameter(s) per VNF instance (as opposed to
the NS level, which is covered in
additionalParamsforNs). This is for VNFs that are
to be created by the NFVO as part of the NS
scaling and not for existing VNF that are covered
by the scaleVnfData.
type: array
moscatelli
committed
items:
$ref: "#/definitions/ParamsForVnf"
locationConstraints:
description: >
The location constraints for the VNF to be
instantiated as part of the NS scaling.
An example can be a constraint for the VNF to be
in a specific geographic location.
type: array
moscatelli
committed
items:
$ref: "#/definitions/VnfLocationConstraint"
nestedNslocationConstraints:
description: >
Defines the location constraints for the nested NS to be instantiated as part of the NS instantiation.
An example can be a constraint for the nested NS to be in a specific geographic location.
type: array
items:
$ref: "#/definitions/NestedNsLocationConstraint"
ScaleVnfData:
description: >
This type represents defines the information to scale a VNF instance
to a given level, or to scale a VNF instance by steps.
NOTE 1: ETSI GS NFV-IFA 010 (available at https://www.etsi.org/deliver/etsi_gs/NFV-IFA/001_099/010/03.02.01_60/gs_NFV-IFA010v030201p.pdf)
specifies that the lifecycle management operations that expandor contract a VNF instance
include scale in, scale out, scale up and scale down. Vertical scaling (scale up, scale down)
is not supported in the present document.
NOTE 2: Either scaletoLevelData or scaleByStepData but not both shall be present. The scaleByStepData
is used for scale out/in type of scaling, and the scaleToLevelData is used for scale to instantiation/scale
level type of scaling.
type: object
required:
moscatelli
committed
- scaleVnfType
oneOf:
- required:
- scaleToLevelData
- required:
- scaleByStepData
description: >
Identifier of the VNF instance being scaled.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
scaleVnfType:
description: >
Type of the scale VNF operation requested.
Allowed values are:
- SCALE_OUT
- SCALE_IN
- SCALE_TO_INSTANTIATION_LEVEL
- SCALE_TO_SCALE_LEVEL(S)
The set of types actually supported depends on the
moscatelli
committed
enum:
moscatelli
committed
- SCALE_IN
- SCALE_TO_INSTANTIATION_LEVEL
- SCALE_TO_SCALE_LEVEL(S)
scaleToLevelData:
description: >
The information used for scaling to a given level.
moscatelli
committed
$ref: "#/definitions/ScaleToLevelData"
scaleByStepData:
description: >
The information used for scaling by steps. See note 2.
moscatelli
committed
$ref: "#/definitions/ScaleByStepData"
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
ScaleNsByStepsData:
description: >
This type represents the information used to scale an NS instance by one or more scaling steps, with respect to a
particular NS scaling aspect. Performing a scaling step means increasing/decreasing the capacity of an NS instance in a
discrete manner, i.e. moving from one NS scale level to another. The NS scaling aspects and their corresponding NS
scale levels applicable to the NS instance are declared in the NSD.
type: object
required:
- scalingDirection
- aspectId
properties:
scalingDirection:
description: >
The scaling direction. Possible values are:
- SCALE_IN
- SCALE_OUT.
type: string
enum:
- SCALE_IN
- SCALE_OUT
aspectId:
description: >
The aspect of the NS that is requested to be scaled, as
declared in the NSD.
$ref: "#/definitions/IdentifierInNsd"
numberOfSteps:
description: >
The number of scaling steps to be performed. Defaults to 1.
type: integer
default: 1
ScaleNsToLevelData:
description: >
This type represents the information used to scale an NS instance to a target size. The target size is either expressed as
an NS instantiation level or as a list of NS scale levels, one per NS scaling aspect, of the current DF. The NS
instantiation levels, the NS scaling aspects and their corresponding NS scale levels applicable to the NS instance are
declared in the NSD.
NOTE: Either nsInstantiationLevel or nsScaleInfo, but not both, shall be present.
oneOf:
- required:
- nsInstantiationLevel
- required:
- nsScaleInfo
properties:
nsInstantiationLevel:
description: >
Identifier of the target NS instantiation level of the
current DF to which the NS instance is requested to be scaled. See note.
$ref: "#/definitions/IdentifierInNsd"
nsScaleInfo:
description: >
For each NS scaling aspect of the current DF, defines
the target NS scale level to which the NS instance is to be scaled. See note.
moscatelli
committed
items:
$ref: "#/definitions/NsScaleInfo"
moscatelli
committed
ScaleToLevelData:
description: >
This type describes the information used to scale a VNF instance to a target size. The target size is either expressed as
an instantiation level of that DF as defined in the VNFD, or given as a list of scale levels, one per scaling aspect of that
DF. Instantiation levels and scaling aspects are declared in the VNFD. The NFVO shall then invoke the
ScaleVnfToLevel operation towards the appropriate VNFM.
NOTE: Either the instantiationLevelId attribute or the scaleInfo attribute shall be included.
anyOf:
- required:
- vnfInstantiationLevelId
- required:
- vnfScaleInfo
properties:
vnfInstantiationLevelId:
description: >
Identifier of the target instantiation level of the current
deployment flavor to which the VNF is requested to be scaled. See note.
$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
vnfScaleInfo:
description: >
For each scaling aspect of the current deployment
flavor, indicates the target scale level to which the VNF
moscatelli
committed
items:
$ref: "#/definitions/VnfScaleInfo"
additionalParams:
description: >
Additional parameters passed by the NFVO as input to
the scaling process, specific to the VNF being scaled.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
ScaleByStepData:
description: >
This type describes the information to scale a VNF instance by steps.
The NFVO shall then invoke the Scale VNF
operation towards the appropriate VNFM.
NOTE: A scaling step is the smallest unit by which a VNF instance can be scaled w.r.t a particular scaling aspect.
type: object
required:
- aspectId
properties:
aspectId:
description: >
Identifier of (reference to) the aspect of the VNF that is
requested to be scaled, as declared in the VNFD.
$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
numberOfSteps:
description: >
Number of scaling steps. It shall be a positive number.
Defaults to 1.
The VNF provider defines in the VNFD whether or not a
particular VNF supports performing more than one step
at a time. Such a property in the VNFD applies for all
moscatelli
committed
default: 1
additionalParams:
description: >
Additional parameters passed by the NFVO as input to
the scaling process, specific to the VNF instance being scaled.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
moscatelli
committed
LcmOperationStateType:
description: >
Value | Description
------|------------
PROCESSING | The LCM operation is currently in execution.
COMPLETED | The LCM operation has been completed successfully.
PARTIALLY_COMPLETED | The LCM operation has been partially completed with accepTable errors.
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 will not succeed.
OLLING_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 NS prior to the original operation invocation has been restored as closely as possible.
type: string
enum:
- PROCESSING
- COMPLETED
- PARTIALLY_COMPLETED
- FAILED_TEMP
- FAILED
- ROLLING_BACK
- ROLLED_BACK
moscatelli
committed
NsComponentType:
description: >
The enumeration NsComponentType represents the NS component type. It shall comply with the provisions defined in Table 6.5.4.5-1.
Value | Description
------|------------
VNF | Represents the impacted NS component is a VNF.
PNF | Represents the impacted NS component is a PNF.
NS | Represents the impacted NS component is a nested NS.
type: string
enum:
- VNF
- PNF
moscatelli
committed
- NS
Samir Medjiah
committed
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
LcmOpNameForChangeNotificationType:
description: >
The enumeration LcmOpNameForChangeNotificationType represents the name of the lifecycle operation that impacts the NS component and trigger an NS change notification. It shall comply with the provisions defined in Table 6.5.4.6-1.
Value | Description
------|------------
VNF_INSTANTIATE | Represents the "Instantiate VNF" LCM operation.
VNF_SCALE | Represents the "Scale VNF" LCM operation.
VNF_SCALE_TO_LEVEL | Represents the "Scale VNF to Level" LCM operation.
VNF_CHANGE_FLAVOUR | Represents the "Change VNF Flavor" LCM operation.
VNF_TERMINATE | Represents the "Terminate VNF" LCM operation.
VNF_HEAL | Represents the "Heal VNF" LCM operation.
VNF_OPERATE | Represents the "Operate VNF" LCM operation.
VNF_CHANGE_EXT_CONN | Represents the "Change external VNF connectivity" LCM operation.
VNF_MODIFY_INFO | Represents the "Modify VNF Information" LCM operation.
NS_INSTANTIATE | Represents the "Instantiate NS" LCM operation
NS_SCALE | Represents the "Scale NS" LCM operation.
NS_UPDATE | Represents the "Update NS" LCM operation.
NS_TERMINATE | Represents the "Terminate NS" LCM operation.
NS_HEAL | Represents the "Heal NS" LCM operation.
type: string
enum:
- VNF_INSTANTIATE
- VNF_SCALE
moscatelli
committed
- VNF_SCALE_TO_LEVEL
- VNF_CHANGE_FLAVOUR
- VNF_TERMINATE
- VNF_HEAL
- VNF_OPERATE
- VNF_CHANGE_EXT_CONN
- VNF_MODIFY_INFO
- NS_INSTANTIATE
- NS_SCALE
moscatelli
committed
- NS_UPDATE
- NS_TERMINATE
- NS_HEAL
Samir Medjiah
committed
LcmOpOccStatusForChangeNotificationType:
description: >
The enumeration LcmOpOccStatusForChangeNotificationType represents the status of the lifecycle management
operation occurrence that impacts the NS component and triggers an NS change notification. It shall comply with the
provisions defined in Table 6.5.4.7-1.
Value | Description
------|------------
START | The impact on the NS component is identified.
COMPLETED | The impact on the NS component stops and related lifecycle operation completes successfully.
PARTIALLY_COMPLETED | The impact on the NS component stops and related lifecycle operation partially completes. Inconsistency state may exist on the NS component.
FAILED | The impact on the NS component stops and related lifecycle operation fails. Inconsistency state may exist for the NS component.
ROLLED_BACK | The impact on the NS component stops and related lifecycle operation is rolled back.
type: string
enum:
- START
- COMPLETED
moscatelli
committed
- PARTIALLY_COMPLETED
- ROLLED_BACK
NsLcmOpOcc:
description: >
This type represents a request a NS lifecycle operation occurrence.
It shall comply with the provisions defined in Table 6.5.2.3-1.
NOTE 1: This allows the OSS/BSS to obtain a copy of the latest "result" notification if it has not received
it due to an error. If the notification represents the successful result of a lifecycle operation, at least
an affectedVnf, or affectedPnf, or affectedVl, or affectedVnffg or affectedNs, or affectedSap shall be present.
NOTE 2: A coordination action has timed out if the NFVO 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 3: 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", “PARTIALLY COMPLETED” and "ROLLED_BACK".
type: object
required:
- id
- operationState
- nsInstanceId
- lcmOperationType
- startTime
- isAutomaticInvocation
- isCancelPending
- _links
properties:
id:
description: >
Identifier of this NS lifecycle operation occurrence.
NOTE 1: This allows the OSS/BSS to obtain a copy of the latest "result"
notification if it has not received it due to an error. If the notification
represents the successful result of a lifecycle operation, at least an affectedVnf,
or affectedPnf, or affectedVl, or affectedVnffg or affectedNs, or affectedSap
shall be present.
NOTE 2: A coordination action has timed out if the NFVO 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.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
operationState:
description: >
The state of the NS LCM operation.
Samir Medjiah
committed
$ref: "#/definitions/NsLcmOperationStateType"
stateEnteredTime:
Date-time when the current state has been entered.
$ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
nsInstanceId:
description: >
Identifier of the NS instance to which the operation applies.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
lcmOperationType:
description: >
Type of the actual LCM operation represented by this
lcm operation occurrence.
Samir Medjiah
committed
$ref: "#/definitions/NsLcmOpType"
startTime:
description: >
Date-time of the start of the operation.
$ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
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
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
isAutomaticInvocation:
description: >
Set to true if this NS LCM operation occurrence has
been automatically triggered by the NFVO. This occurs
in the case of auto-scaling, auto-healing and when a
nested NS is modified as a result of an operation on its
composite NS. Set to false otherwise.
type: boolean
operationParams:
description: >
Input parameters of the LCM operation. This attribute
shall be formatted according to the request data type of
the related LCM operation.
The following mapping between lcmOperationType and
the data type of this attribute shall apply:
- INSTANTIATE: InstantiateNsRequest
- SCALE: ScaleNsRequest
- UPDATE: UpdateNsRequest
- HEAL: HealNsRequest
- TERMINATE: TerminateNsRequest
This attribute shall be present if this data type is returned
in a response to reading an individual resource, and may
be present according to the chosen attribute selector
parameter if this data type is returned in a response to a
query of a container resource.
type: string
enum:
- INSTANTIATE
- SCALE
- UPDATE
- HEAL
- TERMINATE
isCancelPending:
description: >
If the LCM operation occurrence is in "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.
type: 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: "../../definitions/SOL005_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:
affectedVnfs:
description: >
Information about the VNF instances that were affected
during the lifecycle operation, if this notification
represents the result of a lifecycle operation. See note 1.
Samir Medjiah
committed
$ref: "#/definitions/AffectedVnf"
affectedPnfs:
description: >
Information about the PNF instances that were affected
during the lifecycle operation, if this notification
represents the result of a lifecycle operation. See note 1.
Samir Medjiah
committed
$ref: "#/definitions/AffectedPnf"
affectedVls:
description: >
Information about the VL instances that were affected
during the lifecycle operation, if this notification
represents the result of a lifecycle operation. See note 1.
$ref: "#/definitions/AffectedVirtualLink"
affectedVnffgs:
description: >
Information about the VNFFG instances that were
affected during the lifecycle operation, if this notification
represents the result of a lifecycle operation. See note 1.
Samir Medjiah
committed
$ref: "#/definitions/AffectedVnffg"
affectedNss:
description: >
Information about the nested NS instances that were
affected during the lifecycle operation, if this notification
represents the result of a lifecycle operation. See note 1.
Samir Medjiah
committed
$ref: "#/definitions/AffectedNs"
affectedSaps:
description: >
Information about the nested NS instances that were
affected during the lifecycle operation, if this notification
represents the result of a lifecycle operation. See note 1.
Samir Medjiah
committed
$ref: "#/definitions/AffectedSap"
lcmCoordinations:
description: >
Information about LCM coordination actions (see clause 12)
related to this LCM operation occurrence.
type: array
items:
type: object
required:
- id
- coordinationActionName
- startTime
- endpointType
properties:
id:
description: >
Identifier of this coordination action. For a terminated coordination action,
this attribute refers to the "id" attribute in the LcmCoord data structure
(see clause 12.5.2.3). For a timed-out or ongoing coordination action, this
attribute refers to the {coordinationId} URI variable in the "Location" header
of the "202 Accepted" HTTP response to the POST request that has initiated the
coordination action (see clause 12.4.2.3.1).
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
coordinationActionName:
description: >
Indicator of the actual coordination action.
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
coordinationResult:
description: >
The result of executing the coordination action which also implies the action
to be performed by the NFVO 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 2).
$ref: "../../NSLCMCoordination/definitions/SOL005NSLCMCoordination_def.yaml#/definitions/LcmCoordResultType"
startTime:
description: >
The time when the NFVO has received the confirmation that the coordination action has been started.
$ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
endTime:
description: >
The time when the NFVO 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 2) and shall be absent if the
coordination is ongoing.
$ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
endpointType:
description: >
The endpoint type used by this coordination action.
Valid values:
- MGMT: coordination with other operation supporting management systems (e.g. OSS/BSS)
type: string
enum:
- MGMT
delay:
description: >
The end of the delay period.
This attribute shall be present if the last known HTTP response related to this coordination has
contained a "Retry-After" header, and shall be absent otherwise.
$ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
warnings:
description: >
Warning messages that were generated while the operation was executing.
If the operation has included VNF LCM operations or NS LCM coordination
actions and these have resulted in warnings, such warnings should be
added to this attribute.
type: array
items:
type: string
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
rejectedLcmCoordinations:
description: >
Information about LCM coordination actions (see clause 12) that were rejected by 503 error which means
they can be tried again after a delay. See note 3.
type: array
items:
type: object
required:
- coordinationActionName
- rejectionTime
- endpointType
- delay
properties:
coordinationActionName:
description: >
Indicator of the actual coordination action.
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
rejectionTime:
description: >
The time when the NFVO has received the 503 response that rejects the actual coordination.
$ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
endpointType:
description: >
The endpoint type used by this coordination action.
Valid values:
- MGMT: coordination with other operation supporting management systems (e.g. OSS/BSS)
type: string
delay:
description: >
The end of the delay period, as calculated from the startTime and "Retry-After" header.
$ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
_links:
description: >
Links to resources related to this resource.
type: object
required:
- self
- nsInstance
properties:
self:
description: >
URI of this resource.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
nsInstance:
description: >
Link to the NS instance that the operation applies to.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
cancel:
description: >
Link to the task resource that represents the "cancel"
operation for this LCM operation occurrence, if
cancelling is currently allowed.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
retry:
description: >
Link to the task resource that represents the "cancel"
operation for this LCM operation occurrence,
if cancelling is currently allowed.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
rollback:
description: >
Link to the task resource that represents the "rollback"
operation for this LCM operation occurrence, if rolling
back is currently allowed.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
continue:
description: >
Link to the task resource that represents the "continue"
operation for this LCM operation occurrence, if rolling
back is currently allowed.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
fail:
description: >
Link to the task resource that represents the "fail"
operation for this LCM operation occurrence, if rolling
back is currently allowed.
Samir Medjiah
committed
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
$ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
subscriptionId:
description: >
Identifier of the subscription that this notification relates to.
type: string
nsInstanceId:
description: >
The deleted NS instance identifier.
type: string
CpProtocolData:
description: >
This type represents network protocol data.
type: object
required:
- layerProtocol
properties:
layerProtocol:
description: >
Identifier of layer(s) and protocol(s).
Permitted values: IP_OVER_ETHERNET.
type: string
enum:
- IP_OVER_ETHERNET
ipOverEthernet:
description: >
Network address data for IP 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/IpOverEthernetAddressData"
IpOverEthernetAddressData:
description: >
This type represents network address data for IP over Ethernet.
NOTE 1: At least one of "macAddress" or "ipAddresses" shall be present.
NOTE 2: Exactly one of "fixedAddresses", "numDynamicAddresses" or "ipAddressRange" 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.
Samir Medjiah
committed
type: object
anyOf:
- required:
- ipAddresses
- required:
- macAddress
Samir Medjiah
committed
properties:
macAddress:
description: >
MAC address. If this attribute is not present, it shall be chosen by the NFV MANO.
$ref: "#/definitions/MacAddress"
segmentationType:
description: >
Specifies the encapsulation type for the traffics coming in and out of the trunk subport.
Permitted values are:
- VLAN: The subport uses VLAN as encapsulation type.
- INHERIT: The subport gets its segmentation type from the network it is connected to.
This attribute may be present for CP instances that represent subports in a trunk and shall be absent otherwise.
If this attribute is not present for a subport CP instance, default value VLAN shall be used.
type: string
enum:
- VLAN
- INHERIT
segmentationId:
description: >
Identification of the network segment to which the CP instance connects to. See note 3 and note 4.
Samir Medjiah
committed
ipAddresses:
description: >
List of IP addresses to assign to the CP instance. Each entry
represents IP address data for fixed or dynamic IP address
assignment per subnet.
If this attribute is not present, no IP address shall be assigned. See note 1.
Samir Medjiah
committed
type: array
items:
type: object
required:
- type
oneOf:
- required:
- fixedAddresses
- required:
- numDynamicAddresses
- required:
- addressRange
Samir Medjiah
committed
properties:
type:
description: >
The type of the IP addresses.
Permitted values:
- IPV4
- IPV6
Samir Medjiah
committed
type: string
enum:
- IPV4
- IPV6
fixedAddresses:
description: >
Fixed addresses to assign (from the subnet defined by
"subnetId" if provided).
Exactly one of "fixedAddresses", "numDynamicAddresses" or
"ipAddressRange" shall be present.
type: array
items:
$ref: "#/definitions/IpAddress"
Samir Medjiah
committed
numDynamicAddresses:
description: >
Number of dynamic addresses to assign (from the subnet defined
by "subnetId" if provided).
Samir Medjiah
committed
type: integer
addressRange:
description: >
An IP address range to be used, e.g. in case of egress
connections.
In case this attribute is present, IP addresses from the range
will be used.
type: object
required:
- minAddress
- maxAddress
properties:
minAddress:
description: >
Lowest IP address belonging to the range.
$ref: "#/definitions/IpAddress"
Samir Medjiah
committed
maxAddress:
description: >
Highest IP address belonging to the range.
$ref: "#/definitions/IpAddress"
Samir Medjiah
committed
subnetId:
description: >
Subnet defined by the identifier of the subnet resource in the
VIM.
In case this attribute is present, IP addresses from that
subnet will be assigned; otherwise, IP addresses not bound to
a subnet will be assigned.
$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVim"
Samir Medjiah
committed
ExtVirtualLinkData:
description: >
This type represents an external VL.
NOTE: A link port is not needed for an external CP instance that exposes a VIP CP in the following cases:
1. For a VIP CP directly exposed as extCP:
1.1. no dedicated IP address is allocated as VIP address, as indicated in the VNFD
1.2. a dedicated IP address is allocated as VIP address,
but the NFVO indicates that no port is needed (createExtLinkPort in VnfExtCpConfig set to false).
2. For a VIP CP exposed as extCP via a floating IP address:
2.1. no dedicated IP address is allocated as VIP address, as indicated in the VNFD,
and the VNFC CP associated to the VIP CP is also exposed via a floating IP address.
Samir Medjiah
committed
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
type: object
required:
- resourceId
- extCps
properties:
extVirtualLinkId:
description: >
The identifier of the external VL instance, if provided.
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
vimId:
description: >
Identifier of the VIM that manages this resource. This
attribute shall only be supported and present if VNFrelated
resource management in direct mode is applicable.
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
resourceProviderId:
description: >
Identifies the entity responsible for the management of
this resource.
This attribute shall only be supported and present if
VNF-related resource management in indirect mode is
applicable. The identification scheme is outside the
scope of the present document.
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
resourceId:
description: >
The identifier of the resource in the scope of the VIM or
the resource provider.
$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVim"
Samir Medjiah
committed
extCps:
description: >
External CPs of the VNF to be connected to this external VL.
type: array
items:
$ref: "#/definitions/VnfExtCpData"
extLinkPorts:
description: >
Externally provided link ports to be used to connect
external connection points to this external VL unless
the extCp exposes a VIP CP and a link port is not needed
for it based on the conditions defined below.
Samir Medjiah
committed
type: array
items:
$ref: "#/definitions/ExtLinkPortData"
ExtManagedVirtualLinkData:
description: >
This type represents an externally-managed internal VL.
It shall comply with the provisions defined in Table 6.5.3.27-1.
type: object
required:
Samir Medjiah
committed
- resourceId
properties:
extManagedVirtualLinkId:
description: >
The identifier of the externally-managed internal VL
instance, if provided.
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
Samir Medjiah
committed
description: >
The identifier of the VLD in the VNFD for this VL.
$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
Samir Medjiah
committed
vimId:
description: >
Identifier of the VIM that manage this resource. This
attribute shall only be supported and present if VNFrelated
resource management in direct mode is applicable.
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
resourceProviderId:
description: >
Identifies the entity responsible for the management of
this resource. This attribute shall only be supported and present if
VNF-related resource management in indirect mode is
applicable. The identification scheme is outside the
scope of the present document.
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
resourceId:
description: >
The identifier of the resource in the scope of the VIM or
the resource provider.
$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVim"
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
externally-managed VL.
type: array
items:
$ref: "#/definitions/VnfLinkPortData"
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 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: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
Samir Medjiah
committed
VnfExtCpData:
description: >
This type represents configuration information for external CPs created
from a CPD.
NOTE 1: In case this identifier refers to a CPD with trunking enabled, the external
CP instances created from this CPD will represent ports in a trunk.
NOTE 2: The map entry value shall be set to "null" in order to delete a "VnfExtCpConfig"
entry identified by a particular key value from the map, i.e. for the disconnection of an
existing external CP instance addressed by cpInstanceId in the deleted map entry from a particular
external virtual link, and deletion of that instance in case it represents a subport. Deleting
the last key from the map removes the affected instance of the "VnfExtCpData" structure from its
parent data structure.
NOTE 3: Within one VNF instance, all VNFC instances created from a particular VDU have the
same external connectivity. Thus, given a particular value of the "cpdId' attribute, there
shall be one "cpConfig" entry for each VNFC instance that has been or can be created from
a VDU which includes a CPD identified by the "cpdId" attribute. If the cpConfig represents
a subport in a trunk, all "cpConfig" entries in this list shall have the same segmentationId,
which means they are connected to the same set of external VLs via the trunk.
Samir Medjiah
committed
type: object
required:
- cpdId
properties:
cpdId:
description: >
The identifier of the CPD in the VNFD.
$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
Samir Medjiah
committed
cpConfig:
description: >
Map of instance data that need to be configured on the CP instances created from the respective CPD.
The key of the map which identifies the individual VnfExtCpConfig entries is managed by the API consumer.
The entries shall be applied by the VNFM according to the rules of JSON Merge Patch (see IETF RFC 7396).
Samir Medjiah
committed
$ref: "#/definitions/VnfExtCpConfig"
ExtLinkPortData:
description: >
This type represents an externally provided link port to be used to
connect an external connection point to an external VL.
NOTE: The value of "trunkResourceId" is scoped by the value of "vimConnectionId" in the "resourceHandle" attribute.
Samir Medjiah
committed
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: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
resourceHandle:
description: >
Reference to the virtualised resource realizing this link port.
$ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
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.
$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVim"
Samir Medjiah
committed
VnfExtCpConfig:
description: >
This type represents an externally provided link port or network address
information per instance of an external connection point. In case a link
port is provided, the VNFM shall use that link port when connecting the
external CP to the external VL. In a link port is not provided, the VNFM
shall create a link port on the external VL, and use that link port to
connect the external CP to the external VL.
NOTE 1: The following conditions apply to the attributes "linkPortId" and "cpProtocolData":
- At least one of the "linkPortId" and "cpProtocolData" attributes shall be present for
an external CP instance representing a subport that is to be created, or an external CP instance
that is to be created by creating the corresponding VNFC or VNF instance during the current or
a subsequent LCM operation, or for an existing external CP instance that is to be re-configured
or added to a particular external virtual link.
- If the "cpProtocolData" attribute is absent, the "linkPortId" attribute shall be provided
referencing a pre-created link port with pre-configured address information.
- If both "cpProtocolData" and "linkportId" are provided, the API consumer shall ensure that
the cpProtocolData can be used with the pre-created link port referenced by "linkPortId".
NOTE 2: In case the NFVO manages its own identifier space, the NFVO may remap this identifier
when communicating with the VNFM. If the NFVO knows that there can be an identifier collision
when communicating with the VNFM by using the identifier from the OSS/BSS, the NFVO shall remap it.
Samir Medjiah
committed
type: object
anyOf:
- required:
- linkPortId
- required:
- cpProtocolData
Samir Medjiah
committed
properties:
parentCpConfigId:
description: >
Value of the key that identifies to the "VnfExtCpConfig" entry that corresponds to the parent port of the trunk.
Only present in "VnfExtCpConfig" map structures which provide configuration information for a CP which represents
a subport in a trunk, and if parent ports are supported. See note 2.
$ref: "#/definitions/IdentifierInVnf"
Samir Medjiah
committed
linkPortId:
description: >
Identifier of a pre-configured link port to which the external CP
will be associated.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
createExtLinkPort:
description: >
Indicates the need to create a dedicated link port for the external CP.
If set to True, a link port is created. If set to False, no link port is created.
This attribute is only applicable for external CP instances without a floating IP
address that expose a VIP CP instance for which a dedicated IP address is allocated.
It shall be present in that case and shall be absent otherwise.
type: boolean
Samir Medjiah
committed
cpProtocolData:
description: >
Parameters for configuring the network protocols on the link port
that connects the CP to a VL.
Samir Medjiah
committed
type: array
items:
$ref: "#/definitions/CpProtocolData"
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
IdentifierInNs:
description: >
An identifier that is unique with respect to a NS. Representation: string of variable length.
type: string
IdentifierInNsd:
description: >
An identifier that is unique within a NS descriptor. Representation: string of variable length.
type: string
IdentifierInPnf:
description: >
An Identifier that is unique within respect to a PNF. Representation: string of variable length.
type: string
IdentifierInVim:
description: >
An identifier maintained by the VIM or other resource provider.
It is expected to be unique within the VIM instance. Representation: string of variable length.
type: string
IdentifierInVnf:
description: >
An identifier that is unique for the respective type within a VNF
instance, but may not be globally unique.
type: string
MacAddress:
description: >
A MAC address. Representation: string that consists of groups of two hexadecimal digits,
separated by hyphens or colons.
type: string
format: MAC
IpAddress:
description: >
An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal
integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that
consists of groups of zero to four hexadecimal digits, separated by colons.
type: string
format: IP
IpAddressPrefix:
description: >
An IPV4 or IPV6 address range in CIDR format. For IPV4 address range, refer to IETF RFC 4632 [12].
For IPV6 address range, refer to IETF RFC 4291.
type: string
Samir Medjiah
committed
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
PortRange:
description: >
The PortRange data type provides the lower and upper bounds of a range of Internet ports.
It shall comply with the provisions defined in Table 6.5.3.42-1.
type: object
required:
- lowerPort
- upperPort
properties:
lowerPort:
description: >
Identifies the lower bound of the port range. upperPort Integer
type: integer
minimum: 0
upperPort:
description: >
Identifies the upper bound of the port range.
type: integer
minimum: 0
Mask:
description: >
The Mask data type identifies the value to be matched for a sequence of
bits at a particular location in a frame. It shall
comply with the provisions defined in Table 6.5.3.41-1.
type: object
required:
- startingPoint
- length
- value
properties:
startingPoint:
description: >
Indicates the offset between the last bit of the source
mac address and the first bit of the sequence of bits
to be matched.
type: integer
length:
description: >
Indicates the number of bits to be matched.
type: integer
value:
description: >
Provide the sequence of bit values to be matched.
type: string
VnfSnapshotInfo:
description: |
This type represents an "Individual VNF snapshot" resource. The "id" attributed is used by the NFVO to index and
identify the VNF snapshots information resources that are accessible via the NFVO. The identifier is still
generated by the VNFM and copied into the present "VnfSnapshotInfo" representing the "Individual VNF snapshot"
resource hold by the NFVO.
type: object
required:
- id
properties:
id:
description: >
Identifier of the "Individual VNF snapshot" resource. This identifier is allocated by the VNFM.
$ref: "../../definitions/SOL005_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: "../../definitions/SOL005_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 on a VNFM, either created via the
corresponding "Create VNF Snapshot" task resource or extracted from a VNF snapshot package.
$ref: '#/definitions/VnfSnapshot'
_links:
description: >
Links to resources related to this resource.
type: object
required:
- self
properties:
self:
description: >
URI of this resource.
$ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
VnfSnapshot:
description: >
This type represents a VNF Snapshot. It shall comply with the provisions defined in table 6.5.2.18-1.
type: object
required:
- id
- vnfInstanceId
- triggeredAt
- createdAt
- vnfdId
- vnfInstance
- vnfcSnapshots
properties:
id:
description: >
Identifier of the VNF snapshot. This identifier is allocated by the VNFM.
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
vnfInstanceId:
description: >
Identifier of the snapshotted VNF instance.
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
Timestamp indicating when the VNF Snapshot creation has been started by the VNFM.
$ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
Timestamp indicating when the VNF Snapshot has been completed by the VNFM.
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
$ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
vnfdId:
description: >
Identifier of the VNFD in use at the time the snapshot of the VNF instance has been created.
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
vnfInstance:
description: >
VNF instance information of the snapshotted VNF instance. This is a copy of the "Individual VNF instance" resource.
$ref: '#/definitions/VnfInstance'
vnfcSnapshots:
description: >
Information about VNFC Snapshots constituting this VNF Snapshot.
type: array
items:
$ref: '#/definitions/VnfcSnapshotInfo'
userDefinedData:
description: >
User defined data for the VNF Snapshot.
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
WanConnectionInfo:
description: |
This type provides information about the connectivity to the WAN of network resources realizing a VL, e.g.,
when the VL is deployed on several sites across a WAN. It shall comply with the provisions defined in table 6.5.3.90-1.
NOTE: Either a "nsVirtualLinkInfoId" or a "vnfVirtualLinkResourceInfoId" shall be provided, but not both.
type: object
required:
- wanConnectionInfoId
oneOf:
- required:
- nsVirtualLinkInfoId
- required:
- vnfVirtualLinkResourceInfoId
properties:
wanConnectionInfoId:
description: >
Identifies this WAN connection information.
$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNs"
nsVirtualLinkInfoId:
description: >
References the NS VL instance to which the connection information is associated. Shall be present if a
corresponding NS VL instance has been created.
$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNs"
vnfVirtualLinkResourceInfoId:
description: >
References the VNF VL instance to which the connection information is associated. Shall be present if a
corresponding VNF VL instance has been created.
$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNs"
protocolInfo:
description: >
Protocol specific information for connecting to the WAN.
$ref: "#/definitions/WanConnectionProtocolInfo"
WanConnectionProtocolInfo:
description: |
This type provides protocol specific information about the connectivity to the WAN of network resources realizing
a VL, e.g., when the VL is deployed on several sites and across a WAN, and the related multi-site connectivity
service (MSCS) enabling the connectivity through the WAN. This type supports providing information about both
pre-provisioned WAN connectivity realized by external entities to NFV-MANO but parts of such connectivity is known
to the NFVO, as well as information about MSCS created under NFV-MANO responsibility (i.e., connectivity is realized
when NFVO communicates with the WIM). It shall comply with the provisions defined in table 6.5.3.91-1.
type: object
properties:
mscsInfo:
description: >
Information about the provisioned MSCS, if already available.
$ref: "#/definitions/MscsInfo"
connectivityServiceEndpoints:
description: >
Configuration information about the network resources in the NFVI-PoP and their connectivity to the WAN.
type: array
items:
$ref: "#/definitions/ConnectivityServiceEndpointInfo"
WanConnectionData:
description: |
This type provides information used to connect the comprising network resources realizing a VL, e.g., when the VL
is deployed on several sites and across a WAN. It shall comply with the provisions defined in table 6.5.3.80-1.
NOTE: Either a "nsVirtualLink" or a "vnfVirtualLink" shall be provided, but not both.
type: object
required:
- protocolData
oneOf:
- required:
- nsVirtualLink
- required:
- vnfVirtualLink
properties:
nsVirtualLink:
description: >
Information used to identify the NS VL for which the WAN connectivity data is applicable.
type: object
required:
- nsVirtualLinkDescId
- nsVirtualLinkProfileId
properties:
nsVirtualLinkDescId:
description: >
Identifier of the VLD in the NSD from which the VL is created in the case of a multi-site NS VL.
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd"
nsVirtualLinkProfileId:
description: >
Identifier of the VL profile in the NSD.
$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd"
vnfVirtualLink:
description: >
Information used to identify the VNF VL for which the WAN connectivity data is applicable.
Either a "nsVirtualLink" or a "vnfVirtualLink" shall be provided, but not both.
type: object
required:
- vnfProfileId
- vnfVirtualLinkDescId
- vnfVirtualLinkProfileId
properties:
vnfProfileId:
description: >
Identifier of the VNF profile.
$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd"
vnfVirtualLinkDescId:
description: >
Identifier of the VLD in the VNFD from which the VL is created in the case of a multi-site internal VNF VL.
$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
vnfVirtualLinkProfileId:
description: >
Identifier of the VL profile in the VNFD.
$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
protocolData:
description: >
Protocol specific information for connecting to the WAN.
$ref: "#/definitions/WanConnectionProtocolData"
ChangeVnfPackageData:
description: |
This type specifies the information needed to change the current VNF package for a VNF instance. Clause B.3 of the
ETSI GS NFV-IFA 007 illustrates the variants of changes to the current VNF Package and information flow procedures.
This operation encompasses the following scenarios:
* Changes of the VNF virtualised resources, such as requirements, composition and structure between the VNF versions,
without changing the VNF software version.
* Changes of both the VNF software version and the VNF virtualised resources. This case includes replacing the VNF
software version by means of virtualised resources management, such as terminating the current virtualized resource
instances running the current software version and instantiating new virtualized resource instances with the
destination VNF software version. The new virtualized resource instances may have the same characteristics as the
current virtualized resource instances.
* Changes related to the VNFD, such as correction of bugs in the VNFD, changes in the naming scheme of VNFD components
(e.g. name of the VDU, vduId), and adding/removing descriptors of VNF Package changes (VnfPackageChangeInfo).
NOTE: For software updates that are executed by functional entities outside NFV-MANO and that require synchronization
of the information held by the NFV-MANO entities with a new VNF package that reflects the same changes, an
alternative procedure using the PATCH method on the "Individual VNF instance" resource has been defined, as
illustrated in annex B.2 of ETSI GS NFV-IFA 007 [19]. This procedure assumes certain restrictions on the
characteristics of the new VNF package, as defined in note 1 in table 5.5.2.2-1 of ETSI GS NFV-SOL 003.
This type shall comply with the provisions defined in Table 6.5.3.54-1.
type: object
required:
- vnfInstanceId
- vnfdId
properties:
vnfInstanceId:
description: >
Identifier of the VNF instance.
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
vnfdId:
description: >
Identifier of the VNFD which defines the destination VNF Package for the change.
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
extVirtualLinks:
description: >
Information about external VLs to connect the VNF to. Entries in the list that are unchanged need not be
supplied as part of this request.
type: array
items:
$ref: "#/definitions/ExtVirtualLinkData"
extManagedVirtualLinks:
description: >
Information about internal VLs that are managed by the NFVO.
type: array
items:
$ref: "#/definitions/ExtManagedVirtualLinkData"
additionalParams:
description: >
Additional parameters passed by the OSS/BSS as input to the change current VNF package process, specific to the
VNF of which the underlying VNF package is changed, as declared in the VNFD as part of "ChangeCurrentVnfPkgOpConfig".
$ref: "../../definitions/SOL005_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 6.5.3.57. 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 of ETSI GS NFV-SOL 003.
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
vnfConfigurableProperties:
description: >
If present, this attribute provides modifications to the values of the VNF configurable properties attribute in
the "VnfInstance", as defined in clause 6.5.3.57. 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 of ETSI
GS NFV-SOL 003.
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
DeleteVnfSnapshotData:
description: >
This type specifies the identifier of information of an available VNF Snapshot to be deleted and the identifier of
the related VNF instance of the NS instance. It shall comply with the provisions defined in Table 6.5.3.74-1.
type: object
required:
- vnfInstanceId
- vnfSnapshotInfoId
properties:
vnfInstanceId:
description: >
Identifier of the VNF instance to identify the VNFM holding the VNF Snapshot information to be deleted.
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
vnfSnapshotInfoId:
description: >
Identifier of information held by the VNFM about the VNF Snapshot to be deleted.
This identifier was allocated by the VNFM.
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
RevertVnfToSnapshotData:
description: >
This type specifies the identifier of an existing VNF instance of the NS instance to be reverted and the identifier
of an existing VNF Snapshot to be reverted to. It shall comply with the provisions defined in Table 6.5.3.75-1.
type: object
required:
- vnfInstanceId
- vnfSnapshotInfoId
properties:
vnfInstanceId:
description: >
Identifier of the VNF instance to identify the VNFM holding the VNF Snapshot information to be reverted.
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
vnfSnapshotInfoId:
description: >
Identifier of information held by the VNFM about the VNF Snapshot to be reverted.
This identifier was allocated by the VNFM.
$ref: "../../definitions/SOL005_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”.
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
CreateVnfSnapshotData:
description: >
This type represents the information that are needed for VNF snapshot creation. When the NFVO invokes the Create
VNF snapshot operation, a set of these parameters are then passed by the NFVO to the VNFM. It shall comply with
the provisions defined in Table 6.5.3.76-1.
type: object
required:
- vnfInstanceId
properties:
vnfInstanceId:
description: >
Identifier of the VNF instance to perform the snapshot from.
$ref: "../../definitions/SOL005_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”.
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
userDefinedData:
description: >
User defined data for the VNF snapshot.
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
VnfcSnapshotInfo:
description: >
This type represents a VNFC Snapshot. It shall comply with the provisions defined in table 6.5.3.77-1.
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
- createdAt
- vnfcInfoId
properties:
id:
description: >
Identifier of the information held by the VNFM about a specific VNFC Snapshot. This identifier is allocated by
the VNFM and is unique within the scope of a VNF snapshot. The attribute also identifies the compute snapshot
image associated to this VNFC snapshot within the context of a referred VNF snapshot.
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
vnfcInstanceId:
description: >
Identifier of the snapshotted VNFC instance.
$ref: "#/definitions/IdentifierInVnf"
Timestamp indicating when the VNFC Snapshot creation has been started by the VNFM.
$ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
Timestamp indicating when the VNFC Snapshot has been completed by the VNFM.
$ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
Reference to the "VnfcResourceInfo" structure that represents the resources of the snapshotted VNFC instance.
A snapshot of that structure is available in the "vnfInstance" attribute of the "VnfSnapshot" structure.
$ref: "#/definitions/IdentifierInVnf"
computeSnapshotResource:
description: >
Reference to a compute snapshot resource.
$ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
storageSnapshotResources:
description: >
Reference to the "VirtualStorageResourceInfo" structure in the "VnfInstance" structure that represents
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: "#/definitions/IdentifierInVnf"
storageSnapshotResources:
description: >
Reference to a storage snapshot resource.
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".
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
$ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
userDefinedData:
description: >
User defined data for the VNF Snapshot.
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
VnfLinkPortData:
description: >
This type represents an externally provided link port to be used to connect a VNFC connection point to an
externally-managed VL. It shall comply with the provisions defined in table 6.5.3.78-1.
type: object
required:
- vnfLinkPortId
- resourceHandle
properties:
vnfLinkPortId:
description: >
Identifier of this link port as provided by the entity that has created the link port.
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
resourceHandle:
description: >
Resource handle of the virtualised resource that realizes the link port.
$ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
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.
The "ModificationsTriggeredByVnfPkgChange" data type shall comply with the provisions defined in table 6.5.3.79-1.
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.
This attribute represents the delta (semantics as per IETF RFC 7396 [11], 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.
In addition, the provisions in clause 6.7 shall apply.
$ref: "../../definitions/SOL005_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. 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.
$ref: "../../definitions/SOL005_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. This attribute represents the delta
(semantics as per IETF RFC 7396 [11], 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.
In addition, the provisions in clause 6.7 shall apply.
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
vnfdId:
description: >
If present, this attribute signals the new value of the "vnfdId" attribute in "VnfInstance".
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
vnfProvider:
description: >
If present, this attribute signals the new value of the "vnfProvider" attribute in "VnfInstance".
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: string
vnfProductName:
description: >
If present, this attribute signals the new value of the "vnfProductName" attribute in "VnfInstance".
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: string
vnfSoftwareVersion:
description: >
If present, this attribute signals the new value of the "vnfSoftwareVersion" attribute in "VnfInstance".
If present, this attribute (which depends on the value of the "vnfdId" attribute) was modified implicitly
during the related operation, by copying the value of this attribute from the VNFD in the VNF Package
identified by the "vnfdId" attribute.
$ref: "../../definitions/SOL005_def.yaml#/definitions/Version"
vnfdVersion:
description: >
If present, this attribute signals the new value of the "vnfdVersion" attribute in "VnfInstance".
If present, this attribute (which depends on the value of the "vnfdId" attribute) was modified implicitly
during the related operation, by copying the value of this attribute from the VNFD in the VNF Package
identified by the "vnfdId" attribute.
$ref: "../../definitions/SOL005_def.yaml#/definitions/Version"
WanConnectionProtocolData:
description: >
This type provides protocol specific information used to connect the comprising network resources realizing a VL,
e.g., when the VL is deployed on several sites and across a WAN. This type supports signalling input information
about both pre-provisioned WAN connectivity realized by external entities to NFV-MANO, as well as for the creation
of MSCS under NFV-MANO responsibility (i.e., when connectivity is realized when NFVO communicates with the WIM).
It shall comply with the provisions defined in table 6.5.3.81-1.
NOTE: At least one of these attributes shall be present. Annex E documents the applicability of certain attributes
depending on the WAN and NFVI-PoP network management and the responsibilities of NFV-MANO in its provisioning.
anyOf:
- required:
- mscsInfo
- required:
- connectivityServiceEndpointConfigDatas
- required:
- mscsConfigData
properties:
mscsInfo:
description: >
Information about the pre-provisioned multi-site connectivity service (MSCS), if already available.
$ref: "#/definitions/MscsInfo"
connectivityServiceEndpointConfigDatas:
description: >
Configuration data for the network resources in the NFVI-PoP.
type: array
items:
$ref: "#/definitions/ConnectivityServiceEndpointInfo"
mscsConfigData:
description: >
Configuration data for the provisioning of the MSCS, if such MSCS is to be created by NFV-MANO.
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
$ref: "#/definitions/MscsConfigData"
MscsInfo:
description: >
This type provides information about an already provisioned multi-site connectivity service (MSCS) deployed across
a WAN. It shall comply with the provisions defined in Table 6.5.3.82-1.
type: object
required:
- mscsId
- mscsType
properties:
mscsId:
description: >
Identifier of the MSCS established over the WAN.
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
mscsName:
description: >
Human readable name of the MSCS.
type: string
mscsDescription:
description: >
Human readable description of the MSCS.
type: string
mscsType:
description: >
The type of connectivity that is provided to the virtualized networks in the NFVI-PoP and characterizes the
connectivity service across the WAN.
Permitted values:
type: string
enum:
- L2VPN
- L3VPN
mscsLayerProtocol:
description: >
Type of underlying connectivity service and protocol associated to the MSCS.
Permitted values are as listed below and restricted by the type of MSCS:
- EVPN_BGP_MPLS: as specified in IETF RFC 7432. Only applicable for mscsType="L2".
- EVPN_VPWS: as specified in IETF RFC 8214. Only applicable for mscsType="L2".
- VPLS_BGP: as specified in IETF RFC 4761 and IETF RFC 6624. Only applicable for mscsType="L2".
- VPLS_LDP_L2TP: as specified in IETF RFC 4762. Only applicable for mscsType="L2".
- VPWS_LDP_L2TP: as specified in IETF RFC 6074. Only applicable for mscsType="L2".
- BGP_IP_VPN: BGP/MPLS based IP VPN as specified in IETF RFC 4364. Only applicable for mscsType="L3".
type: string
enum:
- EVPN_BGP_MPLS
- EVPN_VPWS
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
- VPLS_BGP
- VPLS_LDP
- VPWS
- BGP_IP_VPN
siteAccessProtectionSchemes:
description: >
Information to determine the proper MSCS endpoints configuration to fulfil certain resiliency/protection
requirements, e.g., by considering certain availability and redundancy of connectivity service endpoints
in between NFVI-PoP and WAN.
type: array
items:
type: object
properties:
locationConstraints:
description: >
Defines the location constraints according to an NFVI-PoP (site).
$ref: "#/definitions/LocationConstraints"
protectionScheme:
description: >
Defines the protection scheme.
Permitted values:
- UNPROTECTED: to indicate no protection.
- ONE_TO_ONE: to indicate an active-passive access protection.
- ONE_PLUS_ONE: to indicate an active-active access protection.
- ONE_TO_N: to indicate an N active to 1 passive access protection.
type: string
enum:
- UNPROTECTED
- ONE_TO_ONE
- ONE_PLUS_ONE
- ONE_TO_N
mtuMscs:
description: >
Maximum Transmission Unit (MTU) that can be forwarded over the MSCS (in bytes). Default value is "1500" (bytes).
type: number
mscsEndpoints:
description: >
Information about the MSCS endpoints of the MSCS.
type: array
items:
$ref: "#/definitions/MscsEndpointInfo"
MscsEndpointInfo:
description: >
This type provides encapsulates information about an MSCS endpoint of the MSCS. It shall comply with the provisions
defined in table 6.5.3.83-1.
type: object
required:
- mscsEndpointId
- directionality
- connectivityServiceEndpoinId
properties:
mscsEndpointId:
description: >
Identifier of the MSCS endpoint.
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
directionality:
description: >
Directionality of the data traffic in the context of the terminating MSCS endpoint from WAN’s perspective.
Permitted values:
- INBOUND: to indicate into the WAN.
- OUTBOUND: to indicate from the WAN.
- BOTH: to indicate bidirectional data traffic to/from the WAN.
type: string
enum:
- INBOUND
- OUTBOUND
- BOTH
connectivityServiceEndpoinId:
description: >
References the connectivity service endpoint configuration information applicable to support the MSCS endpoint.
More than one connectivity service endpoint can be referred when endpoints are in LAG mode.
type: array
items:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
ConnectivityServiceEndpointInfo:
description: >
This type provides configuration data for the NFVI-PoP network gateway providing connectivity service endpoints.
The connectivity service endpoints are used as endpoints by an MSCS. It shall comply with the provisions defined
in Table 6.5.3.84-1.
type: object
required:
- connectivityServiceEndpointId
- vimId
properties:
connectivityServiceEndpointId:
description: >
Identifier of the connectivity service endpoint of the NFVI-PoP (site) providing the UNI in between the
NFVI-PoP and the WAN.
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
vimId:
description: >
Identifier of the VIM responsible for the management of the virtualized networks in the NFVI-PoP of the
applicable VL, and for which the connection data is applicable.
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
siteToWanLayer2ProtocolData:
description: >
Layer 2 protocol specific information for the configuration of the NFVI-PoP network gateway to enable the
stitching of the intra-site VN to the MSCS over the WAN.
$ref: "#/definitions/SiteToWanLayer2ProtocolData"
siteToWanLayer3ProtocolData:
description: >
Layer 3 protocol specific information for the configuration of NFVI-PoP network gateway to enable the stitching
of the intra-site VN to the MSCS over the WAN.
$ref: "#/definitions/SiteToWanLayer3ProtocolData"
SiteToWanLayer2ProtocolData:
description: >
This type provides information about Layer 2 protocol specific information for the configuration of the NFVI-PoP
network gateway to enable the stitching of the intra-site VN to the MSCS over the WAN. It shall comply with the
provisions defined in Table 6.5.3.85-1.
NOTE: Either "networkResources" or "vnSegmentsIds" shall be provided, but not both.
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
type: object
required:
- layer2ConnectionInfo
properties:
layer2ConnectionInfo:
description: >
Layer 2 protocol parameters of the connectivity service endpoint (CSE).
type: object
required:
- connectionType
- interfaceType
- interfaceTagging
- encapsulationType
properties:
connectionType:
description: >
The type of connection to be established on the connectivity service point.
Permitted values:
- CSE: defined by the characteristics of the existing referred connectivity service point.
- AGGREGATE_CSE: create an aggregation of the connectivity service endpoints.
type: string
enum:
- CSE
- AGGREGATE_CSE
interfaceType:
description: >
To indicate whether to create logical interfaces on the referred connectivity service endpoint or new
aggregated connectivity service endpoint.
Permitted values:
- PARENT: use the mapped interface to the connectivity service endpoint as is, i.e., do not create logical interfaces.
- LOGICAL: create logical interfaces.
type: string
enum:
- PARENT
- LOGICAL
interfaceTagging:
description: >
The type of frames to forward on the connectivity service point.
Permitted values:
- UNTAGGED: an interface where frames are not tagged.
- TAGGED: an interface configured to forward tagged frames (i.e., enabled for VLAN tagging).
type: string
enum:
- UNTAGGED
- TAGGED
encapsulationType:
description: >
The type of encapsulation. If the interfaceTagging="TAGGED", either "VLAN" or "VXLAN" shall be set.
Permitted values:
- ETH: generic Ethernet encapsulation.
- VLAN: encapsulation based on VLAN.
- VXLAN: encapsulation based on VXLAN.
type: string
enum:
- ETH
- VLAN
- VXLAN
Type of encapsulation method for VLAN tagging. Shall be present if interfaceTagging="TAGGED" and
encapsulationType="VLAN".
- DOT1Q: used when packets on the CSE are encapsulated with one or a set of customer VLAN identifiers.
- QINQ: used when packets on the CSE are encapsulated with multiple customer VLAN identifiers and a single
service VLAN identifier.
- QINANY: used when packets on the CSE have no specific customer VLAN and a service VLAN identifier is used.
type: string
enum:
- DOT1Q
- QINQ
wanSegmentIds:
description: >
Segment identifiers to pass on the tagged interface. Shall be present if encapsulationType="VLAN" or “VXLAN".
type: object
required:
- wanSegmentIdValue
properties:
wanSegmentIdValue:
description: >
Identifier of the network segment (e.g., VLAN id or VNI).
type: string
wanSegmentIdUpperRange:
description: >
Identifier of the upper range network segment, in case the "wanSegmentIds" is used to define a range.
type: string
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
vxlanConfig:
description: >
Additional configuration needed when using VXLAN encapsulation. Shall be present if interfaceTagging="TAGGED"
and encapsulationType="VXLAN".
type: object
required:
- peerMode
properties:
peerMode:
description: >
Type of VXLAN access mode. Default value is "STATIC".
Permitted values:
- STATIC
- BGP_EVPN
type: string
enum:
- STATIC
- BGP_EVPN
peers:
description: >
List of IP addresses of VTEP peers when using static mode.
type: array
items:
$ref: "#/definitions/IpAddress"
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
lagInterfaceData:
description: >
Information for setting up a LAG interface aggregating multiple connectivity service endpoints.
type: object
required:
- aggregatedEndpoints
- lacpActivation
- lacpConfig
properties:
aggregatedEndpoints:
description: >
List of the connectivity service endpoints that are to be aggregated. Shall be present if
connectionType="AGGREGATE_CSE". In case of aggregating connectivity service endpoints, only one
SiteToWanLayer2ProtocolData shall be provided for the whole set of aggregated endpoints.
type: array
items:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
lacpActivation:
description: >
Indicates whether to activate LACP on the interface. If "TRUE", the LACP is to be activated, or "FALSE"
otherwise. Default value is "FALSE".
type: boolean
lacpConfig:
description: >
Specific configuration for the LACP. Examples include configuration to indicate the minimum number of
active connectivity service endpoints, the time internal and priority of LACP packet data units (PDU).
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
layer2ControlProtocol:
description: >
Configuration enabling the L2 control protocol in between the NFVI-PoP network gateway and the WAN.
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
mtuL2:
description: >
Maximum Transmission Unit (MTU) that can be forwarded at layer 2 (in bytes). Default value is "1500" (bytes).
virtualRoutingAndForwarding:
description: >
Configuration related to the L2 virtual routing and forwarding (MAC-VRF).
type: object
required:
- macVrfName
properties:
macVrfName:
description: >
Name (or identifier) of the MAC-VRF instance.
type: string
forwardingConfig:
description: >
Information related to the forwarding of the VN in the NFVI-PoP to the connectivity service endpoint,
if information about the VN to "stitch" is already known. . by the OSS/BSS. Shall not be provided otherwise,
in which case the NFVO will infer the forwarding configuration based on the NS VL, or external VL, or
externally-managed VL provisioning.
oneOf:
- required:
- networkResources
- required:
- vnSegmentIds
properties:
networkResources:
description: >
Reference to the VN resource to be forwarded into/from the MSCS.
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
type: array
items:
$ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
vnSegmentIds:
description: >
Identifiers of the network segments of the VN resources to be forwarded into/from the MSCS.
type: object
required:
- vnSegmentIdValue
properties:
vnSegmentIdValue:
description: >
Identifier of the network segment.
type: string
vnSegmentIdUpperRange:
description: >
Identifier of the upper range network segment, in case the "vnSegmentIds" is used to define a range.
type: string
SiteToWanLayer3ProtocolData:
description: >
This type provides information about Layer 3 protocol specific information for the stitching of the intra-site VN
to the multi-site connectivity service over the WAN. It shall comply with the provisions defined in Table 6.5.3.86-1.
type: object
required:
- routingInfo
properties:
logicalInterfaceIpAddress:
description: >
IP addressing information associated to a logical interface. Shall be present if the "interfaceType" of the
SiteToWanLayer2ProtocolData is equal to "LOGICAL".
type: object
required:
- ipAddress
- associatedSegmentId
properties:
ipAddress:
description: >
The IP address to be assigned to the interface.
$ref: "#/definitions/IpAddress"
associatedSegmentId:
description: >
The associated segment identifier that has triggered the creation of the logical interface.
The value shall be one of the values listed in the "wanSegmentIds" of the "siteToWanLayer2ProtocolData".
type: string
routingInfo:
description: >
The routing information that is activated on the connectivity service endpoint. More than one "routingInfo" is
allowed to enable stacking different routing protocols (e.g., one routing protocol for IPv4 and another one for IPv6).
type: object
required:
- routingProtocol
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
properties:
routingProtocol:
description: >
The routing protocol that is activated on the connectivity service endpoint.
Permitted values:
- BGP: used for dynamic routing BGPv4.
- RIP: used for dynamic routing RIPv2.
- OSPF: used for dynamic routing (OSPF version 2 for IPv4; and OSPF version 3 for IPv6).
- STATIC: used for static routing.
- DIRECT: used when the NFVI-PoP network is directly connected to the WAN provider network.
- VRRP: used when the NFVI-PoP network is directly connected to the WAN provider network with virtual
router redundancy protocol support (VRRP).
type: string
enum:
- BGP
- RIP
- OSPF
- STATIC
- DIRECT
- VRRP
staticRouting:
description: >
Defines a static route. It shall only be present if the routingProtocol="STATIC".
type: object
required:
- ipVersion
- ipPrefix
- prefixSize
- nextHop
properties:
ipVersion:
description: >
The IP version applicable to the routing entry.
Permitted values:
- IPV4
- IPV6
type: string
enum:
- IPV4
- IPV6
ipPrefix:
description: >
The IP network prefix.
$ref: '#/definitions/IpAddress'
prefixSize:
description: >
The IP prefix size.
type: number
nextHop:
description: >
The next hop’s IP address.
$ref: '#/definitions/IpAddress'
routingAddressFamily:
description: >
The IP version applicable to the dynamic routing protocol. Shall be present for dynamic routing protocols.
Permitted values:
- IPV4
- IPV6
type: string
enum:
- IPV4
- IPv6
ospfRouting:
description: >
Defines parameters for OSPF routing. It shall only be present if the routingProtocol="OSPF".
type: object
required:
- areaId
properties:
areaId:
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
The routing area identifier, e.g., a number or an IP address.
type: string
bgpRouting:
description: >
Defines parameters for BGP routing. It shall only be present if the routingProtocol="BGP".
type: object
required:
- bgpAs
properties:
bgpAs:
description: >
The Autonomous System (AS) identification applicable to the BGP routing info entry.
type: object
bgpNeighbour:
description: >
The IP address of the BGP neighbour.
$ref: '#/definitions/IpAddress'
bgpAdditionalParam:
description: >
Additional parameters for setting up the BGP neighbour, such as information about the remote AS.
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
routeMapsDistribution:
description: >
Maps of routes that are permitted or denied for redistribution.
type: object
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
required:
- policy
- sequence
- matchAndSetRule
properties:
policy:
description: >
The policy to apply to the route distribution.
Permitted values:
- PERMIT
- DENY
type: string
enum:
- PERMIT
- DENY
sequence:
description: >
Sequence or index number assigned to the route-map.
type: number
matchAndSetRule:
description: >
Set of "match" and "set" rules for the distribution of routing information. "Match" key entries define
the routes that are selected. "Set" key entries define what information to modify when distributing the
routing information.
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
mtuL3:
description: >
Maximum Transmission Unit (MTU) that can be forwarded at layer 3 (in bytes). Default value is "1500" (bytes).
type: number
virtualRoutingAndForwarding:
description: >
Configuration related to the virtual routing and forwarding (VRF).
type: object
required:
- vrfName
properties:
vrfName:
description: >
Name (or identifier) of the VRF instance.
type: string
bfdConfig:
description: >
Configuration related to bidirectional forwarding detection (BFD).
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
MscsConfigData:
description: >
This type provides configuration data for the creation of an MSCS. It shall comply with the provisions defined in
Table 6.5.3.87-1.
type: object
required:
- mscsType
properties:
mscsType:
description: >
The type of connectivity that is requested to be provided to the virtualized networks in the NFVI-PoP and
characterizes the connectivity service across the WAN.
Permitted values:
type: string
enum:
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
siteAccessProtectionSchemes:
description: >
Information to determine the proper MSCS endpoints configuration to fulfil certain resiliency/protection
requirements, e.g., by considering certain availability and redundancy of connectivity service endpoints in
between NFVI-PoP and WAN.
type: array
items:
type: object
required:
- locationConstraints
- protectionScheme
properties:
locationConstraints:
description: >
Defines the location constraints according to an NFVI-PoP (site).
$ref: '#/definitions/LocationConstraints'
protectionScheme:
description: >
Defines the protection scheme.
Permitted values:
- UNPROTECTED
- ONE_TO_ONE
- ONE_PLUS_ONE
- ONE_TO_N
type: string
enum:
- UNPROTECTED
- ONE_TO_ONE
- ONE_PLUS_ONE
- ONE_TO_N
mtuMscs:
description: >
Maximum Transmission Unit (MTU) that can be forwarded over the MSCS (in bytes). Default value is "1500" (bytes).
type: number
wanLayer2ProtocolData:
description: >
Layer 2 protocol specific information for the configuration of the multi-site connectivity service over the WAN.
$ref: '#/definitions/WanLayer2ProtocolData'
wanLayer3ProtocolData:
description: >
Layer 3 protocol specific information for the configuration of the multi-site connectivity service over the WAN.
$ref: '#/definitions/WanLayer3ProtocolData'
WanLayer2ProtocolData:
description: >
This type provides information about Layer 2 protocol specific information for the configuration of the MSCS over
the WAN. It shall comply with the provisions defined in Table 6.5.3.88-1.
type: object
required:
- isSegmentPreservation
- isSegmentCosPreservation
properties:
mscsLayer2Protocol:
description: >
Type of underlying connectivity service and protocol associated to the type of MSCS.
Permitted values are as listed below and restricted by the type of MSCS:
- EVPN_BGP_MPLS: as specified in IETF RFC 7432.
- EVPN_VPWS: as specified in IETF RFC 8214.
- VPLS_BGP: as specified in IETF RFC 4761 and IETF RFC 6624.
- VPLS_LDP_L2TP: as specified in IETF RFC 4762 and IETF RFC 6074.
- VPWS_LDP_L2TP: as specified in IETF RFC 6074.
type: string
enum:
- EVPN_BGP_MPLS
- EVPN_VPWS
- VPLS_LDP_L2TP
- VPWS_LDP_L2TP
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
isSegmentPreservation:
description: >
Indicates the requirement of whether to ensure network segment (e.g., VLAN id) preservation across the MSCS
endpoints (i.e., from/to the NFVI-PoPs). If "TRUE", segment identifiers shall be preserved, "FALSE" otherwise.
Default value is "FALSE".
type: boolean
isSegmentCosPreservation:
description: >
Indicates the requirement of whether to ensure network segment class of service preservation across the MSCS
endpoints (i.e., from/to the NFVI-PoPs). If "TRUE", segment class of service shall be preserved, "FALSE" otherwise.
Default value is "FALSE".
type: boolean
WanLayer3ProtocolData:
description: >
Type of underlying connectivity service and protocol associated to the type of MSCS.
Permitted values are as listed below and restricted by the type of MSCS:
- BGP_IP_VPN: BGP/MPLS based IP VPN as specified in IETF RFC 4364.
type: string
enum:
- BGP_IP_VPN
ModifyWanConnectionInfoData:
description: >
This type represents attribute modifications for WAN connection information. The attributes of the "WanConnectionInfo"
that can be modified according to the provisions of the "UpdateNsRequest" in clause 6.5.2.12 related to WAN connection
information are included in the "ModifyWanConnectionInfoData" data type. It shall comply with the provisions defined
in table 6.5.3.92-1.
type: object
required:
- wanConnectionInfoId
properties:
wanConnectionInfoId:
description: >
Identifier of the WAN connection information to modify.
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
mscsName:
description: >
New value of the "mscsName" attribute in "MscsInfo", or "null" to remove the attribute.
type: string
mscsDescription:
description: >
New value of the "mscsDescription" attribute in "MscsInfo", or "null" to remove the attribute.
type: string
mscsEndpoints:
description: >
New content of certain entries of MSCS endpoints in the "mscsEndpoints" attribute in "MscsInfo",
as defined below this table.
type: array
items:
$ref: "#/definitions/MscsEndpointInfo"
removeMscsEndpointIds:
description: >
List of identifier entries to be deleted from the "mscsEndpoints" attribute array in "MscsInfo", to be used
as "deleteIdList" as defined below this table.
type: array
items:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
connectivityServiceEndpoints:
description: >
New content of certain entries of connectivity service endpoints in the "connectivityServiceEndpointInfos"
attribute in "WanConnectionProtocolInfo", as defined below this table.
type: array
items:
$ref: "#/definitions/ConnectivityServiceEndpointInfo"
removeConnectivityServiceEndpoints:
description: >
List of identifier entries to be deleted from the "connectivityServiceEndpointInfos" attribute array in
"WanConnectionProtocolInfo", to be used as "deleteIdList" as defined below this table.
type: array
items:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
WanConnectionInfoModification :
description: >
This type represents attribute modifications that were performed on WAN connection information.
The attributes that can be included consist of those requested to be modified explicitly with the "UpdateNsRequest"
data structure. It shall comply with the provisions defined in table 6.5.3.93-1.
type: object
required:
- wanConnectionInfoId
properties:
wanConnectionInfoId:
description: >
Identifier of the WAN connection information that has been modified.
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
mscsName:
description: >
If present, this attribute signals modifications of the "mscsName" attribute in "MscsInfo" as defined in
clause 6.5.3.82.
type: string
mscsDescription:
description: >
If present, this attribute signals modifications of the "mscsDescription" attribute in "MscsInfo" as defined
in clause 6.5.3.82.
type: string
mscsEndpoints:
description: >
If present, this attribute signals modifications of certain entries in the "mscsEndpoints" attribute array in
"MscsInfo", as defined in clause 6.5.3.82.
type: array
items:
$ref: "#/definitions/MscsEndpointInfo"
removeMscsEndpointIds:
description: >
If present, this attribute signals the deletion of certain entries in the "mscsEndpoints" attribute array in
"MscsInfo", as defined in clause 6.5.3.82.
type: array
items:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
connectivityServiceEndpoints:
description: >
If present, this attribute signals modifications of certain entries in the "connectivityServiceEndpoints"
attribute array in "WanConnectionProtocolInfo", as defined in clause 6.5.3.91.
type: array
items:
$ref: "#/definitions/ConnectivityServiceEndpointInfo"
removeConnectivityServiceEndpoints:
description: >
If present, this attribute signals the deletion of certain entries in the "connectivityServiceEndpoints"
attribute array in "WanConnectionProtocolInfo", as defined in clause 6.5.3.91.
type: array
items:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
AddNsVirtualLinkData:
description: >
This type specifies the parameters used for the creation of a new NsVirtualLink instance.
It shall comply with the provisions defined in table 6.5.3.95-1.
NOTE: All NsVirtualLink instances of a particular NS DF based on a specific "NsVirtualLinkDesc"
have the same characteristics as they use the same "VirtualLinkProfile".
type: object
required:
- nsVirtualLinkProfileId
properties:
nsVirtualLinkProfileId:
description: >
Identifier of the virtual link profile to be used to create a new NsVirtualLink instance.
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
NestedNsLocationConstraint:
description: >
This type represents the association of location constraints to a nested NS instance to be created according to a
specific NS profile. It shall comply with the provisions defined in Table 6.5.3.96-1.
NOTE: These constraints are typically determined by the OSS/BSS from service requirements (e.g. latency requirements,
regulatory requirements). The NFVO can map such location constraints to eligible NFVI-PoPs/resource zones where
the VNF instances as part of the nested NS are to be created.
type: object
required:
- nsProfileId
- locationConstraints
properties:
nsProfileId:
description: >
Identifier of an NsProfile defined in the NSD which the existing nested NS instance shall be matched with.
$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNs"
locationConstraints:
description: >
Defines the location constraints for the nested NS instance to be created based on the NS profile.
$ref: "#/definitions/LocationConstraints"
LcmOpOccNotificationVerbosityType:
description: >
The enumeration LcmOpOccNotificationVerbosityType provides values to control the verbosity of LCM operation
occurrence notifications. It shall comply with the provisions defined in table 6.5.4.11-1.
* 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
TerminateVnfData:
description: >
This type represents the information to terminate a VNF that is part of an NS.
NOTE: If the VNF is still in service, requesting forceful termination can adversely impact network service.
type: object
required:
- vnfInstanceId
properties:
vnfInstanceId:
description: >
Identifies the VNF instance, part of the NS, to be terminated.
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
terminationType:
description: >
Indicates whether forceful or graceful termination is requested.
Permitted values:
- FORCEFUL
- GRACEFUL
type: string
enum:
- FORCEFUL
- GRACEFUL
gracefulTerminationTimeout:
description: >
The 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.
type: integer
additionalParams:
description: >
Additional parameters passed by the OSS/BSS as input to the termination process, specific to the VNF being terminated.
EXAMPLE: Input parameters to VNF-specific termination procedures.
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
TerminateNsData:
type: object
properties:
additionalParamsforNs:
description: >
Allows the OSS/BSS to provide additional parameter(s) to the termination process at the NS level.
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
VipCpInfo:
description: >
This type provides information related to virtual IP (VIP) CP. It shall comply with the provisions
defined in table 6.5.3.97 1.
NOTE: It is possible that there is no associated VnfcCp because the VIP CP is available
but not associated yet.
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
type: object
required:
- cpInstanceId
- cpdId
properties:
cpInstanceId:
description: >
Identifier of this VIP CP instance and of this VipCpInfo information element.
$ref: "#/definitions/IdentifierInVnf"
cpdId:
description: >
Identifier of the VIP Connection Point Descriptor, VipCpd, in the VNFD.
$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
vnfExtCpId:
description: >
When the VIP CP is exposed as external CP of the VNF, the identifier of this external VNF CP instance.
$ref: "#/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 addresse allocated to the VIP CP instance. See note.
type: array
items:
$ref: "#/definitions/IdentifierInVnf"
vnfLinkPortId:
description: >
Identifier of the "VnfLinkPortInfo" structure in the "VnfVirtualLinkResourceInfo" or "ExtManagedVirtual-Link¬Info" structure.
Shall be present if the CP is associated to a link port on an internal VL (including externally-managed internal VL).
$ref: "#/definitions/IdentifierInVnf"
metadata:
description: >
Allows the OSS/BSS to provide additional parameter(s) to the termination process at the NS level.
type: array
items:
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"