Esx Settings Clusters InstalledImages get
Returns the last extracted installed Image info.
This operation was added in vSphere API 8.0.3.0.
Returns an authorization error if you do not have all of the privileges described as follows:
- Operation execution requires
VcIntegrity.lifecycleSettings.Read. - The resource
ClusterComputeResourcereferenced by the parameter cluster requiresVcIntegrity.lifecycleSettings.Read.
Identifier of the cluster.
The parameter must be an identifier for the resource type: ClusterComputeResource.
last extracted installed images for the cluster
{
"completion_time": "string",
"uniform_image": false,
"status": "string",
"successful_hosts": [
"string"
],
"failed_hosts": [
"string"
],
"unsupported_hosts": [
"string"
],
"image_categories": {
"is_highest_and_widely_used_image_equal": false,
"most_widely_used_image": {
"software_info": {
"base_image": {
"details": {
"display_name": "string",
"display_version": "string",
"release_date": "string",
"quick_patch_compatible_versions": {
"quick_patch_compatible_versions": "string"
}
},
"version": "string"
},
"add_on": {
"details": {
"display_name": "string",
"vendor": "string",
"display_version": "string"
},
"name": "string",
"version": "string"
},
"components": {
"components": {
"version": "string",
"details": {
"display_name": "string",
"vendor": "string",
"display_version": "string"
}
}
},
"solutions": {
"solutions": {
"details": {
"display_name": "string",
"display_version": "string",
"components": [
{
"component": "string",
"display_name": "string",
"display_version": "string",
"vendor": "string"
}
]
},
"version": "string",
"components": [
{
"component": "string"
}
]
}
},
"hardware_support": {
"packages": {
"packages": {
"pkg": "string",
"version": "string"
}
}
},
"removed_components": {
"removed_components": {
"version": "string",
"details": {
"display_name": "string",
"vendor": "string",
"display_version": "string"
}
}
},
"alternative_images": {
"alternative_images": {
"base_image": {
"details": {
"display_name": "string",
"display_version": "string",
"release_date": "string",
"quick_patch_compatible_versions": {
"quick_patch_compatible_versions": "string"
}
},
"version": "string"
},
"add_on": {
"details": {
"display_name": "string",
"vendor": "string",
"display_version": "string"
},
"name": "string",
"version": "string"
},
"components": {
"components": {
"version": "string",
"details": {
"display_name": "string",
"vendor": "string",
"display_version": "string"
}
}
},
"solutions": {
"solutions": {
"details": {
"display_name": "string",
"display_version": "string",
"components": [
{
"component": "string",
"display_name": "string",
"display_version": "string",
"vendor": "string"
}
]
},
"version": "string",
"components": [
{
"component": "string"
}
]
}
},
"hardware_support": {
"packages": {
"packages": {
"pkg": "string",
"version": "string"
}
}
},
"removed_components": {
"removed_components": {
"version": "string",
"details": {
"display_name": "string",
"vendor": "string",
"display_version": "string"
}
}
},
"display_name": "string",
"selection_criteria": {
"selection_type": "string",
"host_uuids": [
"string"
],
"host_hardware_spec": {
"vendor": "string",
"models": [
"string"
],
"families": [
"string"
],
"oem_strings": [
"string"
]
}
}
}
}
},
"host_list": [
"string"
]
},
"highest_versioned_image": {
"software_info": {
"base_image": {
"details": {
"display_name": "string",
"display_version": "string",
"release_date": "string",
"quick_patch_compatible_versions": {
"quick_patch_compatible_versions": "string"
}
},
"version": "string"
},
"add_on": {
"details": {
"display_name": "string",
"vendor": "string",
"display_version": "string"
},
"name": "string",
"version": "string"
},
"components": {
"components": {
"version": "string",
"details": {
"display_name": "string",
"vendor": "string",
"display_version": "string"
}
}
},
"solutions": {
"solutions": {
"details": {
"display_name": "string",
"display_version": "string",
"components": [
{
"component": "string",
"display_name": "string",
"display_version": "string",
"vendor": "string"
}
]
},
"version": "string",
"components": [
{
"component": "string"
}
]
}
},
"hardware_support": {
"packages": {
"packages": {
"pkg": "string",
"version": "string"
}
}
},
"removed_components": {
"removed_components": {
"version": "string",
"details": {
"display_name": "string",
"vendor": "string",
"display_version": "string"
}
}
},
"alternative_images": {
"alternative_images": {
"base_image": {
"details": {
"display_name": "string",
"display_version": "string",
"release_date": "string",
"quick_patch_compatible_versions": {
"quick_patch_compatible_versions": "string"
}
},
"version": "string"
},
"add_on": {
"details": {
"display_name": "string",
"vendor": "string",
"display_version": "string"
},
"name": "string",
"version": "string"
},
"components": {
"components": {
"version": "string",
"details": {
"display_name": "string",
"vendor": "string",
"display_version": "string"
}
}
},
"solutions": {
"solutions": {
"details": {
"display_name": "string",
"display_version": "string",
"components": [
{
"component": "string",
"display_name": "string",
"display_version": "string",
"vendor": "string"
}
]
},
"version": "string",
"components": [
{
"component": "string"
}
]
}
},
"hardware_support": {
"packages": {
"packages": {
"pkg": "string",
"version": "string"
}
}
},
"removed_components": {
"removed_components": {
"version": "string",
"details": {
"display_name": "string",
"vendor": "string",
"display_version": "string"
}
}
},
"display_name": "string",
"selection_criteria": {
"selection_type": "string",
"host_uuids": [
"string"
],
"host_hardware_spec": {
"vendor": "string",
"models": [
"string"
],
"families": [
"string"
],
"oem_strings": [
"string"
]
}
}
}
}
},
"host_list": [
"string"
]
},
"host_image_list": [
{
"software_info": {
"base_image": {
"details": {
"display_name": "string",
"display_version": "string",
"release_date": "string",
"quick_patch_compatible_versions": {
"quick_patch_compatible_versions": "string"
}
},
"version": "string"
},
"add_on": {
"details": {
"display_name": "string",
"vendor": "string",
"display_version": "string"
},
"name": "string",
"version": "string"
},
"components": {
"components": {
"version": "string",
"details": {
"display_name": "string",
"vendor": "string",
"display_version": "string"
}
}
},
"solutions": {
"solutions": {
"details": {
"display_name": "string",
"display_version": "string",
"components": [
{
"component": "string",
"display_name": "string",
"display_version": "string",
"vendor": "string"
}
]
},
"version": "string",
"components": [
{
"component": "string"
}
]
}
},
"hardware_support": {
"packages": {
"packages": {
"pkg": "string",
"version": "string"
}
}
},
"removed_components": {
"removed_components": {
"version": "string",
"details": {
"display_name": "string",
"vendor": "string",
"display_version": "string"
}
}
},
"alternative_images": {
"alternative_images": {
"base_image": {
"details": {
"display_name": "string",
"display_version": "string",
"release_date": "string",
"quick_patch_compatible_versions": {
"quick_patch_compatible_versions": "string"
}
},
"version": "string"
},
"add_on": {
"details": {
"display_name": "string",
"vendor": "string",
"display_version": "string"
},
"name": "string",
"version": "string"
},
"components": {
"components": {
"version": "string",
"details": {
"display_name": "string",
"vendor": "string",
"display_version": "string"
}
}
},
"solutions": {
"solutions": {
"details": {
"display_name": "string",
"display_version": "string",
"components": [
{
"component": "string",
"display_name": "string",
"display_version": "string",
"vendor": "string"
}
]
},
"version": "string",
"components": [
{
"component": "string"
}
]
}
},
"hardware_support": {
"packages": {
"packages": {
"pkg": "string",
"version": "string"
}
}
},
"removed_components": {
"removed_components": {
"version": "string",
"details": {
"display_name": "string",
"vendor": "string",
"display_version": "string"
}
}
},
"display_name": "string",
"selection_criteria": {
"selection_type": "string",
"host_uuids": [
"string"
],
"host_hardware_spec": {
"vendor": "string",
"models": [
"string"
],
"families": [
"string"
],
"oem_strings": [
"string"
]
}
}
}
}
},
"host_list": [
"string"
]
}
]
},
"host_notifications": {
"host_notifications": {
"info": [
{
"type": "string",
"id": "string",
"time": "string",
"message": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"resolution": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"originator": "string",
"retriable": false
}
],
"warnings": [
{
"type": "string",
"id": "string",
"time": "string",
"message": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"resolution": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"originator": "string",
"retriable": false
}
],
"errors": [
{
"type": "string",
"id": "string",
"time": "string",
"message": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"resolution": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"originator": "string",
"retriable": false
}
]
}
},
"host_info": {
"host_info": {
"name": "string",
"is_vsan_witness": false
}
},
"orphaned_vibs": {
"orphaned_vibs": [
"string"
]
},
"notifications": {
"notifications": {
"info": [
{
"type": "string",
"id": "string",
"time": "string",
"message": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"resolution": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"originator": "string",
"retriable": false
}
],
"warnings": [
{
"type": "string",
"id": "string",
"time": "string",
"message": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"resolution": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"originator": "string",
"retriable": false
}
],
"errors": [
{
"type": "string",
"id": "string",
"time": "string",
"message": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"resolution": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"originator": "string",
"retriable": false
}
]
}
}
}Timestamp describing the completion of generate candidate image operation
This property was added in vSphere API 8.0.3.0.
If this flag is set, it means all hosts in cluster are running the same software image. In this case, “mostWidelyUsedImage” and “highestVersionImage” of “imageCategories” will contain same software image as value and subsequently “isHighestAndWidelyUsedImageEqual” flag will also be set. If this flag is not set, then depending upon the software image running in hosts “imageCategories” fields will be filled.
This property was added in vSphere API 8.0.3.0.
Execution status of the task. If it's not SUCCESS then the Esx Settings Clusters InstalledImages InstalledImageInfo.notifications property of this schema can be inspected for more information.
For more information see: Esx Settings Clusters InstalledImages InstalledImageInfo Status.
This property was added in vSphere API 8.0.3.0.
List of Hosts for which software image has extracted
This property was added in vSphere API 8.0.3.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.
List of hosts for which no software image has extracted
This property was added in vSphere API 8.0.3.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.
List of hosts that were skipped for extracting software image. Host will be skipped when software version is less than the supported version.
This property was added in vSphere API 8.0.3.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.
Various categories of software image running on hosts in the cluster
This property was added in vSphere API 8.0.3.0.
Notifications stating any error or orphaned vibs etc on Hosts
This property was added in vSphere API 8.0.3.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.
Information about the hosts in this cluster for which checks have been requested to be run.
This property was added in vSphere API 8.0.3.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.
Information about the orphaned vibs available on the hosts underlying cluster. Here Key is the orphaned vibs and value is the list of hosts where these orphaned vibs have installed. orphaned vibs formats are orphaned vibs name(version).
This property was added in vSphere API 8.0.3.0.
When clients pass a value of this schema as a parameter, the value 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 value in the property map will be an identifier for the resource type: HostSystem.
Various notifications received and segregated based on operation type while generating the report. If the task's status is ELIGIBILITY_CHECK_FAILURE then the notifications corresponding to the ELIGIBILITY_CHECK key can be inspected for more informaiton. For any other task status the notifications corresponding to the EXTRACT_INSTALLED_IMAGE key can be inspected.
This property was added in vSphere API 8.0.3.0.
If the caller is not authenticated.
"Vapi Std Errors Unauthenticated Object"Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.
For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"
This property was added in vSphere API 7.0.0.0.
This property is optional because it was added in a newer version than its parent node.
If the caller is not authorized.
"Vapi Std Errors Unauthorized Object"If there is no cluster associated with cluster in the system.
"Vapi Std Errors NotFound Object"If there is unknown internal error. The accompanying error message will give more details about the failure
"Vapi Std Errors Error Object"Stack of one or more localizable messages for human error consumers.
The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.
Each subsequent message in the stack describes the "cause" of the prior message.
Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.
Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.
The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.
Some operations will not set this property when reporting errors.
Discriminator field to help API consumers identify the structure type.
For more information see: Vapi Std Errors Error Type.
This property was added in vSphere API 6.7.2.
Can be missing or null for compatibility with preceding implementations.
If the service is not available.
"Vapi Std Errors ServiceUnavailable Object" curl -H 'Authorization: <value>' https://{api_host}/api/esx/settings/clusters/{cluster}/installed-images