com.vmware.vcenter

Interface Host

All Superinterfaces:

HostTypes, Service

All Known Implementing Classes:

HostStub

public interface Host
extends Service, HostTypes

The Host interface provides methods to manage hosts in the vCenter Server.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.HostTypes

HostTypes.ConnectionState, HostTypes.CreateSpec, HostTypes.FilterSpec, HostTypes.PowerState, HostTypes.Summary

Field Summary

Fields inherited from interface com.vmware.vcenter.HostTypes

_VAPI_SERVICE_ID, RESOURCE_TYPE

Method Summary

Modifier and Type	Method and Description
void	connect(java.lang.String host) Connect to the host corresponding to host previously added to the vCenter server.
void	connect(java.lang.String host, AsyncCallback<java.lang.Void> asyncCallback) Connect to the host corresponding to host previously added to the vCenter server.
void	connect(java.lang.String host, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Connect to the host corresponding to host previously added to the vCenter server.
void	connect(java.lang.String host, InvocationConfig invocationConfig) Connect to the host corresponding to host previously added to the vCenter server.
java.lang.String	create(HostTypes.CreateSpec spec) Add a new standalone host in the vCenter inventory.
void	create(HostTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback) Add a new standalone host in the vCenter inventory.
void	create(HostTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Add a new standalone host in the vCenter inventory.
java.lang.String	create(HostTypes.CreateSpec spec, InvocationConfig invocationConfig) Add a new standalone host in the vCenter inventory.
void	delete(java.lang.String host) Remove a standalone host from the vCenter Server.
void	delete(java.lang.String host, AsyncCallback<java.lang.Void> asyncCallback) Remove a standalone host from the vCenter Server.
void	delete(java.lang.String host, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Remove a standalone host from the vCenter Server.
void	delete(java.lang.String host, InvocationConfig invocationConfig) Remove a standalone host from the vCenter Server.
void	disconnect(java.lang.String host) Disconnect the host corresponding to host from the vCenter server
void	disconnect(java.lang.String host, AsyncCallback<java.lang.Void> asyncCallback) Disconnect the host corresponding to host from the vCenter server
void	disconnect(java.lang.String host, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Disconnect the host corresponding to host from the vCenter server
void	disconnect(java.lang.String host, InvocationConfig invocationConfig) Disconnect the host corresponding to host from the vCenter server
java.util.List<HostTypes.Summary>	list(HostTypes.FilterSpec filter) Returns information about at most 2500 visible (subject to permission checks) hosts in vCenter matching the HostTypes.FilterSpec.
void	list(HostTypes.FilterSpec filter, AsyncCallback<java.util.List<HostTypes.Summary>> asyncCallback) Returns information about at most 2500 visible (subject to permission checks) hosts in vCenter matching the HostTypes.FilterSpec.
void	list(HostTypes.FilterSpec filter, AsyncCallback<java.util.List<HostTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) Returns information about at most 2500 visible (subject to permission checks) hosts in vCenter matching the HostTypes.FilterSpec.
java.util.List<HostTypes.Summary>	list(HostTypes.FilterSpec filter, InvocationConfig invocationConfig) Returns information about at most 2500 visible (subject to permission checks) hosts in vCenter matching the HostTypes.FilterSpec.

Method Detail

create

java.lang.String create(HostTypes.CreateSpec spec)

Add a new standalone host in the vCenter inventory. The newly connected host will be in connected state. The vCenter Server will verify the SSL certificate before adding the host to its inventory. In the case where the SSL certificate cannot be verified because the Certificate Authority is not recognized or the certificate is self signed, the vCenter Server will fall back to thumbprint verification mode as defined by HostTypes.CreateSpec.ThumbprintVerification.

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

Parameters:

spec - Specification for the new host to be created.

Returns:

The newly created identifier of the host in vCenter. The return value will be an identifier for the resource type: HostSystem.

Throws:

AlreadyExists - if the host with the same name is already present.

Error - if installation of VirtualCenter agent on a host fails.

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

InvalidArgument - if the host name is invalid.

InvalidArgument - if the host folder is invalid.

InvalidArgument - if the SSL thumbprint specified is invalid.

InvalidElementType - if the host folder id does not support vSphere compute resource as its children type.

NotFound - if there is no folder associated with the getFolder() property in the system.

ResourceInUse - if the host is already being managed by another vCenter Server

UnableToAllocateResource - if there are not enough licenses to add the host.

Unauthenticated - if the user name or password for the administration account on the host are invalid.

Unauthenticated - if the user can not be authenticated.

Unsupported - if the software version on the host is not supported.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

Unauthorized - if the user doesn't have the required privileges.

create

java.lang.String create(HostTypes.CreateSpec spec,
                        InvocationConfig invocationConfig)

Add a new standalone host in the vCenter inventory. The newly connected host will be in connected state. The vCenter Server will verify the SSL certificate before adding the host to its inventory. In the case where the SSL certificate cannot be verified because the Certificate Authority is not recognized or the certificate is self signed, the vCenter Server will fall back to thumbprint verification mode as defined by HostTypes.CreateSpec.ThumbprintVerification.

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 - Specification for the new host to be created.

invocationConfig - Configuration for the method invocation.

Returns:

The newly created identifier of the host in vCenter. The return value will be an identifier for the resource type: HostSystem.

Throws:

AlreadyExists - if the host with the same name is already present.

Error - if installation of VirtualCenter agent on a host fails.

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

InvalidArgument - if the host name is invalid.

InvalidArgument - if the host folder is invalid.

InvalidArgument - if the SSL thumbprint specified is invalid.

InvalidElementType - if the host folder id does not support vSphere compute resource as its children type.

NotFound - if there is no folder associated with the getFolder() property in the system.

ResourceInUse - if the host is already being managed by another vCenter Server

UnableToAllocateResource - if there are not enough licenses to add the host.

Unauthenticated - if the user name or password for the administration account on the host are invalid.

Unauthenticated - if the user can not be authenticated.

Unsupported - if the software version on the host is not supported.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

Unauthorized - if the user doesn't have the required privileges.

create

void create(HostTypes.CreateSpec spec,
            AsyncCallback<java.lang.String> asyncCallback)

Add a new standalone host in the vCenter inventory. The newly connected host will be in connected state. The vCenter Server will verify the SSL certificate before adding the host to its inventory. In the case where the SSL certificate cannot be verified because the Certificate Authority is not recognized or the certificate is self signed, the vCenter Server will fall back to thumbprint verification mode as defined by HostTypes.CreateSpec.ThumbprintVerification.

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

Invocation Result:
The newly created identifier of the host in vCenter. The return value will be an identifier for the resource type: HostSystem.

Operation Errors:
AlreadyExists - if the host with the same name is already present.
Error - if installation of VirtualCenter agent on a host fails.
Error - if the system reports an error while responding to the request.
InvalidArgument - if the host name is invalid.
InvalidArgument - if the host folder is invalid.
InvalidArgument - if the SSL thumbprint specified is invalid.
InvalidElementType - if the host folder id does not support vSphere compute resource as its children type.
NotFound - if there is no folder associated with the getFolder() property in the system.
ResourceInUse - if the host is already being managed by another vCenter Server
UnableToAllocateResource - if there are not enough licenses to add the host.
Unauthenticated - if the user name or password for the administration account on the host are invalid.
Unauthenticated - if the user can not be authenticated.
Unsupported - if the software version on the host is not supported.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthorized - if the user doesn't have the required privileges.

Parameters:

spec - Specification for the new host to be created.

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

create

void create(HostTypes.CreateSpec spec,
            AsyncCallback<java.lang.String> asyncCallback,
            InvocationConfig invocationConfig)

Add a new standalone host in the vCenter inventory. The newly connected host will be in connected state. The vCenter Server will verify the SSL certificate before adding the host to its inventory. In the case where the SSL certificate cannot be verified because the Certificate Authority is not recognized or the certificate is self signed, the vCenter Server will fall back to thumbprint verification mode as defined by HostTypes.CreateSpec.ThumbprintVerification.

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:
The newly created identifier of the host in vCenter. The return value will be an identifier for the resource type: HostSystem.

Operation Errors:
AlreadyExists - if the host with the same name is already present.
Error - if installation of VirtualCenter agent on a host fails.
Error - if the system reports an error while responding to the request.
InvalidArgument - if the host name is invalid.
InvalidArgument - if the host folder is invalid.
InvalidArgument - if the SSL thumbprint specified is invalid.
InvalidElementType - if the host folder id does not support vSphere compute resource as its children type.
NotFound - if there is no folder associated with the getFolder() property in the system.
ResourceInUse - if the host is already being managed by another vCenter Server
UnableToAllocateResource - if there are not enough licenses to add the host.
Unauthenticated - if the user name or password for the administration account on the host are invalid.
Unauthenticated - if the user can not be authenticated.
Unsupported - if the software version on the host is not supported.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthorized - if the user doesn't have the required privileges.

Parameters:

spec - Specification for the new host to be created.

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

invocationConfig - Configuration for the method invocation.

delete

void delete(java.lang.String host)

Remove a standalone host from the vCenter Server.

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

Parameters:

host - Identifier of the host to be deleted. The parameter must be an identifier for the resource type: HostSystem.

Throws:

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

NotFound - if there is no host associated with host in the system.

ResourceInUse - if the host associated with host is in a vCenter cluster

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user doesn't have the required privileges.

delete

void delete(java.lang.String host,
            InvocationConfig invocationConfig)

Remove a standalone host from the vCenter Server.

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:

host - Identifier of the host to be deleted. The parameter must be an identifier for the resource type: HostSystem.

invocationConfig - Configuration for the method invocation.

Throws:

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

NotFound - if there is no host associated with host in the system.

ResourceInUse - if the host associated with host is in a vCenter cluster

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user doesn't have the required privileges.

delete

void delete(java.lang.String host,
            AsyncCallback<java.lang.Void> asyncCallback)

Remove a standalone host from the vCenter Server.

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

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if there is no host associated with host in the system.
ResourceInUse - if the host associated with host is in a vCenter cluster
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.

Parameters:

host - Identifier of the host to be deleted. The parameter must be an identifier for the resource type: HostSystem.

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

delete

void delete(java.lang.String host,
            AsyncCallback<java.lang.Void> asyncCallback,
            InvocationConfig invocationConfig)

Remove a standalone host from the vCenter Server.

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

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if there is no host associated with host in the system.
ResourceInUse - if the host associated with host is in a vCenter cluster
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.

Parameters:

host - Identifier of the host to be deleted. The parameter must be an identifier for the resource type: HostSystem.

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

invocationConfig - Configuration for the method invocation.

list

java.util.List<HostTypes.Summary> list(HostTypes.FilterSpec filter)

Returns information about at most 2500 visible (subject to permission checks) hosts in vCenter matching the HostTypes.FilterSpec.

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

Parameters:

filter - Specification of matching hosts for which information should be returned. If null, the behavior is equivalent to a HostTypes.FilterSpec with all properties null which means all hosts match the filter.

Returns:

Commonly used information about the hosts matching the HostTypes.FilterSpec.

Throws:

InvalidArgument - if the HostTypes.FilterSpec.getConnectionStates() property contains a value that is not supported by the server.

UnableToAllocateResource - if more than 2500 hosts match the HostTypes.FilterSpec.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user doesn't have the required privileges.

list

java.util.List<HostTypes.Summary> list(HostTypes.FilterSpec filter,
                                       InvocationConfig invocationConfig)

Returns information about at most 2500 visible (subject to permission checks) hosts in vCenter matching the HostTypes.FilterSpec.

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:

filter - Specification of matching hosts for which information should be returned. If null, the behavior is equivalent to a HostTypes.FilterSpec with all properties null which means all hosts match the filter.

invocationConfig - Configuration for the method invocation.

Returns:

Commonly used information about the hosts matching the HostTypes.FilterSpec.

Throws:

InvalidArgument - if the HostTypes.FilterSpec.getConnectionStates() property contains a value that is not supported by the server.

UnableToAllocateResource - if more than 2500 hosts match the HostTypes.FilterSpec.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user doesn't have the required privileges.

list

void list(HostTypes.FilterSpec filter,
          AsyncCallback<java.util.List<HostTypes.Summary>> asyncCallback)

Returns information about at most 2500 visible (subject to permission checks) hosts in vCenter matching the HostTypes.FilterSpec.

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

Invocation Result:
Commonly used information about the hosts matching the HostTypes.FilterSpec.

Operation Errors:
InvalidArgument - if the HostTypes.FilterSpec.getConnectionStates() property contains a value that is not supported by the server.
UnableToAllocateResource - if more than 2500 hosts match the HostTypes.FilterSpec.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.

Parameters:

filter - Specification of matching hosts for which information should be returned. If null, the behavior is equivalent to a HostTypes.FilterSpec with all properties null which means all hosts match the filter.

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

list

void list(HostTypes.FilterSpec filter,
          AsyncCallback<java.util.List<HostTypes.Summary>> asyncCallback,
          InvocationConfig invocationConfig)

Returns information about at most 2500 visible (subject to permission checks) hosts in vCenter matching the HostTypes.FilterSpec.

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:
Commonly used information about the hosts matching the HostTypes.FilterSpec.

Operation Errors:
InvalidArgument - if the HostTypes.FilterSpec.getConnectionStates() property contains a value that is not supported by the server.
UnableToAllocateResource - if more than 2500 hosts match the HostTypes.FilterSpec.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.

Parameters:

filter - Specification of matching hosts for which information should be returned. If null, the behavior is equivalent to a HostTypes.FilterSpec with all properties null which means all hosts match the filter.

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

invocationConfig - Configuration for the method invocation.

connect

void connect(java.lang.String host)

Connect to the host corresponding to host previously added to the vCenter server.

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

Parameters:

host - Identifier of the host to be reconnected. The parameter must be an identifier for the resource type: HostSystem.

Throws:

AlreadyInDesiredState - if the host associated with host is already connected.

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

NotFound - if there is no host associated with host in the system.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user doesn't have the required privileges.

connect

void connect(java.lang.String host,
             InvocationConfig invocationConfig)

Connect to the host corresponding to host previously added to the vCenter server.

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:

host - Identifier of the host to be reconnected. The parameter must be an identifier for the resource type: HostSystem.

invocationConfig - Configuration for the method invocation.

Throws:

AlreadyInDesiredState - if the host associated with host is already connected.

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

NotFound - if there is no host associated with host in the system.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user doesn't have the required privileges.

connect

void connect(java.lang.String host,
             AsyncCallback<java.lang.Void> asyncCallback)

Connect to the host corresponding to host previously added to the vCenter server.

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

Operation Errors:
AlreadyInDesiredState - if the host associated with host is already connected.
Error - if the system reports an error while responding to the request.
NotFound - if there is no host associated with host in the system.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.

Parameters:

host - Identifier of the host to be reconnected. The parameter must be an identifier for the resource type: HostSystem.

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

connect

void connect(java.lang.String host,
             AsyncCallback<java.lang.Void> asyncCallback,
             InvocationConfig invocationConfig)

Connect to the host corresponding to host previously added to the vCenter server.

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

Operation Errors:
AlreadyInDesiredState - if the host associated with host is already connected.
Error - if the system reports an error while responding to the request.
NotFound - if there is no host associated with host in the system.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.

Parameters:

host - Identifier of the host to be reconnected. The parameter must be an identifier for the resource type: HostSystem.

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

invocationConfig - Configuration for the method invocation.

disconnect

void disconnect(java.lang.String host)

Disconnect the host corresponding to host from the vCenter server

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

Parameters:

host - Identifier of the host to be disconnected. The parameter must be an identifier for the resource type: HostSystem.

Throws:

AlreadyInDesiredState - if the host associated with host is already disconnected.

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

NotFound - if there is no host associated with host in the system.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user doesn't have the required privileges.

disconnect

void disconnect(java.lang.String host,
                InvocationConfig invocationConfig)

Disconnect the host corresponding to host from the vCenter server

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:

host - Identifier of the host to be disconnected. The parameter must be an identifier for the resource type: HostSystem.

invocationConfig - Configuration for the method invocation.

Throws:

AlreadyInDesiredState - if the host associated with host is already disconnected.

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

NotFound - if there is no host associated with host in the system.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user doesn't have the required privileges.

disconnect

void disconnect(java.lang.String host,
                AsyncCallback<java.lang.Void> asyncCallback)

Disconnect the host corresponding to host from the vCenter server

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

Operation Errors:
AlreadyInDesiredState - if the host associated with host is already disconnected.
Error - if the system reports an error while responding to the request.
NotFound - if there is no host associated with host in the system.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.

Parameters:

host - Identifier of the host to be disconnected. The parameter must be an identifier for the resource type: HostSystem.

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

disconnect

void disconnect(java.lang.String host,
                AsyncCallback<java.lang.Void> asyncCallback,
                InvocationConfig invocationConfig)

Disconnect the host corresponding to host from the vCenter server

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

Operation Errors:
AlreadyInDesiredState - if the host associated with host is already disconnected.
Error - if the system reports an error while responding to the request.
NotFound - if there is no host associated with host in the system.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.

Parameters:

host - Identifier of the host to be disconnected. The parameter must be an identifier for the resource type: HostSystem.

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

invocationConfig - Configuration for the method invocation.