Esx.Settings.Clusters.Software.HaInternal.ApplyResult

Esx.Settings.Clusters.Software.HaInternal.ApplyResult
Esx.Settings.Clusters.Software.HaInternal.ApplyResult

The Esx.Settings.Clusters.Software.HaInternal.ApplyResult schema contains properties that describe the result of an apply operation.

This schema was added in vSphere API 7.0.0.0.

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

JSON Example
{
    "status": {
        "status": "string",
        "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
                }
            ]
        }
    },
    "component_name": "string",
    "component_version": "string",
    "host_info": {
        "host_info": {
            "name": "string",
            "is_vsan_witness": false
        }
    },
    "host_status": {
        "host_status": {
            "status": "string",
            "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"
    ]
}
status
Optional

Specifies the aggregated status of the apply operation.

This property was added in vSphere API 7.0.0.0.

missing or null if the apply operation is in progress.

string
component_name
Required

The identifier of the component applied to all hosts within the cluster.

This property was added in vSphere API 7.0.0.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.component. 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.component.

string
component_version
Required

Version of the component

This property was added in vSphere API 7.0.0.0.

object
host_info
Required

Information of the hosts in this cluster to which the desired component needs to be applied.

This property was added in vSphere API 7.0.0.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

The status of all hosts in this cluster to which the desired component was applied.

This property was added in vSphere API 7.0.0.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

The hosts in the cluster on which component apply succeeded.

This property was added in vSphere API 7.0.0.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

The hosts in the cluster on which component apply failed.

This property was added in vSphere API 7.0.0.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.