From 3afecd8548fe4aec8a2bb4d441024e19996e2c79 Mon Sep 17 00:00:00 2001 From: cubag Date: Tue, 28 Nov 2023 02:12:56 +0000 Subject: [PATCH 1/2] update osmclient documentation with ns-op-cancel command --- 10-osm-client-commands-reference.md | 17 +++++++++++++++++ 12-osm-nbi.md | 2 +- 2 files changed, 18 insertions(+), 1 deletion(-) diff --git a/10-osm-client-commands-reference.md b/10-osm-client-commands-reference.md index b2f13ef..727610f 100644 --- a/10-osm-client-commands-reference.md +++ b/10-osm-client-commands-reference.md @@ -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. + +## 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: diff --git a/12-osm-nbi.md b/12-osm-nbi.md index 090a37c..5d96424 100644 --- a/12-osm-nbi.md +++ b/12-osm-nbi.md @@ -118,7 +118,7 @@ URL: /osm GET POST heal 5 /ns_lcm_op_occs 5 5 / 5 5 5 - TO BE COMPLETED 5 5 + cancel 05 /vnf_instances (also vnfrs for compatibility) O / O /subscriptions 5 5 -- GitLab From ea4bea794a633012ec8d5cbf023122aecd8762a3 Mon Sep 17 00:00:00 2001 From: garciadeblas Date: Thu, 21 Dec 2023 11:26:14 +0000 Subject: [PATCH 2/2] Update 10-osm-client-commands-reference.md, 05-osm-usage.md files --- 05-osm-usage.md | 15 +++++++++++++++ 10-osm-client-commands-reference.md | 16 ---------------- 2 files changed, 15 insertions(+), 16 deletions(-) diff --git a/05-osm-usage.md b/05-osm-usage.md index c2f48cb..a89db42 100644 --- a/05-osm-usage.md +++ b/05-osm-usage.md @@ -2009,6 +2009,21 @@ __Step 2: See the notification in notification receiver.__ - Support for subscription and notification for VNFD. - Cache to store subscribers. +## How to cancel an ongoing operation over a NS + +The OSM client command `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. + ## Start, Stop and Rebuild operations over a VDU of a running VNF instance These three operations involves starting , stopping, and rebuilding of a VDU on a running VNF instance by using the NGUI. diff --git a/10-osm-client-commands-reference.md b/10-osm-client-commands-reference.md index 727610f..ce8f40a 100644 --- a/10-osm-client-commands-reference.md +++ b/10-osm-client-commands-reference.md @@ -580,22 +580,6 @@ The following video illustrates the log detail for each verbosity level. - -## 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: -- GitLab