Commit 65d4fab4 authored by Giacomo Bernini's avatar Giacomo Bernini
Browse files

merge

parents ac73107c 0b9d6e09
......@@ -126,6 +126,60 @@ definitions:
instance information is accessible as a resource.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
AlarmNotification:
description: >
This type represents an alarm notification about VNF faults.
This notification shall be triggered by the VNFM when:
* An alarm has been created.
* An alarm has been updated, e.g. if the severity of the alarm has
changed.
type: object
required:
- id
- notificationType
- subscriptionId
- timeStamp
- alarm
- _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: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
notificationType:
description: >
Discriminator for the different notification types. Shall be set to
"AlarmNotification" for this notification type.
type: string
enum:
- AlarmNotification
subscriptionId:
description: >
Identifier of the subscription that this notification relates to.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
timeStamp:
description: >
Date-time of the generation of the notification.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime"
alarm:
description: >
Information about an alarm including AlarmId, affected VNF
identifier, and FaultDetails.
$ref: "#/definitions/Alarm"
_links:
description: >
Links to resources related to this notification.
type: object
required:
- subscription
properties:
subscription:
description: >
Link to the related subscription.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/NotificationLink"
PerceivedSeverityRequest:
description: >
This type represents the escalated value of the perceived severity for an alarm.
......
......@@ -190,7 +190,7 @@ components:
content:
application/json:
schema:
$ref: ../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmNotification
$ref: ../VNFFaultManagement/definitions/SOL002VNFFaultManagement_def.yaml#/definitions/AlarmNotification
required: true
AlarmClearedNotification:
......
......@@ -3,7 +3,13 @@ openapi: 3.0.2
info:
title: SOL002 - VNF Indicator interface
description: |
SOL002 - VNF Indicator interface IMPORTANT: Please note that this file might be not aligned to the current version of the ETSI Group Specification it refers to and has not been approved by the ETSI NFV ISG. In case of discrepancies the published ETSI Group Specification takes precedence. Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis
SOL002 - VNF Indicator interface
IMPORTANT: Please note that this file might be not aligned to the current version of the ETSI Group Specification it
refers to and has not been approved by the ETSI NFV ISG. In case of discrepancies the published ETSI Group Specification
takes precedence.
Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis
contact:
name: NFV-SOL WG
license:
......
openapi: 3.0.2
info:
title: SOL002 - VNF Indicator Notification Endpoint interface
title: SOL002 - VNF Indicator Notification interface
description: |
SOL002 - VNF Indicator Notification Endpoint interface IMPORTANT: Please note that this file might be not aligned to
SOL002 - VNF Indicator Notification interface
IMPORTANT: Please note that this file might be not aligned to
the current version of the ETSI Group Specification it refers to and has not been approved by the ETSI NFV ISG.
In case of discrepancies the published ETSI Group Specification takes precedence. Please report bugs to
https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis
In case of discrepancies the published ETSI Group Specification takes precedence.
Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis
contact:
name: NFV-SOL WG
license:
......
......@@ -1925,7 +1925,7 @@ components:
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc"
$ref: ./definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc
IndividualVnfLcmOpOcc.Get:
description: |
......@@ -1956,7 +1956,7 @@ components:
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc"
$ref: ./definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc
VnfLcmOpOccRetry.Post:
description: |
......@@ -2031,7 +2031,7 @@ components:
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc"
$ref: ./definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc
VnfLcmOpOccCancel.Post:
description: |
......
......@@ -924,14 +924,6 @@ definitions:
The identifier of the resource in the scope of the VIM or the
resource provider.
$ref: "../../../definitions/SOL002SOL003_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/SOL002SOL003_def.yaml#/definitions/VnfLinkPortData"
ExtManagedVirtualLinkInfo:
type: object
......@@ -1195,12 +1187,6 @@ definitions:
(for new and modified resources) or has been (for removed
resources) available from the VIM.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ResourceHandle"
resourceDefinitionId:
description: >
The identifier of the "ResourceDefinition" in the granting exchange
related to the LCM operation occurrence. It shall be present when
an applicable GrantInfo for thegranted resource exists. See note.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierLocal"
metadata:
description: >
Metadata about this resource.
......@@ -1371,4 +1357,355 @@ definitions:
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: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
\ No newline at end of file
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
VnfLcmOpOcc:
description: >
This type represents a VNF lifecycle management operation occurrence. Shall be set to the value of the "id"
attribute in the "Grant" representing the associated "Individual Grant", if such grant exists.
type: object
oneOf:
- required:
- changedInfo
- required:
- modificationsTriggeredByVnfPkgChange
required:
- id
- operationState
- stateEnteredTime
- startTime
- vnfInstanceId
- operation
- isAutomaticInvocation
- isCancelPending
properties:
id:
description: >
Identifier of this VNF lifecycle management operation occurrence.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
operationState:
description: >
The state of the LCM operation.
$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LcmOperationStateType"
stateEnteredTime:
description: >
Date-time when the current state has been entered.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime"
startTime:
description: >
Date-time of the start of the operation.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime"
vnfInstanceId:
description: >
Identifier of the VNF instance to which the operation applies
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
grantId:
description: >
Identifier of the grant related to this VNF LCM operation
occurrence. Shall be set to the value of the "id" attribute
in the "Grant" representing the associated "Individual Grant",
if such grant exists.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
operation:
description: >
Type of the actual LCM operation represented by this VNF LCM
operation occurrence.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/LcmOperationType"
isAutomaticInvocation:
description: >
Set to true if this VNF LCM operation occurrence has been triggered
by an automated procedure inside the VNFM (i.e.
ScaleVnf / ScaleVnfToLevel triggered by auto-scale, or HealVnf
triggered by auto-heal). Set to false otherwise.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Boolean"
operationParams:
description: >
Input parameters of the LCM operation. This attribute shall be
formatted according to the request data type of the related LCM
operation. The following mapping between operationType and the
data type of this attribute shall apply:
* INSTANTIATE: InstantiateVnfRequest
* SCALE: ScaleVnfRequest
* SCALE_TO_LEVEL: ScaleVnfToLevelRequest
* CHANGE_FLAVOUR: ChangeVnfFlavourRequest
* OPERATE: OperateVnfRequest
* HEAL: HealVnfRequest
* CHANGE_EXT_CONN: ChangeExtVnfConnectivityRequest
* TERMINATE: TerminateVnfRequest
* MODIFY_INFO: VnfInfoModifications
* CREATE_SNAPSHOT: CreateVnfSnapshotRequest
* REVERT_TO_SNAPSHOT: RevertToVnfSnapshotRequest
* CHANGE_VNFPKG: ChangeCurrentVnfPkgRequest
type: object
isCancelPending:
description: >
If the VNF LCM operation occurrence is in "STARTING", "PROCESSING"
or "ROLLING_BACK" state and the operation is being cancelled, this
attribute shall be set to true. Otherwise, it shall be set to false.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Boolean"
cancelMode:
description: >
The mode of an ongoing cancellation. Shall be present when
isCancelPending=true, and shall be absent otherwise.
$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/CancelModeType"
error:
description: >
If "operationState" is "FAILED_TEMP" or "FAILED" or "operationState"
is "PROCESSING" or "ROLLING_BACK" and previous value of
"operationState" was "FAILED_TEMP", this attribute shall be present
and contain error information, unless it has been requested to be
excluded via an attribute selector.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
resourceChanges:
description: >
This attribute contains information about the cumulative changes to
virtualised resources that were performed so far by the LCM
operation since its start, if applicable.
type: object
properties:
affectedVnfcs:
description: >
Information about VNFC instances that were affected during the
lifecycle operation.
This allows the API consumer to obtain the information contained in
the latest "result" notification if it has not received it due to an
error or a wrongly configured subscription filter.
type: array
items:
$ref: "#/definitions/AffectedVnfc"
affectedVirtualLinks:
description: >
Information about VL instances that were affected during the
lifecycle operation.
This allows the API consumer to obtain the information contained in
the latest "result" notification if it has not received it due to an
error or a wrongly configured subscription filter.
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 VNF link ports of the VL by using the "changeType" equal to
"LINK_PORT_ADDED".
type: array
items:
$ref: "#/definitions/AffectedVirtualLink"
affectedExtLinkPorts:
description: >
Information about external VNF link ports that were affected during the lifecycle operation. This allows
the API consumer to obtain the information contained in the latest "result" notification if it has not
received it due to an error or a wrongly configured subscription filter.
type: array
items:
$ref: "#/definitions/AffectedExtLinkPort"
affectedVirtualStorages:
description: >
Information about virtualised storage instances that were affected
during the lifecycle operation.
This allows the API consumer to obtain the information contained
in the latest "result" notification if it has not received it due to
an error or a wrongly configured subscription filter.
type: array
items:
$ref: "#/definitions/AffectedVirtualStorage"
changedInfo:
description: >
Information about the changed VNF instance information, including
VNF configurable properties, if applicable.
This allows the NFVO to obtain the information contained in the
latest "result" notification if it has not received it due to an
error or a wrongly configured subscription filter.
$ref: "#/definitions/VnfInfoModifications"
changedExtConnectivity:
description: >
Information about changed external connectivity, if applicable.
This allows the NFVO to obtain the information contained in the
latest "result" notification if it has not received it due to an
error or a wrongly configured subscription filter.
type: array
items:
$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ExtVirtualLinkInfo"
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".
This allows the API consumer to obtain the information contained in the latest "result" notification if it has
not received it due to an error or a wrongly configured subscription filter.
Not more than one of changedInfo and modificationsTriggeredByVnfPkgChange shall be present.
$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/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: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
_links:
description: >
Links to resources related to this resource.
type: object
required:
- self
- vnfInstance
properties:
self:
description: >
URI of this resource.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
vnfInstance:
description: >
Link to the VNF instance that the operation applies to.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
grant:
description: >
Link to the grant for this operation, if one exists.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
cancel:
description: >
Link to the task resource that represents the "cancel" operation
for this VNF LCM operation occurrence, if cancelling is
currently allowed.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
retry:
description: >
Link to the task resource that represents the "retry" operation
for this VNF LCM operation occurrence, if retrying is currently
allowed.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
rollback:
description: >
Link to the task resource that represents the "rollback"
operation for this VNF LCM operation occurrence, if rolling back
is currently allowed.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
fail:
description: >
Link to the task resource that represents the "fail" operation
for this VNF LCM operation occurrence, if declaring as failed is
currently allowed.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
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: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
AffectedExtLinkPort:
description: >
This type provides information about added and deleted external link ports (link ports attached to external virtual links).
type: object
required:
- id
- changeType
- extCpInstanceId
- resourceHandle
properties:
id:
description: >
Identifier of the link port, identifying the applicable "extLinkPorts" entry in the "ExtVirtualLinkInfo" data
type (see clause 5.5.3.2).
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/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: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
resourceHandle:
description: >
Reference to the link port resource.
Detailed information is (for added resources) or has been (for removed resources) available from the VIM.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ResourceHandle"
VnfInfoModifications:
description: >
This type represents attribute modifications that were performed on an
"Individual VNF instance" resource. The attributes that can be included
consist of those requested to be modified explicitly in the
"VnfInfoModificationRequest" data structure, and additional attributes
of the "VnfInstance" data structure that were modified implicitly e.g.
when modifying the referenced VNF package.
type: object
properties:
vnfInstanceName:
description: >
If present, this attribute signals modifications of the
"vnfInstanceName" attribute in "VnfInstance".
type: string
vnfInstanceDescription:
description: >
If present, this attribute signals modifications of the
"vnfInstanceDescription" attribute in "VnfInstance".
type: string
vnfConfigurableProperties:
description: >
If present, this attribute signals modifications of the
"vnfConfigurableProperties" attribute in "VnfInstance".
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
metadata:
description: >
If present, this attribute signals modifications of the "metadata"
attribute in "VnfInstance".
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
extensions:
description: >
If present, this attribute signals modifications of the "extensions"
attribute in "VnfInstance".
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
vnfdId:
description: >
If present, this attribute signals modifications of the "vnfdId"
attribute in "VnfInstance".
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
vnfProvider:
description: >
If present, this attribute signals modifications of the
"vnfProvider" attribute in "VnfInstance".
If present, this attribute (which depends on the value of the
"vnfPkgId" attribute) was modified implicitly following a request to
modify the "vnfPkgId" attribute, by copying the value of this
attribute from the VNFD in the VNF Package identified by the
"vnfPkgId” attribute.
type: string
vnfProductName:
description: >
If present, this attribute signals modifications of the
"vnfProductName" attribute in "VnfInstance".
If present, this attribute (which depends on the value of the
"vnfPkgId" attribute) was modified implicitly following a request to
modify the "vnfPkgId" attribute, by copying the value of this
attribute from the VNFD in the VNF Package identified by the
"vnfPkgId” attribute.
type: string
vnfSoftwareVersion:
description: >
If present, this attribute signals modifications of the
"vnfSoftwareVersion" attribute in "VnfInstance".
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Version"
vnfdVersion:
description: >
If present, this attribute signals modifications of the
"vnfdVersion" attribute in "VnfInstance".
If present, this attribute (which depends on the value of the
"vnfdId" attribute) was modified implicitly following a request to
modify the "vnfdId" attribute, by copying the value of this
attribute from the VNFD in the VNF Package identified by the
"vnfdId” attribute.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Version"
vnfcInfoModifications:
description: >
If present, this attribute signals modifications of certain
entries in the "vnfcInfo" attribute array in the
"instantiatedVnfInfo" attribute of "VnfInstance", as defined
in clause 5.5.2.12
type: array
items:
$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfcInfoModifications"
\ No newline at end of file
......@@ -148,7 +148,7 @@ definitions:
operation occurrence and by any of the error handling procedures for that operation occurrence.
type: array
items:
$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/AffectedExtLinkPort"
$ref: "../../VNFLifecycleManagement/definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/AffectedExtLinkPort"
affectedVirtualStorages:
description: >
Information about virtualised storage instances that were affected
......@@ -170,7 +170,7 @@ definitions:
the operation has performed any changes to VNF instance information,
including VNF configurable properties.
Shall be absent otherwise.
$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInfoModifications"
$ref: "../../VNFLifecycleManagement/definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/VnfInfoModifications"
changedExtConnectivity:
description: >
Information about changed external connectivity, if this
......
......@@ -419,7 +419,7 @@ components:
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/Alarm"
$ref: "./definitions/SOL003VNFFaultManagement_def.yaml#/definitions/Alarm"
IndividualAlarm.Get.200:
description: |
......@@ -451,7 +451,7 @@ components:
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/Alarm"
$ref: "./definitions/SOL003VNFFaultManagement_def.yaml#/definitions/Alarm"
IndividualAlarm.Patch.200:
description: |
......
definitions:
Alarm:
description: >
The alarm data type encapsulates information about an alarm.
type: object
required:
- id
- managedObjectId
- alarmRaisedTime
- ackState
- perceivedSeverity
- eventTime
- eventType
- probableCause
- isRootCause
- _links
properties:
id:
description: >