#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

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

Datacenter is the name or inventory path of the datacenter in which the virtual machine is created/located.

Datastore is the name or inventory path 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 or inventory path of the folder in which the virtual machine is created/located.

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.

ResourcePool is the name or inventory path of the resource pool 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

Template is the name or inventory path 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

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

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

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

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.

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.

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 and DHCP6 are both 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 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.

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.

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.

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.

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.

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

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 not 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.