SspiUpgradeStatus

SspiUpgradeStatus
Upgrade Status

Aggregated status of the upgrade operation, providing real-time visibility into upgrade progress and detailed execution status for each upgrade step. The upgrade process is asynchronous and may take significant time depending on system size and configuration.

JSON Example
{
    "current_version": "string",
    "target_version": "string",
    "overall_status": "string",
    "upgrade_steps": [
        {
            "_create_time": 0,
            "_last_modified_time": 0,
            "id": "string",
            "display_name": "string",
            "description": "string",
            "activity_status_msg": "string",
            "_completed_at": 0,
            "status": "string",
            "messages": [
                {
                    "severity": "string",
                    "message": "string"
                }
            ],
            "last_run_time": 0
        }
    ],
    "pre_checks_status": {
        "overall_status": "string",
        "pre_checks": [
            {
                "_create_time": 0,
                "_last_modified_time": 0,
                "id": "string",
                "display_name": "string",
                "description": "string",
                "activity_status_msg": "string",
                "_completed_at": 0,
                "status": "string",
                "messages": [
                    {
                        "severity": "string",
                        "message": "string"
                    }
                ],
                "last_run_time": 0
            }
        ]
    }
}
string
current_version
Required

Current version of the appliance before upgrade. This field indicates the version from which the system is being upgraded.

This field is always present and populated, even when upgrade status is NOT_STARTED, indicating the currently running system version.

string
target_version
Required

Target version of the appliance after upgrade completion. This field indicates the version to which the system will be upgraded.

This field is always present and populated, indicating the version that will be installed when the upgrade completes successfully.

overall_status
Required

Aggregated status of the entire upgrade operation, computed from individual step results.

NOT_STARTED: Upgrade has not been initiated. IN_PROGRESS: Upgrade is actively executing. One or more steps are running. SUCCESS: All upgrade steps completed successfully. FAILED: One or more upgrade steps failed. Review ERROR messages in the failed steps or connect with VMware Support for assistance.

Enumeration: NOT_STARTED, IN_PROGRESS, SUCCESS, SUCCESS_WITH_WARNINGS, FAILED, SKIPPED, PAUSED
upgrade_steps
Required

Ordered sequence of all upgrade steps with their individual execution status and messages. Each entry combines the step definition with real-time execution state. Steps are listed in the order they are executed.

Monitor individual steps to track upgrade progress, identify which step is currently executing, determine which step failed if upgrade fails, and review progress messages for long-running steps.

pre_checks_status
Optional

Aggregated status of all pre-checks validations. This field provides the results of pre-upgrade validation checks, including overall pre-checks status and detailed results for each individual pre-check.

This field is present when pre-checks have been executed, either standalone via POST /upgrade?pre_checks_only=true or as part of a full upgrade via POST /upgrade.