MaintenanceModeResultView
TaskView.result of enter/exit maintenance mode.
| Name | Type | Required | Description |
|---|---|---|---|
maintenanceMode | boolean | yes | Whether the host is in maintenance mode after the task. |
Schemas of the native REST API whose name starts with M.
TaskView.result of enter/exit maintenance mode.
| Name | Type | Required | Description |
|---|---|---|---|
maintenanceMode | boolean | yes | Whether the host is in maintenance mode after the task. |
Create-folder request.
| Name | Type | Required | Description |
|---|---|---|---|
createParents | boolean | Create missing parent folders too. | |
path | string | yes | Path of the new folder below the datastore root. |
Convert a template back to a VM (POST /v1/vms/{id}/mark-as-vm).
| Name | Type | Required | Description |
|---|---|---|---|
host | string or null | Host (host-N). Defaults to the template's current host. | |
resourcePool | string or null | Resource pool (resgroup-N). Defaults to the template's current pool. |
A metrics query.
| Name | Type | Required | Description |
|---|---|---|---|
counters | array of string | yes | Counter names (cpu.usage.average) or ids ("2"). |
end | string or null | Inclusive end (RFC 3339); default now. | |
entities | array of string | yes | Entity ids (vm-42, host-1, datastore-3). |
instance | string or null | "" the aggregate (default), "*" every instance and the aggregate, or one instance. | |
interval | integer (int32) or null | Sampling period (20, 300, 1800, 7200, 86400); default 20 for hosts and VMs, 300 for datastores. | |
maxSamples | integer (int32) or null | Newest N samples per series. | |
start | string or null | Exclusive start (RFC 3339); default as far back as the interval keeps. |
Query answer.
| Name | Type | Required | Description |
|---|---|---|---|
series | array of SeriesView | yes | Series with at least one point. |
TOTP code.
| Name | Type | Required | Description |
|---|---|---|---|
code | string | yes | Six-digit code. |
TOTP enrolment response.
| Name | Type | Required | Description |
|---|---|---|---|
otpauthUrl | string | yes | otpauth:// URL for QR codes. |
secret | string | yes | Base32 seed; shown once. |
TaskView.result of migrate / RelocateVM.
| Name | Type | Required | Description |
|---|---|---|---|
datastore | string or null | Destination datastore id after a cold storage relocate, when any. | |
host | string or null | Placement host id after the move, when any. | |
live | boolean | yes | Whether a live migration ran. |
relocatedDisks | array of RelocatedDiskView | Disks copied onto the new datastore. | |
relocatedNics | array of RelocatedNicView | NICs whose network backing was rebound. | |
report | object or null | Live-migration agent report when present; otherwise null. |
Body of POST /v1/vms/{id}/firewall/mode.
| Name | Type | Required | Description |
|---|---|---|---|
confirmWithin | integer (int64) or null | Seconds until the previous mode comes back unless confirmed (30 to 86,400; absent: no timer). | |
mode | ModeView | yes | The new mode. |
nics | array of string | NIC keys (default: every host-bridge NIC of the VM). | |
reason | string or null | Why (kept in the event). |
Firewall mode of a vNIC.
Values: "off", "monitor", "enforce"
One port seen in the monitor tables.
| Name | Type | Required | Description |
|---|---|---|---|
count | integer (int64) | yes | Packets that would have been dropped. |
direction | string | yes | in or out. |
firstSeen | string | yes | First seen. |
lastSeen | string | yes | Last seen. |
nic | string | yes | NIC id. |
port | integer (int32) | yes | Destination port (0: none). |
proto | integer (int32) | yes | IP protocol number. |
sources | array of string | yes | Up to 16 sample sources. |
The monitor report of a VM.
| Name | Type | Required | Description |
|---|---|---|---|
entries | array of MonitorEntryView | yes | Would-drops, most packets first. |
nics | object | yes | The VM's host-bridge vNICs and their modes. |
proposal | ProposalView | yes | What to allow before switching to enforce. |
since | string | yes | Start of the window (monitorReportDays back). |
vm | string | yes | VM id. |
wouldDrop | integer (int64) | yes | Packets that would have been dropped, all entries. |
WeekOfMonth wire values for [ScheduledRecurrence::MonthlyByWeekday].
Values: "first", "second", "third", "fourth", "last"
Body of POST /v1/clusters/{id}/move-hosts.
| Name | Type | Required | Description |
|---|---|---|---|
list | array of string | yes | Host ids (host-N), each in maintenance mode and without virtual machines. |
Re-parent inventory entities under a folder (POST /v1/inventory/folders/{id}/move-into, SOAP Folder.MoveIntoFolder_Task).
| Name | Type | Required | Description |
|---|---|---|---|
idempotencyKey | string or null | Idempotency key. | |
list | array of string | yes | Entities to move (vm-N, group-vN, …). Must be non-empty. |
Move VMs and/or child pools under a resource pool (POST /v1/resource-pools/{id}/move-into, SOAP MoveIntoResourcePool).
| Name | Type | Required | Description |
|---|---|---|---|
idempotencyKey | string or null | Idempotency key. | |
list | array of string | yes | Entities to move (vm-N, resgroup-N, …). Must be non-empty. |
Moves a rule inside its policy.
| Name | Type | Required | Description |
|---|---|---|---|
position | integer (int32) | yes | New position (0 first; beyond the end: last). |
Version 0.1.