Esx.Settings.Hosts.Software.StageResult

Esx.Settings.Hosts.Software.StageResult
Esx.Settings.Hosts.Software.StageResult

The Esx.Settings.Hosts.Software.StageResult schema contains properties that describe the result of a POST /esx/settings/hosts/{host}/software?action=stage operation.

This schema was added in vSphere API 8.0.0.1.

JSON Example
{
    "status": {
        "status": "string",
        "progress": "Cis.Task.Progress Object",
        "start_time": "string",
        "end_time": "string",
        "notifications": {
            "info": [
                {
                    "type": "string",
                    "id": "string",
                    "time": "string",
                    "message": "Vapi.Std.LocalizableMessage Object",
                    "resolution": "Vapi.Std.LocalizableMessage Object",
                    "originator": "string",
                    "retriable": false
                }
            ],
            "warnings": [
                {
                    "type": "string",
                    "id": "string",
                    "time": "string",
                    "message": "Vapi.Std.LocalizableMessage Object",
                    "resolution": "Vapi.Std.LocalizableMessage Object",
                    "originator": "string",
                    "retriable": false
                }
            ],
            "errors": [
                {
                    "type": "string",
                    "id": "string",
                    "time": "string",
                    "message": "Vapi.Std.LocalizableMessage Object",
                    "resolution": "Vapi.Std.LocalizableMessage Object",
                    "originator": "string",
                    "retriable": false
                }
            ]
        }
    },
    "commit": "string",
    "host_info": {
        "name": "string",
        "is_vsan_witness": false
    },
    "notifications": {
        "info": [
            {
                "type": "string",
                "id": "string",
                "time": "string",
                "message": "Vapi.Std.LocalizableMessage Object",
                "resolution": "Vapi.Std.LocalizableMessage Object",
                "originator": "string",
                "retriable": false
            }
        ],
        "warnings": [
            {
                "type": "string",
                "id": "string",
                "time": "string",
                "message": "Vapi.Std.LocalizableMessage Object",
                "resolution": "Vapi.Std.LocalizableMessage Object",
                "originator": "string",
                "retriable": false
            }
        ],
        "errors": [
            {
                "type": "string",
                "id": "string",
                "time": "string",
                "message": "Vapi.Std.LocalizableMessage Object",
                "resolution": "Vapi.Std.LocalizableMessage Object",
                "originator": "string",
                "retriable": false
            }
        ]
    }
}
status
Optional

Specifies the status of the POST /esx/settings/hosts/{host}/software?action=stage operation on the specified Esx.Settings.Hosts.Software.StageResult.commit of the desired software document.

This property was added in vSphere API 8.0.0.1.

missing or null if the POST /esx/settings/hosts/{host}/software?action=stage operation is in progress.

string
commit
Required

The identifier of the commit used to fetch the desired software document to be staged to a host.

This property was added in vSphere API 8.0.0.1.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.esx.settings.commit. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.esx.settings.commit.

host_info
Required

Information of the host to which the desired software document specified by the Esx.Settings.Hosts.Software.StageResult.commit was staged.

This property was added in vSphere API 8.0.0.1.

notifications
Optional

Notifications providing additional information for POST /esx/settings/hosts/{host}/software?action=stage operation. These notifications are mutually exclusive with the notifications in Esx.Settings.Hosts.Software.StageStatus.

This property was added in vSphere API 8.0.0.1.

This property will be missing or null if there are no notifications