Appliance Update Pending Info

Appliance Update Pending Info
Appliance Update Pending Info

The Appliance Update Pending Info schema contains the extended information about the update

This schema was added in vSphere API 6.7.

JSON Example
{
    "name": "string",
    "contents": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "params": {
                "params": {
                    "s": "string",
                    "dt": "string",
                    "i": 0,
                    "d": "number",
                    "l": "Vapi Std NestedLocalizableMessage Object",
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        }
    ],
    "services_will_be_stopped": [
        {
            "service": "string",
            "description": {
                "id": "string",
                "default_message": "string",
                "args": [
                    "string"
                ],
                "params": {
                    "params": {
                        "s": "string",
                        "dt": "string",
                        "i": 0,
                        "d": "number",
                        "l": "Vapi Std NestedLocalizableMessage Object",
                        "format": "string",
                        "precision": 0
                    }
                },
                "localized": "string"
            }
        }
    ],
    "estimated_time_to_install": 0,
    "workload_management_impact": false,
    "eulas": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "params": {
                "params": {
                    "s": "string",
                    "dt": "string",
                    "i": 0,
                    "d": "number",
                    "l": "Vapi Std NestedLocalizableMessage Object",
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        }
    ],
    "staged": false,
    "knowledge_base": "string",
    "description": {
        "id": "string",
        "default_message": "string",
        "args": [
            "string"
        ],
        "params": {
            "params": {
                "s": "string",
                "dt": "string",
                "i": 0,
                "d": "number",
                "l": "Vapi Std NestedLocalizableMessage Object",
                "format": "string",
                "precision": 0
            }
        },
        "localized": "string"
    },
    "priority": "string",
    "severity": "string",
    "update_type": "string",
    "release_date": "string",
    "quick_patch": false,
    "reboot_required": false,
    "size": 0
}
string
name
Required

Name of the update.

This property was added in vSphere API 6.7.

array of Vapi Std LocalizableMessage
contents
Required

List of the 1. issues addressed since previous/current version 2. new features/improvements

This property was added in vSphere API 6.7.

array of Appliance Update ServiceInfo
services_will_be_stopped
Required

List of the services that will be stopped and restarted during the update installation.

This property was added in vSphere API 6.7.

integer As int64 As int64
estimated_time_to_install
Optional

Rough estimate of time to install the update (minutes).

This property was added in vSphere API 9.1.0.0.

estimatedTimeToInstall If missing or null N/A

boolean
workload_management_impact
Optional

Flag indicating if there is an impact to workload management. False: The following Workload Management API-Driven Operations are fully operational and will not be disrupted by this update. VM workload provisioning, VM CRUD Operations Kubernetes workload provisioning, Kubernetes CRUD Operations Compute and Storage Scaling Continuous log collection and forwarding to Ops for monitoring True: Workload management will be disrupted for a given downtime.

This property was added in vSphere API 9.1.0.0.

workloadManagementImpact If missing or null the patch is not a quick patch

array of Vapi Std LocalizableMessage
eulas
Required

List of EULAs. This list has multiple entries and can be dynamic based on what we are actually installing.

This property was added in vSphere API 6.7.

boolean
staged
Required

Is the update staged

This property was added in vSphere API 6.7.

string As uri As uri
knowledge_base
Required

URL for the knowledge base article describing this update.

This property was added in vSphere API 6.7.

description
Required

Description of the update. The short information what this update is. E.g. "Update2 for vCenter Server Appliance 6.5"

This property was added in vSphere API 6.7.

string
priority
Required

Update priority

For more information see: Appliance Update CommonInfo Priority.

This property was added in vSphere API 6.7.

string
severity
Required

Update severity

For more information see: Appliance Update CommonInfo Severity.

This property was added in vSphere API 6.7.

string
update_type
Required

Update category

For more information see: Appliance Update CommonInfo Category.

This property was added in vSphere API 6.7.

string As date-time As date-time
release_date
Required

Update release date.

This property was added in vSphere API 6.7.

boolean
quick_patch
Optional

Flag indicating whether the incoming patch is a quick patch. If field is not set, the patch is not a quick patch

This property was added in vSphere API 9.1.0.0.

This property is optional because it was added in a newer version than its parent node.

boolean
reboot_required
Required

Flag indicating whether reboot is required after update.

This property was added in vSphere API 6.7.

integer As int64 As int64
size
Required

Download Size of update in Megabytes.

This property was added in vSphere API 6.7.

Returned By