Cancel Upgrade Operation

1	Introduction
1.1	Prerequisites
2	Procedure

1 Introduction

This document describes how to cancel an upgrade operation.

The user can perform different types of cancel operations, described in Table 1.

Table 1 Types of Cancel Operation
Cancel Operation	Initial `UpgradePackage` MO State	Result of Cancel Operation
Cancel an ongoing `prepare` action	`PREPARE_IN_PROGRESS`	Back to state `INITIALIZED`, which is the state after the initial creation of the UpgradePackage Managed Object (MO).
Cancel an ongoing activation step	`ACTIVATION_IN_PROGRESS`	A fallback operation is triggered. The state is successively going from `DEACTIVATION_IN_PROGRESS` to `PREPARE_COMPLETED`.
Cancel a completed intermediary activation step in a step-by-step activation	`ACTIVATION_STEP_COMPLETED`
Cancel the final and completed activation step	`WAITING_FOR_COMMIT`

An ongoing operation is canceled when it has been started by mistake, at the wrong time, or takes too long time.

A completed activation step is canceled when the user observation and assessment of the Managed Element (ME) health check status is not according to expectations.

The procedure in this document focuses on an example where the user cancels the final and completed activation step in a one-step activation situation.

In this example, a software version with product name ERIC-COREMW_RUNTIME, product number CXP9020355_1, and product revision R7E01 is running in the system. A software upgrade package ERIC_UP-CXP9020355_1-R7F01, which is designed to upgrade this software version to product revision R7F01, has already been prepared and is going through the activation phase.

1.1 Prerequisites

This section describes the prerequisites, which must be fulfilled before using the procedure.

1.1.1 Conditions

The following conditions must apply:

The upgrade package is prepared.
The fallback capability is supported by the ME, that is, attribute timeoutFallbackCapability=SUPPORTED in the SwM MO.
The system is in state PREPARE_IN_PROGRESS, ACTIVATION_IN_PROGRESS, ACTIVATION_STEP_COMPLETED, or WAITING_FOR_COMMIT.
In this document, the UpgradePackage MO state is WAITING_FOR_COMMIT after execution of Steps 1 through 8 in Operating Instructions Upgrade Using One-Step Activation.
The ME has not successfully passed the health check routine after the software activation.
An Ericsson Command-Line Interface (ECLI) session in Exec mode is in progress.

2 Procedure

To cancel an upgrade operation:

Cancel the upgrade operation:
(UpgradePackage=UpgradePackage=ERIC_UP-CXP9020355_1-R7F01)>cancel

The system returns output true or false.

Attention!
Risk of system malfunction or traffic disturbance.

The cancel action automatically triggers a fallback to the earlier software version. This can imply some system outage because of reboot and reload.

Verify the result:

(UpgradePackage=UpgradePackage=ERIC_UP-CXP9020355_1-R7F01)>show -v

The following example output shows the final result. If state=CANCELLING, the operation is not yet completed. For a cancel operation, result=FAILURE because it refers to the initially started operation, which was an activation.

[...]
reportProgress <read-only>
   actionId=1 <read-only>
   actionName="Activate" <read-only>
[...]
   progressPercentage=100 <read-only>
   result=FAILURE <read-only>
   resultInfo="Rollback of campaign done" <read-only>
   state=CANCELLED <read-only>
   step=0 <read-only>
   stepProgressPercentage=100 <read-only>
[...]

Navigate to the SwM MO:
(UpgradePackage=ERIC_UP-CXP9020355_1-R7F01)>up

Verify that the active software version still is R7E01.

(SwM=1)>show -v

The following example output shows that R7E01 is the active software version

SwM=1
   activeSwVersion
      "ManagedElement=1,SystemFunctions=1,SwM=1,⇒
SwVersionMain=ERIC-COREMW_RUNTIME-CXP9020355_1-R7E01" <read-only>
[...]
   reportProgress <read-only>
[...]
   SwVersionMain=ERIC-COREMW_RUNTIME-CXP9020355_1-R7E01
[...]