Reference For: developers

API schemas: M

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

MaintenanceModeResultView

TaskView.result of enter/exit maintenance mode.

NameTypeRequiredDescription
maintenanceModebooleanyesWhether the host is in maintenance mode after the task.

MakeFolderRequest

Create-folder request.

NameTypeRequiredDescription
createParentsbooleanCreate missing parent folders too.
pathstringyesPath of the new folder below the datastore root.

MarkAsVmRequest

Convert a template back to a VM (POST /v1/vms/{id}/mark-as-vm).

NameTypeRequiredDescription
hoststring or nullHost (host-N). Defaults to the template's current host.
resourcePoolstring or nullResource pool (resgroup-N). Defaults to the template's current pool.

MetricsQueryRequest

A metrics query.

NameTypeRequiredDescription
countersarray of stringyesCounter names (cpu.usage.average) or ids ("2").
endstring or nullInclusive end (RFC 3339); default now.
entitiesarray of stringyesEntity ids (vm-42, host-1, datastore-3).
instancestring or null"" the aggregate (default), "*" every instance and the aggregate, or one instance.
intervalinteger (int32) or nullSampling period (20, 300, 1800, 7200, 86400); default 20 for hosts and VMs, 300 for datastores.
maxSamplesinteger (int32) or nullNewest N samples per series.
startstring or nullExclusive start (RFC 3339); default as far back as the interval keeps.

MetricsQueryResponse

Query answer.

NameTypeRequiredDescription
seriesarray of SeriesViewyesSeries with at least one point.

MfaCodeRequest

TOTP code.

NameTypeRequiredDescription
codestringyesSix-digit code.

MfaEnrolResponse

TOTP enrolment response.

NameTypeRequiredDescription
otpauthUrlstringyesotpauth:// URL for QR codes.
secretstringyesBase32 seed; shown once.

MigrateResultView

TaskView.result of migrate / RelocateVM.

NameTypeRequiredDescription
datastorestring or nullDestination datastore id after a cold storage relocate, when any.
hoststring or nullPlacement host id after the move, when any.
livebooleanyesWhether a live migration ran.
relocatedDisksarray of RelocatedDiskViewDisks copied onto the new datastore.
relocatedNicsarray of RelocatedNicViewNICs whose network backing was rebound.
reportobject or nullLive-migration agent report when present; otherwise null.

ModeBody

Body of POST /v1/vms/{id}/firewall/mode.

NameTypeRequiredDescription
confirmWithininteger (int64) or nullSeconds until the previous mode comes back unless confirmed (30 to 86,400; absent: no timer).
modeModeViewyesThe new mode.
nicsarray of stringNIC keys (default: every host-bridge NIC of the VM).
reasonstring or nullWhy (kept in the event).

ModeView

Firewall mode of a vNIC.

Values: "off", "monitor", "enforce"

MonitorEntryView

One port seen in the monitor tables.

NameTypeRequiredDescription
countinteger (int64)yesPackets that would have been dropped.
directionstringyesin or out.
firstSeenstringyesFirst seen.
lastSeenstringyesLast seen.
nicstringyesNIC id.
portinteger (int32)yesDestination port (0: none).
protointeger (int32)yesIP protocol number.
sourcesarray of stringyesUp to 16 sample sources.

MonitorReportView

The monitor report of a VM.

NameTypeRequiredDescription
entriesarray of MonitorEntryViewyesWould-drops, most packets first.
nicsobjectyesThe VM's host-bridge vNICs and their modes.
proposalProposalViewyesWhat to allow before switching to enforce.
sincestringyesStart of the window (monitorReportDays back).
vmstringyesVM id.
wouldDropinteger (int64)yesPackets that would have been dropped, all entries.

MonthWeekOffset

WeekOfMonth wire values for [ScheduledRecurrence::MonthlyByWeekday].

Values: "first", "second", "third", "fourth", "last"

MoveHostsRequest

Body of POST /v1/clusters/{id}/move-hosts.

NameTypeRequiredDescription
listarray of stringyesHost ids (host-N), each in maintenance mode and without virtual machines.

MoveIntoFolderRequest

Re-parent inventory entities under a folder (POST /v1/inventory/folders/{id}/move-into, SOAP Folder.MoveIntoFolder_Task).

NameTypeRequiredDescription
idempotencyKeystring or nullIdempotency key.
listarray of stringyesEntities to move (vm-N, group-vN, …). Must be non-empty.

MoveIntoResourcePoolRequest

Move VMs and/or child pools under a resource pool (POST /v1/resource-pools/{id}/move-into, SOAP MoveIntoResourcePool).

NameTypeRequiredDescription
idempotencyKeystring or nullIdempotency key.
listarray of stringyesEntities to move (vm-N, resgroup-N, …). Must be non-empty.

MoveRuleBody

Moves a rule inside its policy.

NameTypeRequiredDescription
positioninteger (int32)yesNew position (0 first; beyond the end: last).

Version 0.1.