Reference For: developers

API schemas: D

Schemas of the native REST API whose name starts with D.

DailySummaryView

The usage summary of one day.

NameTypeRequiredDescription
daystringyesThe day.
tenantsarray of UsageLineViewyesPer tenant.
totalsUsageLineViewyesTotals.
vmsarray of UsageLineViewyesPer VM.

Datacenter

A datacenter: the top-level container. Its four child folders are created with it.

NameTypeRequiredDescription
namestringyesDisplay name.

Datastore

A datastore.

NameTypeRequiredDescription
accessiblebooleanWhether it is reachable.
capacity_bytesinteger (int64)Total capacity.
datastore_typeDatastoreTypeBackend type.
free_bytesinteger (int64)Free space.
hostsarray of stringHosts that have mounted it.
namestringyesDisplay name.
nasDatastoreNas or null
urlstringBackend-specific URL/path (never contains credentials).

DatastoreCapacityView

The size and free space of a datastore as a host measured them.

NameTypeRequiredDescription
accessiblebooleanyesReachable from the host that measured it.
capacityBytesinteger (int64)yesSize of the file system in bytes.
freeBytesinteger (int64)yesFree bytes.
idstringyesDatastore id.
measuredOnstringyesThe host that measured it.
namestringyesName.
refreshedAtstringyesWhen (RFC 3339).

DatastoreEntry

An entry of a folder listing (native API).

NameTypeRequiredDescription
capacityBytesinteger (int64) or nullGuest-visible capacity of a disk image.
formatstring or nullFormat of a disk image (qcow2, raw, vmdk).
kindstringyesClass of the file (vmDisk, iso, vmConfig, file, ...; folder for folders).
modifiedAtstring or nullLast change (RFC 3339).
namestringyesName.
sizeBytesinteger (int64) or nullSize in bytes (allocated bytes for disk images); absent for folders.
typestringyesfolder or file.

DatastoreListing

A folder listing (native API).

NameTypeRequiredDescription
entriesarray of DatastoreEntryyesFolders first, then files, by name.
pathstringyesThe folder, relative to the datastore root (empty: the root).
truncatedbooleanyesThe folder has more entries than one listing returns.

DatastoreNas

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.

NameTypeRequiredDescription
remote_hoststringyesNFS server (HostNasVolumeSpec.remoteHost).
remote_pathstringyesExport path (HostNasVolumeSpec.remotePath).
security_typestring or nullSecurity flavour (sys / krb5 / …), when known.
volume_typestring or nullVolume type string (NFS / NFS41), when known.

DatastoreType

Datastore backend type. The string form matches what tools expect in summary.type.

Values: "LOCAL", "NFS", "BLOCK", "RBD", "LINSTOR", "ZFS"

DeadLetterView

A dead letter.

NameTypeRequiredDescription
attemptsinteger (int32)yesAttempts.
eventIdstringyesEvent id.
failedAtstringyesWhen it was parked.
lastErrorstringyesLast error.

DefaultActionView

Default action of a profile direction.

Values: "allow", "drop", "reject"

DeliveryResultView

Delivery outcome.

NameTypeRequiredDescription
attemptsinteger (int32)yesAttempts made.
deliveredbooleanyesDelivered (2xx).
errorstring or nullLast error.
statusinteger (int32)yesLast HTTP status.

DhcpEvidence

What the DHCP responder on the quarantine bridge saw.

NameTypeRequiredDescription
acksinteger (int64)yesACKs sent (the guest took the lease).
addressstring or nullThe leased address.
macstring or nullThe NIC's MAC.
nicstring or nullThe NIC the evidence is about.
offersinteger (int64)yesOFFERs sent.

DirectionView

Direction relative to the vNICs the rule applies to.

Values: "in", "out", "in-out"

DiskBackupView

OpenAPI stand-in for one disk inside a backup session.

NameTypeRequiredDescription
capacityinteger (int64)yesCapacity in bytes at the backup point.
changeIdstringyesChange id this backup will commit on success.
deviceKeyinteger (int32)yesDevice key of the disk in the VM.
diskIdstring (uuid)yesStable disk identity.
exportNbdExportView or null
granularityinteger (int64)yesTracking granularity in bytes.
incrementalbooleanyesWhether since was honoured (false means full/allocated areas).
sincestringyes* or a change id the client asked relative to.

DiskChangeInfoView

OpenAPI stand-in for one page of changed areas.

NameTypeRequiredDescription
changedAreaarray of ChangedAreaViewyesAreas within the covered range.
lengthinteger (int64)yesNumber of bytes covered by this reply.
startOffsetinteger (int64)yesFirst byte covered by this reply.

DiskFileRequest

A disk file a create or reconfigure task makes on the datastore.

NameTypeRequiredDescription
datastorestringyesDatastore id (datastore-N).
linkedbooleanWith 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.
pathstringyesPath below the datastore root (web-01/web-01.qcow2).
sizeBytesinteger (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).
sourceDatastorestring or nullDatastore of the image (datastore-N).
sourcePathstring or nullImage to start from: a path below the root of sourceDatastore (default: the target datastore).

DiskSelectionView

OpenAPI stand-in for one disk selection in a begin-backup request.

NameTypeRequiredDescription
deviceKeyinteger (int32)yesDevice key of the disk in the VM.
sincestringyes* for a full backup, or a change id from a previous completed session.

DistributedPortgroup

A port group on a distributed switch.

NameTypeRequiredDescription
ipv4HostBridgeIpv4 or null
ipv6PortgroupIpv6 or null
leasesobjectThe 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.
namestringyesDisplay name.
static_addressesobjectFixed IPv4 addresses by MAC (lower case), set by the operator; inside the subnet, inside or outside the range.
switchstring or nullThe switch.
vlan_idinteger (int32)VLAN id, 0 for untagged.
vniinteger (int32) or nullOverlay segment (Geneve VNI) when not VLAN-backed.

DistributedSwitch

A distributed virtual switch (maps to an OVN logical switch set).

NameTypeRequiredDescription
host_uplinksarray of DvsHostUplinksThe 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).
hostsarray of stringMember hosts.
mtuinteger (int32)Maximum transmission unit.
namestringyesDisplay name.
uplink_namesarray of stringNames of the uplinks (the ports of the switch's uplink port group, uplinkPortPolicy.uplinkPortName in vSphere); empty: uplink1 to uplink<uplinks>.
uplinksinteger (int32)Number of uplinks per host.

The physical NICs of one member host of a distributed switch.

NameTypeRequiredDescription
hoststringyesThe member host.
nicsobjectUplink name to the host's physical NIC (eno2).

Version 0.1.