Get Entropy External Pool
Retrieves the entropy pool details of a host including current entropy level. if you do not have all of the privileges described as follows: - The resource HostSystem referenced by the parameter host requires Host.Entropy.Read.
Request
URLURL
https://{api_host}/api/vcenter/host/{host}/entropy/external-pool
Path Parameters
Path Parameters
string
host
Required
Identifier of the host. The parameter must be an identifier for the resource type: HostSystem.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
HostEntropyExternalPoolInfo
of type application/json
Entropy details of a host.
{
"capacity": 0,
"currently_available": 0,
"inactive_source_timeout": 0,
"low_watermark": 0,
"status": "ENABLED"
}
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.
Possible values are: ENABLED , DISABLED
integer
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
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
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.
integer
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.
Errors
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/host/{host}/entropy/external-pool
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: get
Availability
Added in 8.0.0.10200
