Host_Entropy_ExternalPool_Info

Host_Entropy_ExternalPool_Info
Host_Entropy_ExternalPool_Info

The ExternalPool.Info structure contains entropy pool information on the ESX host. It provides external entropy pool details as well as timeout in seconds within which client has to keep calling ExternalPool.get operation. Client has to monitor Info.currentlyAvailable parameter. Before the entropy level goes down below a threshold value the client has to send entropy data by calling ExternalPool.add operation.

JSON Example
{
    "status": "string",
    "capacity": 0,
    "currently_available": 0,
    "low_watermark": 0,
    "inactive_source_timeout": 0
}
status
Required

The ExternalPool.Status enum represents external entropy status on an ESX host.
ENABLED : External entropy is enabled for the ESX host.
DISABLED : External entropy is disabled for the ESX host.

integer As int64
capacity
Optional

Capacity of external entropy pool in bytes. This field is optional and it is only relevant when the value of ExternalPool.Info.status is ENABLED.

integer As int64
currently_available
Optional

Currently available amount of entropy in bytes in the external entropy pool. This field is optional and it is only relevant when the value of ExternalPool.Info.status is ENABLED.

integer As int64
low_watermark
Optional

A threshold value in bytes. An audit record will be logged when ExternalPool.Info.currently-available drops below this value. This field is optional and it is only relevant when the value of ExternalPool.Info.status is ENABLED.

integer As int64
inactive_source_timeout
Optional

A timeout period in seconds within which the client must call ExternalPool.get operation or ExternalPool.add operation. If no call is received before the timeout lapses an audit record will be created. This timeout is used to detect that connection with the client is lost.

This field is optional and it is only relevant when the value of ExternalPool.Info.status is ENABLED.