RESOURCEPOOL: Resource Pool
The RESOURCEPOOL entity: A logical partition of CPU and memory resources within a hypervisor cluster, with reservations, limits, and shares for workload isolation.
RESOURCEPOOL definition shipped with DemandFlow. Administrators can add, remove, rename, or re-type fields, change which ones are required, and alter the layout from the Definitions screen in Settings. Your tenant's current schema may differ from what is shown here. To read the current definition at any time, GET the DEFINITION object whose id matches RESOURCEPOOL.Entity properties
| Property | Value |
|---|---|
| Entity code | RESOURCEPOOL |
| Display name | Resource Pool |
| Plural | Resource Pools |
| Level | 330 |
Use cases
RESOURCEPOOL models the resource partitioning layer in hypervisor clusters. vSphere Resource Pools, Hyper-V resource metering groups, Proxmox resource pools, etc. It is a child of HYPCLUSTER via comboKey (SUB|HYPC).
Resource pools can nest via the parentPool self-referential lookup, supporting hierarchical resource allocation (e.g. Production > Tier1 > Database). CPU and memory each have three controls: reservation (guaranteed minimum), limit (hard cap), and shares (relative priority when resources are contended).
Fields
Pool Information
| Field | Type | Required | Notes |
|---|---|---|---|
name | text | Yes | Pool Name |
description | text (multi-line) | Description | |
cluster | reference → HYPCLUSTER | Cluster | |
parentPool | reference → RESOURCEPOOL | Nest within a parent resource pool | |
status | enum | Yes | Status Valid ids: 1 (Active), 2 (Inactive). |
expandableReservation | boolean | Allow this pool to borrow from parent when its own reservation is exhausted |
CPU Resources
| Field | Type | Required | Notes |
|---|---|---|---|
cpuReservationMhz | number | Guaranteed minimum CPU | |
cpuLimitMhz | number | Hard cap. -1 = unlimited | |
cpuShares | number | Relative priority (Low=1000, Normal=2000, High=4000, or custom) | |
cpuShareLevel | enum | Share Level Valid ids: 1 (Low), 2 (Normal), 3 (High), 4 (Custom). | |
cpuUsedMhz | number | Read-only. Current Usage (MHz) |
Memory Resources
| Field | Type | Required | Notes |
|---|---|---|---|
memReservationGB | number | Guaranteed minimum memory | |
memLimitGB | number | Hard cap. -1 = unlimited | |
memShares | number | Shares | |
memShareLevel | enum | Share Level Valid ids: 1 (Low), 2 (Normal), 3 (High), 4 (Custom). | |
memUsedGB | number | Read-only. Current Usage (GB) |
Summary
| Field | Type | Required | Notes |
|---|---|---|---|
vmCount | number | Read-only. VMs in Pool | |
childPoolCount | number | Read-only. Child Pools |
Additional panels
- Activity timeline panel attached.
Relationships
- Lookups:
clusterpoints at aHYPCLUSTERrecord;parentPoolpoints at aRESOURCEPOOLrecord. - Related lists:
COMPINV(formatlink),RESOURCEPOOL(formatlink).
Creating a Resource Pool via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "RESOURCEPOOL",
"level": 330,
"comboKey": "SUB:|ENT:",
"name": "Example name",
"status": 1,
"description": "Example Description",
"cluster": ""
} Listing Resource Pools records
GET /v1/entities/RESOURCEPOOL/SUB