com.vmware.vcenter.vm.guest

Interface Identity

All Superinterfaces:

IdentityTypes, Service

All Known Implementing Classes:

IdentityStub

public interface Identity
extends Service, IdentityTypes

The Identity interface provides methods for retrieving guest operating system identification information. This interface was added in vSphere API 6.7.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.vm.guest.IdentityTypes

IdentityTypes.Info

Method Summary

Methods

Modifier and Type	Method and Description
IdentityTypes.Info	get(java.lang.String vm) Return information about the guest.
void	get(java.lang.String vm, AsyncCallback<IdentityTypes.Info> asyncCallback) Return information about the guest.
void	get(java.lang.String vm, AsyncCallback<IdentityTypes.Info> asyncCallback, InvocationConfig invocationConfig) Return information about the guest.
IdentityTypes.Info	get(java.lang.String vm, InvocationConfig invocationConfig) Return information about the guest.

Method Detail

get

IdentityTypes.Info get(java.lang.String vm)

Return information about the guest. This method was added in vSphere API 6.7.

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

Parameters:

vm - Identifier of the virtual machine. The parameter must be an identifier for the resource type: VirtualMachine.

Returns:

guest identification information.

Throws:

Error - if the system reports an error while responding to the request.

NotFound - if the virtual machine is not found.

ServiceUnavailable - if VMware Tools is not running.

ServiceUnavailable - if VMware Tools has not provided any values.

get

IdentityTypes.Info get(java.lang.String vm,
                     InvocationConfig invocationConfig)

Return information about the guest. This method was added in vSphere API 6.7.

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:

vm - Identifier of the virtual machine. The parameter must be an identifier for the resource type: VirtualMachine.

invocationConfig - Configuration for the method invocation.

Returns:

guest identification information.

Throws:

Error - if the system reports an error while responding to the request.

NotFound - if the virtual machine is not found.

ServiceUnavailable - if VMware Tools is not running.

ServiceUnavailable - if VMware Tools has not provided any values.

get

void get(java.lang.String vm,
       AsyncCallback<IdentityTypes.Info> asyncCallback)

Return information about the guest. This method was added in vSphere API 6.7.

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

Operation Result:
guest identification information.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if the virtual machine is not found.
ServiceUnavailable - if VMware Tools is not running.
ServiceUnavailable - if VMware Tools has not provided any values.

Parameters:

vm - Identifier of the virtual machine. The parameter must be an identifier for the resource type: VirtualMachine.

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

get

void get(java.lang.String vm,
       AsyncCallback<IdentityTypes.Info> asyncCallback,
       InvocationConfig invocationConfig)

Return information about the guest. This method was added in vSphere API 6.7.

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

Operation Result:
guest identification information.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if the virtual machine is not found.
ServiceUnavailable - if VMware Tools is not running.
ServiceUnavailable - if VMware Tools has not provided any values.

Parameters:

vm - Identifier of the virtual machine. The parameter must be an identifier for the resource type: VirtualMachine.

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

invocationConfig - Configuration for the method invocation.