DailySummaryView
The usage summary of one day.
| Name | Type | Required | Description |
|---|---|---|---|
day | string | yes | The day. |
tenants | array of UsageLineView | yes | Per tenant. |
totals | UsageLineView | yes | Totals. |
vms | array of UsageLineView | yes | Per VM. |
Schemas of the native REST API whose name starts with D.
The usage summary of one day.
| Name | Type | Required | Description |
|---|---|---|---|
day | string | yes | The day. |
tenants | array of UsageLineView | yes | Per tenant. |
totals | UsageLineView | yes | Totals. |
vms | array of UsageLineView | yes | Per VM. |
A datacenter: the top-level container. Its four child folders are created with it.
| Name | Type | Required | Description |
|---|---|---|---|
name | string | yes | Display name. |
A datastore.
| Name | Type | Required | Description |
|---|---|---|---|
accessible | boolean | Whether it is reachable. | |
capacity_bytes | integer (int64) | Total capacity. | |
datastore_type | DatastoreType | Backend type. | |
free_bytes | integer (int64) | Free space. | |
hosts | array of string | Hosts that have mounted it. | |
name | string | yes | Display name. |
nas | DatastoreNas or null | ||
url | string | Backend-specific URL/path (never contains credentials). |
The size and free space of a datastore as a host measured them.
| Name | Type | Required | Description |
|---|---|---|---|
accessible | boolean | yes | Reachable from the host that measured it. |
capacityBytes | integer (int64) | yes | Size of the file system in bytes. |
freeBytes | integer (int64) | yes | Free bytes. |
id | string | yes | Datastore id. |
measuredOn | string | yes | The host that measured it. |
name | string | yes | Name. |
refreshedAt | string | yes | When (RFC 3339). |
An entry of a folder listing (native API).
| Name | Type | Required | Description |
|---|---|---|---|
capacityBytes | integer (int64) or null | Guest-visible capacity of a disk image. | |
format | string or null | Format of a disk image (qcow2, raw, vmdk). | |
kind | string | yes | Class of the file (vmDisk, iso, vmConfig, file, ...; folder for folders). |
modifiedAt | string or null | Last change (RFC 3339). | |
name | string | yes | Name. |
sizeBytes | integer (int64) or null | Size in bytes (allocated bytes for disk images); absent for folders. | |
type | string | yes | folder or file. |
A folder listing (native API).
| Name | Type | Required | Description |
|---|---|---|---|
entries | array of DatastoreEntry | yes | Folders first, then files, by name. |
path | string | yes | The folder, relative to the datastore root (empty: the root). |
truncated | boolean | yes | The folder has more entries than one listing returns. |
NFS remote recorded for a datastore created via HostDatastoreSystem.CreateNasDatastore.
The inventory url is the host file:// mount point after AgentOps pool-attach (PoolManager → mount -t nfs); this carries the remote host/export projected as NasDatastoreInfo.
| Name | Type | Required | Description |
|---|---|---|---|
remote_host | string | yes | NFS server (HostNasVolumeSpec.remoteHost). |
remote_path | string | yes | Export path (HostNasVolumeSpec.remotePath). |
security_type | string or null | Security flavour (sys / krb5 / …), when known. | |
volume_type | string or null | Volume type string (NFS / NFS41), when known. |
Datastore backend type. The string form matches what tools expect in summary.type.
Values: "LOCAL", "NFS", "BLOCK", "RBD", "LINSTOR", "ZFS"
A dead letter.
| Name | Type | Required | Description |
|---|---|---|---|
attempts | integer (int32) | yes | Attempts. |
eventId | string | yes | Event id. |
failedAt | string | yes | When it was parked. |
lastError | string | yes | Last error. |
Default action of a profile direction.
Values: "allow", "drop", "reject"
Delivery outcome.
| Name | Type | Required | Description |
|---|---|---|---|
attempts | integer (int32) | yes | Attempts made. |
delivered | boolean | yes | Delivered (2xx). |
error | string or null | Last error. | |
status | integer (int32) | yes | Last HTTP status. |
What the DHCP responder on the quarantine bridge saw.
| Name | Type | Required | Description |
|---|---|---|---|
acks | integer (int64) | yes | ACKs sent (the guest took the lease). |
address | string or null | The leased address. | |
mac | string or null | The NIC's MAC. | |
nic | string or null | The NIC the evidence is about. | |
offers | integer (int64) | yes | OFFERs sent. |
Direction relative to the vNICs the rule applies to.
Values: "in", "out", "in-out"
OpenAPI stand-in for one disk inside a backup session.
| Name | Type | Required | Description |
|---|---|---|---|
capacity | integer (int64) | yes | Capacity in bytes at the backup point. |
changeId | string | yes | Change id this backup will commit on success. |
deviceKey | integer (int32) | yes | Device key of the disk in the VM. |
diskId | string (uuid) | yes | Stable disk identity. |
export | NbdExportView or null | ||
granularity | integer (int64) | yes | Tracking granularity in bytes. |
incremental | boolean | yes | Whether since was honoured (false means full/allocated areas). |
since | string | yes | * or a change id the client asked relative to. |
OpenAPI stand-in for one page of changed areas.
| Name | Type | Required | Description |
|---|---|---|---|
changedArea | array of ChangedAreaView | yes | Areas within the covered range. |
length | integer (int64) | yes | Number of bytes covered by this reply. |
startOffset | integer (int64) | yes | First byte covered by this reply. |
A disk file a create or reconfigure task makes on the datastore.
| Name | Type | Required | Description |
|---|---|---|---|
datastore | string | yes | Datastore id (datastore-N). |
linked | boolean | With sourcePath: true makes a qcow2 overlay whose backing file is the image (linked clone; same datastore, the image is only read), false a full copy. | |
path | string | yes | Path below the datastore root (web-01/web-01.qcow2). |
sizeBytes | integer (int64) | Capacity in bytes. For a disk from an image: at least the image's virtual size; a larger value grows the new disk (the image stays as it is). | |
sourceDatastore | string or null | Datastore of the image (datastore-N). | |
sourcePath | string or null | Image to start from: a path below the root of sourceDatastore (default: the target datastore). |
OpenAPI stand-in for one disk selection in a begin-backup request.
| Name | Type | Required | Description |
|---|---|---|---|
deviceKey | integer (int32) | yes | Device key of the disk in the VM. |
since | string | yes | * for a full backup, or a change id from a previous completed session. |
A port group on a distributed switch.
| Name | Type | Required | Description |
|---|---|---|---|
ipv4 | HostBridgeIpv4 or null | ||
ipv6 | PortgroupIpv6 or null | ||
leases | object | The IPv4 address of every NIC on the port group by MAC (lower case): the fixed ones and those allocated from the range. Maintained by the control plane. | |
name | string | yes | Display name. |
static_addresses | object | Fixed IPv4 addresses by MAC (lower case), set by the operator; inside the subnet, inside or outside the range. | |
switch | string or null | The switch. | |
vlan_id | integer (int32) | VLAN id, 0 for untagged. | |
vni | integer (int32) or null | Overlay segment (Geneve VNI) when not VLAN-backed. |
A distributed virtual switch (maps to an OVN logical switch set).
| Name | Type | Required | Description |
|---|---|---|---|
host_uplinks | array of DvsHostUplinks | The physical NICs of each member host that back the uplinks (vSphere: the host proxy switch, DistributedVirtualSwitchHostMemberPnicSpec). VLAN-backed port groups reach the physical network through them (docs/network/DESIGN.md §6.4). | |
hosts | array of string | Member hosts. | |
mtu | integer (int32) | Maximum transmission unit. | |
name | string | yes | Display name. |
uplink_names | array of string | Names of the uplinks (the ports of the switch's uplink port group, uplinkPortPolicy.uplinkPortName in vSphere); empty: uplink1 to uplink<uplinks>. | |
uplinks | integer (int32) | Number of uplinks per host. |
The physical NICs of one member host of a distributed switch.
| Name | Type | Required | Description |
|---|---|---|---|
host | string | yes | The member host. |
nics | object | Uplink name to the host's physical NIC (eno2). |
Version 0.1.