Esx Settings Hosts Software Recommendations get
Returns Information about the most recent recommendation generation result.
This operation was added in vSphere API 8.0.0.1.
Returns an authorization error if you do not have all of the privileges described as follows:
- Operation execution requires
VcIntegrity.lifecycleSoftwareSpecification.Read. - The resource
HostSystemreferenced by the parameter host requiresVcIntegrity.lifecycleSoftwareSpecification.Read.
Identifier of the host.
The parameter must be an identifier for the resource type: HostSystem.
Information about the most recent recommendation generation result.
{
"latest_recommendation": {
"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"
]
}
}
}
}
},
"current_series_recommendation": {
"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"
]
}
}
}
}
},
"base_image_explanation_details": [
{
"display_name": "string",
"display_version": "string",
"explanation": [
{
"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"
}
]
}
],
"check_time": "string"
}Recommended image specification based on latest base image version.
This property was added in vSphere API 8.0.0.1.
missing or null if no recommended image based on latest base image version is available.
Recommended image specification based on latest base image patch or update of the current series.
This property was added in vSphere API 8.0.0.1.
missing or null if no recommended image based on latest base image patch or update of the current series is available.
Details about why some base images are excluded in latest and current series recommendations. This is not applicable for specified base image recommendations.
This property was added in vSphere API 8.0.0.1.
The most recent timestamp when check for recommended image is launched.
This property was added in vSphere API 8.0.0.1.
missing or null if no recommendation check has ever been launched.
If the host is not a vLCM managed standlone host.
"Vapi Std Errors Unsupported Object"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.
Error!
"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/hosts/{host}/software/recommendations