List Hardware Support Managers
Returns the list of registered Hardware Support Managers (HSMs) in the system. 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
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
array of
SettingsHardwareSupportManagersHardwareSupportManagerInfo
of type application/json
List of currently registered Hardware Support Manager (HSMs)
[
{
"description": "string",
"display_name": "string",
"manager": "string",
"vendor": "string"
}
]
string
description
Required
User-intelligible description of the HSM (e.g. “Front end for Frobozz so-and-so management system”)
string
display_name
Required
UI label for HSM, derived from HSM extension’s description’s ‘label’ field. (e.g. “Frobozz Free Management System”)
string
manager
Required
Name of the Hardware Support Manager (HSM) (e.g. “Frobozz Hardware Support Manager”) 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.manager. 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.manager.
string
vendor
Required
Company providing the Hardware Support Manager (HSM) (e.g. “Frobozz Magic Software Company”)
Errors
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-ListHardwareSupportManagers
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/esx/settings/hardware-support/managers
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: list
Availability
Added in 7.0.0.0
