VirtualMachineClusterPreference [virtualmachineclusterpreferences.instancetype.kubevirt.io/v1beta1]

Description
VirtualMachineClusterPreference is a cluster scoped version of the VirtualMachinePreference resource.
Type
object
Required
spec

Specification

PropertyTypeDescription
apiVersionstring

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kindstring

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadataObjectMeta

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

specobject

Required spec describing the preferences

.spec

Description
Required spec describing the preferences
Type
object
PropertyTypeDescription
annotationsobject

Optionally defines preferred Annotations to be applied to the VirtualMachineInstance

clockobject

Clock optionally defines preferences associated with the Clock attribute of a VirtualMachineInstance DomainSpec

cpuobject

CPU optionally defines preferences associated with the CPU attribute of a VirtualMachineInstance DomainSpec

devicesobject

Devices optionally defines preferences associated with the Devices attribute of a VirtualMachineInstance DomainSpec

featuresobject

Features optionally defines preferences associated with the Features attribute of a VirtualMachineInstance DomainSpec

firmwareobject

Firmware optionally defines preferences associated with the Firmware attribute of a VirtualMachineInstance DomainSpec

machineobject

Machine optionally defines preferences associated with the Machine attribute of a VirtualMachineInstance DomainSpec

preferSpreadSocketToCoreRatiointeger

PreferSpreadSocketToCoreRatio defines the ratio to spread vCPUs between cores and sockets, it defaults to 2.

preferredArchitecturestring

PreferredArchitecture defines a prefeerred architecture for the VirtualMachine

preferredSubdomainstring

Subdomain of the VirtualMachineInstance

preferredTerminationGracePeriodSecondsinteger

Grace period observed after signalling a VirtualMachineInstance to stop after which the VirtualMachineInstance is force terminated.

requirementsobject

Requirements defines the minium amount of instance type defined resources required by a set of preferences

volumesobject

Volumes optionally defines preferences associated with the Volumes attribute of a VirtualMachineInstace DomainSpec

.spec.annotations

Description
Optionally defines preferred Annotations to be applied to the VirtualMachineInstance
Type
object

.spec.clock

Description
Clock optionally defines preferences associated with the Clock attribute of a VirtualMachineInstance DomainSpec
Type
object
PropertyTypeDescription
preferredClockOffsetobject

ClockOffset allows specifying the UTC offset or the timezone of the guest clock.

preferredTimerobject

Timer specifies whih timers are attached to the vmi.

.spec.clock.preferredClockOffset

Description
ClockOffset allows specifying the UTC offset or the timezone of the guest clock.
Type
object
PropertyTypeDescription
timezonestring

Timezone sets the guest clock to the specified timezone. Zone name follows the TZ environment variable format (e.g. 'America/New_York').

utcobject

UTC sets the guest clock to UTC on each boot. If an offset is specified, guest changes to the clock will be kept during reboots and are not reset.

.spec.clock.preferredClockOffset.utc

Description
UTC sets the guest clock to UTC on each boot. If an offset is specified, guest changes to the clock will be kept during reboots and are not reset.
Type
object
PropertyTypeDescription
offsetSecondsinteger

OffsetSeconds specifies an offset in seconds, relative to UTC. If set, guest changes to the clock will be kept during reboots and not reset.

.spec.clock.preferredTimer

Description
Timer specifies whih timers are attached to the vmi.
Type
object
PropertyTypeDescription
hpetobject

HPET (High Precision Event Timer) - multiple timers with periodic interrupts.

hypervobject

Hyperv (Hypervclock) - lets guests read the host’s wall clock time (paravirtualized). For windows guests.

kvmobject

KVM (KVM clock) - lets guests read the host’s wall clock time (paravirtualized). For linux guests.

pitobject

PIT (Programmable Interval Timer) - a timer with periodic interrupts.

rtcobject

RTC (Real Time Clock) - a continuously running timer with periodic interrupts.

.spec.clock.preferredTimer.hpet

Description
HPET (High Precision Event Timer) - multiple timers with periodic interrupts.
Type
object
PropertyTypeDescription
presentboolean

Enabled set to false makes sure that the machine type or a preset can't add the timer. Defaults to true.

tickPolicystring

TickPolicy determines what happens when QEMU misses a deadline for injecting a tick to the guest. One of "delay", "catchup", "merge", "discard".

.spec.clock.preferredTimer.hyperv

Description
Hyperv (Hypervclock) - lets guests read the host’s wall clock time (paravirtualized). For windows guests.
Type
object
PropertyTypeDescription
presentboolean

Enabled set to false makes sure that the machine type or a preset can't add the timer. Defaults to true.

.spec.clock.preferredTimer.kvm

Description
KVM (KVM clock) - lets guests read the host’s wall clock time (paravirtualized). For linux guests.
Type
object
PropertyTypeDescription
presentboolean

Enabled set to false makes sure that the machine type or a preset can't add the timer. Defaults to true.

.spec.clock.preferredTimer.pit

Description
PIT (Programmable Interval Timer) - a timer with periodic interrupts.
Type
object
PropertyTypeDescription
presentboolean

Enabled set to false makes sure that the machine type or a preset can't add the timer. Defaults to true.

tickPolicystring

TickPolicy determines what happens when QEMU misses a deadline for injecting a tick to the guest. One of "delay", "catchup", "discard".

.spec.clock.preferredTimer.rtc

Description
RTC (Real Time Clock) - a continuously running timer with periodic interrupts.
Type
object
PropertyTypeDescription
presentboolean

Enabled set to false makes sure that the machine type or a preset can't add the timer. Defaults to true.

tickPolicystring

TickPolicy determines what happens when QEMU misses a deadline for injecting a tick to the guest. One of "delay", "catchup".

trackstring

Track the guest or the wall clock.

.spec.cpu

Description
CPU optionally defines preferences associated with the CPU attribute of a VirtualMachineInstance DomainSpec
Type
object
PropertyTypeDescription
preferredCPUFeaturesarray

PreferredCPUFeatures optionally defines a slice of preferred CPU features.

preferredCPUTopologystring

PreferredCPUTopology optionally defines the preferred guest visible CPU topology, defaults to PreferSockets.

spreadOptionsobject

.spec.cpu.preferredCPUFeatures

Description
PreferredCPUFeatures optionally defines a slice of preferred CPU features.
Type
array

.spec.cpu.preferredCPUFeatures[]

Description
CPUFeature allows specifying a CPU feature.
Type
object
Required
name
PropertyTypeDescription
namestring

Name of the CPU feature

policystring

Policy is the CPU feature attribute which can have the following attributes: force - The virtual CPU will claim the feature is supported regardless of it being supported by host CPU. require - Guest creation will fail unless the feature is supported by the host CPU or the hypervisor is able to emulate it. optional - The feature will be supported by virtual CPU if and only if it is supported by host CPU. disable - The feature will not be supported by virtual CPU. forbid - Guest creation will fail if the feature is supported by host CPU. Defaults to require

.spec.cpu.spreadOptions

Type
object
PropertyTypeDescription
acrossstring

Across optionally defines how to spread vCPUs across the guest visible topology. Default: SocketsCores

ratiointeger

Ratio optionally defines the ratio to spread vCPUs across the guest visible topology:

CoresThreads - 1:2 - Controls the ratio of cores to threads. Only a ratio of 2 is currently accepted. SocketsCores - 1:N - Controls the ratio of socket to cores. SocketsCoresThreads - 1:N:2 - Controls the ratio of socket to cores. Each core providing 2 threads.

Default: 2

.spec.devices

Description
Devices optionally defines preferences associated with the Devices attribute of a VirtualMachineInstance DomainSpec
Type
object
PropertyTypeDescription
preferredAutoattachGraphicsDeviceboolean

PreferredAutoattachGraphicsDevice optionally defines the preferred value of AutoattachGraphicsDevice

preferredAutoattachInputDeviceboolean

PreferredAutoattachInputDevice optionally defines the preferred value of AutoattachInputDevice

preferredAutoattachMemBalloonboolean

PreferredAutoattachMemBalloon optionally defines the preferred value of AutoattachMemBalloon

preferredAutoattachPodInterfaceboolean

PreferredAutoattachPodInterface optionally defines the preferred value of AutoattachPodInterface

preferredAutoattachSerialConsoleboolean

PreferredAutoattachSerialConsole optionally defines the preferred value of AutoattachSerialConsole

preferredBlockMultiQueueboolean

PreferredBlockMultiQueue optionally enables the vhost multiqueue feature for virtio disks.

preferredCdromBusstring

PreferredCdromBus optionally defines the preferred bus for Cdrom Disk devices.

preferredDisableHotplugboolean

PreferredDisableHotplug optionally defines the preferred value of DisableHotplug

preferredDiskBlockSizeobject

PreferredBlockSize optionally defines the block size of Disk devices.

preferredDiskBusstring

PreferredDiskBus optionally defines the preferred bus for Disk Disk devices.

preferredDiskCachestring

PreferredCache optionally defines the DriverCache to be used by Disk devices.

preferredDiskDedicatedIoThreadboolean

PreferredDedicatedIoThread optionally enables dedicated IO threads for Disk devices using the virtio bus.

preferredDiskIOstring

PreferredIo optionally defines the QEMU disk IO mode to be used by Disk devices.

preferredInputBusstring

PreferredInputBus optionally defines the preferred bus for Input devices.

preferredInputTypestring

PreferredInputType optionally defines the preferred type for Input devices.

preferredInterfaceMasqueradeobject

PreferredInterfaceMasquerade optionally defines the preferred masquerade configuration to use with each network interface.

preferredInterfaceModelstring

PreferredInterfaceModel optionally defines the preferred model to be used by Interface devices.

preferredLunBusstring

PreferredLunBus optionally defines the preferred bus for Lun Disk devices.

preferredNetworkInterfaceMultiQueueboolean

PreferredNetworkInterfaceMultiQueue optionally enables the vhost multiqueue feature for virtio interfaces.

preferredPanicDeviceModelstring

PreferredPanicDeviceModel optionally defines the preferred panic device model to use with panic devices.

preferredRngobject

PreferredRng optionally defines the preferred rng device to be used.

preferredSoundModelstring

PreferredSoundModel optionally defines the preferred model for Sound devices.

preferredTPMobject

PreferredTPM optionally defines the preferred TPM device to be used.

preferredUseVirtioTransitionalboolean

PreferredUseVirtioTransitional optionally defines the preferred value of UseVirtioTransitional

preferredVirtualGPUOptionsobject

PreferredVirtualGPUOptions optionally defines the preferred value of VirtualGPUOptions

.spec.devices.preferredDiskBlockSize

Description
PreferredBlockSize optionally defines the block size of Disk devices.
Type
object
PropertyTypeDescription
customobject

CustomBlockSize represents the desired logical and physical block size for a VM disk.

matchVolumeobject

Represents if a feature is enabled or disabled.

.spec.devices.preferredDiskBlockSize.custom

Description
CustomBlockSize represents the desired logical and physical block size for a VM disk.
Type
object
PropertyTypeDescription
discardGranularityinteger
logicalinteger
physicalinteger

.spec.devices.preferredDiskBlockSize.matchVolume

Description
Represents if a feature is enabled or disabled.
Type
object
PropertyTypeDescription
enabledboolean

Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

.spec.devices.preferredInterfaceMasquerade

Description
PreferredInterfaceMasquerade optionally defines the preferred masquerade configuration to use with each network interface.
Type
object

.spec.devices.preferredRng

Description
PreferredRng optionally defines the preferred rng device to be used.
Type
object

.spec.devices.preferredTPM

Description
PreferredTPM optionally defines the preferred TPM device to be used.
Type
object
PropertyTypeDescription
enabledboolean

Enabled allows a user to explicitly disable the vTPM even when one is enabled by a preference referenced by the VirtualMachine Defaults to True

persistentboolean

Persistent indicates the state of the TPM device should be kept accross reboots Defaults to false

.spec.devices.preferredVirtualGPUOptions

Description
PreferredVirtualGPUOptions optionally defines the preferred value of VirtualGPUOptions
Type
object
PropertyTypeDescription
displayobject

.spec.devices.preferredVirtualGPUOptions.display

Type
object
PropertyTypeDescription
enabledboolean

Enabled determines if a display addapter backed by a vGPU should be enabled or disabled on the guest. Defaults to true.

ramFBobject

Enables a boot framebuffer, until the guest OS loads a real GPU driver Defaults to true.

.spec.devices.preferredVirtualGPUOptions.display.ramFB

Description
Enables a boot framebuffer, until the guest OS loads a real GPU driver Defaults to true.
Type
object
PropertyTypeDescription
enabledboolean

Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

.spec.features

Description
Features optionally defines preferences associated with the Features attribute of a VirtualMachineInstance DomainSpec
Type
object
PropertyTypeDescription
preferredAcpiobject

PreferredAcpi optionally enables the ACPI feature

preferredApicobject

PreferredApic optionally enables and configures the APIC feature

preferredHypervobject

PreferredHyperv optionally enables and configures HyperV features

preferredKvmobject

PreferredKvm optionally enables and configures KVM features

preferredPvspinlockobject

PreferredPvspinlock optionally enables the Pvspinlock feature

preferredSmmobject

PreferredSmm optionally enables the SMM feature

.spec.features.preferredAcpi

Description
PreferredAcpi optionally enables the ACPI feature
Type
object
PropertyTypeDescription
enabledboolean

Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

.spec.features.preferredApic

Description
PreferredApic optionally enables and configures the APIC feature
Type
object
PropertyTypeDescription
enabledboolean

Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

endOfInterruptboolean

EndOfInterrupt enables the end of interrupt notification in the guest. Defaults to false.

.spec.features.preferredHyperv

Description
PreferredHyperv optionally enables and configures HyperV features
Type
object
PropertyTypeDescription
evmcsobject

EVMCS Speeds up L2 vmexits, but disables other virtualization features. Requires vapic. Defaults to the machine type setting.

frequenciesobject

Frequencies improves the TSC clock source handling for Hyper-V on KVM. Defaults to the machine type setting.

ipiobject

IPI improves performances in overcommited environments. Requires vpindex. Defaults to the machine type setting.

reenlightenmentobject

Reenlightenment enables the notifications on TSC frequency changes. Defaults to the machine type setting.

relaxedobject

Relaxed instructs the guest OS to disable watchdog timeouts. Defaults to the machine type setting.

resetobject

Reset enables Hyperv reboot/reset for the vmi. Requires synic. Defaults to the machine type setting.

runtimeobject

Runtime improves the time accounting to improve scheduling in the guest. Defaults to the machine type setting.

spinlocksobject

Spinlocks allows to configure the spinlock retry attempts.

synicobject

SyNIC enables the Synthetic Interrupt Controller. Defaults to the machine type setting.

synictimerobject

SyNICTimer enables Synthetic Interrupt Controller Timers, reducing CPU load. Defaults to the machine type setting.

tlbflushobject

TLBFlush improves performances in overcommited environments. Requires vpindex. Defaults to the machine type setting.

vapicobject

VAPIC improves the paravirtualized handling of interrupts. Defaults to the machine type setting.

vendoridobject

VendorID allows setting the hypervisor vendor id. Defaults to the machine type setting.

vpindexobject

VPIndex enables the Virtual Processor Index to help windows identifying virtual processors. Defaults to the machine type setting.

.spec.features.preferredHyperv.evmcs

Description
EVMCS Speeds up L2 vmexits, but disables other virtualization features. Requires vapic. Defaults to the machine type setting.
Type
object
PropertyTypeDescription
enabledboolean

Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

.spec.features.preferredHyperv.frequencies

Description
Frequencies improves the TSC clock source handling for Hyper-V on KVM. Defaults to the machine type setting.
Type
object
PropertyTypeDescription
enabledboolean

Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

.spec.features.preferredHyperv.ipi

Description
IPI improves performances in overcommited environments. Requires vpindex. Defaults to the machine type setting.
Type
object
PropertyTypeDescription
enabledboolean

Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

.spec.features.preferredHyperv.reenlightenment

Description
Reenlightenment enables the notifications on TSC frequency changes. Defaults to the machine type setting.
Type
object
PropertyTypeDescription
enabledboolean

Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

.spec.features.preferredHyperv.relaxed

Description
Relaxed instructs the guest OS to disable watchdog timeouts. Defaults to the machine type setting.
Type
object
PropertyTypeDescription
enabledboolean

Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

.spec.features.preferredHyperv.reset

Description
Reset enables Hyperv reboot/reset for the vmi. Requires synic. Defaults to the machine type setting.
Type
object
PropertyTypeDescription
enabledboolean

Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

.spec.features.preferredHyperv.runtime

Description
Runtime improves the time accounting to improve scheduling in the guest. Defaults to the machine type setting.
Type
object
PropertyTypeDescription
enabledboolean

Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

.spec.features.preferredHyperv.spinlocks

Description
Spinlocks allows to configure the spinlock retry attempts.
Type
object
PropertyTypeDescription
enabledboolean

Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

spinlocksinteger

Retries indicates the number of retries. Must be a value greater or equal 4096. Defaults to 4096.

.spec.features.preferredHyperv.synic

Description
SyNIC enables the Synthetic Interrupt Controller. Defaults to the machine type setting.
Type
object
PropertyTypeDescription
enabledboolean

Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

.spec.features.preferredHyperv.synictimer

Description
SyNICTimer enables Synthetic Interrupt Controller Timers, reducing CPU load. Defaults to the machine type setting.
Type
object
PropertyTypeDescription
directobject

Represents if a feature is enabled or disabled.

enabledboolean

.spec.features.preferredHyperv.synictimer.direct

Description
Represents if a feature is enabled or disabled.
Type
object
PropertyTypeDescription
enabledboolean

Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

.spec.features.preferredHyperv.tlbflush

Description
TLBFlush improves performances in overcommited environments. Requires vpindex. Defaults to the machine type setting.
Type
object
PropertyTypeDescription
enabledboolean

Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

.spec.features.preferredHyperv.vapic

Description
VAPIC improves the paravirtualized handling of interrupts. Defaults to the machine type setting.
Type
object
PropertyTypeDescription
enabledboolean

Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

.spec.features.preferredHyperv.vendorid

Description
VendorID allows setting the hypervisor vendor id. Defaults to the machine type setting.
Type
object
PropertyTypeDescription
enabledboolean

Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

vendoridstring

VendorID sets the hypervisor vendor id, visible to the vmi. String up to twelve characters.

.spec.features.preferredHyperv.vpindex

Description
VPIndex enables the Virtual Processor Index to help windows identifying virtual processors. Defaults to the machine type setting.
Type
object
PropertyTypeDescription
enabledboolean

Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

.spec.features.preferredKvm

Description
PreferredKvm optionally enables and configures KVM features
Type
object
PropertyTypeDescription
hiddenboolean

Hide the KVM hypervisor from standard MSR based discovery. Defaults to false

.spec.features.preferredPvspinlock

Description
PreferredPvspinlock optionally enables the Pvspinlock feature
Type
object
PropertyTypeDescription
enabledboolean

Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

.spec.features.preferredSmm

Description
PreferredSmm optionally enables the SMM feature
Type
object
PropertyTypeDescription
enabledboolean

Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

.spec.firmware

Description
Firmware optionally defines preferences associated with the Firmware attribute of a VirtualMachineInstance DomainSpec
Type
object
PropertyTypeDescription
preferredEfiobject

PreferredEfi optionally enables EFI

preferredUseBiosboolean

PreferredUseBios optionally enables BIOS

preferredUseBiosSerialboolean

PreferredUseBiosSerial optionally transmitts BIOS output over the serial.

Requires PreferredUseBios to be enabled.

preferredUseEfiboolean

PreferredUseEfi optionally enables EFI

Deprecated: Will be removed with v1beta2 or v1

preferredUseSecureBootboolean

PreferredUseSecureBoot optionally enables SecureBoot and the OVMF roms will be swapped for SecureBoot-enabled ones.

Requires PreferredUseEfi and PreferredSmm to be enabled.

Deprecated: Will be removed with v1beta2 or v1

.spec.firmware.preferredEfi

Description
PreferredEfi optionally enables EFI
Type
object
PropertyTypeDescription
persistentboolean

If set to true, Persistent will persist the EFI NVRAM across reboots. Defaults to false

secureBootboolean

If set, SecureBoot will be enabled and the OVMF roms will be swapped for SecureBoot-enabled ones. Requires SMM to be enabled. Defaults to true

.spec.machine

Description
Machine optionally defines preferences associated with the Machine attribute of a VirtualMachineInstance DomainSpec
Type
object
PropertyTypeDescription
preferredMachineTypestring

PreferredMachineType optionally defines the preferred machine type to use.

.spec.requirements

Description
Requirements defines the minium amount of instance type defined resources required by a set of preferences
Type
object
PropertyTypeDescription
architecturestring

Required Architecture of the VM referencing this preference

cpuobject

Required CPU related attributes of the instancetype.

memoryobject

Required Memory related attributes of the instancetype.

.spec.requirements.cpu

Description
Required CPU related attributes of the instancetype.
Type
object
Required
guest
PropertyTypeDescription
guestinteger

Minimal number of vCPUs required by the preference.

.spec.requirements.memory

Description
Required Memory related attributes of the instancetype.
Type
object
Required
guest
PropertyTypeDescription
guest

Minimal amount of memory required by the preference.

.spec.volumes

Description
Volumes optionally defines preferences associated with the Volumes attribute of a VirtualMachineInstace DomainSpec
Type
object
PropertyTypeDescription
preferredStorageClassNamestring

PreffereedStorageClassName optionally defines the preferred storageClass

API Endpoints

The following API endpoints are available:

  • /apis/instancetype.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachineclusterpreferences
    • DELETE: delete collection of VirtualMachineClusterPreference
    • GET: list objects of kind VirtualMachineClusterPreference
    • POST: create a new VirtualMachineClusterPreference
  • /apis/instancetype.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachineclusterpreferences/{name}
    • DELETE: delete the specified VirtualMachineClusterPreference
    • GET: read the specified VirtualMachineClusterPreference
    • PATCH: partially update the specified VirtualMachineClusterPreference
    • PUT: replace the specified VirtualMachineClusterPreference

/apis/instancetype.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachineclusterpreferences

HTTP method
DELETE
Description
delete collection of VirtualMachineClusterPreference
HTTP responses
HTTP codeResponse body
200 - OKStatus schema
401 - UnauthorizedEmpty
HTTP method
GET
Description
list objects of kind VirtualMachineClusterPreference
HTTP responses
HTTP codeResponse body
200 - OKVirtualMachineClusterPreferenceList schema
401 - UnauthorizedEmpty
HTTP method
POST
Description
create a new VirtualMachineClusterPreference
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
Body parameters
ParameterTypeDescription
bodyVirtualMachineClusterPreference schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKVirtualMachineClusterPreference schema
201 - CreatedVirtualMachineClusterPreference schema
202 - AcceptedVirtualMachineClusterPreference schema
401 - UnauthorizedEmpty

/apis/instancetype.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachineclusterpreferences/{name}

HTTP method
DELETE
Description
delete the specified VirtualMachineClusterPreference
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
HTTP responses
HTTP codeResponse body
200 - OKStatus schema
202 - AcceptedStatus schema
401 - UnauthorizedEmpty
HTTP method
GET
Description
read the specified VirtualMachineClusterPreference
HTTP responses
HTTP codeResponse body
200 - OKVirtualMachineClusterPreference schema
401 - UnauthorizedEmpty
HTTP method
PATCH
Description
partially update the specified VirtualMachineClusterPreference
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
HTTP responses
HTTP codeResponse body
200 - OKVirtualMachineClusterPreference schema
401 - UnauthorizedEmpty
HTTP method
PUT
Description
replace the specified VirtualMachineClusterPreference
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
Body parameters
ParameterTypeDescription
bodyVirtualMachineClusterPreference schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKVirtualMachineClusterPreference schema
201 - CreatedVirtualMachineClusterPreference schema
401 - UnauthorizedEmpty