API schemas: R

RangeView

An IPv4 range.

Name	Type	Required	Description
`end`	`string`	yes	Last address (inclusive).
`start`	`string`	yes	First address.

RdnsMode

How a pool's PTR names reach DNS.

Values: "provider", "manual"

ReconfigureClusterRequest

Body of POST /v1/clusters/{id}/reconfigure (HA/DRS/migration-policy thin slice).

Name	Type	Description
`allowPostcopy`	`boolean` or `null`	Flip `Cluster.migration.allow_postcopy` when set.
`downtimeLimitMs`	`integer` (int64) or `null`	Set `Cluster.migration.downtime_limit_ms`. Clear with `modify=false`.
`haEnabled`	`boolean` or `null`	Flip `Cluster.ha.enabled` when set.
`maxBandwidthMibS`	`integer` (int64) or `null`	Set `Cluster.migration.max_bandwidth_mib_s` (MiB/s). Clear with `modify=false`.
`modify`	`boolean`	Merge provided fields (default) or replace missing with false/cleared.
`schedulerAutomatic`	`boolean` or `null`	Flip `Cluster.scheduler.automatic` when set.
`schedulerEnabled`	`boolean` or `null`	Flip `Cluster.scheduler.enabled` when set.

ReconfigureResultView

TaskView.result of VirtualMachine.reconfigure.

Name	Type	Required	Description
`generation`	`integer` (int64)	yes	Desired-state generation after the change.
`grownDisks`	array of `GrownDiskView`		Disks the task grew, when any.

ReconfigureScheduledTaskRequest

Request to reconfigure a scheduled task (entity is fixed).

Name	Type	Required	Description
`action`	`ScheduledAction`	yes	Power action.
`activeTime`	`string` or `null`		Optional scheduler active time.
`description`	`string`		Description.
`enabled`	`boolean`		Enabled.
`expireTime`	`string` or `null`		Optional scheduler expire time.
`name`	`string`	yes	Display name.
`notification`	`string` or `null`		Optional notification address (SMTP send when `[smtp] enabled`).
`recurrence`	`ScheduledRecurrence`		Scheduler cadence.
`runAt`	`string` or `null`		One-shot run time / create-time anchor (RFC 3339). Defaults to now.

ReconfigureVmRequest

VM reconfigure request.

Name	Type	Required	Description
`config`	`VmConfig`	yes	Body in the `VmConfig` schema (the full desired configuration).
`createDisks`	array of `DiskFileRequest`		Disk files to create for disks `config` adds (empty images or from an image).
`deleteDisks`	array of `DiskFileRequest`		Disk files to delete after they leave `config.disks` (detach and destroy). Omit a removed disk here to detach and keep the file on the datastore.
`growDisks`	array of `DiskFileRequest`		Disks of `config` whose capacity grows: the file is grown to `sizeBytes`. On a running VM the host grows it online where the runtime can; otherwise the change applies at the next start (the task result says which).
`idempotencyKey`	`string` or `null`		Idempotency key.
`name`	`string` or `null`		New display name (unique within the folder).

RecordMetaView

Store metadata of a record.

Name	Type	Required	Description
`createdAt`	`string`	yes	Creation time (RFC 3339).
`createdVersion`	`integer` (int64)	yes	Version at creation.
`id`	`string`	yes	MoRef-compatible id, e.g. `vm-42`.
`name`	`string` or `null`		Display name.
`parentId`	`string` or `null`		Parent id in the inventory tree.
`updatedAt`	`string`	yes	Last update time (RFC 3339).
`uuid`	`string`	yes	Globally unique id.
`version`	`integer` (int64)	yes	Version of the last change (compare-and-set token).

RecoveryCodesResponse

Recovery codes (shown once).

Name	Type	Required	Description
`recoveryCodes`	array of `string`	yes	Ten single-use codes `xxxx-xxxx-xxxx-xxxx`.

RegisterVmRequest

Reads [ds] name/.kyvernon-vm.json written by unregister (or an equivalent path such as [ds] name/name.vmx) and restores inventory without recreating disks.

Name	Type	Required	Description
`asTemplate`	`boolean`		Register as a template.
`folderId`	`string`	yes	Destination VM folder (`group-vN`).
`host`	`string` or `null`		Host (`host-N`). Optional placement hint.
`idempotencyKey`	`string` or `null`		Idempotency key.
`name`	`string` or `null`		Display name; defaults to the name in the on-disk manifest.
`path`	`string`	yes	Datastore path (`[ds] name/name.vmx` or `[ds] name/.kyvernon-vm.json`).
`resourcePool`	`string` or `null`		Resource pool (`resgroup-N`). Required unless `asTemplate` is true.

ReinstallServerRequest

Request to reinstall a server (its addresses stay).

Name	Type	Description
`image`	`string` or `null`	Image (default: the current one).
`password`	`boolean`	Generate a password (always when no SSH keys are given).
`sshKeys`	array of `string`	SSH public keys.
`userData`	`string` or `null`	cloud-init user data.

ReleasedAddress

An address returned to its pool.

Name	Type	Required	Description
`address`	`string`	yes	The address or /64 prefix.
`pool`	`string`	yes	The pool.

RelocateDiskLocator

One cold per-disk storage relocate locator (RelocateVM_Task.spec.disk).

Name	Type	Required	Description
`datastore`	`string`	yes	Destination datastore (`datastore-N`).
`diskKey`	`integer` (int32)	yes	Virtual disk device key (`VirtualDevice.key`, typically 2000+).

RelocateNicChange

One RelocateVM Ethernet Edit (RelocateVM_Task.spec.deviceChange NIC backing).

Name	Type	Required	Description
`network`	`string`	yes	Destination network or distributed port group (`network-N` / `dvportgroup-N`).
`nicKey`	`integer` (int32)	yes	Virtual NIC device key (`VirtualDevice.key`, typically 4000+).

RelocateVmRequest

Relocate a VM (POST /v1/vms/{id}/relocate, SOAP RelocateVM_Task).

Cold storage relocate (datastore and/or per-disk disks locators) copies disks of a powered-off VM without snapshots onto datastores mounted on the current host. nics rebinds Ethernet network backing (SOAP spec.deviceChange Edit). Host / pool / folder placement fields share the same task engine as SOAP. Live Storage vMotion stays refused.

Name	Type	Description
`datastore`	`string` or `null`	Destination datastore (`datastore-N`) for every disk not listed in `disks`.
`disks`	array of `RelocateDiskLocator`	Per-disk locators (`diskKey` + datastore). Overrides `datastore` for those keys.
`folderId`	`string` or `null`	Destination VM folder (`group-vN`).
`host`	`string` or `null`	Destination host (`host-N`). Optional; pool placement may choose one.
`idempotencyKey`	`string` or `null`	Idempotency key.
`nics`	array of `RelocateNicChange`	Ethernet network rebinds (`nicKey` + network). SOAP `deviceChange` Edit.
`resourcePool`	`string` or `null`	Destination resource pool (`resgroup-N`).

RelocatedDiskView

One disk relocated by cold storage relocate.

Name	Type	Required	Description
`datastore`	`string`	yes	Destination datastore id.
`path`	`string`	yes	Path below the datastore root.

RelocatedNicView

One NIC rebinding from RelocateVM deviceChange / native nics.

Name	Type	Required	Description
`network`	`string`	yes	Destination network id.
`nicKey`	`integer` (int32)	yes	Virtual NIC device key.

RemovedSnapshotsResultView

TaskView.result of remove-snapshot / remove-all-snapshots.

Name	Type	Required	Description
`removed`	array of `integer` (int32)	yes	Snapshot keys that were removed.

RenameRequest

Body of POST /v1/inventory/objects/{id}/rename.

Name	Type	Required	Description
`name`	`string`	yes	The new name, 1 to 80 characters.

RenameResultView

TaskView.result of rename.

Name	Type	Required	Description
`name`	`string`	yes	New name.

RenameSnapshotRequest

Rename a snapshot (POST /v1/vms/{id}/snapshots/{key}/rename, SOAP VirtualMachineSnapshot.RenameSnapshot). At least one of name or description is required.

Name	Type	Required	Description
`description`	`string` or `null`		New free-text description (empty string clears it).
`name`	`string` or `null`		New display name (1..=80 characters, no surrounding spaces).

RescueServerRequest

Request to boot the rescue image.

Name	Type	Required	Description
`image`	`string` or `null`		Rescue image (default: the first catalogue entry marked `rescue`).

ResizeServerRequest

Request to resize a server.

Name	Type	Required	Description
`plan`	`string`	yes	The larger plan.

ResolveMigrationRequest

Body for POST /v1/vms/{id}/resolve-migration.

Name	Type	Required	Description
`host`	`string` or `null`		Destination host (`host-N`). Required when `resolution` is `destination-keeps` so inventory placement moves off the source.
`resolution`	`FenceResolutionView`	yes	Who keeps the guest (`source-keeps` or `destination-keeps`).

ResolveMigrationView

Result of resolving a fenced migration.

Name	Type	Required	Description
`host`	`string`	yes	Host that now owns the inventory placement.
`resolution`	`FenceResolutionView`	yes	Resolution applied.

ResourceAllocation

Reservation/limit/shares for one resource.

Name	Type	Description
`expandable_reservation`	`boolean`	Whether the reservation may grow when the parent has headroom.
`limit`	`integer` (int64) or `null`	Maximum amount, `None` for unlimited.
`reservation`	`integer` (int64)	Guaranteed amount (MHz or MiB).
`shares`	`integer` (int32)	Custom shares (when level is `Custom`).
`shares_level`	`SharesLevel`	Shares level.

ResourcePool

A resource pool.

Name	Type	Required	Description
`cpu`	`ResourceAllocation`		CPU allocation in MHz.
`memory`	`ResourceAllocation`		Memory allocation in MiB.
`name`	`string`	yes	Display name (`Resources` for a root pool).

RestorePointRequest

Body of POST /v1/backup/points/{id}/restore.

Name	Type	Description
`datastoreId`	`string` or `null`	Datastore for the new disks (default: the verification pool, else the first usable).
`folderId`	`string` or `null`	Folder of the new virtual machine (default: the folder of the source).
`hostId`	`string` or `null`	Host of the new virtual machine (default: the host of the source).
`mode`	`string` or `null`	`new` (default; also `new_vm`): a new virtual machine with the backed-up disks and the configuration of the source. `in-place` (also `in_place`): the disks of the source, which must be powered off, are replaced by those of the point (task `VirtualMachine.restoreBackupInPlace`); `name`, `folderId`, `datastoreId`, `hostId` and `powerOn` do not apply.
`name`	`string` or `null`	Name of the new virtual machine (default: `<source> (restored)`).
`powerOn`	`boolean`	Power the virtual machine on when the restore is done (default false).
`verify`	`VerifySpec` or `null`

RestoreSession

A restore session as the verification sees it.

Name	Type	Required	Description
`backupSessionId`	`string` (uuid) or `null`		The backup session restored, for nightly runs.
`destroyed`	`boolean`	yes	The VM was destroyed after the verdict.
`evidence`	`Evidence` or `null`
`finishedAt`	`integer` (int64) or `null`		End, Unix seconds.
`reason`	`string` or `null`		Message key of the failure.
`sourceVmId`	`string` (uuid) or `null`		The VM the backup was taken from, for nightly runs.
`startedAt`	`integer` (int64)	yes	Start, Unix seconds.
`state`	`VerifyState`	yes	State.
`verified`	`boolean` or `null`		The verdict; `None` while running.
`vmId`	`string` (uuid)	yes	The restored VM's instance uuid.

RevertSnapshotRequest

Revert to a snapshot (POST /v1/vms/{id}/snapshots/{key}/revert).

Name	Type	Required	Description
`idempotencyKey`	`string` or `null`		Idempotency key.
`suppressPowerOn`	`boolean`		Do not power the guest on after a memory snapshot revert.

RoleRequest

Role create/update body.

Name	Type	Required	Description
`description`	`string`		Description.
`name`	`string`	yes	Name.
`privileges`	array of `string`	yes	Privileges from the catalogue.

RoleView

A role.

Name	Type	Required	Description
`description`	`string`	yes	Description.
`id`	`string`	yes	Role id.
`name`	`string`	yes	Name.
`privileges`	array of `string`	yes	Privileges.
`system`	`boolean`	yes	Built-in.

RuleBody

A rule as written by a client.

Name	Type	Required	Description
`action`	`ActionView`	yes	Action.
`appliedTo`	array of `string`		Groups the rule applies to (empty: the policy's).
`destinations`	array of `string`		Destinations (empty: any).
`destinationsNegated`	`boolean`		Match everything except the destinations.
`direction`	`DirectionView`		Direction (default `in-out`).
`enabled`	`boolean`		Enabled (default true).
`id`	`string` or `null`		Id of an existing rule (policy `PUT`: keeps its number and counters); ignored when a rule is added.
`ipVersion`	`IpVersionView`		IP families (default `any`).
`logged`	`boolean`		Log matches.
`name`	`string`		Display name.
`services`	array of `ServiceEntryView`		Services (empty: any IP traffic).
`sources`	array of `string`		Sources: group ids, addresses or prefixes (empty: any).
`sourcesNegated`	`boolean`		Match everything except the sources.

RuleStatsView

Counters of one rule.

Name	Type	Required	Description
`bytes`	`integer` (int64)	yes	Bytes, all hosts.
`hosts`	`object`	yes	Per host.
`lastHit`	`string` or `null`		Last report with a non-zero count.
`number`	`integer` (int32)	yes	Rule number.
`packets`	`integer` (int64)	yes	Packets, all hosts.
`policy`	`string` or `null`		Policy id (when the rule still exists).
`supported`	`boolean`	yes	Hit counters are kept for this rule (host bridges, and segment ports when the controller reads the Southbound database; `false` otherwise, §6.3).

RuleView

A rule.

Type: RuleBody, object