com.vmware.esx.hosts

Interface Software

All Superinterfaces:

Service, SoftwareTypes

All Known Implementing Classes:

SoftwareStub

public interface Software
extends Service, SoftwareTypes

The Software interface provides methods to get and extract the current software specification applied to the host. This interface was added in vSphere API 7.0.2.0.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.esx.hosts.SoftwareTypes

SoftwareTypes.ConnectionSpec, SoftwareTypes.HostCredentials, SoftwareTypes.Info

Field Summary

Fields inherited from interface com.vmware.esx.hosts.SoftwareTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
SoftwareTypes.Info	get(SoftwareTypes.ConnectionSpec spec) Returns details about the current software specification applied to the host.
void	get(SoftwareTypes.ConnectionSpec spec, AsyncCallback<SoftwareTypes.Info> asyncCallback) Returns details about the current software specification applied to the host.
void	get(SoftwareTypes.ConnectionSpec spec, AsyncCallback<SoftwareTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns details about the current software specification applied to the host.
SoftwareTypes.Info	get(SoftwareTypes.ConnectionSpec spec, InvocationConfig invocationConfig) Returns details about the current software specification applied to the host.

Method Detail

get

SoftwareTypes.Info get(SoftwareTypes.ConnectionSpec spec)

Returns details about the current software specification applied to the host. This method was added in vSphere API 7.0.2.0.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

spec - ConnectionSpec connection spec for the host.

Returns:

Info details about the current software specification applied to the host.

Throws:

InvalidArgument - if the ConnectionSpec.HostCredentials#hostName property of spec is invalid.

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

NotFound - If there is no ConnectionSpec.HostCredentials#hostName property associated with host id in the system.

ServiceUnavailable - If the service is not available.

Unauthenticated - if the caller is not authenticated.

UnverifiedPeer - If the SSL certificate of the target node cannot be validated by comparing with the thumbprint provided in ConnectionSpec.HostCredentials#sslThumbPrint.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSoftwareSpecification.Read.

get

SoftwareTypes.Info get(SoftwareTypes.ConnectionSpec spec,
                       InvocationConfig invocationConfig)

Returns details about the current software specification applied to the host. This method was added in vSphere API 7.0.2.0.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

spec - ConnectionSpec connection spec for the host.

invocationConfig - Configuration for the method invocation.

Returns:

Info details about the current software specification applied to the host.

Throws:

InvalidArgument - if the ConnectionSpec.HostCredentials#hostName property of spec is invalid.

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

NotFound - If there is no ConnectionSpec.HostCredentials#hostName property associated with host id in the system.

ServiceUnavailable - If the service is not available.

Unauthenticated - if the caller is not authenticated.

UnverifiedPeer - If the SSL certificate of the target node cannot be validated by comparing with the thumbprint provided in ConnectionSpec.HostCredentials#sslThumbPrint.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSoftwareSpecification.Read.

get

void get(SoftwareTypes.ConnectionSpec spec,
         AsyncCallback<SoftwareTypes.Info> asyncCallback)

Returns details about the current software specification applied to the host. This method was added in vSphere API 7.0.2.0.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
Info details about the current software specification applied to the host.

Operation Errors:
InvalidArgument - if the ConnectionSpec.HostCredentials#hostName property of spec is invalid.
Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no ConnectionSpec.HostCredentials#hostName property associated with host id in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - if the caller is not authenticated.
UnverifiedPeer - If the SSL certificate of the target node cannot be validated by comparing with the thumbprint provided in ConnectionSpec.HostCredentials#sslThumbPrint.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSoftwareSpecification.Read.

Parameters:

spec - ConnectionSpec connection spec for the host.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

get

void get(SoftwareTypes.ConnectionSpec spec,
         AsyncCallback<SoftwareTypes.Info> asyncCallback,
         InvocationConfig invocationConfig)

Returns details about the current software specification applied to the host. This method was added in vSphere API 7.0.2.0.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
Info details about the current software specification applied to the host.

Operation Errors:
InvalidArgument - if the ConnectionSpec.HostCredentials#hostName property of spec is invalid.
Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no ConnectionSpec.HostCredentials#hostName property associated with host id in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - if the caller is not authenticated.
UnverifiedPeer - If the SSL certificate of the target node cannot be validated by comparing with the thumbprint provided in ConnectionSpec.HostCredentials#sslThumbPrint.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSoftwareSpecification.Read.

Parameters:

spec - ConnectionSpec connection spec for the host.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.