com.vmware.vcenter.host.entropy

Interface ExternalPool

All Superinterfaces:

ExternalPoolTypes, Service

All Known Implementing Classes:

ExternalPoolStub

public interface ExternalPool
extends Service, ExternalPoolTypes

The ExternalPool interface provides methods to send entropy data and query external entropy pool information on an ESX host. Clients can check the entropy level of an ESX host using the get(java.lang.String) method to check com.vmware.vcenter.host.entropy.ExternalPool#Info. When the entropy level has dropped below a threshold, a client can use the add(java.lang.String, com.vmware.vcenter.host.entropy.ExternalPoolTypes.AddSpec) method to add additional entropy until as required. This interface was added in vSphere API 8.0.0.10200.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.host.entropy.ExternalPoolTypes

ExternalPoolTypes.AddResult, ExternalPoolTypes.AddSpec, ExternalPoolTypes.Info, ExternalPoolTypes.Status

Field Summary

Fields inherited from interface com.vmware.vcenter.host.entropy.ExternalPoolTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
ExternalPoolTypes.AddResult	add(java.lang.String host, ExternalPoolTypes.AddSpec spec) Adds additional entropy to the pool.
void	add(java.lang.String host, ExternalPoolTypes.AddSpec spec, AsyncCallback<ExternalPoolTypes.AddResult> asyncCallback) Adds additional entropy to the pool.
void	add(java.lang.String host, ExternalPoolTypes.AddSpec spec, AsyncCallback<ExternalPoolTypes.AddResult> asyncCallback, InvocationConfig invocationConfig) Adds additional entropy to the pool.
ExternalPoolTypes.AddResult	add(java.lang.String host, ExternalPoolTypes.AddSpec spec, InvocationConfig invocationConfig) Adds additional entropy to the pool.
ExternalPoolTypes.Info	get(java.lang.String host) Retrieves the entropy pool details of a host including current entropy level.
void	get(java.lang.String host, AsyncCallback<ExternalPoolTypes.Info> asyncCallback) Retrieves the entropy pool details of a host including current entropy level.
void	get(java.lang.String host, AsyncCallback<ExternalPoolTypes.Info> asyncCallback, InvocationConfig invocationConfig) Retrieves the entropy pool details of a host including current entropy level.
ExternalPoolTypes.Info	get(java.lang.String host, InvocationConfig invocationConfig) Retrieves the entropy pool details of a host including current entropy level.

Method Detail

get

ExternalPoolTypes.Info get(java.lang.String host)

Retrieves the entropy pool details of a host including current entropy level. This method was added in vSphere API 8.0.0.10200.

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

Parameters:

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

Returns:

Entropy details of a host.

Throws:

Error - if there is a generic error.

NotFound - if the host is not found.

ServiceUnavailable - if the host is not available.

Unauthenticated - if the caller is not authenticated.

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

• The resource HostSystem referenced by the parameter host requires Host.Entropy.Read.

get

ExternalPoolTypes.Info get(java.lang.String host,
                           InvocationConfig invocationConfig)

Retrieves the entropy pool details of a host including current entropy level. This method was added in vSphere API 8.0.0.10200.

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. The parameter must be an identifier for the resource type: HostSystem.

invocationConfig - Configuration for the method invocation.

Returns:

Entropy details of a host.

Throws:

Error - if there is a generic error.

NotFound - if the host is not found.

ServiceUnavailable - if the host is not available.

Unauthenticated - if the caller is not authenticated.

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

• The resource HostSystem referenced by the parameter host requires Host.Entropy.Read.

get

void get(java.lang.String host,
         AsyncCallback<ExternalPoolTypes.Info> asyncCallback)

Retrieves the entropy pool details of a host including current entropy level. This method was added in vSphere API 8.0.0.10200.

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

Invocation Result:
Entropy details of a host.

Operation Errors:
Error - if there is a generic error.
NotFound - if the host is not found.
ServiceUnavailable - if the host is not available.
Unauthenticated - if the caller is not authenticated.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource HostSystem referenced by the parameter host requires Host.Entropy.Read.

Parameters:

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

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

get

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

Retrieves the entropy pool details of a host including current entropy level. This method was added in vSphere API 8.0.0.10200.

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:
Entropy details of a host.

Operation Errors:
Error - if there is a generic error.
NotFound - if the host is not found.
ServiceUnavailable - if the host is not available.
Unauthenticated - if the caller is not authenticated.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource HostSystem referenced by the parameter host requires Host.Entropy.Read.

Parameters:

host - Identifier of the host. 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.

add

ExternalPoolTypes.AddResult add(java.lang.String host,
                                ExternalPoolTypes.AddSpec spec)

Adds additional entropy to the pool. This API will accept maximum (ExternalPoolTypes.Info.getCapacity() - ExternalPoolTypes.Info.getCurrentlyAvailable()) bytes of entropy. Extra entropy data sent will be discarded. This method was added in vSphere API 8.0.0.10200.

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

Parameters:

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

spec - contains buffer of entropy data.

Returns:

Result of add() method.

Throws:

Error - if there is a generic error.

NotFound - if the host is not found.

ServiceUnavailable - if the host is not available.

Unauthenticated - if the caller is not authenticated.

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

• The resource HostSystem referenced by the parameter host requires Host.Entropy.Write.

add

ExternalPoolTypes.AddResult add(java.lang.String host,
                                ExternalPoolTypes.AddSpec spec,
                                InvocationConfig invocationConfig)

Adds additional entropy to the pool. This API will accept maximum (ExternalPoolTypes.Info.getCapacity() - ExternalPoolTypes.Info.getCurrentlyAvailable()) bytes of entropy. Extra entropy data sent will be discarded. This method was added in vSphere API 8.0.0.10200.

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. The parameter must be an identifier for the resource type: HostSystem.

spec - contains buffer of entropy data.

invocationConfig - Configuration for the method invocation.

Returns:

Result of add() method.

Throws:

Error - if there is a generic error.

NotFound - if the host is not found.

ServiceUnavailable - if the host is not available.

Unauthenticated - if the caller is not authenticated.

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

• The resource HostSystem referenced by the parameter host requires Host.Entropy.Write.

add

void add(java.lang.String host,
         ExternalPoolTypes.AddSpec spec,
         AsyncCallback<ExternalPoolTypes.AddResult> asyncCallback)

Adds additional entropy to the pool. This API will accept maximum (ExternalPoolTypes.Info.getCapacity() - ExternalPoolTypes.Info.getCurrentlyAvailable()) bytes of entropy. Extra entropy data sent will be discarded. This method was added in vSphere API 8.0.0.10200.

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

Invocation Result:
Result of add() method.

Operation Errors:
Error - if there is a generic error.
NotFound - if the host is not found.
ServiceUnavailable - if the host is not available.
Unauthenticated - if the caller is not authenticated.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource HostSystem referenced by the parameter host requires Host.Entropy.Write.

Parameters:

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

spec - contains buffer of entropy data.

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

add

void add(java.lang.String host,
         ExternalPoolTypes.AddSpec spec,
         AsyncCallback<ExternalPoolTypes.AddResult> asyncCallback,
         InvocationConfig invocationConfig)

Adds additional entropy to the pool. This API will accept maximum (ExternalPoolTypes.Info.getCapacity() - ExternalPoolTypes.Info.getCurrentlyAvailable()) bytes of entropy. Extra entropy data sent will be discarded. This method was added in vSphere API 8.0.0.10200.

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:
Result of add() method.

Operation Errors:
Error - if there is a generic error.
NotFound - if the host is not found.
ServiceUnavailable - if the host is not available.
Unauthenticated - if the caller is not authenticated.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource HostSystem referenced by the parameter host requires Host.Entropy.Write.

Parameters:

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

spec - contains buffer of entropy data.

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

invocationConfig - Configuration for the method invocation.