Description: Objects to control Agent software update, activation or removal. If the Agent doesn't support software update/activation/removal at all, always 'no such object' has to be returned to any request within this section.

General: - Any state transition not shown in the state diagram (except state transcision to idle - see idle description) is not allowed and should respond an SNMP error code. Before responding the error code, fulStateResultOk and fulStateResultString should be prepared accordingly. - swActivePackageVersion and swActivePackagePatchLevel show the version and patch level of the actual active SW package at the Agent. - swPackagesTable lists always all SW packages that are available at the Agent. Note: Depending on the Agent implementation swPackagesTable may list one (NodeA), two (NodeAM) or several (ION) available packages.

Preconditions for SW update (all workflows) are: - swState = idle (default at Agent startup) - swStateResultOk and swActivationForced = false (default at Agent startup) - swPackageVersion, swStateResultString and swNeededFilesTable are empty (defaults at Agent startup) - swPackagePatchLevel = 0 (default at Agent startup)

Workflow SW update - file transfer: - Manager sets swPackageVersion - Manager sets swPackagePatchLevel - Manager sets swState = versionReq Manager performs file upload of the SW package TOC file - Manager sets swState = prepareVersionRsp Agent analyzes the TOC file, updates swNeededFilesTable accordingly, sets swStateResultOk and swStateResultString accordingly and finally Agent sets swState = versionRsp - Manager gets swState in a loop until swState = versionRsp - Manager gets swStateResultOk and swStateResultString Manager gives corresponding user feedback. - Manager sets swState = fileTransfer Manager sends all necessary files to the Agent using File Upload (commonDeviceFileTransfer.fUpload) - If all files are uploaded, Manager sets swState = fileTransferDone Agent updates swPackagesTable with the actual transferred package swPackageVersion / swPackagePatchLevel before sending the SNMP SET response. - Manager can go on with package activation or cancel (back to idle)

Workflow SW update - package activation: - Manager sets swPackageVersion - Manager sets swPackagePatchLevel - Manager sets swActivationForced accordingly (default should be 'false') - Manager sets swState = versionActivation Agent performs the neccessary actions to activate the SW package (package uncompression, database migration if not up to date, distribute SW to sub components,...), provides regular SW activation notifications (swActivationProgress, swState = versionActivation and progress info in swStateResultString), sets swStateResultOk and swStateResultString accordingly and finally Agent sets swState = versionActivationOrRemovalDone and sends final SW activation notification (swState = versionActivationOrRemovalDone) - Manager processes received SW activation notifications and gives corresponding user feedback - Manager waits for final SW activation notification and (optional, only with AlwaysOn connection) may get the swState in a loop until swState = versionActivationOrRemovalDone In case of timeout waiting for the final SW activation notification (which may get lost if not send as inform) the Manager finally gets swState, swStateResultOk and swStateResultString - Manager gives corresponding final user feedback. - Note: Depending on the Agent implementation package activation may force an Agent restart / reboot. Nevertheless the Agent should provide the final SW activation notification during startup. If the Agent is not able to do this (see also alarmTrapCounter description), the agentUpAndRunningEvent indicates the end of the package activation. If in this case within the agentUpAndRunningEvent the reported swActivePackageVersion is equal to the requested swPackageVersion and the reported swActivePackagePatchLevel is equal to the requested swPackagePatchLevel the package activation was successful, otherwise not. The Manager has to consider this issue.

Workflow SW update - package removal: - Manager sets swPackageVersion - Manager sets swPackagePatchLevel - Manager sets swState = versionRemoval Agent performs the neccessary actions to remove the SW package, removes corresponding swPackageVersion / swPackagePatchLevel entry from swPackagesTable, sets swStateResultOk and swStateResultString accordingly and finally Agent sets swState = versionActivationOrRemovalDone - Manager gets swState in a loop until swState = versionActivationOrRemovalDone - Manager gets swStateResultOk and swStateResultString Manager gives corresponding user feedback. - Note: Depending on the Agent implementation package removal may not be supported. In this case the Agent should respond an appropriate error like during an invalid state transicion (see General above).

Workflow cancel SW update: - Manager sets swState = idle Upon this, the Agent resets swStateResultOk to false and all the other objects to the default values listed in the SW update preconditions above.

V1.5.3.0 workflow extensions - immediate file activation after upload: Manager detects swNeededFilesImmediateActivationRequired=true during fileTransfer after successful upload of a file. In this case: - Manager stops continuing fileTransfer of the remaining files by setting swState = fileTransferDone and continues with SW package activation immediately. - Manager waits for file activation synchronization notification identified by swNeededFilesImmediateActivationSync. - Agent performs corresponding file activation actions on SW package activation request and sends corresponding file activation synchronization notification when finished (reboot may take place). - Manager immediately starts SW update file transfer newly for the remaining files to upload. In this case the Agent might not request previously uploaded and already activated files again, otherwise there will be an endless upload/activation loop. If there are no remaining files to upload: - Manager verifies the overall SW package activation result. Note: Relevant for the overall SW package activation result is just the SW package version / result information sent with the file activation finished synchronization notification for the last file within swNeededFilesTable. For all other intermediate file activations the SW package version information may be not available or empty resp. the result may be false. In case the last file within swNeededFilesTable does not need immediate activation, swFinalActivationNotification is relevant for the overall SW package activation result. If the swFinalActivationNotification object is not available, the Manager has to assume the agentUpAndRunningEvent.