VSphereMachine [infrastructure.cluster.x-k8s.io/v1beta1]

Description: VSphereMachine is the Schema for the vspheremachines API Deprecated: This type will be removed in one of the next releases.
Type: object

Specification

Property	Type	Description
`apiVersion`	`string`	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`	`string`	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
`metadata`	`ObjectMeta`	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
`spec`	`object`	VSphereMachineSpec defines the desired state of VSphereMachine
`status`	`object`	VSphereMachineStatus defines the observed state of VSphereMachine

.spec

Description: VSphereMachineSpec defines the desired state of VSphereMachine
Type: object
Required: networktemplate

Property	Type	Description
`cloneMode`	`string`	CloneMode specifies the type of clone operation. The LinkedClone mode is only support 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`	`object`	CustomVMXKeys is a dictionary of advanced VMX options that can be set on VM Defaults to empty map
`datacenter`	`string`	Datacenter is the name or inventory path of the datacenter in which the virtual machine is created/located.
`datastore`	`string`	Datastore is the name or inventory path of the datastore in which the virtual machine is created/located.
`diskGiB`	`integer`	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.
`failureDomain`	`string`	FailureDomain is the failure domain unique identifier this Machine should be attached to, as defined in Cluster API. For this infrastructure provider, the name is equivalent to the name of the VSphereDeploymentZone.
`folder`	`string`	Folder is the name or inventory path of the folder in which the virtual machine is created/located.
`memoryMiB`	`integer`	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`	`object`	Network is the network configuration for this machine's VM.
`numCPUs`	`integer`	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`	`integer`	NumCPUs is the number of cores among which to distribute CPUs in this virtual machine. Defaults to the eponymous property value in the template from which the virtual machine is cloned.
`providerID`	`string`	ProviderID is the virtual machine's BIOS UUID formated as vsphere://12345678-1234-1234-1234-123456789abc
`resourcePool`	`string`	ResourcePool is the name or inventory path of the resource pool in which the virtual machine is created/located.
`server`	`string`	Server is the IP address or FQDN of the vSphere server on which the virtual machine is created/located.
`snapshot`	`string`	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`	`string`	StoragePolicyName of the storage policy to use with this Virtual Machine
`template`	`string`	Template is the name or inventory path of the template used to clone the virtual machine.
`thumbprint`	`string`	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.

.spec.customVMXKeys

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

.spec.network

Description: Network is the network configuration for this machine's VM.
Type: object
Required: devices

Property	Type	Description
`devices`	`array`	Devices is the list of network devices used by the virtual machine.
`preferredAPIServerCidr`	`string`	PreferredAPIServeCIDR is the preferred CIDR for the Kubernetes API server endpoint on this machine
`routes`	`array`	Routes is a list of optional, static routes applied to the virtual machine.

.spec.network.devices

Description: Devices is the list of network devices used by the virtual machine.
Type: array

.spec.network.devices[]

Description: NetworkDeviceSpec defines the network configuration for a virtual machine's network device.
Type: object
Required: networkName

Property	Type	Description
`deviceName`	`string`	DeviceName may be used to explicitly assign a name to the network device as it exists in the guest operating system.
`dhcp4`	`boolean`	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`	`boolean`	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`	`string`	Gateway4 is the IPv4 gateway used by this device. Required when DHCP4 is false.
`gateway6`	`string`	Gateway4 is the IPv4 gateway used by this device. Required when DHCP6 is false.
`ipAddrs`	`array`	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`	`string`	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`	`integer`	MTU is the device’s Maximum Transmission Unit size in bytes.
`nameservers`	`array`	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`	`string`	NetworkName is the name of the vSphere network to which the device will be connected.
`routes`	`array`	Routes is a list of optional, static routes applied to the device.
`searchDomains`	`array`	SearchDomains is a list of search domains used when resolving IP addresses with DNS.

.spec.network.devices[].ipAddrs

Description: 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.
Type: array

.spec.network.devices[].ipAddrs[]

Type: string

.spec.network.devices[].nameservers

Description: 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).
Type: array

.spec.network.devices[].nameservers[]

Type: string

.spec.network.devices[].routes

Description: Routes is a list of optional, static routes applied to the device.
Type: array

.spec.network.devices[].routes[]

Description: NetworkRouteSpec defines a static network route.
Type: object
Required: metrictovia

Property	Type	Description
`metric`	`integer`	Metric is the weight/priority of the route.
`to`	`string`	To is an IPv4 or IPv6 address.
`via`	`string`	Via is an IPv4 or IPv6 address.

.spec.network.devices[].searchDomains

Description: SearchDomains is a list of search domains used when resolving IP addresses with DNS.
Type: array

.spec.network.devices[].searchDomains[]

Type: string

.spec.network.routes

Description: Routes is a list of optional, static routes applied to the virtual machine.
Type: array

.spec.network.routes[]

Description: NetworkRouteSpec defines a static network route.
Type: object
Required: metrictovia

Property	Type	Description
`metric`	`integer`	Metric is the weight/priority of the route.
`to`	`string`	To is an IPv4 or IPv6 address.
`via`	`string`	Via is an IPv4 or IPv6 address.

.status

Description: VSphereMachineStatus defines the observed state of VSphereMachine
Type: object

Property	Type	Description
`addresses`	`array`	Addresses contains the VSphere instance associated addresses.
`conditions`	`array`	Conditions defines current service state of the VSphereMachine.
`failureMessage`	`string`	FailureMessage will be set in the event that there is a terminal problem reconciling the Machine 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 Machine's spec or the configuration of the controller, and that manual intervention is required. Examples of terminal errors would be invalid combinations of settings in the spec, values that are unsupported by the controller, or the responsible controller itself being critically misconfigured. Any transient errors that occur during the reconciliation of Machines can be added as events to the Machine object and/or logged in the controller's output.
`failureReason`	`string`	FailureReason will be set in the event that there is a terminal problem reconciling the Machine and will contain a succinct value suitable for machine 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 Machine's spec or the configuration of the controller, and that manual intervention is required. Examples of terminal errors would be invalid combinations of settings in the spec, values that are unsupported by the controller, or the responsible controller itself being critically misconfigured. Any transient errors that occur during the reconciliation of Machines can be added as events to the Machine object and/or logged in the controller's output.
`network`	`array`	Network returns the network status for each of the machine's configured network interfaces.
`ready`	`boolean`	Ready is true when the provider resource is ready.

.status.addresses

Description: Addresses contains the VSphere instance associated addresses.
Type: array

.status.addresses[]

Description: MachineAddress contains information for the node's address.
Type: object
Required: addresstype

Property	Type	Description
`address`	`string`	The machine address.
`type`	`string`	Machine address type, one of Hostname, ExternalIP or InternalIP.

.status.conditions

Description: Conditions defines current service state of the VSphereMachine.
Type: array

.status.conditions[]

Description: Condition defines an observation of a Cluster API resource operational state.
Type: object
Required: statustype

Property	Type	Description
`lastTransitionTime`	`string`	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`	`string`	A human readable message indicating details about the transition. This field may be empty.
`reason`	`string`	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`	`string`	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`	`string`	Status of the condition, one of True, False, Unknown.
`type`	`string`	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.

.status.network

Description: Network returns the network status for each of the machine's configured network interfaces.
Type: array

.status.network[]

Description: NetworkStatus provides information about one of a VM's networks.
Type: object
Required: macAddr

Property	Type	Description
`connected`	`boolean`	Connected is a flag that indicates whether this network is currently connected to the VM.
`ipAddrs`	`array`	IPAddrs is one or more IP addresses reported by vm-tools.
`macAddr`	`string`	MACAddr is the MAC address of the network device.
`networkName`	`string`	NetworkName is the name of the network.

.status.network[].ipAddrs

Description: IPAddrs is one or more IP addresses reported by vm-tools.
Type: array

.status.network[].ipAddrs[]

Type: string

API Endpoints

The following API endpoints are available:

/apis/infrastructure.cluster.x-k8s.io/v1alpha3/namespaces/{namespace}/vspheremachines
- DELETE: delete collection of VSphereMachine
- GET: list objects of kind VSphereMachine
- POST: create a new VSphereMachine
/apis/infrastructure.cluster.x-k8s.io/v1alpha3/namespaces/{namespace}/vspheremachines/{name}
- DELETE: delete the specified VSphereMachine
- GET: read the specified VSphereMachine
- PATCH: partially update the specified VSphereMachine
- PUT: replace the specified VSphereMachine
/apis/infrastructure.cluster.x-k8s.io/v1alpha3/namespaces/{namespace}/vspheremachines/{name}/status
- GET: read status of the specified VSphereMachine
- PATCH: partially update status of the specified VSphereMachine
- PUT: replace status of the specified VSphereMachine

/apis/infrastructure.cluster.x-k8s.io/v1alpha3/namespaces/{namespace}/vspheremachines

HTTP method: DELETE
Description: delete collection of VSphereMachine
HTTP responses

HTTP code	Response body
200 - OK	`Status` schema
401 - Unauthorized	Empty

HTTP method: GET
Description: list objects of kind VSphereMachine
HTTP responses

HTTP code	Response body
200 - OK	`VSphereMachineList` schema
401 - Unauthorized	Empty

HTTP method: POST
Description: create a new VSphereMachine

Query parameters

Parameter	Type	Description
`dryRun`	`string`	When 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
`fieldValidation`	`string`	fieldValidation 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

Parameter	Type	Description
`body`	`VSphereMachine` schema	`application/json` formatted

HTTP responses

HTTP code	Response body
200 - OK	`VSphereMachine` schema
201 - Created	`VSphereMachine` schema
202 - Accepted	`VSphereMachine` schema
401 - Unauthorized	Empty

/apis/infrastructure.cluster.x-k8s.io/v1alpha3/namespaces/{namespace}/vspheremachines/{name}

HTTP method: DELETE
Description: delete the specified VSphereMachine

Query parameters

Parameter	Type	Description
`dryRun`	`string`	When 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 code	Response body
200 - OK	`Status` schema
202 - Accepted	`Status` schema
401 - Unauthorized	Empty

HTTP method: GET
Description: read the specified VSphereMachine
HTTP responses

HTTP code	Response body
200 - OK	`VSphereMachine` schema
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update the specified VSphereMachine

Query parameters

Parameter	Type	Description
`dryRun`	`string`	When 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
`fieldValidation`	`string`	fieldValidation 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 code	Response body
200 - OK	`VSphereMachine` schema
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace the specified VSphereMachine

Query parameters

Parameter	Type	Description
`dryRun`	`string`	When 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
`fieldValidation`	`string`	fieldValidation 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

Parameter	Type	Description
`body`	`VSphereMachine` schema	`application/json` formatted

HTTP responses

HTTP code	Response body
200 - OK	`VSphereMachine` schema
201 - Created	`VSphereMachine` schema
401 - Unauthorized	Empty

/apis/infrastructure.cluster.x-k8s.io/v1alpha3/namespaces/{namespace}/vspheremachines/{name}/status

HTTP method: GET
Description: read status of the specified VSphereMachine
HTTP responses

HTTP code	Response body
200 - OK	`VSphereMachine` schema
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update status of the specified VSphereMachine

Query parameters

Parameter	Type	Description
`dryRun`	`string`	When 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
`fieldValidation`	`string`	fieldValidation 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 code	Response body
200 - OK	`VSphereMachine` schema
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace status of the specified VSphereMachine

Query parameters

Parameter	Type	Description
`dryRun`	`string`	When 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
`fieldValidation`	`string`	fieldValidation 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

Parameter	Type	Description
`body`	`VSphereMachine` schema	`application/json` formatted

HTTP responses

HTTP code	Response body
200 - OK	`VSphereMachine` schema
201 - Created	`VSphereMachine` schema
401 - Unauthorized	Empty

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

Specification#

.spec#

.spec.customVMXKeys#

.spec.network#

.spec.network.devices#

.spec.network.devices[]#

.spec.network.devices[].ipAddrs#

.spec.network.devices[].ipAddrs[]#

.spec.network.devices[].nameservers#

.spec.network.devices[].nameservers[]#

.spec.network.devices[].routes#

.spec.network.devices[].routes[]#

.spec.network.devices[].searchDomains#

.spec.network.devices[].searchDomains[]#

.spec.network.routes#

.spec.network.routes[]#

.status#

.status.addresses#

.status.addresses[]#

.status.conditions#

.status.conditions[]#

.status.network#

.status.network[]#

.status.network[].ipAddrs#

.status.network[].ipAddrs[]#

API Endpoints#

/apis/infrastructure.cluster.x-k8s.io/v1alpha3/namespaces/{namespace}/vspheremachines#

/apis/infrastructure.cluster.x-k8s.io/v1alpha3/namespaces/{namespace}/vspheremachines/{name}#

/apis/infrastructure.cluster.x-k8s.io/v1alpha3/namespaces/{namespace}/vspheremachines/{name}/status#

VSphereMachine [infrastructure.cluster.x-k8s.io/v1beta1]

Specification

.spec

.spec.customVMXKeys

.spec.network

.spec.network.devices

.spec.network.devices[]

.spec.network.devices[].ipAddrs

.spec.network.devices[].ipAddrs[]

.spec.network.devices[].nameservers

.spec.network.devices[].nameservers[]

.spec.network.devices[].routes

.spec.network.devices[].routes[]

.spec.network.devices[].searchDomains

.spec.network.devices[].searchDomains[]

.spec.network.routes

.spec.network.routes[]

.status

.status.addresses

.status.addresses[]

.status.conditions

.status.conditions[]

.status.network

.status.network[]

.status.network[].ipAddrs

.status.network[].ipAddrs[]

API Endpoints

/apis/infrastructure.cluster.x-k8s.io/v1alpha3/namespaces/{namespace}/vspheremachines

/apis/infrastructure.cluster.x-k8s.io/v1alpha3/namespaces/{namespace}/vspheremachines/{name}

/apis/infrastructure.cluster.x-k8s.io/v1alpha3/namespaces/{namespace}/vspheremachines/{name}/status