Get Hardware Support Managers Packages Versions
Returns the detailed information for a specific version of an available Hardware Support Packages (HSPs) as specified by the Hardware Support Manager (HSM) if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Read.
Request
URLURL
https://{api_host}/api/esx/settings/hardware-support/managers/{manager}/packages/{pkg}/versions/{version}
Path Parameters
Path Parameters
string
manager
Required
Identifier for the Hardware Support Manager (HSM). The parameter must be an identifier for the resource type: com.vmware.esx.setting.hardware_support.manager.
string
pkg
Required
The name of the Hardware Support Package (HSP) The parameter must be an identifier for the resource type: com.vmware.esx.setting.hardware_support.package.
string
version
Required
The version of the Hardware Support Package (HSP)
Query Parameters
Query Parameters
string
base_image_version
Optional
vSphere release version for the component information in the Hardware Support Package (HSP). Only Hardware Support Packages (HSPs) compatible with the vSphere release version specified in ‘baseImageVersion’ will be returned. The ‘baseImageVersion’ parameter should be a full numeric base image version string (e.g. “7.1.0-2.3.436234”). Future implementations may support version specification by prefix (e.g. “7.1” to specify all updates and builds of 7.1) or other forms of specification (e.g. “>=7.0”). Hardware Support Pacakges (HSPs) may be advertised as supporting truncated version strings to indicate the remainder is wildcarded. Matching is on the specified substring only, so a bundle supporting “7.1.0-2” would match a ‘release’ parameter of “7.1.0-2.3.436234” as well as “7.1.0-2.1.4133564” and “7.1.0-2.0.355667” but not “7.1.0-3.0.63445” or any base image version starting with “7.2”. Note that we require compatible base image versions be specified at least down to the update version (i.e. “7.0” is insufficiently constrained) If unset, all supported releases will be returned but no specific component information (added or deleted) will be included.
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
SettingsHardwareSupportManagersPackagesVersionsPackageInfo
of type application/json
detailed information on Hardware Support Packages (HSPs)
{
"components": [
{
"display_name": "string",
"display_version": "string",
"name": "string",
"version": "string"
}
],
"description": "string",
"pkg": "string",
"removed_components": [
{
"display_name": "string",
"name": "string"
}
],
"supported_releases": [
"string"
],
"version": "string"
}
components
Required
List of components in this HSP manifest.
string
description
Required
Description of the Hardware Support Package (HSP) (e.g. for use in help bubble)
string
pkg
Required
Name of the Hardware Support Package (e.g. “Jan. 2018 Release” or “Latest Hardware Support Package for Frobozz GenX hardware”) selected When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.esx.setting.hardware_support.package. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.esx.setting.hardware_support.package.
removed_components
Required
List of components removed by this HSP manifest.
array of
string
supported_releases
Required
Supported vSphere releases
string
version
Required
Version of the Hardware Support Package (e.g. “20180128.1” or “v42”) selected
Errors
400
com.vmware.vapi.std.errors.invalid_argument : If any of the specified parameters are Invalid (e.g. if the release version specified in the query parameter is not, in fact, among those supported by the Hardware Support Package (HSP).
401
com.vmware.vapi.std.errors.unauthenticated : if the caller is not authenticated. named manager in the system.
403
com.vmware.vapi.std.errors.unauthorized : if the user does not have the required privilege to perform the operation.
404
com.vmware.vapi.std.errors.not_found : If there is no Hardware Support Manager (HSM) with the specified name, or no Hardware Support Package (HSP) with the specified name and version.
500
com.vmware.vapi.std.errors.error : If there is some 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-GetManagerPkgVersionPackages -Manager "MyManager" -Pkg "MyPkg" -Version "MyVersion" -BaseImageVersion "MyBaseImageVersion"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/esx/settings/hardware-support/managers/{manager}/packages/{pkg}/versions/{version}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: get
Availability
Added in 7.0.0
