API schemas: C

Cardinality

Tag cardinality within a category.

Values: "single", "multiple"

CatalogueImageView

Catalogue metadata of an image (a template VM).

Name	Type	Description
`catalogue`	`boolean`	Offered to tenants.
`cloudInit`	`boolean`	Personalised through cloud-init.
`defaultUser`	`string`	Default user.
`displayName`	`string`	Name shown to tenants.
`minDiskGib`	`integer` (int64)	Smallest disk (GiB).
`noCredentials`	`boolean`	Takes no credentials (no password or SSH keys; e.g. EuroOS).
`osFamily`	`string`	`linux`, `windows`, `euroos`, `bsd` or `other`.
`osVersion`	`string`	OS version.
`rescue`	`boolean`	A rescue image.
`templateId`	`string`	The template (`vm-N`; ignored in requests, the path names it).
`templateName`	`string`	The template's name.

CategoryView

Category.

Values: "emergency", "infrastructure", "environment", "application"

CdpHintView

CDP neighbour fields (PhysicalNicCdpInfo).

Name	Type	Description
`deviceId`	`string` or `null`	Device ID (`devId`).
`mgmtAddr`	`string` or `null`	Management address.
`platform`	`string` or `null`	Platform / hardware.
`portId`	`string` or `null`	Port ID.
`softwareVersion`	`string` or `null`	Software version.
`systemName`	`string` or `null`	System name when distinct from device id.
`ttl`	`integer` (int32) or `null`	TTL.

ChangePasswordRequest

Change-password request.

Name	Type	Required	Description
`currentPassword`	`string` or `null`		Current password (required for self-service).
`newPassword`	`string`	yes	New password.

ChangeSetView

Changes of one committed transaction.

Name	Type	Required	Description
`actor`	`string` or `null`		Actor.
`at`	`string`	yes	Time.
`changes`	array of `ChangeView`	yes	Changes.
`version`	`integer` (int64)	yes	Version produced by the transaction.

ChangeView

One change in the feed.

Name	Type	Required	Description
`kind`	`string`	yes	`created`, `updated` or `deleted`.
`object`	`ObjectView`	yes	The object after the change (before, for `deleted`).

ChangedAreaView

OpenAPI stand-in for one changed or allocated byte range.

Name	Type	Required	Description
`length`	`integer` (int64)	yes	Length in bytes (never zero).
`start`	`integer` (int64)	yes	Byte offset.

ChangesResponse

Long-poll response of the change feed.

Name	Type	Required	Description
`changeSets`	array of `ChangeSetView`	yes	Change sets since the requested version (may be empty on timeout).
`resync`	`boolean`	yes	True when the requested version is too old or the replica jumped: the client must re-read and resume from `version`.
`version`	`integer` (int64)	yes	Version to resume from.

CheckResponse

Privilege check result.

Name	Type	Required	Description
`granted`	`boolean`	yes	Granted.

ClearTriggeredAlarmsRequest

Clear triggered (non-green) alarm states (ClearTriggeredAlarms).

Name	Type	Required	Description
`statuses`	array of `AlarmStatusView`		Only clear these statuses; empty clears every non-green state.

CloneVmRequest

Clone a virtual machine (POST /v1/vms/{id}/clone).

Builds disk copies next to the source (or on datastore) and submits the same task the SOAP CloneVM_Task path uses.

Name	Type	Required	Description
`copyFirewall`	`boolean`		Copy the source's firewall: vNIC mode and profile, static group memberships, the rules of its own policy (same tenant only; `Kyvernon.Firewall.ManagePolicies` on the source). Without it the clone's vNICs start like new ones.
`copyTags`	`boolean`		Attach the source's tags to the clone (same tenant only; `InventoryService.Tagging.AttachTag` on the source).
`datastore`	`string` or `null`		Target datastore for every disk. Defaults to each disk's current datastore. Linked clones require the same datastore as the source disks.
`folderId`	`string` or `null`		Destination VM folder (`group-vN`). Defaults to the source's folder.
`host`	`string` or `null`		Host (`host-N`). Defaults to the source's host.
`idempotencyKey`	`string` or `null`		Idempotency key.
`linked`	`boolean`		Linked clone (qcow2 child of a snapshot). Requires `snapshot`.
`name`	`string`	yes	Name of the clone.
`powerOn`	`boolean`		Power the clone on after creation.
`resourcePool`	`string` or `null`		Resource pool (`resgroup-N`). Defaults to the source's pool.
`snapshot`	`integer` (int32) or `null`		Snapshot key to clone from (required when `linked` is true).
`template`	`boolean`		Mark the clone as a template.

CloseTenantRequest

Request to close a tenant.

Name	Type	Required	Description
`graceSeconds`	`integer` (int64) or `null`		Seconds until VMs and disks are destroyed (default: the controller's `[tenancy] close_grace`, 7 days).

Cluster

A cluster of hosts.

Name	Type	Required	Description
`ha`	`ClusterHaConfig`		HA settings.
`migration`	`ClusterMigrationConfig`		Live-migration policy (bandwidth, downtime, postcopy opt-in).
`name`	`string`	yes	Display name.
`scheduler`	`ClusterSchedulerConfig`		Scheduler settings.

ClusterHaConfig

High-availability settings of a cluster (subset; the scheduler team extends).

Name	Type	Required	Description
`enabled`	`boolean`		Whether HA restarts VMs of failed hosts.
`host_failures_to_tolerate`	`integer` (int32)		Number of host failures to tolerate in admission control.

ClusterMigrationConfig

Live-migration policy for VMs in this cluster (L-109 / TP-3 / L-91).

Passed by the control plane as MigrationOptions.policy on migrate-out. Unset members fall back to each host's [migration] defaults; nothing set means uncapped bandwidth and the host downtime default.

Name	Type	Description
`allow_postcopy`	`boolean`	Allow postcopy when a migrate request asks for it (opt-in, L-91).
`downtime_limit_ms`	`integer` (int64) or `null`	Acceptable downtime in ms; `None` takes the host default (typically 300).
`max_bandwidth_mib_s`	`integer` (int64) or `null`	Bandwidth cap in MiB/s; `None` = uncapped (after host default).

ClusterSchedulerConfig

Scheduling (DRS-like) settings of a cluster.

Name	Type	Required	Description
`automatic`	`boolean`		Whether migrations are applied automatically or only recommended.
`enabled`	`boolean`		Whether the scheduler balances load automatically.

Comparison

Comparison for metric triggers.

Values: "above", "below"

CompleteMfaRequest

MFA completion request.

Name	Type	Required	Description
`code`	`string`	yes	Six-digit code.
`pendingToken`	`string`	yes	Pending token from the login response.

ComputeResource

A compute resource wrapping a standalone host (vSphere ComputeResource).

Name	Type	Required	Description
`name`	`string`	yes	Display name (same as the host).

ConsistencyView

OpenAPI stand-in for Consistency.

Values: "CRASH_CONSISTENT", "FILESYSTEM_CONSISTENT"

ConsoleTicketView

A single-use console ticket (POST /v1/vms/{id}/console/ticket).

Name	Type	Required	Description
`expiresAt`	`string`	yes	When the ticket stops working (RFC 3339); 30 seconds after issue.
`expiresIn`	`integer` (int64)	yes	Seconds of validity.
`ticket`	`string`	yes	The ticket (base64url). Single use, bound to the VM and to this session.
`vmId`	`string`	yes	The VM it opens.
`websocketPath`	`string`	yes	Same-origin WebSocket path to open (`/v1/console/{ticket}`); binary frames carry RFB (VNC) bytes, so noVNC connects to it directly.

ControllerArchiveView

One archive of the controller state.

Name	Type	Required	Description
`name`	`string`	yes	File name in the target folder.
`sizeBytes`	`integer` (int64)	yes	Size in bytes.

ControllerBackupRequest

Body of PUT /v1/backup/controller.

Name	Type	Required	Description
`enabled`	`boolean`	yes	Take archives on the schedule.
`retention`	`integer`	yes	Archives kept (1 to 365).
`schedule`	`string`		`HH:MM` UTC or an interval such as `6h`; needed when `enabled`.
`target`	`string`	yes	Folder on the controller the archives go to (absolute).

ControllerBackupStatusView

State of the backup of the controller's own state (not implemented yet).

Name	Type	Required	Description
`archives`	array of `ControllerArchiveView`	yes	The archives in the target folder, newest first.
`enabled`	`boolean`	yes	Backups of the controller state are taken.
`lastError`	`string` or `null`		Error of the last run.
`lastResult`	`string` or `null`		`success` or `failure`.
`lastRunAt`	`string` or `null`		Last run.
`lastSizeBytes`	`integer` (int64) or `null`		Size of the last archive.
`nextRunAt`	`string` or `null`		Next run.
`retention`	`integer`	yes	Archives kept.
`running`	`boolean`	yes	A run is going on.
`schedule`	`string`	yes	When they are taken.
`stateDirectory`	`string`	yes	The state directory that is copied.
`target`	`string`	yes	Folder on the controller the archives go to.

CopyMoveFileRequest

Copy or move a datastore file (CopyDatastoreFile_Task / MoveDatastoreFile_Task).

Name	Type	Required	Description
`destinationDatastoreId`	`string` or `null`		Destination datastore (`datastore-N`). Defaults to the path datastore.
`destinationPath`	`string`	yes	Destination path below the destination datastore root.
`overwrite`	`boolean`		Replace an existing destination file.
`sourcePath`	`string`	yes	Source path below the path datastore root.

CounterView

A counter of the catalogue.

Name	Type	Required	Description
`entityTypes`	array of `string`	yes	Entity types (`host`, `vm`, `datastore`).
`group`	`string`	yes	Group key (`cpu`, `mem`, `disk`, `net`, `datastore`, `virtualDisk`, `sys`, `rescpu`).
`groupLabel`	`string`	yes	Group label.
`id`	`integer` (int32)	yes	Stable id (vCenter's where one exists; 900000 and up otherwise).
`instances`	`string`	yes	Instance kind (`none`, `device`, `object`).
`instancesOnly`	`boolean`	yes	True when the counter has no aggregate instance.
`label`	`string`	yes	Label.
`level`	`integer` (int32)	yes	Collection level of the aggregate.
`metric`	`string`	yes	The metric the counter reads.
`name`	`string`	yes	`group.name.rollup`.
`nameKey`	`string`	yes	Name key.
`perDeviceLevel`	`integer` (int32)	yes	Collection level of device instances.
`rollup`	`string`	yes	Rollup type (`average`, `minimum`, `maximum`, `latest`, `summation`, `none`).
`statsType`	`string`	yes	Statistics type (`absolute`, `delta`, `rate`).
`summary`	`string`	yes	What is measured.
`unit`	`string`	yes	Unit key (`percent`, `kiloBytesPerSecond`, ...).
`unitLabel`	`string`	yes	Unit label (`%`, `KBps`, ...).

CreateAlarmRequest

Request to define an alarm.

Name	Type	Required	Description
`actions`	array of `AlarmAction`		Actions.
`description`	`string`		Description.
`enabled`	`boolean`		Enabled (default true).
`name`	`string`	yes	Name.
`scopeId`	`string`	yes	Scope entity id.
`trigger`	`AlarmTrigger`	yes	Trigger.

CreateApiTokenRequest

Request to create an API token.

Name	Type	Required	Description
`name`	`string`	yes	Label (1..=64 characters).
`ttlSeconds`	`integer` (int64) or `null`		Lifetime in seconds, 1 up to the controller maximum (`[identity.policy] api_token_max_ttl`, 365 days unless configured otherwise). Absent: the maximum. Every token expires; a longer lifetime is refused (`error.api_token.ttl`).

CreateApiTokenResponse

A created API token. The token is shown once.

Name	Type	Required	Description
`apiToken`	`ApiTokenView`	yes	Its public description.
`token`	`string`	yes	`kyvt_<id>_<secret>`; give it as the password of programmatic logins.

CreateCustomizationSpecRequest

Create or overwrite a customization specification.

Name	Type	Required	Description
`description`	`string` or `null`		Optional description.
`dnsServers`	array of `string` or `null`		DNS servers.
`dnsSuffixes`	array of `string` or `null`		DNS search suffixes.
`domain`	`string` or `null`		DNS domain.
`domainAdmin`	`string` or `null`		Domain-join account name.
`domainAdminPassword`	`string` or `null`		Domain-join account password (stored; never returned on GET).
`domainOu`	`string` or `null`		Optional target OU DN.
`fullName`	`string` or `null`		Windows registered owner.
`hostname`	`string` or `null`		Fixed host name.
`joinDomain`	`string` or `null`		AD domain to join.
`joinWorkgroup`	`string` or `null`		Workgroup when not joining a domain.
`metadata`	`string` or `null`		Raw cloud-init metadata (overrides hostname synthesis when set).
`name`	`string`	yes	Spec name (1..=80; ignored on PUT path overwrite in favour of the path).
`nics`	array of `CustomizationNicSetting` or `null`		NIC mappings (static IP / DHCP).
`orgName`	`string` or `null`		Windows organisation.
`password`	`string` or `null`		Plaintext guest password (stored; never returned on GET).
`sshUser`	`string` or `null`		Optional SSH username that also receives the password.
`timezone`	`string` or `null`		Timezone.
`type`	`string` or `null`		Guest OS family (`Linux` or `Windows`); defaults to Linux.
`unattend`	`string` or `null`		Raw unattend.xml for Windows (stored; never returned on GET).
`userdata`	`string` or `null`		Raw cloud-init user-data (overrides synthesized user-data when set).

CreateDatacenterRequest

Body of POST /v1/datacenters.

Name	Type	Required	Description
`folderId`	`string` or `null`		Datacenter folder to create it in (`group-dN`); default: the root folder.
`name`	`string`	yes	Name, 1 to 80 characters, unique among the datacenters of the folder.

CreateDistributedPortgroupRequest

Body of POST /v1/distributed-portgroups.

Name	Type	Required	Description
`datacenterId`	`string` or `null`		The datacenter of the switch (optional; checked when given).
`idempotencyKey`	`string` or `null`		Idempotency key.
`ipv4`	`HostBridgeIpv4Request` or `null`
`ipv6`	`PortgroupIpv6Request` or `null`
`name`	`string`	yes	Name (1 to 80 characters).
`staticAddresses`	`object` or `null`		Fixed IPv4 addresses by MAC.
`switchId`	`string`	yes	The switch.
`vlanId`	`integer` (int32) or `null`		VLAN id, 0 for untagged; ignored when `vni` is set.
`vni`	`integer` (int32) or `null`		Overlay segment (Geneve VNI) instead of a VLAN.

CreateDistributedSwitchRequest

Body of POST /v1/distributed-switches.

Name	Type	Required	Description
`datacenterId`	`string`	yes	The datacenter; the switch goes into its network folder.
`hostUplinks`	array of `HostUplinksRequest` or `null`		The physical NICs of member hosts behind the uplinks.
`hosts`	array of `string` or `null`		Member hosts (default none).
`idempotencyKey`	`string` or `null`		Idempotency key.
`mtu`	`integer` (int32) or `null`		MTU (576 to 9216; default 1500).
`name`	`string`	yes	Name (1 to 80 characters).
`uplinkNames`	array of `string` or `null`		Uplink names (default `uplink1` to `uplink<uplinks>`).
`uplinks`	`integer` (int32) or `null`		Number of uplinks (default 1).

CreateGroupRequest

Body of POST /v1/identity/groups.

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

CreateHostDatastoreRequest

Body for POST /v1/hosts/{id}/datastores (CreateLocalDatastore / CreateNasDatastore / CreateVmfsDatastore).

Name	Type	Required	Description
`accessMode`	`string` or `null`		`readWrite` or `readOnly` (default `readWrite`).
`disk`	`string` or `null`		Disk key for VMFS create: WWID, `naa.…`, or device path.
`name`	`string`	yes	Datastore display name (`CreateLocalDatastore.name` / `HostNasVolumeSpec.localPath` / `HostVmfsSpec.volumeName`).
`nfsType`	`string` or `null`		`NFS` or `NFS41` (default `NFS`).
`path`	`string` or `null`		Absolute host path for a local datastore.
`remoteHost`	`string` or `null`		NFS server (`CreateNasDatastore`).
`remotePath`	`string` or `null`		NFS export path.
`securityType`	`string` or `null`		NFS security flavour (default `sys`).
`type`	`string`	yes	`local`, `nfs`, or `vmfs` (SOAP CreateLocal / CreateNas / CreateVmfs).

CreateLibraryItemRequest

Register a library item that references an existing datastore file, or an empty item that will receive content through an update session.

Name	Type	Required	Description
`clientToken`	`string` or `null`		Optional client token for idempotent create.
`datastoreId`	`string` or `null`		Override the library's datastore backing.
`description`	`string` or `null`		Optional description.
`filePath`	`string` or `null`		Datastore-relative path; omit or empty when uploading via update session.
`libraryId`	`string`	yes	Owning library id.
`name`	`string`	yes	Display name.
`size`	`integer` (int64) or `null`		Optional size hint in bytes.
`type`	`string`	yes	`iso`, `ovf`, or `vm-template`.

CreateLibraryRequest

Create a local content library.

Name	Type	Required	Description
`clientToken`	`string` or `null`		Optional client token for idempotent create.
`datastoreId`	`string`	yes	Datastore that backs item files.
`description`	`string` or `null`		Optional description.
`name`	`string`	yes	Display name (1..=80).

CreateNetworkRequest

Create a host-bridge network / standard port group (POST /v1/networks).

Lands under the datacenter's network folder. Empty hosts means every host currently under the datacenter; operators can narrow the list later.

Name	Type	Required	Description
`backing`	`HostBridgeBackingRequest`	yes	How NICs reach the hosts (host-bridge only in this slice).
`datacenterId`	`string`	yes	Datacenter that owns the network (`datacenter-N`).
`hosts`	array of `string` or `null`		Hosts offering this network (`host-N`). Empty or omitted: all hosts under the datacenter.
`idempotencyKey`	`string` or `null`		Idempotency key.
`name`	`string`	yes	Display name (1..=80 characters).
`vlanId`	`integer` (int32) or `null`		VLAN id, 0 for untagged (default 0).

CreateObjectRequest

Inventory create request.

Name	Type	Required	Description
`data`	`ObjectBody`	yes	Body in the kind's schema.
`idempotencyKey`	`string` or `null`		Idempotency key; a repeat returns the same object.
`parentId`	`string` or `null`		Parent id (required for inventory entities).

CreateOvfDescriptorRequest

Build an OVF envelope from export file metadata (OvfManager.CreateDescriptor).

Name	Type	Required	Description
`description`	`string` or `null`		Annotation / description override.
`includeImageFiles`	`boolean` or `null`		Package attached ISO images as References (govc `export.ovf -i`).
`name`	`string` or `null`		Override entity name; defaults to the VM display name.
`ovfFiles`	array of `OvfCreateDescriptorFileRequest`	yes	Disk and optional ISO package members (govc `export.ovf` file list).
`vmId`	`string`	yes	Source VM whose hardware is reflected in the descriptor.

CreateOvfImportSpecRequest

Build an import plan from an OVF descriptor (OvfManager.CreateImportSpec).

Name	Type	Required	Description
`datastoreId`	`string`	yes	Target datastore (`datastore-N`).
`deploymentOption`	`string` or `null`		Optional deployment configuration id.
`entityName`	`string` or `null`		Override entity name; defaults to the package VirtualSystem name.
`networkMapping`	array of `OvfNetworkMappingRequest`		OVF network name → inventory network mappings.
`ovfDescriptor`	`string`	yes	OVF envelope XML.
`resourcePoolId`	`string`	yes	Target resource pool (`resgroup-N` / `resourcepool-N`).

CreateScheduledTaskRequest

Request to create a scheduled task.

Name	Type	Required	Description
`action`	`ScheduledAction`	yes	Power action.
`activeTime`	`string` or `null`		Optional scheduler active time.
`description`	`string`		Description.
`enabled`	`boolean`		Enabled (default true).
`entityId`	`string`	yes	Target VM id.
`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 (default `once`).
`runAt`	`string` or `null`		One-shot run time / create-time anchor (RFC 3339). Defaults to now.

CreateServerRequest

Request to create a server.

Name	Type	Required	Description
`hostname`	`string`	yes	Host name (RFC 1123 label), also the VM's name.
`image`	`string`	yes	Catalogue image (`vm-N` of the template).
`location`	`string` or `null`		Datacenter (`datacenter-N`; default: the tenant's first).
`password`	`boolean`		Generate a password (always when no SSH keys are given); it is returned once.
`plan`	`string`	yes	Plan (`vmplan-N`).
`sshKeys`	array of `string`		SSH public keys for the default user and root.
`userData`	`string` or `null`		cloud-init user data (`guestinfo.userdata`, at most 64 KiB).

CreateSnapshotRequest

Create a VM snapshot (POST /v1/vms/{id}/snapshots).

Name	Type	Required	Description
`description`	`string` or `null`		Free-text description.
`idempotencyKey`	`string` or `null`		Idempotency key.
`memory`	`boolean`		Capture memory when the guest is powered on (resume on revert).
`name`	`string`	yes	Display name (1..=80 characters).
`quiesce`	`boolean`		Quiesce guest file systems when a guest agent is present.

CreateSubscriptionRequest

Create-subscription request.

Name	Type	Required	Description
`eventTypes`	array of `string`		Event types (empty = all).
`labels`	array of `string`		Labels.
`maxAttempts`	`integer` (int32) or `null`		Attempts per event (default 5).
`name`	`string`	yes	Name.
`secret`	`string`	yes	Shared secret for `X-Kyvernon-Signature` (HMAC-SHA256); at least 16 bytes.
`tenant`	`string` or `null`		Deliver only the self-service events of this tenant (`tenant-N`; §5).
`url`	`string`	yes	Target URL (https recommended).

CreateTagCategoryRequest

Body of POST /v1/tag-categories.

Name	Type	Required	Description
`associableKinds`	array of `string`		Object kinds the tags may be attached to; empty or absent: every inventory kind.
`cardinality`	`string` or `null`		`single` (default) or `multiple`.
`description`	`string`		Description.
`name`	`string`	yes	Name, 1 to 80 characters, unique.

CreateTagRequest

Body of POST /v1/tags.

Name	Type	Required	Description
`categoryId`	`string`	yes	Category id.
`description`	`string`		Description.
`name`	`string`	yes	Name, 1 to 80 characters, unique within the category.

CreateTenantRequest

Request to create a tenant.

Name	Type	Required	Description
`anchorDay`	`integer` (int32) or `null`		Day of the month (1 to 28) the traffic period starts (default: the 1st).
`displayName`	`string`		Display name.
`externalRef`	`string`		The portal's account id.
`labels`	`object`		Labels.
`name`	`string`	yes	Short name (`[a-z0-9-]`, 1..=63), also the name of its folders and pools.
`quota`	`QuotaView`		Limits (default: unlimited).

CreateTenantUserRequest

Request to create a tenant user.

Name	Type	Required	Description
`displayName`	`string`		Display name.
`email`	`string`		E-mail.
`password`	`string`	yes	Initial password.
`role`	`string`		`admin` (Tenant administrator), `user` (Tenant user) or `read-only`.
`rotationRequired`	`boolean`		The password must be changed at first login.
`serviceAccount`	`boolean`		Automation account (API logins only).
`username`	`string`	yes	Login name.

CreateUpdateSessionRequest

Create an update session for a library item.

Name	Type	Required	Description
`clientToken`	`string` or `null`		Optional client token for idempotent create.
`libraryItemId`	`string`	yes	Library item id.

CreateUserRequest

Create-user request.

Name	Type	Required	Description
`displayName`	`string`		Display name.
`email`	`string`		E-mail.
`groups`	array of `string`		Groups.
`password`	`string`	yes	Initial password.
`rotationRequired`	`boolean`		Require a password change at first login (default true).
`username`	`string`	yes	Username.

CreateVmRequest

VM create request.

Name	Type	Required	Description
`createDisks`	array of `DiskFileRequest`		Disk files the task creates before the VM record exists: empty qcow2 images, or copies or linked clones of an image (`sourcePath`). Each must be one of the disks of `spec.config.disks` (same datastore and path).
`folderId`	`string`	yes	VM folder id (`group-vN`).
`guestAgent`	`boolean`		Install the guest agent through cloud-init: merges `packages: [qemu-guest-agent]` and `runcmd: [systemctl enable --now qemu-guest-agent]` into `guestinfo.vendordata` (`kyvernon_vm_model::guestinfo::with_guest_agent`). For images that lack the package (the Ubuntu and Debian cloud images); without it such a VM reports `toolsNotInstalled`. Never applied unless set: `POST /v1/guest-agent/offer` says when to offer it. Vendor data that is not `#cloud-config` is refused, not rewritten.
`host`	`string` or `null`		Host to place the VM on (`host-N`). Without it the VM goes to the first connected host of the resource pool's cluster.
`idempotencyKey`	`string` or `null`		Idempotency key.
`spec`	`VirtualMachine`	yes	Body in the `VirtualMachine` schema, validated as a record (`name`, `instance_uuid`, `resource_pool` and `config` are required).

CreatedObjectResultView

TaskView.result when the operation creates or returns an inventory object (create VM, clone, AddHost, CreateSnapshot).

Name	Type	Required	Description
`id`	`string` or `null`		Native object id (`vm-42`, `host-7`), when present.
`snapshot`	`integer` (int32) or `null`		Snapshot key when the created object is a snapshot.
`vimResult`	`VimMoRefView`	yes	Facade MoRef (`TaskInfo.result`).

CustomField

A custom field definition (CustomFieldsManager).

Name	Type	Required	Description
`managed_kind`	`string` or `null`		Kind the field applies to, `None` for all.
`managed_type`	`string` or `null`		The vSphere managed object type the field applies to (`VirtualMachine`, `Folder`, `ManagedEntity`, ...), as the facade's `CustomFieldDef.managedObjectType` names it; `None` for all. Kept next to `managed_kind` because several kinds share a type (the folders) and some types have no kind (`ManagedEntity`).
`name`	`string`	yes	Field name.
`values`	`object`		Values per object.

CustomizationNicSetting

One NIC mapping (CustomizationAdapterMapping / cloud-init physical).

Name	Type	Description
`dnsServers`	array of `string`	Optional per-NIC DNS servers (falls back to spec `dnsServers`).
`gateway`	array of `string`	Default gateway(s).
`ip`	`string` or `null`	Fixed IPv4 address; omit or empty for DHCP.
`macAddress`	`string` or `null`	Optional MAC for cloud-init matching.
`subnetMask`	`string` or `null`	IPv4 subnet mask (`255.255.255.0`) or prefix length (`24`); required with `ip`.

CustomizationSpecView

Named customization specification (GET/POST /v1/customization/specs).

Name	Type	Required	Description
`changeVersion`	`string`	yes	Change version.
`description`	`string`	yes	Description.
`dnsServers`	array of `string`		DNS servers.
`dnsSuffixes`	array of `string`		DNS search suffixes.
`domain`	`string`		DNS domain.
`domainAdmin`	`string` or `null`		Domain-join account name.
`domainAdminPasswordSet`	`boolean`		Whether a domain-join password is stored (value never returned).
`domainOu`	`string` or `null`		Optional target OU DN.
`fullName`	`string` or `null`		Windows registered owner.
`hostname`	`string` or `null`		Fixed host name.
`joinDomain`	`string` or `null`		AD domain to join.
`joinWorkgroup`	`string` or `null`		Workgroup when not joining a domain.
`lastUpdateTime`	`string`	yes	Last update time (RFC3339 / vim wire).
`metadata`	`string` or `null`		Raw cloud-init metadata.
`name`	`string`	yes	Spec name (unique key).
`nics`	array of `CustomizationNicSetting`		NIC mappings (static IP / DHCP).
`orgName`	`string` or `null`		Windows organisation.
`passwordSet`	`boolean`	yes	Whether a password is stored (value never returned).
`sshUser`	`string` or `null`		Optional SSH username that also receives the password.
`timezone`	`string` or `null`		Timezone.
`type`	`string`	yes	Guest OS family (`Linux` or `Windows`).
`unattendSet`	`boolean`		Whether a raw unattend.xml is stored (value never returned).
`userdata`	`string` or `null`		Raw cloud-init user-data.

CustomizeResultView

TaskView.result of guest customization.

Name	Type	Required	Description
`customized`	`boolean`	yes	Always `true` on success.

CustomizeVmRequest

Apply a named customization specification to a powered-off VM (POST /v1/vms/{id}/customize, SOAP CustomizeVM_Task).

Name	Type	Required	Description
`idempotencyKey`	`string` or `null`		Idempotency key.
`spec`	`string`	yes	Name of a catalogue specification (`GET /v1/customization/specs/{name}`).