Developer Documentation

SoftwareApplyResult

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


Properties

Required Property Name Type Description
required commit string

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.

required failed_hosts array of string

Hosts in this cluster to which the desired software document specified by the Software.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.

required host_info map of SettingsHostInfo

Information of the hosts in this cluster to which the desired software document specified by the Software.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.

required host_status map of SoftwareApplyStatus

Status of the hosts in this cluster to which the desired software document specified by the Software.ApplyResult.commit was applied to. Hosts on which the Software.apply operation was successful are specified by Software.ApplyResult.successful-hosts. Hosts on which the apply operation failed are specified by Software.ApplyResult.failed-hosts. Hosts which were skipped by the Software.apply operation are specified by Software.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.

required skipped_hosts array of string

Hosts in this cluster that were skipped by the Software.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.

optional status SoftwareApplyStatus

Specifies the aggregated status of the Software.apply operation. unset if the Software.apply operation is in progress.

required successful_hosts array of string

Hosts in this cluster to which the desired software document specified by the Software.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.

Feedback

Was this page helpful?