Esx.Settings.Inventory.Reports.TransitionSummary.Clusters.ClusterSummary
The Esx.Settings.Inventory.Reports.TransitionSummary.Clusters.ClusterSummary schema contains properties that describes the cluster and what software it is currently running. It fetches the software details from all the hosts within the cluster. Along with the software details, it also provides the status of a given cluster with respect to its transition from baseline managed to image managed.
This schema was added in vSphere API 9.0.0.0.
{
"cluster": "string",
"last_check_time": "string",
"uniform_image": false,
"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"
}
}
},
"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"
]
}
}
}
}
}
],
"orphan_vibs": false,
"status": "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
}
]
}
}Identifier of the cluster
This property was added in vSphere API 9.0.0.0.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: ClusterComputeResource. When operations return a value of this schema as a response, the property will be an identifier for the resource type: ClusterComputeResource.
Defines the timestamp when the last com.vmware.esx.settings.inventory.Inventory#extractInstalledImage operation was executed on a given entity.
This property was added in vSphere API 9.0.0.0.
Defines if the given entity is having a single image or not.
This property was added in vSphere API 9.0.0.0.
Defines the list of unique images found on a given cluster.
This property was added in vSphere API 9.0.0.0.
Defines if any orphan VIBs are found on an entity. If found the user is expected to check the detailed installed-image report of a given entity.
This property was added in vSphere API 9.0.0.0.
Esx.Settings.Inventory.Reports.TransitionSummary.Clusters.TransitionStatus of a given entity as described in #TransitionStatus.
Possible values:
- NOT_DETECTED: Transition workflow first needs the com.vmware.esx.settings.inventory.Inventory#extractInstalledImage operation to be executed. This status defines that the com.vmware.esx.settings.inventory.Inventory#extractInstalledImage operation is not executed or the result is not available for a given cluster.
- DETECTING_IMAGE: Defines that com.vmware.esx.settings.inventory.Inventory#extractInstalledImage operation is in-progress for a given cluster.
- ELIGIBLE: Defines that a given cluster is ready for transition from baseline managed to image managed. This also states that the given cluster is also eligible to be transitioned through the com.vmware.esx.settings.inventory.Inventory#transition workflow. One of the criteria is that the given entity has single installed-image.
- CLUSTER_LEVEL_CONVERSION_REQUIRED: Defines that the cluster is not ready for transition from baseline managed to image managed using com.vmware.esx.settings.inventory.Inventory#transition operation. One of the possible reasons could be that the given cluster might have multiple installed images. In such case, the given cluster cannot be transitioned using this workflow but can be done using existing cluster workflow.
- CONVERTING: Defines that for a given cluster is getting converted from baseline managed to image managed using com.vmware.esx.settings.inventory.Inventory#transition operation.
- CONVERTED: Defines the a given cluster is successfully converted from baseline managed to image managed.
- UNKNOWN: Defines that the transition status of the cluster is unknown.
Warning: this constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
For more information see: Esx.Settings.Inventory.Reports.TransitionSummary.Clusters.TransitionStatus.
This property was added in vSphere API 9.0.0.0.
Describes if any notifications were raised for the given entity during the execution of the operation.
This property was added in vSphere API 9.0.0.0.