Newer
Older
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/LcmOperationType"
isAutomaticInvocation:
description: >
Set to true if this VNF LCM operation occurrence has been triggered
by an automated procedure inside the VNFM (i.e.
ScaleVnf / ScaleVnfToLevel triggered by auto-scale, or HealVnf
triggered by auto-heal). Set to false otherwise.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Boolean"
operationParams:
description: >
Input parameters of the LCM operation. This attribute shall be
formatted according to the request data type of the related LCM
operation. In addition, the provisions in clause 5.7 shall apply.
The following mapping between operationType and the
data type of this attribute shall apply:
* INSTANTIATE: InstantiateVnfRequest
* SCALE: ScaleVnfRequest
* SCALE_TO_LEVEL: ScaleVnfToLevelRequest
* CHANGE_FLAVOUR: ChangeVnfFlavourRequest
* OPERATE: OperateVnfRequest
* HEAL: HealVnfRequest
* CHANGE_EXT_CONN: ChangeExtVnfConnectivityRequest
* TERMINATE: TerminateVnfRequest
* MODIFY_INFO: VnfInfoModifications
* CREATE_SNAPSHOT: CreateVnfSnapshotRequest
* REVERT_TO_SNAPSHOT: RevertToVnfSnapshotRequest
* CHANGE_VNFPKG: ChangeCurrentVnfPkgRequest
* SELECT_DEPL_MODS: SelectVnfDeployableModulesRequest
type: object
isCancelPending:
description: >
If the VNF LCM operation occurrence is in "STARTING", "PROCESSING"
or "ROLLING_BACK" state and the operation is being cancelled, this
attribute shall be set to true. Otherwise, it shall be set to false.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Boolean"
cancelMode:
description: >
The mode of an ongoing cancellation. Shall be present when
isCancelPending=true, and shall be absent otherwise.
$ref: "#/definitions/CancelModeType"
error:
description: >
If "operationState" is "FAILED_TEMP" or "FAILED" or "operationState"
is "PROCESSING" or "ROLLING_BACK" and previous value of
"operationState" was "FAILED_TEMP", this attribute shall be present
and contain error information, unless it has been requested to be
excluded via an attribute selector.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/ProblemDetails"
resourceChanges:
description: >
This attribute contains information about the cumulative changes to
virtualised resources that were performed so far by the LCM
operation since its start, if applicable.
type: object
properties:
affectedVnfcs:
description: >
Information about VNFC instances that were affected during the lifecycle operation.
See note 1.
type: array
items:
$ref: "#/definitions/AffectedVnfc"
affectedVirtualLinks:
description: >
Information about VL instances that were affected during the lifecycle operation.
See notes 1 and 3.
type: array
items:
$ref: "#/definitions/AffectedVirtualLink"
affectedExtLinkPorts:
description: >
Information about external VNF link ports that were affected during the lifecycle operation.
See note 1.
$ref: "#/definitions/AffectedExtLinkPort"
Information about virtualised storage instances that were affected during the lifecycle operation.
See note 1.
type: array
items:
$ref: "#/definitions/AffectedVirtualStorage"
changedInfo:
description: >
Information about the changed VNF instance information, including VNF configurable properties,
if applicable. See note 1 and note 2.
$ref: "#/definitions/VnfInfoModifications"
piscione
committed
affectedVipCps:
description: >
Information about virtual IP CP instances that were affected during
the execution of the lifecycle management operation.
type: array
items:
$ref: "#/definitions/AffectedVipCp"
Information about changed external connectivity, if applicable. See note 1.
$ref: "#/definitions/ExtVirtualLinkInfo"
modificationsTriggeredByVnfPkgChange:
description: >
Information about performed changes of "VnfInstance" attributes triggered by changing the current VNF package,
if applicable. Shall be absent if the "operation" attribute is different from "CHANGE_VNFPKG".
See notes 1 and 2.
$ref: "#/definitions/ModificationsTriggeredByVnfPkgChange"
vnfSnapshotInfoId:
description: >
Identifier of the "individual VNF snapshot" resource. Shall be present if applicable to the type of LCM operation,
i.e., if the value of the "operation" attribute is either "CREATE_SNAPSHOT" or "REVERT_TO_SNAPSHOT".
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
piscione
committed
lcmCoordinations:
description: >
Information about LCM coordination actions (see clause 10 in ETSI GS NFV-SOL002) related to this LCM operation occurrence.
type: array
items:
type: object
required:
- id
- coordinationActionName
- startTime
- endpointType
properties:
id:
description: >
Identifier of this coordination action.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
piscione
committed
coordinationActionName:
description: >
Indicator of the actual coordination action.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
piscione
committed
coordinationResult:
description: >
The result of executing the coordination action which also implies the action to be performed by the VNFM as
the result of this coordination.
Shall be present if the coordination has been finished. Shall be absent if the coordination is ongoing or has
timed out (see note 4).
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/LcmCoordResultType"
piscione
committed
startTime:
description: >
The time when the VNFM has received the confirmation that the coordination action has been started.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/DateTime"
piscione
committed
endTime:
description: >
The time when the VNFM has received the confirmation that the coordination action has finished or has been
cancelled, or the time when a coordination action has timed out. Shall be present for a coordination
action that has finished or timed out (see note 4) and shall be absent if the coordination is ongoing.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/DateTime"
delay:
description: >
The end of the delay period.
This attribute shall be present if the last known HTTP response related to this coordination has
contained a "Retry-After" header, and shall be absent otherwise.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/DateTime"
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
endpointType:
description: >
The endpoint type used by this coordination action.
Valid values:
• MGMT: coordination with other operation supporting management systems (e.g. EM)
• VNF: coordination with the VNF instance
type: string
enum:
- MGMT
- VNF
rejectedLcmCoordinations:
description: >
Information about LCM coordination actions (see clause 10 in ETSI GS NFV-SOL002) that were rejected
by 503 error which means they can be tried again after a delay. See note 5.
type: array
items:
type: object
required:
- coordinationActionName
- rejectionTime
- endpointType
- delay
properties:
coordinationActionName:
description: >
Indicator of the actual coordination action.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
rejectionTime:
description: >
The time when the VNFM has received the 503 response that rejects the actual coordination.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/DateTime"
delay:
description: >
The end of the delay period, as calculated from the startTime and "Retry-After" header.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/DateTime"
piscione
committed
endpointType:
description: >
The endpoint type used by this coordination action.
Valid values:
• MGMT: coordination with other operation supporting management systems (e.g. EM)
• VNF: coordination with the VNF instance
type: string
enum:
- MGMT
- VNF
warnings:
description: >
Warning messages that were generated while the operation was executing.
If the operation has included LCM coordination actions and these have resulted
in warnings, such warnings should be added to this attribute.
type: array
items:
type: string
_links:
description: >
Links to resources related to this resource.
type: object
required:
- self
- vnfInstance
properties:
self:
description: >
URI of this resource.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Link"
vnfInstance:
description: >
Link to the VNF instance that the operation applies to.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Link"
grant:
description: >
Link to the grant for this operation, if one exists.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Link"
cancel:
description: >
Link to the task resource that represents the "cancel" operation
for this VNF LCM operation occurrence, if cancelling is
currently allowed.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Link"
retry:
description: >
Link to the task resource that represents the "retry" operation
for this VNF LCM operation occurrence, if retrying is currently
allowed.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Link"
rollback:
description: >
Link to the task resource that represents the "rollback"
operation for this VNF LCM operation occurrence, if rolling back
is currently allowed.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Link"
fail:
description: >
Link to the task resource that represents the "fail" operation
for this VNF LCM operation occurrence, if declaring as failed is
currently allowed.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Link"
vnfSnapshot:
description: >
Link to the VNF snapshot resource, if the VNF LCM operation occurrence is related to a VNF snapshot.
Shall be present if operation="CREATE_SNAPSHOT" or operation="REVERT_TO_SNAPSHOT".
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Link"
AffectedExtLinkPort:
description: >
This type provides information about added and deleted external link ports (link ports attached to external virtual links).
NOTE: The "resourceDefinitionId" attribute provides information to the API consumer (i.e. the NFVO) to assist in correlating
the resource changes performed during the LCM operation with the granted resources in a specific Grant exchange, which
is identified by the "grantId" available in the "Individual VNF lifecycle management operation occurrence" and the "id"
in the "Individual Grant".
type: object
required:
- id
- changeType
- extCpInstanceId
- resourceHandle
properties:
id:
description: >
Identifier of the link port, identifying the applicable "extLinkPorts" entry in the "ExtVirtualLinkInfo" data
type (see clause 5.5.3.2).
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
changeType:
description: >
Signals the type of change.
Permitted values:
- ADDED
- REMOVED
type: string
enum:
- ADDED
- REMOVED
extCpInstanceId:
description: >
Identifier of the related external CP instance.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
resourceHandle:
description: >
Reference to the link port resource.
Detailed information is (for added resources) or has been (for removed resources) available from the VIM.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/ResourceHandle"
resourceDefinitionId:
description: >
The identifier of the "ResourceDefinition" in the granting exchange related to the LCM operation occurrence.
It shall be present when an applicable GrantInfo for the granted resource exists. See note.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierLocal"
VnfLcmOperationOccurrenceNotification:
description: >
This type represents a VNF lifecycle management operation occurrence notification, which
informs the receiver of changes in the VNF lifecycle caused by a VNF LCM operation occurrence.
The support of the notification is mandatory.
This notification shall be triggered by the VNFM when there is a change in the state of a VNF LCM
operation occurrence that changes the VNF lifecycle, which represents an occurrence of one the
following LCM operations:
- Instantiation of the VNF
- Scaling of the VNF instance (including auto-scaling)
- Healing of the VNF instance (including auto-healing)
- Change of the state of the VNF instance (i.e. Operate VNF)
- Change of the deployment flavour of the VNF instance
- Change of the external connectivity of the VNF instance
- Change of the current VNF package
- Selection of deployable modules of the VNF instance
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
- Termination of the VNF instance
- Modification of VNF instance information and/or VNF configurable properties through the "PATCH"
method on the "Individual VNF instance" resource
- Creation of a VNF snapshot
- Reversion of the VNF instance to a VNF snapshot
Clause 5.6.2 defines the states and state transition of a VNF LCM operation occurrence, and also
specifies details of the notifications to be emitted at each state transition.
If this is the initial notification about the start of a VNF LCM operation occurrence, it is assumed
that the notification is sent by the VNFM before any action (including sending the grant request) is
taken as part of the LCM operation. Due to possible race conditions, the "start" notification, the grant
request and the LCM operation acknowledgment (i.e. the "202 Accepted" response) can arrive in any order
at the NFVO, and the NFVO shall be able to handle such a situation.
If this is a notification about a final or intermediate result state of a VNF LCM operation occurrence,
the notification shall be sent after all related actions of the LCM operation that led to this state have
been executed.
The new state shall be set in the "Individual VNF LCM operation occurrence" resource before the notification
about the state change is sent.
The amount of information provided in the LCM operation occurrence notifications to be issued by the VNFM when
a particular subscription matches can be controlled by the API consumer using the "verbosity" attribute in the
subscription request (see clause 5.5.2.15). The "verbosity" setting in a particular individual subscription shall
only apply to the LCM operation occurrence notifications triggered by that subscription. However, it shall not
affect the amount of information in the "VnfLcmOpOcc" structure (see clause 5.5.2.13) which represents the "Individual
LCM operation occurrence" resource associated with each of the notifications.
See clause 5.6.2.2 for further provisions regarding sending this notification, including in cases of handling LCM
operation errors.
NOTE 1: Shall be present if the "notificationStatus" is set to "RESULT", the "verbosity" attribute is set to "FULL"
and the operation has performed any resource modification. Shall be absent otherwise. This attribute contains
information about the cumulative changes to virtualised resources that were performed so far by the VNF LCM
operation occurrence and by any of the error handling procedures for that operation occurrence.
NOTE 2: For a particular affected VL, there shall be as many "AffectedVirtualLink" entries as needed for signalling
the different types of changes, i.e. one per virtual link and change type. For instance, in the case of signaling
affected VL instances involving the addition of a particular VL instance with links ports, one "AffectedVirtualLink"
entry signals the addition of the VL by using the "changeType" attribute of "AffectedVirtualLink" structure equal to
"ADDED", and another "AffectedVirtualLink" entry signals the addition of externally visible VNF link ports of the VL
by using the "changeType" equal to "LINK_PORT_ADDED".
Note 3: Not more than one of changedInfo and modificationsTriggeredByVnfPkgChange shall be present.
type: object
required:
- id
- notificationType
- subscriptionId
- timeStamp
- notificationStatus
- operationState
- vnfInstanceId
- operation
- isAutomaticInvocation
- vnfLcmOpOccId
- _links
properties:
id:
description: >
Identifier of this notification. If a notification is sent multiple
times due to multiple subscriptions, the "id" attribute of all these
notifications shall have the same value.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
notificationType:
description: >
Discriminator for the different notification types. Shall be set to
"VnfLcmOperationOccurrenceNotification" for this notification type.
type: string
enum:
- VnfLcmOperationOccurrenceNotification
subscriptionId:
description: >
Identifier of the subscription that this notification relates to.Shall be set to the value of the "id" attribute
of the "LccnSubscription" representing the associated "Individual subscription" resource.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
timeStamp:
description: >
Date-time of the generation of the notification.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/DateTime"
notificationStatus:
description: >
Indicates whether this notification reports about the start of a
lifecycle operation or the result of a lifecycle operation.
Permitted values:
* START: Informs about the start of the VNF LCM operation
occurrence.
* RESULT: Informs about the final or intermediate result of the VNF
LCM operation occurrence.
type: string
enum:
- START
- RESULT
operationState:
description: >
The state of the VNF LCM operation occurrence.
$ref: "#/definitions/LcmOperationStateType"
vnfInstanceId:
description: >
The identifier of the VNF instance affected.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
operation:
description: >
The lifecycle management operation.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/LcmOperationType"
isAutomaticInvocation:
description: >
Set to true if this VNF LCM operation occurrence has been triggered
by an automated procedure inside the VNFM
(i.e. ScaleVnf / ScaleVnfToLevel triggered by auto-scale, or HealVnf
triggered by auto-heal).
Set to false otherwise.
type: boolean
verbosity:
description: >
This attribute signals the verbosity of the notification. If it is not present, it shall default to the value "FULL".
If the value is "SHORT", full change details can be obtained by performing a GET request on the "Individual LCM
operation occurrence" resource that is signalled by the "vnfLcmOpOcc" child attribute of the "_links" attribute.
$ref: '#/definitions/LcmOpOccNotificationVerbosityType'
vnfLcmOpOccId:
description: >
The identifier of the VNF lifecycle management operation occurrence associated to the notification. Shall be
set to the value of the "id" attribute of the "VnfLcmOpOcc" representing the associate "Individual VNF lifecycle
management operation occurrence" resource.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
Information about VNFC instances that were affected during the lifecycle operation. See note 1.
type: array
items:
$ref: "#/definitions/AffectedVnfc"
affectedVirtualLinks:
description: >
Information about VL instances that were affected during the lifecycle operation. See note 1 and note 2.
type: array
items:
$ref: "#/definitions/AffectedVirtualLink"
affectedExtLinkPorts:
description: >
Information about external VNF link ports that were affected during the lifecycle operation. See note 1.
$ref: "#/definitions/AffectedExtLinkPort"
Information about virtualised storage instances that were affected during the lifecycle operation. See note 1.
type: array
items:
$ref: "#/definitions/AffectedVirtualStorage"
changedInfo:
description: >
Information about the changed VNF instance information, including
changed VNF configurable properties.
Shall be present if the "notificationStatus" is set to "RESULT",
the "operation" attribute is not equal to "CHANGE_VNFPKG", the
"verbosity" attribute is set to "FULL" and the operation has performed
any changes to VNF instance information, including VNF configurable
properties. Shall be absent otherwise. See note 3.
$ref: "#/definitions/VnfInfoModifications"
piscione
committed
affectedVipCps:
description: >
Information about virtual IP CP instances that were affected during the execution of the lifecycle management
operation, if this notification represents the result of a lifecycle management operation occurrence.
Shall be present if the "notificationStatus" is set to "RESULT", the "verbosity" attribute is set to "FULL"
and the operation has made any changes to the VIP CP instances of the VNF instance. Shall be absent otherwise.
Only information about VIP CP instances that have been added, deleted or modified shall be provided.
type: array
items:
$ref: "#/definitions/AffectedVipCp"
affectedVirtualCps:
description:
Information about virtual CP instances that were affected during the execution of the lifecycle
management operation, if this notification represents the result of a lifecycle management operation
occurrence.
Shall be present if the "notificationStatus" is set to "RESULT", the "verbosity" attribute is set to "FULL"
and the operation has made any changes to the virtual CP instances of the VNF instance. Shall be absent
otherwise. Only information about virtual CP instances that have been added, deleted or modified shall be
provided.
type: array
items:
$ref: "#/definitions/AffectedVirtualCp"
affectedCertificates:
description: >
Information about certificate content that were affected during the execution of the lifecycle management
operation, if this notification represents the result of a lifecycle management operation occurrence.
Shall be present when using delegation mode, otherwise shall be absent.
This attribute shall be supported when delegation mode in certificate management is applicable
type: array
items:
$ref: "#/definitions/AffectedCertificate"
changedExtConnectivity:
description: >
Information about changed external connectivity, if this notification
represents the result of a lifecycle operation occurrence.
Shall be present if the "notificationStatus" is set to "RESULT",
the "verbosity" attribute is set to "FULL" and the operation has made
any changes to the external connectivity of the VNF instance. Shall be
absent otherwise. Only information about external VL instances that
have been added or modified shall be provided.
type: array
items:
$ref: "#/definitions/ExtVirtualLinkInfo"
modificationsTriggeredByVnfPkgChange:
description: >
Information about performed changes of "VnfInstance" attributes triggered by changing the current VNF package.
Shall be present if the "notificationStatus" is set to "RESULT", the "operation" attribute is equal to
"CHANGE_VNFPKG", the "verbosity" attribute is set to "FULL" and the operation has performed any changes to
"VnfInstance" attributes. Shall be absent otherwise. See note 3.
$ref: "#/definitions/ModificationsTriggeredByVnfPkgChange"
error:
description: >
Details of the latest error, if one has occurred during executing
the LCM operation (see clause 6.3 of ETSI GS NFV-SOL 013).
Shall be present if the "operationState" attribute is "FAILED_TEMP", "FAILED"
or "ROLLED_BACK" and shall be absent otherwise.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/ProblemDetails"
_links:
description: >
Links to resources related to this notification.
The link URIs in this structure shall be set to point to the
resources identified by the corresponding identifier attributes
in this notification.
$ref: "#/definitions/LccnLinks"
AffectedVirtualLink:
description: >
This type provides information about added, deleted, modified and
temporary VLs, and added or removed VNF link ports.
NOTE 1: When signalling the addition (LINK_PORT_ADDED) or removal (LINK_PORT_REMOVED) of VNF link ports,
the "networkResource" and "resourceDefinitionId" attributes refer to the affected virtual link
instance, not the link port instance. The resource handles of the affected VNF link ports can be
found by dereferencing the identifiers in the "vnfLinkPortIds" attribute.
NOTE 2: The "resourceDefinitionId" attribute provides information to the API consumer (i.e. the NFVO) to
assist in correlating the resource changes performed during the LCM operation with the granted
resources in a specific Grant exchange, which is identified by the "grantId" available in the
"Individual VNF lifecycle management operation occurrence" and the "id" in the "Individual Grant".
type: object
required:
- id
- vnfVirtualLinkDescId
- changeType
- networkResource
properties:
id:
description: >
Identifier of the virtual link instance, identifying the applicable
"vnfVirtualLinkResourceInfo" or "extManagedVirtualLinkInfo" entry in the "VnfInstance" data type.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
vnfVirtualLinkDescId:
description: >
Identifier of the related VLD in the VNFD.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnfd"
vnfdId:
description: >
Identifier of the VNFD.
Shall be present in case of a "change current VNF Package" to identify whether the affected VL instance is
associated to a VLD which is referred from the source or destination VNFD.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
Signals the type of change.
Permitted values:
- ADDED
- REMOVED
- MODIFIED
- TEMPORARY
- LINK_PORT_ADDED
- LINK_PORT_REMOVED
For a temporary resource, an AffectedVirtualLink structure exists as long as the temporary resource exists.
See note 1.
type: string
enum:
- ADDED
- REMOVED
- MODIFIED
- TEMPORARY
- LINK_PORT_ADDED
- LINK_PORT_REMOVED
networkResource:
description: >
Reference to the VirtualNetwork resource or reference to a Network MCIO.
Detailed information is (for new and modified resources) or has been (for removed resources)
available from the VIM or the CISM.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/ResourceHandle"
Identifiers of the link ports of the affected VL related to the change. Each identifier references
a "VnfLinkPortInfo" structure.
Shall be set when changeType is equal to "LINK_PORT_ADDED" or "LINK_PORT_REMOVED", and the
related "VnfLinkPortInfo" structures are present (case "added") or have been present (case "removed")
in the "VnfVirtualLinkResourceInfo" or "ExtManagedVirtualLinkInfo" structures that are represented
by the "vnfVirtualLinkResource¬Info" or "extManagedVirtualLinkInfo" attribute in the "VnfInstance"
structure. See note 1.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnfd"
The identifier of the "ResourceDefinition" in the granting exchange related to the LCM operation occurrence.
It shall be present when an applicable GrantInfo for the granted resource exists. See note 1 and note 2.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierLocal"
zoneId:
description: >
The identifier of the resource zone, as managed by the resource
management layer (typically, the VIM), where the referenced VirtualNetwork
resource is placed. Shall be provided if this information is available from the VIM.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
metadata:
description: >
Metadata about this resource.
The content of this attribute shall be a copy of the content of the
"metadata" attribute of the applicable "vnfVirtualLinkResourceInfo”
structure if such structure is referenced by the "id" attribute and it has metadata.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"
AffectedVirtualStorage:
description: >
This type provides information about added, deleted, modified and temporary virtual storage resources.
NOTE: The "resourceDefinitionId" attribute provides information to the API consumer (i.e. the NFVO) to
assist in correlating the resource changes performed during the LCM operation with the granted
resources in a specific Grant exchange, which is identified by the "grantId" available in the
"Individual VNF lifecycle management operation occurrence" and the "id" in the "Individual Grant".
type: object
required:
- id
- virtualStorageDescId
- changeType
- storageResource
properties:
id:
description: >
Identifier of the storage instance, identifying the applicable
"virtualStorageResourceInfo" entry in the "VnfInstance" data type.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
virtualStorageDescId:
description: >
Identifier of the related VirtualStorage descriptor in the VNFD.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnfd"
vnfdId:
description: >
Identifier of the VNFD.
Shall be present in case of a "change current VNF Package" to identify whether the affected virtual storage
instance is associated to a VirtualStorage descriptor which is referred from the source or destination VNFD.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
changeType:
description: >
Signals the type of change. Permitted values:
* ADDED
* REMOVED
* MODIFIED
* TEMPORARY
For a temporary resource, an AffectedVirtualStorage structure exists
as long as the temporary resource exists.
type: string
enum:
- ADDED
- REMOVED
- MODIFIED
- TEMPORARY
storageResource:
description: >
Reference to the VirtualStorage resource or reference to a Storage MCIO.
Detailed information is (for new and modified resources) or has been (for removed
resources) available from the VIM or the CISM.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/ResourceHandle"
The identifier of the "ResourceDefinition" in the granting exchange related to the LCM operation occurrence.
It shall be present when an applicable GrantInfo for the granted resource exists. See note.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierLocal"
zoneId:
description: >
The identifier of the resource zone, as managed by the resource
management layer (typically, the VIM), where the referenced VirtualNetwork
resource is placed. Shall be provided if this information is available from the VIM.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
metadata:
description: >
Metadata about this resource.
The content of this attribute shall be a copy of the content of the
"metadata" attribute of the VirtualStorageResourceInfo structure.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"
IntVnfCpData:
description: >
This type represents input information related to one or more VNF internal CP instances
created based on the same CPD.
NOTE: Cardinality greater than 1 is only applicable for specific cases where more than one network attachment
definition resource is needed to fulfil the connectivity requirements of the VNF internal CP, e.g. to build a link
redundant mated pair in SR-IOV cases. When more than one netAttDefResourceId is indicated, all shall
belong to the same namespace as defined by the corresponding "containerNamespace" attribute in the "resourceHandle" attribute
in the "NetAttDefResourceData".
type: object
required:
- cpdId
- netAttDefResourceId
properties:
cpdId:
description: >
Identifier of the CPD in the VNFD.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
netAttDefResourceId:
description: >
Identifiers of the “NetAttDefResourceData” structure that
provides the specification of the interface to attach the VNF
internal CP created from the CPD identified by cpdId to a
secondary container cluster network. See note.
type: array
items:
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
CertificateConfigurationData:
description: >
This type provides input information related to certificate management.
ETSI GS NFV-SOL 009 [i.18] specifies the means to discover the applicable certificate management mode of VNFM
and configure into the NFVO applicable certificate management mode via the "NFV-MANO Configuration and
Information Management" interface
type: object
properties:
overridingCertificateProfiles:
description: >
Overriding certificate profile. This overrides the
certificateBaseProfile provided in the VNFD, and the CA
and CMF can additionally override aspects of this
certificateBaseProfile at later point in the VNF lifecycle if
necessary to meet operator security policy.
type: array
items:
$ref: "#/definitions/CertificateBaseProfile"
securityPolicy:
description: >
Security policy to be satisfied for the certificate.
type: array
items:
$ref: "#/definitions/SecurityPolicy"
cmfData:
description: >
Information for CMF.
$ref: "#/definitions/CmfData"
SecurityPolicy:
description: >
This type provides input information related to security policy for certificate management.
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
type: object
required:
- id
properties:
id:
description: Identifier of this security policy.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
maxValidityPeriod:
description: Allowed max validity period for certificates.
type: number
allowedAlgorithm:
description: Allowed signature algorithm.
type: string
minimumKeyLength:
description: Minimum key length for certificates.
type: number
CertificateBaseProfile:
description: >
NOTE: At least one overriding attributes shall be present, otherwise shall be absent.
This type provides input information to override certificate base profile
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
type: object
required:
- id
properties:
id:
description: The identifier of this certificate profile.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
issuer:
description: Issuer of certificates. See note.
type: string
issuerUniqueIdentifier:
description: Identifier of this issuer of certificates. See note.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
subject:
description: Subject of certificates. See note.
$ref: "#/definitions/CertSubjectData"
subjectUniqueIdentifier:
description: Identifier of this subject of certificates. See note.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
basicConstraints:
description: Basic constraints of certificates. See note.
type: string
issuerAltName:
description: Alternative name of issuer of certificates in this NS. See note.
type: array
items:
type: string
subjectAltName:
description: >
Alternative name of subject of certificates. Shall be present when
this certificate is used for encrypted communication using IP
address and subjectAltName attribute of CertificateBaseProfile in
CertificateDesc of VNFD is empty (see ETSI GS NFV-IFA 011 [14],
clause 7.1.19.4). See note.
type: array
items:
type: string
nameConstraints:
description: Name constraints of certificates. See note.
type: array
items:
type: string
CmfData:
description: >
This type provides input information related to CMF for certificate
type: object
required:
- endPoint
- supportedProtocols
properties:
endPoint:
description: End point of CMF instance.
type: object
properties:
ipAddress:
description: An IP address of this end point.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IpAddress"
link:
description: A link to this end point.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Link"
supportedProtocols:
description: Supported protocols by CMF instance.
type: array
items:
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/SupportedProtocol"
CertSubjectData:
description: >
This type provides input information related to the subject of the certificate.
NOTE: At least one overriding attributes shall be present, otherwise shall be absent.
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
type: object
properties:
commonName:
description: >
Information of the certification target subject FQDN. Can be set
empty when this certificate is used for encrypted communication
using IP address. See note.
type: string
organization:
description: Information of the certification target subject Organization. See note.
type: string
country:
description: Information of the certification target subject Country. See note.
type: string
state:
description: Information of the certification target subject State. See note.
type: string
locality:
description: Information of the certification target subject Locality. See note.
type: string
emailAddress:
description: Information of the certification contact email address. See note.
type: string
CmfInfo:
description: >
This type provides input information related to CMF for certificate management.
type: object
required:
- id
- endPoint
- supportedProtocol
properties:
id:
description: Identifier of this CMF information.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
endPoint:
description: End point of CMF instance.
type: object
properties:
ipAddress:
description: An IP address of this end point.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IpAddress"
link:
description: A link to this end point.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Link"
supportedProtocol:
description: Supported protocols by CMF instance.
type: array
items:
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/SupportedProtocol"
certificateChain:
description: Certificate chain that this CMF provides.
type: array
items:
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"
AffectedCertificate:
description: >
This type provides input information about added, deleted, and modified certificate contents.
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
type: object
required:
- certificateInfoId
- changeType
properties:
certificateInfoId:
description: Identifier of certificate information.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
certificateBaseProfileId:
description: Identifier of certificate base profile.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
securityPolicyId:
description: Identifier of security policy.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
cmfInfoId:
description: Identifier of CMF information.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
certificateContentId:
description: Identifier of certificate content.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
changeType:
description: Signals the type of change.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/ChangeType"
PaasServiceInfo:
description: >
This type provides input information about a PaaS Service that is used by
a VNF instance. The PaasServiceInfo is comprised of various sets of
information. Some information comes from the VNFD, other information comes
from the PaaS Service assets provided by the NFVO to the VNFM, and other
information is provided at runtime information about the usage of the PaaS
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
type: object
required:
- id
- paasServiceId
- paasServiceType
- paasServiceRequestId
- paasServiceHandle
properties:
id:
description: Identifier of this PaaS Service Information.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
paasServiceId:
description: Identifier of the assigned PaaS Service as managed by the PaaS Services Management (PSM) function.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
paasServiceType:
description: The type of PaaS Service. The value of this attribute is expected to be matched against values of the registered PaaS Services in the PSR.
type: string
paasServiceVersion:
description: Version of the PaaS Service. It shall be present if the PaaS Service is versioned.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Version"
paasServiceRequestId:
description: Identifier of the PaaS Service request in the VNFD that maps to the assigned PaaS Service.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnfd"
paasServiceHandle:
description: A handle enabling the access and use of the PaaS Service by the VNF instance.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/PaasServiceHandle"
additionalInfo:
description: Additional information which is specific to the PaaS Service, its type, and which is available from the PaaS Service instance.
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"
CertificateInfo:
description: >
This type provides input information related to certificate and certificate management.
type: object
required:
- id
properties:
id:
description: Identifier of this certificate information.