Vcenter Host Entropy ExternalPool add
Adds additional entropy to the pool. This API will accept maximum (Vcenter Host Entropy ExternalPool Info.capacity - Vcenter Host Entropy ExternalPool Info.currently_available) bytes of entropy. Extra entropy data sent will be discarded.
This operation was added in vSphere API 8.0.1.0.
Returns an authorization error if you do not have all of the privileges described as follows:
- The resource
HostSystemreferenced by the parameter host requiresHost.Entropy.Write.
Identifier of the host.
The parameter must be an identifier for the resource type: HostSystem.
contains buffer of entropy data.
{
"data": "string"
}Buffer for entropy data. This will carry entropy data received from the external entropy source.
This property was added in vSphere API 8.0.1.0.
Result of add operation.
{
"capacity": 0,
"currently_available": 0,
"low_watermark": 0,
"inactive_source_timeout": 0
}Capacity of external entropy pool in bytes.
This property was added in vSphere API 8.0.1.0.
Currently available amount of entropy in bytes in the external entropy pool.
This property was added in vSphere API 8.0.1.0.
A threshold value in bytes. An audit record will be logged when Vcenter Host Entropy ExternalPool AddResult.currently_available drops below this value.
This property was added in vSphere API 8.0.1.0.
A timeout period in seconds within which the client must call GET /vcenter/host/{host}/entropy/external-pool operation or POST /vcenter/host/{host}/entropy/external-pool?action=add operation. If no call is received before the timeout lapses an audit record will be created.
This is the timeout to detect any connection lost with the client.
This property was added in vSphere API 8.0.1.0.
if the caller is not authenticated.
{
"messages": [
{
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
}
],
"data": {},
"error_type": "string",
"challenge": "string"
}Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.
For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"
This property was added in vSphere API 7.0.0.0.
This property is optional because it was added in a newer version than its parent node.
if the host is not found.
{
"messages": [
{
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
}
],
"data": {},
"error_type": "string"
}if there is a generic error.
{
"messages": [
{
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
}
],
"data": {},
"error_type": "string"
}Stack of one or more localizable messages for human error consumers.
The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.
Each subsequent message in the stack describes the "cause" of the prior message.
Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.
Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.
The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.
Some operations will not set this property when reporting errors.
Discriminator field to help API consumers identify the structure type.
For more information see: Vapi Std Errors Error Type.
This property was added in vSphere API 6.7.2.
Can be missing or null for compatibility with preceding implementations.
if the host is not available.
{
"messages": [
{
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
}
],
"data": {},
"error_type": "string"
} curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"data:"string"}' https://{api_host}/api/vcenter/host/{host}/entropy/external-pool?action=add