Esx.Settings.Clusters.Software.Solutions.SolutionsInternal.RemoveResult

Esx.Settings.Clusters.Software.Solutions.SolutionsInternal.RemoveResult
Esx.Settings.Clusters.Software.Solutions.SolutionsInternal.RemoveResult

The Esx.Settings.Clusters.Software.Solutions.SolutionsInternal.RemoveResult schema contains properties that describe aggregated status of solution's component removal.

This schema was added in vSphere API 7.0.1.0.

Note: this schema is restricted for VMware internal use only.

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": {
        "host_info": {
            "name": "string",
            "is_vsan_witness": false
        }
    },
    "host_status": {
        "host_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
                    }
                ]
            }
        }
    },
    "successful_hosts": [
        "string"
    ],
    "failed_hosts": [
        "string"
    ],
    "skipped_hosts": [
        "string"
    ]
}
status
Optional

Specifies the aggregated status of the operation.

This property was added in vSphere API 7.0.1.0.

missing or null if the operation is in progress.

string
commit
Required

The identifier of the commit used to fetch the desired software document to be applied to all hosts within the cluster.

This property was added in vSphere API 7.0.1.0.

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.

object
host_info
Required

Information about the hosts in this cluster for which remove has been run.

This property was added in vSphere API 7.0.1.0.

When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: HostSystem. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: HostSystem.

object
host_status
Required

Status of the hosts in this cluster from which the solution components were removed. Hosts on which the operation was successful are specified by Esx.Settings.Clusters.Software.Solutions.SolutionsInternal.RemoveResult.successful_hosts. Hosts on which the operation failed are specified by Esx.Settings.Clusters.Software.Solutions.SolutionsInternal.RemoveResult.failed_hosts. Hosts which were skipped by the operation are specified by Esx.Settings.Clusters.Software.Solutions.SolutionsInternal.RemoveResult.skipped_hosts.

This property was added in vSphere API 7.0.1.0.

When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: HostSystem. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: HostSystem.

array of string
successful_hosts
Required

Hosts in this cluster from which the solution components have been successfully removed.

This property was added in vSphere API 7.0.1.0.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: HostSystem. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: HostSystem.

array of string
failed_hosts
Required

Hosts in this cluster from which the solution components failed to be removed.

This property was added in vSphere API 7.0.1.0.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: HostSystem. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: HostSystem.

array of string
skipped_hosts
Required

Hosts in this cluster that were skipped by the operation.

This property was added in vSphere API 7.0.1.0.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: HostSystem. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: HostSystem.