Esx. Settings. Hosts. Software. Base Image Get

Esx. Settings. Hosts. Software. Base Image Get

Returns the desired base-image specification set for given host

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/base-image
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

Base-image specification.

Returns Esx.Settings.BaseImageInfo of type(s) application/json
"Esx.Settings.BaseImageInfo Object"

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 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/base-image