API schemas: O

ObjectBody

A record body in the schema of its kind (kyvernon_inventory::model).

One of: Datacenter, Folder, Cluster, ComputeResource, Host, ResourcePool, VirtualMachine, Datastore, Network, DistributedSwitch, DistributedPortgroup, Tag, TagCategory, CustomField

ObjectView

A stored inventory object: record metadata, kind, health and the body data in the schema of the kind (kyvernon_inventory::model). Select the body schema on kind.

One of: ObjectViewDatacenter, ObjectViewDatacenterFolder, ObjectViewVmFolder, ObjectViewHostFolder, ObjectViewNetworkFolder, ObjectViewDatastoreFolder, ObjectViewCluster, ObjectViewComputeResource, ObjectViewHost, ObjectViewResourcePool, ObjectViewVirtualMachine, ObjectViewDatastore, ObjectViewNetwork, ObjectViewDistributedSwitch, ObjectViewDistributedPortgroup, ObjectViewTag, ObjectViewTagCategory, ObjectViewCustomField

ObjectViewCluster

An inventory object of kind cluster with a Cluster body.

Type: RecordMetaView, ObjectViewCommon, object

ObjectViewCommon

Fields every inventory object carries besides its metadata and body.

Name	Type	Required	Description
`health`	`string`		Health: the worst unacknowledged alarm on the object, `danger` for a disconnected host. Present on inventory reads; absent on writes and on records of kinds that carry no alarms.

ObjectViewComputeResource

An inventory object of kind compute_resource with a ComputeResource body.

Type: RecordMetaView, ObjectViewCommon, object

ObjectViewCustomField

An inventory object of kind custom_field with a CustomField body.

Type: RecordMetaView, ObjectViewCommon, object

ObjectViewDatacenter

An inventory object of kind datacenter with a Datacenter body.

Type: RecordMetaView, ObjectViewCommon, object

ObjectViewDatacenterFolder

An inventory object of kind datacenter_folder with a Folder body.

Type: RecordMetaView, ObjectViewCommon, object

ObjectViewDatastore

An inventory object of kind datastore with a Datastore body.

Type: RecordMetaView, ObjectViewCommon, object

ObjectViewDatastoreFolder

An inventory object of kind datastore_folder with a Folder body.

Type: RecordMetaView, ObjectViewCommon, object

ObjectViewDistributedPortgroup

An inventory object of kind distributed_portgroup with a DistributedPortgroup body.

Type: RecordMetaView, ObjectViewCommon, object

ObjectViewDistributedSwitch

An inventory object of kind distributed_switch with a DistributedSwitch body.

Type: RecordMetaView, ObjectViewCommon, object

ObjectViewHost

An inventory object of kind host with a Host body.

Type: RecordMetaView, ObjectViewCommon, object

ObjectViewHostFolder

An inventory object of kind host_folder with a Folder body.

Type: RecordMetaView, ObjectViewCommon, object

ObjectViewNetwork

An inventory object of kind network with a Network body.

Type: RecordMetaView, ObjectViewCommon, object

ObjectViewNetworkFolder

An inventory object of kind network_folder with a Folder body.

Type: RecordMetaView, ObjectViewCommon, object

ObjectViewResourcePool

An inventory object of kind resource_pool with a ResourcePool body.

Type: RecordMetaView, ObjectViewCommon, object

ObjectViewTag

An inventory object of kind tag with a Tag body.

Type: RecordMetaView, ObjectViewCommon, object

ObjectViewTagCategory

An inventory object of kind tag_category with a TagCategory body.

Type: RecordMetaView, ObjectViewCommon, object

ObjectViewVirtualMachine

An inventory object of kind virtual_machine with a VirtualMachine body.

Type: RecordMetaView, ObjectViewCommon, object

ObjectViewVmFolder

An inventory object of kind vm_folder with a Folder body.

Type: RecordMetaView, ObjectViewCommon, object

OidcAdminInput

The identity provider to store. The controller runs provider discovery first and refuses settings the provider does not answer to.

Name	Type	Required	Description
`clientId`	`string`	yes	Client id.
`clientSecret`	`string` or `null`		Client secret (write-only). Blank or absent keeps the stored one.
`groupsClaim`	`string`		Claim with the group names (default `groups`).
`issuer`	`string`	yes	Issuer URL.
`loginTtlSeconds`	`integer` (int64)	yes	How long a started sign-in stays valid, 60 to 3600 seconds.
`redirectUri`	`string`	yes	Redirect URI, normally `https://<controller>/v1/identity/oidc/callback`.
`scopes`	array of `string`		Scopes beyond `openid`.

OidcAdminView

The OpenID Connect identity provider as an administrator sees it. The client secret is never returned.

Name	Type	Required	Description
`clientId`	`string`	yes	Client id registered at the provider.
`clientSecretSet`	`boolean`	yes	Whether a client secret is stored.
`configured`	`boolean`	yes	Whether a provider is set up (sign-in with it is offered).
`groupsClaim`	`string`	yes	Claim of the ID token with the group names.
`issuer`	`string`	yes	Issuer URL.
`loginTtlSeconds`	`integer` (int64)	yes	How long a started sign-in stays valid, seconds.
`redirectUri`	`string`	yes	Redirect URI registered at the provider.
`scopes`	array of `string`	yes	Scopes requested beyond `openid`.
`source`	`string`	yes	Where the provider comes from: `console` (set up here), `configuration` (the `[oidc]` section of the controller configuration) or `none`.

OidcConfigView

OIDC part of [AuthConfigView].

Name	Type	Required	Description
`enabled`	`boolean`	yes	An identity provider is configured.
`label`	`string` or `null`		Button label (the issuer host), when enabled.

OidcStartResponse

OIDC login start.

Name	Type	Required	Description
`state`	`string`	yes	State to expect on the callback.
`url`	`string`	yes	Provider URL to redirect the browser to.

OpenPortBody

Body of POST /v1/vms/{id}/firewall/open-port.

Name	Type	Required	Description
`from`	array of `string`		Sources allowed (addresses or prefixes; empty: any).
`ipVersion`	`IpVersionView`		IP families (default `any`).
`name`	`string` or `null`		Rule name (default `open <protocol> <ports>`).
`ports`	`string`	yes	Port or range (`443`, `8000-8100`).
`protocol`	`string`	yes	`tcp` or `udp`.

Origin

Where an effective rule comes from.

Values: "provider", "tenant", "baseline", "system", "default"

OrphanDisk

A disk image nothing references.

Name	Type	Required	Description
`backing`	`string` or `null`		Backing image as stored in the header (an orphan overlay names its base).
`capacityBytes`	`integer` (int64) or `null`		Guest-visible capacity, when the header tells.
`format`	`string` or `null`		Image format (`qcow2`, `raw`, `vmdk`).
`modifiedUnix`	`integer` (int64) or `null`		Last change (seconds since the Unix epoch).
`path`	`string`	yes	Path below the datastore root.
`sizeBytes`	`integer` (int64) or `null`		Bytes the file takes on the datastore.

OrphanDiskReport

The orphan-disk report of one datastore.

Name	Type	Required	Description
`datastore`	`string`	yes	The datastore (`datastore-N`).
`datastoreName`	`string`	yes	Its name.
`minAgeSeconds`	`integer` (int64)	yes	Files changed more recently than this were left out.
`orphanSidecars`	array of `OrphanSidecar`		Change-tracking sidecars (`<image>.kcbt`, `<image>.kcbt.<epoch>.<seq>`) whose image no longer exists, by path (TP-50). The sidecars of a listed image are not repeated here: they go with it.
`orphans`	array of `OrphanDisk`	yes	The disk images nothing references, by path.
`referencedDisks`	`integer`	yes	Disk images the inventory references (directly, as overlay or as backing image).
`scannedDisks`	`integer`	yes	Disk images found on the datastore.
`totalSizeBytes`	`integer` (int64)	yes	Bytes the listed files take together.
`truncated`	`boolean`	yes	The datastore has more files than one scan returns; the list is incomplete.

OrphanSidecar

A change-tracking sidecar whose image is gone.

Name	Type	Required	Description
`image`	`string`	yes	Path of the image it belonged to.
`modifiedUnix`	`integer` (int64) or `null`		Last change (seconds since the Unix epoch).
`path`	`string`	yes	Path below the datastore root.
`sizeBytes`	`integer` (int64) or `null`		Bytes the file takes on the datastore.

OvfCreateDescriptorFileRequest

One package member for CreateDescriptor (OvfFile).

Name	Type	Required	Description
`capacity`	`integer` (int64) or `null`		Virtual disk capacity in bytes when known (preferred over `size` for disks).
`deviceId`	`string`		NFC / export device id (`/{entity}/disk:N` or cdrom key).
`path`	`string`	yes	Package member path (href), e.g. `web-disk1.vmdk` or `media.iso`.
`populatedSize`	`integer` (int64) or `null`		Populated size when `size` is zero.
`size`	`integer` (int64)		Transfer / compressed size in bytes.

OvfCreateDescriptorView

Result of POST /v1/ovf/create-descriptor.

Name	Type	Description
`entityName`	`string`	Entity name written into the envelope.
`errors`	array of `OvfMessageView`	Hard failures (HTTP still 200, matching SOAP).
`includeImageFiles`	`boolean`	Whether ISO image files were packaged.
`ovfDescriptor`	`string`	OVF envelope XML.
`warnings`	array of `OvfMessageView`	Soft warnings.

OvfDeploymentOptionView

One deployment option from the package.

Name	Type	Required	Description
`key`	`string`	yes	Option key / id.
`label`	`string`	yes	Display label.

OvfFileItemView

File the NFC lease would upload (OvfFileItem).

Name	Type	Required	Description
`cimType`	`integer` (int32)	yes	CIM type (17 = disk, 15 = CD-ROM).
`create`	`boolean`	yes	Create empty backing instead of uploading.
`deviceId`	`string`	yes	Device import key.
`path`	`string`	yes	Package member path (href) or empty-disk basename.
`size`	`integer` (int64) or `null`		Declared size when known.

OvfImportCdromView

CD-ROM planned by CreateImportSpec.

Name	Type	Required	Description
`id`	`string`	yes	Package CD-ROM id.
`importKey`	`string` or `null`		NFC import key when an ISO upload is required.
`isoPath`	`string` or `null`		ISO datastore path when the package includes media.

OvfImportDiskView

Disk planned by CreateImportSpec.

Name	Type	Required	Description
`capacityBytes`	`integer` (int64)	yes	Capacity in bytes.
`create`	`boolean`	yes	Whether an empty disk is created (no NFC upload).
`datastorePath`	`string`	yes	Destination datastore path (`[ds] name/disk-N.qcow2`).
`id`	`string`	yes	Package disk id.
`importKey`	`string`	yes	NFC import key (`/{entity}/disk:N`).

OvfImportNicView

NIC planned by CreateImportSpec.

Name	Type	Required	Description
`connected`	`boolean`	yes	Connect at power-on.
`id`	`string`	yes	Package NIC id.
`mac`	`string` or `null`		MAC when the package states one.
`model`	`string`	yes	Model string (`vmxnet3`, `e1000`, …).
`networkId`	`string` or `null`		Resolved inventory network id when mapped.
`networkName`	`string` or `null`		Resolved inventory network name.
`ovfNetwork`	`string` or `null`		Network name from the OVF.

OvfImportSpecView

Result of POST /v1/ovf/import-spec.

Name	Type	Description
`annotation`	`string` or `null`	Annotation.
`cdroms`	array of `OvfImportCdromView`	Planned CD-ROMs.
`coresPerSocket`	`integer` (int32) or `null`	Cores per socket when valid.
`datastoreId`	`string`	Datastore id.
`disks`	array of `OvfImportDiskView`	Planned disks.
`entityName`	`string`	Planned VM name.
`errors`	array of `OvfMessageView`	Hard failures (HTTP still 200, matching SOAP).
`extraConfig`	`object`	`vmw:ExtraConfig` / guestinfo pairs.
`fileItems`	array of `OvfFileItemView`	NFC file items.
`firmware`	`string`	Firmware: `bios` or `efi` as the package states it, `efi` when it states none.
`guestId`	`string` or `null`	Guest OS id from the package.
`hardwareVersion`	`string` or `null`	Hardware version string when stated.
`memoryMib`	`integer` (int64)	Memory in MiB.
`nics`	array of `OvfImportNicView`	Planned NICs (unmapped NICs are omitted with a warning).
`numCpus`	`integer` (int32)	vCPU count.
`resourcePoolId`	`string`	Resource pool id.
`secureBoot`	`boolean`	Secure Boot as the package states it (kept with `efi` only).
`warnings`	array of `OvfMessageView`	Soft warnings.

OvfMessageView

Warning or error from OVF parse / import-spec.

Name	Type	Required	Description
`detail`	`string`	yes	Non-secret detail.
`key`	`string`	yes	Stable message key (`import.ovf.*`).

OvfNetworkInfoView

One OVF network advertised by the package.

Name	Type	Required	Description
`description`	`string`		Description from the package.
`name`	`string`	yes	Network name in the package.

OvfNetworkMappingRequest

Map an OVF network name to an inventory network.

Name	Type	Required	Description
`name`	`string`	yes	Network name as stated in the OVF.
`networkId`	`string`	yes	Inventory network or distributed port group id.

OvfParseDescriptorRequest

Parse an OVF descriptor (OvfManager.ParseDescriptor).

Name	Type	Required	Description
`deploymentOption`	`string` or `null`		Optional deployment configuration id from the package.
`ovfDescriptor`	`string`	yes	OVF envelope XML.

OvfParseDescriptorView

Result of POST /v1/ovf/parse.

Name	Type	Description
`annotation`	`string`	Annotation / description.
`approximateDownloadSize`	`integer` (int64) or `null`	Approximate download size in bytes.
`approximateFlatDeploymentSize`	`integer` (int64) or `null`	Approximate flat deployment size in bytes.
`approximateSparseDeploymentSize`	`integer` (int64) or `null`	Approximate sparse deployment size in bytes.
`defaultDeploymentOption`	`string`	Default deployment option key.
`defaultEntityName`	`string`	Default VM name from the first VirtualSystem.
`deploymentOptions`	array of `OvfDeploymentOptionView`	Deployment options.
`errors`	array of `OvfMessageView`	Hard failures (parse still returns 200 with these populated, matching SOAP).
`networks`	array of `OvfNetworkInfoView`	Networks declared by the package.
`virtualApp`	`boolean`	Whether the package is a vApp (always false in this thin slice).
`warnings`	array of `OvfMessageView`	Soft warnings.

OvnHostView

One host's realization as the status shows it.

Name	Type	Required	Description
`applied`	`boolean`	yes	The slice is realised on the host's Open vSwitch.
`error`	`string` or `null`		Why not.
`generation`	`integer` (int64)	yes	Generation of the slice the host holds.
`host`	`string`	yes	Host id.
`ports`	`integer`	yes	Logical ports bound to the host.
`portsInstalled`	`integer`	yes	Of those, ports whose flows `ovn-controller` installed.
`preconditions`	array of `string`		Host preconditions that do not hold.
`reportedAt`	`string`	yes	When the host last reported.

OvnStatusView

Realization status of the OVN logical networks (GET /v1/network/realization).

Name	Type	Required	Description
`connected`	`boolean`	yes	The Northbound connection is up.
`counters`	`string`	yes	Rule counters on segments: `available`, `not configured` (no `[ovn] southbound`) or the reason they are not.
`enabled`	`boolean`	yes	`[ovn] enabled`.
`error`	`string` or `null`		The model or realization error, if the newest model is not realised.
`hosts`	array of `OvnHostView`		The hosts' reports.
`lastDrift`	`integer`	yes	Rows another writer changed that the last realization corrected.
`lastOperations`	`integer`	yes	Database operations of the last realization (0: already in line).
`modelGeneration`	`integer` (int64)	yes	Generation of the newest model (the store version it was read at).
`northbound`	`string`	yes	The Northbound remote.
`notes`	array of `string`		Notes of the compiler and inventory objects left out.
`ports`	`integer`	yes	Logical ports in the model.
`portsUp`	`integer`	yes	Logical ports OVN reports up (bound on a chassis).
`realizedAt`	`string` or `null`		When it was realised.
`realizedGeneration`	`integer` (int64)	yes	Generation last realised in the Northbound database.
`segments`	`integer`	yes	Segments in the model.