List Software Installed Components
Returns the installed components on the host. 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/hosts/{host}/software/installed-components
Path Parameters
Path Parameters
string
host
Required
Identifier of the cluster. 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
map of
HostsSoftwareInstalledComponentsInstalledComponentInfo
of type application/json
The components installed on the host. The key in the result map will be an identifier for the resource type: com.vmware.esx.hosts.component.
{
"display_name": "string",
"display_version": "string",
"platforms": [
"string"
],
"version": "string"
}
string
display_name
Required
Display name of the component.
string
display_version
Required
Human readable version of the component.
string
version
Required
Version of the installed component
array of
string
platforms
Optional
Platforms the component belongs to. Example: host, vmdpu0, vmdpu1, … This field is optional because it was added in a newer version than its parent node.
Errors
404
com.vmware.vapi.std.errors.not_found : If there is no host associated with host in the system.
500
com.vmware.vapi.std.errors.internal_server_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-ListHostSoftwareInstalledComponents -Host "MyHost"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/esx/hosts/{host}/software/installed-components
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
