class UpgradePackage

+-SystemFunctions

+-SwM

+-UpgradePackage

+-RoleUpgrade [0..1]

Describes the process of changing the software configuration of an ME and actions to control the change process.

An instance of UpgradePackage (UP) represents a specific change of software configuration from the existing one to the new one identified by the attribute administrativeData. The execution of the change process described by UP class is the normal way to change the content of the SW inventory.

An UP may be seen as a "modification agent": it can add new, remove, or modify functionality.

When the upgrade package MO is created the upgrade control file is downloaded to specify the administrative data and the activation steps for this upgrade.
The sequence in which a Software upgrade executes is:

1. Prepare
2. Verify (optional)
3. Activate
4. Commit

This MO is created by the system.

References from:: SwM;
References to:: ManagedObject;

Actions
`boolean`	`activate ( );` Current upgrade package is taken into operation fully or partially. Partial activation occurs if the UCF defines activation steps and the attribute ignoreBreakPoints is false. The ME upgrade engine notifies the operator that the activation step is completed. The next activation step starts when the operator invokes an activate action. Each UP has to have at least 1 activation step. When the attribute ignoreBreakPoints=true, all activation steps are executed in sequence, when an activation step is complete the ME executes the next activation step i.e. there is no operator invocation when an activation step is complete. The time for observation of the correct operation of the ME after each completed step is always monitored by a supervision timer. The invocation of activate() may be monitored by a supervision timer. If the supervision timer expires before invocation of activate() or commit(), then the activation fails and the ME falls back to the state PREPARE_COMPLETED. The action returns immediately after invocation. The progress of the action can be tracked via the progressReport attribute. The action returns false if the action could not start for any reason (e.g., another parallel action is in progress), otherwise returns true. This action can be invoked when the state is PREPARE_COMPLETED or ACTIVATION_STEP_COMPLETED. If the action is invoked in a state where the action has no meaning, ME is expected to return an error message.
`boolean`	`cancel ( );` Stops the operation and restores the (consistent) state present before the long lasting operation was started. Cancel can be invoked during any long lasting operation. Furthermore, cancel() can also be invoked when the UP is in WAITING_FOR_COMMIT or ACTIVATION_STEP_COMPLETED state (without having a long lasting operation in progress). Calling cancel(), in this state, orders the ME to restore the state present before the activation procedure was started (PREPARE_COMPLETED). The action returns immediately after invocation. The consequences of the action can be tracked via the progressReport attribute. The action returns false if the action is refused by the ME, returns true otherwise. This action can be invoked when the UP state is PREPARE_IN_PROGRESS, VERIFICATION_IN_PROGRESS, ACTIVATION_IN_PROGRESS, ACTIVATION_STEP_COMPLETED, or WAITING_FOR_COMMIT. If the action is invoked in a state where the action has no meaning, the ME is expected to return false.
`boolean`	`commit ( );` Stops the activation supervision timer (fallback timer) and confirms the upgrade. The action returns when the action has completed (synchronous). This action can be invoked when the state is WAITING_FOR_COMMIT. The action returns true on success, false on failure.
`boolean`	`prepare ( );` Prepares the Managed Element for the activation of current upgrade package. Executing prepare() does not have any negative impact on the in service performance of Managed Element. The action returns immediately after invocation. The progress of the action can be tracked via the progressReport attribute. The action returns false if the action could not start for any reason (e.g., another parallel action is in progress), otherwise returns true.
`boolean`	`verify ( );` Verifies the ability to activate current upgrade package. The action returns immediately after invocation. The progress of the action can be tracked via the progressReport attribute. The action returns false if the action could not start for any reason (e.g., another parallel action is in progress), otherwise returns true. This action can be invoked when the state is PREPARE_COMPLETED. If the action is invoked in a state where the action has no meaning, ME is expected to return an error message. Calling this action is optional in the whole upgrade procedure. The action can be called more than once if wished.

Attributes
`int32 noNotification readOnly`	`activationFallbackTimer = -1` The activationFallbackTimer is the maximum execution time of an activation operation. The activationFallbackTimer is fetched from the packageInfo.xml. The default -1 value denotes that the activation timer is disabled.
`ActivationStep[1..] readOnly`	`activationStep` List of activation steps the activation procedure consists of. It is possible to stop after each step, perform supervision and continue with the procedure. The upgrade procedure consists of at least one activation step.
`ProductData[1..] readOnly`	`administrativeData` The product identification of the software version(s) being activated at successful completion of the full sequence of actions for an upgrade. If the resulting software version after activation is unknown or uncertain, the administrativeData could be empty.
`DateTime readOnly`	`created` Date and time this Upgrade Package instance was created.
`uint16[0..1] noNotification readOnly`	`creatorActionId = 0` The Id (actionId) of the action that have created this UpgradePackage managed object. The default 0 value denotes that the managed element does not record this information.
`string[0..1] readOnly`	`directoryPathExtension` DEPRECATED Relative path to the directory containing the Upgrade Package. It reflects the input given when creating this UP. If the UP is stored locally, this path extension is relative to the localFileStore FileGroup MO (or LocalFileStorePath). If the UP is stored remotely, this path extension is concatenated to the uriPathExtension in the TransferPolicyProducer. Deprecated:
`ExecMethod[0..1] noNotification`	`execMethod` The execution method of a specific UpgradePackage.
`boolean`	`ignoreBreakPoints = true` Influences the behaviour of the activate() action. false => There is a breakpoint between each activation step. Activation process stops at each breakpoint. true => Execution shall ignore breakpoints between activation steps and instead execute the end to end activation process invoking all activation steps in sequence (assuming no errors occur).
`boolean readOnly`	`isLocallyStored` DEPRECATED Shows if upgrade package is stored on the node. If true the upgrade package is stored in the local file system of the managed element. If false the upgrade package is stored in a remote file system (remote file server). Deprecated:
`ManagedObject[0..1] readOnly`	`remoteFileStore` DEPRECATED If the upgrade package is stored remotely, this attribute contains a reference to a TransferPolicyConsumer object. This attribute indicates the relative location of the UP and reflects the input given when creating this UP. Deprecated:
`AsyncActionProgressWithSteps readOnly`	`reportProgress` Represents the progress report (including result) of the ongoing action. This MO supports only one action to be executed at a time.
`UpgradePackageState readOnly`	`state` Current state of Upgrade Package.
`string key mandatory noNotification restricted`	`upgradePackageId` The value component of the RDN.
`string readOnly`	`uri` A URI pointing to the directory where the UP can be found. The URI may be local (e.g., file://data/dir/subdir) or a remote (e.g., ftp://hostname/dir/subdir).
`string[0..1]`	`userLabel` Used for free-text description.

class UpgradePackage