Newer
Older
title: SOL003 - VNF Lifecycle Management interface
description: |
SOL003 - VNF Lifecycle Management interface
Michele Carignani
committed
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.
Giacomo Bernini
committed
Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
version: "2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
Michele Carignani
committed
externalDocs:
description: ETSI GS NFV-SOL 003 V3.3.1
Giacomo Bernini
committed
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.07.01_60/gs_NFV-SOL003v020701p.pdf
servers:
- url: http://127.0.0.1/vnflcm/v1
- url: https://127.0.0.1/vnflcm/v1
Giacomo Bernini
committed
###############################################################################
# API Versions #
###############################################################################
/api_versions:
$ref: ../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions
###############################################################################
# VNF instances #
###############################################################################
parameters:
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
The POST method creates a new VNF instance resource based on a VNF package that is onboarded and in
"ENABLED" state.
This method shall follow the provisions specified in the tables 5.4.2.3.1-1 and 5.4.2.3.1-2
for URI query parameters, request and response data structures, and response codes.
As the result of successfully executing this method, a new "Individual VNF instance"
resource as defined in clause 5.4.3 shall have been created, and the value of the
"instantiationState" attribute in the representation of that resource shall be "NOT_INSTANTIATED".
A notification of type VnfIdentifierCreationNotification shall be triggered as part of successfully
executing this method as defined in clause 5.5.2.18.
When initiating the creation of a VNF instance resource, the passed metadata values can differ from
the default values for metadata, if any, declared in the VNFD.
The VNFM shall apply the "metadata" attributes in the "CreateVnfRequest" data structure in the payload
body to the "metadata" attribute in the "VnfInstance" data structure on top of the default values that
were obtained from the VNFD according to the rules of JSON Merge Patch (see IETF RFC 7396).
For all metadata keys defined in the VNFD, the VNFM shall ensure that the content of the resulting
"metadata" attributes is valid against the data type definitions in the VNFD. The absence of a metadata
item that is marked "required" in the VNFD shall not be treated as an error. In case a "metadata" child
attribute is not defined in the VNFD, the VNFM shall consider it valid in case it is a valid JSON structure.
In case of an error, the operation shall be rejected with a "422 Unprocessable Entity" error.
requestBody:
$ref: '#/components/requestBodies/CreateVnfRequest'
$ref: '#/components/responses/VNFInstances.Post.201'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
Query VNF.
The GET method queries information about multiple VNF instances.
parameters:
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/all_fields
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/fields
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/exclude_fields
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/exclude_default
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker
$ref: '#/components/responses/VNFInstances.Get.200'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
moscatelli
committed
###############################################################################
# Individual VNF instance #
###############################################################################
#SOL003 location: 5.4.3.2
parameters:
- $ref: '#/components/parameters/VnfInstanceId'
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
The GET method retrieves information about a VNF instance by reading an "Individual VNF instance" resource.
This method shall follow the provisions specified in the tables 5.4.3.3.2-1 and 5.4.3.3.2-2
for URI query parameters, request and response data structures, and response codes.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
$ref: '#/components/responses/IndividualVnfInstance.Get.200'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
moscatelli
committed
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
patch:
#SOL003 location: 5.4.3.3.4
moscatelli
committed
Modify VNF Information.
This method modifies an "Individual VNF instance" resource.
Changes to the VNF configurable properties are applied to the configuration in the VNF instance,
and are reflected in the representation of this resource.
Other changes are applied to the VNF instance information managed by the VNFM, and are reflected
in the representation of this resource.
This method shall follow the provisions specified in the tables 5.4.3.3.4-1 and 5.4.3.3.4-2
for URI query parameters, request and response data structures, and response codes.
The steps and conditions that apply as the result of successfully executing this method are
specified in clause 5.4.1.2.
The VNFM shall apply the "metadata", "extensions" and "vnfConfigurableProperties" attributes in the
"VnfInfoModificationRequest" data structure in the payload body to the existing "extensions" and
"vnfConfigurableProperties" attributes from the "VnfInstance" data structure according to the
rules of JSON Merge Patch (see IETF RFC 7396).
The VNFM shall ensure that the content of the child attributes of the resulting "metadata", "extensions"
and "vnfConfigurableProperties" attributes is valid against the data types definitions of these child
attributes in the VNFD.
In case a "metadata" child attribute is not defined in the VNFD, the VNFM shall consider it valid in
case it is a valid JSON structure.
NOTE: "Extensions" and "vnfConfigurableProperties" child attributes are always declared in the VNFD.
If the VNF instance is in the "INSTANTIATED" state, the validation shall also include
ensuring the presence of all "extensions" and "vnfConfigurableProperties" child attributes that are
marked as "required" in the VNFD.
NOTE: This allows to build the set of "extensions" and "vnfConfigurableProperties" incrementally
prior VNF instantiation but ensures their completeness for an instantiated VNF instance.
The absence of a metadata item that is marked "required" in the VNFD shall not be treated as an error.
In case of an error during validation, the operation shall be automatically rolled back, and
appropriate error information shall be provided in the "VnfLcmOperationOccurrenceNotification"
message and the "VnfLcmOpOcc" data structure.
The processing of changes to the "metadata" / "extensions" / "vnfConfigurableProperties" attributes
shall be performed in the "PROCESSING" phase of the LCM operation. The change shall be atomic, i.e. the
result of intermediate stages shall not be visible in the API. In case of successful completion of the
processing and validation, the attributes shall be provided in the "VnfInstance" data structure and
the operation shall proceed towards successful completion.
requestBody:
$ref: '#/components/requestBodies/VnfInfoModificationRequest'
$ref: '#/components/responses/IndividualVnfInstance.Patch.202'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
Giacomo Bernini
committed
#409 CONFLICT
Giacomo Bernini
committed
#Shall be returned upon the following error: The operation cannot be executed currently,
#due to a conflict with the state of the "Individual VNF instance" resource.
#Typically, this is due to the fact that another LCM operation is ongoing.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/412"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
delete:
#SOL003 location: 5.4.3.3.5
moscatelli
committed
Delete VNF Identifier.
This method deletes an "Individual VNF instance" resource.
This method shall follow the provisions specified in the tables 5.4.3.3.5-1 and 5.4.3.3.5-2
for URI query parameters, request and response data structures, and response codes.
As the result of successfully executing this method, the "Individual VNF instance" resource
shall not exist any longer.
A notification of type "VnfIdentifierDeletionNotification" shall be triggered as part of successfully
executing this method as defined in clause 5.5.2.19.
$ref: '#/components/responses/IndividualVnfInstance.Delete.204'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
Giacomo Bernini
committed
#409 CONFLICT
Giacomo Bernini
committed
#Shall be returned upon the following error: The operation cannot be executed currently,
#due to a conflict with the state of the resource.
#Typically, this is due to the fact that the "Individual VNF instance" resource is in INSTANTIATED state.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/412"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
###############################################################################
# Instantiate VNF task #
###############################################################################
/vnf_instances/{vnfInstanceId}/instantiate:
#SOL003 location: 5.4.4.2
parameters:
- $ref: '#/components/parameters/VnfInstanceId'
Instantiate VNF.
The POST method instantiates a VNF instance.
This method shall follow the provisions specified in the tables 5.4.4.3.1-1 and 5.4.4.3.1-2
for URI query parameters, request and response data structures, and response codes.
The steps and conditions that apply as the result of successfully executing this method
are specified in clause 5.4.1.2.
In addition, once the VNFM has successfully completed the underlying VNF LCM operation occurrence,
it shall set the "instantiationState" attribute to the value "INSTANTIATED" and the "vnfState"
attribute to the value "STARTED" in the representation of the "Individual VNF instance" resource.
When instantiating a VNF instance, the values of the extensions and/or VNF configurable properties
passed in the instantiation request can differ from the values in the "VnfInstance" data structure
that were initialized from default values, if any, declared in the VNFD.
The VNFM shall apply the "extensions" and "vnfConfigurableProperties" attributes in the
"InstantiateVnfRequest" data structure in the payload body to the existing "extensions" and
"vnfConfigurableProperties" attributes from the "VnfInstance" data structure according to the rules
of JSON Merge Patch (see IETF RFC 7396). The VNFM shall ensure that the content of the resulting
"extensions" and "vnfConfigurableProperties" attributes is valid against the VNFD (including the
presence of all child attributes that are marked as "required" in the VNFD). In case of an error
during validation, the operation shall be automatically rolled back, and appropriate error information
shall be provided in the "VnfLcmOperationOccurrenceNotification" message and the "VnfLcmOpOcc"
data structure. The processing of changes to the "extensions" / "vnfConfigurableProperties" attributes
shall be performed in the "STARTING" phase of the LCM operation. The change shall be atomic, i.e.
the result of intermediate stages shall not be visible in the API. In case of successful completion
of the processing and validation, the attributes shall be provided in the "VnfInstance" data structure
and the operation shall proceed to obtain the grant.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
requestBody:
$ref: '#/components/requestBodies/InstantiateVnfRequest'
$ref: '#/components/responses/InstantiateVnfInstance.Post.202'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
Giacomo Bernini
committed
#409 CONFLICT
#Shall be returned upon the following error: The operation cannot be executed currently,
#due to a conflict with the state of the resource.
#Typically, this is due to the fact that the "Individual VNF instance" resource is in INSTANTIATED state,
#or that a required child attribute of the "extensions" attribute has not been set.
#Those attributes are marked as "required" in the VNFD.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
###############################################################################
# Scale VNF task #
###############################################################################
/vnf_instances/{vnfInstanceId}/scale:
#SOL003 location: 5.4.5.2
parameters:
- $ref: '#/components/parameters/VnfInstanceId'
Scale VNF.
The POST method requests to scale a VNF instance resource incrementally.
This method shall follow the provisions specified in the tables 5.4.5.3.1-1 and 5.4.5.3.1-2
for URI query parameters, request and response data structures, and response codes.
The steps and conditions that apply as the result of successfully executing this method are
specified in clause 5.4.1.2.
In addition, once the VNFM has successfully completed the underlying VNF LCM operation occurrence,
it shall reflect the result of scaling the VNF instance by updating the "scaleStatus" attribute
in the representation of the "Individual VNF instance" resource.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
requestBody:
$ref: '#/components/requestBodies/ScaleVnfRequest'
$ref: '#/components/responses/ScaleVnfInstance.Post.202'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
Giacomo Bernini
committed
#404 NOT FOUND
#Shall be returned upon the following error: The API producer did not find a current representation
#for the target resource or is not willing to disclose that one exists.
#The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013,
#including rules for the presence of the response body.
#Specifically in case of this task resource, the response code 404 shall also returned if
#the task is not supported for the VNF instance represented by the parent resource, which means that the
#task resource consequently does not exist.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
Giacomo Bernini
committed
#409 CONFLICT
#Shall be returned upon the following error: The operation cannot be executed currently,
#due to a conflict with the state of the resource.
#Typically, this is due to the fact that the "Individual VNF instance" resource is in
#NOT_INSTANTIATED state, or that another lifecycle management operation is ongoing, or that
#a required child attribute of the "extensions" attribute has not been set.
#Those attributes are marked as "required" in the VNFD.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
###############################################################################
# Scale VNF to Level task #
###############################################################################
/vnf_instances/{vnfInstanceId}/scale_to_level:
#SOL003 location: 5.4.6.2
parameters:
- $ref: '#/components/parameters/VnfInstanceId'
Scale VNF to Level.
The POST method requests to scale a VNF instance resource to a target level.
This method shall follow the provisions specified in the tables 5.4.6.3.1-1 and 5.4.6.3.1-2
for URI query parameters, request and response data structures, and response codes.
The steps and conditions that apply as the result of successfully executing this method are
specified in clause 5.4.1.2.
In addition, once the VNFM has successfully completed the underlying VNF LCM operation occurrence,
it shall reflect the result of scaling the VNF instance by updating the "scaleStatus" attribute
in the representation of the "Individual VNF instance" resource.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
requestBody:
$ref: '#/components/requestBodies/ScaleVnfToLevelRequest'
$ref: '#/components/responses/ScaleToLevelVnfInstance.Post.202'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
Giacomo Bernini
committed
#404 NOT FOUND
#Shall be returned upon the following error: The API producer did not find a current representation
#for the target resource or is not willing to disclose that one exists.
#The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013,
#including rules for the presence of the response body.
#Specifically in case of this task resource, the response code 404 shall also returned if the task
#is not supported for the VNF instance represented by the parent resource, which means that the task resource
#consequently does not exist.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
Giacomo Bernini
committed
#409 CONFLICT
#Shall be returned upon the following error: The operation cannot be executed currently,
#due to a conflict with the state of the resource.
#Typically, this is due to the fact that the VNF instance resource is in NOT_INSTANTIATED state,
#that another lifecycle management operation is ongoing, or that a required child attribute of
#the "extensions" attribute has not been set.
#Those attributes are marked as "required" in the VNFD.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
###############################################################################
# Change VNF Flavour task #
###############################################################################
/vnf_instances/{vnfInstanceId}/change_flavour:
#SOL003 location: 5.4.7.2
parameters:
- $ref: '#/components/parameters/VnfInstanceId'
Change VNF Flavour.
This method shall follow the provisions specified in the tables 5.4.7.3.1-1 and 5.4.7.3.1-2
for URI query parameters, request and response data structures, and response codes.
The steps and conditions that apply as the result of successfully executing this method
are specified in clause 5.4.1.2.
In addition, once the VNFM has successfully completed the underlying VNF LCM operation occurrence,
it shall set the "flavourId" attribute in the representation of the "Individual VNF instance"
resource to the value of the "newFlavourId" attribute passed in the "ChangeVnfFlavourRequest"
data in the POST request.
When initiating a change of the current VNF flavour, the values of the extensions and/or VNF
configurable properties, can differ between the new flavour and the old flavour of the VNF instance.
The VNFM shall apply the "extensions" and "vnfConfigurableProperties" attributes in the
"ChangeVnfFlavourRequest" data structure in the payload body to the existing "extensions" and
"vnfConfigurableProperties" attributes from the "VnfInstance" data structure according to the rules
of JSON Merge Patch (see IETF RFC 7396). The VNFM shall ensure that the content of the resulting
"extensions" and "vnfConfigurableProperties" attributes is valid against the VNFD (which includes
ensuring the presence of all child attributes that are marked as "required" in the VNFD). In case
of an error, the operation shall be automatically rolled back, and appropriate error information
shall be provided in the "VnfLcmOperationOccurrenceNotification" message and the "VnfLcmOpOcc" data
structure. The processing of changes to the "extensions" / "vnfConfigurableProperties" attributes
shall be performed in the "STARTING" phase of the LCM operation. The change shall be atomic, i.e.
the result of intermediate stages shall not be visible in the API. In case of successful completion
of the processing and validation, the attributes shall be provided in the "VnfInstance" data structure
and the operation shall proceed to obtain the grant.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
requestBody:
$ref: '#/components/requestBodies/ChangeVnfFlavourRequest'
$ref: '#/components/responses/ChangeFlavourVnfInstance.Post.202'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
Giacomo Bernini
committed
#404 NOT FOUND
#Shall be returned upon the following error: The API producer did not find a current representation
#for the target resource or is not willing to disclose that one exists.
#The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013,
#including rules for the presence of the response body.
#Specifically in case of this task resource, the response code 404 shall also returned if the task
#is not supported for the VNF instance represented by the parent resource, which means that the task resource
#consequently does not exist.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
Giacomo Bernini
committed
#409 CONFLICT
#Shall be returned upon the following error: The operation cannot be executed currently,
#due to a conflict with the state of the resource.
#Typically, this is due to the fact that the VNF instance resource is in NOT_INSTANTIATED state,
#that another lifecycle management operation is ongoing, or that a required child attribute of
#the "extensions" attribute has not been set.
#Those attributes are marked as "required" in the VNFD.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
moscatelli
committed
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
moscatelli
committed
###############################################################################
# Terminate VNF task #
###############################################################################
/vnf_instances/{vnfInstanceId}/terminate:
#SOL003 location: 5.4.8.2
parameters:
- $ref: '#/components/parameters/VnfInstanceId'
moscatelli
committed
Terminate VNF.
Giacomo Bernini
committed
The POST method triggers the VNFM to terminate a VNF instance and to request to the VIM
the release of its used virtualised resources.
This method shall follow the provisions specified in the tables 5.4.8.3.1-1 and 5.4.8.3.1-2
for URI query parameters, request and response data structures, and response codes.
The steps and conditions that apply as the result of successfully executing this method
are specified in clause 5.4.1.2.
In addition, once the VNFM has successfully completed the underlying VNF LCM operation occurrence,
it shall set the "instantiationState" attribute in the representation of the "Individual VNF instance"
resource to the value "NOT_INSTANTIATED".
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
requestBody:
$ref: '#/components/requestBodies/TerminateVnfRequest'
$ref: '#/components/responses/TerminateVnfInstance.Post.202'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
Giacomo Bernini
committed
#409 CONFLICT
#Shall be returned upon the following error: The operation cannot be executed currently,
#due to a conflict with the state of the resource.
#Typically, this is due to the fact that the VNF instance resource is in NOT_INSTANTIATED state,
#that another lifecycle management operation is ongoing, or that a required child attribute of
#the "extensions" attribute has not been set.
#Those attributes are marked as "required" in the VNFD.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
moscatelli
committed
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
moscatelli
committed
###############################################################################
# Heal VNF task #
###############################################################################
/vnf_instances/{vnfInstanceId}/heal:
#SOL003 location: 5.4.9.2
parameters:
- $ref: '#/components/parameters/VnfInstanceId'
moscatelli
committed
Heal VNF.
The POST method requests to heal a VNF instance.
This method shall follow the provisions specified in the tables 5.4.9.3.1-1 and 5.4.9.3.1-2
for URI query parameters, request and response data structures, and response codes.
The steps and conditions that apply as the result of successfully executing this method
are specified in clause 5.4.1.2.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
requestBody:
$ref: '#/components/requestBodies/HealVnfRequest'
$ref: '#/components/responses/HealVnfInstance.Post.202'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
Giacomo Bernini
committed
#404 NOT FOUND
#Shall be returned upon the following error: The API producer did not find a current representation
#for the target resource or is not willing to disclose that one exists.
#The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013,
#including rules for the presence of the response body.
#Specifically in case of this task resource, the response code 404 shall also returned if the task is
#not supported for the VNF instance represented by the parent resource, which means that the task resource
#consequently does not exist.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
Giacomo Bernini
committed
#409 CONFLICT
#Shall be returned upon the following error: The operation cannot be executed currently,
#due to a conflict with the state of the resource.
#Typically, this is due to the fact that the VNF instance resource is in NOT_INSTANTIATED state,
#that another lifecycle management operation is ongoing, or that a required child attribute of
#the "extensions" attribute has not been set.
#Those attributes are marked as "required" in the VNFD.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
moscatelli
committed
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
moscatelli
committed
###############################################################################
# Operate VNF task #
###############################################################################
/vnf_instances/{vnfInstanceId}/operate:
#SOL003 location: 5.4.10.2
- $ref: '#/components/parameters/VnfInstanceId'
moscatelli
committed
Operate VNF.
The POST method changes the operational state of a VNF instance resource.
This method shall follow the provisions specified in the tables 5.4.10.3.1-1 and 5.4.10.3.1-2
for URI query parameters, request and response data structures, and response codes.
The steps and conditions that apply as the result of successfully executing this method
are specified in clause 5.4.1.2.
In addition, once the VNFM has successfully completed the underlying VNF LCM operation occurrence,
it shall set the "vnfState" attribute in the representation of the "Individual VNF instance" resource
to the value of the "changeStateTo" attribute passed in the "OperateVnfRequest" data in the POST request.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
requestBody:
$ref: '#/components/requestBodies/OperateVnfRequest'
$ref: '#/components/responses/OperateVnfInstance.Post.202'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
Giacomo Bernini
committed
#404 NOT FOUND
#Shall be returned upon the following error: The API producer did not find a current representation
#for the target resource or is not willing to disclose that one exists.
#The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013,
#including rules for the presence of the response body.
#Specifically in case of this task resource, the response code 404 shall also returned if the task is
#not supported for the VNF instance represented by the parent resource, which means that the task resource
#consequently does not exist.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
Giacomo Bernini
committed
#409 CONFLICT
#Shall be returned upon the following error: The operation cannot be executed currently,
#due to a conflict with the state of the resource.
#Typically, this is due to the fact that the VNF instance resource is in NOT_INSTANTIATED state,
#that another lifecycle management operation is ongoing, or that a required child attribute of
#the "extensions" attribute has not been set.
#Those attributes are marked as "required" in the VNFD.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
moscatelli
committed
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
moscatelli
committed
###############################################################################
# Change external VNF connectivity task #
###############################################################################
/vnf_instances/{vnfInstanceId}/change_ext_conn:
#SOL003 location: 5.4.11.2
- $ref: '#/components/parameters/VnfInstanceId'
Change External VNF Connectivity.
The POST method changes the external connectivity of a VNF instance.
This method shall follow the provisions specified in the tables 5.4.11.3.1-1 and 5.4.11.3.1-2
for URI query parameters, request and response data structures, and response codes.
The steps and conditions that apply as the result of successfully executing this method
are specified in clause 5.4.1.2.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
requestBody:
$ref: '#/components/requestBodies/ChangeExtVnfConnectivityRequest'
$ref: '#/components/responses/ChangeExtConnVnfInstance.Post.202'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
Giacomo Bernini
committed
#409 CONFLICT
#Shall be returned upon the following error: The operation cannot be executed currently,
#due to a conflict with the state of the resource.
#Typically, this is due to the fact that another lifecycle management operation is ongoing,
#or that a required child attribute of the "extensions" attribute has not been set.
#Those attributes are marked as "required" in the VNFD.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
###############################################################################
# Change current VNF package task #
###############################################################################
/vnf_instances/{vnfInstanceId}/change_vnfpkg:
#SOL003 location: 5.4.11a.2
parameters:
- $ref: '#/components/parameters/VnfInstanceId'
The POST method changes the current VNF package on which the VNF instance is based.
This method shall follow the provisions specified in the tables 5.4.11a.3.1-1 and
5.4.11a.3.1-2 for URI query parameters, request and response data structures, and
response codes.
The steps and conditions that apply as the result of successfully executing this method
are specified in clause 5.4.1.2.
During a change of the current VNF package, the allowed and required extensions and/or
VNF configurable properties and their data types, as well as the metadata data types,
can differ between the source and the destination VNFD.
parameters:
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
requestBody:
$ref: '#/components/requestBodies/ChangeCurrentVnfPkgRequest'
$ref: '#/components/responses/ChangeVnfpkgVnfInstance.Post.202'
400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
401:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
403:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
404:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
405:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
409:
#409 CONFLICT
#Shall be returned upon the following error: The operation cannot be executed currently,
#due to a conflict with the state of the resource.
#Typically, this is due to the fact that another lifecycle management operation is ongoing,
#or that a required child attribute of the "extensions" attribute has not been set.
#Those attributes are marked as "required" in the VNFD.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
###############################################################################
# VNF LCM operation occurrences #
###############################################################################
Giacomo Bernini
committed
The API consumer can use this method to query status information about multiple
VNF lifecycle management operation occurrences.
This method shall follow the provisions specified in the tables 5.4.12.3.2-1 and 5.4.12.3.2-2
for URI query parameters, request and response data structures, and response codes.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/all_fields
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/fields
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/exclude_fields
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/exclude_default
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
$ref: '#/components/responses/VnfLcmOpOccs.Get.200'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
###############################################################################
# Individual VNF LCM operation occurrence #
###############################################################################
#SOL003 location: 5.4.13
parameters:
- $ref: '#/components/parameters/VnfLcmOpOccId'
Giacomo Bernini
committed
The API consumer can use this method to retrieve status information about a VNF lifecycle
management operation occurrence by reading an "Individual VNF LCM operation occurrence" resource.
This method shall follow the provisions specified in the tables 5.4.13.3.2-1 and 5.4.13.3.2-2
for URI query parameters, request and response data structures, and response codes.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
$ref: '#/components/responses/IndividualVnfLcmOpOcc.Get.200'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
###############################################################################
# Retry operation task #
###############################################################################
/vnf_lcm_op_occs/{vnfLcmOpOccId}/retry:
#SOL003 location: 5.4.14
parameters:
- $ref: '#/components/parameters/VnfLcmOpOccId'
The POST method initiates retrying a VNF lifecycle operation if that operation
has experienced a temporary failure, i.e. the related "Individual VNF LCM operation occurrence"
resource is in "FAILED_TEMP" state.
This method shall follow the provisions specified in the tables 5.4.14.3.1-1 and 5.4.14.3.1-2
for URI query parameters, request and response data structures, and response codes.
In case of success of processing the asynchronous request, the "operationState" attribute
in the representation of the parent resource shall be changed to "PROCESSING" and the applicable
"start" notification according to clause 5.6.2.2 shall be emitted to indicate that the underlying
VNF LCM operation occurrence proceeds.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
$ref: '#/components/responses/RetryVnfLcmOpOcc.Post.202'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
Giacomo Bernini
committed
#404 NOT FOUND
#Shall be returned upon the following error: The API producer did not find a current representation
#for the target resource or is not willing to disclose that one exists.
#The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013,
#including rules for the presence of the response body.
#Specifically in case of this task resource, the response code 404 shall also be returned if the task
#is not supported for the VNF LCM operation occurrence represented by the parent resource,
#which means that the task resource consequently does not exist.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
Giacomo Bernini
committed
#409 CONFLICT
Giacomo Bernini
committed
#Shall be returned upon the following error: The operation cannot be executed currently,
#due to a conflict with the state of the VNF LCM operation occurrence.
#Typically, this is due to the fact that the VNF LCM operation occurrence is not in FAILED_TEMP state,
#or another error handling action is starting, such as rollback or fail.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
###############################################################################
# Rollback operation task #
###############################################################################
/vnf_lcm_op_occs/{vnfLcmOpOccId}/rollback:
#SOL003 location: 5.4.15
parameters:
- $ref: '#/components/parameters/VnfLcmOpOccId'
The POST method initiates rolling back a VNF lifecycle operation if that operation
has experienced a temporary failure, i.e. the related "Individual VNF LCM operation occurrence"
resource is in "FAILED_TEMP" state.
Giacomo Bernini
committed
In case of rolling back an occurrence of the "InstantiateVnf" operation, the VNFM shall
request to the VIM the release of the virtualised resources that were allocated for the related VNF instance.
The "rollback" task shall be supported by the VNFM for any VNF LCM operation occurrence that represents an
"InstantiateVnf" operation in FAILED_TEMP state.
This method shall follow the provisions specified in the tables 5.4.15.3.1-1 and 5.4.15.3.1-2
for URI query parameters, request and response data structures, and response codes.
In case of success of processing the asynchronous request, the "operationState" attribute
in the representation of the parent resource shall be changed to "ROLLING_BACK" and the applicable
"start" notification according to clause 5.6.2.2 shall be emitted to indicate that rollback of the
underlying VNF LCM operation occurrence is attempted.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
$ref: '#/components/responses/RollbackVnfLcmOpOcc.Post.202'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
Giacomo Bernini
committed
#404 NOT FOUND
#Shall be returned upon the following error: The API producer did not find a current representation
#for the target resource or is not willing to disclose that one exists.
#The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013,
#including rules for the presence of the response body.
#Specifically in case of this task resource, the response code 404 shall also be returned if the task
#is not supported for the VNF LCM operation occurrence represented by the parent resource,
#which means that the task resource consequently does not exist.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
Giacomo Bernini
committed
#409 CONFLICT
Giacomo Bernini
committed
#Shall be returned upon the following error: The operation cannot be executed currently,
#due to a conflict with the state of the VNF LCM operation occurrence.
#Typically, this is due to the fact that the VNF LCM operation occurrence is not in FAILED_TEMP state,
#or another error handling action is starting, such as rollback or fail.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
###############################################################################
# Fail operation task #
###############################################################################
/vnf_lcm_op_occs/{vnfLcmOpOccId}/fail:
#SOL003 location: 5.4.16
parameters:
- $ref: '#/components/parameters/VnfLcmOpOccId'
The POST method marks a VNF lifecycle management operation occurrence as "finally failed"
if that operation occurrence is in "FAILED_TEMP" state.
This method shall follow the provisions specified in the tables 5.4.16.3.1-1 and 5.4.16.3.1-2
for URI query parameters, request and response data structures, and response codes.
In case of success, the "operationState" attribute in the representation of the parent resource
shall be changed to "FAILED" and the applicable "result" notification according to clause 5.6.2.2
shall be emitted to indicate that the execution of the underlying VNF LCM operation occurrence
has finally and unrecoverably failed.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
$ref: '#/components/responses/FailVnfLcmOpOcc.Post.200'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
Giacomo Bernini
committed
#404 NOT FOUND
#Shall be returned upon the following error: The API producer did not find a current representation
#for the target resource or is not willing to disclose that one exists.
#The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013,
#including rules for the presence of the response body.
#Specifically in case of this task resource, the response code 404 shall also returned if the task
#is not supported for the VNF LCM operation occurrence represented by the parent resource, which means
#that the task resource consequently does not exist.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
Giacomo Bernini
committed
#409 CONFLICT
Giacomo Bernini
committed
#Shall be returned upon the following error: The operation cannot be executed currently, due to a conflict
#with the state of the VNF LCM operation occurrence.
#Typically, this is due to the fact that the VNF LCM operation occurrence is not in FAILED_TEMP state,
#or another error handling action is starting, such as retry or rollback.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
###############################################################################
# Cancel operation task #
###############################################################################
/vnf_lcm_op_occs/{vnfLcmOpOccId}/cancel:
#SOL003 location: 5.4.17
parameters:
- $ref: '#/components/parameters/VnfLcmOpOccId'
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
The POST method initiates cancelling an ongoing VNF lifecycle operation while
it is being executed or rolled back, i.e. the related "Individual VNF LCM operation occurrence"
resource is either in "STARTING" or "PROCESSING" or "ROLLING_BACK" state.
This method shall follow the provisions specified in the tables 5.4.17.3.1-1 and 5.4.17.3.1-2
for URI query parameters, request and response data structures, and response codes.
Before returning the "202 Accepted" response, the VNFM shall update the "isCancelPending"
and "cancelMode" attributes in the representation of the parent resource according to the
provisions in clause 5.5.2.13.
In case of success of processing the asynchronous request:
1) If the request has been processed in "STARTING" state, the "operationState" attribute
in the representation of the parent resource shall be changed to "ROLLED_BACK".
2) If the request has been processed in "PROCESSING" or "ROLLING_BACK" state,
the "operationState" attribute in the representation of the parent resource
shall be changed to "FAILED_TEMP".
In both cases, the VNFM shall update the "isCancelPending" and "cancelMode" attributes
in the representation of the parent resource according to the provisions in clause 5.5.2.13
to reflect the new status, and the applicable "result" notification according to clause 5.6.2.2
shall be emitted to indicate that the execution of the underlying VNF LCM operation occurrence
has temporarily failed.
Due to race conditions, the processing of the actual operation that is to be cancelled may eventually
still succeed, in which case the "operationState" attribute in the representation of the parent
resource shall represent the result of that operation, rather than the result of the cancellation.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
$ref: '#/components/responses/CancelVnfLcmOpOcc.Post.202'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
Giacomo Bernini
committed
#409 CONFLICT
Giacomo Bernini
committed
#Shall be returned upon the following error: The operation cannot be executed currently,
#due to a conflict with the state of the VNF LCM operation occurrence.
#Typically, this is due to the fact that the operation occurrence is not in STARTING,
#PROCESSING or ROLLING_BACK state.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
###############################################################################
# Subscriptions #
###############################################################################
parameters:
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
The POST method creates a new subscription.
This method shall follow the provisions specified in the tables 5.4.18.3.1-1 and 5.4.18.3.1-2
for URI query parameters, request and response data structures, and response codes.
As the result of successfully executing this method, a new "Individual subscription"
resource as defined in clause 5.4.3 shall have been created. This method shall not trigger any notification.
Creation of two "Individual subscription" resources with the same callback URI and the same filter
can result in performance degradation and will provide duplicates of notifications to the NFVO,
and might make sense only in very rare use cases. Consequently, the VNFM may either allow creating
an "Individual subscription" resource if another "Individual subscription" resource with the same
filter and callback URI already exists (in which case it shall return the "201 Created" response code),
or may decide to not create a duplicate "Individual subscription" resource (in which case it shall
return a "303 See Other" response code referencing the existing "Individual subscription" resource
with the same filter and callback URI).
requestBody:
$ref: '#/components/requestBodies/LccnSubscriptionRequest'
$ref: '#/components/responses/Subscriptions.Post.201'
Giacomo Bernini
committed
#303 SEE OTHER
#Shall be returned if a subscription with the same callback URI and the same filter already exists
Giacomo Bernini
committed
#and the policy of the VNFM is to not create redundant subscriptions.
#The HTTP response shall include a "Location" HTTP header that contains the resource URI of the existing
#"Individual subscription" resource.
#The response body shall be empty.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/303"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
Giacomo Bernini
committed
422:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
Query Subscription Information.
The GET method queries the list of active subscriptions of the
functional block that invokes the method. It can be used e.g. for
resynchronization after error situations.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker
$ref: '#/components/responses/Subscriptions.Get.200'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
###############################################################################
# Individual subscription #
###############################################################################
#SOL003 location: 5.4.19
parameters:
- $ref: '#/components/parameters/SubscriptionId'
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
Query Subscription Information.
The GET method retrieves information about a subscription by reading an "Individual subscription" resource.
This method shall follow the provisions specified in the tables 5.4.19.3.2-1 and 5.4.19.3.2-2
for URI query parameters, request and response data structures, and response codes.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
$ref: '#/components/responses/IndividualSubscription.Get.200'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
The DELETE method terminates an individual subscription.
This method shall follow the provisions specified in the tables 5.4.19.3.5-1 and 5.4.19.3.5-2
for URI query parameters, request and response data structures, and response codes.
As the result of successfully executing this method, the "Individual subscription" resource
shall not exist any longer. This means that no notifications for that subscription shall be
sent to the formerly-subscribed API consumer.
NOTE: Due to race conditions, some notifications might still be received by the formerly-subscribed
API consumer for a certain time period after the deletion.
$ref: '#/components/responses/IndividualSubscription.Delete.204'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
###############################################################################
# Create VNF snapshot task #
###############################################################################
/vnf_instances/{vnfInstanceId}/create_snapshot:
#SOL003 location: 5.4.21.2
parameters:
- $ref: '#/components/parameters/VnfInstanceId'
The POST method requests taking a snapshot a VNF instance and populating a
previously created VNF snapshot resource (refer to clause 5.4.23.3.1) with
the snapshot content.
The steps and conditions that apply as the result of successfully executing
this method are specified in clause 5.4.1.2.
In addition, once the VNFM has successfully completed the underlying VNF LCM
operation occurrence, it shall reflect the result of the VNF snapshot creation
by updating the corresponding "Individual VNF snapshot" resource indicated by
the "vnfSnapshotInfoId" attribute of the "CreateVnfSnapshotRequest" that is
included in the payload body of the request.
This method shall follow the provisions specified in the tables 5.4.21.3.1-1
and 5.4.21.3.1-2 for URI query parameters, request and response data structures,
and response codes.
parameters:
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
requestBody:
$ref: '#/components/requestBodies/CreateVnfSnapshotRequest'
$ref: '#/components/responses/CreateVnfSnapshotTask.Post.202'
400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
401:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
403:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
404:
#404 NOT FOUND
#Shall be returned upon the following error: The API producer did not find a current representation
#for the target resource or is not willing to disclose that one exists.
#The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013,
#including rules for the presence of the response body.
#Specifically in case of this task resource, the response code 404 shall also be returned if the task
#is not supported for the VNF instance represented by the parent resource, which means that the task
#resource consequently does not exist.
#In this case, the response body shall be present, and shall contain a ProblemDetails structure, in
#which the "detail" attribute shall convey more information about the error.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
405:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
409:
#409 CONFLICT
#Shall be returned upon the following error: The operation cannot be executed currently,
#due to a conflict with the state of the resource.
#Typically, this is due to the fact that the VNF instance resource is in NOT_INSTANTIATED
#state, or that another lifecycle management operation is ongoing.
#The response body shall contain a ProblemDetails structure, in which the "detail" attribute
#shall convey more information about the error.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
422:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
###############################################################################
# Revert to VNF snapshot task #
###############################################################################
/vnf_instances/{vnfInstanceId}/revert_to_snapshot:
#SOL003 location: 5.4.22.2
parameters:
- $ref: '#/components/parameters/VnfInstanceId'
The POST method requests reverting a VNF instance to a VNF snapshot.
This method shall follow the provisions specified in the tables 5.4.22.3.1-1
and 5.4.22.3.1-2 for URI query parameters, request and response data structures,
and response codes.
parameters:
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
requestBody:
$ref: '#/components/requestBodies/RevertToVnfSnapshotRequest'
$ref: '#/components/responses/RevertToVnfSnapshotTask.Post.202'
400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
401:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
403:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
404:
#404 NOT FOUND
#Shall be returned upon the following error: The API producer did not find a current representation
#for the target resource or is not willing to disclose that one exists.
#The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013,
#including rules for the presence of the response body.
#Specifically in case of this task resource, the response code 404 shall also be returned if the task
#is not supported for the VNF instance represented by the parent resource, which means that the task
#resource consequently does not exist.
#In this case, the response body shall be present, and shall contain a ProblemDetails structure, in
#which the "detail" attribute shall convey more information about the error.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
405:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
409:
#409 CONFLICT
#Shall be returned upon the following error: The operation cannot be executed currently,
#due to a conflict with the state of the resource.
#Typically, this is due to the fact that the VNF instance resource is in NOT_INSTANTIATED
#state, or that another lifecycle management operation is ongoing.
#The response body shall contain a ProblemDetails structure, in which the "detail" attribute
#shall convey more information about the error.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
###############################################################################
# VNF snapshots #
###############################################################################
#SOL003 location: 5.4.23.2
parameters:
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
The POST method creates a new "Individual VNF snapshot" resource.
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
As a result of successfully executing this method, a new "Individual VNF snapshot"
resource as defined in clause 5.4.24 shall have been created.
The creation of an "Individual VNF snapshot" resource can be performed for two reasons:
- To create an "Individual VNF snapshot" resources that can later be populated by a
new VNF snapshot taken from a VNF instance (refer to clause 5.4.21.3.1).
- To create an "Individual VNF snapshot" resource that can be populated with information
gathered from a VNF snapshot package extraction. In this case, the API consumer indicates
the source of the VNF snapshot package in the payload body of the POST request to the
present resource.
In the second case, for a successful execution of the operation, the values in the
"VnfSnapshotInfo" data structure representing the "Individual VNF snapshot" resource
shall be applied as follows:
- If the request (refer to clause 5.5.2.20) includes the "vnfSnapshot" attribute,
the VNFM shall apply the "VnfSnapshotInfo" with such provided information.
- If the request (refer to clause 5.5.2.20) does not include the "vnfSnapshot"
attribute, the VNFM shall first fetch the VNF snapshot record from the source VNF
snapshot package signalled by the "vnfSnapshotPkgId" attribute in the request and
then apply the "VnfSnapshotInfo" from the fetched VNF snapshot record.
This method shall follow the provisions specified in the tables 5.4.23.3.1-1
and 5.4.23.3.1-2 for URI query parameters, request and response data structures,
and response codes.
requestBody:
$ref: '#/components/requestBodies/CreateVnfSnapshotInfoRequest'
$ref: '#/components/responses/VnfSnapshots.Post.201'
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
401:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
403:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
404:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
405:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
409:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
get:
description: >
The GET method queries information about multiple VNF snapshots.
This method shall follow the provisions specified in the tables 5.4.23.3.2-1
and 5.4.23.3.2-2 for URI query parameters, request and response data structures,
and response codes.
parameters:
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/all_fields
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/fields
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/exclude_fields
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/exclude_default
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker
$ref: '#/components/responses/VnfSnapshots.Get.200'
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
401:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
403:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
404:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
405:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
416:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416"
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
###############################################################################
# Individual VNF snapshot #
###############################################################################
/vnf_snapshots/{vnfSnapshotInfoId}:
#SOL003 location: 5.4.24.2
parameters:
- $ref: '#/components/parameters/VnfSnapshotInfoId'
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
get:
#SOL003 location: 5.4.24.3.2
The GET method retrieves information about a VNF snapshot by reading an "Individual VNF snapshot"
resource.
This method shall follow the provisions specified in the tables 5.4.24.3.2-1 and 5.4.24.3.2-2
for URI query parameters, request and response data structures, and response codes.
parameters:
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
$ref: '#/components/responses/IndividualVnfSnapshot.Get.200'
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
401:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
403:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
404:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
405:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
416:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416"
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
patch:
#SOL003 location: 5.4.24.3.4
description: |
This method modifies an "Individual VNF snapshot" resource.
Changes are applied to the VNF snapshot information managed by the VNFM and are reflected in the
representation of this resource. The VNFM shall reject the modification request if the "vnfSnapshot"
attribute in the "VnfSnapshotInfo" structure representing the "Individual VNF snapshot" resource
is not empty, or the resource is associated to an ongoing VNF snapshot operation (e.g., a VNF
snapshot creation process has started).
This method shall follow the provisions specified in the tables 5.4.24.3.4-1 and 5.4.24.3.4-2
for URI query parameters, request and response data structures, and response codes.
parameters:
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType
requestBody:
$ref: '#/components/requestBodies/VnfSnapshotInfoModificationRequest'
responses:
200:
$ref: '#/components/responses/IndividualVnfSnapshot.Patch.200'
400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
401:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
403:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
404:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
405:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
409:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
412:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/412"
416:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416"
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
delete:
#SOL003 location: 5.4.24.3.5
This method deletes an "Individual VNF snapshot" resource and the associated VNF snapshot
information managed by the VNFM, and any resource associated to the VNF snapshot managed
by the VIM.
As the result of successfully executing this method, the "Individual VNF snapshot" resource
shall not exist any longer.
This method shall follow the provisions specified in the tables 5.4.24.3.5-1 and 5.4.24.3.5-2
for URI query parameters, request and response data structures, and response codes.
responses:
204:
$ref: '#/components/responses/IndividualVnfSnapshot.Delete.204'
400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
401:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
403:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
404:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
405:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
409:
#409 CONFLICT
#Shall be returned upon the following error: The operation cannot be executed currently,
#due to a conflict with the state of the resource.
#Typically, this is due to the fact that the VNF snapshot is in use by some operation such
#as reverting a VNF instance to a VNF snapshot or creating a VNF snapshot package.
#The response body shall contain a ProblemDetails structure, in which the "detail" attribute
#shall convey more information about the error.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
412:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/412"
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
/vnf_snapshots/{vnfSnapshotInfoId}/vnf_state_snapshot:
#SOL003 location: 5.4.25.2
parameters:
- $ref: '#/components/parameters/VnfSnapshotInfoId'
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
get:
#SOL003 location: 5.4.25.3.2
description: |
The GET method fetches the content of the VNF state snapshot.
This method shall follow the provisions specified in the tables 5.4.25.3.2-1 and 5.4.25.3.2-2
for URI query parameters, request and response data structures, and response codes.
parameters:
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: '#/components/parameters/Range'
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
responses:
200:
$ref: '#/components/responses/IndividualVnfSnapshotState.Get.200'
206:
$ref: '#/components/responses/IndividualVnfSnapshotState.Get.206'
400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
401:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
403:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
404:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
405:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
409:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
416:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416"
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
components:
parameters:
VnfInstanceId:
name: vnfInstanceId
in: path
description: |
Identifier of the VNF instance for the VNF snapshot to be reverted to. This identifier can be retrieved from the resource
referenced by the "Location" HTTP header in the response to a POST request creating a new "Individual VNF instance" resource.
It can also be retrieved from the "id" attribute in the payload body of that response.
required: true
style: simple
explode: false
schema:
type: string
VnfLcmOpOccId:
name: vnfLcmOpOccId
in: path
description: |
Identifier of a VNF lifecycle management operation occurrence. This identifier can be retrieved from the resource
referenced by the "Location" HTTP header in the response to a PATCH or POST request triggering a VNF LCM operation.
It can also be retrieved from the "vnfLcmOpOccId" attribute in the VnfLcmOperationOccurrenceNotification.
required: true
style: simple
explode: false
schema:
type: string
SubscriptionId:
name: subscriptionId
in: path
description: |
Identifier of this subscription. This identifier can be retrieved from the resource referenced by the "Location"
HTTP header in the response to a POST request creating a new subscription resource. It can also be retrieved from
the "id" attribute in the payload body of that response.
required: true
style: simple
explode: false
schema:
type: string
VnfSnapshotInfoId:
name: VnfSnapshotInfoId
in: path
description: |
Identifier of the "Individual VNF snapshot" resource. This identifier can be retrieved
from the resource referenced by the "Location" HTTP header in the response to a POST request
creating a new VNF snapshot resource. It can also be retrieved from the "id" attribute in
the payload body of that response.
required: true
style: simple
explode: false
schema:
type: string
Range:
name: Range
in: header
description: |
The request may contain a "Range" HTTP header to obtain single
range of bytes from a VNF state snapshot file. This can be used to
continue an aborted transmission.
If the "Range" header is present in the request and the VNFM
does not support responding to range requests with a 206
response, it shall return a 200 OK response instead.
schema:
type: string
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
CreateVnfRequest:
description: The VNF creation parameters
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/CreateVnfRequest"
required: true
VnfInfoModificationRequest:
description: |
Parameters for the VNF modification, as defined in clause 5.5.2.12.
content:
application/json:
schema:
$ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInfoModificationRequest"
required: true
InstantiateVnfRequest:
description: Parameters for the VNF instantiation.
content:
application/json:
schema:
$ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/InstantiateVnfRequest"
required: true
ScaleVnfRequest:
description: Parameters for the scale VNF operation.
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ScaleVnfRequest"
required: true
ScaleVnfToLevelRequest:
description: Parameters for the scale VNF to Level operation.
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ScaleVnfToLevelRequest"
required: true
ChangeVnfFlavourRequest:
description: Parameters for the Change VNF Flavour operation.
content:
application/json:
schema:
$ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/ChangeVnfFlavourRequest"
required: true
TerminateVnfRequest:
description: Parameters for the VNF termination.
content:
application/json:
schema:
$ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/TerminateVnfRequest"
required: true
HealVnfRequest:
description: Parameters for the Heal VNF operation.
content:
application/json:
schema:
$ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/HealVnfRequest"
required: true
OperateVnfRequest:
description: Parameters for the Operate VNF operation.
content:
application/json:
schema:
$ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/OperateVnfRequest"
required: true
ChangeExtVnfConnectivityRequest:
description: |
Parameters for the Change external VNF connectivity operation.
content:
application/json:
schema:
$ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/ChangeExtVnfConnectivityRequest"
required: true
ChangeCurrentVnfPkgRequest:
description: |
Parameters for the Change current VNF package operation, as defined in clause 5.5.2.11a.
content:
application/json:
schema:
$ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/ChangeCurrentVnfPkgRequest"
required: true
LccnSubscriptionRequest:
description: |
Details of the subscription to be created.
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnSubscriptionRequest"
required: true
CreateVnfSnapshotRequest:
description: |
Parameters for the "Create VNF Snapshot" operation, as defined in clause 5.5.2.21.
content:
application/json:
schema:
$ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/CreateVnfSnapshotRequest"
required: true
RevertToVnfSnapshotRequest:
description: |
Parameters for the Revert to VNF snapshot operation, as defined in clause 5.5.2.26.
content:
application/json:
schema:
$ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/RevertToVnfSnapshotRequest"
required: true
CreateVnfSnapshotInfoRequest:
description: |
The VNF snapshot resource creation parameters, as defined in clause 5.5.2.20.
content:
application/json:
schema:
$ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/CreateVnfSnapshotInfoRequest"
required: true
VnfSnapshotInfoModificationRequest:
description: |
Parameters for the VNF snapshot information modification, as defined in clause 5.5.2.24.
content:
application/json:
schema:
$ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfSnapshotInfoModificationRequest"
required: true
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
responses:
VNFInstances.Post.201:
description: |
201 CREATED
Shall be returned when a new "Individual VNF instance" resource and
the associated VNF instance identifier washas been created successfully.
The response body shall contain a representation of the created VNF instance,
as defined in clause 5.5.2.2.
The HTTP response shall include a "Location" HTTP header that contains the resource
URI of the created VNF instance.
headers:
Location:
description: |
The resource URI of the created subscription resource.
style: simple
explode: false
schema:
type: string
format: url
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
VNFInstances.Get.200:
description: |
200 OK
Shall be returned when information about zero or more VNF instances has been queried successfully.
The response body shall contain in an array the representations of zero or more VNF instances,
as defined in clause 5.5.2.2.
If the "filter" URI parameter or one of the "all_fields", "fields" (if supported), "exclude_fields"
(if supported) or "exclude_default" URI parameters was supplied in the request, the data in the response
body shall have been transformed according to the rules specified in clauses 5.2.2 and 5.3.2 of
ETSI GS NFV-SOL 013, respectively.
If the VNFM supports alternative 2 (paging) according to clause 5.4.7.2.1 of ETSI GS NFV-SOL 013
for this resource, inclusion of the Link HTTP header in this response shall follow the provisions
in clause 4.7.2.3.5.4.2.3 of ETSI GS NFV-SOL 013.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
Link:
description: |
Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
type: array
items:
$ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
IndividualVnfInstance.Get.200:
description: |
200 OK
Shall be returned when information about an individual VNF instance has been read successfully.
The response body shall contain a representation of the VNF instance, as defined in clause 5.5.2.2.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
IndividualVnfInstance.Patch.202:
description: |
202 ACCEPTED
Shall be returned when the request has been accepted for processing.
On success, the HTTP response shall include a "Location" HTTP header that
contains the URI of the newly-created "Individual VNF LCM operation occurrence"
resource corresponding to the operation.
The response body shall be empty.
headers:
Location:
description: |
The resource URI of the created subscription resource.
style: simple
explode: false
schema:
type: string
format: url
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
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
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
IndividualVnfInstance.Delete.204:
description: |
204 NO CONTENT
Shall be returned when the "Individual VNF instance" resource and the associated
VNF identifier were deleted successfully.
The response body shall be empty.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
InstantiateVnfInstance.Post.202:
description: |
202 ACCEPTED
Shall be returned when the request has been accepted for processing
The response body shall be empty.
The HTTP response shall include a "Location" HTTP header that
contains the URI of the newly-created "Individual VNF LCM operation
occurrence" resource corresponding to the operation.
headers:
Location:
description: |
The resource URI of the created subscription resource.
style: simple
explode: false
schema:
type: string
format: url
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
ScaleVnfInstance.Post.202:
description: |
202 ACCEPTED
Shall be returned when the request has been accepted for processing.
The response body shall be empty.
The HTTP response shall include a "Location" HTTP header that
contains the URI of the newly-created "VNF LCM operation
occurrence" resource corresponding to the operation.
headers:
Location:
description: |
The resource URI of the created subscription resource.
style: simple
explode: false
schema:
type: string
format: url
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
ScaleToLevelVnfInstance.Post.202:
description: |
202 ACCEPTED
Shall be returned when the request has been accepted for processing.
The response body shall be empty.
The HTTP response shall include a "Location" HTTP header that
contains the URI of the newly-created "VNF LCM operation
occurrence" resource corresponding to the operation.
headers:
Location:
description: |
The resource URI of the created subscription resource.
style: simple
explode: false
schema:
type: string
format: url
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
ChangeFlavourVnfInstance.Post.202:
description: |
202 ACCEPTED
Shall be returned when the request has been accepted for processing.
The response body shall be empty.
The HTTP response shall include a "Location" HTTP header that
contains the URI of the newly-created "VNF LCM operation
occurrence" resource corresponding to the operation.
headers:
Location:
description: |
The resource URI of the created subscription resource.
style: simple
explode: false
schema:
type: string
format: url
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
TerminateVnfInstance.Post.202:
description: |
202 ACCEPTED
Shall be returned when the request has been accepted for processing.
The response body shall be empty.
The HTTP response shall include a "Location" HTTP header that
contains the URI of the newly-created "VNF LCM operation
occurrence" resource corresponding to the operation.
headers:
Location:
description: |
The resource URI of the created subscription resource.
style: simple
explode: false
schema:
type: string
format: url
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
HealVnfInstance.Post.202:
description: |
202 ACCEPTED
Shall be returned when the request has been accepted for processing.
The response body shall be empty.
The HTTP response shall include a "Location" HTTP header that
contains the URI of the newly-created "VNF LCM operation
occurrence" resource corresponding to the operation.
headers:
Location:
description: |
The resource URI of the created subscription resource.
style: simple
explode: false
schema:
type: string
format: url
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
OperateVnfInstance.Post.202:
description: |
202 ACCEPTED
Shall be returned when the request has been accepted for processing.
The response body shall be empty.
The HTTP response shall include a "Location" HTTP header that
contains the URI of the newly-created "VNF LCM operation
occurrence" resource corresponding to the operation.
headers:
Location:
description: |
The resource URI of the created subscription resource.
style: simple
explode: false
schema:
type: string
format: url
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
ChangeExtConnVnfInstance.Post.202:
description: |
202 ACCEPTED
Shall be returned when the request has been accepted for processing.
The response body shall be empty.
The HTTP response shall include a "Location" HTTP header that
contains the URI of the newly-created "VNF LCM operation
occurrence" resource corresponding to the operation.
headers:
Location:
description: |
The resource URI of the created subscription resource.
style: simple
explode: false
schema:
type: string
format: url
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
ChangeVnfpkgVnfInstance.Post.202:
description: |
202 ACCEPTED
Shall be returned when the request has been accepted for processing.
The response body shall be empty.
The HTTP response shall include a "Location" HTTP header that contains the URI of
the newly-created "VNF LCM operation occurrence" resource corresponding to the operation.
headers:
Location:
description: |
The resource URI of the created subscription resource.
style: simple
explode: false
schema:
type: string
format: url
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
VnfLcmOpOccs.Get.200:
description: |
200 OK
Shall be returned when status information for zero or more VNF lifecycle management
operation occurrences has been queried successfully.
The response body shall contain in an array the status information about zero or more
VNF lifecycle operation occurrences, as defined in clause 5.5.2.13.
If the "filter" URI parameter or one of the "all_fields", "fields" (if supported),
"exclude_fields" (if supported) or "exclude_default" URI parameters was supplied in the request,
the data in the response body shall have been transformed according to the rules specified
in clauses 5.2.2 and 5.3.2 of ETSI GS NFV-SOL 013, respectively.
If the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013
for this resource, inclusion of the Link HTTP header in this response shall follow the provisions
in clause 5.4.2.3 of ETSI GS NFV-SOL 013.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
Link:
description: |
Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc"
IndividualVnfLcmOpOcc.Get.200:
description: |
200 OK
Shall be returned when information about a VNF LCM operation occurrence washas been read successfully.
The response body shall contain status information about a VNF lifecycle management operation occurrence
(see clause 5.5.2.13).
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc"
RollbackVnfLcmOpOcc.Post.202:
description: |
202 ACCEPTED
Shall be returned when the request has been accepted for processing.
The response shall have an empty payload body.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
RetryVnfLcmOpOcc.Post.202:
description: |
202 ACCEPTED
Shall be returned when the request has been accepted for processing.
The response shall have an empty payload body.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
FailVnfLcmOpOcc.Post.200:
description: |
200 OK
Shall be returned when the state of the VNF lifecycle management operation occurrence
has been changed successfully.
The response bofyshall include a representation of the "Individual VNF lifecycle operation occurrence"
resource.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc"
CancelVnfLcmOpOcc.Post.202:
description: |
202 ACCEPTED
Shall be returned when the request has been accepted for processing.
The response shall have an empty payload body.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Subscriptions.Post.201:
description: |
201 CREATED
Shall be returned when the subscription has been created successfully.
The response body shall contain a representation of the created "Individual subscription" resource.
The HTTP response shall include a "Location" HTTP header that points to the created
"Individual subscription" resource.
headers:
Location:
description: |
The resource URI of the created subscription resource.
style: simple
explode: false
schema:
type: string
format: url
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnSubscription"
Subscriptions.Get.200:
description: |
200 OK
Shall be returned when the list of subscriptions has been queried successfully.
The response body shall contain in an array the representations of all active subscriptions of
the functional block that invokes the method, i.e. zero or more representations of lifecycle change
notification subscriptions as defined in clause 5.5.2.16.
If the "filter" URI parameter was supplied in the request, the data in the response body shall have been
transformed according to the rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013.
If the VNFM supports alternative 2 (paging) according to clause 5.4.7.2.1 of ETSI GS NFV-SOL 013
for this resource, inclusion of the Link HTTP header in this response shall follow the provisions
in clause 4.7.2.3.5.4.2.3 of ETSI GS NFV-SOL 013.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
Link:
description: |
Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnSubscription"
IndividualSubscription.Get.200:
description: |
200 OK
Shall be returned when information about an individual subscription has been read successfully.
The response body shall contain a representation of the "Individual subscription" resource.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
2796
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
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
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
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnSubscription"
IndividualSubscription.Delete.204:
description: |
204 NO CONTENT
Shall be returned when the "Individual subscription" resource has been deleted successfully.
The response body shall be empty.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
CreateVnfSnapshotTask.Post.202:
description: |
202 ACCEPTED
Shall be returned when the request was accepted for processing, but the processing
has not been completed.
The response body shall be empty.
The HTTP response shall include a "Location" HTTP header that contains the URI of
the newly-created "VNF LCM operation occurrence" resource corresponding to the operation.
headers:
Location:
description: |
The resource URI of the created subscription resource.
style: simple
explode: false
schema:
type: string
format: url
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
RevertToVnfSnapshotTask.Post.202:
description: |
202 ACCEPTED
Shall be returned when the request was accepted for processing, but the processing has
not been completed.
The response body shall be empty.
The HTTP response shall include a "Location" HTTP header that contains the URI of
the newly-created "VNF LCM operation occurrence" resource corresponding to the operation.
headers:
Location:
description: |
The resource URI of the created subscription resource.
style: simple
explode: false
schema:
type: string
format: url
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
VnfSnapshots.Post.201:
description: |
201 CREATED
Shall be returned when an "Individual VNF snapshot" resource has been created
successfully.
The response body shall contain a representation of the new "Individual VNF snapshot"
resource, as defined in clause 5.5.2.22.
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
The HTTP response shall include a "Location" HTTP header that contains the resource URI
of the "Individual VNF snapshot" resource.
headers:
Location:
description: |
The resource URI of the created subscription resource.
style: simple
explode: false
schema:
type: string
format: url
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfSnapshotInfo"
VnfSnapshots.Get.200:
description: |
200 OK
Shall be returned when information about zero or more VNF snapshots was queried successfully.
The response body shall contain in an array the representations of zero or more
"Individual VNF snapshot" resources, as defined in clause 5.5.2.22.
If the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013
for this resource, inclusion of the Link HTTP header in this response shall follow the provisions
in clause 5.4.2.3 of ETSI GS NFV-SOL 013.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
Link:
description: |
Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
type: array
items:
$ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfSnapshotInfo"
IndividualVnfSnapshot.Get.200:
description: |
200 OK
Shall be returned when information about an individual VNF snapshot was read successfully.
The response body shall contain a representation of the "Individual VNF snapshot" resource,
as defined in clause 5.5.2.22.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfSnapshotInfo"
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
IndividualVnfSnapshot.Patch.200:
description: |
200 OK
Shall be returned when the modification of VNF snapshot information has been accepted and completed.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfSnapshotInfoModifications"
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
IndividualVnfSnapshot.Delete.204:
description: |
204 NO CONTENT
Shall be returned when the VNF snapshot resource and the associated VNF snapshot were
deleted successfully.
The response body shall be empty.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
IndividualVnfSnapshotState.Get.200:
description: |
200 OK
Shall be returned when the whole content of the VNF state snapshot file has been read successfully.
The payload body shall contain a copy of the VNF state snapshot file and the "Content-Type" HTTP
header shall be set according to the content type of the VNF state snapshot file. If the VNF state
snapshot content is encrypted, the header shall be set to the value "application/cms" (IETF RFC 7193).
If the content type cannot be determined, the header shall be set to the value "application/octet-stream".
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/*:
schema:
type: string
format: binary
IndividualVnfSnapshotState.Get.206:
description: |
206 PARTIAL CONTENT
If the VNFM supports range requests, this response shall be returned when a single consecutive byte
range from the content of the VNF state snapshot file has been read successfully according to the request.
The response body shall contain the requested part of the VNF state snapshot file. The "Content-Type" HTTP
header shall be set according to the content type of the VNF state snapshot file. If the content type cannot
be determined, the header shall be set to the value "application/octet-stream".
The "Content-Range" HTTP header shall be provided according to IETF RFC 7233.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Range:
required : true
style: simple
explode: false
schema:
type: string
content:
application/*:
schema:
type: string
format: binary