Error Codes

Top  Previous  Next

This section covers both result codes in general and error conditions.

 

Result Codes

The Result Codes are displayed in the result child of the return element in many call responses.

 

Result Code

Meaning

internal.request.complete

For services without separate status methods, the request has completed successfully. For services with separate status methods such as switch and restart, the request has been started

internal.request.complete.message

The same as internal.request.complete, but the response includes messages for the end user.

internal.request.failed

The request failed. Ignore any results.

 

Soap Layer Messages

The Soap Layer Messages appear in the messageKey child of remoteMessages under the return element in many call responses.

 

Messages

Meaning

error.soap.internal

Error when a SOAP service experiences an unexpected problem.

error.remote.throttled

Error when the request was denied due to throttling.

error.validation.invalid

Validation error - required data is not valid.

error.validation.maxlength

Validation error - required data is too big.

error.validation.minlength

Validation error - required data is too small.

error.validation.range

Validation error - required data is not within a certain range.

error.validation.required

Validation error - required data is missing.

error.validation.mustbe

Validation error - required data must be a specific value to be valid.

 

Application Layer Messages

The Application Layer Messages appear in the messageKey child of remoteMessages under the return element in many call responses

 

Key

Meaning

internal.error.cmd.failed

The indicated command could not be executed.

internal.error.cmd.formatting

The indicated command could not be formatted correctly and therefore was not executed.

internal.error.cmd.resultsfile

The indicated command did not generate the appropriate results file. The process results could not be determined.

internal.error.cmd.running

The indicated command is still running.

internal.warning.cmd.interrupted

The indicated command was interrupted before it was completed.

internal.request.denied.lock

The system is currently locked by another process. Please try again later.

error.cmd.failure

The requested command returned the indicated result code. Non zero results indicate a failure.

error.cmd.primarynode

The requested action is not permitted on the first node (Publisher).

error.cmd.secondarynode

The requested action is not permitted on a subsequent node (Subscriber).

error.directory.notaccessible

The indicated directory could not accessed.

error.product.notdetermined

The product information was not accessible. Please review the Cisco Unified Communications OS Platform API logs.

error.system

An error occurred but no additional information was given. Please review the Cisco Unified Communications OS Platform API logs.

error.system.parsing

One or more system calls or files have changed resulting in a parsing error. Please review the Cisco Unified Communications OS Platform API logs.

error.upgrade.anotheruser

Another user session is currently configuring an upgrade.

error.upgrade.cancel.cop

Installation of a Cisco Options Package (COP) cannot be canceled.

error.upgrade.file.notlisted

The selected upgrade was not in the list of valid files.

error.upgrade.file.notready

A valid upgrade file must be provided before an upgrade can be started.

error.upgrade.inprogress

An upgrade is already in progress.

error.upgrade.progress

An error occurred while getting the upgrade progress.

error.upgrade.rebootnotallowd

Automatic reboots are not allowed on this hardware model.

error.upgrade.upgradestate.error

An error occurred while accessing the upgrade state file. Please verify the status of the local file system.

error.upgrade.filter.error

An error occurred while filtering upgrade files. Please review the Cisco Unified Communications OS Platform API logs.

error.upgrade.canceled

The upgrade was canceled.

errors.upgrade.nodeployment

Unable to determine the install deployment type which is required for upgrade. Please refer to upgrade log for further information.

errors.upgrade.unexecutable

A utility required for upgrade is not executable. Upgrade patch may be corrupted or tampered with. Please verify.

errors.upgrade.copyfailed

Copy of file failed. Upgrade patch may be corrupted or tampered with. Please verify.

errors.upgrade.checksumfailed

Checksum of file failed. Upgrade patch may be corrupted or tampered with. Please verify.

errors.upgrade.vendordirnotfound

The Vendor directory is missing. Upgrade patch may be corrupted or tampered with. Please verify.

errors.upgrade.copyvendorlinksfailed

Copy of VendorLinks failed. Upgrade patch may be corrupted or tampered with. Please verify.

errors.upgrade.missingchecksum

The Checksum file is missing. Upgrade patch may be corrupted or tampered with. Please verify.

errors.upgrade.sourcefilenotfound

Source file doesn't exist. Upgrade patch may be corrupted or tampered with. Please verify.

errors.upgrade.badpassword

The user name or password is not valid.

errors.upgrade.directorynotfound

The directory could not be located.

errors.upgrade.mediaisofile

The media contains an iso data file, not an iso image.

errors.upgrade.diskspace

There is not enough disk space in the common partition to perform the upgrade. Please use either the Platform Command Line Interface or the Real-Time Monitoring Tool (RTMT) to free space on the common partition.

errors.upgrade.filenotdownloaded

The file could not be downloaded.

errors.upgrade.filenotfound

The file could not be located.

errors.install.file.isonotvalid

The selected ISO file is not valid. This indicates that the download of the ISO file corrupted the file or the ISO file on the remote server is corrupt.

errors.install.file.isorenamed

Upgrade has detected that the ISO file name has been changed from the original name. This is not allowed.

errors.install.file.md5failed

The checksum could not be calculated.

errors.install.file.notvalid

The selected file is not valid.

errors.install.file.unpack

The selected ISO file is not valid. Possible reasons are the file was corrupted on download or the file is corrupted on the remote server.

errors.upgrade.mountfailed

Unable to mount the local file system. This could be caused by a corrupt ISO file. For example, FTPing the ISO file to the remote server in ASCII mode would cause this error.

errors.upgrade.nofileordirectory

The file or directory could not be located.

errors.upgrade.remoteunavail

The remote file could not be accessed or fully downloaded. Please verify the file permissions or check the remote server's status.

errors.system

An unknown error occurred while accessing the upgrade file.

errors.upgrade.unknownhost

The remote server could not be located.

errors.upgrade.firstnodeissue

Connectivity Issue to First Node. Verify that the first node is powered on, the network connection is up and the security password on this node and the first node are the same.

errors.upgrade.versionmismatch

The version number inside the selected upgrade does not match the filename.

errors.upgrade.incompatible.sftp

The sftp server used is incompatible with the local client. Please upgrade to a newer version or reattempt using ftp.

errors.upgrade.incompatible.ftp

The ftp server used is incompatible with the local client. Please upgrade to a newer version or reattempt using sftp.

errors.upgrade.toVersionDisallowed

Upgrade candidates found in the patch directory are not allowed by the current version

errors.upgrade.fromVersionDisallowed

The selected upgrade is disallowed from the current version

errors.upgrade.copfileDisallowed

Cop file candidates found in the patch directory are not allowed by the current version

errors.upgrade.HardwareUnsupported

This hardware is no longer supported.

errors.upgrade.HWNoDeploymentsSupported

This upgrade software no longer supports this hardware for the installed deployment.

errors.upgrade.Preflight

The preflight script in the upgrade file failed. Please review the install logs for more information.

errors.upgrade.connectionHWDisallowed

This server is not supported for use with the version of Cisco Unity Connection that you are trying to install. For information on supported servers, see the applicable version of the Cisco Unity Connection Supported Platforms List.

errors.upgrade.sub.valid

Valid upgrades found however the first node (publisher) must be upgraded before upgrading this node.

errors.upgrade.sub.noValid

No valid upgrades found. The first node (publisher) must be upgraded before upgrading this node.

errors.upgrade.sub.pubnotavailable

The first node (publisher) is not currently available. Access to the publisher is required for this operation.

errors.upgrade.sub.pubwrongversion

Version mismatch. Please switch versions on the publisher and try again.

errors.upgrade.sub.pubwrongunrest

Restricted/Unrestricted software mismatch. Publisher and subsequent node (Subscriber) must be running same software type (restricted vs. unrestricted).

error.version.active.notavailable

No active version is available.

error.version.inactive.notavailable

No inactive version is available.

error.undetermined.result

Restart/switch version result cannot be determined. Please verify that the restart/switch version completed successfully.

error.undetermined.result

Restart result cannot be determined. Please verify that the restart completed successfully.

errors.switch.grub

The machine could not switch to the inactive version. Please verify the inactive version was properly installed.

errors.switch.reboot

The machine successfully switch to the inactive version however the reboot failed.

errors.switch.sync

The machine could not sync the inactive version to the active version. Please verify the inactive version was properly installed and try again.

errors.switch.sync.lock

The machine could not obtain a sync lock. Please verify the inactive version was properly installed and try again.

errors.switch.licensing_grace_period

getSwitchVersion is not allowed during Licensing Grace Period.

errors.upgrade.licensing_grace_period

Upgrades are prohibited during Licensing Grace Period.

warning.upgrade.canceled

The upgrade was canceled.

warning.upgrade.essutimestamp

The selected upgrade file does not contain some of the security fixes currently applied to this machine. Installing the selected upgrade file will remove some previously installed security fixes.

warning.upgrade.messages.notdisplayed

The upgrade file contained one or more upgrade messages that could not be displayed. Please review the Cisco Unified Communications OS Platform API logs.

warning.upgrade.notcancelled

An attempt to cancel the upgrade failed. Please review the Cisco Unified Communications OS Platform API logs.

warning.upgrade.noupgrades

The given directory was located and searched but no valid options or upgrades were available. Note, the system cannot be downgraded so option and upgrade files for previous releases were ignored.

warning.upgrade.rebootrequired

A system reboot is required when the upgrade process completes or is canceled. This will ensure services affected by the upgrade process are functioning properly.

warning.upgrade.removemedia

Please remove the DVD from the drive.

warning.upgrade.state.notpersisted

The upgrade state could not be saved. Other administrative sessions will not be able to assume control of this upgrade.

info.upgrade.rebooting

The system upgrade was successful. A SwitchVersion request has been submitted. This can take a long time depending on the platform and database size. Please continue to monitor the switchover process from the Cisco Unified Communications OS Platform CLI. Please verify the system restarts and the correct version is active.

info.upgrade.rebootrequired

The system upgrade was successful. Please reboot the system to activate the change. This will also ensure services affected by the upgrade process are functioning properly.

info.upgrade.switchrequired

The system upgrade was successful. Please switch versions to activate the upgrade or reboot the system to ensure services affected by the upgrade process are functioning properly.

 

 

 

Errors

 

If a service is invoked with missing or incorrect arguments, the service may not be invoked at all. A response indicating the failure. often including a stack trace, is returned.

 

RestartSystem and SwitchVersion Services

 

These requests cause the system to reboot and as a result networking may not be present when PAWS tries to invoke the Callback URL. For this reason, asynchronous responses from these services are unreliable. There are two services, RestartSystemStatusService and SwitchVersionStatusService which you can use to check the status of these commands.

Please be aware that, since the system may be rebooting, even these services may not be available.

 

Refresh Upgrade

 

Certain major platform upgrades, for instance moving from a32-bit to a 64-bit OS, require the "to-side" kernel to be running for the upgrade to proceed properly. As a result, refresh upgrades perform an interim reboot of the new kernel to perform the bulk of the upgrade. Currently refresh upgrade are indistinguishable from standard upgrades. This affects Platform SOAP Services as follows:

 

A premature result is returned even though the upgrade is not complete.

Platform SOAP services are not available during the interim reboot.

 

CancelUpgradeService

 

CancelUpgrade always returns success if the cancel request was successfully submitted. However, it may take a few minutes for cancel request to complete. You can call UpgradeStageService to determine when the upgrade can be canceled by checking for a result of upgrade.stage.cancelled.

 

Due to an operating system limitation, a COP file cannot be stopped once the StartUpgradeService has been called.