API schemas: I

ImportVAppRequest

Import a VM from an OVF plan (POST /v1/resource-pools/{id}/import-vapp).

Same body as [CreateOvfImportSpecRequest] plus optional folder / host placement.

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.
`folderId`	`string` or `null`		Destination VM folder (`group-vN`); defaults to the datacenter VM folder.
`hostId`	`string` or `null`		Destination host (`host-N`).
`networkMapping`	array of `OvfNetworkMappingRequest`		OVF network name → inventory network mappings.
`ovfDescriptor`	`string`	yes	OVF envelope XML.

InstallLicenceRequest

Body of POST /v1/licence/install.

Name	Type	Required	Description
`payload`	`string`	yes	Licence payload JSON (the signed document).
`signature`	`string`	yes	Detached minisign signature file text.

InstalledLicenceView

Summary of one installed licence (no signature bytes).

Name	Type	Required	Description
`installedAt`	`string`	yes	When it was installed on this controller (RFC 3339).
`licenceId`	`string`	yes	Licence id.
`licensee`	`string`	yes	Licensee.
`valid`	`boolean`	yes	Whether it is currently inside its validity window.

IntervalView

A sampling interval.

Name	Type	Required	Description
`key`	`integer` (int32)	yes	`PerfInterval.key` (0 = realtime).
`length`	`integer` (int32)	yes	Seconds of history kept.
`level`	`integer` (int32) or `null`		Collection level (historical intervals).
`name`	`string`	yes	Name.
`samplingPeriod`	`integer` (int32)	yes	Seconds between samples; the `interval` of a query.

InvalidateRequestView

OpenAPI stand-in for InvalidateRequest.

Name	Type	Required	Description
`reason`	`InvalidationReasonView`	yes	Why change tracking restarts for the disk.
`vmId`	`string` (uuid)	yes	VM instance UUID.

InvalidationReasonView

OpenAPI stand-in for InvalidationReason (model lives in kyvernon-backup).

Values: "TRACKING_RESET", "DISK_RESIZED", "SNAPSHOT_REVERT", "BITMAP_LOST", "RESTORED"

InventoryNode

A node of the inventory tree (lazy loading).

Name	Type	Required	Description
`hasChildren`	`boolean`	yes	Whether the node has children.
`id`	`string`	yes	Object id.
`name`	`string`	yes	Display name.
`parentId`	`string` or `null`		Parent id.
`status`	`string`	yes	Health (`ok`, `warning`, `danger`, `unknown`).
`type`	`string`	yes	Short type (`datacenter`, `folder`, `cluster`, `host`, `vm`, `datastore`, `network`, ...).

IpPoolAvailableView

The addresses of a pool that can be allocated now.

Name	Type	Required	Description
`addresses`	array of `string`	yes	The first free IPv4 addresses, ascending, at most `limit`. The first one is what an allocation without an address takes. Gateway, reserved, network and broadcast addresses, allocated ones and those in quarantine are never listed. Another caller can take a listed address first: allocating it then fails with `error.ip_pool.address_in_use` (409).
`freeIpv4`	`integer` (int64)	yes	Free IPv4 addresses in total (not limited).
`freeIpv6Blocks`	`integer` (int64)	yes	Free IPv6 blocks in total (0 without IPv6).
`ipv6BlockLen`	`integer` (int32) or `null`		Length of the pool's IPv6 blocks (absent without IPv6).
`pool`	`string`	yes	Pool id.
`poolName`	`string`	yes	Pool name.
`truncated`	`boolean`	yes	True when more addresses are free than listed.

IpPoolRequest

Create or replace a pool.

Name	Type	Required	Description
`addresses`	array of `string`		Single IPv4 addresses (a provider's on-link addresses), besides or instead of ranges.
`dnsServers`	array of `string`		DNS servers; empty: the network's.
`expectedVersion`	`integer` (int64) or `null`		Required on update: the version read.
`gateway`	`string` or `null`		Gateway.
`ipv6`	`PoolIpv6View` or `null`
`name`	`string`	yes	Name, unique.
`network`	`string`	yes	The host-bridge network id (`network-N`).
`prefixLen`	`integer` (int32)	yes	Prefix length of the IPv4 subnet.
`quarantineS`	`integer` (int64) or `null`		Quarantine of released addresses in seconds (default 14 days).
`ranges`	array of `RangeView`		IPv4 ranges.
`rdns`	`RdnsMode` or `null`
`reserved`	array of `string`		Addresses never handed out.
`smtpIpv4`	`SmtpPolicy` or `null`
`smtpIpv6`	`SmtpPolicy` or `null`

IpPoolView

A pool.

Name	Type	Required	Description
`addresses`	array of `string`	yes	Single addresses.
`dnsServers`	array of `string`	yes	DNS servers.
`gateway`	`string` or `null`		Gateway.
`id`	`string`	yes	Id (`ippool-N`).
`ipv6`	`PoolIpv6View` or `null`
`name`	`string`	yes	Name.
`network`	`string`	yes	Network id.
`prefixLen`	`integer` (int32)	yes	Prefix length.
`quarantineS`	`integer` (int64)	yes	Quarantine in seconds.
`ranges`	array of `RangeView`	yes	Ranges.
`rdns`	`RdnsMode`	yes	Reverse DNS mode in effect for the pool: `provider` or `manual`.
`reserved`	array of `string`	yes	Reserved addresses.
`smtpIpv4`	`SmtpPolicy`	yes	Outgoing SMTP over IPv4.
`smtpIpv6`	`SmtpPolicy`	yes	Outgoing SMTP over IPv6.
`uplink`	`HostBridgeUplink` or `null`
`usage`	`PoolUsage`	yes	Counts.
`version`	`integer` (int64)	yes	Record version (for `expectedVersion`).

IpVersionView

IP families of a rule.

Values: "any", "v4", "v6"

IscsiAuthenticationRequest

Body for PUT /v1/hosts/{id}/iscsi/authentication.

Name	Type	Required	Description
`chapAuthEnabled`	`boolean`	yes	`chapAuthEnabled`.
`chapName`	`string` or `null`		`chapName`.
`chapSecret`	`string` or `null`		`chapSecret` (omit to reuse existing secret for the same name).
`mutualChapAuthenticationType`	`string` or `null`		Mutual CHAP type; omit / empty / `chapProhibited` disables mutual.
`mutualChapName`	`string` or `null`		`mutualChapName`.
`mutualChapSecret`	`string` or `null`		`mutualChapSecret`.
`targetSet`	`IscsiTargetSetBody` or `null`

IscsiConfigView

The software iSCSI configuration of a host.

Name	Type	Required	Description
`chapEnabled`	`boolean`	yes	CHAP on the adapter.
`chapName`	`string` or `null`		CHAP user name on the adapter (the secret is never returned).
`discoveredTargets`	array of `IscsiTargetView`	yes	Targets found by the last rescan.
`enabled`	`boolean`	yes	Software iSCSI initiator enabled.
`hbaDevice`	`string`	yes	Adapter name for the rescan (`vmhba64`).
`hostId`	`string`	yes	Host id.
`luns`	array of `IscsiLunView`	yes	LUNs found by the last rescan.
`mutualChapEnabled`	`boolean`	yes	Mutual CHAP on the adapter.
`sendTargets`	array of `IscsiPortalView`	yes	Discovery (send target) portals.
`staticTargets`	array of `IscsiTargetView`	yes	Static targets entered by an administrator.

IscsiLunView

A LUN the host sees through software iSCSI.

Name	Type	Required	Description
`canonicalName`	`string`	yes	Canonical name (`naa.<wwid>`), what `POST /v1/hosts/{id}/datastores` takes as `disk`.
`capacityBytes`	`integer` (int64)	yes	Capacity in bytes.
`devicePath`	`string`	yes	Device path on the host.
`lun`	`integer` (int32)	yes	LUN number.
`portal`	`string`	yes	Portal.
`target`	`string`	yes	Target IQN.
`wwid`	`string`	yes	WWID.

IscsiPortalView

An iSCSI portal.

Name	Type	Required	Description
`address`	`string`	yes	Address (host name or IP address).
`chapEnabled`	`boolean` or `null`		A CHAP setting of its own (secrets are never returned).
`port`	`integer` (int32)	yes	TCP port (3260 when not set).

IscsiRescanRequest

Body for POST /v1/hosts/{id}/iscsi/rescan.

Name	Type	Required	Description
`hbaDevice`	`string` or `null`		HBA device (`vmhba64`); defaults to the software iSCSI HBA.

IscsiSendTargetBody

One send-target portal in a request body.

Name	Type	Required	Description
`address`	`string`	yes	Portal address (hostname or IP).
`port`	`integer` (int32) or `null`		Portal TCP port; omit for 3260.

IscsiSendTargetsRequest

Body for add/remove send-target routes.

Name	Type	Required	Description
`targets`	array of `IscsiSendTargetBody`	yes	Send targets to add or remove.

IscsiStaticTargetBody

One static-target portal + IQN in a request body.

Name	Type	Required	Description
`address`	`string`	yes	Portal address.
`iqn`	`string`	yes	Target IQN.
`port`	`integer` (int32) or `null`		Portal TCP port; omit for 3260.

IscsiStaticTargetsRequest

Body for add/remove static-target routes.

Name	Type	Required	Description
`targets`	array of `IscsiStaticTargetBody`	yes	Static targets to add or remove.

IscsiTargetSetBody

Optional target set for per-target CHAP.

Name	Type	Required	Description
`sendTargets`	array of `IscsiSendTargetBody`		Send targets to update.
`staticTargets`	array of `IscsiStaticTargetBody`		Static targets to update.

IscsiTargetView

An iSCSI target.

Name	Type	Required	Description
`address`	`string`	yes	Portal address.
`chapEnabled`	`boolean` or `null`		A CHAP setting of its own (secrets are never returned).
`iqn`	`string`	yes	Target IQN.
`port`	`integer` (int32)	yes	TCP port.

IssueView

One validation finding.

Name	Type	Required	Description
`key`	`string`	yes	Message key (`net.validation.fw_`, `net.note.`).
`message`	`string`	yes	English detail.
`object`	`string`	yes	Object path (`policies/fwpolicy-3/rules/12`).
`severity`	`string`	yes	`error` or `note`.