Esx Hosts Software InstalledComponents list

Esx Hosts Software InstalledComponents list

Returns the installed components on the host.

This operation was added in vSphere API 7.0.0.0.

Returns an authorization error 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
URI
GET
https://{api_host}/api/esx/hosts/{host}/software/installed-components
COPY
Path Parameters
string
host
Required

Identifier of the cluster.

The parameter must be an identifier for the resource type: HostSystem.

Authentication
This operation uses the following authentication methods.
Responses
200

The components installed on the host.

The key in the response map will be an identifier for the resource type: com.vmware.esx.hosts.component.

{
    "display_name": "string",
    "version": "string",
    "display_version": "string",
    "platforms": [
        "string"
    ]
}

401

if the caller is not authenticated.

Returns Vapi Std Errors Unauthenticated of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors Unauthenticated0 
"Vapi Std Errors Unauthenticated Object"
string
challenge
Optional

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.


404

If there is no host associated with host in the system.

Returns Vapi Std Errors NotFound of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors NotFound0 
"Vapi Std Errors NotFound Object"

500

If there is some unknown internal error. The accompanying error message will give more details about the failure.

Returns Vapi Std Errors InternalServerError of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors InternalServerError0 
"Vapi Std Errors InternalServerError Object"

503

If the service is not available.

Returns Vapi Std Errors ServiceUnavailable of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors ServiceUnavailable0 
"Vapi Std Errors ServiceUnavailable Object"

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/esx/hosts/{host}/software/installed-components
On This Page
Esx Hosts Operations
GET
Esx Hosts Software InstalledComponents list