Esx. Settings. Hosts. Software. Components List

Esx. Settings. Hosts. Software. Components List

Returns a list of components in the desired software specification.

This operation was added in vSphere API 8.0.0.1.

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}/esx/settings/hosts/{host}/software/components
COPY
Path Parameters
string
host
Required

Identifier of the host.

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

Authentication
This operation uses the following authentication methods.
Responses
200

Map of ComponentInfo keyed by the component identifier. If no version is specified in desired software specification, then it will be empty.

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

{
    "0": "E",
    "1": "s",
    "2": "x",
    "3": ".",
    "4": "S",
    "5": "e",
    "6": "t",
    "7": "t",
    "8": "i",
    "9": "n",
    "10": "g",
    "11": "s",
    "12": ".",
    "13": "C",
    "14": "o",
    "15": "m",
    "16": "p",
    "17": "o",
    "18": "n",
    "19": "e",
    "20": "n",
    "21": "t",
    "22": "I",
    "23": "n",
    "24": "f",
    "25": "o",
    "26": " ",
    "27": "O",
    "28": "b",
    "29": "j",
    "30": "e",
    "31": "c",
    "32": "t"
}

400

If the host is not a vLCM managed standalone host.

Returns Vapi.Std.Errors.Unsupported of type(s) application/json 
"Vapi.Std.Errors.Unsupported Object"

401

If the caller is not authenticated.

Returns Vapi.Std.Errors.Unauthenticated of type(s) application/json 
"Vapi.Std.Errors.Unauthenticated Object"

404

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

Returns Vapi.Std.Errors.NotFound of type(s) application/json 
"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.Error of type(s) application/json 
"Vapi.Std.Errors.Error Object"

503

If the service is not available.

Returns Vapi.Std.Errors.ServiceUnavailable of type(s) application/json 
"Vapi.Std.Errors.ServiceUnavailable Object"

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/esx/settings/hosts/{host}/software/components
On This Page
Esx.settings.hosts.software.components Operations
GET
Esx. Settings. Hosts. Software. Components Get
GET
Esx. Settings. Hosts. Software. Components List