LCM (2018-03-29)
POST /operations/LCM:action-status
Description: An operation to get the current state of the previously submitted LCM request
Consumes: [‘application/json’, ‘application/xml’]
Produces: [‘application/json’, ‘application/xml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
body |
body |
Responses
200 - No response was specified
POST /operations/LCM:attach-volume
Description: An operation to attach a cinder volume to a VM
Consumes: [‘application/json’, ‘application/xml’]
Produces: [‘application/json’, ‘application/xml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
body |
body |
Responses
200 - No response was specified
POST /operations/LCM:audit
Description: An operation to audit the configurations of a virtual network function (or VM)
Consumes: [‘application/json’, ‘application/xml’]
Produces: [‘application/json’, ‘application/xml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
body |
body |
Responses
200 - No response was specified
POST /operations/LCM:check-lock
Description: An operation to check VNF lock status
Consumes: [‘application/json’, ‘application/xml’]
Produces: [‘application/json’, ‘application/xml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
body |
body |
Responses
200 - No response was specified
POST /operations/LCM:config-backup
Description: An operation to Backup configurations of a virtual network function\n(or VM)
Consumes: [‘application/json’, ‘application/xml’]
Produces: [‘application/json’, ‘application/xml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
body |
body |
Responses
200 - No response was specified
POST /operations/LCM:config-backup-delete
Description: An operation to Delete backup configurations of a virtual network\nfunction (or VM)
Consumes: [‘application/json’, ‘application/xml’]
Produces: [‘application/json’, ‘application/xml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
body |
body |
Responses
200 - No response was specified
POST /operations/LCM:config-export
Description: An operation to Export configurations of a virtual network function\n(or VM)
Consumes: [‘application/json’, ‘application/xml’]
Produces: [‘application/json’, ‘application/xml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
body |
body |
Responses
200 - No response was specified
POST /operations/LCM:config-modify
Description: Use the ModifyConfig command when a full configuration cycle is either not required\nor is considered too costly. The ModifyConfig LCM action affects only a subset of the\ntotal configuration data of a VNF. The set of configuration parameters to be affected\nis a subset of the total configuration data of the target VNF type. The payload Stop\nApplication must contain the configuration parameters to be modified and their values.\nA successful modify returns a success response. A failed modify returns a failure\nresponse and the specific failure messages in the response payload Stop Application
Consumes: [‘application/json’, ‘application/xml’]
Produces: [‘application/json’, ‘application/xml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
body |
body |
Responses
200 - No response was specified
POST /operations/LCM:config-restore
Description: An operation to restore the configurations of a virtual network\nfunction (or VM)
Consumes: [‘application/json’, ‘application/xml’]
Produces: [‘application/json’, ‘application/xml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
body |
body |
Responses
200 - No response was specified
POST /operations/LCM:config-scale-out
Description: An operation to Modify the configuration or other action to support\na ConfigScaleOut of a VNF.
Consumes: [‘application/json’, ‘application/xml’]
Produces: [‘application/json’, ‘application/xml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
body |
body |
Responses
200 - No response was specified
POST /operations/LCM:configure
Description: An operation to configure the configurations of a virtual network\nfunction (or VM)
Consumes: [‘application/json’, ‘application/xml’]
Produces: [‘application/json’, ‘application/xml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
body |
body |
Responses
200 - No response was specified
POST /operations/LCM:detach-volume
Description: An operation to detach a cinder volume from a VM
Consumes: [‘application/json’, ‘application/xml’]
Produces: [‘application/json’, ‘application/xml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
body |
body |
Responses
200 - No response was specified
POST /operations/LCM:evacuate
Description: An operation to evacuate a virtual network function (or VM)
Consumes: [‘application/json’, ‘application/xml’]
Produces: [‘application/json’, ‘application/xml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
body |
body |
Responses
200 - No response was specified
POST /operations/LCM:health-check
Description: An operation to perform health check of vSCP prior its upgrading
Consumes: [‘application/json’, ‘application/xml’]
Produces: [‘application/json’, ‘application/xml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
body |
body |
Responses
200 - No response was specified
POST /operations/LCM:live-upgrade
Description: An operation to perform upgrade of vSCP
Consumes: [‘application/json’, ‘application/xml’]
Produces: [‘application/json’, ‘application/xml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
body |
body |
Responses
200 - No response was specified
POST /operations/LCM:lock
Description: An operation to perform VNF lock operation
Consumes: [‘application/json’, ‘application/xml’]
Produces: [‘application/json’, ‘application/xml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
body |
body |
Responses
200 - No response was specified
POST /operations/LCM:migrate
Description: An operation to migrate a virtual network function (or VM)
Consumes: [‘application/json’, ‘application/xml’]
Produces: [‘application/json’, ‘application/xml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
body |
body |
Responses
200 - No response was specified
POST /operations/LCM:query
Description: An operation to query the status of a targe VNF.\nReturns information on each VM, including state (active or standby)\nand status (healthy or unhealthy)
Consumes: [‘application/json’, ‘application/xml’]
Produces: [‘application/json’, ‘application/xml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
body |
body |
Responses
200 - No response was specified
POST /operations/LCM:quiesce-traffic
Description: An operation to stop traffic gracefully on the VF.\nIt stops traffic gracefully without stopping the application
Consumes: [‘application/json’, ‘application/xml’]
Produces: [‘application/json’, ‘application/xml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
body |
body |
Responses
200 - No response was specified
POST /operations/LCM:reboot
Description: An operation to reboot a specified virtual machine (VM)
Consumes: [‘application/json’, ‘application/xml’]
Produces: [‘application/json’, ‘application/xml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
body |
body |
Responses
200 - No response was specified
POST /operations/LCM:rebuild
Description: An operation to rebuild a virtual network function (or VM)
Consumes: [‘application/json’, ‘application/xml’]
Produces: [‘application/json’, ‘application/xml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
body |
body |
Responses
200 - No response was specified
POST /operations/LCM:restart
Description: An operation to restart a virtual network function (or VM)
Consumes: [‘application/json’, ‘application/xml’]
Produces: [‘application/json’, ‘application/xml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
body |
body |
Responses
200 - No response was specified
POST /operations/LCM:resume-traffic
Description: An operation to resume traffic gracefully on the VF.\nIt resumes traffic gracefully without stopping the application
Consumes: [‘application/json’, ‘application/xml’]
Produces: [‘application/json’, ‘application/xml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
body |
body |
Responses
200 - No response was specified
POST /operations/LCM:rollback
Description: An operation to rollback to particular snapshot of a virtual network function (or VM)
Consumes: [‘application/json’, ‘application/xml’]
Produces: [‘application/json’, ‘application/xml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
body |
body |
Responses
200 - No response was specified
POST /operations/LCM:snapshot
Description: An operation to create a snapshot of a virtual network function (or VM)
Consumes: [‘application/json’, ‘application/xml’]
Produces: [‘application/json’, ‘application/xml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
body |
body |
Responses
200 - No response was specified
POST /operations/LCM:software-upload
Description: An operation to upload a new version of vSCP image to vSCP for updating it
Consumes: [‘application/json’, ‘application/xml’]
Produces: [‘application/json’, ‘application/xml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
body |
body |
Responses
200 - No response was specified
POST /operations/LCM:start
Description: An operation to start a virtual network function (or VM)
Consumes: [‘application/json’, ‘application/xml’]
Produces: [‘application/json’, ‘application/xml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
body |
body |
Responses
200 - No response was specified
POST /operations/LCM:start-application
Description: An operation to perform VNF Start Application operation
Consumes: [‘application/json’, ‘application/xml’]
Produces: [‘application/json’, ‘application/xml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
body |
body |
Responses
200 - No response was specified
POST /operations/LCM:stop
Description: An operation to stop the configurations of a virtual network function (or VM)
Consumes: [‘application/json’, ‘application/xml’]
Produces: [‘application/json’, ‘application/xml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
body |
body |
Responses
200 - No response was specified
POST /operations/LCM:stop-application
Description: An operation to Stop Application traffic to a virtual network function
Consumes: [‘application/json’, ‘application/xml’]
Produces: [‘application/json’, ‘application/xml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
body |
body |
Responses
200 - No response was specified
POST /operations/LCM:sync
Description: An operation to sync the configurations of a virtual network function (or VM)
Consumes: [‘application/json’, ‘application/xml’]
Produces: [‘application/json’, ‘application/xml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
body |
body |
Responses
200 - No response was specified
POST /operations/LCM:terminate
Description: An operation to terminate the configurations of a virtual network function (or VM)
Consumes: [‘application/json’, ‘application/xml’]
Produces: [‘application/json’, ‘application/xml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
body |
body |
Responses
200 - No response was specified
POST /operations/LCM:test
Description: An operation to test the configurations of a virtual network function (or VM)
Consumes: [‘application/json’, ‘application/xml’]
Produces: [‘application/json’, ‘application/xml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
body |
body |
Responses
200 - No response was specified
POST /operations/LCM:unlock
Description: An operation to perform VNF unlock operation
Consumes: [‘application/json’, ‘application/xml’]
Produces: [‘application/json’, ‘application/xml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
body |
body |
Responses
200 - No response was specified
POST /operations/LCM:upgrade-backout
Description: An operation does a backout after an UpgradeSoftware is completed (either successfully or unsuccessfully).
Consumes: [‘application/json’, ‘application/xml’]
Produces: [‘application/json’, ‘application/xml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
body |
body |
Responses
200 - No response was specified
POST /operations/LCM:upgrade-backup
Description: An operation to do full backup of the VNF data prior to an upgrade.
Consumes: [‘application/json’, ‘application/xml’]
Produces: [‘application/json’, ‘application/xml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
body |
body |
Responses
200 - No response was specified
POST /operations/LCM:upgrade-post-check
Description: An operation to check the VNF upgrade has been successful completed and all processes are running properly.
Consumes: [‘application/json’, ‘application/xml’]
Produces: [‘application/json’, ‘application/xml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
body |
body |
Responses
200 - No response was specified
POST /operations/LCM:upgrade-pre-check
Description: An operation to check that the VNF has the correct software version needed for a software upgrade.
Consumes: [‘application/json’, ‘application/xml’]
Produces: [‘application/json’, ‘application/xml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
body |
body |
Responses
200 - No response was specified
POST /operations/LCM:upgrade-software
Description: An operation to upgrade the target VNF to a new version and expected that the VNF is in a quiesced status .
Consumes: [‘application/json’, ‘application/xml’]
Produces: [‘application/json’, ‘application/xml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
body |
body |
Responses
200 - No response was specified
POST /operations/LCM:download-n-e-sw
Description: An operation to download NE software.
Consumes: [‘application/json’, ‘application/xml’]
Produces: [‘application/json’, ‘application/xml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
body |
body |
Responses
200 - No response was specified
POST /operations/LCM:activate-n-e-sw
Description: An operation to activate NE software.
Consumes: [‘application/json’, ‘application/xml’]
Produces: [‘application/json’, ‘application/xml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
body |
body |
Responses
200 - No response was specified