Skip to main content

The SystemStatus interface provides status and upgrade information about Trust Protection Platform engines. This information also appears in the UI.

Engine Upgrade Status

EngineUpgradeState describes the following Trust Protection Platform upgrade statuses:

  • Upgrade Complete: The upgrade completed on all Trust Protection Platform engines.
  • Upgrade Blocked: One or more dependency tasks prevented the upgrade from completing.
  • Upgrade In Error: The upgrade encountered an error.
  • Upgrade Running: The upgrade is to a newer version is in progress.
  • Upgrade Pending Install: The numbers of engines that still have a previous version of Trust Protection Platform. An upgrade is required.

Service Status

The Service status describes engine availability:

  • Down: The service is deemed unavailable for operations. The service is considered down if the TimeSinceLastSeen is greater than six minutes. When Demo mode is enabled to allow updates every 30 seconds, the service is considered down if TimeSinceLastSeen is greater than 45 seconds.
  • New: The vPlatform service never detected operations for this service. The corresponding timeSinceFirstSeen and TimeSinceLastSeen values are also empty.
  • Unknown: The IIS status is unknown because the vPlatform service is not currently available to report the status.
  • Up: The service is deemed available for operations. The service is considered up if the TimeSinceLastSeen is less than six minutes. When Demo mode is enabled to allow updates every 30 seconds, the service is considered up if TimeSinceLastSeen is less than 45 seconds.

Upgrade Status Summary Details object

The UpgradeSummary object describes the status of a Trust Protection Platform upgrade:

  • Status: The Engine Upgrade Status.
  • StatusDetails: Appears only when an upgrade is blocked, in error, or pending installation. Additional information about the upgrade.
  • UpgradeStartTime: The UTC start time that the upgrade began on the first engine.
  • UpgradeStopTime: The UTC completion time when the last engine finished the upgrade.
  • CompletedTasks: The total number of upgrade task across all engines.
  • OriginVersion: Appears on any upgrades that occur after 20.1. For example, if you are upgrading to 20.1 or higher for the first time, the value is omitted. The starting point version prior to Trust Protection Platform upgrades.
  • TargetVersion: The intended Trust Protection Platform version.
  • RemainingTasks: Appears only when additional upgrade tasks are present.
  • EnginesComplete: The number of engines that successfully completed the upgrade.
  • EnginesRunning: The number of engines that are currently upgrading.
  • EnginesBlocked: The number of engines blocked by other upgrade tasks or dependencies.
  • EnginesInError: The number of engines that are in a failed state. These engines retry every three minutes.
  • EnginesPendingInstall: The number of engines that still have a previous version of Trust Protection Platform installed. An upgrade is required.