Get Hosts Software Recommendations
Returns Information about the most recent recommendation generation result. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read. - The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Read.
Request
URLURL
https://{api_host}/api/esx/settings/hosts/{host}/software/recommendations
Path Parameters
Path Parameters
string
host
Required
Identifier of the host. The parameter must be an identifier for the resource type: HostSystem.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
SettingsHostsSoftwareRecommendationsInfo
of type application/json
Information about the most recent recommendation generation result.
{
"base_image_explanation_details": [
{
"display_name": "string",
"display_version": "string",
"explanation": [
{
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
}
]
}
],
"check_time": "string",
"current_series_recommendation": {
"add_on": {
"details": {
"display_name": "string",
"display_version": "string",
"vendor": "string"
},
"name": "string",
"version": "string"
},
"base_image": {
"details": {
"display_name": "string",
"display_version": "string",
"release_date": "string"
},
"version": "string"
},
"components": {
"key": {
"details": {
"display_name": "string",
"display_version": "string",
"vendor": "string"
},
"version": "string"
}
},
"hardware_support": {
"packages": {
"key": {
"pkg": "string",
"version": "string"
}
}
},
"solutions": {
"key": {
"components": [
{
"component": "string"
}
],
"details": {
"components": [
{
"component": "string",
"display_name": "string",
"display_version": "string",
"vendor": "string"
}
],
"display_name": "string",
"display_version": "string"
},
"version": "string"
}
}
},
"latest_recommendation": {
"add_on": {
"details": {
"display_name": "string",
"display_version": "string",
"vendor": "string"
},
"name": "string",
"version": "string"
},
"base_image": {
"details": {
"display_name": "string",
"display_version": "string",
"release_date": "string"
},
"version": "string"
},
"components": {
"key": {
"details": {
"display_name": "string",
"display_version": "string",
"vendor": "string"
},
"version": "string"
}
},
"hardware_support": {
"packages": {
"key": {
"pkg": "string",
"version": "string"
}
}
},
"solutions": {
"key": {
"components": [
{
"component": "string"
}
],
"details": {
"components": [
{
"component": "string",
"display_name": "string",
"display_version": "string",
"vendor": "string"
}
],
"display_name": "string",
"display_version": "string"
},
"version": "string"
}
}
}
}
base_image_explanation_details
Required
Details about why some base images are excluded in latest and current series recommendations. This is not applicable for specified base image recommendations.
string
check_time
Optional
The most recent timestamp when check for recommended image is launched. unset if no recommendation check has ever been launched.
current_series_recommendation
Optional
Recommended image specification based on latest base image patch or update of the current series. unset if no recommended image based on latest base image patch or update of the current series is available.
latest_recommendation
Optional
Recommended image specification based on latest base image version. unset if no recommended image based on latest base image version is available.
Errors
400
com.vmware.vapi.std.errors.unsupported : If the host is not a vLCM managed standlone host.
404
com.vmware.vapi.std.errors.not_found : The requested resource could not be found but may be available again in the future.
500
com.vmware.vapi.std.errors.error : If there is unknown internal error. The accompanying error message will give more details about the failure.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-GetHostSoftwareRecommendations -Host "MyHost"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/esx/settings/hosts/{host}/software/recommendations
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: get
Availability
Added in 8.0.0.1
