IBM DataPower Operations Dashboard v1.0.12.0

A newer version of this product documentation is available.

You are viewing an older version. View latest at IBM DPOD Documentation.

Firmware Upgrade Status Codes

Here are some common statuses for Firmware upgrade task executions.

Status Code
Description
WAITING_FOR_PRE_VALIDATIONThe task was entered into the execution queue, it was not yet validated or checked, and eventually may not get executed
SKIPPED_DEVICE_DOES_NOT_EXIST
SKIPPED_DEVICE_NOT_AVAILABLE
The task will not execute - the device was not available or does not exist/setup in DPOD
SKIPPED_NO_DEVICES_MATCHING_PATTERNThe task will not execute - no devices were matching the device pattern requested in the activity
VALIDATION_INTERNAL_EXCEPTION
SKIPPED_INTERNAL_EXCEPTION
ERROR_EXCEPTION_IN_PRE_VALIDATIONS
The task will not execute - an internal error occurred, a UUID will be printed, search the logs for this UUID in order to get more information
ERROR_IMAGE_FILE_DOES_NOT_EXISTThe task will not execute - The firmware image file that was specified for the activity was not found on disk
see Configurable Parameters and Settings on how to change the image repository path
ERROR_UNSUPPORTED_DEVICE_TYPEThe task will not execute - The only supported device types are IDG, XB62, XI52 and XG45
ERROR_COULD_NOT_PARSE_IMAGE_FILE_NAMEThe task will not execute - the image file's name was not in the standard format:
modelType+firmwareVersion+.+features+.+imageFormat
For example: idg7519.oradco.scrypt4
ERROR_DEVICE_AND_IMAGE_MODEL_GROUPS_ARE_DIFFERENTThe task will not execute - the image file's prefix indicated a model type different than the device type, 
For example, the image file was idg7519.oradco.scrypt4 but the device was XG45
ERROR_DOWNGRADE_NOT_SUPPORTEDThe task will not execute - the firmware version of the image file was lower than the device's firmware version.
Downgrade is supported only within the same major version (e.g. 7.5.1.7 to 7.5.1.4), only if approved in the activity definition
ERROR_DOWNGRADE_MAJOR_RELEASE_NOT_APPROVEDThe task will not execute - the firmware version of the image file was lower than the device's version, but in the same major version (e.g. 7.5.1.7 to 7.5.1.4),
User approval for the downgrade was not given in the activity definition
ERROR_DEVICE_AND_IMAGE_VERSIONS_ARE_IDENTICALThe task will not execute - the firmware version of the image file was identical to the device's version.
ERROR_DEVICE_FEATURES_NOT_FOUND_IN_IMAGE

The task will not execute - the image file does not contain features (Tibco-EMS or DCO-Oracle) that found on the device
The upgrade may still commence if user approval for this situation was given in the activity definition

ERROR_IMAGE_FEATURES_NOT_FOUND_IN_DEVICEThe task will not execute - the device does not contain features (Tibco-EMS or DCO-Oracle) that found in the image file
ERROR_UNKNOWN_IMAGE_FILE_FORMATThe task will not execute - only image files that end with scrypt3 or scrypt4 are supported
ERROR_IMAGE_NOT_DESIGNED_FOR_VIRTUAL_DEVICESThe task will not execute - scrypt3 file was chosen for upgrading virtual appliance
ERROR_IMAGE_NOT_DESIGNED_FOR_PHYSICAL_DEVICESThe task will not execute - scrypt4 file was chosen for upgrading physical appliance
ERROR_NOT_ENOUGH_FREE_ENCRYPTED_SPACE_ON_DEVICEThe task will not execute - there is not enough free space to upload the image file to the device's encrypted file system (free space is needed in both encrypted and temporary file systems)
ERROR_NOT_ENOUGH_FREE_TEMP_SPACE_ON_DEVICEThe task will not execute - there is not enough free space to upload the image file to the device's temporary file system  (free space is needed in both encrypted and temporary file systems)
ERROR_FOUND_UNSAVED_CHANGES_ON_DEVICEThe task will not execute - Unsaved changes were found in the device, apply all unsaved changes before starting the firmware upgrade again.
SKIPPED_BECAUSE_ERROR_POLICY
EXECUTION_CANCELED_BECAUSE_ERROR_POLICY
The task will not execute - Another task failed and specified Error Policy = Fail (See Maintenance Concepts to learn more about Error Policies)
ERROR_WHILE_GETTING_DEVICE_LICENSES
ERROR_GETTING_SOURCE_DOMAIN_STATUS
ERROR_EXCEPTION_WHILE_GETTING_SOURCE_DOMAIN_STATUS
The task will not execute - and error was returned when DPOD was communicating with the monitored device.
Search the log files with the error code for more information.
PLAN_FAILED_PRE_SCRIPTThe task will not execute - the pre-plan script returned with a return code greater than 0
EXECUTION_CANCELED_BECAUSE_A_DAY_PASSEDThe task was not executed - it was automatically canceled because more than 24 hours passed since it started to wait for execution
EXECUTION_CANCELED_BECAUSE_MAINTENANCE_WINDOWThe task was not executed - the current time is not within the maintenance window (see Maintenance Concepts for more information about the maintenance window), the maintenance window is checked for all execution types - schedules, ad-hoc via the UI and via the REST API
READY_FOR_EXECUTIONInterim status - the task passed all validation, it is queued and will be executed in the next minute, or is waiting for other tasks to finish executing first.
SENT_TO_MDB
EXECUTION_STARTED
EXECUTION_PRE_CHECKS_STARTED
Interim status - the task is executing
EXECUTION_PRE_CHECKS_FOUND_QUIESCED_DOMAIN_IN_DEVICETask failed - one or more domains are quiesced, unquiesce all domains before running the upgrade
EXECUTION_PRE_CHECKS_DEVICE_FIRMWARE_LEVEL_CHANGEDTask failed - The firmware level of the device was changed by an external party during the upgrade task execution, DPOD will assume that another upgrade (manual or by DPOD) is running and will stop the execution
EXECUTION_PRE_CHECKS_DEVICE_NOT_FOUND
EXECUTION_PRE_CHECKS_DEVICE_NOT_AVAILABLE
Task failed - the DataPower device was not available, or not found in DPOD managed devices.
EXECUTION_WAITING_FOR_PRE_SCRIPTWaiting for the user pre script to execute
EXECUTION_PRE_SCRIPT_ERRORTask failed - the user pre task script return code was larger than 0, the post task script will still be executed (if specified)
EXECUTION_FIRST_QUIESCE_STARTED
EXECUTION_SECOND_QUIESCE_STARTED
Quiesce domain/device started
First Quiesce = optional quiesce that can be requested by the user 
Second Quiesce = a mandatory quiesce that is issued by DPOD just before the upgrade starts
EXECUTION_FIRST_QUIESCE_WAITING_FOR_QUIESCE
EXECUTION_SECOND_QUIESCE_WAITING_FOR_QUIESCE
Waiting for the device or domain to quiesce
First Quiesce = optional quiesce that can be requested by the user 
Second Quiesce = a mandatory quiesce that is issued by DPOD just before the upgrade starts
EXECUTION_FIRST_QUIESCE_TIMEOUT_OCCURRED
EXECUTION_SECOND_QUIESCE_TIMEOUT_OCCURRED
A timeout occurred while waiting for the device or domain to quiesce, the timeout can be configured -  see Configurable Parameters and Settings 
(DPOD will add 3 minutes to the specified timeout)
First Quiesce = optional quiesce that can be requested by the user 
Second Quiesce = a mandatory quiesce that is issued by DPOD just before the upgrade starts
EXECUTION_RESTART_TIMEOUT_OCCURRED

A timeout occurred while waiting for the device to restart, the timeout can be configured -  see Configurable Parameters and Settings 
DPOD stops the operation and will not upgrade the device

EXECUTION_RESTART_WAITING_FOR_RESTARTDPOD is waiting for the device to restart
EXECUTION_WAIT_AFTER_RESTART_STARTEDDPOD is waiting for the time specified in the activity definition (this can only happen after a restart was completed successfully)
EXECUTION_UPLOAD_IMAGE_STARTED
EXECUTION_WAITING_FOR_UPLOAD_IMAGE
DPOD is uploading the image file to the device
EXECUTION_UPLOAD_IMAGE_ERRORTask failed - error occurred while uploading the image file to the device, DPOD uses a script to upload the file - search the logs for "EXECUTION_UPLOAD_IMAGE_ERROR" to see the detailed output the script.
EXECUTION_UPGRADE_STARTEDDPOD started the firmware upgrade on the monitored device.
EXECUTION_UPGRADE_WAITING_FOR_UPGRADEThe upgrade was started, the device will restart during the process, DPOD is waiting for the device to finish the upgrade
EXECUTION_UPGRADE_TIMEOUT_OCCURREDTask failed - DPOD waited for the device to upgrade more than the time that was specified in the activity definition 
The device may or may not have been successfully upgraded, you should check the device's status manually
EXECUTION_UNQUIESCE_ON_ERROR_STARTEDAn error occured in a previous state while the device was quiesced, DPOD is unquiescing the device before ending the task
EXECUTION_UNQUIESCE_ON_ERROR_WAITING_FOR_UNQUIESCEAn error occured in a previous state while the device was quiesced, DPOD is unquiescing the device before ending the task
EXECUTION_UNQUIESCE_ON_ERROR_TIMEOUT_OCCURREDAn error occured in a previous state while the device was quiesced, DPOD tryed to unquiesce the device before ending the task, but aa timeout occurred while waiting for the device to unquiesce, the timeout can be configured -  see Configurable Parameters and Settings (DPOD will add 3 minutes to the specified timeout)
EXECUTION_UPLOAD_IMAGE_EXCEPTION
EXECUTION_UPGRADE_EXCEPTION_OCCURRED
EXECUTION_SECOND_QUIESCE_EXCEPTION_OCCURRED
EXECUTION_UNQUIESCE_ON_ERROR_EXCEPTION_OCCURRED
An internal error occurred, a UUID will be printed, search the logs for this UUID in order to get more information
EXECUTION_FAILED_WITH_INTERNAL_EXCEPTIONInternal error occurred, see error message for details
EXECUTION_FAILED_LONG_RUNNINGThe task was running for more than 60 minutes (see Configurable Parameters and Settings on how to change this duration) and was marked as finished, the task may still be executing, manual intervention may be required
SUCCESSThe upgrade finished successfully

IBM DataPower Operations Dashboard (DPOD) v1.0.12.0