#VSphereVM [infrastructure.cluster.x-k8s.io/v1beta1]

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

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

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

VSphereVMSpec defines the desired state of VSphereVM.

VSphereVMStatus defines the observed state of VSphereVM.

AdditionalDisksGiB holds the sizes of additional disks of the virtual machine, in GiB Defaults to the eponymous property value in the template from which the virtual machine is cloned.

BiosUUID is the VM's BIOS UUID that is assigned at runtime after the VM has been created. This field is required at runtime for other controllers that read this CRD as unstructured data.

BootstrapRef is a reference to a bootstrap provider-specific resource that holds configuration details. This field is optional in case no bootstrap data is required to create a VM.

CloneMode specifies the type of clone operation. The LinkedClone mode is only supported for templates that have at least one snapshot. If the template has no snapshots, then CloneMode defaults to FullClone. When LinkedClone mode is enabled the DiskGiB field is ignored as it is not possible to expand disks of linked clones. Defaults to LinkedClone, but fails gracefully to FullClone if the source of the clone operation has no snapshots.

CustomVMXKeys is a dictionary of advanced VMX options that can be set on VM Defaults to empty map

DataDisks are additional disks to add to the VM that are not part of the VM's OVA template.

Datacenter is the name, inventory path, managed object reference or the managed object ID of the datacenter in which the virtual machine is created/located. Defaults to * which selects the default datacenter.

Datastore is the name, inventory path, managed object reference or the managed object ID of the datastore in which the virtual machine is created/located.

DiskGiB is the size of a virtual machine's disk, in GiB. Defaults to the eponymous property value in the template from which the virtual machine is cloned.

Folder is the name, inventory path, managed object reference or the managed object ID of the folder in which the virtual machine is created/located.

GuestSoftPowerOffTimeout sets the wait timeout for shutdown in the VM guest. The VM will be powered off forcibly after the timeout if the VM is still up and running when the PowerOffMode is set to trySoft.

This parameter only applies when the PowerOffMode is set to trySoft.

If omitted, the timeout defaults to 5 minutes.

HardwareVersion is the hardware version of the virtual machine. Defaults to the eponymous property value in the template from which the virtual machine is cloned. Check the compatibility with the ESXi version before setting the value.

MemoryMiB is the size of a virtual machine's memory, in MiB. Defaults to the eponymous property value in the template from which the virtual machine is cloned.

Network is the network configuration for this machine's VM.

NumCPUs is the number of virtual processors in a virtual machine. Defaults to the eponymous property value in the template from which the virtual machine is cloned.

NumCoresPerSocket is the number of cores per socket in a virtual machine. Defaults to the eponymous property value in the template from which the virtual machine is cloned.

OS is the Operating System of the virtual machine Defaults to Linux

PciDevices is the list of pci devices used by the virtual machine.

PowerOffMode describes the desired behavior when powering off a VM.

There are three supported power off modes: hard, soft, and trySoft. The first mode, hard, is the equivalent of a physical system's power cord being ripped from the wall. The soft mode requires the VM's guest to have VM Tools installed and attempts to gracefully shut down the VM. Its variant, trySoft, first attempts a graceful shutdown, and if that fails or the VM is not in a powered off state after reaching the GuestSoftPowerOffTimeout, the VM is halted.

If omitted, the mode defaults to hard.

ResourcePool is the name, inventory path, managed object reference or the managed object ID in which the virtual machine is created/located.

Server is the IP address or FQDN of the vSphere server on which the virtual machine is created/located.

Snapshot is the name of the snapshot from which to create a linked clone. This field is ignored if LinkedClone is not enabled. Defaults to the source's current snapshot.

StoragePolicyName of the storage policy to use with this Virtual Machine

TagIDs is an optional set of tags to add to an instance. Specified tagIDs must use URN-notation instead of display names.

Template is the name, inventory path, managed object reference or the managed object ID of the template used to clone the virtual machine.

Thumbprint is the colon-separated SHA-1 checksum of the given vCenter server's host certificate When this is set to empty, this VirtualMachine would be created without TLS certificate validation of the communication between Cluster API Provider vSphere and the VMware vCenter server.

API version of the referent.

If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

Name is used to identify the disk definition. Name is required and needs to be unique so that it can be used to clearly identify purpose of the disk.

ProvisioningMode specifies the provisioning type to be used by this vSphere data disk. If not set, the setting will be provided by the default storage policy.

SizeGiB is the size of the disk in GiB.

Devices is the list of network devices used by the virtual machine.

PreferredAPIServerCIDR is the preferred CIDR for the Kubernetes API server endpoint on this machine

Deprecated: This field is going to be removed in a future release.

Routes is a list of optional, static routes applied to the virtual machine.

AddressesFromPools is a list of IPAddressPools that should be assigned to IPAddressClaims. The machine's cloud-init metadata will be populated with IPAddresses fulfilled by an IPAM provider.

DeviceName may be used to explicitly assign a name to the network device as it exists in the guest operating system.

DHCP4 is a flag that indicates whether or not to use DHCP for IPv4 on this device. If true then IPAddrs should not contain any IPv4 addresses.

DHCP4Overrides allows for the control over several DHCP behaviors. Overrides will only be applied when the corresponding DHCP flag is set. Only configured values will be sent, omitted values will default to distribution defaults. Dependent on support in the network stack for your distribution. For more information see the netplan reference (https://netplan.io/reference#dhcp-overrides)

DHCP6 is a flag that indicates whether or not to use DHCP for IPv6 on this device. If true then IPAddrs should not contain any IPv6 addresses.

DHCP6Overrides allows for the control over several DHCP behaviors. Overrides will only be applied when the corresponding DHCP flag is set. Only configured values will be sent, omitted values will default to distribution defaults. Dependent on support in the network stack for your distribution. For more information see the netplan reference (https://netplan.io/reference#dhcp-overrides)

Gateway4 is the IPv4 gateway used by this device. Required when DHCP4 is false.

Gateway6 is the IPv6 gateway used by this device. Required when DHCP6 is false.

IPAddrs is a list of one or more IPv4 and/or IPv6 addresses to assign to this device. IP addresses must also specify the segment length in CIDR notation. Required when DHCP4, DHCP6 and SkipIPAllocation are false.

MACAddr is the MAC address used by this device. It is generally a good idea to omit this field and allow a MAC address to be generated. Please note that this value must use the VMware OUI to work with the in-tree vSphere cloud provider.

MTU is the device’s Maximum Transmission Unit size in bytes.

Nameservers is a list of IPv4 and/or IPv6 addresses used as DNS nameservers. Please note that Linux allows only three nameservers (https://linux.die.net/man/5/resolv.conf).

NetworkName is the name, managed object reference or the managed object ID of the vSphere network to which the device will be connected.

Routes is a list of optional, static routes applied to the device.

SearchDomains is a list of search domains used when resolving IP addresses with DNS.

SkipIPAllocation allows the device to not have IP address or DHCP configured. This is suitable for devices for which IP allocation is handled externally, eg. using Multus CNI. If true, CAPV will not verify IP address allocation.

APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

Kind is the type of resource being referenced

Name is the name of resource being referenced

Hostname is the name which will be sent to the DHCP server instead of the machine's hostname.

RouteMetric is used to prioritize routes for devices. A lower metric for an interface will have a higher priority.

SendHostname when true, the hostname of the machine will be sent to the DHCP server.

UseDNS when true, the DNS servers in the DHCP server will be used and take precedence.

UseDomains can take the values true, false, or route. When true, the domain name from the DHCP server will be used as the DNS search domain for this device. When route, the domain name from the DHCP response will be used for routing DNS only, not for searching.

UseHostname when true, the hostname from the DHCP server will be set as the transient hostname of the machine.

UseMTU when true, the MTU from the DHCP server will be set as the MTU of the device.

UseNTP when true, the NTP servers from the DHCP server will be used by systemd-timesyncd and take precedence.

UseRoutes can take the values true, false, or route. When true, the routes from the DHCP server will be installed in the routing table.

Hostname is the name which will be sent to the DHCP server instead of the machine's hostname.

RouteMetric is used to prioritize routes for devices. A lower metric for an interface will have a higher priority.

SendHostname when true, the hostname of the machine will be sent to the DHCP server.

UseDNS when true, the DNS servers in the DHCP server will be used and take precedence.

UseDomains can take the values true, false, or route. When true, the domain name from the DHCP server will be used as the DNS search domain for this device. When route, the domain name from the DHCP response will be used for routing DNS only, not for searching.

UseHostname when true, the hostname from the DHCP server will be set as the transient hostname of the machine.

UseMTU when true, the MTU from the DHCP server will be set as the MTU of the device.

UseNTP when true, the NTP servers from the DHCP server will be used by systemd-timesyncd and take precedence.

UseRoutes can take the values true, false, or route. When true, the routes from the DHCP server will be installed in the routing table.

Metric is the weight/priority of the route.

To is an IPv4 or IPv6 address.

Via is an IPv4 or IPv6 address.

Metric is the weight/priority of the route.

To is an IPv4 or IPv6 address.

Via is an IPv4 or IPv6 address.

CustomLabel is the hardware label of a virtual machine's PCI device. Defaults to the eponymous property value in the template from which the virtual machine is cloned.

DeviceID is the device ID of a virtual machine's PCI, in integer. Defaults to the eponymous property value in the template from which the virtual machine is cloned. Mutually exclusive with VGPUProfile as VGPUProfile and DeviceID + VendorID are two independent ways to define PCI devices.

VGPUProfile is the profile name of a virtual machine's vGPU, in string. Defaults to the eponymous property value in the template from which the virtual machine is cloned. Mutually exclusive with DeviceID and VendorID as VGPUProfile and DeviceID + VendorID are two independent ways to define PCI devices.

VendorId is the vendor ID of a virtual machine's PCI, in integer. Defaults to the eponymous property value in the template from which the virtual machine is cloned. Mutually exclusive with VGPUProfile as VGPUProfile and DeviceID + VendorID are two independent ways to define PCI devices.

Addresses is a list of the VM's IP addresses. This field is required at runtime for other controllers that read this CRD as unstructured data.

CloneMode is the type of clone operation used to clone this VM. Since LinkedClone is the default but fails gracefully if the source of the clone has no snapshots, this field may be used to determine the actual type of clone operation used to create this VM.

Conditions defines current service state of the VSphereVM.

FailureMessage will be set in the event that there is a terminal problem reconciling the vspherevm and will contain a more verbose string suitable for logging and human consumption.

This field should not be set for transitive errors that a controller faces that are expected to be fixed automatically over time (like service outages), but instead indicate that something is fundamentally wrong with the vm.

Any transient errors that occur during the reconciliation of vspherevms can be added as events to the vspherevm object and/or logged in the controller's output.

FailureReason will be set in the event that there is a terminal problem reconciling the vspherevm and will contain a succinct value suitable for vm interpretation.

This field should not be set for transitive errors that a controller faces that are expected to be fixed automatically over time (like service outages), but instead indicate that something is fundamentally wrong with the vm.

Any transient errors that occur during the reconciliation of vspherevms can be added as events to the vspherevm object and/or logged in the controller's output.

Host describes the hostname or IP address of the infrastructure host that the VSphereVM is residing on.

ModuleUUID is the unique identifier for the vCenter cluster module construct which is used to configure anti-affinity. Objects with the same ModuleUUID will be anti-affined, meaning that the vCenter DRS will best effort schedule the VMs on separate hosts.

Network returns the network status for each of the machine's configured network interfaces.

Ready is true when the provider resource is ready. This field is required at runtime for other controllers that read this CRD as unstructured data.

RetryAfter tracks the time we can retry queueing a task

Snapshot is the name of the snapshot from which the VM was cloned if LinkedClone is enabled.

TaskRef is a managed object reference to a Task related to the machine. This value is set automatically at runtime and should not be set or modified by users.

v1beta2 groups all the fields that will be added or modified in VSphereVM's status with the V1Beta2 version.

VMRef is the VM's Managed Object Reference on vSphere. It can be used by consumers to programatically get this VM representation on vSphere in case of the need to retrieve informations. This field is set once the machine is created and should not be changed

lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

message is a human readable message indicating details about the transition. This field may be empty.

reason is the reason for the condition's last transition in CamelCase. The specific API may choose whether or not this field is considered a guaranteed API. This field may be empty.

severity provides an explicit classification of Reason code, so the users or machines can immediately understand the current situation and act accordingly. The Severity field MUST be set only when Status=False.

status of the condition, one of True, False, Unknown.

type of condition in CamelCase or in foo.example.com/CamelCase. Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important.

Connected is a flag that indicates whether this network is currently connected to the VM.

IPAddrs is one or more IP addresses reported by vm-tools.

MACAddr is the MAC address of the network device.

NetworkName is the name of the network.

conditions represents the observations of a VSphereVM's current state. Known condition types are Ready, VirtualMachineProvisioned, VCenterAvailable and IPAddressClaimsFulfilled, GuestSoftPowerOffSucceeded, PCIDevicesDetached and Paused.

lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

message is a human readable message indicating details about the transition. This may be an empty string.

observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

status of the condition, one of True, False, Unknown.

type of condition in CamelCase or in foo.example.com/CamelCase.