SettingsClustersSoftwareReportsLastApplyResultApplyResult

The LastApplyResult.ApplyResult structure contains fields that describe the result of an apply operation.


Properties

string
commit Required

The identifier of the commit used to fetch the desired software document to be applied to all hosts within the cluster. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.esx.settings.commit. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.esx.settings.commit.


array of string
failed_hosts Required

Hosts in this cluster to which the desired software document specified by the LastApplyResult.ApplyResult.commit failed to be applied to. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: HostSystem. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: HostSystem.


host_info Required

Information of the hosts in this cluster to which the desired software document specified by the LastApplyResult.ApplyResult.commit should be applied to. When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: HostSystem. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: HostSystem.


host_status Required

Status of the hosts in this cluster to which the desired software document specified by the LastApplyResult.ApplyResult.commit was applied to. Hosts on which the apply operation was sucessful are specified by LastApplyResult.ApplyResult.successful-hosts. Hosts on which the apply operation failed are specified by LastApplyResult.ApplyResult.failed-hosts. Hosts which were skipped by the apply operation are specified by LastApplyResult.ApplyResult.skipped-hosts. When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: HostSystem. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: HostSystem.


array of string
skipped_hosts Required

Hosts in this cluster that were skipped by the apply operation. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: HostSystem. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: HostSystem.


status Required

Specifies the aggregated status of the apply operation.


array of string
successful_hosts Required

Hosts in this cluster to which the desired software document specified by the LastApplyResult.ApplyResult.commit has been successfully applied to. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: HostSystem. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: HostSystem.

JSON Example

{
    "commit": "string",
    "failed_hosts": [
        "string"
    ],
    "host_info": {
        "key": {
            "name": "string"
        }
    },
    "host_status": {
        "key": {
            "end_time": "string",
            "notifications": {},
            "start_time": "string",
            "status": "OK"
        }
    },
    "skipped_hosts": [
        "string"
    ],
    "status": {
        "end_time": "string",
        "notifications": {},
        "start_time": "string",
        "status": "OK"
    },
    "successful_hosts": [
        "string"
    ]
}

Feedback

Was this page helpful?