SOL003 - VNF Lifecycle Management Notification interface
SOL003 - VNF Lifecycle Management Notification interface
IMPORTANT: Please note that this file might be not aligned to the current version of the ETSI Group Specification it refers to. In case of discrepancies the published ETSI Group Specification takes precedence.
In clause 4.3.2 of ETSI GS NFV-SOL 003 v2.4.1, an attribute-based filtering mechanism is defined. This mechanism is currently not included in the corresponding OpenAPI design for this GS version. Changes to the attribute-based filtering mechanism are being considered in v2.5.1 of this GS for inclusion in the corresponding future ETSI NFV OpenAPI design.
Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution=
Version: 1.1.1
BasePath:/so/vnfm-adapter/v1/
ETSI Forge copyright notice
https://forge.etsi.org/etsi-forge-copyright-notice.txt
Access
[ Jump to Models ]
Table of Contents
Up
post /lcn/VnfIdentifierCreationNotification
(lcnVnfIdentifierCreationNotificationPost)
Notify
The POST method delivers a notification from the server to the client.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — A notification about the creation of a VNF identifier and the related VNF instance resource.
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
No Content
The notification was delivered successfully.
400
Bad Request
If the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem.
If the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.
If there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code.The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem.
inline_response_400
401
Unauthorized
If the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.
inline_response_400
403
Forbidden
If the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided. It should include in the "detail" attribute information about the source of the problem, and may indicate how to solve it.
inline_response_400
404
Not Found
If the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists, it shall respond with this response code. Specifically in case of this task resource, the reason can also be that the task is not supported for the VNF LCM operation occurrence represented by the parent resource, and that the task resource consequently does not exist. The "ProblemDetails" structure may be provided, including in the "detail" attribute information about the sourceof the problem, e.g. a wrong resource URI variable.
inline_response_400
405
Method Not Allowed
If a particular HTTP method is not supported for a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted in that case.
inline_response_400
406
Not Acceptable
If the "Accept" HTTP header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted in that case.
inline_response_400
500
Internal Server Error
If there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond withthis response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem.
inline_response_400
503
Service Unavailable
If the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 [13] for the use of the "Retry-After" HTTP header and for the alternative to refuse the connection. The "ProblemDetails" structure may be omitted.
inline_response_400
Up
post /lcn/VnfIdentifierDeletionNotification
(lcnVnfIdentifierDeletionNotificationPost)
Notify
The POST method delivers a notification from the server to the client.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — A notification about the deletion of a VNF identifier and the related VNF instance resource.
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
No Content
The notification was delivered successfully.
400
Bad Request
If the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem.
If the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.
If there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code.The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem.
inline_response_400
401
Unauthorized
If the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.
inline_response_400
403
Forbidden
If the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided. It should include in the "detail" attribute information about the source of the problem, and may indicate how to solve it.
inline_response_400
404
Not Found
If the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists, it shall respond with this response code. Specifically in case of this task resource, the reason can also be that the task is not supported for the VNF LCM operation occurrence represented by the parent resource, and that the task resource consequently does not exist. The "ProblemDetails" structure may be provided, including in the "detail" attribute information about the sourceof the problem, e.g. a wrong resource URI variable.
inline_response_400
405
Method Not Allowed
If a particular HTTP method is not supported for a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted in that case.
inline_response_400
406
Not Acceptable
If the "Accept" HTTP header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted in that case.
inline_response_400
500
Internal Server Error
If there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond withthis response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem.
inline_response_400
503
Service Unavailable
If the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 [13] for the use of the "Retry-After" HTTP header and for the alternative to refuse the connection. The "ProblemDetails" structure may be omitted.
inline_response_400
Up
post /lcn/VnfLcmOperationOccurrenceNotification
(lcnVnfLcmOperationOccurrenceNotificationPost)
Notify
The POST method delivers a notification from the server to the client.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — A notification about on-boarding of a VNF package.
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
No Content
The notification was delivered successfully.
400
Bad Request
If the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem.
If the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.
If there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code.The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem.
inline_response_400
401
Unauthorized
If the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.
inline_response_400
403
Forbidden
If the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided. It should include in the "detail" attribute information about the source of the problem, and may indicate how to solve it.
inline_response_400
404
Not Found
If the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists, it shall respond with this response code. Specifically in case of this task resource, the reason can also be that the task is not supported for the VNF LCM operation occurrence represented by the parent resource, and that the task resource consequently does not exist. The "ProblemDetails" structure may be provided, including in the "detail" attribute information about the sourceof the problem, e.g. a wrong resource URI variable.
inline_response_400
405
Method Not Allowed
If a particular HTTP method is not supported for a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted in that case.
inline_response_400
406
Not Acceptable
If the "Accept" HTTP header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted in that case.
inline_response_400
500
Internal Server Error
If there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond withthis response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem.
inline_response_400
503
Service Unavailable
If the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 [13] for the use of the "Retry-After" HTTP header and for the alternative to refuse the connection. The "ProblemDetails" structure may be omitted.
inline_response_400
[ Jump to Methods ]
Table of Contents
VnfIdentifierCreationNotification - VnfIdentifierDeletionNotification - VnfLcmOperationOccurrenceNotification - inline_response_400 - lcnVnfLcmOperationOccurrenceNotification__links - lcnVnfLcmOperationOccurrenceNotification__links_vnfInstance - lcnVnfLcmOperationOccurrenceNotification_affectedVirtualLinks - lcnVnfLcmOperationOccurrenceNotification_affectedVirtualStorages - lcnVnfLcmOperationOccurrenceNotification_affectedVnfcs - lcnVnfLcmOperationOccurrenceNotification_changedExtConnectivity - lcnVnfLcmOperationOccurrenceNotification_changedInfo - lcnVnfLcmOperationOccurrenceNotification_changedInfo_vimConnectionInfo - lcnVnfLcmOperationOccurrenceNotification_computeResource - lcnVnfLcmOperationOccurrenceNotification_error - lcnVnfLcmOperationOccurrenceNotification_extLinkPorts -
This type represents a VNF identifier creation notification, which informs the receiver of the creation of a new VNF instance resource and the associated VNF instance identifier. This notification shall be triggered by the VNFM when it has created a VNF instance resource and the associated VNF instance identifier.
id
String An identifier with the intention of being globally unique.
notificationType
String Discriminator for the different notification types. Shall be set to "VnfIdentifierCreationNotification" for this notification type.
VnfIdentifierCreationNotification
subscriptionId (optional)
String An identifier with the intention of being globally unique.
timeStamp
Date Date-time stamp. Representation: String formatted according to IETF RFC 3339. format: date-time
vnfInstanceId
String An identifier with the intention of being globally unique.
_links
This type represents a VNF identifier deletion notification, which informs the receiver of the deletion of a new VNF instance resource and the associated VNF instance identifier. This notification shall be triggered by the VNFM when it has deleted a VNF instance resource and the associated VNF instance identifier.
id
String An identifier with the intention of being globally unique.
notificationType
String Discriminator for the different notification types. Shall be set to "VnfIdentifierDeletionNotification" for this notification type.
VnfIdentifierDeletionNotification
subscriptionId (optional)
String An identifier with the intention of being globally unique.
timeStamp
Date Date-time stamp. Representation: String formatted according to IETF RFC 3339. format: date-time
vnfInstanceId
String An identifier with the intention of being globally unique.
_links
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 VNF lifecycle caused by a VNF LCM operation occurrence, including: * 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 * 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.
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 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 VnfLcmOpOcc resource before the notification about the state change is sent.
id
String An identifier with the intention of being globally unique.
notificationType
String Discriminator for the different notification types. Shall be set to "VnfLcmOperationOccurrenceNotification" for this notification type.
VnfLcmOperationOccurrenceNotification
subscriptionId
String An identifier with the intention of being globally unique.
timeStamp
Date Date-time stamp. Representation: String formatted according to IETF RFC 3339. format: date-time
notificationStatus
String 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.
START
RESULT
operationState
String Value | Description ------|------------ STARTING | The LCM operation is starting. PROCESSING | The LCM operation is currently in execution. COMPLETED | he LCM operation has been completed successfully. FAILED_TEMP | The LCM operation has failed and execution has stopped, but the execution of the operation is not considered to be closed. FAILED | The LCM operation has failed and it cannot be retried or rolled back, as it is determined that such action won't succeed. ROLLING_BACK | The LCM operation is currently being rolled back. ROLLED_BACK | The LCM operation has been successfully rolled back, i.e. The state of the VNF prior to the original operation invocation has been restored as closely as possible.
STARTING
PROCESSING
COMPLETED
FAILED_TEMP
FAILED
ROLLING_BACK
ROLLED_BACK
vnfInstanceId
String An identifier with the intention of being globally unique.
operation
String Value | Description ------|------------ INSTANTIATE | Represents the "Instantiate VNF" LCM operation. SCALE | Represents the "Scale VNF" LCM operation. SCALE_TO_LEVEL | Represents the "Scale VNF to Level" LCM operation. CHANGE_FLAVOUR | Represents the "Change VNF Flavour" LCM operation. TERMINATE | Represents the "Terminate VNF" LCM operation. HEAL | Represents the "Heal VNF" LCM operation. OPERATE | Represents the "Operate VNF" LCM operation. CHANGE_EXT_CONN | Represents the "Change external VNF connectivity" LCM operation. MODIFY_INFO | Represents the "Modify VNF Information" LCM operation.
INSTANTIATE
SCALE
SCALE_TO_LEVEL
CHANGE_FLAVOUR
TERMINATE
HEAL
OPERATE
CHANGE_EXT_CONN
MODIFY_INFO
isAutomaticInvocation
Boolean 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.
vnfLcmOpOccId
String An identifier with the intention of being globally unique.
affectedVnfcs (optional)
array[lcnVnfLcmOperationOccurrenceNotification_affectedVnfcs] Information about VNFC instances that were affected during the lifecycle operation. Shall be present if the "notificationStatus" is set to "RESULT" 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.
affectedVirtualLinks (optional)
array[lcnVnfLcmOperationOccurrenceNotification_affectedVirtualLinks] Information about VL instances that were affected during the lifecycle operation. Shall be present if the "notificationStatus" is set to "RESULT" 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.
affectedVirtualStorages (optional)
array[lcnVnfLcmOperationOccurrenceNotification_affectedVirtualStorages] Information about virtualised storage instances that were affected during the lifecycle operation. Shall be present if the "notificationStatus" is set to "RESULT" 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.
changedInfo (optional)
changedExtConnectivity (optional)
error (optional)
_links
The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
type (optional)
String A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank". format: URI
title (optional)
String A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than "about:blank", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
status
Integer The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
detail
String A human-readable explanation specific to this occurrence of the problem.
instance (optional)
String A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced. format: URI
This type represents the links to resources that a notification can contain.
vnfInstance
subscription
vnfLcmOpOcc (optional)
This type represents a link to a resource.
href
String URI of the referenced resource. format: url
This type provides information about added, deleted, modified and temporary VLs.
id
String An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.
virtualLinkDescId
String An identifier that is unique within a VNF descriptor.
changeType
String 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.
ADDED
REMOVED
MODIFIED
TEMPORARY
LINK_PORT_ADDED
LINK_PORT_REMOVED
networkResource
metadata (optional)
Object This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.
This type provides information about added, deleted, modified and temporary virtual storage resources.
id
String An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.
virtualStorageDescId
String An identifier that is unique within a VNF descriptor.
changeType
String 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.
ADDED
REMOVED
MODIFIED
TEMPORARY
storageResource
metadata (optional)
Object This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.
This type provides information about added, deleted, modified and temporary VNFCs.
id
String An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.
vduId
String An identifier that is unique within a VNF descriptor.
changeType
String Signals the type of change. Permitted values: * ADDED * REMOVED * MODIFIED * TEMPORARY For a temporary resource, an AffectedVnfc structure exists as long as the temporary resource exists.
ADDED
REMOVED
MODIFIED
TEMPORARY
computeResource
metadata (optional)
Object This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.
affectedVnfcCpIds (optional)
array[String] Identifiers of CP(s) of the VNFC instance that were affected by the change. Shall be present for those affected CPs of the VNFC instance that are associated to an external CP of the VNF instance. May be present for further affected CPs of the VNFC instance.
addedStorageResourceIds (optional)
array[String] References to VirtualStorage resources that have been added. Each value refers to a VirtualStorageResourceInfo item in the VnfInstance that was added to the VNFC. It shall be provided if at least one storage resource was added to the VNFC.
removedStorageResourceIds (optional)
array[String] References to VirtualStorage resources that have been removed. The value contains the identifier of a VirtualStorageResourceInfo item that has been removed from the VNFC, and might no longer exist in the VnfInstance. It shall be provided if at least one storage resource was removed from the VNFC.
id
String An identifier with the intention of being globally unique.
resourceHandle
extLinkPorts (optional)
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.
vnfInstanceName (optional)
String If present, this attribute signals modifications of the "vnfInstanceName" attribute in "VnfInstance".
vnfInstanceDescription (optional)
String If present, this attribute signals modifications of the "vnfInstanceDescription" attribute in "VnfInstance".
vnfConfigurableProperties (optional)
Object This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.
metadata (optional)
Object This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.
extensions (optional)
Object This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.
vimConnectionInfo (optional)
vnfPkgId (optional)
String An identifier with the intention of being globally unique.
vnfdId (optional)
String An identifier with the intention of being globally unique.
vnfProvider (optional)
String 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.
vnfProductName (optional)
String 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.
vnfSoftwareVersion (optional)
vnfdVersion (optional)
This type represents parameters to connect to a VIM for managing the resources of a VNF instance. This structure is used to convey VIM-related parameters over the Or-Vnfm interface. Additional parameters for a VIM may be configured into the VNFM by means outside the scope of the present document, and bound to the identifier of that VIM.
id
String An identifier with the intention of being globally unique.
vimId (optional)
String An identifier with the intention of being globally unique.
vimType
String Discriminator for the different types of the VIM information. The value of this attribute determines the structure of the "interfaceInfo" and "accessInfo" attributes, based on the type of the VIM. The set of permitted values is expected to change over time as new types or versions of VIMs become available. The ETSI NFV registry of VIM-related information provides access to information about VimConnectionInfo definitions for various VIM types. The structure of the registry is defined in Annex C of SOL003.
interfaceInfo (optional)
Object This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.
accessInfo (optional)
Object This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.
extra (optional)
Object This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.
This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.
vimConnectionId
String An identifier with the intention of being globally unique.
resourceProviderId (optional)
String An identifier with the intention of being globally unique.
resourceId
String An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.
vimLevelResourceType (optional)
String Type of the resource in the scope of the VIM or the resource provider.
The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].
type (optional)
String A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank". format: URI
title (optional)
String A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than "about:blank", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
status
Integer The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
detail
String A human-readable explanation specific to this occurrence of the problem.
instance (optional)
String A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced. format: URI
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.
id
String An identifier with the intention of being globally unique.
resourceHandle
cpInstanceId (optional)
String An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.