Commit 3afecd85 authored by cubag's avatar cubag
Browse files

update osmclient documentation with ns-op-cancel command

parent 810b217e
Pipeline #13289 passed with stage
in 59 seconds
......@@ -53,6 +53,7 @@ Commands:
ns-delete deletes a NS instance
ns-list list all NS instances
ns-metric-export exports a metric to the internal OSM bus, which can be read by other apps
ns-op-cancel cancels an ongoing NS operation
ns-op-list shows the history of operations over a NS instance
ns-op-show shows the info of a NS operation
ns-show shows the info of a NS instance
......@@ -579,6 +580,22 @@ The following video illustrates the log detail for each verbosity level.
<script id="asciicast-336575" src="https://asciinema.org/a/336575.js" async></script>
## Cancelling ongoing operations
`ns-op-cancel` allows to cancel any ongoing operation of Network Service. For instance, to cancel the instantiation of a NS execute the following steps:
1. Create the NS with `osm ns-create` and save the Network Service ID (NS_ID)
2. Obtain the Operation ID of the NS instantiation with `osm ns-op-list NS_ID`
3. Cancel the operation with `osm ns-op-cancel OP_ID`
4. The NS will be in `FAILED_TEMP` status.
Be aware that resources created before the cancellation will not be rolled back and the Network Service could be unhealthy.
If some operation is blocked due to an ungraceful restart of LCM module, you can use this command to delete the operation and unblock the Network Service.
Queued (unstarted) operations can also be deleted with this command.
## Other useful options
Some commands present useful options:
......
......@@ -118,7 +118,7 @@ URL: /osm GET POST
heal 5
/ns_lcm_op_occs 5 5
/<nsLcmOpOccId> 5 5 5
TO BE COMPLETED 5 5
cancel 05
/vnf_instances (also vnfrs for compatibility) O
/<vnfInstanceId> O
/subscriptions 5 5
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment