API schemas: V

VerificationRecord

The last nightly run of one VM.

Name	Type	Required	Description
`backupSessionId`	`string` (uuid) or `null`		The backup session restored.
`evidence`	`Evidence` or `null`
`passed`	`boolean`	yes	Verdict.
`reason`	`string` or `null`		Message key of the failure.
`restoredVmId`	`string` (uuid) or `null`		The restored VM (may be destroyed already).
`runAt`	`integer` (int64)	yes	Run time, Unix seconds.
`vmId`	`string` (uuid)	yes	The VM that was backed up.
`vmName`	`string`	yes	Its name.

VerificationReport

GET /v1/backup/verification.

Name	Type	Required	Description
`neverVerified`	array of `string`	yes	VMs flagged for verification that have never been verified.
`runs`	array of `VerificationRecord`	yes	Last run per VM, by VM name.

VerifySpec

What to verify against.

Name	Type	Required	Description
`destroy`	`boolean`		Destroy the restored VM after the verdict (default: keep it powered off).
`network`	`string`	yes	The quarantine network: id or name.
`serialMarkers`	array of `string`		Serial markers that count as an operating system (default: [`OS_MARKERS`]).
`tcpPorts`	array of `integer` (int32)		TCP ports to check from the host probe after boot and lease (empty: no TCP check).
`timeoutSeconds`	`integer` (int64) or `null`		Give up after this many seconds (default 300, at most 3600).

VerifyState

State of a restore verification.

Values: "running", "passed", "failed"

VimMoRefView

Managed-object reference embedded in create/clone/AddHost/snapshot results (TaskInfo.result for the SOAP facade).

Name	Type	Required	Description
`type`	`string`	yes	vim type name (`VirtualMachine`, `HostSystem`, `VirtualMachineSnapshot`).
`value`	`string`	yes	MoRef value (`vm-42`, `host-7`, `vm-42-snapshot-1`).

VirtualCdrom

A virtual CD-ROM drive (VirtualCdrom), optionally with an ISO image inserted.

Name	Type	Required	Description
`connected`	`boolean`		Connected at power on.
`datastore`	`string` or `null`		Datastore holding the inserted ISO image; `None` is an empty tray.
`iso_path`	`string`		ISO path relative to the datastore root; empty for an empty tray.
`key`	`integer` (int32)	yes	Stable device key within the VM (3000, 3001, ...).

VirtualDisk

A virtual disk.

Name	Type	Required	Description
`capacity_bytes`	`integer` (int64)	yes	Capacity.
`cbt_enabled`	`boolean`		Changed-block tracking enabled.
`datastore`	`string`	yes	Datastore holding the backing file.
`independent`	`boolean`		Excluded from snapshots (`diskMode = independent_persistent`, ESX-V-07).
`key`	`integer` (int32)	yes	Stable device key within the VM.
`nonpersistent`	`boolean`		Independent non-persistent (`diskMode = independent_nonpersistent`): power-cycle overlay discarded on stop. Implies `independent`.
`path`	`string`	yes	Backing path relative to the datastore root.
`thin`	`boolean`		Thin provisioned.

VirtualMachine

A virtual machine.

Name	Type	Required	Description
`config`	`VmConfig`	yes	Desired configuration.
`current_snapshot`	`integer` (int32) or `null`		The snapshot the running state descends from (`snapshot.currentSnapshot`).
`desired_power_state`	`PowerState`		The power state the control plane wants; the host agent reconciles `runtime.power_state` towards it and reports back.
`generation`	`integer` (int64)		Desired-state generation; bumped on every config change or power request so the host agent knows what to reconcile.
`guest`	`VmGuest`		Guest information.
`instance_uuid`	`string` (uuid)	yes	Stable instance UUID exposed to the guest (SMBIOS).
`name`	`string`	yes	Display name.
`reset_epoch`	`integer` (int64)		Incremented by every reset request; the host resets the VM once per increment (a reset does not change the desired power state).
`resource_pool`	`string`	yes	Resource pool the VM belongs to.
`runtime`	`VmRuntime`		Observed runtime state.
`snapshots`	array of `VmSnapshot`		Snapshot tree, flat (each snapshot names its parent), in creation order.

VirtualNic

A virtual NIC.

Name	Type	Required	Description
`connected`	`boolean`		Connected at power on.
`firewall`	`object`		Distributed firewall mode and profile of the vNIC (`DFW-HOSTBRIDGE.md` §4); the default (mode `off`) is not written.
`key`	`integer` (int32)	yes	Stable device key within the VM.
`mac_address`	`string`	yes	MAC address, lower-case colon-separated.
`model`	`string`		Device model (`virtio`, `e1000e`, `vmxnet3`-compatible profile, ...).
`network`	`string`	yes	Network or distributed portgroup.

VmAddress

One address of a VM, across pools.

Name	Type	Required	Description
`address`	`string`	yes	IPv4 address, or the server's IPv6 address (`<prefix>::1`).
`allocatedAt`	`string`	yes	Allocation time.
`mac`	`string` or `null`		NIC MAC.
`pool`	`string`	yes	The pool.
`poolName`	`string`	yes	The pool's name.
`prefix`	`string` or `null`		For IPv6: the block (`<prefix>/<len>`, e.g. `/64` or `/112`).
`prefixLen`	`integer` (int32) or `null`		For IPv6: the block length (64 to 128). A PTR may only be set for the server address `address`, which lies in this block.
`ptr`	`string` or `null`		Reverse DNS name.
`ptrReason`	`string` or `null`		Why the operator rejected the name.
`ptrStatus`	`PtrStatus` or `null`
`role`	`string`	yes	`primary`, `extra` or `ipv6`.

VmConfig

The configuration of a VM (what the user asked for).

Name	Type	Required	Description
`annotation`	`string`		Annotation / notes.
`cdroms`	array of `VirtualCdrom`		CD-ROM drives.
`change_tracking`	`boolean`		Changed-block tracking (`config.changeTrackingEnabled`); the disks' `cbt_enabled` follow it.
`change_version`	`integer` (int64)		Monotonic change counter the facade exposes as `config.changeVersion`.
`cores_per_socket`	`integer` (int32)		Cores per socket (0 = let the hypervisor decide).
`disks`	array of `VirtualDisk`		Disks.
`extra_config`	`object`		Free-form `extraConfig`-style options (`guestinfo.*`, ...).
`firmware`	`FirmwareKind`		Firmware.
`guest_id`	`string`		Guest OS identifier (vSphere-style `guestId`, e.g. `ubuntu64Guest`).
`memory_mib`	`integer` (int64)	yes	Memory.
`nics`	array of `VirtualNic`		NICs.
`num_cpus`	`integer` (int32)	yes	Virtual CPUs.
`secure_boot`	`boolean`		Secure Boot enabled (EFI only).
`template`	`boolean`		Whether this VM is a template.
`vtpm`	`boolean`		Virtual TPM present.

VmGuest

Guest information (from the guest agent).

Name	Type	Description
`agent_version`	`string`	Version of the guest agent while it runs.
`files_allowed`	`boolean`	The guest agent allows file operations (`guest-file-*`).
`hostname`	`string`	Guest hostname.
`ip_address`	`string`	Primary IP address.
`ip_addresses`	array of `string`	All IP addresses.
`nics`	array of `GuestNic`	Network interfaces the guest agent reports (without the loopback), each with its MAC address and addresses. The SOAP facade's `guest.net` is projected from them.
`operations_note`	`string`	Why guest operations are not allowed (the commands the agent has disabled and the remedy); empty when they are or while the agent does not run.
`os_family`	`string`	Detected guest OS family (`linux`, `windows`, ...).
`os_name`	`string`	Detected guest OS full name.
`processes_allowed`	`boolean`	The guest agent allows process operations (`guest-exec`): `StartProgramInGuest` and friends can work. The RHEL-family agent blocks them by default.
`tools_status`	`ToolsStatus`	Guest agent state.

VmRuntime

Runtime state of a VM (reported by the host agent).

Name	Type	Description
`boot_time`	`string` or `null`	Time of last power on.
`cpu_usage_mhz`	`integer` (int32)	Current CPU usage.
`host`	`string` or `null`	Host the VM currently runs on (or last ran on).
`lifecycle`	`LifecycleState` or `null`
`memory_usage_mib`	`integer` (int64)	Guest memory in use on the host.
`observed_generation`	`integer` (int64)	Desired-state reconciliation generation last acknowledged by the host.
`pid`	`integer` (int32) or `null`	Hypervisor process id on the host, when running.
`power_state`	`PowerState`	Power state.
`reconcile_error`	`string` or `null`	The last reconciliation error the host reported for this VM, cleared by the next successful report.

VmSnapshot

A point-in-time snapshot of a VM (VirtualMachineSnapshot).

The control plane keeps the tree and the configuration at snapshot time (a revert restores it, as in vSphere); the disk and memory state lives on the host under the runtime name, which the agent uses as its snapshot tag.

Name	Type	Required	Description
`config`	`VmConfig`	yes	The VM configuration when the snapshot was taken.
`created_at`	`string`	yes	Creation time.
`description`	`string`		Free text.
`key`	`integer` (int32)	yes	Number unique within the VM; the MoRef value is `<vm id>-snapshot-<key>`.
`memory`	`boolean`		Includes the memory state (a revert resumes the running guest).
`name`	`string`	yes	Display name (not unique; vSphere allows duplicates).
`parent`	`integer` (int32) or `null`		Parent snapshot key; `None` for a root.
`power_state`	`PowerState`	yes	Power state of the VM when the snapshot was taken.
`quiesced`	`boolean`		Guest file systems were quiesced through the guest channel.
`runtime_name`	`string`	yes	Snapshot tag on the host (`[A-Za-z0-9_.-]{1,64}`).

VmTraffic

Traffic of one VM in a period.

Name	Type	Required	Description
`billableBytes`	`integer` (int64)	yes	Billable bytes.
`inBytes`	`integer` (int64)	yes	Bytes received by the VM (inbound).
`name`	`string`	yes	VM name as last seen.
`outBytes`	`integer` (int64)	yes	Bytes sent by the VM (outbound).
`tenant`	`string`	yes	Tenant as last seen in the ledger.
`vm`	`string`	yes	VM id.

VmTrafficView

One VM's traffic in a period, with its limit state and daily series.

Name	Type	Required	Description
`billableBytes`	`integer` (int64)	yes	Billable bytes.
`days`	array of `TrafficDay`	yes	Bytes per day.
`inBytes`	`integer` (int64)	yes	Inbound bytes.
`limitBytes`	`integer` (int64) or `null`		The limit of the period (plan plus packages); absent: none.
`outBytes`	`integer` (int64)	yes	Outbound bytes.
`percent`	`number` (double) or `null`		Billable bytes as per cent of the limit.
`periodEnd`	`string`	yes	Last day of the period (inclusive).
`periodStart`	`string`	yes	First day of the period.
`policy`	`TrafficPolicy` or `null`
`throttled`	`boolean`	yes	The VM is throttled now.
`vm`	`string`	yes	VM id.

VmfsCreateOptionView

One VMFS create-option template (QueryVmfsDatastoreCreateOptions).

Name	Type	Required	Description
`blockSizeMb`	`integer` (int32)	yes	Suggested block size in MiB.
`canonicalName`	`string`	yes	Canonical name (`naa.…`).
`capacityBytes`	`integer` (int64)	yes	Capacity in bytes.
`devicePath`	`string`	yes	Host device path.
`diskUuid`	`string`	yes	Disk WWID (`VmfsDatastoreSpec.diskUuid`).
`majorVersion`	`integer` (int32)	yes	Suggested major version.

VmfsDiskView

One available disk for VMFS create (QueryAvailableDisksForVmfs).

Name	Type	Required	Description
`canonicalName`	`string`	yes	Canonical name (`naa.…`).
`capacityBytes`	`integer` (int64)	yes	Capacity in bytes.
`devicePath`	`string`	yes	Host device path.
`lun`	`integer` (int32)	yes	LUN number.
`portal`	`string`	yes	Portal used for login.
`target`	`string`	yes	Target IQN.
`wwid`	`string`	yes	Multipath / by-id WWID.

VnicFirewallView

The firewall of one vNIC.

Name	Type	Required	Description
`appliedVersion`	`integer` (int64) or `null`		Plan version the host holds as applied.
`defaultIn`	`DefaultActionView`	yes	Default for inbound traffic.
`defaultOut`	`DefaultActionView`	yes	Default for outbound traffic.
`host`	`string` or `null`		Host.
`mac`	`string`	yes	MAC.
`mode`	`ModeView`	yes	Mode.
`network`	`string`	yes	Network id.
`nicKey`	`string`	yes	NIC key (`4000`).
`pending`	`PendingModeView` or `null`
`profile`	`string`	yes	Profile id.
`profileExplicit`	`boolean`	yes	The profile was set on the vNIC (else it follows the NIC kind).
`protection`	`ProtectionView`	yes	Protection.
`public`	`boolean`	yes	Public (an IP pool address).
`rules`	array of `EffectiveRule`	yes	Rules in evaluation order, the two defaults last.
`vm`	`string`	yes	VM id.
`wantedVersion`	`integer` (int64) or `null`		Plan version last sent to the host.

VnicView

A vNIC: VM id and NIC key (4000, or nic4000).

Name	Type	Required	Description
`nic`	`string`	yes	NIC key.
`vm`	`string`	yes	VM id (`vm-7`).