SettingsClustersSoftwareStageResult

The Software.StageResult structure contains fields that describe the result of a Software.stage operation.


Properties

string
commit Required

The identifier of the commit used to fetch the desired software document to be staged 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 Software.StageResult.commit failed to be staged 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 Software.StageResult.commit should be staged 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 Software.StageResult.commit was staged to. Hosts on which the Software.stage operation was successful are specified by Software.StageResult.successful-hosts. Hosts on which the stage operation failed are specified by Software.StageResult.failed-hosts. Hosts which were skipped by the Software.stage operation are specified by Software.StageResult.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.


notifications Optional

Notifications providing additional information for Software.stage operation. These notifications are mutually exclusive with the notifications in Software.StageStatus.


array of string
skipped_hosts Required

Hosts in this cluster that were skipped by the Software.stage operation. For example hosts which are compliant, or are previously staged shall be skipped. 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 Optional

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


array of string
successful_hosts Required

Hosts in this cluster to which the desired software document specified by the Software.StageResult.commit has been successfully staged 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": "RUNNING"
		}
	},
	"skipped_hosts": [
		"string"
	],
	"successful_hosts": [
		"string"
	]
}

Feedback

Was this page helpful?